paytrace 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bd07fbb1aa8790f15aef76475889b670c70dcf6
-  data.tar.gz: 3278c3fb6a5dbd3ee70a37fe3c936d077c9ea665
+  metadata.gz: 3d869a7a1682a69f321a50d93bd9e866c4149f1a
+  data.tar.gz: f71c44dd7d62b4aa4fd233342c3f3dbfe4d24ae0
 SHA512:
-  metadata.gz: f91baaad3173806193bc0ca109975cd16617b0a5423e03f9cfc127c0e338abcf077ee285e17b64a60a866198bc7130a282104af75d7450611187df54f2cc1a9f
-  data.tar.gz: e900959662bf88b1b3b196db6d431d67952b3e492c98cf8c94ef1b8516840e8742c98ec344d26d217f6f7b4e1062f13ea0ea62fec04df8dbf53dedfa40d91f88
+  metadata.gz: 00ef5897480340a8f83e9e690d8057e39706398215f46e5c55ea106b5a218a9f8eaa17242f4116f8877a22ce4eb900c1feb6e415862aa19e19a33d225b9fe856
+  data.tar.gz: 21f438fc6405a3cb60333b15860b1f04a01f5fda2d13f8cb561dfa5bce75dcbba5d6b11efecdb497e4c110e2ab106ab4f04164b000cab3405b793c1da70c69de

data/README.md

