paytrace 0.1.18 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b8c933ace0d385e68fb1fa6763ef764d969160c
-  data.tar.gz: 2c0f4df1ebd158e3d95e0dcfb4b178583a426f05
+  metadata.gz: 320dcdc4504f93ee689d060590f765241e9b2e2b
+  data.tar.gz: 8babaffbd61ff385240e26268c4ac9b16002195f
 SHA512:
-  metadata.gz: 4757b23b7fa51b37b985c3aee2a8cf33602bf1a52eb600ece91849be7f8751a1510ea1b0717176cf6e868851c1bd74e85b3578a89e017a4c4b319a2fbeff19ec
-  data.tar.gz: 2765509db5fa83ead7620de56e9160825d74452c9e396955412517af4cb155f385f2495ae3e982a375b84a7ec2bc8de8e6fea25c276a4a0eb2ed972f35dc5c75
+  metadata.gz: dade330968ea5744206631a953abde4f18aab0a2757f0d0678409931497646dfd522cdd68e51f1e7c01406f3fe6cf9d4ee692b69e17f8890456b37a732a95371
+  data.tar.gz: d2ff117c82ecb19ceda25508cd96a460926c31bdbe0c25ff5e94ae297b4d718cea61722badefdbb3c187ab912219a0046c79a7617938e666ad81d753f51c7e60

data/lib/paytrace/api/fields.rb

@@ -106,7 +106,9 @@ module PayTrace
         source_zip: "SOURCEZIP",
         source_state: "SOURCESTATE",
         shipping_weight: "WEIGHT",
-        shippers: "SHIPPERS"
+        shippers: "SHIPPERS",
+        # test flag
+        test_flag: "TEST"
       }
     end
   end

data/lib/paytrace/check_transaction.rb

@@ -1,16 +1,66 @@
 module PayTrace
   class CheckTransaction
     PROCESS_SALE_METHOD = "ProcessCheck"
+    MANAGE_CHECK_METHOD = "ManageCheck"
 
     def self.process_sale(params = {})
       request = PayTrace::API::Request.new
       request.set_param(:method, PROCESS_SALE_METHOD)
+      self.add_common_parameters(params, request)
+
+      gateway = PayTrace::API::Gateway.new
+      response = gateway.send_request(request)      
+      unless response.has_errors?
+        response.values
+      end
+    end
+
+    def self.process_hold(params = {})
+      request = PayTrace::API::Request.new
+      request.set_param(:method, PROCESS_SALE_METHOD)
+      params.delete(:check_type) # make sure we don't duplicate this
+      self.add_common_parameters(params, request)
+      request.set_param(:check_type, "Hold")
+
+      gateway = PayTrace::API::Gateway.new
+      response = gateway.send_request(request)      
+      unless response.has_errors?
+        response.values
+      end
+    end
+
+    def self.process_refund(params = {})
+      request = PayTrace::API::Request.new
+      request.set_param(:method, PROCESS_SALE_METHOD)
+      params.delete(:check_type) # make sure we don't duplicate this
+      self.add_common_parameters(params, request)
+      request.set_param(:check_id, params[:check_id])
+      request.set_param(:check_type, "Refund")
+
+      gateway = PayTrace::API::Gateway.new
+      response = gateway.send_request(request)      
+      unless response.has_errors?
+        response.values
+      end
+    end
+
+    def self.manage_check(params = {})
+      request = PayTrace::API::Request.new
+      request.set_param(:method, MANAGE_CHECK_METHOD)
+      request.set_params([:check_type, :check_id], params)
+
+      gateway = PayTrace::API::Gateway.new
+      response = gateway.send_request(request)      
+      unless response.has_errors?
+        response.values
+      end
+    end
+
+    def self.add_common_parameters(params = {}, request)
       request.set_params([
         :check_type, 
         :amount, :customer_id, :account_number, :routing_number,
-        :billing_name, :billing_address, :billing_address2, :billing_city, :billing_state, :billing_postal_code, :billing_country,
-        :shipping_name, :shipping_address, :shipping_address2, :shipping_city, :shipping_region, :shipping_state, :shipping_postal_code, :shipping_country,
-        :email, :invoice, :description, :tax_amount, :customer_reference_id
+        :email, :invoice, :description, :tax_amount, :customer_reference_id, :test_flag
         ], params)
 
       if params[:discretionary_data] 
@@ -18,11 +68,13 @@ module PayTrace
           request.set_discretionary(k, params[:discretionary_data][k])
         end
       end
-      
-      gateway = PayTrace::API::Gateway.new
-      response = gateway.send_request(request)      
-      unless response.has_errors?
-        response.values
+
+      if params.has_key?(:billing_address)
+        params[:billing_address].set_request(request)
+      end
+
+      if params.has_key?(:shipping_address)
+        params[:shipping_address].set_request(request)
       end
     end
   end

