paytrace 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0f4c097c551f541060d31c505b42cd02517f495
-  data.tar.gz: da442a4e5a8816759b4ef90e9d052c89c0b6f616
+  metadata.gz: e8e39285035b4738f309e0124bbb9984bc724ee9
+  data.tar.gz: 621bbb455c469a7e98abd9a1e7509364c23a7922
 SHA512:
-  metadata.gz: e69acf89d801f7140e4cc85bb7885ac1d1b5a9b7245d377b6ea04329625bb8db9a0e8f9f80b78b718f4bffd50dca57a5f3d94e8767e5970c35c1b690f855fe3c
-  data.tar.gz: 16746312d84d238dad91bf55a361350353c4f5b5abbf4cf95b5cccec9906cbcc108c15517811d566beb7599c4c6baabe5944b3175606d9d1e86df3c72c003348
+  metadata.gz: 6e515351d099ee793196e7f83bbd431b8295c9d8eed6dfcd1cba57610420adecb85548281db275a48270fdd9b81b656450b4da657668a88894360b414c7bb84c
+  data.tar.gz: 4eeb9ecaad3cc8959d1588a91997bb1630469c47dc5c4d85439e0979b998c6c700d21af9135d0c0118754a2b05c2d879b26da8d6a437096f0fee0f4a11df7be0

data/api_names.txt

@@ -0,0 +1,287 @@
+
+ADDTAX
+
+ADDTAXIND
+
+ADDTAXINDLI
+
+ADDTAXLI
+
+ADDTAXRATE
+
+ADDTAXRATELI
+
+AMOUNT
+
+AMOUNTLI
+
+APPROVAL
+
+APPROVEURL
+
+BADDRESS
+
+BADDRESS2
+
+BATCHNUMBER
+
+BCITY
+
+BCOUNTRY
+
+BNAME
+
+BSTATE
+
+CASHADVANCE
+
+CC
+
+CCODE
+
+CCODELI
+
+CHECKID
+
+CHECKTYPE
+
+CSC
+
+CUSTID
+
+CUSTOMDBA
+
+CUSTOMERTAXID
+
+CUSTPSWD
+
+CUSTRECEIPT
+
+CUSTREF
+
+DCIND
+
+DDA
+
+DECLINEURL
+
+DESCRIPTION
+
+DISCOUNT
+
+DISCOUNTIND
+
+DISCOUNTLI
+
+DISCOUNTRATE
+
+DUTY
+
+EDATE
+
+EMAIL
+
+ENABLEPARTIALAUTH
+
+EXPMNTH
+
+EXPYR
+
+FAX
+
+FORCEADDRESS
+
+FORCECSC
+
+FORCEEMAIL
+
+FREIGHT
+
+FREQUENCY
+
+IDEXP
+
+INVOICE
+
+LAST4
+
+MEASURE
+
+MERCHANTTAXID
+
+METHOD
+
+NETGROSSIND
+
+NEWCUSTID
+
+NEWPSWD
+
+NEWPSWD2
+
+NEXT
+
+NTAX
+
+ORDERID
+
+ORIGINALID
+
+PHONE
+
+PHOTOID
+
+POSTURL
+
+PRODUCTID
+
+PSWD
+
+QUANTITY
+
+RECURID
+
+RECURTYPE
+
+RETURNBIN
+
+RETURNCLR
+
+RETURNID
+
+SADDRESS
+
+SADDRESS2
+
+SCITY
+
+SCOUNTRY
+
+SCOUNTY
+
+SDATE
+
+SEARCHTEXT
+
+SHIPPERS
+
+SNAME
+
+SOURCESTATE
+
+SOURCEZIP
+
+SSTATE
+
+START
+
+STRFWDDATE
+
+SWIPE
+
+SZIP
+
+TAX
+
+
+TERMS
+
+TEST
+
+TOTALCOUNT
+
+TRANXID
+
+TRANXTYPE
+
+UN
+
+UNITCOST
+
+USER
+
+WEIGHT
+
+“……………………………”
+Discretionary Data elements that are configured in PayTrace’s Virtual Terminal may be passed through the API. All Discretionary Data elements are optional in the API, our integrated solutions may make them required. Discretionary Data elements should be passed w/ the Title in the name portion of the pair and the value to the right of the tilde. For example, a Discretionary Data element titled “Hair Color” could be passed as “Hair Color~Red|” Please note that Discretionary Data titles and values should be URL encoded. Also, multiple select Discretionary Data values should be comma delimited
+alpha-numeric
+1-99
+
+
+ACHCODE
+
+ACHMSG
+
+APPCODE
+
+APPMSG
+
+AUTHKEY
+
+AVSRESPONSE
+
+BALANCEAMOUNT
+
+BATCHNUM
+
+CHECKIDENTIFIER
+
+CSCRESPONSE
+
+CUSTOMERID
+
+CUSTOMERRECORD
+
+ERROR
+
+IP
+
+LASTCHECK
+
+LASTTRANX
+
+NETAMOUNT
+
+PARTIALAMOUNT
+
+REFUNDAMOUNT
+
+REFUNDCOUNT
+
+RESPONSE
+
+SALESAMOUNT
+
+SALESCOUNT
+
+SETTLED
+
+SHIPPINGCOMPANY
+
+SHIPPINGMETHOD
+
+SHIPPINGRATE
+
+SHIPPINGRECORD
+
+STATUS
+
+TRANSACTIONID
+
+TRANSACTIONRECORD
+
+TRANXCOUNT
+
+VISAREFUNDAMOUNT
+
+VISAREFUNDCOUNT
+
+VISASALESAMOUNT
+
+VISASALESCOUNT
+
+WHEN
+
+
+
+

