an 0.0.1.rc2 → 0.0.1.rc3

data/README

@@ -13,32 +13,25 @@ USAGE
 
     $ gem install an
 
-    AN.login_id = ENV["LOGIN_ID"]
-    AN.transaction_key = ENV["TRANS_KEY"]
-
-    gateway = AN::AIM.test
-
-    customer = AN::Customer.new(first_name: "John",
-                                last_name: "Doe",
-                                zip: "98004",
-                                email: "me@cyrildavid.com")
-
-    invoice = AN::Invoice.new(invoice_num: SecureRandom.hex(20),
-                              amount: "19.99",
-                              description: "Sample Transaction")
-
-    card = AN::CreditCard.new(card_num: "4111111111111111",
-                              card_code: "123",
-                              exp_month: "1", exp_year: "2015")
-
-    begin
-      gateway.sale(customer, invoice, card)
-    rescue AN::TransactionFailed => e
-      puts "%s: %s" % [e.reason_code, e.reason_text]
+    $ export AUTHORIZE_NET_URL=https://<login>:<key>@<url>
+
+    gateway = AN.connect
+
+    response = gateway.transact(
+      card_number: "4111111111111111",
+      card_code: "123",
+      expiration_date: "2015-01",
+      amount: "10.00",
+      invoice_number: SecureRandom.hex(10)
+    )
+
+    if resp.success?
+      # process the order, possibly storing
+      # parts of resp.to_hash
+    else
+      # display an error.
     end
 
-
 TODOS
 
     ARB Integration
-    CIM Integration

data/an.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "an"
-  s.version           = "0.0.1.rc2"
+  s.version           = "0.0.1.rc3"
   s.summary           = "A thin Authorize.NET client."
   s.description       = "AN is a simplified client for integration with Authorize.NET."
   s.authors           = ["Cyril David"]
@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
     "test/*.*"
   ]
 
-  s.add_dependency "scrivener"
+  s.add_dependency "mote"
+  s.add_dependency "xml-simple"
   s.add_development_dependency "cutest"
 end

data/lib/an.rb

@@ -9,14 +9,14 @@ class AN
   #
   # AUTHORIZE_NET_URL=https://login:key@api.authorize.net/xml/v1/request.api
   #
-  # in the appropriate location (e.g. /etc/profile.d, ~/.bashrc, or 
+  # in the appropriate location (e.g. /etc/profile.d, ~/.bashrc, or
   # whatever you're most comfortable with.
   #
   # The TEST URL is https://apikey.authorize.net/xml/v1/request.api
   def self.connect(url = ENV["AUTHORIZE_NET_URL"])
     new(URI(url))
   end
-  
+
   TEMPLATES = File.expand_path("../templates", File.dirname(__FILE__))
 
   include Mote::Helpers
@@ -24,7 +24,7 @@ class AN
   attr :url
   attr :auth
   attr :client
- 
+
   def initialize(uri)
     @auth   = { login: uri.user, transaction_key: uri.password }
     @client = Client.new(uri)
@@ -41,16 +41,16 @@ class AN
   def create_payment_profile(params)
     call("createCustomerPaymentProfileRequest", params)
   end
-  
+
   def create_profile_transaction(params)
     call("createCustomerProfileTransactionRequest", params)
   end
 
-private 
+private
   def call(api_call, params)
     Response.new(post(payload(api_call, params)))
   end
-  
+
   def post(xml)
     client.post(xml, "Content-Type" => "text/xml")
   end
@@ -58,71 +58,81 @@ private
   def payload(api_call, params)
     mote(File.join(TEMPLATES, "%s.mote" % api_call), params.merge(auth))
   end
-  
+
   class Response
-    attr :data
-  
     OK = "Ok"
 
     def initialize(xml)
-      @data = XmlSimple.xml_in(xml, forcearray: false)      
+      @data = XmlSimple.xml_in(xml, forcearray: false)
     end
 
-    def success?
-      data["messages"]["resultCode"] == OK
+    def [](key)
+      @data[key]
     end
 
-    def transaction_id
-      data["transactionResponse"]["transId"]      
+    def success?
+      @data["messages"]["resultCode"] == OK
     end
 
-    def reference_id
-      data["refId"]
+    def to_hash
+      @data
     end
 
     def profile_id
-      data["customerProfileId"]      
+      @data["customerProfileId"]
     end
 
     def payment_profile_id
-      data["customerPaymentProfileId"]
+      @data["customerPaymentProfileId"]
     end
 
-    def validation_response
-      if resp = data["validationDirectResponse"] || data["directResponse"]
-        ValidationResponse.new(resp)
-      end
+    def authorization
+      response = @data["validationDirectResponse"] || @data["directResponse"]
+
+      AuthorizationResponse.new(response) if response
     end
   end
 
-  class ValidationResponse
-    RESPONSE_FIELDS = %w[code subcode reason_code reason_text
-                         authorization_code avs_response trans_id
-                         invoice_number description amount method
-                         transaction_type customer_id first_name
-                         last_name company address city state zip
-                         country phone fax email
-                         shipping_first_name shipping_last_name
-                         shipping_company shipping_address shipping_city
-                         shipping_state shipping_zip shipping_country
-                         tax duty freight tax_exempt purchase_order_number
-                         md5_hash card_code_response cavv_response
-                         _41 _42 _43 _44 _45 _46 _47 _48 _49 _50
-                         account_number card_type split_tender_id
-                         requested_amount balance_on_card].freeze
-
-    attr :fields
+  class AuthorizationResponse
+    FIELDS = {
+      1  => "responseCode",
+      3  => "messageCode",
+      4  => "messageDescription",
+      5  => "authCode",
+      6  => "avsResultCode",
+      7  => "transId",
+      38 => "transHash",
+      39 => "cvvResultCode",
+      40 => "cavvResultCode",
+      51 => "accountNumber",
+      52 => "accountType"
+    }
 
     def initialize(data, delimiter = ",")
