paytrace 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7823d38c4a275aeab478b25d379d7602224cad3d
-  data.tar.gz: 34e1abb081f2d8b63ab21986b67ac38078e0edc9
+  metadata.gz: e13cfd13c9fa4d9c8ec7b4fc6e950bd3b2923a3f
+  data.tar.gz: d407555a86e3e4193e9fb38a66eecd47701350c1
 SHA512:
-  metadata.gz: 7367901908882b94361f6f2ded694a98bc3a926e26aeb675bc54aa214375a4093842c765f914c6abb052c2d47d0a092e68af914f76f5946dfa78bb538dcecc3e
-  data.tar.gz: 8c24e2639e2d277709dd27274150ac3749fc2f3516b74d37889d2ad8d038391c0de41965739f594c6993e154ae76613d2713fb60082c67b4b6cf73c1411614b2
+  metadata.gz: f3e0613a8cdddcfa3800e120ce48da58353cc6886af2100e5db2922f3cc2503ade41ca24f380e294530d6deb50f5ccce1121c32782056b4916e8a973a1cc07b3
+  data.tar.gz: f74214c1513e428e24a7b245693a441d536d4f1ffd24990f7c8f0c473ce9ffe3199818fa0c10b965fbbe60c4f5473eee902715cd92a8ff9d83686973ac8eaf43

data/lib/paytrace/api/fields.rb

@@ -12,11 +12,16 @@ module PayTrace
         description: "DESCRIPTION",
         tax_amount: "TAX",
         return_clr: "RETURNCLR",
+        return_bin: "RETURNBIN",
         enable_partial_authentication: "ENABLEPARTIALAUTH",
         custom_dba: "CUSTOMDBA",
         invoice:"INVOICE",
         transaction_id:"TRANXID",
+        transaction_user:"USER",
+        search_text:"SEARCHTEXT",
         check_id:"CHECKID",
+        start_date:"SDATE",
+        end_date:"EDATE",
         #credit card
         card_number: "CC",
         expiration_year: "EXPYR",
@@ -62,7 +67,10 @@ module PayTrace
         recur_start: "START",
         recur_count: "TOTALCOUNT",
         recur_receipt: "CUSTRECEIPT",
-        recur_type: "RECURTYPE"
+        recur_type: "RECURTYPE",
+        # attach signatures
+        image_data: "IMAGEDATA",
+        image_type: "IMAGETYPE"
       }
     end
   end

data/lib/paytrace/api/gateway.rb

@@ -41,7 +41,7 @@ module PayTrace
         @@raise_exceptions = raise_exceptions
       end
 
-      def send_request(request)
+      def send_request(request, multi_value_fields = [])
         @@last_request = request.to_parms_string if @@debug
         unless (@@debug && @@next_response)
           res = @connection.post PayTrace.configuration.url, parmlist: request.to_parms_string
@@ -51,7 +51,7 @@ module PayTrace
         end
         
         @@last_response = raw_response
-        response = PayTrace::API::Response.new(raw_response)
+        response = PayTrace::API::Response.new(raw_response, multi_value_fields)
         @@last_response_object = response
 
         @@next_response = nil # just to be sure

data/lib/paytrace/api/response.rb

@@ -3,12 +3,13 @@ module PayTrace
     class Response
       attr_reader :values, :errors
 
-      def initialize(response_string)
+      def initialize(response_string, multi_value_fields = [])
         @field_delim = "|"
         @value_delim = "~"
+        @multi_value_delim = "+"
         @values = {}
         @errors = {}
-        parse_response(response_string)
+        parse_response(response_string, multi_value_fields)
       end
 
       def response_code
@@ -19,7 +20,7 @@ module PayTrace
            @errors.length > 0
       end
 
-      def parse_response(response_string)
+      def parse_response(response_string, multi_value_fields = [])
 
         if (response_string.include? "ERROR")
            return parse_errors(response_string)
@@ -28,7 +29,12 @@ module PayTrace
         pairs = response_string.split(@field_delim)
         pairs.each do |p|
           k,v = p.split(@value_delim)
-          @values[k] = v
+          if multi_value_fields.include?(k)
+            @values[k] ||= []
+            @values[k] << Hash[v.split(@multi_value_delim).map {|pair| pair.split('=')}]
+          else
+            @values[k] = v
+          end
         end
       end
 

data/lib/paytrace/transaction.rb

@@ -1,6 +1,8 @@
 require 'paytrace/api/request'
 require 'paytrace/api/gateway'
 require 'paytrace/address'
+require 'base64'
+
 module PayTrace
   module TransactionOperations
     def sale(args)
@@ -83,14 +85,14 @@ module PayTrace
     attr_accessor :response, :discretionary_data
 
     TRANSACTION_METHOD = "PROCESSTRANX"
-
+    EXPORT_TRANSACTIONS_METHOD = "ExportTranx"
+    EXPORT_TRANSACTIONS_RESPONSE = "TRANSACTIONRECORD"
+    ATTACH_SIGNATURE_METHOD = "AttachSignature"
 
     def set_shipping_same_as_billing()
         @shipping_address = @billing_address
     end
 