data/lib/paytrace/version.rb

@@ -1,3 +1,3 @@
 module PayTrace
-  VERSION = "0.1.18"
+  VERSION = "0.1.19"
 end

data/test/paytrace/check_transactions_spec.rb

@@ -10,34 +10,153 @@ describe PayTrace::CheckTransaction do
     PayTrace::API::Gateway.reset_trace()
   end
 
-  # UN, PSWD, TERMS, METHOD, CHECKTYPE, AMOUNT, DDA, TR
-  it "should process a check payment via routing number/account number" do
-    PayTrace::API::Gateway.next_response = "RESULT~Ok"
-    params = {
-      check_type: 'foo',
-      amount: 17.29,
-      account_number: 1234567,
-      routing_number: 1234568
-    }
-    result = PayTrace::CheckTransaction.process_sale(params)
-    PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::CheckTransaction::PROCESS_SALE_METHOD) +
-      "CHECKTYPE~foo|AMOUNT~17.29|DDA~1234567|TR~1234568|"
-  end
+  describe "sale transactions" do
+
+    # UN, PSWD, TERMS, METHOD, CHECKTYPE, AMOUNT, DDA, TR
+    it "should process a check payment via routing number/account number" do
+      PayTrace::API::Gateway.next_response = "RESULT~Ok"
+      params = {
+        check_type: 'foo',
+        amount: 17.29,
+        account_number: 1234567,
+        routing_number: 1234568
+      }
+      result = PayTrace::CheckTransaction.process_sale(params)
+      PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::CheckTransaction::PROCESS_SALE_METHOD) +
+        "CHECKTYPE~foo|AMOUNT~17.29|DDA~1234567|TR~1234568|"
+    end
+
+    # UN, PSWD, TERMS, METHOD, CHECKTYPE, AMOUNT, CUSTID
+    it "should process a check payment via customer id" do
+      PayTrace::API::Gateway.next_response = "RESULT~Ok"
+      params = {
+        check_type: 'bar',
+        amount: 17.28,
+        customer_id: 'MMouse'
+      }
+      result = PayTrace::CheckTransaction.process_sale(params)
+      PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::CheckTransaction::PROCESS_SALE_METHOD) +
+        "CHECKTYPE~bar|AMOUNT~17.28|CUSTID~MMouse|"
+    end
+
+
+    it "accepts billing and shipping information" do
+      PayTrace::API::Gateway.next_response = "RESULT~Ok"
+
+      ba = PayTrace::Address.new({
+        name: "John Doe",
+        street: "1234 Main Street",
+        street2: "Apartment 1B",
+        city: "Shoreline",
+        state: "WA",
+        country: "US",
+        postal_code: "98133",
+        address_type: :billing
+      })
+
+      sa = PayTrace::Address.new({
+        name: "Jane Doe",
+        street: "1235 Moon Street",
+        street2: "Apartment 2C",
+        city: "Shortline",
+        state: "WA",
+        country: "US",
+        postal_code: "98134",
+        address_type: :shipping
+      })
+
+      params = {
+        check_type: 'baz',
+        amount: 17.29,
+        customer_id: 'DDuck',
+        billing_address: ba,
+        shipping_address: sa
+      }
+
+      result = PayTrace::CheckTransaction.process_sale(params)
+      PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::CheckTransaction::PROCESS_SALE_METHOD) +
+        "CHECKTYPE~baz|AMOUNT~17.29|CUSTID~DDuck|BNAME~John Doe|BADDRESS~1234 Main Street|BADDRESS2~Apartment 1B|BCITY~Shoreline|BSTATE~WA|BZIP~98133|BCOUNTRY~US|SNAME~Jane Doe|SADDRESS~1235 Moon Street|SADDRESS2~Apartment 2C|SCITY~Shortline|SSTATE~WA|SZIP~98134|SCOUNTRY~US|"
+    end
+
+
+    it "accepts email, invoice, description, tax amount, and customer reference id" do
+      PayTrace::API::Gateway.next_response = "RESULT~Ok"
 
