merchant_e_solutions 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 711eff0d6ae2129abe6b4ca1870bf1e41e282c55
-  data.tar.gz: 19c5204ecbd1dd9f4559151c552c5f724ef16f6f
+  metadata.gz: 2abad0c5d536f2fa6e9ff7368afdee52174dae7c
+  data.tar.gz: 14028295e458de893515dcf3f2533734c25b1bc9
 SHA512:
-  metadata.gz: 6598c2a6dcb1601be52e6bdcb279c1aed463b6e6a9e96bc6ea4b784e47983ade0b02fe3107e48041dbe85565491e0919479af7a71dae4ea400692e43229f1f66
-  data.tar.gz: aad781319bb3f9f950e4099519f45c5f1b4f819acdabaf0041568c2d909e58f4ed04911fe0fa5281faa06a870b5711d794992401fb2b2903e217cf08e05735b8
+  metadata.gz: a3ff838a52c321221ceb1b2abf3dd396417243abff6d61e9cff2606c826141d4fbfabbc99e72b79453ca92f836cb43925aee546204c48ac3af52b86b53f16588
+  data.tar.gz: 621921e56c491b918869419beaf46e4d65d24ba113ba5e4e5e44dab9cd281796bad9d6dcd5f7955fd6b3a3ca48c219c47c9aac34ab07f4c1d0440da191ea7185

data/README.md

