paytrace 0.1.21 → 0.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 151f729f1e86c8a9dd7f218afe022017af0c9c5f
-  data.tar.gz: 8e5bae858b0e4825466d61fd8084f56d94b43dd5
+  metadata.gz: eb8b55937b9c0b2a71ebf27a80842724762b006d
+  data.tar.gz: 872c601caeb2ebe395d9ff3abc1c64edde62f78b
 SHA512:
-  metadata.gz: 7c704b30039685e4f063bb4906ce383d3a14805ef5aafc0fd533b94b63b5771d3e42eff7e9b4bcf1d928e558512a91334eef0c98d0e00558217fda368859e25e
-  data.tar.gz: d3b6bbdd08257974328db8713cdfc62d94880bd4c3cb0f193af3ea10f9f514f052e33de7424c22cb1f080ef9afae69ddb669e45dd34e885868c24fb2ff8897d2
+  metadata.gz: fa3d3191c00543ab32e097a41a2b50fe8ab74eff126c64e288ae9d1b74dc841a7316e44706357ea14baca473673674a0561a59e07f82e913a0ccb264336cd44e
+  data.tar.gz: 0b32bc57ddec96fa1007f53118cbfc85fd685d804048a9729ae5356868c783e1fd6a692b3072aff36602321a9772c35a4d76ad28b0f02f7ecd7ca18d382ad574

data/lib/paytrace.rb

@@ -11,6 +11,7 @@ require 'paytrace/api/response'
 require 'paytrace/exceptions'
 require 'paytrace/recurring_transaction'
 require 'paytrace/check_transaction'
+require 'paytrace/batch_operations'
 
 module PayTrace
 end

data/lib/paytrace/address.rb

@@ -5,6 +5,17 @@ module PayTrace
   class Address
     attr_accessor :name, :street,:street2,:city,:state, :country,:region,:postal_code,:address_type
 
+    ATTRIBUTE_MAP = [
+      [:name, :name],
+      [:address, :street],
+      [:address2, :street2],
+      [:city, :city],
+      [:region, :region],
+      [:state, :state],
+      [:postal_code, :postal_code],
+      [:country, :country]
+    ]
+
     # Initialize a new address instance. Parameters are symbolic keys in a hash. They are:
     # * *:name* -- the name on this address
     # * *:street* -- the street address
@@ -31,16 +42,12 @@ module PayTrace
     # Parameters:
     # * *request* -- the request object to apply this address to
     def set_request(request)
-      atype_str = address_type.to_s
-
-      request.set_param(:"#{atype_str}_name", name) if name
-      request.set_param(:"#{atype_str}_address", street) if street
-      request.set_param(:"#{atype_str}_address2", street2) if street2
-      request.set_param(:"#{atype_str}_city", city) if city
-      request.set_param(:"#{atype_str}_region", region) if region
-      request.set_param(:"#{atype_str}_state", state) if state
-      request.set_param(:"#{atype_str}_postal_code", postal_code) if postal_code
-      request.set_param(:"#{atype_str}_country", country) if country
+      ATTRIBUTE_MAP.each do |request_name, attribute_name|   
+        unless request_name == :region && address_type == :billing # special case
+          # this is ugly, but it saves us from subclassing just to change field names in a predictable way...
+          request.set_param("#{address_type.to_s}_#{request_name}".to_sym, self.send(attribute_name))
+        end
+      end
     end
   end
 end

data/lib/paytrace/api/fields.rb

@@ -110,6 +110,8 @@ module PayTrace
         source_state: "SOURCESTATE",
         shipping_weight: "WEIGHT",
         shippers: "SHIPPERS",
+        # batch opterations
+        batch_number: "BATCHNUMBER",
         # test flag
         test_flag: "TEST"
       }

data/lib/paytrace/api/request.rb

@@ -42,10 +42,16 @@ module PayTrace
       # Sets discretionary data keys and values
       # * *:key* -- the name of the setting
       # * *:value* -- the value of the setting
+      # 
+      # _Note:_ you can bulk-set discretionary data by simply passing in a hash as the "key"
       def set_discretionary(key, value = nil)
         if key.is_a?(Hash)