@@ -2,11 +2,6 @@
 
 ![Build Status](https://www.codeship.io/projects/611ffe60-f3ee-0130-0299-1a84c3740ef1/status)
 
-*This SDK is actively under development but should still be considered in an alpha
-state. It does not provide all the access we are planning to our API at this time.
-Please feel free to experiment with it and we will be regularly pushing out new
-updates with increased functionality over the coming weeks*
-
 This gem integrates with the PayTrace API. It provides functionality to the
 publicly available functionality including:
 
@@ -14,6 +9,7 @@ publicly available functionality including:
  * Creating Customers
  * Exporting Transaction or Customer Data
 
+ Note that the gem is intended to be a "thin shim" around the public API, cleaning up and organizing the URL-based function calls. It is designed to be consumed by other code for payment processing.
 
 ## Installation
 
@@ -46,15 +42,15 @@ end
 ### Transactions
 
 Transactions can be processed utilizing class methods on the PayTrace::Transaction
-class.
+class. A simple example:
 
 ```ruby
-transaction = Transaction.sale(
-    {amount: "1.00",
-    credit_card: {
-        card_number: "1111222233334444",
-        expiration_year: 14,
-        expiration_month: 3
+response = Transaction.sale(
+    {
+      amount: "1.00",
+      card_number: "1111222233334444",
+      expiration_year: 14,
+      expiration_month: 3
     }
   }
 )
@@ -62,12 +58,12 @@ transaction = Transaction.sale(
 #
 ## Response information is available on the transaction
 #
-puts transaction.response_code # 101. Your transaction was successfully approved.
+puts response.get_response() # 101. Your transaction was successfully approved.
 
 #
-## All values returned are accessible through the attached response property
+## All values returned are accessible through the response
 #
-transaction.response.each do |key, value|
+response.values do |key, value|
     puts key      # e.g. APPCODE
     puts value    # TAS671
 end
@@ -77,21 +73,19 @@ end
 
 ```ruby
 # running a transaction for a customer
-transaction = Transaction.sale({amount: "1.00",customer: my_customer_id})
+Transaction.sale({amount: "1.00",customer: my_customer_id})
 
 ```
 ### Some Optional Fields
 ```ruby
 #Adding Optional Fields
 
-transaction = Transaction.Sale(
+Transaction.Sale(
   {
     amount: "1.00",
-    credit_card: {
-        card_number: "1111222233334444",
-        expiration_year: 14,
-        expiration_month: 3
-    },
+    card_number: "1111222233334444",
+    expiration_year: 14,
+    expiration_month: 3,
     email:"me@example.com",
     description:"This is a test",
     tax_amount:".50",
@@ -103,27 +97,20 @@ transaction = Transaction.Sale(
 
 ### Billing and Shipping Address
 ```ruby
-transaction = Transaction.Sale(
-    {amount: "1.00",
-    credit_card: {
+Transaction.Sale(
+    {
+      amount: "1.00",
       card_number: "1111222233334444",
       expiration_year: 14,
-      expiration_month: 3
-    },  
-    billing_address:{
-        name:"Jane Doe",
-        street:"1234 happy st.",
-        street2:"apt#2",
-        city:"Seattle",
-        state:"WA",
-        country: "US",
-        postal_code:"98107"
-    },
-      shipping_address: {
-        #Same as billing above.
-      }
-    }
-)
+      expiration_month: 3,  
+      billing_name:"Jane Doe",
+      billing_address:"1234 happy st.",
+      billing_address2:"apt#2",
+      billing_city:"Seattle",
+      billing_state:"WA",
+      billing_country: "US",
+      billing_postal_code:"98107"
+    })
 
 ```
 

data/lib/paytrace/api/gateway.rb

@@ -92,7 +92,7 @@ module PayTrace
         @@next_response = nil # just to be sure
 
         if @@raise_exceptions && response.has_errors?
-          raise PayTrace::Exceptions::ErrorResponse.new(response.get_response())
+          raise PayTrace::Exceptions::ErrorResponse.new(response)
         else
           response
         end

data/lib/paytrace/debug.rb

@@ -42,9 +42,10 @@ module PayTrace
 
       begin
         yield
-      rescue Exception => e
+      rescue PayTrace::Exceptions::ErrorResponse => e
         puts "[REQUEST] #{PayTrace::API::Gateway.last_request}"
-
+        puts "[RESPONSE] #{PayTrace::API::Gateway.last_response}"
+        
         raise
       else
         dump_transaction
@@ -61,12 +62,17 @@ module PayTrace
       end
     end
 
+    # helper method to make CodeClimate happy
+    def self.split_tuples(raw, case_sensitive = false)
+      PayTrace::Debug.split_request_string(raw).map {|tuple| case_sensitive ? tuple : [tuple[0].upcase, tuple[1]]}
+    end
+
     # verify whether two requests match
     def self.diff_requests(expected_raw, actual_raw, case_sensitive = false)
       whats_wrong = []
 
-      expected = PayTrace::Debug.split_request_string(expected_raw).map {|tuple| case_sensitive ? tuple : [tuple[0].upcase, tuple[1]]}
-      actual = PayTrace::Debug.split_request_string(actual_raw).map {|tuple| case_sensitive ? tuple : [tuple[0].upcase, tuple[1]]}
+      expected = PayTrace::Debug.split_tuples(expected_raw, case_sensitive)
+      actual = PayTrace::Debug.split_tuples(actual_raw, case_sensitive)
 
       expected_remaining = []
       actual_extra = actual.dup

data/lib/paytrace/exceptions.rb

@@ -11,6 +11,15 @@ module PayTrace
 
     # Raised by default when an error response is returned from the server
     class ErrorResponse < Base
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+
+      def to_s
+        @response.get_response()
+      end
     end
   end
 end

data/lib/paytrace/transaction.rb

@@ -90,6 +90,21 @@ module PayTrace
 
     STORE_AND_FORWARD_OPTIONAL = ALL_OPTIONAL_FIELDS + [:store_forward_date]
 
+    CASH_ADVANCE_REQUIRED = [
+      :transaction_type,
+      :amount,
+      :cash_advance,
+      :id_number,
+      :id_expiration,
+      :cc_last_4,
+      :billing_name,
+      :billing_address,
+      :billing_address2,
+      :billing_city,
+      :billing_state,
+      :billing_postal_code
+    ]
+
     CASH_ADVANCE_OPTIONAL = [
       :billing_country,
       :shipping_name,
@@ -119,10 +134,7 @@ module PayTrace
     # * *:expiration_month* -- the expiration month of the credit card
     # * *:expiration_year* -- the expiration year of the credit card
     def self.keyed_sale(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::SALE}),
-        KEYED_SALE_REQUEST_REQUIRED,
-        KEYED_SALE_REQUEST_OPTIONAL)
+      send_transaction(params, TransactionTypes::SALE, KEYED_SALE_REQUEST_REQUIRED, KEYED_SALE_REQUEST_OPTIONAL)
     end
 
     # See http://help.paytrace.com/api-sale
@@ -134,10 +146,7 @@ module PayTrace
     # * *:amount* -- the amount of the transaction
     # * *:swipe* -- credit card swipe data (card swiped sales)
     def self.swiped_sale(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::SALE}),
-        SWIPED_SALE_REQUEST_REQUIRED,
-        SWIPED_SALE_REQUEST_OPTIONAL)
+      send_transaction(params, TransactionTypes::SALE, SWIPED_SALE_REQUEST_REQUIRED, SWIPED_SALE_REQUEST_OPTIONAL)
     end
 
     # See http://help.paytrace.com/api-sale
@@ -177,10 +186,7 @@ module PayTrace
     # * *:custom_dba* -- optional value that is sent to the cardholder’s issuer and overrides the business name stored in PayTrace. Custom DBA values are only used with requests to process sales or authorizations through accounts on the TSYS/Vital, Heartland, and Trident networks (customer ID token sale)
     # * *:enable_partial_authentication* -- flag that must be set to ‘Y’ in order to support partial authorization and balance amounts in transaction responses (customer ID token sale)
     def self.customer_id_sale(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::SALE}),
-        CUSTID_SALE_REQUEST_REQUIRED,
-        CUSTID_SALE_REQUEST_OPTIONAL)
+      send_transaction(params, TransactionTypes::SALE, CUSTID_SALE_REQUEST_REQUIRED, CUSTID_SALE_REQUEST_OPTIONAL)
     end
 
     # See http://help.paytrace.com/api-authorizations