-  # UN, PSWD, TERMS, METHOD, CHECKTYPE, AMOUNT, CUSTID
-  it "should process a check payment via customer id" do
-    PayTrace::API::Gateway.next_response = "RESULT~Ok"
-    params = {
-      check_type: 'bar',
-      amount: 17.28,
-      customer_id: 'MMouse'
-    }
-    result = PayTrace::CheckTransaction.process_sale(params)
-    PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::CheckTransaction::PROCESS_SALE_METHOD) +
-      "CHECKTYPE~bar|AMOUNT~17.28|CUSTID~MMouse|"
+      params = {
+        email: 'foo@bar.com',
+        description: 'You bought something with a check, yo!',
+        invoice: '12345',
+        amount: 17.27,
+        customer_id: 'YosemiteSam',
+        tax_amount: 2.11,
+        customer_reference_id: '1234AB'
+      }
+      result = PayTrace::CheckTransaction.process_sale(params)
+
+      PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::CheckTransaction::PROCESS_SALE_METHOD) +
+        "AMOUNT~17.27|CUSTID~YosemiteSam|EMAIL~foo@bar.com|INVOICE~12345|DESCRIPTION~You bought something with a check, yo!|TAX~2.11|CUSTREF~1234AB|"
+    end
+
+    it "accepts discretionary data" do
+      PayTrace::API::Gateway.next_response = "RESULT~Ok"
+
+      params = {
+        check_type: 'foo',
+        amount: 17.29,
+        account_number: 1234567,
+        routing_number: 1234568,
+        discretionary_data: {hair_color: :red}
+      }
+      result = PayTrace::CheckTransaction.process_sale(params)
+
+      PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::CheckTransaction::PROCESS_SALE_METHOD) +
+        "CHECKTYPE~foo|AMOUNT~17.29|DDA~1234567|TR~1234568|hair_color~red|"
+    end
   end
 
-  it "accepts billing and shipping information"
-  it "accepts email, invoice, description, tax amount, and customer reference id"
-  it "accepts discretionary data"
+  # hold transactions are just sale transactions with a CheckType of "Hold" -- don't need to re-test
+  describe "hold transactions" do
+    it "accepts a routing number/account number hold request" do
+      PayTrace::API::Gateway.next_response = "RESULT~Ok"
+      params = {
+        check_type: 'foo',
+        amount: 17.29,
+        account_number: 1234567,
+        routing_number: 1234568,
+        discretionary_data: {hair_color: :red}
+      }
+      result = PayTrace::CheckTransaction.process_hold(params)
+
+      PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::CheckTransaction::PROCESS_SALE_METHOD) +
+        "AMOUNT~17.29|DDA~1234567|TR~1234568|CHECKTYPE~Hold|hair_color~red|"
+    end
+
+    describe "refund transactions" do
+      it "accepts a check ID" do
+        PayTrace::API::Gateway.next_response = "RESULT~Ok"
+        params = {
+          check_type: 'foo',
+          check_id: 12345678
+        }
+        result = PayTrace::CheckTransaction.process_refund(params)
+
+        PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::CheckTransaction::PROCESS_SALE_METHOD) +
+          "CHECKID~12345678|CHECKTYPE~Refund|"
+      end
+    end
+
+    describe "manage a check" do
+      it "accepts check id" do
+        PayTrace::API::Gateway.next_response = "RESULT~Ok"
+        params = {
+          check_type: 'Hold',
+          check_id: 12345678
+        }
+        result = PayTrace::CheckTransaction.manage_check(params)
+
+        PayTrace::API::Gateway.last_request.must_equal base_url(PayTrace::CheckTransaction::MANAGE_CHECK_METHOD) +
+          "CHECKTYPE~Hold|CHECKID~12345678|"
+      end
+    end
+  end
 end

data/test/scripts/run_adjust_amount.rb

@@ -9,8 +9,8 @@ PayTrace::Debug.configure_test("demo123", "demo123", "stage.paytrace.com")
 PayTrace::Debug.trace do
   params = {
     # this must be a valid transaction ID for the credentials supplied
-    transaction_id: 1131,
-    amount: 4.01
+    transaction_id: 938,
+    amount: 1.01
   }
   PayTrace::Transaction::adjust_amount(params)
 end

data/test/scripts/run_check_transactions.rb

@@ -0,0 +1,21 @@
+$:<< "./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")
+
+# http://help.paytrace.com/api-processing-a-check-sale
+
+PayTrace::Debug.trace do
+  params = {
+  check_type: "Sale",
+  amount: 15.99,
+  # replace this with a valid customer ID
+  customer_id: 'MoMouse',
+  test_flag: 'Y'  
+}
+
+  PayTrace::CheckTransaction::process_sale(params)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paytrace
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
 platform: ruby
 authors:
 - Trevor Redfern
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-01 00:00:00.000000000 Z
+date: 2014-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -145,6 +145,7 @@ files:
 - test/scripts/run_attach_signature.rb
 - test/scripts/run_calculate_shipping_costs.rb
 - test/scripts/run_change_password.rb
+- test/scripts/run_check_transactions.rb
 - test/scripts/run_create_customer.rb
 - test/scripts/run_email_request.rb
 - test/scripts/run_export_customers.rb
@@ -198,6 +199,7 @@ test_files:
 - test/scripts/run_attach_signature.rb
 - test/scripts/run_calculate_shipping_costs.rb
 - test/scripts/run_change_password.rb
+- test/scripts/run_check_transactions.rb
 - test/scripts/run_create_customer.rb
 - test/scripts/run_email_request.rb
 - test/scripts/run_export_customers.rb