-          @discretionary_data = key
-        else
+          ddata_hash = key
+          ddata_hash.keys.each do |inner_key|
+            inner_value = ddata_hash[inner_key]
+            @discretionary_data[inner_key] = inner_value unless inner_value.nil?
+          end
+        elsif key.is_a?(Symbol)
           @discretionary_data[key] = value unless value.nil?
         end
       end
@@ -86,9 +92,26 @@ module PayTrace
       # Sets multiple parameters at once
       # * *:keys* -- an array of key names to extract from the params hash
       # * *:params* -- the parameters hash to be extracted from
+      #
+      # _Note:_ the values in *:keys* can also include arrays of two values (techincally, a tuple). The sub-array contains the name of the field that will be used in the request, and the name of the field in the params. This allows more succinct parameter names; e.g. *:address* instead of *:billing_address*. Example:
+      #
+      #   #
+      #   # note the nested array; this will send the field :billing_address,
+      #   # but uses the argument :address as the argument name
+      #   #
+      #   set_params([
+      #       :foo,
+      #       [:billing_address, :address]
+      #     ], params) 
       def set_params(keys, params)
         keys.each do |key|
-          set_param(key, params[key])
+          if key.is_a?(Array)
+            request_variable = key[0]
+            arg_name = key[1]
+            set_param(request_variable, params[arg_name])
+          else
+            set_param(key, params[key])
+          end
         end
       end
     end

data/lib/paytrace/batch_operations.rb

@@ -0,0 +1,62 @@
+module PayTrace
+  # This class serves as a container for batch processing methods
+  class BatchOperations
+    EXPORT_SINGLE_METHOD = "ExportBatch"
+    EXPORT_MULTIPLE_METHOD = "ExportBatches"
+    EXPORT_DETAILS_METHOD = "ExportBatchDetails"
+
+    # See http://help.paytrace.com/api-export-single-batch
+    #
+    # Verifying batch details is sometimes necessary for your application to be able to determine deposit and transaction sums. The ExportBatch method is useful for extracting a summary of a specific batch or currently pending settlement break-down by card and transaction type.
+    #
+    # Optional parameters hash:
+    #
+    # * *:batch_number* -- number of the batch of transactions you wish to export
+    def self.exportSingle(params = {})
+      request = PayTrace::API::Request.new
+      request.set_param(:method, EXPORT_SINGLE_METHOD)
+      request.set_param(:batch_number, params[:batch_number])
+
+      gateway = PayTrace::API::Gateway.new
+      response = gateway.send_request(request)      
+      unless response.has_errors?
+        response.values
+      end
+    end
+
+    # See http://help.paytrace.com/api-export-batches
+    #
+    # Exports summary information about multiple batches over a given date range. Required parameters:
+    #
+    # * *:start_date* -- indicates when to start searching for transactions to export. Must be a valid date formatted as MM/DD/YYYY
+    # * *:end_date* -- indicates when to end searching for transactions to export. Must be a valid date formatted as MM/DD/YYYY
+    def self.exportMultiple(params = {})
+      request = PayTrace::API::Request.new
+      request.set_param(:method, EXPORT_MULTIPLE_METHOD)
+      request.set_params([:start_date, :end_date], params)
+
+      gateway = PayTrace::API::Gateway.new
+      response = gateway.send_request(request)      
+      unless response.has_errors?
+        response.values
+      end
+    end
+
+    # See http://help.paytrace.com/api-export-batch-details
+    #
+    # Exports transaction details of a given batch. Required parameters hash:
+    #
+    # * *:batch_number* -- number of the batch of transactions you wish to export
+    def self.exportDetails(params = {})
+      request = PayTrace::API::Request.new
+      request.set_param(:method, EXPORT_DETAILS_METHOD)
+      request.set_param(:batch_number, params[:batch_number])
+
+      gateway = PayTrace::API::Gateway.new
+      response = gateway.send_request(request)      
+      unless response.has_errors?
+        response.values
+      end
+    end
+  end
+end

data/lib/paytrace/customer.rb

@@ -131,28 +131,23 @@ module PayTrace
     # Internal helper method; not meant to be called directly.
     def set_request_data(params, request = nil)
       request ||= PayTrace::API::Request.new