@@ -194,9 +200,11 @@ module PayTrace
     # * *:expiration_month* -- the expiration month of the credit card
     # * *:expiration_year* -- the expiration year of the credit card
     def self.keyed_authorization(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::Authorization}),
-        [:transaction_type, :amount, :card_number, :expiration_month, :expiration_year])
+      send_transaction(
+        params,
+        TransactionTypes::Authorization,
+        [:transaction_type, :amount, :card_number, :expiration_month, :expiration_year],
+        [])
     end
 
     # See http://help.paytrace.com/api-authorizations
@@ -208,8 +216,7 @@ module PayTrace
     # * *:amount* -- the amount of the transaction
     # * *:customer_id* -- the customer ID to reference for this authorization
     def self.customer_id_authorization(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::Authorization}), [:transaction_type, :amount, :customer_id])
+      send_transaction(params, TransactionTypes::Authorization, [:transaction_type, :amount, :customer_id], [])
     end
 
     # See http://help.paytrace.com/api-refunds
@@ -249,8 +256,7 @@ module PayTrace
     # * *:custom_dba* -- optional value that is sent to the cardholder’s issuer and overrides the business name stored in PayTrace. Custom DBA values are only used with requests to process sales or authorizations through accounts on the TSYS/Vital, Heartland, and Trident networks (customer ID token sale)
     # * *:enable_partial_authentication* -- flag that must be set to ‘Y’ in order to support partial authorization and balance amounts in transaction responses (customer ID token sale)
     def self.swiped_refund(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::Refund}), [:transaction_type, :amount, :swipe], REFUND_OPTIONAL)
+      send_transaction(params, TransactionTypes::Refund, [:transaction_type, :amount, :swipe], REFUND_OPTIONAL)
     end
 
     # See http://help.paytrace.com/api-refunds
