global_collect 0.1.5 → 0.2.0

data/lib/global_collect/log_parsing/payment_report/parser.rb

@@ -0,0 +1,105 @@
+module GlobalCollect::LogParsing::PaymentReport
+  class Parser
+    def self.parse(file)
+      FixedWidth.parse(file, :payment_report)
+    end
+
+    private
+
+    RECORD_CATEGORY = {
+      "X" => :processed  ,
+      "+" => :collected  ,
+      "-" => :reversed   ,
+      "I" => :information
+    }
+
+    RECORD_TYPE = {
+      "FH" => :file_header  ,
+      "FT" => :file_trailer ,
+      "BH" => :batch_header ,
+      "BT" => :batch_trailer,
+      "ON" => :settlement   ,
+      "RS" => :refusal      ,
+      "RN" => :rejection    ,
+      "CR" => :refund       ,
+      "CB" => :chargeback
+    }
+
+    DATA_GROUPS = {
+      0..21  => :order,
+      22..34 => :payment,
+      35..44 => :chargeback,
+      45..51 => :refund
+    }
+    def self.data_group(index)
+      DATA_GROUPS.detect{|range, group| range.include?(index) }.last
+    end
+
+    DATE_LAMBDA = lambda {|d| Date.strptime(d, "%Y%m%d") }
+    def self.options_for_format(format)
+      case format
+      when "N"  then { :align => :right, :parser => :to_i }
+      when "AN" then { :align => :left }
+      when "D"  then { :parser => DATE_LAMBDA }
+      else raise ArgumentError.new("Unknown field format '#{format.inspect}'!")
+      end
+    end
+
+    SPACERS = ['reserved', 'filler']
+    def self.make_column(section, field, options={})
+      if SPACERS.include?(field[:name])
+        section.spacer(field[:length].to_i, ' ')
+      else
+        section.column(field[:name].to_sym, field[:length].to_i, options_for_format(field[:type]).merge(options))
+      end
+    end
+
+    DEFINITION = FixedWidth.define(:payment_report, :nil_blank => true) do |pr|
+      pr.template :record_info do |ri|
+        ri.record_category 1, :parser => lambda{|x| RECORD_CATEGORY[x] }
+        ri.record_type     2, :parser => lambda{|x| RECORD_TYPE[x]     }
+      end
+      pr.template :header_trailer do |hf|
+        HEADER_TRAILER_FIELDS.each {|field| make_column(hf, field) }
+      end
+
+      pr.header do |h|
+        h.trap { |line| line[0,3] == 'IFH' }
+        h.template :record_info
+        h.template :header_trailer
+      end
+
+      pr.batch_header do |bh|
+        bh.trap { |line| line[0,3] == 'IBH' }
+        bh.template :record_info
+        BATCH_HEADER_FIELDS.each {|field| make_column(bh, field) }
+      end
+
+      pr.data_records(:optional => true) do |d|
+        d.trap { |line| line =~ /^[X,-,+]/ }
+        d.template :record_info
+        DATA_FIELDS.each_with_index do |field, index|
+          make_column(d, field, :group => data_group(index))
+        end
+      end
+
+      pr.information_records(:optional => true) do |info|
+        info.trap { |line| line[0,3] == 'ITM' }
+        info.template :record_info
+        INFORMATION_FIELDS.each {|field| make_column(info, field) }
+      end
+
+      pr.batch_trailer do |bt|
+        bt.trap { |line| line[0,3] == 'IBT' }
+        bt.template :record_info
+        BATCH_TRAILER_FIELDS.each {|field| make_column(bt, field) }
+      end
+
+      pr.trailer do |t|
+        t.trap { |line| line[0,3] == 'IFT' }
+        t.template :record_info
+        t.template :header_trailer
+      end
+    end
+  end
+end

data/lib/global_collect/log_parsing/payment_report/report_file.rb

