com.beanstream.api.ReportingAPI.java Source code

Introduction

Here is the source code for com.beanstream.api.ReportingAPI.java

Source

/* The MIT License (MIT)
 *
 * Copyright (c) 2014 Beanstream Internet Commerce Corp, Digital River, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.beanstream.api;

import com.beanstream.Configuration;
import com.beanstream.connection.PaymentsUrls;
import com.beanstream.connection.HttpMethod;
import com.beanstream.connection.HttpsConnector;
import com.beanstream.data.Records;
import com.beanstream.domain.Transaction;
import com.beanstream.domain.TransactionRecord;
import com.beanstream.exceptions.BeanstreamApiException;
import com.beanstream.requests.Criteria;
import com.beanstream.requests.CriteriaSerializer;
import com.beanstream.requests.SearchQuery;
import com.beanstream.responses.BeanstreamResponse;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;
import org.apache.http.HttpStatus;

/**
 * Get a transaction or search for a range of transactions with the Reporting API.
 * 
 * You can get an individual transaction and all of its Adjustments (voids, returns) or 
 * you can search for transactions using date ranges and specific criteria.
 * 
 * @author bowens
 */
public class ReportingAPI {

    private Configuration config;
    private HttpsConnector connector;
    private final String DATE_FORMAT_STRING = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX";

    private GsonBuilder getGsonBuilder() {
        GsonBuilder gsonBuilder = new GsonBuilder();
        gsonBuilder.setDateFormat(DATE_FORMAT_STRING); //2014-10-16T15:22:17.815-07:00
        gsonBuilder.registerTypeAdapter(Criteria.class, new CriteriaSerializer());
        return gsonBuilder;
    }

    private Gson getGson() {
        return getGsonBuilder().create();
    }

    public ReportingAPI(Configuration config) {
        this.config = config;
        connector = new HttpsConnector(config.getMerchantId(), config.getReportingApiPasscode());
        connector.setCustomHttpClient(config.getCustomHttpClient());
    }

    public void setConfig(Configuration config) {
        this.config = config;
        connector = new HttpsConnector(config.getMerchantId(), config.getReportingApiPasscode());
        connector.setCustomHttpClient(config.getCustomHttpClient());
    }

    /**
     * Get a single transaction
     * @param paymentId Transaction ID of payment
     * @return Transaction
     * @throws BeanstreamApiException when not successful
     */
    public Transaction getTransaction(String paymentId) throws BeanstreamApiException {

        assertNotEmpty(paymentId, "invalid paymentId");

        String url = PaymentsUrls.getPaymentUrl(config.getPlatform(), config.getVersion(), paymentId);
        connector.setApiPasscode(config.getPaymentsApiPasscode());

        // get the transaction using the REST API
        String response = connector.ProcessTransaction(HttpMethod.get, url, null);

        return getGson().fromJson(response, Transaction.class);
    }

    private void assertNotEmpty(String value, String errorMessage) throws BeanstreamApiException {

        if (value == null || value.trim().isEmpty()) {
            // TODO - do we need to supply category and code ids here?
            BeanstreamResponse response = BeanstreamResponse.fromMessage("invalid payment request");
            throw BeanstreamApiException.getMappedException(HttpStatus.SC_BAD_REQUEST, response);
        }
    }

    public List<TransactionRecord> query(final Date startDate, final Date endDate, final int startRow,
            final int endRow, Criteria[] searchCriteria) throws BeanstreamApiException {
        if (endDate == null || startDate == null)
            throw new IllegalArgumentException("Start Date and End Date cannot be null!");
        if (endDate.compareTo(startDate) < 0)
            throw new IllegalArgumentException("End Date cannot be less than Start Date!");
        if (endRow < startRow)
            throw new IllegalArgumentException("End Row cannot be less than Start Row!");
        if (endRow - startRow > 1000)
            throw new IllegalArgumentException("You cannot query more than 1000 rows at a time!");

        if (searchCriteria == null)
            searchCriteria = new Criteria[] {};

        String url = PaymentsUrls.getReportsUrl(config.getPlatform(), config.getVersion());

        final SimpleDateFormat dateFormat = new SimpleDateFormat(DATE_FORMAT_STRING);
        SearchQuery query = new SearchQuery(dateFormat.format(startDate), dateFormat.format(endDate), startRow,
                endRow, searchCriteria);

        connector.setGsonBuilder(getGsonBuilder());

        String response = connector.ProcessTransaction(HttpMethod.post, url, query);
        System.out.println("Response:\n" + response);
        Records records = getGson().fromJson(response, Records.class);

        return records.records;
    }
}