ibanizator 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1f786044ace1c45ebe8559e727703ec36a536036
-  data.tar.gz: c261905ed2238ab14f5cdb59151f076ef3cc3cea
+SHA256:
+  metadata.gz: b015729f9d4eaf5a14f69b1d930930f9b41dc9672824081e4e4682b1f2c67918
+  data.tar.gz: 1a9670039e52ed73c62b758f3b7d383955ebf4f932f3e8c103167256874f86d3
 SHA512:
-  metadata.gz: 72d76071fa0986b87c3084d54206fd94140299b306d3ba5e4bad8998276e3bc038674fa4ea4b1bc007b66ee1c706f72ecae6489dfe0386fa32d08e62605ef682
-  data.tar.gz: daeff951441cf080b51c646c0cacd1e6bf7e59217815ec178f939d3d08170255e1e8906816fb3283053fb0e222147dacab4a15b984c035ede29eb50ce8d193ba
+  metadata.gz: a796a55437bd6811ac03243bbcf5e569753a980f0362b3de9845de9f76a6c44ce20f90bb1dcfe8405789856984a3fa4f1ed644ab3485e8b4195dc2faee4f0060
+  data.tar.gz: ab68994a1f0e1f95c4b0e7dca633b38a28c58e71e77d2406aae2646af25baca7f050cf3ad71d0989c7664f2bda211c35a00ef6002c3b5be3e921d7a273320792

data/lib/iban/validator.rb

@@ -1,13 +1,5 @@
 module Iban
   class Validator
-    # <b>DEPRECATED:</b> Please use <tt>Ibanizator.iban_from_string(an_iban).valid?</tt> instead.
-    def validate_iban(input)
-      warn "[DEPRECATION] `Iban#validate_iban` is deprecated.  Please use `Ibanizator.iban_from_string(an_iban).valid?instead."
-      iban = sanitize_input(input)
-
-      valid_length?(iban) && valid_checksum?(iban)
-    end
-
     # public because it's used in `Ibanizator.calculate_iban`
     def sanitize_input(input)
       input.to_s.chomp.gsub(/\s+/,"")

data/lib/ibanizator.rb

@@ -1,21 +1,21 @@
+# frozen_string_literal: true
+
 require_relative 'iban/validator'
-require_relative 'swift_bic/bank_db'
 
 require_relative 'ibanizator/bank_db'
 require_relative 'ibanizator/bank'
 require_relative 'ibanizator/iban'
 
 class Ibanizator
-
   def self.bank_db
     @bank_db ||= BankDb.new
   end
 
-  def self.iban_from_string(a_string)
-    Iban.from_string(a_string)
+  def self.iban_from_string(string)
+    Iban.from_string(string)
   end
 
-  def calculate_iban options
+  def calculate_iban(options)
     # Error handling
     # TODO
 
@@ -34,34 +34,14 @@ class Ibanizator
     options[:country_code].to_s.upcase + checksum + options[:bank_code] + options[:account_number]
   end
 
-  # <b>DEPRECATED:</b> Please use <tt>Ibanizator.iban_from_string(an_iban).valid?</tt> instead.
-  def validate_iban iban
-    warn "[DEPRECATION] `Ibanizator#validate_iban` is deprecated.  Please use `Ibanizator.iban_from_string(an_iban).valid?instead."
-    # for the sake of compatibility
-    self.class.iban_from_string(iban).valid?
-  end
-
-  # <b>DEPRECATED:</b> Please use <tt>Ibanizator.bank_db.bank_by_bank_code</tt> instead.
-  def bic bank_code
-    warn "[DEPRECATION] `Ibanizator#bank_name` is deprecated.  Please use `Ibanizator::bank_db.bank_by_bank_code` instead."
-    bank_db = SwiftBic::BankDb.new bank_code
-    bank_db.bic
-  end
-
-  # <b>DEPRECATED:</b> Please use <tt>Ibanizator.bank_db.bank_by_bank_code</tt> instead.
-  def bank_name bank_code
-    warn "[DEPRECATION] `Ibanizator#bank_name` is deprecated.  Please use `Ibanizator::bank_db.bank_by_bank_code` instead."
-    bank_db = SwiftBic::BankDb.new bank_code
-    bank_db.bank_name
-  end
-
-  def character_to_digit char
+  def character_to_digit(char)
     char.upcase.split('').inject('') { |code, c| code + (c.ord - 55).to_s }
   end
 
-  def calculate_checksum bank_code, account_number, country_code_num
+  def calculate_checksum(bank_code, account_number, country_code_num)
     x = (bank_code + account_number + country_code_num + '00').to_i % 97
     checksum = (98 - x).to_s
+
     checksum.length == 1 ? checksum.insert(0, '0') : checksum
   end
 end

data/lib/ibanizator/bank_db.rb

@@ -1,46 +1,70 @@
 class Ibanizator
   class BankDb
-    class BankNotFoundError < StandardError ; end
+    class BankNotFoundError < StandardError; end
 
-    attr_reader :known_banks
+    attr_reader :known_banks, :bank_code_index, :bic_index
 
     def initialize
       @known_banks = []
-      @bic_index, @bank_code_index = {}, {}
+      @bic_index = {}
+      @bank_code_index = {}
       populate_known_banks!
     end
 
-    def bank_by_bic(a_bic)
-      @bic_index.fetch(a_bic.to_s) do
-        error! "No bank for bic: #{a_bic} found"
+    def bank_by_bic(bic)
+      @bic_index.fetch(bic.to_s) do
+        error!("No bank for bic: #{bic} found")
       end
     end
 