-      @fields = Hash[RESPONSE_FIELDS.zip(data.split(delimiter))]
+      @list = data.split(delimiter)
+      @data = {}
+
+      FIELDS.each do |index, field|
+        # The FIELDS hash is using a 1-based index in order
+        # to match the ordering number in the AIM documentation.
+        @data[field] = @list[index - 1]
+      end
+    end
+
+    def to_hash
+      @data
+    end
+
+    def [](key)
+      @data[key]
     end
 
     def success?
-      fields["code"] == "1" && fields["reason_code"] == "1"
+      @data["responseCode"] == "1" && @data["messageCode"] == "1"
     end
 
     def transaction_id
-      fields["trans_id"]
+      @data["transId"]
     end
   end
 

data/test/an.rb

@@ -4,22 +4,39 @@ setup do
   AN.connect
 end
 
-test "AIM basic transaction" do |gateway|
-  resp = gateway.transact({
-    :card_number => "4111111111111111",
-    :card_code => "123",
-    :expiration_date => "2015-01",
-    :amount => "10.00",
-    :invoice_number => SecureRandom.hex(10),
-    :description => "Aeutsahoesuhtaeu",
-    :first_name => "John",
-    :last_name => "Doe",
-    :address => "12345 foobar street",
-    :zip => "90210"
-  })
+test "AIM most basic transaction" do |gateway|
+  resp = gateway.transact(
+    card_number: "4111111111111111",
+    card_code: "123",
+    expiration_date: "2015-01",
+    amount: "10.00",
+    invoice_number: SecureRandom.hex(10)
+  )
 
   assert resp.success?
-  assert resp.transaction_id
+  assert resp["transactionResponse"].kind_of?(Hash)
+  assert_equal "XXXX1111", resp["transactionResponse"]["accountNumber"]
+  assert_equal "Visa", resp["transactionResponse"]["accountType"]
+end
+
+test "AIM transaction with billing info" do |gateway|
+  resp = gateway.transact(
+    card_number: "4111111111111111",
+    card_code: "123",
+    expiration_date: "2015-01",
+    amount: "10.00",
+    invoice_number: SecureRandom.hex(10),
+    description: "Aeutsahoesuhtaeu",
+    first_name: "John",
+    last_name: "Doe",
+    address: "12345 foobar street",
+    zip: "90210"
+  )
+
+  assert resp.success?
+  assert resp["transactionResponse"].kind_of?(Hash)
+  assert_equal "XXXX1111", resp["transactionResponse"]["accountNumber"]
+  assert_equal "Visa", resp["transactionResponse"]["accountType"]
 end
 
 # CIM (Customer Information Manager)
@@ -33,9 +50,9 @@ scope do
     resp = gateway.create_profile(reference_id: reference_id,
                                   customer_id: customer_id,
                                   email: "foo@bar.com")
-    
+
     assert resp.success?
-    assert_equal reference_id, resp.reference_id
+    assert_equal reference_id, resp["refId"]
     assert resp.profile_id
 
     # After a successful response in the background process, you
@@ -64,13 +81,13 @@ scope do
     # By default the validation method used is liveMode which returns an
     # AIM-like payment response string related to the credit card details
     # passed as part of creating the payment profile.
-    assert resp.success?  
+    assert resp.success?
     assert resp.payment_profile_id
-    assert resp.validation_response.success?
-    
-    assert_equal "XXXX1111", resp.validation_response.fields["account_number"]
-    assert_equal "Visa", resp.validation_response.fields["card_type"]
-  
+    assert resp.authorization.success?
+
+    assert_equal "XXXX1111", resp.authorization["accountNumber"]
+    assert_equal "Visa", resp.authorization["accountType"]
+
     # The payment profile id should then be saved together with the user.
     # You may also do a one-to-many setup similar to amazon where they can
     # add multiple credit cards. If that's the case, simply use the
@@ -89,10 +106,10 @@ scope do
       description: "Jan - Feb",
       purchase_order_number: "001"
     })
-    
+
     assert resp.success?
-    assert resp.validation_response.success?
-    assert_equal "XXXX1111", resp.validation_response.fields["account_number"]
-    assert_equal "Visa", resp.validation_response.fields["card_type"]
+    assert resp.authorization.success?
+    assert_equal "XXXX1111", resp.authorization["accountNumber"]
+    assert_equal "Visa", resp.authorization["accountType"]
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: an
 version: !ruby/object:Gem::Version
-  version: 0.0.1.rc2
+  version: 0.0.1.rc3
   prerelease: 6
 platform: ruby
 authors:
@@ -12,8 +12,8 @@ cert_chain: []
 date: 2012-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: scrivener
-  requirement: &2156032980 !ruby/object:Gem::Requirement
+  name: mote
+  requirement: &2151853740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156032980
+  version_requirements: *2151853740
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: &2151853160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151853160
 - !ruby/object:Gem::Dependency
   name: cutest
-  requirement: &2155894040 !ruby/object:Gem::Requirement
+  requirement: &2151852500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2155894040
+  version_requirements: *2151852500
 description: AN is a simplified client for integration with Authorize.NET.
 email:
 - me@cyrildavid.com
@@ -66,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: A thin Authorize.NET client.