sepa_clearer 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ab7c92f7cf252703f2f0ab62a13f89d317a2801
-  data.tar.gz: 0b7158c517ba56c29c28a8a801b44a0adba5198e
+  metadata.gz: cbd32af62350c9dfef2b8ff7cd7a694d1619716b
+  data.tar.gz: 5e93b7e97b94e34c3c45e7ae66b250e860676f29
 SHA512:
-  metadata.gz: 33a42b42f3cb089a71e71cc594c9fe52ca135e0225454233d9594bbbceee3cbb80d95a8945b7b24e07dac4a90f0e7e313fa44dd955c90da774460aaf1b1c11ee
-  data.tar.gz: 1f07d8f9ed72c4f41a07efb28c275ad5e1c690245248b39f5a2287dbefdb7b807fced7225ca5f6419d6af1b921853a720bcbdb29aef943a2ee697c2b6f2abea1
+  metadata.gz: bd98140704cdd382443eaec4db7c95003b1ed393a12a137eff2eae2ea377be2fbe05de044af4b50da20750da36a75969b6e1b4bd22342849202490ff719a0fd4
+  data.tar.gz: 0dc263db105322307eeac665494ad5ebab9ca8a20b8e3fd105122f626d63833eefcc77e9c1102e292cce4caffcc5fcdc7c96d517e69714973ef6c202a4a82b3e

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+v0.1.0
+------
+
+* Replace in-memory datastore with sqlite3 based one. The class api should be
+  the same.
+
+
 v0.0.2
 ------
 

data/README.md

@@ -5,15 +5,16 @@ system. The gem currently supports only "Deutsche Bundesbank" as a clearer. You
 can fetch all providers and their capabilities or fetch only a unique provider
 by his BIC.
 
-Currently the gem fetches all data into memory which can be quite heavy. You
-might want to store it in your local database for quick and easy access.
+The gem comes with a sqlite3 database which contains all data. In order to access
+it, you need to have sqlite3 installed.
 
+__Last data update: 2014-07-07__
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'sepa-clearer'
+    gem 'sepa_clearer'
 
 And then execute:
 
@@ -21,21 +22,26 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install sepa-clearer
+    $ gem install sepa_clearer
 
 
 ## Usage
+    require 'sepa_clearer'
 
     # Create a new cleaer instance
-    clearer = SepaClearer::Clearer.new('DeutscheBundesbank')
+    clearer = SepaClearer::Clearer.new
 
     # Fetch all payment providers
     clearer.all
     # => [<PaymentProvider: …>, <PaymentProvider: …>]
 
     # Fetch a single provider by his identifier code. The BIC is normalized (uppercase and 11 letters filled with X)
-    clearer.find_by_bic('DEIRGENDWAS')
-    # => <PaymentProvider: @bic="DEIRGENDWAS", @name="Your Provider", @supports=[:core, :cor1]>
+    provider = clearer.find_by_bic('DEIRGENDWAS')
+    # => <PaymentProvider: @bic="DEIRGENDWAS", @name="YOUR PROVIDER", @sct=false, @core=true, @cor1=true, @b2b=false>
+
+    # Get all capabilities
+    provider.capabilities
+    # => [:core, :cor1]
 
 
 ## Update clearer list

data/lib/sepa_clearer/clearer.rb

@@ -1,20 +1,62 @@
+require 'sqlite3'
+
 module SepaClearer
   class Clearer
-    def initialize(clearer = 'DeutscheBundesbank')
-      @klass = SepaClearer.const_get(clearer).new
+    attr_accessor :db
+
+    # Make sure we always have the correct order of columns
+    ATTRIBUTES = [:name, :bic, :sct, :core, :cor1, :b2b]
+
+    def initialize(db_name = 'deutsche_bundesbank')
+      self.db = SQLite3::Database.new File.join(File.dirname(__FILE__), '../..', "data/#{db_name}.db")
+    end
+
+    def add(provider)
+      data = boolean_to_integers(provider.to_a)
+      db.execute "INSERT INTO payment_providers (#{ATTRIBUTES.join(',')}) VALUES (?, ?, ?, ?, ?, ?)", data
     end
 
     def all