data/lib/paytrace/api/fields.rb

@@ -43,6 +43,13 @@ module PayTrace
         #customer
         customer_id: "CUSTID",
         customer_reference_id:"CUSTREF",
+        approval_code:"APPROVAL",
+        #cash advance
+        cash_advance:"CASHADVANCE",
+        id_number:"PHOTOID",
+        id_expiration:"IDEXP",
+        cc_last_4:"LAST4"
+
       }
     end
   end

data/lib/paytrace/api/request.rb

@@ -31,7 +31,7 @@ module PayTrace
         @params[:method] = TRANSACTION_METHOD
         @params[:amount] = t.amount
         load_address(t)
-        load_optional_fields(t) if t.optional_fields
+        load_misc_fields(t) if t.optional_fields
       end
 
       def add_credit_card(cc)
@@ -42,18 +42,13 @@ module PayTrace
         @params[:csc] = cc.csc if cc.csc
       end
 
-      def load_optional_fields(t)
+      def load_misc_fields(t)
         o = t.optional_fields
-        @params[:email] = o[:email] if o[:email]
-        @params[:description] = o[:description] if o[:description]
-        @params[:tax_amount] = o[:tax_amount] if o[:tax_amount]
-        @params[:return_clr] = o[:return_clr] if o[:return_clr]
-        @params[:enable_partial_authentication] = o[:enable_partial_authentication] if o[:enable_partial_authentication]
-        @params[:discretionary_data] = o[:discretionary_data] if o[:discretionary_data]
-        @params[:custom_dba] = o[:custom_dba] if o[:custom_dba]
-        @params[:invoice] = o[:invoice] if o[:invoice]
-        @params[:transaction_id] = o[:transaction_id] if o[:transaction_id]
-        @params[:customer_reference_id] = o[:customer_reference_id] if o[:customer_reference_id]
+        o.each do |k,v|
+          @params[k]= v
+        end
+
+
       end
 
       def load_address(t)
@@ -82,7 +77,6 @@ module PayTrace
         @params[:"#{address_type}_state"] = address.state if address.state
         @params[:"#{address_type}_postal_code"] = address.postal_code if address.postal_code
         @params[:"#{address_type}_country"] = address.country if address.country
-
       end
 
 

data/lib/paytrace/api/response.rb

@@ -1,13 +1,30 @@
 module PayTrace
   module API
     class Response
-      attr_reader :values
+      attr_reader :values, :errors
 
       def initialize(response_string)
         @field_delim = "|"
         @value_delim = "~"
         @values = {}