-      request.set_param(:customer_id, params[:customer_id])
-      request.set_param(:new_customer_id, params[:new_customer_id])
-      request.set_param(:transaction_id, params[:transaction_id])
+      request.set_params([
+        :customer_id,
+        :new_customer_id,
+        :transaction_id,
+        :email,
+        [:customer_phone, :phone],
+        [:customer_fax, :fax],
+        :customer_password,
+        :account_number,
+        :routing_number
+        ], params)
 
       params[:billing_address].set_request(request) if params[:billing_address]
       params[:shipping_address].set_request(request) if params[:shipping_address]
+      params[:credit_card].set_request_data(request) if params[:credit_card]
 
-      if params[:credit_card]
-        params[:credit_card].set_request_data(request)
-      end
-
-      request.set_param(:email, params[:email])
-      request.set_param(:customer_phone, params[:phone]) 
-      request.set_param(:customer_fax, params[:fax]) 
-      request.set_param(:customer_password, params[:customer_password])
-      request.set_param(:account_number, params[:account_number])
-      request.set_param(:routing_number, params[:routing_number])
-      if params[:discretionary_data] 
-        params[:discretionary_data].keys.each do |k|
-          request.set_discretionary(k, params[:discretionary_data][k])
-        end
-      end
+      request.set_discretionary(params[:discretionary_data])
     end
   end
 end

data/lib/paytrace/recurring_transaction.rb

@@ -112,17 +112,19 @@ module PayTrace
       request = PayTrace::API::Request.new
       request.set_param(:method, method)
 
-      request.set_param(:recur_id, params[:recur_id])
-      request.set_param(:customer_id, params[:customer_id])
-      request.set_param(:recur_frequency, params[:recur_frequency])
-      request.set_param(:recur_start, params[:recur_start])
-      request.set_param(:recur_next, params[:recur_next])
-      request.set_param(:recur_count, params[:recur_count])
-      request.set_param(:amount, params[:amount])
-      request.set_param(:transaction_type, params[:transaction_type])
-      request.set_param(:description, params[:description])
-      request.set_param(:recur_receipt, params[:recur_receipt])
-      request.set_param(:recur_type, params[:recur_type])
+      request.set_params([
+        :recur_id,
+        :customer_id,
+        :recur_frequency,
+        :recur_start,
+        :recur_next,
+        :recur_count,
+        :amount,
+        :transaction_type,
+        :description,
+        :recur_receipt,
+        :recur_type
+        ], params)
 
       gateway = PayTrace::API::Gateway.new
       gateway.send_request(request)

data/lib/paytrace/version.rb

@@ -1,4 +1,4 @@
 module PayTrace
   # Version number
-  VERSION = "0.1.21"
+  VERSION = "0.1.23"
 end

data/paytrace.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "mocha", "~> 1.0"
   spec.add_development_dependency "guard", '~> 0'
   spec.add_development_dependency "guard-minitest", '~> 0'
+  spec.add_development_dependency "ruby_gntp", '~> 0'
 end

data/test/paytrace/api/request_spec.rb

@@ -38,6 +38,14 @@ describe PayTrace::API::Request do
     r.params[:billing_postal_code].must_equal [98133]
   end
 
+  it "can alias parameters in set_params" do
+    params = {name: "Ron Jones", postal_code: 98134}
+    r = PayTrace::API::Request.new
+    r.set_params([[:billing_name, :name], [:billing_postal_code, :postal_code]], params)
+    r.params[:billing_name].must_equal ["Ron Jones"]
+    r.params[:billing_postal_code].must_equal [98134]  
+  end
+
   it "raises a validation exception for unknown fields" do
     r = PayTrace::API::Request.new
 