-      @klass.data
+      db.execute("SELECT #{ATTRIBUTES.join(',')} FROM payment_providers ORDER BY name").map do |row|
+        PaymentProvider.new(hash_from_result(row))
+      end
     end
 
     def find_by_bic(bic)
-      normalized_bic = normalize_bic(bic)
-      @klass.data.find { |provider| provider.bic == normalized_bic }
+      db.execute("SELECT #{ATTRIBUTES.join(',')} FROM payment_providers WHERE bic = ?", normalize_bic(bic)).map do |row|
+        PaymentProvider.new(hash_from_result(row))
+      end.first
     end
 
     def normalize_bic(bic)
       bic.to_s.ljust(11, 'X').upcase
     end
+
+    protected
+
+    def hash_from_result(raw_array)
+      raw_array_with_boolean = integers_to_boolean(raw_array)
+      Hash[ATTRIBUTES.zip(raw_array_with_boolean)]
+    end
+
+    def boolean_to_integers(array)
+      array.map do |element|
+        if element.kind_of?(TrueClass) || element.kind_of?(FalseClass)
+          element ? 1 : 0
+        else
+          element
+        end
+      end
+    end
+
+    def integers_to_boolean(array)
+      array.map do |element|
+        if element.kind_of?(Integer)
+          element == 1
+        else
+          element
+        end
+      end
+    end
   end
 end

data/lib/sepa_clearer/deutsche_bundesbank.rb

@@ -2,12 +2,12 @@ require 'csv'
 
 module SepaClearer
   class DeutscheBundesbank
-    CAPABILITIES_MAPPING = {
-                        service_sct: :sct,
-                        service_sdd: :core,
-                        service_cor1: :cor1,
-                        service_b2b: :b2b
-                      }
+    MAPPING = {
+                              service_sct: :sct,
+                              service_sdd: :core,
+                              service_cor1: :cor1,
+                              service_b2b: :b2b
+                            }
 
     def data(file = nil)
       @data ||= begin
@@ -20,11 +20,10 @@ module SepaClearer
     end
 
     def parse_raw_data(data)
-      [
-        data[:name].strip.chomp,
-        data[:bic],
-        CAPABILITIES_MAPPING.map { |key, service| data[key] == '1' ? service : nil }.compact
-      ]
+      MAPPING.reduce({}) { |hsh,(key, service)| hsh[service] = (data[key] == '1'); hsh }.merge({
+        name: data[:name].strip.chomp,
+        bic: data[:bic].strip.chomp,
+      })
     end
 
     def default_data_file

data/lib/sepa_clearer/payment_provider.rb

@@ -2,12 +2,30 @@ module SepaClearer
   class PaymentProvider
     SERVICES = [:sct, :core, :cor1, :b2b]
 
-    attr_accessor :name, :bic, :capabilities
+    attr_accessor :name, :bic, :sct, :core, :cor1, :b2b
 
-    def initialize(name, bic, capabilities)
-      self.name = name
-      self.bic = bic
-      self.capabilities = capabilities
+    def initialize(options = {})
+      self.name = options[:name]
+      self.bic = options[:bic]
+      self.sct = options[:sct] || false
+      self.core = options[:core] || false
+      self.cor1 = options[:cor1] || false
+      self.b2b = options[:b2b] || false
+    end
+
+    def capabilities
+      SERVICES.map { |s| [s, send(s)] }.select { |_,v| v }.map { |k,v| k }
+    end
+
+    def to_hash
+      {
+        name: name,
+        bic: bic,
+        sct: sct,
+        core: core,
+        cor1: cor1,
+        b2b: b2b,
+      }
     end
   end
 end

data/lib/sepa_clearer/version.rb

@@ -1,3 +1,3 @@
 module SepaClearer
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/sepa-clearer.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "sqlite3"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 0"
   spec.add_development_dependency "rspec", "~> 3"

data/spec/clearer_spec.rb