-        
+        @errors = {}
+        parse_response(response_string)
+      end
+
+      def response_code
+        get_response
+      end
+
+      def has_errors?
+           @errors.length > 0
+      end
+
+      def parse_response(response_string)
+
+        if (response_string.include? "ERROR")
+           return parse_errors(response_string)
+        end
+
         pairs = response_string.split(@field_delim)
         pairs.each do |p|
           k,v = p.split(@value_delim)
@@ -15,9 +32,34 @@ module PayTrace
         end
       end
 
-      def response_code
+      def parse_errors(response_string)
+        pairs = response_string.split(@field_delim)
+        pairs.each do |p|
+          k,v = p.split(@value_delim)
+          k = generate_error_key(k,v)
+          @errors[k] = v
+        end
+      end
+
+      def generate_error_key(key,value)
+        #get the error number from the value
+        return key +'-'+ value[/([1-9]*)/,1]
+      end
+
+      def get_response()
+        if has_errors?
+          return get_error_response()
+        end
         @values["RESPONSE"]
       end
+
+      def get_error_response()
+        error_message = ""
+        @errors.each do  |k,v|
+          error_message << v + ","
+        end
+        error_message
+      end
     end
   end
 end

data/lib/paytrace/transaction.rb

@@ -3,21 +3,72 @@ require 'paytrace/api/gateway'
 require 'paytrace/address'
 module PayTrace
   module TransactionOperations
-    def sale(params)
-      amount = params[:amount]
-      cc = CreditCard.new(params[:credit_card]) if params[:credit_card]
-      customer = Customer.new(customer_id: params[:customer_id]) if params[:customer_id]
+    def sale(args)
+      create_transaction(args,TransactionTypes::SALE)
+    end
+
+    def authorization(args)
+      create_transaction(args,TransactionTypes::Authorization)
+    end
+
+    def refund(args)
+      create_transaction(args,TransactionTypes::Refund)
+    end
+
+    def void(transaction_id)
+      params = {transaction_id: transaction_id}
+      t = Transaction.new(type: TransactionTypes::Void,
+                          optional:params)
+      t.response = send_request(t)
+      t
+    end
+
+    def forced_sale(approval_code,args)
+      args[:approval_code] = approval_code
+      create_transaction(args,TransactionTypes::ForcedSale)
+    end
+
+    def capture(transaction_id)
+      params = {transaction_id: transaction_id}
+      t = Transaction.new(type: TransactionTypes::Capture,
+                          optional:params)
+      t.response = send_request(t)
+      t
+    end
+
+    def cash_advance(args)
+      args[:cash_advance] = "Y"
+
+      create_transaction(args,TransactionTypes::SALE)
+    end
+
+    def store_forward(amount,credit_card,optional={})
+      optional[:amount] = amount
+      optional[:credit_card] = credit_card
+      create_transaction(optional,TransactionTypes::StoreForward)
+    end
 
-      t = Transaction.new(amount: amount, 
-                      credit_card: cc, 
-                      customer: customer,
-                      type: TransactionTypes::SALE,
-                      optional:params)
+    private
+    def create_transaction(args,type)
+      amount = args.delete(:amount)  if args[:amount]
+      cc = CreditCard.new(args.delete(:credit_card)) if args[:credit_card]
+      customer = Customer.new(customer_id: args.delete(:customer_id)) if args[:customer_id]
+
+      t = Transaction.new(amount: amount,
+                          credit_card: cc,
+                          customer: customer,
+                          type: type,
+                          optional:args)
+
+      t.response = send_request(t)
+      t
+    end
 
+    private
+    def send_request(t)
       request = PayTrace::API::Request.new(transaction: t)
       gateway = PayTrace::API::Gateway.new
-      t.response = gateway.send_request(request)
-      t
+      gateway.send_request(request)
     end
 
   end
@@ -45,21 +96,19 @@ module PayTrace
     end
 
     private
-    def include_optional(optional)
+    def include_optional(args)
+      s = nil
+      b = nil
 
-      b = optional[:billing_address]
+      b = args.delete(:billing_address)  if args[:billing_address]
       @billing_address = PayTrace::Address.new(b) if b
-      s = optional[:shipping_address]
+      s =  args.delete(:shipping_address) if args[:shipping_address]
       @shipping_address = PayTrace::Address.new(s) if s