data/test/paytrace/batch_operations_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '../../test_helper.rb')
+
+describe PayTrace::BatchOperations do
+  def base_url(method)
+    "UN~#{PayTrace.configuration.user_name}|PSWD~#{PayTrace.configuration.password}|TERMS~Y|METHOD~#{method}|"
+  end
+
+  before do
+    PayTrace::API::Gateway.debug = true
+    PayTrace::API::Gateway.reset_trace()
+  end
+
+  describe "exportSingle" do
+    it "generates the correct request" do
+      PayTrace::API::Gateway.next_response = "RESULT~Ok"
+      result = PayTrace::BatchOperations.exportSingle()
+      PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::BatchOperations::EXPORT_SINGLE_METHOD)
+    end
+
+    it "accepts an optional batch number" do
+      PayTrace::API::Gateway.next_response = "RESULT~Ok"
+      result = PayTrace::BatchOperations.exportSingle(batch_number: 12345)
+      PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::BatchOperations::EXPORT_SINGLE_METHOD) + "BATCHNUMBER~12345|"
+    end
+  end
+
+  describe "exportMultiple" do
+    it "generates the correct request" do
+      PayTrace::API::Gateway.next_response = "RESULT~Ok"
+      result = PayTrace::BatchOperations.exportMultiple(start_date: "03/01/2014", end_date: "06/01/2014")
+      PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::BatchOperations::EXPORT_MULTIPLE_METHOD) +
+        "SDATE~03/01/2014|EDATE~06/01/2014|"
+    end
+  end
+
+  describe "exportDetails" do
+    it "generates the correct request" do
+      PayTrace::API::Gateway.next_response = "RESULT~Ok"
+      result = PayTrace::BatchOperations.exportDetails(batch_number: 12346)
+      PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::BatchOperations::EXPORT_DETAILS_METHOD) + "BATCHNUMBER~12346|"
+    end
+  end
+end

data/test/scripts/run_export_batches.rb

@@ -0,0 +1,32 @@
+$:<< "./lib" # uncomment this to run against a Git clone instead of an installed gem
+
+require "paytrace"
+require "paytrace/debug"
+
+# change this as needed to reflect the username, password, and test host you're testing against
+PayTrace::Debug.configure_test("demo123", "demo123", "stage.paytrace.com")
+
+# export summary info of a single batch (by batch number in this case, otherwise chooses latest batch)
+PayTrace::Debug.trace do
+  params = {
+    batch_number: 413
+  }
+  result = PayTrace::BatchOperations.exportSingle(params)
+end
+
+# export batches by date range
+PayTrace::Debug.trace do
+  params = {
+    start_date: "01/01/2014",
+    end_date: "05/01/2014"
+  }
+  result = PayTrace::BatchOperations.exportMultiple(params)
+end
+
+# export batch transaction details
+PayTrace::Debug.trace do
+  params = {
+    batch_number: 413
+  }
+  result = PayTrace::BatchOperations.exportDetails(params)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paytrace
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.23
 platform: ruby
 authors:
 - Trevor Redfern
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby_gntp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Integration with PayTrace Payment Gateway
 email:
 - trevor@paytrace.com
@@ -116,6 +130,7 @@ files:
 - lib/paytrace/api/gateway.rb
 - lib/paytrace/api/request.rb
 - lib/paytrace/api/response.rb
+- lib/paytrace/batch_operations.rb
 - lib/paytrace/check_transaction.rb
 - lib/paytrace/configuration.rb
 - lib/paytrace/credit_card.rb
@@ -132,6 +147,7 @@ files:
 - test/paytrace/api/gateway_spec.rb
 - test/paytrace/api/request_spec.rb
 - test/paytrace/api/response_spec.rb
+- test/paytrace/batch_operations_spec.rb
 - test/paytrace/check_transactions_spec.rb
 - test/paytrace/configuration_spec.rb
 - test/paytrace/credit_card_spec.rb
@@ -148,6 +164,7 @@ files:
 - test/scripts/run_check_transactions.rb
 - test/scripts/run_create_customer.rb
 - test/scripts/run_email_request.rb
+- test/scripts/run_export_batches.rb
 - test/scripts/run_export_customers.rb
 - test/scripts/run_export_transactions.rb
 - test/scripts/run_level3_data.rb
@@ -186,6 +203,7 @@ test_files:
 - test/paytrace/api/gateway_spec.rb
 - test/paytrace/api/request_spec.rb
 - test/paytrace/api/response_spec.rb
+- test/paytrace/batch_operations_spec.rb
 - test/paytrace/check_transactions_spec.rb
 - test/paytrace/configuration_spec.rb
 - test/paytrace/credit_card_spec.rb
@@ -202,6 +220,7 @@ test_files:
 - test/scripts/run_check_transactions.rb
 - test/scripts/run_create_customer.rb
 - test/scripts/run_email_request.rb
+- test/scripts/run_export_batches.rb
 - test/scripts/run_export_customers.rb
 - test/scripts/run_export_transactions.rb
 - test/scripts/run_level3_data.rb