bankgiro_inbetalningar 1.1.1 → 1.2.0

data/README.md

@@ -20,13 +20,14 @@ Or install it yourself as:
 
 ## Usage
 
-Use the convenience method `BankgiroInbetalningar.parse` to parse a file:
+Use the convenience method `BankgiroInbetalningar.parse_file` to parse a file
+or `BankgiroInbetalningar.parse_string` to parse a string:
 
 ```ruby
-res = BankgiroInbetalningar.parse('BgMaxfil4.txt')
+res = BankgiroInbetalningar.parse_file("BgMaxfil4.txt")
 # Or
-data = File.read("BgMaxfil4.txt")
-res = BankgiroInbetalningar.parse_data(data)
+data = File.read("BgMaxfil4.txt").force_encoding("ISO-8859-1")
+res = BankgiroInbetalningar.parse_string(data)
 
 raise "oops" unless res.valid?
 # You can process deposit by deposit...
@@ -44,8 +45,33 @@ res.payments.each do |p|
 end
 ```
 
-See the specs for more details.  Note that all text is in UTF-8, as it should be,
-and not in ISO-8859-1 as Bankgirot prefers.  It is the 21st century.
+You can also parse isolated deposits or payments which is useful if you store
+the raw data along with each deposit or payment in a database.  Note that the
+currency name only is available in the deposit:
+
+```ruby
+Dir.chdir 'spec/fixtures'
+payment_1 = BankgiroInbetalningar.parse_file("BgMaxfil4.txt").payments.first
+payment_2 = BankgiroInbetalningar.parse_string(payment_1.raw).payments.first
+payment_1.cents    # => 180000
+payment_2.cents    # => 180000
+payment_1.currency # => "SEK"
+payment_2.currency # => nil
+```
+
+The `raw` method is also available on deposit objects.
+See the specs for more details.
+
+Files are expected to be ISO-8859-1 (as Bankgirot prefers), but data strings
+can be in any encoding, as long as `String#encoding` is correct. The library
+returns UTF-8. It *is* the 21st century.
+
+## Changes in 1.2.0
+
+* Renamed `parse` and `parse_data` to `parse_file` and `parse_string`.  The old
+  method names are still available.
+* `parse_string` accepts a string in any encoding that can be converted to UTF-8.
+* Added `BankgiroInbetalningar::Result::Deposit#raw`.
 
 ## Todo / Missing features
 

data/lib/bankgiro_inbetalningar.rb

@@ -4,7 +4,7 @@ require "bankgiro_inbetalningar/parser"
 
 module BankgiroInbetalningar
   def self.parse(filename)
-    data = File.read(filename)
+    data = File.read(filename).force_encoding("ISO-8859-1")
     parse_data(data)
   end
 
@@ -13,4 +13,9 @@ module BankgiroInbetalningar
     parser.run
     parser.result
   end
+
+  class << self
+    alias parse_file parse
+    alias parse_string parse_data
+  end
 end

data/lib/bankgiro_inbetalningar/parser.rb

@@ -5,7 +5,7 @@ module BankgiroInbetalningar
     attr_accessor :result
 
     def initialize(data)
-      @raw_data ||= data.encode('utf-8', 'iso-8859-1')
+      @raw_data ||= data.encode("UTF-8")
     end
 
     def run
@@ -35,11 +35,18 @@ module BankgiroInbetalningar
     end
 
     def record_line
+      if result.deposit && deposit_line?
+        result.deposit.raw << @line
+      end
       if result.deposit && result.payment && payment_line?
         result.payment.raw << @line
       end
     end
 
+    def deposit_line?
+      payment_line? || %w(05 15).include?(@line[0..1])
+    end
+
     def payment_line?
       @line[0] == '2'
     end
@@ -202,7 +209,7 @@ module BankgiroInbetalningar
     end
 
     def new_payment
-      deposit.payments << Payment.new
+      (deposit || new_deposit).payments << Payment.new
       payment
     end
 
@@ -215,9 +222,10 @@ module BankgiroInbetalningar
     end
 
     class Deposit
-      attr_accessor :bgno, :currency, :payments, :date
+      attr_accessor :bgno, :currency, :payments, :date, :raw
       def initialize
         @payments = []
+        @raw = ""
       end
     end
 
@@ -225,7 +233,7 @@ module BankgiroInbetalningar
       attr_accessor :cents, :references, :currency, :raw, :payer, :sender_bgno, :text, :date, :number
       def initialize
         @references = []
-        @raw = "".force_encoding('iso-8859-1')
+        @raw = ""
       end
 
       def payer!

data/lib/bankgiro_inbetalningar/version.rb

@@ -1,3 +1,3 @@
 module BankgiroInbetalningar
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/spec/bankgiro_inbetalningar/parser_spec.rb

@@ -4,10 +4,18 @@ require_relative '../spec_helper'
 module BankgiroInbetalningar
   describe Parser do
     context "parsing sample file 4" do
-      let(:data) { File.read(fixture_path('BgMaxfil4.txt')) }
+      let(:data) { data_from_file('BgMaxfil4.txt') }
       let(:parser) { Parser.new(data) }
       let(:result) { parser.run ; parser.result }
 
+      context "with non Latin-1 data" do
+        let(:data) { data_from_file('BgMaxfil4.txt').encode("UTF-8") }
+
+        it "handles that fine" do
+          result.payments[1].payer.name.should include "Olles färg"
+        end
+      end
+
       it "returns valid results" do
         result.should be_valid
       end