@@ -266,13 +272,11 @@ module PayTrace
     # 
     # _Note:_ optional parameters are identical to those for swiped_refund
     def self.keyed_refund(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD, 
-        params.merge({transaction_type: TransactionTypes::Refund}), [
-          :transaction_type,
-          :amount,
-          :card_number,
-          :expiration_month,
-          :expiration_year], REFUND_OPTIONAL)
+      send_transaction(
+        params,
+        TransactionTypes::Refund,
+        [:transaction_type, :amount, :card_number, :expiration_month, :expiration_year],
+        REFUND_OPTIONAL)
     end
     
 
@@ -287,8 +291,11 @@ module PayTrace
     # 
     # _Note:_ optional parameters are identical to those for swiped_refund
     def self.customer_id_refund(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::Refund}), [:transaction_type, :amount, :customer_id], REFUND_OPTIONAL)
+      send_transaction(
+        params,
+        TransactionTypes::Refund,
+        [:transaction_type, :amount, :customer_id],
+        REFUND_OPTIONAL)
     end
 
 
@@ -303,8 +310,11 @@ module PayTrace
     # 
     # _Note:_ optional parameters are identical to those for swiped_refund
     def self.transaction_id_refund(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::Refund}), [:transaction_type, :transaction_id], REFUND_OPTIONAL)
+      send_transaction(
+        params, 
+        TransactionTypes::Refund,
+        [:transaction_type, :transaction_id],
+        REFUND_OPTIONAL)
     end
 
     # See http://help.paytrace.com/api-void
@@ -315,8 +325,7 @@ module PayTrace
     #
     # * *:transaction_id* -- the transaction ID to void
     def self.void(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::Void}), [:transaction_type, :transaction_id])
+      send_transaction(params, TransactionTypes::Void, [:transaction_type, :transaction_id], [])
     end
 
     # See http://help.paytrace.com/api-forced-sale
@@ -329,8 +338,10 @@ module PayTrace
     # * *:swipe* -- credit card swipe data (card swiped sales)
     # * *:approval_code* -- the approval code obtained external to the PayTrace system
     def self.swiped_forced_sale(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::ForcedSale}), [:transaction_type, :amount, :swipe, :approval_code],
+      send_transaction(
+        params,
+        TransactionTypes::ForcedSale,
+        [:transaction_type, :amount, :swipe, :approval_code],
         ADDRESSES_AND_EXTRA)
     end
 
@@ -346,8 +357,10 @@ module PayTrace
     # * *:expiration_year* -- the expiration year of the credit card
     # * *:approval_code* -- the approval code obtained external to the PayTrace system
     def self.keyed_forced_sale(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::ForcedSale}), [:transaction_type, :amount, :card_number, :expiration_month, :expiration_year, :approval_code],
+      send_transaction(
+        params,
+        TransactionTypes::ForcedSale,
+        [:transaction_type, :amount, :card_number, :expiration_month, :expiration_year, :approval_code],
         ADDRESSES_AND_EXTRA)
     end
 
@@ -361,8 +374,10 @@ module PayTrace
     # * *:customer_id -- the customer ID for the forced sale 
     # * *:approval_code* -- the approval code obtained external to the PayTrace system
     def self.customer_id_forced_sale(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::ForcedSale}), [:transaction_type, :amount, :customer_id, :approval_code],
+      send_transaction(
+        params,
+        TransactionTypes::ForcedSale,
+        [:transaction_type, :amount, :customer_id, :approval_code],
         ADDRESSES_AND_EXTRA)
     end
 
@@ -376,8 +391,10 @@ module PayTrace
     # * *:transaction_id -- the transaction ID for the forced sale 
     # * *:approval_code* -- the approval code obtained external to the PayTrace system
     def self.transaction_id_forced_sale(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::ForcedSale}), [:transaction_type, :transaction_id, :approval_code],
+      send_transaction(
+        params,
+        TransactionTypes::ForcedSale,
+        [:transaction_type, :transaction_id, :approval_code],
         ADDRESSES_AND_EXTRA)
     end
 
