total_in 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9daf2078aea2bffac2851c381b979d49c65cce6f
-  data.tar.gz: 918f03d6bd88d8c99c3f2f6ef54232aa60922ae0
+  metadata.gz: 353b198563a1b0e9a48706e4c84a43a259cd4e05
+  data.tar.gz: 7b88983001ccc29990a62b3bae56c84995082aec
 SHA512:
-  metadata.gz: ffa4a64cd178435c8eae2d7de63ee20bcf58074190f92cb6fa75d3dd4d399c20d9e0354b5edb88b7937903392cda373bcf5fbfdb13ded8491fb9d781df3be3e8
-  data.tar.gz: 4a84dd6f73a09230540a0e77be52a7ac402071b0d92052991ea763cefae3ccd6c7f1374e45dafd91850246965178d5881be775993a108b4b818425ad04a65220
+  metadata.gz: 1ea026300e106f9ed6f8b18fbd3f2882d68e87c26a51b3e2c66cd90cdb218c0da56badaf595bc0e552ba11c8ba51e135daa71962e205a5368cad954a8906de9c
+  data.tar.gz: 9a35cb35e78bae51be28b160e44625c756e902496d8c90462613a3e289b4f187bc707715db57d363129f0c512ee436d928d9b3e3d52d421f94c585cab6991c76

data/README.md

@@ -3,6 +3,7 @@
 [![Code Climate](https://codeclimate.com/github/Oktavilla/total-in-ruby/badges/gpa.svg)](https://codeclimate.com/github/Oktavilla/total-in-ruby)
 [![Test Coverage](https://codeclimate.com/github/Oktavilla/total-in-ruby/badges/coverage.svg)](https://codeclimate.com/github/Oktavilla/total-in-ruby)
 
+Parses transaction files in the [TotalIn format](http://www.nordea.se/Images/39-16101/postbeskrivning-total-in-eng.pdf).
 
 ## Usage
 

data/lib/total_in/document.rb

@@ -15,12 +15,16 @@ module TotalIn
       @accounts ||= []
     end
 
+    def transaction_date
+      accounts.map(&:date).compact.first
+    end
+
     def payments
-      accounts.map { |a| a.payments }.flatten
+      accounts.flat_map(&:payments)
     end
 
     def deductions
-      accounts.map { |a| a.deductions }.flatten
+      accounts.flat_map(&:deductions)
     end
 
     class Account

data/lib/total_in/file_format_validator.rb

@@ -0,0 +1,19 @@
+require "total_in/line_parser"
+module TotalIn
+  class FileFormatValidator < LineParser
+    field :record_type, 0..1, :raw
+    field :file_type, 36..38
+
+    def valid?
+      errors.empty?
+    end
+
+    def errors
+      errors = []
+      errors << "Must start with 00 (was ”#{record_type}”)" if record_type != "00"
+      errors << "Must be of type TL1 (was ”#{file_type}”" if file_type != "TL1"
+
+      errors
+    end
+  end
+end

data/lib/total_in/line_handlers.rb

@@ -3,33 +3,97 @@ require "total_in/line_processors"
 
 module TotalIn
   module LineHandlers
+    def self.mapping
+      {
+        "00" => self.document_start,
+        "99" => self.document_end,
+        "10" => self.account_start,
+        "90" => self.account_end,
+        "20" => self.payment_start,
+        "25" => self.deduction_start,
+        "30" => self.reference_numbers,
+        "40" => self.messages,
+        "50" => self.sender_names,
+        "51" => self.sender_address,
+        "52" => self.sender_locality,
+        "60" => self.sender_account_start,
+        "61" => self.sender_account_names,
+        "62" => self.sender_account_address,
+        "63" => self.sender_account_locality,
+        "70" => self.international
+      }
+    end
+
+    def self.document_start
+      Handler.new LineParsers::DocumentStart, LineProcessors::DocumentStart
+    end
+
+    def self.document_end
+      Handler.new LineParsers::DocumentEnd, LineProcessors::DocumentEnd
+    end
+
+    def self.account_start
+      Handler.new LineParsers::AccountStart, LineProcessors::AccountStart
+    end
+
+    def self.account_end
+      Handler.new LineParsers::AccountEnd, LineProcessors::AccountEnd
+    end
+
+    def self.payment_start
+      Handler.new LineParsers::PaymentStart, LineProcessors::PaymentStart
+    end
+
+    def self.deduction_start
+      Handler.new LineParsers::DeductionStart, LineProcessors::DeductionStart
+    end
+
+    def self.reference_numbers
+      Handler.new LineParsers::ReferenceNumbers, LineProcessors::ReferenceNumbers
+    end
+
+    def self.messages
+      Handler.new LineParsers::Messages, LineProcessors::Messages
+    end
+
+    def self.sender_names
+      Handler.new LineParsers::Names, LineProcessors::Names.new(Document::Sender)
+    end
+
+    def self.sender_address
+      Handler.new LineParsers::Addresses, LineProcessors::Addresses.new(Document::Sender)
+    end
+
+    def self.sender_locality
+      Handler.new LineParsers::Locality, LineProcessors::Locality.new(Document::Sender)
+    end
+
+    def self.sender_account_start
+      Handler.new LineParsers::SenderAccount, LineProcessors::SenderAccount
+    end
+
+    def self.sender_account_names
+      Handler.new LineParsers::Names, LineProcessors::Names.new(Document::SenderAccount)
+    end
+
+    def self.sender_account_address
+      Handler.new LineParsers::Addresses, LineProcessors::Addresses.new(Document::SenderAccount)
+    end
+
+    def self.sender_account_locality
+      Handler.new LineParsers::Locality, LineProcessors::Locality.new(Document::SenderAccount)
+    end
+
+    def self.international
+      Handler.new LineParsers::International, LineProcessors::International
+    end
+
     Handler = Struct.new :parser, :processor do
-      def handle line, contexts
+      def process line, contexts
         line_parser = self.parser.new(line)
 
         processor.call line_parser, contexts
       end
     end
-
-    def self.all
-      {
-        "00" => Handler.new(LineParsers::DocumentStart, LineProcessors::DocumentStart),
-        "99" => Handler.new(LineParsers::DocumentEnd, LineProcessors::DocumentEnd),
-        "10" => Handler.new(LineParsers::AccountStart, LineProcessors::AccountStart),
-        "90" => Handler.new(LineParsers::AccountEnd, LineProcessors::AccountEnd),
-        "20" => Handler.new(LineParsers::PaymentStart, LineProcessors::PaymentStart),
-        "25" => Handler.new(LineParsers::DeductionStart, LineProcessors::DeductionStart),
-        "30" => Handler.new(LineParsers::ReferenceNumbers, LineProcessors::ReferenceNumbers),
-        "40" => Handler.new(LineParsers::Messages, LineProcessors::Messages),
-        "50" => Handler.new(LineParsers::Names, LineProcessors::Names.new(Document::Sender)),
-        "51" => Handler.new(LineParsers::Addresses, LineProcessors::Addresses.new(Document::Sender)),
-        "52" => Handler.new(LineParsers::Locality, LineProcessors::Locality.new(Document::Sender)),
-        "60" => Handler.new(LineParsers::SenderAccount, LineProcessors::SenderAccount),
-        "61" => Handler.new(LineParsers::Names, LineProcessors::Names.new(Document::SenderAccount)),
-        "62" => Handler.new(LineParsers::Addresses, LineProcessors::Addresses.new(Document::SenderAccount)),
-        "63" => Handler.new(LineParsers::Locality, LineProcessors::Locality.new(Document::SenderAccount)),
-        "70" => Handler.new(LineParsers::International, LineProcessors::International)
-      }
-    end
   end
 end

data/lib/total_in/line_parser.rb

@@ -32,7 +32,7 @@ module TotalIn
     end
 
     def value_at_position range, type
-      typecast line[range].strip, type
+      typecast line[range].to_s.strip, type
     end
 
     def typecast value, type

data/lib/total_in/parser.rb

@@ -1,48 +1,71 @@
+require "total_in/file_format_validator"
 require "total_in/line_handlers"
 require "total_in/contexts"
 
 module TotalIn
+  class InvalidFileFormatError < ArgumentError; end;
+
   class Parser
-    attr_reader :text
+    attr_reader :file
 
-    def initialize text
-      @text = text
+    # Parser.new accepts a File instance or a String
+    # A InvalidFileFormatError will be raised if file isn't in the TotalIn format
+    def initialize file
+      @file = file
+      validate_file_format
     end
 
     def result
-      contexts = parse_lines text.each_line.to_a, Contexts.new
+      parse_lines(Contexts.new).result
+    end
+
+    protected
 
-      contexts.result
+    def lines
+      @lines ||= file.each_line
     end
 
     private
 
-    def parse_lines lines, contexts
-      if line = lines.shift
-        parse_lines lines, parse_line(line, contexts)
-      else
+    def validate_file_format
+      validator = FileFormatValidator.new first_line
+      raise InvalidFileFormatError.new(validator.errors.join(", ")) unless validator.valid?
+    end
+
+    def parse_lines contexts
+      begin
+        parse_lines parse_line(self.lines.next, contexts)
+      rescue StopIteration
+        self.lines.rewind # Ensure we do not bomb out when calling result multiple times
         contexts
       end
     end
 
+    # Look up a matching handler for the line and process it
+    # The process method on a handler always returns a Contexts object
     def parse_line line, contexts
+      line = line.encode Encoding::UTF_8 if encode_lines?
+
       handler = handler_for_line line
 
-      handler.handle line, contexts
+      handler.process line, contexts
     end
 
     def handler_for_line line
-      self.class.handlers.fetch line[0..1]
+      LineHandlers.mapping.fetch line[0..1]
     end
 
-    def self.handlers
-      @handlers ||= {}
+    def encode_lines?
+      first_line.encoding != Encoding::UTF_8
     end
 
-    def self.register_handlers handlers
-      @handlers = handlers
-    end
+    def first_line
+      @first_line ||= begin
+        line = self.lines.peek
+        self.lines.rewind # peek seems to move the pointer when file is an actual File object
 
-    register_handlers LineHandlers.all
+        line
+      end
+    end
   end
 end

data/lib/total_in/typecaster.rb

@@ -9,9 +9,10 @@ module TotalIn
     def self.casters
       {
         integer: ->(value) { value.to_i },
-        time: ->(value) { Time.parse(value) },
-        date: ->(value) { Date.parse(value) },
-        string: ->(value) { value unless value.match(/\A0+\Z/) }
+        time: ->(value) { Time.strptime(value, "%Y%m%d%H%M%S%N") },
+        date: ->(value) { Date.strptime(value, "%Y%m%d") },
+        string: ->(value) { value unless value.match(/\A0+\Z/) },
+        raw: ->(value) { value }
       }
     end
   end

data/lib/total_in/version.rb

@@ -1,3 +1,3 @@
 module TotalIn
-  VERSION = "0.5.1"
+  VERSION = "1.0.0"
 end

data/spec/fixtures/{total_in_full.txt → total_in_full_latin_1.txt}

@@ -1,61 +1,61 @@
-00TI222222    2011102504133012345601TL1TOTALIN                                  
-1010181                               SEK20111024                               
-2038952344444                        00000000030255022222333334444451           
-3038952345678                        38952145778                                
-40FAKTURANR:38952344444              INTERN REF:  9780858                       
-40FAKTURANR:38952345678              38952145778ABC                             
-601234567                             19999999999                               
-61TESTBOLAGET AB                                                                
-62GATAN 12                                                                      
-6312345    TESTSTAD                                                             
-200000000000000000000000000          00000000042973522222333334444455           
-40TACK FÖR LÅNET                                                                
-50FÖRETAGET AB FRISKVÅRDAVD.                                                    
-6099999999                                                                      
-61FÖRETAGET AB                                                                  
-62GATAN 7                                                                       
-6388888    TESTORTEN                                                            
-200000000000000000000000000          0000000002109002222233333444446734523455   
-40BETALNING FÖR VARA 123                                                        
-50TESTFABRIKEN AB                                                               
-51GATAN 22                                                                      
-5211111    TESTVIKEN                                                            
-6098765433                            29999999999                               
-61NORDEA BANK AB                                                                
-6310571    STOCKHOLM                                                            
-200000000000000000000000000          00000000014836522222333334444472           
-601222211                             19999999999                               
-2038952345555                        00000000088000022222333334444423           
-40FAKT 38952345555,FAKTURANR                                                    
-602232567                             19999999999                               
-70000000000000000                     000000000100000EUR000000088000            
-25987654123                          00000000005255022222333334444457           
-40FAKTURA NR: 987654123 ABC          KUNDNR: 123                                
-40ÅTERBETALNING                                                                 
-601234567                             19999999999                               
-61TESTBOLAGET AB                                                                
-62GATAN 12                                                                      
-6312345    TESTSTAD                                                             
-90000000060000000000191900020111024001                                          
-109690017                             SEK20111024                               
-200000000000000000000000000          00000000092343411111222223333344           
-40BETALNING AVSEENDE KÖP 110902                                                 
-601234567                             19999999999                               
-61TESTBOLAGET AB                                                                
-62GATAN 12                                                                      
-6312345    TESTSTAD                                                             
-2038952678900                        00000000001050022222333334444477           
-50TESTFÖRETAG ENHET 2.A                                                         
-6054321                               19999999999                               
-61TESTFÖRETAG                                                                   
-62TESTV 55                                                                      
-6312345    TESTSTAD                                                             
-2038952678888                        00000000002050022222333334444422           
-3038952345999                                                                   
-40FAKTNR=38952348888 OCH             FAKTNR=38952345999                         
-6098765555                            19999999999                               
-61TESTER AB                                                                     
-62VÄGEN 1                                                                       
-6388888    TESTORTEN                                                            
-90000000030000000000095443420111024001                                          
-99000000000000061                                                               
+00TI222222    2011102504133012345601TL1TOTALIN                                  
+1010181                               SEK20111024                               
+2038952344444                        00000000030255022222333334444451           
+3038952345678                        38952145778                                
+40FAKTURANR:38952344444              INTERN REF:  9780858                       
+40FAKTURANR:38952345678              38952145778ABC                             
+601234567                             19999999999                               
+61TESTBOLAGET AB                                                                
+62GATAN 12                                                                      
+6312345    TESTSTAD                                                             
+200000000000000000000000000          00000000042973522222333334444455           
+40TACK F�R L�NET                                                                
+50F�RETAGET AB FRISKV�RDAVD.                                                    
+6099999999                                                                      
+61F�RETAGET AB                                                                  
+62GATAN 7                                                                       
+6388888    TESTORTEN                                                            
+200000000000000000000000000          0000000002109002222233333444446734523455   
+40BETALNING F�R VARA 123                                                        
+50TESTFABRIKEN AB                                                               
+51GATAN 22                                                                      
+5211111    TESTVIKEN                                                            
+6098765433                            29999999999                               
+61NORDEA BANK AB                                                                
+6310571    STOCKHOLM                                                            
+200000000000000000000000000          00000000014836522222333334444472           
+601222211                             19999999999                               
+2038952345555                        00000000088000022222333334444423           
+40FAKT 38952345555,FAKTURANR                                                    
+602232567                             19999999999                               
+70000000000000000                     000000000100000EUR000000088000            
+25987654123                          00000000005255022222333334444457           
+40FAKTURA NR: 987654123 ABC          KUNDNR: 123                                
+40�TERBETALNING                                                                 
+601234567                             19999999999                               
+61TESTBOLAGET AB                                                                
+62GATAN 12                                                                      
+6312345    TESTSTAD                                                             
+90000000060000000000191900020111024001                                          
+109690017                             SEK20111024                               
+200000000000000000000000000          00000000092343411111222223333344           
+40BETALNING AVSEENDE K�P 110902                                                 
+601234567                             19999999999                               
+61TESTBOLAGET AB                                                                
+62GATAN 12                                                                      
+6312345    TESTSTAD                                                             
+2038952678900                        00000000001050022222333334444477           
+50TESTF�RETAG ENHET 2.A                                                         
+6054321                               19999999999                               
+61TESTF�RETAG                                                                   
+62TESTV 55                                                                      
+6312345    TESTSTAD                                                             
+2038952678888                        00000000002050022222333334444422           
+3038952345999                                                                   
+40FAKTNR=38952348888 OCH             FAKTNR=38952345999                         
+6098765555                            19999999999                               
+61TESTER AB                                                                     
+62V�GEN 1                                                                       
+6388888    TESTORTEN                                                            
+90000000030000000000095443420111024001                                          
+99000000000000061                                                               

data/spec/full_file_parse_spec.rb

@@ -3,7 +3,9 @@ require "total_in"
 RSpec.describe TotalIn do
   describe "parse" do
     before :all do
-      @document = TotalIn.parse File.read File.join(__dir__, "fixtures/total_in_full.txt")
+      File.open File.join(__dir__, "fixtures/total_in_full_latin_1.txt"), encoding: "iso-8859-1" do |file|
+        @document = TotalIn.parse file
+      end
     end
 
     let :document do
@@ -12,7 +14,7 @@ RSpec.describe TotalIn do
 
     it "find the document meta data" do
       expect(document.id).to eq "TI222222"
-      expect(document.created_at.strftime("%Y-%m-%d %H:%M:%S")).to eq "2011-10-25 12:34:56"
+      expect(document.created_at.strftime("%Y-%m-%d %H:%M:%S")).to eq "2011-10-25 04:13:30"
       expect(document.delivery_number).to eq 1
       expect(document.file_type).to eq "TL1"
       expect(document.name).to eq "TOTALIN"

data/spec/total_in/document_spec.rb

@@ -1,5 +1,21 @@
+require "total_in/document"
+
 module TotalIn
   RSpec.describe Document do
+    describe "#transaction_date" do
+      it "delegates to the first account date it finds" do
+        document = Document.new
+        document.accounts << Document::Account.new
+        document.accounts << Document::Account.new(date: "some date")
+
+        expect(document.transaction_date).to eq "some date"
+      end
+
+      it "returns nil if there are no account dates" do
+        expect(Document.new.transaction_date).to be nil
+      end
+    end
+
     describe "#payments" do
       it "returns payments from all accounts" do
         document = Document.new
@@ -33,7 +49,6 @@ module TotalIn
         document.accounts << account_two
 
         expect(document.deductions).to eq [deduction_one, deduction_two]
-
       end
     end
   end

data/spec/total_in/line_parsers/document_start_spec.rb

@@ -13,7 +13,7 @@ module TotalIn
 
       it "extracts the created at timestamp" do
         expect(document_start.created_at).to be_a Time
-        expect(document_start.created_at.strftime("%Y-%m-%d %H:%M:%S")).to eq "2011-10-25 12:34:56"
+        expect(document_start.created_at.strftime("%Y-%m-%d %H:%M:%S")).to eq "2011-10-25 04:13:30"
       end
 
       it "parses the deliver number" do

data/spec/total_in/parser_spec.rb

@@ -0,0 +1,22 @@
+require "total_in/parser"
+
+module TotalIn
+  RSpec.describe Parser do
+    describe "ensuring the file is valid" do
+      it "accepts a valid file" do
+        valid_file = "00TI222222    2011102504133012345601TL1TOTALIN                                  "
+        expect{ Parser.new(valid_file) }.to_not raise_error
+      end
+
+      it "should start with 00" do
+        invalid_file = "99TI222222    2011102504133012345601TL1TOTALIN                                  "
+        expect{ Parser.new(invalid_file) }.to raise_error{ TotalIn::InvalidFileFormatError }
+      end
+
+      it "expects the TL1 file type indicator" do
+        invalid_file = "00TI222222    2011102504133012345601TL2TOTALIN                                  "
+        expect{ Parser.new(invalid_file) }.to raise_error{ TotalIn::InvalidFileFormatError }
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: total_in
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Joel Junström
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
+date: 2015-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - lib/total_in/attribute_methods.rb
 - lib/total_in/contexts.rb
 - lib/total_in/document.rb
+- lib/total_in/file_format_validator.rb
 - lib/total_in/line_handlers.rb
 - lib/total_in/line_parser.rb
 - lib/total_in/line_parsers.rb
@@ -79,7 +80,7 @@ files:
 - lib/total_in/string_helpers.rb
 - lib/total_in/typecaster.rb
 - lib/total_in/version.rb
-- spec/fixtures/total_in_full.txt
+- spec/fixtures/total_in_full_latin_1.txt
 - spec/full_file_parse_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples_for_values_line_parsers.rb
@@ -110,6 +111,7 @@ files:
 - spec/total_in/line_processors/payment_start_spec.rb
 - spec/total_in/line_processors/reference_numbers_spec.rb
 - spec/total_in/line_processors/sender_account_spec.rb
+- spec/total_in/parser_spec.rb
 - spec/total_in_spec.rb
 - total-in.gemspec
 homepage: https://github.com/Oktavilla/total-in-ruby
@@ -137,7 +139,7 @@ signing_key:
 specification_version: 4
 summary: Parses Nordea Total-IN and Total-IN Basic files
 test_files:
-- spec/fixtures/total_in_full.txt
+- spec/fixtures/total_in_full_latin_1.txt
 - spec/full_file_parse_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples_for_values_line_parsers.rb
@@ -168,4 +170,5 @@ test_files:
 - spec/total_in/line_processors/payment_start_spec.rb
 - spec/total_in/line_processors/reference_numbers_spec.rb
 - spec/total_in/line_processors/sender_account_spec.rb
+- spec/total_in/parser_spec.rb
 - spec/total_in_spec.rb