-      if optional[:address_shipping_same_as_billing]
+      if args[:address_shipping_same_as_billing]
         self.set_shipping_same_as_billing
       end
 
-      #clear these out so we have a clean hash
-      optional[:billing_address] = nil
-      optional[:shipping_address] = nil
-
-      @optional_fields = optional
+      @optional_fields = args
 
     end
 
@@ -68,6 +117,12 @@ module PayTrace
 
   module TransactionTypes
     SALE = "SALE"
+    Authorization = "Authorization"
+    Refund = "Refund"
+    Void = "Void"
+    ForcedSale = "Force"
+    Capture = "Capture"
+    StoreForward ="Str/FWD"
   end
 
 end

data/lib/paytrace/version.rb

@@ -1,3 +1,3 @@
 module PayTrace
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/paytrace/api/request_spec.rb

@@ -77,6 +77,9 @@ describe PayTrace::API::Request do
             }
           }
     )
+
+    t.shipping_address.must_be_nil
+
     r = PayTrace::API::Request.new(transaction: t)
 
     url = r.to_parms_string
@@ -149,4 +152,66 @@ describe PayTrace::API::Request do
     url.must_match /\|AMOUNT~1.00\|/
     url.must_match /\|TRANXID~1234|/
   end
+
+  it "can create an approval code call" do
+    t = PayTrace::Transaction.new({amount: "23.12",
+                                   credit_card: PayTrace::CreditCard.new({
+                                                                             card_number: "1234123412341234",
+                                                                             expiration_year: 24,
+                                                                             expiration_month: 10 }),
+                                   type: PayTrace::TransactionTypes::ForcedSale,
+                                   optional:{approval_code:'1234'}
+                                  })
+    r = PayTrace::API::Request.new(transaction: t)
+    url = r.to_parms_string
+
+    url.must_match /\|APPROVAL~1234\|/
+    url.must_match  /\|TRANXTYPE~Force\|/
+
+  end
+
+  it "can create a new cash_advance sale" do
+    cc =  PayTrace::CreditCard.new( {
+                                        swipe: '%B4055010000000005^J/SCOTT^1212101001020001000000701000000?;4055010000000005=12121010010270100001?'
+                                    })
+
+    optional = {
+        billing_address:{
+            name:"John Doe",
+            street:"1234 happy lane",
+            street2:"apt#2",
+            city:"Seattle",
+            state:"WA",
+            country: "US",
+            postal_code:"98107"
+        },
+        id_number:  "1234",
+        id_expiration:"12/20/2020",
+        cc_last_4: "1234",
+        cash_advance: "Y"
+
+
+    }
+    t = PayTrace::Transaction.new(
+        amount: '1.00',
+        credit_card:cc,
+        type: PayTrace::TransactionTypes::SALE,
+        optional:optional
+    )
+
+    r = PayTrace::API::Request.new(transaction: t)
+    url = r.to_parms_string
+
+    url.must_match /\|AMOUNT~1.00\|/
+    url.must_match /\|SWIPE~%B4055010000000005/
+    url.must_match /\|CASHADVANCE~Y\|/
+    url.must_match /\|PHOTOID~1234\|/
+    url.must_match /\|LAST4~1234\|/
+    url.must_match /\|BADDRESS~1234 happy lane\|/
+
+
+
+
+  end
+
 end

data/test/paytrace/api/response_spec.rb

@@ -7,4 +7,25 @@ describe PayTrace::API::Response do
     response = PayTrace::API::Response.new(from_server)        
     response.response_code.must_equal "101. Your transaction was successfully approved."
   end
+
+  it "parses multiple error responses" do
+    from_server ="ERROR~35. Please provide a valid Credit Card Number.|ERROR~43. Please provide a valid Expiration Month.|"
+    response = PayTrace::API::Response.new(from_server)
+    response.has_errors?.must_equal true
+  end
+
+  it "will can contain multiple error messages" do
+    from_server ="ERROR~35. Please provide a valid Credit Card Number.|ERROR~43. Please provide a valid Expiration Month.|"
+    response = PayTrace::API::Response.new(from_server)
+    response.errors.length.must_equal 2
+  end
+
+  it "should create a response with all errors in it" do
+    from_server ="ERROR~35. Please provide a valid Credit Card Number.|ERROR~43. Please provide a valid Expiration Month.|"
+    response = PayTrace::API::Response.new(from_server)
+    actual ="35. Please provide a valid Credit Card Number.,43. Please provide a valid Expiration Month.,"
+    response.response_code.must_equal actual
+  end
+
+
 end