@@ -389,8 +406,11 @@ module PayTrace
     #
     # * *transaction_id* -- the transaction ID to be captured
     def self.capture(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::Capture}), [:transaction_type, :transaction_id])
+      send_transaction(
+        params,
+        TransactionTypes::Capture,
+        [:transaction_type, :transaction_id],
+        [])
     end
 
     # See http://help.paytrace.com/api-cash-advance
@@ -426,21 +446,11 @@ module PayTrace
     # * *:tax_amount* -- the amount of tax on the sale (customer ID token or referenced transaction sale)
     # * *:customer_reference_id* -- a customer reference ID (customer ID token or referenced transaction sale)
     def self.swiped_cash_advance(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::SALE, cash_advance: 'Y'}), [
-          :transaction_type,
-          :amount,
-          :swipe,
-          :cash_advance,
-          :id_number,
-          :id_expiration,
-          :cc_last_4,
-          :billing_name,
-          :billing_address,
-          :billing_address2,
-          :billing_city,
-          :billing_state,
-          :billing_postal_code], CASH_ADVANCE_OPTIONAL)
+      send_transaction(
+        {cash_advance: 'Y'}.merge(params),
+        TransactionTypes::SALE,
+        CASH_ADVANCE_REQUIRED + [:swipe],
+        CASH_ADVANCE_OPTIONAL)
     end
 
     # See http://help.paytrace.com/api-cash-advance
@@ -478,23 +488,11 @@ module PayTrace
     # * *:tax_amount* -- the amount of tax on the sale (customer ID token or referenced transaction sale)
     # * *:customer_reference_id* -- a customer reference ID (customer ID token or referenced transaction sale)
     def self.keyed_cash_advance(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::SALE, cash_advance: 'Y'}), [
-          :transaction_type,
-          :amount,
-          :card_number,
-          :expiration_month,
-          :expiration_year,
-          :cash_advance,
-          :id_number,
-          :id_expiration,
-          :cc_last_4,
-          :billing_name,
-          :billing_address,
-          :billing_address2,
-          :billing_city,
-          :billing_state,
-          :billing_postal_code], CASH_ADVANCE_OPTIONAL)
+      send_transaction(
+        {cash_advance: 'Y'}.merge(params), 
+        TransactionTypes::SALE,
+        CASH_ADVANCE_REQUIRED + [:card_number, :expiration_month, :expiration_year],
+        CASH_ADVANCE_OPTIONAL)
       end
 
     # See http://help.paytrace.com/api-store-and-forward
@@ -535,8 +533,7 @@ module PayTrace
     # * *:enable_partial_authentication* -- flag that must be set to ‘Y’ in order to support partial authorization and balance amounts in transaction responses (customer ID token sale)
     # * *:store_forward_date* -- optional future date when the transaction should be authorized and settled. Only applicable if the TranxType is STR/FWD
     def self.swiped_store_forward(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::StoreForward}), [:transaction_type, :amount, :swipe], STORE_AND_FORWARD_OPTIONAL)
+      send_transaction(params, TransactionTypes::StoreForward, [:transaction_type, :amount, :swipe], STORE_AND_FORWARD_OPTIONAL)
     end
 
     # See http://help.paytrace.com/api-store-and-forward
@@ -579,8 +576,11 @@ module PayTrace
     # * *:enable_partial_authentication* -- flag that must be set to ‘Y’ in order to support partial authorization and balance amounts in transaction responses (customer ID token sale)
     # * *:store_forward_date* -- optional future date when the transaction should be authorized and settled. Only applicable if the TranxType is STR/FWD
     def self.keyed_store_forward(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::StoreForward}), [:transaction_type, :amount, :card_number, :expiration_month, :expiration_year], STORE_AND_FORWARD_OPTIONAL)
+      send_transaction(
+        params,
+        TransactionTypes::StoreForward,
+        [:transaction_type, :amount, :card_number, :expiration_month, :expiration_year],
+        STORE_AND_FORWARD_OPTIONAL)
     end
 
     # See http://help.paytrace.com/api-store-and-forward