@@ -0,0 +1,31 @@
+module GlobalCollect::LogParsing::PaymentReport
+  class ReportFile
+    attr_reader :path, :account_id, :date, :environment, :data
+
+    # RG - Ch2 => Technical aspects => File name
+    # 4 chars numeric account id, 1 char numeric year, 3 char numeric day-of-year,
+    # extension /wrt/ if test, /wr\d/ if production (usually wr1).
+    FILENAME_FORMAT = /^(\d{4})(\d{1})(\d{3})\.wr(.)$/
+    YEAR_BASE_ADJUSTED = ( Date.today.year * 10 ) / 10
+    TEST_ENV_BYTE = 't'
+    def initialize(path)
+      @path = path
+      if File.basename(path) =~ FILENAME_FORMAT
+        @account_id = $1
+        @date = Date.ordinal(YEAR_BASE_ADJUSTED + $2.to_i, $3.to_i)
+        @environment = (TEST_ENV_BYTE == $4) ? :test : :production
+      else
+        raise ArgumentError.new("Unparseable path '#{path}'!")
+      end
+    end
+
+    def parse
+      begin
+        file = File.open(@path, "r")
+        @data = GlobalCollect::LogParsing::PaymentReport::Parser.parse(file)
+      ensure
+        file.close
+      end
+    end
+  end
+end

data/lib/global_collect/responses/base.rb

@@ -1,5 +1,3 @@
-require 'time'
-
 module GlobalCollect::Responses
   # WDL §4 specifies the generalized response
   # This base class is sufficient for many responses that don't include anything

data/lib/global_collect/test_helper.rb

@@ -1,7 +1,11 @@
 require 'fakeweb'
 
-def read_canned_response(filename)
-  File.read(File.join(File.dirname(__FILE__), '..', '..', 'spec', 'support', filename))
+def support_path(filename)
+  File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec', 'support', filename))
+end
+
+def read_support_file(filename)
+  File.read(support_path(filename))
 end
 
 def filename_for(success, action, version)
@@ -14,12 +18,12 @@ def filename_for(success, action, version)
 end
 
 def install_canned_response(service, env, auth_scheme, success, action, version)
-  response_body = read_canned_response(filename_for(success, action, version))
+  response_body = read_support_file(filename_for(success, action, version))
   service_url = GlobalCollect::ApiClient.service_url(service, env, auth_scheme)
   FakeWeb.register_uri(:post, service_url, :body => response_body)
 end
 
 def parse_canned_response(success, action, version)
-  response_body = read_canned_response(filename_for(success, action, version))
+  response_body = read_support_file(filename_for(success, action, version))
   GlobalCollect::Responses::Base.new(Crack::XML.parse(response_body), response_body)
 end

data/spec/log_parsing/collection_report/appendix_report_file_spec.rb

@@ -0,0 +1,96 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe "the appendix to the collection report file" do
+  it "should sort out the metadata from the file name" do
+    report = GlobalCollect::LogParsing::CollectionReport::AppendixReportFile.new("555520100602.csv")
+    report.account_id.should == "5555"
+    report.date.should == Date.strptime("20100602", "%Y%m%d")
+    report.environment.should == :production
+  end
+
+  it "should parse" do
+    report = GlobalCollect::LogParsing::CollectionReport::AppendixReportFile.new(support_path("555520100602.csv"))
+    report.parse
+    report.data.should_not be_blank
+    report.data.should == {
+        :data_records => [
+           {
+                                 :order_currency => "USD",
+                             :merchant_reference => "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+                                   :order_amount => 41.05,
+                                 :invoice_number => "",
+                                 :payment_method => :credit_card,
+                                    :customer_id => "",
+                                    :merchant_id => 5555,
+                            :credit_card_company => "ECMC",
+                                   :currency_due => "USD",
+                         :filename_data_delivery => "a0110147.pg1",
+                                :record_category => "+",
+                         :cross_border_indicator => "N",
+                                     :amount_due => 41.05,
+                                   :payment_type => :payment,
+                                       :date_due => Date.strptime("20100602", "%Y%m%d"),
+                                    :record_type => :settlement,
+                :globalcollect_payment_reference => "206807294137"
+            },
+            {
+                                 :order_currency => "USD",
+                             :merchant_reference => "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
+                                   :order_amount => 88.99,
+                                 :invoice_number => "",
+                                 :payment_method => :credit_card,
+                                    :customer_id => "",
+                                    :merchant_id => 5555,
+                            :credit_card_company => "VISA",
+                                   :currency_due => "USD",
+                         :filename_data_delivery => "a0110147.pg1",
+                                :record_category => "+",
+                         :cross_border_indicator => "N",
+                                     :amount_due => 88.99,
+                                   :payment_type => :payment,
+                                       :date_due => Date.strptime("20100602", "%Y%m%d"),
+                                    :record_type => :settlement,
+                :globalcollect_payment_reference => "206807294138"
+            },
+            {
+                                 :order_currency => "USD",
+                             :merchant_reference => "cccccccccccccccccccccccccccccc",
+                                   :order_amount => -24.5,
+                                 :invoice_number => "",
+                                 :payment_method => :credit_card,
+                                    :customer_id => "",
+                                    :merchant_id => 5555,
+                            :credit_card_company => "VISA",
+                                   :currency_due => "USD",
+                         :filename_data_delivery => "a0110147.rg1",
+                                :record_category => "-",
+                         :cross_border_indicator => "N",
+                                     :amount_due => -24.5,
+                                   :payment_type => :refund_or_reversal,
+                                       :date_due => Date.strptime("20100602", "%Y%m%d"),
+                                    :record_type => :refund,
+                :globalcollect_payment_reference => "206806008113"
+            },
+            {
+                                 :order_currency => "USD",
+                             :merchant_reference => "dddddddddddddddddddddddddddddd",
+                                   :order_amount => -77.83,
+                                 :invoice_number => "",
+                                 :payment_method => :credit_card,
+                                    :customer_id => "",
+                                    :merchant_id => 5555,
+                            :credit_card_company => "ECMC",
+                                   :currency_due => "USD",
+                         :filename_data_delivery => "a0110147.rg1",
+                                :record_category => "-",
+                         :cross_border_indicator => "N",
+                                     :amount_due => -77.83,
+                                   :payment_type => :refund_or_reversal,
+                                       :date_due => Date.strptime("20100602", "%Y%m%d"),
+                                    :record_type => :refund,
+                :globalcollect_payment_reference => "206806008114"
+            }
+        ]
+    }
+  end
+end