data/test/paytrace/transaction_spec.rb

@@ -6,6 +6,28 @@ describe PayTrace::Transaction do
       @response = mock()
       PayTrace::API::Gateway.any_instance.expects(:send_request).returns(@response)
     end
+    it "can create a Payment Authorization" do
+      t = PayTrace::Transaction.authorization(
+          { amount:"1242.32",
+          credit_card: {
+            card_number:"1234123412341234",
+            expiration_month:10,
+            expiration_year:24
+          }
+        }
+      )
+
+
+      #Transaction is properly configured
+      t.amount.must_equal "1242.32"
+      t.type.must_equal PayTrace::TransactionTypes::Authorization
+
+      #Sets up a card
+      t.credit_card.card_number.must_equal "1234123412341234"
+      t.credit_card.expiration_month.must_equal 10
+      t.credit_card.expiration_year.must_equal 24
+    end
+
     it "can charge sales to a credit card" do
       t = PayTrace::Transaction.sale(
           {amount: "1242.32",
@@ -40,6 +62,41 @@ describe PayTrace::Transaction do
       t.response.must_equal @response
 
     end
+
+    it "can run a cash advance" do
+
+      args = {
+        amount:"1.00",
+        cc_last_4:"1234",
+        id_number:"12345",
+        id_expiration:"12/29/2020",
+        billing_address: {
+          street: "1234 happy lane",
+          street2: "apt #1",
+          city: "Seattle",
+          state: "WA",
+          postal_code:"98107",
+          country:"US"
+        },
+        credit_card: {
+            swipe:'%B5454545454545454^J/SCOTT^2612101001020001000000701000000?;5454545454545454=26121010010270100001?'
+        }
+      }
+      t = PayTrace::Transaction.cash_advance(args)
+
+      t.amount.must_equal "1.00"
+      t.type.must_equal PayTrace::TransactionTypes::SALE
+      t.credit_card.swipe.must_equal '%B5454545454545454^J/SCOTT^2612101001020001000000701000000?;5454545454545454=26121010010270100001?'
+      t.optional_fields[:cc_last_4].must_equal "1234"
+      t.optional_fields[:id_expiration].must_equal "12/29/2020"
+      t.optional_fields[:id_number].must_equal "12345"
+
+      t.billing_address.street.must_equal "1234 happy lane"
+      t.response.must_equal @response
+
+    end
+
+
   end
   describe "adding address info" do
     it "can take a shipping address" do
@@ -106,7 +163,33 @@ describe PayTrace::Transaction do
       t.shipping_address.must_equal t.billing_address
     end
 
+  end
 
+  it "can be set to void a transaction" do
+    t = PayTrace::Transaction.new(optional:{transaction_id:"11"})
   end
 
+  it "can create and send a void transaction" do
+    @response = mock()
+    PayTrace::API::Gateway.any_instance.expects(:send_request).returns(@response)
+
+    t = PayTrace::Transaction.void("111")
+    t.optional_fields[:transaction_id].must_equal "111"
+    t.type.must_equal PayTrace::TransactionTypes::Void
+  end
+
+  it "can create a forced sale" do
+    @response = mock()
+    PayTrace::API::Gateway.any_instance.expects(:send_request).returns(@response)
+    t = PayTrace::Transaction.forced_sale("111",{})
+
+    t.optional_fields[:approval_code].must_equal "111"
+    t.type.must_equal PayTrace::TransactionTypes::ForcedSale
+
+
+
+
+  end
+
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paytrace
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Trevor Redfern
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -81,6 +81,7 @@ files:
 - README.md
 - Rakefile
 - Vagrantfile
+- api_names.txt
 - lib/paytrace.rb
 - lib/paytrace/address.rb
 - lib/paytrace/api/fields.rb