@@ -16,11 +16,15 @@ describe SepaClearer::Clearer do
       expect(subject.find_by_bic('MYTHINGY')).to eq(nil)
     end
 
-    it 'normalizes thebic before searching' do
+    it 'normalizes the bic before searching' do
       allow(subject).to receive(:normalize_bic).and_return('AAA')
       expect(subject.find_by_bic('MYTHINGY')).to eq(nil)
       expect(subject).to have_received(:normalize_bic)
     end
+
+    it 'returns an initialize object' do
+      expect(subject.find_by_bic('AABAFI22TMS').name).to eq('BANK OF ALAND PLC')
+    end
   end
 
   describe '#normalize_bic' do

data/spec/deutsche_bundesbank_spec.rb

@@ -3,20 +3,24 @@ require 'spec_helper'
 describe SepaClearer::DeutscheBundesbank do
   describe '#parse_raw_data' do
     let(:data) { { name: "My Org \n", bic: 'QWERTZ12345', service_sct: '1' } }
-    it 'returns an array' do
-      expect(subject.parse_raw_data(data)).to eq(['My Org', 'QWERTZ12345', [:sct]])
+
+    it 'returns a hash' do
+      expect(subject.parse_raw_data(data)).to be_kind_of(Hash)
     end
 
     it 'cleans up the name' do
-      expect(subject.parse_raw_data(data)[0]).to eq('My Org')
+      expect(subject.parse_raw_data(data)[:name]).to eq('My Org')
     end
 
     it 'returns the BIC' do
-      expect(subject.parse_raw_data(data)[1]).to eq('QWERTZ12345')
+      expect(subject.parse_raw_data(data)[:bic]).to eq('QWERTZ12345')
     end
 
     it 'maps the capabilities' do
-      expect(subject.parse_raw_data(data)[2]).to eq([:sct])
+      expect(subject.parse_raw_data(data)[:sct]).to eq(true)
+      expect(subject.parse_raw_data(data)[:core]).to eq(false)
+      expect(subject.parse_raw_data(data)[:cor1]).to eq(false)
+      expect(subject.parse_raw_data(data)[:b2b]).to eq(false)
     end
   end
 end

data/spec/payment_provider_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe SepaClearer::PaymentProvider do
   describe '.new' do
-    subject(:provider) { described_class.new('Testorg', 'SOMEVALIDID', [:core]) }
+    subject(:provider) { described_class.new(name: 'Testorg', bic: 'SOMEVALIDID') }
 
     it 'sets the proper name' do
       expect(provider.name).to eq('Testorg')
@@ -12,8 +12,35 @@ describe SepaClearer::PaymentProvider do
       expect(provider.bic).to eq('SOMEVALIDID')
     end
 
-    it 'sets the proper capabilities' do
-      expect(provider.capabilities).to eq([:core])
+    it 'does not set any capabilities' do
+      expect(provider.capabilities).to eq([])
+    end
+  end
+
+  describe '#capabilities' do
+    subject(:provider) { described_class.new(sct: true, core: false, cor1: true, b2b: true) }
+
+    it 'returns all capabilities' do
+      expect(provider.capabilities).to eq([:sct, :cor1, :b2b])
+    end
+  end
+
+  describe '#to_hash' do
+    subject(:provider) { described_class.new(name: 'test', bic: 'bic', sct: true, core: false, cor1: true, b2b: true) }
+
+    it 'returns a hash' do
+      expect(provider.to_hash).to be_kind_of(Hash)
+    end
+
+    it 'sets correct values' do
+      expect(provider.to_hash).to match({
+        name: 'test',
+        bic: 'bic',
+        sct: true,
+        core: false,
+        cor1: true,
+        b2b: true
+      })
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sepa_clearer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Maximilian Schulz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-07-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +83,7 @@ files:
 - Rakefile
 - bin/update_data
 - data/deutsche_bundesbank.csv
+- data/deutsche_bundesbank.db
 - lib/sepa_clearer.rb
 - lib/sepa_clearer/clearer.rb
 - lib/sepa_clearer/deutsche_bundesbank.rb