data/spec/log_parsing/collection_report/parser_spec.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe "the collection report parser" do
+  it "should parse" do
+    file = File.open(support_path("555555550145.mt1"), "r")
+    data = GlobalCollect::LogParsing::CollectionReport::Parser.parse(file)
+    data[:header].should_not be_nil
+    data[:header][:account_id].should == 5555
+    data[:header][:record_type].should == :file_header
+    data[:header][:date_production].should == Date.ordinal(2010, 145)
+    data[:header][:period_to].should       == Date.ordinal(2010, 145)
+    data[:header][:period_from].should     == Date.ordinal(2010, 145)
+
+    data[:trailer].should_not be_nil
+    data[:trailer][:account_id].should == 5555
+    data[:trailer][:record_type].should == :file_trailer
+    data[:trailer][:number_of_records].should == 3
+    data[:trailer][:date_production].should == Date.ordinal(2010, 145)
+    data[:trailer][:period_to].should       == Date.ordinal(2010, 145)
+    data[:trailer][:period_from].should     == Date.ordinal(2010, 145) 
+
+    data[:data_records].should_not be_nil
+    data[:data_records].size.should == 1
+    data_record = data[:data_records].first
+    data_record[:report_date_from      ].should == Date.ordinal(2010, 145)
+    data_record[:amount_paid           ].should == 2384211
+    data_record[:report_date_to        ].should == Date.ordinal(2010, 145)
+    data_record[:amount_paid_sign      ].should == nil
+    data_record[:currency_due          ].should == "USD"
+    data_record[:exchange_rate         ].should == 1.0
+    data_record[:match_date            ].should == Date.ordinal(2010, 145)
+    data_record[:record_type           ].should == :data_record
+    data_record[:amount_due            ].should == 2384211
+    data_record[:rate_units            ].should == 1
+    data_record[:report_year           ].should == 2010
+    data_record[:amount_due_sign       ].should == nil
+    data_record[:merchant_id           ].should == 5555
+    data_record[:number_of_transactions].should == 1137
+    data_record[:report_serial_number  ].should == 1
+    data_record[:currency_paid         ].should == "USD"
+  end
+end

data/spec/log_parsing/collection_report/report_file_spec.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe "the collection report file" do
+  it "should sort out the metadata from the file name" do
+    report = GlobalCollect::LogParsing::CollectionReport::ReportFile.new("555555550145.mt1")
+    report.account_id.should == "5555"
+    report.master_account_id.should == "5555"
+    report.date.should == Date.ordinal(2010, 145)
+    report.environment.should == :production
+  end
+
+  it "should parse" do
+    report = GlobalCollect::LogParsing::CollectionReport::ReportFile.new(support_path("555555550145.mt1"))
+    report.parse
+    report.data.should_not be_blank
+  end
+end

data/spec/log_parsing/financial_statement/report_file_spec.rb

@@ -0,0 +1,51 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe "the financial statement report file" do
+  it "should sort out the metadata from the file name" do
+    report = GlobalCollect::LogParsing::FinancialStatement::ReportFile.new("FS55550148COMPANY.asc")
+    report.account_id.should == "5555"
+    report.date.should == Date.ordinal(2010, 148)
+    report.environment.should == :production
+  end
+
+  def check_report(report)
+    report.data.should_not be_blank
+    report.data[:header][:record_type].should == :file_header
+    report.data[:header][:relation_number].should == 'R0555500'
+    report.data[:header][:date_production].should == Date.ordinal(2010, 148)
+
+    report.data[:trailer][:record_type].should == :file_trailer
+    report.data[:trailer][:number_of_records].should == 12
+    report.data[:trailer][:relation_number].should == 'R0555500'
+    report.data[:trailer][:date_production].should == Date.ordinal(2010, 148)
+
+    report.data[:data].size.should == 10
+    report.data[:data].each{|d| d[:record_type].should == :data_record }
+    data_record = report.data[:data].first
+    data_record[:reference_number_week].should == "21FR"
+    data_record[:reference_number_year].should == 2010
+    data_record[:class                ].should == :collection_reports
+    data_record[:account_id           ].should == 5555
+    data_record[:description          ].should == "25-05-2010 25-05-2010"
+    data_record[:currency             ].should == "USD"
+    data_record[:amount               ].should == 3333333
+    data_record[:amount_sign          ].should == "+"
+  end
+
+  it "should parse with BOM" do
+    report = GlobalCollect::LogParsing::FinancialStatement::ReportFile.new(support_path("FS55550148COMPANY.asc"))
+    report.parse
+    check_report(report)
+  end
+
+  it "should parse without BOM" do
+    require 'tempfile'
+    tf = Tempfile.new("FS55550148COMPANY.asc")
+    tf.write(File.read(support_path("FS55550148COMPANY.asc"))[3..-1]) #remove BOM
+    tf.rewind
+    report = GlobalCollect::LogParsing::FinancialStatement::ReportFile.new(tf.path)
+    report.parse
+    check_report(report)
+    tf.close(true)
+  end
+end

data/spec/log_parsing/payment_report/parser_spec.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe "the payment report parser" do
+  it "should parse" do
+    file = File.open(support_path("55550141.wr1"), "r")
+    data = GlobalCollect::LogParsing::PaymentReport::Parser.parse(file)
+
+    data[:header].size.should == 1
+    data[:header].first[:record_type].should == :file_header
+    data[:header].first[:filename].should == '55550141'
+
+    data[:batch_header].size.should == 1
+    data[:batch_header].first[:record_type].should == :batch_header
+    data[:batch_header].first[:merchant_id].should == 5555
+
+    data[:trailer].size.should == 1
+    data[:trailer].first[:record_type].should == :file_trailer
+    data[:trailer].first[:filename].should == '55550141'
+
+    data[:batch_trailer].size.should == 1
+    data[:batch_trailer].first[:record_type].should == :batch_trailer
+    data[:batch_trailer].first[:number_of_records].should == 443
+
+    data[:information_records].size.should == 1
+    data[:information_records].first[:total_amount_due].should == 211
+
+    data[:data_records].size.should == 2
+    data[:data_records].each do |r|
+      r[:record_type].should == :settlement
+      r[:record_category].should == :processed
+      r[:payment][:payment_method].should == "CC"
+      r[:order][:card_number].should == "************1234"
+      r[:refund].values.each    {|v| v.should be_nil }
+      r[:chargeback].values.each{|v| v.should be_nil }
+    end
+  end
+end

data/spec/log_parsing/payment_report/report_file_spec.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe "the payment report file" do
+  it "should sort out the metadata from the file name (prod)" do
+    report = GlobalCollect::LogParsing::PaymentReport::ReportFile.new("55550141.wr1")
+    report.account_id.should == "5555"
+    report.date.should == Date.ordinal(2010, 141)
+    report.environment.should == :production
+  end
+
+  it "should sort out the metadata from the file name (test)" do
+    report = GlobalCollect::LogParsing::PaymentReport::ReportFile.new("55550141.wrt")
+    report.account_id.should == "5555"
+    report.date.should == Date.ordinal(2010, 141)
+    report.environment.should == :test
+  end
+
+  it "should parse" do
+    report = GlobalCollect::LogParsing::PaymentReport::ReportFile.new(support_path("55550141.wr1"))
+    report.parse
+    report.data.should_not be_blank
+  end
+end