-
-
     def initialize(params = {})
       @amount = params[:amount]
       @credit_card = params[:credit_card]
@@ -115,6 +117,41 @@ module PayTrace
       end
     end
 
+    def self.export(params = {})
+      request = PayTrace::API::Request.new
+      request.set_param(:method, EXPORT_TRANSACTIONS_METHOD)
+      request.set_param(:transaction_id, params[:transaction_id])
+      request.set_param(:start_date, params[:start_date])
+      request.set_param(:end_date, params[:end_date])
+      request.set_param(:transaction_type, params[:transaction_type])
+      request.set_param(:customer_id, params[:customer_id])
+      request.set_param(:transaction_user, params[:transaction_user])
+      request.set_param(:return_bin, params[:return_bin])
+      request.set_param(:search_text, params[:search_test])
+
+      gateway = PayTrace::API::Gateway.new
+      response = gateway.send_request(request, [EXPORT_TRANSACTIONS_RESPONSE])
+
+      unless response.has_errors?
+        response.values[EXPORT_TRANSACTIONS_RESPONSE]
+      end
+    end
+
+    def self.attach_signature(params = {})
+      request = PayTrace::API::Request.new
+      request.set_param(:method, ATTACH_SIGNATURE_METHOD)
+      request.set_param(:image_data, params[:image_data])
+      request.set_param(:image_type, params[:image_type])
+      if params.has_key?(:image_file)
+        File.open(params[:image_file], 'rb') do |file|
+          request.set_param(:image_data, Base64.encode64(file.read))
+        end
+      end
+
+      gateway = PayTrace::API::Gateway.new
+      gateway.send_request(request)
+    end
+
     private
     def add_transaction_info(request)
       request.set_param(:transaction_type, type)

data/lib/paytrace/version.rb

@@ -1,3 +1,3 @@
 module PayTrace
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/test/paytrace/transaction_spec.rb

@@ -1,6 +1,30 @@
 require File.expand_path(File.dirname(__FILE__) + '../../test_helper.rb')
 
 describe PayTrace::Transaction do
+  it "exports transaction(s)" do
+    PayTrace::API::Gateway.debug = true
+    PayTrace::API::Gateway.next_response = "TRANSACTIONRECORD~TRANXID=1143"
+    records = PayTrace::Transaction.export({transaction_id: 1143})
+    records.must_be_instance_of Array
+    records.count.must_equal 1
+    records[0].must_be_instance_of Hash
+    records[0]["TRANXID"].must_equal "1143"
+  end
+
+  it "successfully attaches base-64 encoded signatures to transactions" do
+    PayTrace::API::Gateway.debug = true
+    PayTrace::API::Gateway.next_response = "RESPONSE~172. The signature image was successfully attached to Transaction ID 13192003.|"
+    result = PayTrace::Transaction.attach_signature({transaction_id: 13192003, image_data: "foo", image_type: "png"})
+    result.has_errors?.must_equal false
+  end
+
+  it "successfully attaches image files to transactions" do
+    PayTrace::API::Gateway.debug = true
+    PayTrace::API::Gateway.next_response = "RESPONSE~172. The signature image was successfully attached to Transaction ID 13192003.|"
+    result = PayTrace::Transaction.attach_signature({transaction_id: 13192003, image_file: __FILE__, image_type: "png"})
+    result.has_errors?.must_equal false
+  end
+
   describe "create sales transactions" do
     before do
       @response = mock()

data/test/scripts/run_attach_signature.rb

@@ -0,0 +1,50 @@
+$:<< "./lib"
+
+require "paytrace"
+
+# see: http://help.paytrace.com/api-email-receipt for details
+
+#
+# Helper that loops through the response values and dumps them out
+#
+def dump_transaction
+  puts "[REQUEST] #{PayTrace::API::Gateway.last_request}"
+  response = PayTrace::API::Gateway.last_response_object
+  if(response.has_errors?)
+    response.errors.each do |key, value|
+      puts "[RESPONSE] ERROR: #{key.ljust(20)}#{value}"
+    end
+  else
+    response.values.each do |key, value|
+      puts "[RESPONSE] #{key.ljust(20)}#{value}"
+    end
+  end
+end
+
+def log(msg)
+  puts ">>>>>>           #{msg}"
+end
+
+def trace(&block)
+  PayTrace::API::Gateway.debug = true
+
+  begin
+    yield
+  rescue Exception => e
+    raise
+  else
+    dump_transaction
+  end
+end
+
+PayTrace.configure do |config|
+  config.user_name = "demo123"
+  config.password = "demo123"
+  config.domain = "stage.paytrace.com"
+end
+
+PayTrace::API::Gateway.debug = true
+
+trace {
+  PayTrace::Transaction.attach_signature({image_file: File.expand_path('smiley_face.png', File.dirname(__FILE__)), image_type: "PNG"})
+}

data/test/scripts/run_export_transactions.rb

@@ -0,0 +1,54 @@
+$:<< "./lib"
+
+require "paytrace"
+
+# see: http://help.paytrace.com/api-email-receipt for details
+
+#
+# Helper that loops through the response values and dumps them out
+#
+def dump_transaction
+  puts "[REQUEST] #{PayTrace::API::Gateway.last_request}"
+  response = PayTrace::API::Gateway.last_response_object
+  if(response.has_errors?)
+    response.errors.each do |key, value|
+      puts "[RESPONSE] ERROR: #{key.ljust(20)}#{value}"
+    end
+  else
+    response.values.each do |key, value|
+      puts "[RESPONSE] #{key.ljust(20)}#{value}"
+    end
+  end
+end
+
+def log(msg)
+  puts ">>>>>>           #{msg}"
+end
+
+def trace(&block)
+  PayTrace::API::Gateway.debug = true
+
+  begin
+    yield
+  rescue Exception => e
+    raise
+  else
+    dump_transaction
+  end
+end
+
+PayTrace.configure do |config|
+  config.user_name = "demo123"
+  config.password = "demo123"
+  config.domain = "stage.paytrace.com"
+end
+
+PayTrace::API::Gateway.debug = true
+
+params = {
+  start_date: "04/01/2014",
+  end_date: "05/31/2014",
+  transaction_id: 1143
+}
+
+trace { puts PayTrace::Transaction.export(params) }

data/test/scripts/run_recur_payments_integration.rb

@@ -20,7 +20,7 @@ def dump_transaction
 end
 
 def log(msg)
-  puts ">>>>>> #{msg}"
+  puts ">>>>>>           #{msg}"
 end
 
 def trace(&block)
@@ -53,7 +53,11 @@ ba = PayTrace::Address.new({
   postal_code: "98133",
   address_type: :billing
   })
-extra = {
+
+params = {
+  customer_id: "john_doe",
+  credit_card: cc,
+  billing_address: ba,
   email: "support@paytrace.com",
   phone: "206-555-1212",
   fax: "206-555-1313",
@@ -68,6 +72,7 @@ PayTrace::API::Gateway.debug = true
 begin
   log "Attempting to remove existing customer 'john_doe'..."
   c = PayTrace::Customer.new("john_doe")
+  # delete customer "john_doe" if he already exists
   trace { c.delete() }
 rescue PayTrace::Exceptions::ErrorResponse
   log "No such cusomter... continuing..."
@@ -76,7 +81,9 @@ end
 log "Creating customer john_doe..."
 begin
   trace do
-    c = PayTrace::Customer.from_cc_info({customer_id: "john_doe", credit_card: cc, billing_address: ba}.merge(extra))
+    ################
+    # create "john_doe" profile from credit card information and a billing address. Also include extra information such as email, phone, and fax
+    c = PayTrace::Customer.from_cc_info(params)
     log "Customer ID: #{c.id}"
   end
 rescue
@@ -102,6 +109,8 @@ params = {
 }
 
 trace do
+  ################
+  # create a recurring payment for "john_doe" of $9.99 every month starting on 4/22/2016, running indefinitely. Send a receipt.
   recur_id = PayTrace::RecurringTransaction.create(params)
   log "Recurrence ID: #{recur_id}"
 end
@@ -109,6 +118,8 @@ end
 begin
   log "Exporting recurring transaction..."
   trace do
+    ################
+    # export any scheduled recurring transactions for "john_doe" to a RecurringTransaction object...
     exported = PayTrace::RecurringTransaction.export_scheduled({customer_id: "john_doe"})
     log "Exported transaction:\n#{exported.inspect}"
   end
@@ -117,7 +128,11 @@ rescue
 end
 
 log "Deleting recurrences for 'john_doe'..."
+################
+# delete any scheduled recurring transactions for "john_doe"
 trace { PayTrace::RecurringTransaction.delete({customer_id: "john_doe"}) }
 
 log "Deleting customer 'john_doe'..."
+################
+# delete "john doe"
 trace { c.delete() }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paytrace
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Trevor Redfern
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-04 00:00:00.000000000 Z
+date: 2014-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -137,9 +137,12 @@ files:
 - test/paytrace/exceptions_spec.rb
 - test/paytrace/recurring_transaction_spec.rb
 - test/paytrace/transaction_spec.rb
+- test/scripts/run_attach_signature.rb
 - test/scripts/run_create_customer.rb
 - test/scripts/run_email_request.rb
+- test/scripts/run_export_transactions.rb
 - test/scripts/run_recur_payments_integration.rb
+- test/scripts/smiley_face.png
 - test/test_helper.rb
 - vagrant-bootstrap.sh
 homepage: http://github.com/PayTrace/paytrace_ruby
@@ -179,7 +182,10 @@ test_files:
 - test/paytrace/exceptions_spec.rb
 - test/paytrace/recurring_transaction_spec.rb
 - test/paytrace/transaction_spec.rb
+- test/scripts/run_attach_signature.rb
 - test/scripts/run_create_customer.rb
 - test/scripts/run_email_request.rb
+- test/scripts/run_export_transactions.rb
 - test/scripts/run_recur_payments_integration.rb
+- test/scripts/smiley_face.png
 - test/test_helper.rb