-    def bank_by_bank_code(a_bank_code)
-      @bank_code_index.fetch(sanitize_bank_code(a_bank_code)) do
-        error! "No bank for bank_code: #{a_bank_code} found"
+    def bank_by_bank_code(bank_code)
+      @bank_code_index.fetch(sanitize_bank_code(bank_code)) do
+        error!("No bank for bank_code: #{bank_code} found")
       end
     end
 
     private
+
     def populate_known_banks!
-      File.open(File.expand_path("../../../db/blz.txt", __FILE__), 'r').each_line do |line|
+      file = File.expand_path('../../db/blz.txt', __dir__)
+
+      File.open(file, 'r').each_line do |line|
         code, _, _, _, _, name, _, bic = line.unpack 'A8A1A58A5A35A27A5A11'
         next if bic.empty?
+
         name.force_encoding('iso-8859-1').encode!('utf-8')
         bank = Bank.new(bic, name, code)
-        @known_banks << bank
-        @bic_index[bank.bic] = bank
-        @bank_code_index[bank.bank_code] = bank
+
+        add_bank_to_indices(bank)
       end
     end
 
-    def sanitize_bank_code(a_bank_code)
-      a_bank_code.to_s.gsub(/\s+/, '')
+    def sanitize_bank_code(bank_code)
+      bank_code.to_s.gsub(/\s+/, '')
     end
 
     def error!(message)
       raise BankNotFoundError, message
     end
+
+    def add_bank_to_indices(bank)
+      @known_banks << bank
+
+      @bic_index[bank.bic] = bank
+      if optional_branch_code?(bank.bic)
+        @bic_index[bank.bic.gsub(/XXX$/, '')] = bank
+      end
+
+      return if bank_exists_and_not_favored?(bank.bank_code, bank.bic)
+      @bank_code_index[bank.bank_code] = bank
+    end
+
+    def optional_branch_code?(bic)
+      bic.end_with?('XXX')
+    end
+
+    def bank_exists_and_not_favored?(bank_code, bic)
+      @bank_code_index.key?(bank_code) && !optional_branch_code?(bic)
+    end
   end
 end

data/lib/ibanizator/iban.rb

@@ -38,6 +38,10 @@ class Ibanizator
       Validator.new(self).validate
     end
 
+    def formatted_iban_string
+      iban_string.scan(/.{1,4}/).join(' ')
+    end
+
     private
     def sanitize(input)
       input.to_s.gsub(/\s+/,'').upcase

data/lib/ibanizator/iban/extended_data/de.rb

@@ -22,9 +22,29 @@ class Ibanizator
         memoize :account_number
 
         def bic
-          Ibanizator.bank_db.bank_by_bank_code(bank_code).bic
+          bank.bic
         end
-        memoize :bic
+
+        def bank_name
+          bank.name
+        end
+
+        def to_hash
+          {
+            bank_code: bank_code,
+            account_number: account_number,
+            bic: bic,
+            bank_name: bank_name,
+          }
+        end
+        alias_method :to_h, :to_hash
+
+        private
+
+        def bank
+          Ibanizator.bank_db.bank_by_bank_code(bank_code)
+        end
+        memoize :bank
       end
     end # ExtendedData
   end # Iban

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ibanizator
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
-- Christoph Stettner
+- Julien Gantner
+- David Seeherr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-19 00:00:00.000000000 Z
+date: 2018-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adamantium
@@ -42,30 +43,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +85,7 @@ description: |2
       ibanizator generates the correct IBAN for given account number and bank number
       for german accounts. It is possible to validate given international IBANS.
       Calculates also the BIC and bank names for given german bank codes.
-email: christoph.stettner@softwareinmotion.de
+email: julien.gantner@softwareinmotion.de
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -103,7 +104,6 @@ files:
 - lib/ibanizator/iban/invalid.rb
 - lib/ibanizator/iban/lengths.rb
 - lib/ibanizator/iban/validator.rb
-- lib/swift_bic/bank_db.rb
 - license.md
 homepage: https://github.com/softwareinmotion/ibanizator
 licenses:
@@ -117,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: An IBAN generator/validator and BIC generator for german accounts.

data/lib/swift_bic/bank_db.rb

@@ -1,40 +0,0 @@
-require_relative '../errors/invalid_bank_code_error'
-require_relative '../errors/bank_not_found_error'
-
-module SwiftBic
-  class BankDb
-
-    BANKS = {}.tap do |banks|
-      File.open(File.expand_path("../../../db/blz.txt", __FILE__), 'r').each_line do |line|
-        code, _, _, _, _, name, _, bic = line.unpack 'A8A1A58A5A35A27A5A11'
-        next if bic.empty?
-        name.force_encoding('iso-8859-1').encode!('utf-8')
-        banks[code] = [name, bic]
-      end
-    end
-
-    # <b>DEPRECATED:</b> Please use <tt>Ibanizator.bank_db</tt> instead.
-    def initialize bank_code
-      warn "[DEPRECATION] `SwiftBic::BankDb` is deprecated.  Please use `Ibanizator::bank_db` instead."
-      validate_bank_code bank_code
-      @bank_data = BANKS[bank_code]
-      raise BankNotFoundError unless @bank_data
-    end
-
-    def bank_name
-      @bank_data[0]
-    end
-
-    def bic
-      @bank_data[1]
-    end
-
-    def validate_bank_code bank_code
-      if bank_code.length == 8
-        return true
-      else
-        raise InvalidBankCodeError
-      end
-    end
-  end
-end