@@ -621,8 +621,11 @@ module PayTrace
     # * *:enable_partial_authentication* -- flag that must be set to ‘Y’ in order to support partial authorization and balance amounts in transaction responses (customer ID token sale)
     # * *:store_forward_date* -- optional future date when the transaction should be authorized and settled. Only applicable if the TranxType is STR/FWD
     def self.customer_id_store_forward(params)
-      PayTrace::API::Gateway.send_request(TRANSACTION_METHOD,
-        params.merge({transaction_type: TransactionTypes::StoreForward}), [:transaction_type, :amount, :customer_id], STORE_AND_FORWARD_OPTIONAL)
+      send_transaction(
+        params,
+        TransactionTypes::StoreForward,
+        [:transaction_type, :amount, :customer_id],
+        STORE_AND_FORWARD_OPTIONAL)
     end
 
     # See http://help.paytrace.com/api-export-transaction-information
@@ -936,6 +939,17 @@ module PayTrace
     def self.adjust_amount(params = {})
       PayTrace::API::Gateway.send_request(ADJUST_AMOUNT_METHOD, params, [:transaction_id, :amount])  
     end
+
+    # private helper method to DRY things up a bit
+    def self.send_transaction(params, type, required, optional)
+      PayTrace::API::Gateway.send_request(
+        TRANSACTION_METHOD,
+        {transaction_type: type}.merge(params),
+        required, 
+        optional)
+    end
+
+    private_class_method :send_transaction
   end
 
   # enumeration of transaction subtypes

data/lib/paytrace/version.rb

@@ -1,4 +1,4 @@
 module PayTrace
   # Version number
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/test/paytrace/exceptions_spec.rb

@@ -1,3 +1,15 @@
 require File.expand_path(File.dirname(__FILE__) + '../../test_helper.rb')
 
-include PayTrace::Exceptions
+include PayTrace::Exceptions
+
+describe PayTrace::Exceptions do
+  describe PayTrace::Exceptions::ErrorResponse do
+    it "shows the error code in to_s" do
+      raw = "ERROR~779. BLOCKED - This card number has been blocked to prevent potential fraud.|"
+      response = PayTrace::API::Response.new(raw)
+      exception = PayTrace::Exceptions::ErrorResponse.new(response)
+
+      exception.to_s.must_equal response.get_response()
+    end
+  end
+end

data/test/scripts/run_settle_transaction.rb

@@ -6,14 +6,7 @@ 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")
 
-# settle a transaction via a recurrence ID
-PayTrace::Debug.trace do
-  params = { recur_id: "1143" } # you must replace this with a valid recurrence ID!
-  PayTrace::Transaction.settle_transactions(params)
-end
-
 # settle a transaction via a customer ID
 PayTrace::Debug.trace do
-  params = { customer_id: "1143" } # you must replace this with a valid customer ID!
-  PayTrace::Transaction.settle_transactions(params)
+  PayTrace::Transaction.settle_transactions()
 end

data/test/scripts/sample_transaction.rb

