merchant_e_solutions 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f190c95e55c362af2bbbe74e6e753f894422fd1
-  data.tar.gz: dfdd06de461ee1f4ae5fb423a5bb93acd11dc600
+  metadata.gz: 711eff0d6ae2129abe6b4ca1870bf1e41e282c55
+  data.tar.gz: 19c5204ecbd1dd9f4559151c552c5f724ef16f6f
 SHA512:
-  metadata.gz: 71d5ffa5a8ea0259101a23cf565c62962a8ad8392bc893ac116047f4c3c0a4d26519e3d14a75b5eeee71775252654dc133ed0299ed700aeb2bbf3bda2a07d993
-  data.tar.gz: bf44ef4d8fdf635c290f8a9ab3a2dffbe32660e586ab2869e6f3e1861fb59e0840703765c232967ed128b2a3905291a583ab3dbb88e042f55facbb77bfd6048d
+  metadata.gz: 6598c2a6dcb1601be52e6bdcb279c1aed463b6e6a9e96bc6ea4b784e47983ade0b02fe3107e48041dbe85565491e0919479af7a71dae4ea400692e43229f1f66
+  data.tar.gz: aad781319bb3f9f950e4099519f45c5f1b4f819acdabaf0041568c2d909e58f4ed04911fe0fa5281faa06a870b5711d794992401fb2b2903e217cf08e05735b8

data/README.md

@@ -45,6 +45,34 @@ echo $MERCHANT_E_SOLUTIONS_USER_ID  # yourUserID
 echo $MERCHANT_E_SOLUTIONS_PASSWORD # yourPassword
 ```
 
+## A Note on Acquirer Reference Numbers (ARNs)
+
+The MeS detailed report APIs return an acquirer reference number for every
+transaction. Take a look at the MeS reporting API documentation under 'Links'
+for more.
+
+One issue we've seen is that the MeS API always returns reference numbers
+pre-pended with an apostrophe. Instead of `123456789`, we consistently see
+`'123456789`.
+
+The MeS docs are inconsistent in its examples, showing apostrophes pre-pended
+to some and none pre-pended to others. The MeS reporting front-end never shows
+apostrophes in reference numbers, and the apostrophe is never addressed in the
+documentation.
+
+Further, the reference number is documented as a 23-character field. The apostrophe
+consistently brings this field's length to 24 characters.
+
+This is probably sloppiness on MeS' end, so by default this library removes these
+apostrophes. If you want to keep the apostrophe for any reason -- personal preference,
+interfacing with legacy records that have them -- you can get the reference number
+unchanged from a record thusly:
+
+    reference_number = record.reference_number(:unchanged => true)
+
+## Links
+
+* [MeS Reporting API documentation](http://resources.merchante-solutions.com/display/TPGPUB/MeS+Payment+Gateway+Developer's+Guide#MeSPaymentGatewayDeveloper%27sGuide-5.ReportingOptions)
 
 ## Contributing
 

data/lib/merchant_e_solutions/detail_record.rb

@@ -4,7 +4,7 @@ module MerchantESolutions
   class DetailRecord < Record
 
     attr_reader :organization_id, :organization_name, :term_number, :batch_number, :batch_date,
-      :transaction_date, :card_code, :card_number, :reference_number, :purchase_id, :auth_code,
+      :transaction_date, :card_code, :card_number, :purchase_id, :auth_code,
       :entry_mode, :transaction_amount, :trident_transaction_id, :client_reference_number
 
     def initialize(row)
@@ -25,6 +25,11 @@ module MerchantESolutions
       @client_reference_number = row[14]
     end
 
+    def reference_number(options={})
+      return @reference_number if options[:unchanged]
+      cleaned_reference_number
+    end
+
     def credit_company
       {
         "AM" => "American Express",
@@ -47,5 +52,16 @@ module MerchantESolutions
         "Business"
       end
     end
+
+
+    private
+
+    def cleaned_reference_number
+      if @reference_number.start_with?("'")
+        @reference_number[1..-1]
+      else
+        @reference_number
+      end
+    end
   end
 end

data/lib/merchant_e_solutions/version.rb

@@ -1,3 +1,3 @@
 module MerchantESolutions
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/spec/lib/merchant_e_solutions/detail_record_spec.rb

@@ -24,15 +24,41 @@ describe MerchantESolutions::DetailRecord do
     its("transaction_date.month") { should == 10 }
     its(:card_code) { should == "AM" }
     its(:card_number) { should == "000000xxxxxx1234" }
-    its(:reference_number) { "'0000213"}
-    its(:purchase_id) { "AAAAAAAAAAA0" }
-    its(:auth_code) { "AAAAAAAAAAA0" }
-    its(:entry_mode) { "AAAAAAAAAAA0" }
+    its(:reference_number) { should == "0000213"}
+    its(:purchase_id) { should == "AAAAAAAAAAA0" }
+    its(:auth_code) { should == "100000" }
+    its(:entry_mode) { should == "KEYED" }
     its(:transaction_amount) { should == 7.09 }
     its(:trident_transaction_id) { should == "T.T.ID" }
     its(:client_reference_number) { should == "clientRefNumber" }
   end
 
+  describe "#reference_number" do
+    let(:reference_number) { "'0000213" }
+    let(:record) { MerchantESolutions::DetailRecord.new([nil, nil, nil, nil, nil, nil, nil, nil, reference_number])}
+
+    context "when no arguments are given" do
+      it "removes the pre-pended apostrophe from the reference number" do
+        record.reference_number.should == "0000213"
+      end
+    end
+
+    context "when the :unchanged option is set to true" do
+      it "returns the reference number verbatim, the pre-pended apostrophe intact" do
+        record.reference_number(:unchanged => true).should == "'0000213"
+      end
+    end
+
+    context "when the reference number doesn't contain an apostrophe" do
+      let (:reference_number) { "0000213" }
+
+      it "returns the reference number verbatim, regardless of the :unchanged argument" do
+        record.reference_number.should == "0000213"
+        record.reference_number(:unchanged => true).should == "0000213"
+      end
+    end
+  end
+
   describe "credit cards" do
     subject { MerchantESolutions::DetailRecord.new([nil, nil, nil, nil, nil, nil, card_code]) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: merchant_e_solutions
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Steve Ellis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2013-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler