global_collect 0.1.5 → 0.2.0

data/HISTORY

@@ -1,3 +1,10 @@
+v0.2.0 (2010-06-07)
+===================
+* add reporting log parsing
+    * Financial Statement
+    * Collection Report + Appendix
+    * Payment Report
+
 v0.1.5 (2010-05-04)
 ===================
 * add two helper methods to GET_ORDERSTATUS v2.0 response:

data/Rakefile

@@ -22,9 +22,10 @@ END
     gemspec.email = "timon.karnezos@gmail.com"
     gemspec.homepage = "http://github.com/timonk/global_collect"
     gemspec.authors = ["Timon Karnezos"]
-    gemspec.version = "0.1.5"
     gemspec.add_dependency('httparty', '>= 0.5.2')
     gemspec.add_dependency('builder', '>= 2.0')
+    gemspec.add_dependency('fastercsv', '>= 1.5.3')
+    gemspec.add_dependency('fixed_width', '>= 0.2.1')
     
     gemspec.add_development_dependency('fakeweb', '>= 1.2.8')
   end

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.2.0

data/examples/parse_collection_report.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require File.join(File.dirname(__FILE__), '..', "lib", "global_collect")
+require 'pp'
+
+path = "something.mt1"
+report = GlobalCollect::LogParsing::CollectionReport::ReportFile.new(path)
+report.parse
+pp report.data
+
+path = "something.csv"
+report = GlobalCollect::LogParsing::CollectionReport::AppendixReportFile.new(path)
+report.parse
+pp report.data

data/examples/parse_financial_statement.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require File.join(File.dirname(__FILE__), '..', "lib", "global_collect")
+require 'pp'
+
+path = "something.asc"
+report = GlobalCollect::LogParsing::FinancialStatement::ReportFile.new(path)
+report.parse
+pp report.data

data/examples/parse_payment_report.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require File.join(File.dirname(__FILE__), '..', "lib", "global_collect")
+require 'pp'
+
+path = "something.wr1"
+report = GlobalCollect::LogParsing::PaymentReport::ReportFile.new(path)
+report.parse
+pp report.data

data/examples/set_payment.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require File.join(File.dirname(__FILE__), '..', "lib", "global_collect")
 
-GlobalCollect.merchant_id           = "5393"
+GlobalCollect.merchant_id           = ""
 GlobalCollect.authentication_scheme = :ip_check
 GlobalCollect.environment           = :test
 GlobalCollect.ip_address            = ""

data/global_collect.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{global_collect}
-  s.version = "0.1.5"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Timon Karnezos"]
-  s.date = %q{2010-05-04}
+  s.date = %q{2010-06-08}
   s.description = %q{Gives minimally intrusive access to Global Collect's payment processing API. 
 Currently implements a very small segment of the full API but is built with 
 extensibility in mind.
@@ -29,6 +29,9 @@ extensibility in mind.
      "examples/convert_amount.rb",
      "examples/get_order_status.rb",
      "examples/insert_order_with_payment.rb",
+     "examples/parse_collection_report.rb",
+     "examples/parse_financial_statement.rb",
+     "examples/parse_payment_report.rb",
      "examples/process_challenged.rb",
      "examples/set_payment.rb",
      "examples/test_connection.rb",
@@ -46,6 +49,14 @@ extensibility in mind.
      "lib/global_collect/const/payment_product.rb",
      "lib/global_collect/const/payment_status.rb",
      "lib/global_collect/field_validator.rb",
+     "lib/global_collect/log_parsing/collection_report/appendix_report_file.rb",
+     "lib/global_collect/log_parsing/collection_report/fields.rb",
+     "lib/global_collect/log_parsing/collection_report/parser.rb",
+     "lib/global_collect/log_parsing/collection_report/report_file.rb",
+     "lib/global_collect/log_parsing/financial_statement/report_file.rb",
+     "lib/global_collect/log_parsing/payment_report/fields.rb",
+     "lib/global_collect/log_parsing/payment_report/parser.rb",
+     "lib/global_collect/log_parsing/payment_report/report_file.rb",
      "lib/global_collect/request_models/base.rb",
      "lib/global_collect/request_models/do_refund/credit_card_payment.rb",
      "lib/global_collect/request_models/do_refund/payment.rb",
@@ -86,6 +97,12 @@ extensibility in mind.
      "spec/const/payment_status_spec.rb",
      "spec/field_validator_spec.rb",
      "spec/global_collect_spec.rb",
+     "spec/log_parsing/collection_report/appendix_report_file_spec.rb",
+     "spec/log_parsing/collection_report/parser_spec.rb",
+     "spec/log_parsing/collection_report/report_file_spec.rb",
+     "spec/log_parsing/financial_statement/report_file_spec.rb",
+     "spec/log_parsing/payment_report/parser_spec.rb",
+     "spec/log_parsing/payment_report/report_file_spec.rb",
      "spec/request_models/base_spec.rb",
      "spec/request_models/insert_order_with_payment/credit_card_online_payment_spec.rb",
      "spec/request_models/insert_order_with_payment/hosted_credit_card_online_payment_spec.rb",
@@ -103,6 +120,10 @@ extensibility in mind.
      "spec/responses/insert_order_with_payment/hosted_merchant_link_payment_response_methods_spec.rb",
      "spec/responses/succcess_row_spec.rb",
      "spec/spec_helper.rb",
+     "spec/support/55550141.wr1",
+     "spec/support/555520100602.csv",
+     "spec/support/555555550145.mt1",
+     "spec/support/FS55550148COMPANY.asc",
      "spec/support/challenged_iowp_v1_response.xml",
      "spec/support/successful_cancel_payment_v1_response.xml",
      "spec/support/successful_convert_amount_v1_response.xml",
@@ -135,6 +156,12 @@ extensibility in mind.
      "spec/const/payment_status_spec.rb",
      "spec/field_validator_spec.rb",
      "spec/global_collect_spec.rb",
+     "spec/log_parsing/collection_report/appendix_report_file_spec.rb",
+     "spec/log_parsing/collection_report/parser_spec.rb",
+     "spec/log_parsing/collection_report/report_file_spec.rb",
+     "spec/log_parsing/financial_statement/report_file_spec.rb",
+     "spec/log_parsing/payment_report/parser_spec.rb",
+     "spec/log_parsing/payment_report/report_file_spec.rb",
      "spec/request_models/base_spec.rb",
      "spec/request_models/insert_order_with_payment/credit_card_online_payment_spec.rb",
      "spec/request_models/insert_order_with_payment/hosted_credit_card_online_payment_spec.rb",
@@ -156,6 +183,9 @@ extensibility in mind.
      "examples/convert_amount.rb",
      "examples/get_order_status.rb",
      "examples/insert_order_with_payment.rb",
+     "examples/parse_collection_report.rb",
+     "examples/parse_financial_statement.rb",
+     "examples/parse_payment_report.rb",
      "examples/process_challenged.rb",
      "examples/set_payment.rb",
      "examples/test_connection.rb",
@@ -169,15 +199,21 @@ extensibility in mind.
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<httparty>, [">= 0.5.2"])
       s.add_runtime_dependency(%q<builder>, [">= 2.0"])
+      s.add_runtime_dependency(%q<fastercsv>, [">= 1.5.3"])
+      s.add_runtime_dependency(%q<fixed_width>, [">= 0.2.1"])
       s.add_development_dependency(%q<fakeweb>, [">= 1.2.8"])
     else
       s.add_dependency(%q<httparty>, [">= 0.5.2"])
       s.add_dependency(%q<builder>, [">= 2.0"])
+      s.add_dependency(%q<fastercsv>, [">= 1.5.3"])
+      s.add_dependency(%q<fixed_width>, [">= 0.2.1"])
       s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
     end
   else
     s.add_dependency(%q<httparty>, [">= 0.5.2"])
     s.add_dependency(%q<builder>, [">= 2.0"])
+    s.add_dependency(%q<fastercsv>, [">= 1.5.3"])
+    s.add_dependency(%q<fixed_width>, [">= 0.2.1"])
     s.add_dependency(%q<fakeweb>, [">= 1.2.8"])
   end
 end

data/lib/global_collect.rb

@@ -1,11 +1,15 @@
+require 'time'
 require 'builder'
 require 'httparty'
 require 'find'
 require 'logger'
 require 'benchmark'
+require 'fixed_width'
+require 'fastercsv'
 
 module GlobalCollect;end
 module GlobalCollect::Builders;end
+module GlobalCollect::LogParsing;end
 module GlobalCollect::RequestModels;end
 module GlobalCollect::Responses;end
 
@@ -22,6 +26,14 @@ lib_dir = File.dirname(__FILE__)
   %w[const payment_product]                                                            ,
   %w[const payment_status]                                                             ,
   %w[field_validator]                                                                  ,
+  %w[log_parsing collection_report fields]                                             ,
+  %w[log_parsing collection_report parser]                                             ,
+  %w[log_parsing collection_report report_file]                                        ,
+  %w[log_parsing collection_report appendix_report_file]                               ,
+  %w[log_parsing financial_statement report_file]                                      ,
+  %w[log_parsing payment_report fields]                                                ,
+  %w[log_parsing payment_report parser]                                                ,
+  %w[log_parsing payment_report report_file]                                           ,
   %w[request_models base]                                                              ,
   %w[request_models insert_order_with_payment order]                                   ,
   %w[request_models insert_order_with_payment payment]                                 ,

data/lib/global_collect/log_parsing/collection_report/appendix_report_file.rb

@@ -0,0 +1,72 @@
+module GlobalCollect::LogParsing::CollectionReport
+  class AppendixReportFile
+    attr_reader :path, :account_id, :date, :data, :environment
+
+    # RG - Ch9 => Technical aspects => File name
+    # 4 chars numeric account id, 8 chars date in YYYMMDD
+    FILENAME_FORMAT = /^(\d{4})(\d{8})\.csv$/
+    def initialize(path)
+      @path = path
+      if File.basename(path) =~ FILENAME_FORMAT
+        @account_id = $1
+        @date = Date.strptime($2, "%Y%m%d")
+        @environment = :production
+      else
+        raise ArgumentError.new("Unparseable path '#{path}'!")
+      end
+    end
+
+    def parse
+      begin
+        file = File.open(@path, "r")
+        csv = FasterCSV.new(file,
+          :col_sep => ";",
+          :headers => FIELDS.map(&:first)
+        )
+        @data = {:data_records => csv.map{|l| convert_line(l) }}
+      ensure
+        file.close
+      end
+    end
+
+    private
+    RECORD_TYPE = {
+      "ON" => :settlement   ,
+      "CR" => :refund       ,
+      "CB" => :chargeback
+    }
+    PAYMENT_METHOD = {
+      "BA" => :bank_payment,
+      "CC" => :credit_card,
+      "CH" => :cheque,
+      "DD" => :direct_debit
+    }
+    PAYMENT_TYPE = {
+      "P" => :payment,
+      "R" => :refund_or_reversal
+    }
+    STRIP_LAMBDA = lambda {|x| x.strip }
+    FIELDS = [
+      [:record_category                , STRIP_LAMBDA                           ],
+      [:record_type                    , lambda{|x| RECORD_TYPE[x] }            ],
+      [:merchant_id                    , lambda {|x| x.to_i }                   ],
+      [:date_due                       , lambda{|x| Date.strptime(x, "%Y%m%d") }],
+      [:currency_due                   , STRIP_LAMBDA                           ],
+      [:amount_due                     , lambda {|x| x.to_f }                   ],
+      [:order_currency                 , STRIP_LAMBDA                           ],
+      [:order_amount                   , lambda {|x| x.to_f }                   ],
+      [:payment_method                 , lambda{|x| PAYMENT_METHOD[x] }         ],
+      [:credit_card_company            , STRIP_LAMBDA                           ],
+      [:cross_border_indicator         , STRIP_LAMBDA                           ],
+      [:globalcollect_payment_reference, STRIP_LAMBDA                           ],
+      [:merchant_reference             , STRIP_LAMBDA                           ],
+      [:invoice_number                 , STRIP_LAMBDA                           ],
+      [:customer_id                    , STRIP_LAMBDA                           ],
+      [:filename_data_delivery         , STRIP_LAMBDA                           ],
+      [:payment_type                   , lambda{|x| PAYMENT_TYPE[x] }           ]
+    ]
+    def convert_line(line)
+      FIELDS.inject({}) {|memo, pair| memo[pair.first] = pair.last.call(line[pair.first]); memo }
+    end
+  end
+end

data/lib/global_collect/log_parsing/collection_report/fields.rb

@@ -0,0 +1,161 @@
+module GlobalCollect::LogParsing::CollectionReport
+  HEADER_TRAILER_FIELDS = [
+    {
+      :type     =>"N",
+      :length   =>"4",
+      :position =>"0004-0007",
+      :name     =>"account_id",
+      :field    =>"021"
+    },
+    {
+      :type     =>"AN",
+      :length   =>"12",
+      :position =>"0008-0019",
+      :name     =>"filename",
+      :field    =>"022"
+    },
+    {
+      :type     =>"AN",
+      :length   =>"3",
+      :position =>"0020-0022",
+      :name     =>"filename_extension",
+      :field    =>"023"
+    },
+    {
+      :type     =>"D",
+      :length   =>"8",
+      :position =>"0023-0030",
+      :name     =>"date_production",
+      :field    =>"024"
+    },
+    {
+      :type     =>"D",
+      :length   =>"8",
+      :position =>"0031-0038",
+      :name     =>"period_from",
+      :field    =>"025"
+    },
+    {
+      :type     =>"D",
+      :length   =>"8",
+      :position =>"0039-0046",
+      :name     =>"period_to",
+      :field    =>"026"
+    }
+  ]
+
+  DATA_FIELDS = [
+    {
+      :type     =>"N",
+      :length   =>"4",
+      :position =>"0004-0007",
+      :name     =>"merchant_id",
+      :field    =>"051"
+    },
+    {
+      :type     =>"D",
+      :length   =>"8",
+      :position =>"0008-0015",
+      :name     =>"match_date",
+      :field    =>"062"
+    },
+    {
+      :type     =>"N",
+      :length   =>"4",
+      :position =>"0016-0019",
+      :name     =>"report_year",
+      :field    =>"053"
+    },
+    {
+      :type     =>"N",
+      :length   =>"3",
+      :position =>"0020-0022",
+      :name     =>"report_serial_number",
+      :field    =>"054"
+    },
+    {
+      :type     =>"D",
+      :length   =>"8",
+      :position =>"0023-0030",
+      :name     =>"report_date_from",
+      :field    =>"055"
+    },
+    {
+      :type     =>"D",
+      :length   =>"8",
+      :position =>"0031-0038",
+      :name     =>"report_date_to",
+      :field    =>"056"
+    },
+    {
+      :type     =>"AN",
+      :length   =>"4",
+      :position =>"0039-0042",
+      :name     =>"currency_due",
+      :field    =>"057"
+    },
+    {
+      :type     =>"N",
+      :length   =>"12",
+      :position =>"0043-0054",
+      :name     =>"amount_due",
+      :field    =>"058"
+    },
+    {
+      :type     =>"AN",
+      :length   =>"1",
+      :position =>"0055-0055",
+      :name     =>"amount_due_sign",
+      :field    =>"910"
+    },
+    {
+      :type     =>"AN",
+      :length   =>"4",
+      :position =>"0056-0059",
+      :name     =>"currency_paid",
+      :field    =>"059"
+    },
+    {
+      :type     =>"N",
+      :length   =>"12",
+      :position =>"0060-0071",
+      :name     =>"amount_paid",
+      :field    =>"060"
+    },
+    {
+      :type     =>"AN",
+      :length   =>"1",
+      :position =>"0072-0072",
+      :name     =>"amount_paid_sign",
+      :field    =>"910"
+    },
+    {
+      :type     =>"XR",
+      :length   =>"16",
+      :position =>"0073-0088",
+      :name     =>"exchange_rate",
+      :field    =>"061"
+    },
+    {
+      :type     =>"N",
+      :length   =>"5",
+      :position =>"0089-0093",
+      :name     =>"rate_units",
+      :field    =>"063"
+    },
+    {
+      :type     =>"N",
+      :length   =>"6",
+      :position =>"0094-0099",
+      :name     =>"number_of_transactions",
+      :field    =>"062"
+    },
+    {
+      :type     =>"AN",
+      :length   =>"301",
+      :position =>"0100-0400",
+      :name     =>"filler",
+      :field    =>"999"
+    }
+  ]
+end

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

@@ -0,0 +1,68 @@
+module GlobalCollect::LogParsing::CollectionReport
+  class Parser
+    def self.parse(file)
+      FixedWidth.parse(file, :collection_report)
+    end
+
+    private
+
+    RECORD_TYPE = {
+      "HDR" => :file_header,
+      "POV" => :data_record,
+      "TRL" => :file_trailer
+    }
+
+    # RG - Ch8 => Technical aspects => Field Format
+    # Exchange rates always have 8 decimal places of precision.
+    EXCHANGE_RATE_LAMBDA = lambda{|x| "#{x[0..-9]}.#{x[-8..-1]}".to_f }
+    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 }
+      when "XR"  then { :parser => EXCHANGE_RATE_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(:collection_report, :nil_blank => true) do |pr|
+      pr.template :record_info do |ri|
+        ri.record_type 3, :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(:singular => true) do |h|
+        h.trap { |line| line[0,3] == 'HDR' }
+        h.template :record_info
+        h.template :header_trailer
+        h.spacer 354
+      end
+
+      pr.data_records(:optional => true) do |d|
+        d.trap { |line| line[0,3] == "POV" }
+        d.template :record_info
+        DATA_FIELDS.each {|field| make_column(d, field) }
+      end
+
+      pr.trailer(:singular => true) do |t|
+        t.trap { |line| line[0,3] == 'TRL' }
+        t.template :record_info
+        t.template :header_trailer
+        t.column   :number_of_records, 8, :parser => :to_i
+        t.spacer 346
+      end
+    end
+  end
+end