@@ -0,0 +1,137 @@
+$:<< "./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.configure do |config|
+  config.user_name = "demo123"
+  config.password = "demo123"
+  config.domain = "stage.paytrace.com"
+end
+
+# 
+# Create a customer profile with a known customer ID
+#
+
+# we can handle non-fatal error responses by rescuing PayTrace::Exception::ErrorResponse objects
+begin
+  # note that most of these parameters are optional; you do not need to include every param to make the call
+  # see the SDK documentation for a list of optional and required parameters for each function
+  params = {
+    customer_id: 'fake_user',
+    card_number: 4111111111111111,
+    expiration_month: 10,
+    expiration_year: 24,
+    billing_name: 'John Doe',
+    billing_address: '1234 Fake Lane.',
+    billing_address2: 'Suite 214',
+    billing_city: 'Shoreline',
+    billing_state: 'WA',
+    billing_postal_code: 98133,
+    shipping_name: 'John Doe',
+    billing_country: 'US',
+    shipping_address: '3456 Business Road',
+    shipping_address2: 'Apartment D',
+    shipping_city: 'Seattle',
+    shipping_region: 'King',
+    shipping_state: 'WA', 
+    shipping_postal_code: 98134,
+    shipping_country: 'US',
+    email: 'support@paytrace.com',
+    customer_phone: '206-555-1212',
+    customer_fax: '206-555-1213',
+    customer_password: 'foobar',
+    account_number: 12345678,
+    routing_number: 325081403,
+    discretionary_data: {hair_color: 'red'} # note, this is level 3 ("discretionary") data appropriate to your account!
+  }
+
+  # here we create a new customer profile, using the credit card number variant
+  PayTrace::Customer.from_cc_info(params)
+rescue PayTrace::Exceptions::ErrorResponse => e
+  if e.response.errors.count == 1 && e.response.errors.has_key?('ERROR-171') # duplicate customer ID
+    puts "*** Customer ID #{params[:customer_id]} already exists, continuing..."
+  else
+    raise
+  end
+else
+  puts "*** Successfully created customer ID #{params[:customer_id]}"
+end
+
+# 
+# Perform a keyed (manually-entered, as opposed to swiped) sale transaction
+#
+
+params = {
+  # a "sandbox" credit card number
+  card_number: 4111111111111111,
+  amount: 15.99,
+  expiration_month: 10,
+  expiration_year: 24
+}
+
+response = PayTrace::Transaction::keyed_sale(params)
+
+# pull the data we care about out
+transaction_id = response.values["TRANSACTIONID"]
+
+puts "*** Successfully created transaction ID #{transaction_id}"
+
+# 
+# Add level 3 data to a known transaction ID
+#
+
+# let's add level 3 data to that transaction...
+params = {
+  transaction_id: transaction_id,
+  line_items: [
+    {product_id: 'SKU123', quantity: 3, description: 'Widgets'}
+  ]
+}
+
+PayTrace::Transaction::add_level_three_visa(params)
+
+puts "*** Successfully added level 3 data to transaction_id #{transaction_id}"
+
+# 
+# Void a known transaction ID
+#
+
+# void it!
+params = {
+  # the transaction ID we received above...
+  transaction_id: transaction_id
+}
+
+# and now we refund that same transaction
+response = PayTrace::Transaction::void(params)
+
+puts "*** Successfully voided transaction_id #{transaction_id}"
+
+#
+# Perform a refund to a known credit card
+#
+
+# now, let's do a refund!
+params = {
+  amount: 15.99,
+  card_number: 4111111111111111,
+  expiration_month: 10,
+  expiration_year: 24
+}
+
+# this might fail if you run against the staging server
+# But, it demonstrates the minimal information necessary to perform a keyed refund.
+PayTrace::Transaction::keyed_refund(params)
+
+puts "*** Successfully refunded $#{params[:amount]} to card number #{params[:card_number]}"
+
+#
+# Delete customer profile
+#
+
+# we know the customer id, so we can delete the profile.
+PayTrace::Customer.delete('fake_user')
+
+puts "*** Successfully deleted customer ID fake_user"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paytrace
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Trevor Redfern
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-13 00:00:00.000000000 Z
+date: 2014-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -183,6 +183,7 @@ files:
 - test/scripts/run_level3_data.rb
 - test/scripts/run_recur_payments_integration.rb
 - test/scripts/run_settle_transaction.rb
+- test/scripts/sample_transaction.rb
 - test/scripts/smiley_face.png
 - test/test_helper.rb
 - vagrant-bootstrap.sh
@@ -238,5 +239,6 @@ test_files:
 - test/scripts/run_level3_data.rb
 - test/scripts/run_recur_payments_integration.rb
 - test/scripts/run_settle_transaction.rb
+- test/scripts/sample_transaction.rb
 - test/scripts/smiley_face.png
 - test/test_helper.rb