@@ -25,7 +33,6 @@ module BankgiroInbetalningar
           payment.references.should == ['535765']
           payment.currency.should == 'SEK'
           payment.cents.should == 500_00
-          payment.raw.should == "200000000000                   535765000000000000050000230000000000230          \r\n"
         end
         it "has a date" do
           payment.date.should == Date.civil(2004,5,25)
@@ -33,6 +40,10 @@ module BankgiroInbetalningar
         it "has a number" do
           payment.number.should == "000000000023"
         end
+        it "stores the raw data" do
+          payment.raw.should == "200000000000                   535765000000000000050000230000000000230          \r\n"
+          result.deposits[3].raw.split(/\r\n/).should == data.encode('utf-8').split(/\r\n/)[50..65]
+        end
       end
 
       context "simple OCR payment with address" do
@@ -74,7 +85,7 @@ module BankgiroInbetalningar
 
     end
     context "parsing a broken sample file 4" do
-      let(:data) { File.read(fixture_path('BgMaxfil4_broken.txt')) }
+      let(:data) { data_from_file('BgMaxfil4_broken.txt') }
       let(:parser) { Parser.new(data) }
       let(:result) { parser.run ; parser.result }
 

data/spec/bankgiro_inbetalningar_spec.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require_relative 'spec_helper'
 
 describe BankgiroInbetalningar, ".parse" do
@@ -18,7 +19,7 @@ end
 
 describe BankgiroInbetalningar, ".parse_data" do
   context "parsing a minimal file" do
-    let(:data) { File.read(fixture_path('minimal.txt')) }
+    let(:data) { data_from_file('minimal.txt') }
     subject { BankgiroInbetalningar.parse_data(data) }
 
     it "finds the timestamp" do
@@ -31,4 +32,35 @@ describe BankgiroInbetalningar, ".parse_data" do
       subject.deposits.first.payments.count.should == 1
     end
   end
+
+  context "parsing a single deposit" do
+    let(:data) { data_from_file('isolated_deposit.txt') }
+    subject { BankgiroInbetalningar.parse_data(data) }
+
+    it "finds 1 deposit" do
+      subject.deposits.count.should == 1
+      subject.deposits.first.currency.should == 'EUR'
+    end
+    it "finds 2 payments" do
+      deposit = subject.deposits.first
+      deposit.payments.count.should == 2
+      deposit.payments[0].payer.name.should.should == 'Olles färg AB'
+      deposit.payments[1].payer.name.should.should == 'Berits Garn'
+    end
+  end
+
+  context "parsing a single payment" do
+    let(:data) { data_from_file('isolated_payment.txt') }
+    subject { BankgiroInbetalningar.parse_data(data) }
+
+    it "creates 1 deposit out of thin air" do
+      subject.deposits.count.should == 1
+      subject.deposits.first.currency.should be_nil
+    end
+    it "finds 1 payment" do
+      deposit = subject.deposits.first
+      deposit.payments.count.should == 1
+      deposit.payments[0].payer.name.should.should == 'Olles färg AB'
+    end
+  end
 end

data/spec/fixtures/isolated_deposit.txt

@@ -0,0 +1,16 @@
+050009912346          EUR                                                       
+2000970123338012577,8013575          000000000000300000320000000000180          
+220097012333                  8012577000000000000000000220000000000180          
+220097012333                  8013575000000000000000000220000000000180          
+220097012333                  8014573000000000000000000220000000000180          
+25 Faktura8014573                                                               
+26Olles f�rg AB                                                                 
+27Lillagatan 3                       12345                                      
+28Stor�ker                                                                      
+29005500001234                                                                  
+200001234567                   525766000000000000100000210000000000190          
+26Berits Garn                                                                   
+27Storgatan 10                       12345                                      
+28Stor�ker                                                                      
+29005500002222                                                                  
+15000000000000000000058410000010098232004052500059000000000000400000EUR00000002 

data/spec/fixtures/isolated_payment.txt

@@ -0,0 +1,5 @@
+200097012333                   524967000000000000190000210000000000190          
+26Olles f�rg AB                                                                 
+27Lillagatan 3                       12345                                      
+28Stor�ker                                                                      
+2900550000432                                                                   

data/spec/spec_helper.rb

@@ -1,6 +1,10 @@
 $: << File.expand_path('../../lib', __FILE__)
 require 'bankgiro_inbetalningar'
 
+def data_from_file(name)
+  File.read(fixture_path(name)).force_encoding("ISO-8859-1")
+end
+
 def fixture_path(name)
   File.expand_path("../fixtures/#{name}", __FILE__)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bankgiro_inbetalningar
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-29 00:00:00.000000000 Z
+date: 2012-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -51,6 +51,8 @@ files:
 - spec/bankgiro_inbetalningar_spec.rb
 - spec/fixtures/BgMaxfil4.txt
 - spec/fixtures/BgMaxfil4_broken.txt
+- spec/fixtures/isolated_deposit.txt
+- spec/fixtures/isolated_payment.txt
 - spec/fixtures/minimal.txt
 - spec/spec_helper.rb
 homepage: https://github.com/PugglePay/bankgiro_inbetalningar
@@ -84,5 +86,7 @@ test_files:
 - spec/bankgiro_inbetalningar_spec.rb
 - spec/fixtures/BgMaxfil4.txt
 - spec/fixtures/BgMaxfil4_broken.txt
+- spec/fixtures/isolated_deposit.txt
+- spec/fixtures/isolated_payment.txt
 - spec/fixtures/minimal.txt
 - spec/spec_helper.rb