@@ -81,3 +81,15 @@ unchanged from a record thusly:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+### Need a different report?
+Adding new reports is easy! Each report consists of two classes, the report and the report record:
+
+Creating a report requires the ```#report_type``` and ```#report_id``` methods to be defined as the params you would pass into the API. Additional default parameters can be specified in ```#report_specific_params```. ```includeTridentTranId```, ```includePurchaseId```, ```includeClientRefNum``` are turned on by default right now, because they would change the order of the columns in some reports. The report class must also specify its ```#record class```. If a report has both a summary and detail version, they should be defined as different classes. The [BatchDetailReport](https://github.com/harrystech/merchant_e_solutions/blob/master/lib/merchant_e_solutions/batch_detail_report.rb) is a good example to reference.
+
+For each row in a report available in the web view there is an instance of a report's report record. Report records specify their attributes, and the order in which the attributes are pulled off of the report CSV. Report record classes also a good place to add co convenience methods. [DetailRecord](https://github.com/harrystech/merchant_e_solutions/blob/master/lib/merchant_e_solutions/detail_record.rb) is a good example to reference.
+
+###TODO
+1. Instances of reports can write out CSVs
+2. Instances of reports can be generated by passing in CSVs(instead of having to pull CSVs directly from the API)
+3. Report records pull their attributes from CSV column names instead of column orders

data/lib/merchant_e_solutions/detail_record.rb

@@ -8,21 +8,21 @@ module MerchantESolutions
       :entry_mode, :transaction_amount, :trident_transaction_id, :client_reference_number
 
     def initialize(row)
-      @organization_id = row[0]
-      @organization_name = row[1]
-      @term_number = row[2]
-      @batch_number = row[3]
-      @batch_date = parse_date(row[4])
-      @transaction_date = parse_date(row[5])
-      @card_code = row[6]
-      @card_number = row[7]
-      @reference_number = row[8]
-      @purchase_id = row[9]
-      @auth_code = row[10]
-      @entry_mode = row[11]
-      @transaction_amount = row[12]
-      @trident_transaction_id = row[13]
-      @client_reference_number = row[14]
+      @organization_id = row["Merchant Id"]
+      @organization_name = row["DBA Name"]
+      @term_number = row["Term Num"]
+      @batch_number = row["Batch Num"]
+      @batch_date = parse_date(row["Batch Date"])
+      @transaction_date = parse_date(row["Tran Date"])
+      @card_code = row["Card Type"]
+      @card_number = row["Card Number"]
+      @reference_number = row["Reference"]
+      @purchase_id = row["Purchase Id"]
+      @auth_code = row["Auth Code"]
+      @entry_mode = row["Entry Mode"]
+      @transaction_amount = row["Tran Amount"]
+      @trident_transaction_id = row["Trident Tran Id"]
+      @client_reference_number = row["Client Ref Num"]
     end
 
     def reference_number(options={})
@@ -30,6 +30,11 @@ module MerchantESolutions
       cleaned_reference_number
     end
 
+    def purchase_id(options={})
+      return @purchase_id if options[:unchanged]
+      cleaned_purchase_id
+    end
+
     def credit_company
       {
         "AM" => "American Express",
@@ -63,5 +68,9 @@ module MerchantESolutions
         @reference_number
       end
     end
+
+    def cleaned_purchase_id
+      @purchase_id.strip
+    end
   end
 end

data/lib/merchant_e_solutions/version.rb

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

data/spec/lib/merchant_e_solutions/detail_record_spec.rb

@@ -1,11 +1,14 @@
 require 'spec_helper'
 
 describe MerchantESolutions::DetailRecord do
+  let(:csv_header) { ["Merchant Id","DBA Name","Term Num","Batch Num","Batch Date","Tran Date","Card Type","Card Number","Reference","Purchase Id","Auth Code","Entry Mode","Tran Amount","Trident Tran Id","Client Ref Num"] }
+
   describe "#initialize" do
     subject { MerchantESolutions::DetailRecord.new(csv_row) }
 
     # "Merchant Id","DBA Name","Term Num","Batch Num","Batch Date","Tran Date","Card Type","Card Number","Reference","Purchase Id","Auth Code","Entry Mode","Tran Amount","Trident Tran Id","Client Ref Num"
-    let(:csv_row) { [42, "Hamazon", 1, 220, "10/07/2013", "10/06/2013", "AM", "000000xxxxxx1234", "'0000213", "AAAAAAAAAAA0", "100000", "KEYED", 7.09, "T.T.ID", "clientRefNumber"] }
+
+    let(:csv_row) { CSV::Row.new(csv_header, [42, "Hamazon", 1, 220, "10/07/2013", "10/06/2013", "AM", "000000xxxxxx1234", "'0000213", "AAAAAAAAAAA0", "100000", "KEYED", 7.09, "T.T.ID", "clientRefNumber"]) }
 
     its(:organization_id) { should == 42 }
     its(:organization_name) { should == "Hamazon" }
@@ -35,7 +38,8 @@ describe MerchantESolutions::DetailRecord do
 
   describe "#reference_number" do
     let(:reference_number) { "'0000213" }
-    let(:record) { MerchantESolutions::DetailRecord.new([nil, nil, nil, nil, nil, nil, nil, nil, reference_number])}
+    let(:csv_row) { CSV::Row.new(csv_header, [nil, nil, nil, nil, nil, nil, nil, nil, reference_number]) }
+    let(:record) { MerchantESolutions::DetailRecord.new(csv_row)}
 
     context "when no arguments are given" do
       it "removes the pre-pended apostrophe from the reference number" do
@@ -59,8 +63,36 @@ describe MerchantESolutions::DetailRecord do
     end
   end
 
+  describe "#purchase_id" do
+    let(:purchase_id) { " AAA0    " }
+    let(:csv_row) { CSV::Row.new(csv_header, [nil, nil, nil, nil, nil, nil, nil, nil, nil, purchase_id]) }
+    let(:record) { MerchantESolutions::DetailRecord.new(csv_row)}
+
+    context "when no arguments are given" do
+      it "strips whitespace from the purchase id" do
+        record.purchase_id.should == "AAA0"
+      end
+    end
+
+    context "when the :unchanged options is set to true" do
+      it "returns the purchase id verbatim, whitespace intact" do
+        record.purchase_id(:unchanged => true).should == purchase_id
+      end
+    end
+
+    context "when the purchase id doesn't contains any spaces" do
+      let(:purchase_id) { "AAA0" }
+
+      it "returns the purchase id verbatim, regardless of the :unchanged argument" do
+        record.purchase_id.should == "AAA0"
+        record.purchase_id(:unchanged => true).should == "AAA0"
+      end
+    end
+  end
+
   describe "credit cards" do
-    subject { MerchantESolutions::DetailRecord.new([nil, nil, nil, nil, nil, nil, card_code]) }
+    let(:csv_row) { CSV::Row.new(csv_header, [nil, nil, nil, nil, nil, nil, card_code]) }
+    subject { MerchantESolutions::DetailRecord.new(csv_row) }
 
     context "when the code is AM" do
       let(:card_code) { "AM" }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: merchant_e_solutions
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Steve Ellis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-21 00:00:00.000000000 Z
+date: 2014-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Wrapper for the Settlement Report API
@@ -161,3 +161,4 @@ test_files:
 - spec/lib/merchant_e_solutions/summary_record_spec.rb
 - spec/lib/merchant_e_solutions_spec.rb
 - spec/spec_helper.rb
+has_rdoc: