iban_calculator 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19c90f0379c87c7251c554191b6ee1ca82f7e7c5
-  data.tar.gz: 1906317a98ebfa25ec45d4bdff1a0c3d01448ab0
+  metadata.gz: 3967a9c57971d2941311ac3669ab2b440f1e4aed
+  data.tar.gz: e639752002e485025b6255f9592a62b9900ee763
 SHA512:
-  metadata.gz: 2210281de1e0c117cf9881d0f0adea74b8f37271a48032dc5a735a9068fdc3e49e69a990ec8bf650f893eb25c865373582a4c5d5746050f4d99f261ee4b0372a
-  data.tar.gz: 4d69c1cef82b442417c2a2096a408eb394f5d1ad8673cdef9c047a245625b8a2e2271e8a2d36200ea583460a15809d0cc8e6db7ef753c4f09b7692f9b2028035
+  metadata.gz: 57c403612b7adb97f2240c89411186d186c35c30f7c027580b06be44fd42b19ee394a2dbbb8157556f5e31986a6be9f8018c8a14b90941698316290fe4df931f
+  data.tar.gz: 6ab47c60821c888040d2989a2c22817cf23a22dd4a6731a9cfbe9440961b95f8baec156824b374e5607751ab3f438ae20f49b394bb0b4d6e73fef3aa9fe392c7

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+0.0.2
+-----
+
+* Add support for validating IBANs and fetching related data such as legacy data
+
+0.0.1
+-----
+
+* Initial release with support for calculating IBANs based on legacy data

data/README.md

@@ -34,6 +34,10 @@ Whenever you need to convert European legacy account data to new SEPA IBAN forma
 
 Example data can be found at: http://www.iban-bic.com/sample_accounts.html
 
+You can also validate a given IBAN and fetch additional data about it:
+
+    IbanCalculator.validate_iban 'AL90208110080000001039531801'
+
 
 ## Contributing
 

data/lib/iban_calculator.rb

@@ -2,21 +2,34 @@ require 'iban_calculator/version'
 require 'active_support/configurable'
 require 'active_support/core_ext/hash'
 require 'logger'
+
+require 'iban_calculator/bank'
+require 'iban_calculator/bic_candidate'
 require 'iban_calculator/iban_bic'
+require 'iban_calculator/iban_validator_response'
 require 'iban_calculator/invalid_data'
 
 module IbanCalculator
+  # Extensions
   include ActiveSupport::Configurable
 
+  # Configuration
   config_accessor(:url) { 'https://ssl.ibanrechner.de/soap/?wsdl' }
   config_accessor(:user) { '' }
   config_accessor(:password) { '' }
   config_accessor(:logger) { Logger.new(STDOUT) }
 
+  # Errors
   ServiceError = Class.new(StandardError)
 
   def self.calculate_iban(attributes = {})
     client = IbanBic.new(config.user, config.password, config.url, config.logger)
     client.calculate_iban(attributes)
   end
+
+  def self.validate_iban(iban)
+    client = Savon.client(wsdl: config.url, logger: config.logger)
+    response = client.call(:validate_iban, message: { iban: iban, user: config.user, password: config.password })
+    IbanValidatorResponse.new(response.body[:validate_iban_response][:return])
+  end
 end

data/lib/iban_calculator/bank.rb

@@ -0,0 +1,27 @@
+module IbanCalculator
+  class Bank
+    attr_accessor :code, :name, :country, :address, :url, :branch, :branch_code
+
+    def initialize(attributes = {})
+      self.code = attributes[:code]
+      self.name = attributes[:name]
+      self.country = attributes[:country]
+      self.address = attributes[:address]
+      self.url = attributes[:url]
+      self.branch = attributes[:branch]
+      self.branch_code = attributes[:branch_code]
+    end
+
+    def as_json(opts = {})
+      {
+        code: code,
+        name: name,
+        country: country,
+        address: address,
+        url: url,
+        branch: branch,
+        branch_code: branch_code,
+      }
+    end
+  end
+end

data/lib/iban_calculator/bic_candidate.rb

@@ -0,0 +1,37 @@
+module IbanCalculator
+  class BicCandidate
+    attr_accessor :bic, :city, :sample_url, :www_count, :zip
+
+    def self.build_list(raw_response)
+      Array.wrap(raw_response[:item]).map { |candidate| new(candidate) }
+    end
+
+    def initialize(raw_attributes = {})
+      self.bic = raw_attributes[:bic]
+      self.zip = string_or_default(raw_attributes[:zip])
+      self.city = string_or_default(raw_attributes[:city])
+      self.sample_url = string_or_default(raw_attributes[:sampleurl])
+      self.www_count = raw_attributes[:wwwcount].to_i
+    end
+
+    def source
+      www_count > 0 ? :www : :directory
+    end
+
+    def as_json(opts = {})
+      {
+        bic: bic,
+        zip: zip,
+        city: city,
+        sample_url: sample_url,
+        www_count: www_count,
+      }
+    end
+
+    private
+
+    def string_or_default(input, default = '')
+      input.kind_of?(String) ? input : default
+    end
+  end
+end

data/lib/iban_calculator/iban_validator_response.rb

@@ -0,0 +1,75 @@
+module IbanCalculator
+  class IbanValidatorResponse
+    CHECKS = {
+      length: :length_check,
+      account_number: :account_check,
+      bank_code: :bank_code_check,
+      iban_checksum: :iban_checksum_check,
+    }
+
+    attr_accessor :raw_response
+
+    def initialize(raw_response)
+      self.raw_response = raw_response
+    end
+
+    def valid?
+      return_code < 128
+    end
+
+    def return_code
+      @return_code ||= raw_response[:return_code].to_i
+    end
+
+    def bic_candidates
+      @bic_candidates ||= BicCandidate.build_list(raw_response[:bic_candidates])
+    end
+
+    def bank
+      @bank ||= begin Bank.new({
+          code: string_or_default(raw_response[:bank_code]),
+          name: string_or_default(raw_response[:bank]),
+          country: string_or_default(raw_response[:country]),
+          address: string_or_default(raw_response[:bank_address]).strip,
+          url: string_or_default(raw_response[:bank_url]),
+          branch: string_or_default(raw_response[:branch]),
+          branch_code: string_or_default(raw_response[:branch_code]),
+        })
+      end
+    end
+
+    def account_number
+      @account_number ||= raw_response[:account_number]
+    end
+
+    def checks
+      CHECKS.each_with_object({}) do |(app_key, api_key), result|
+        result[app_key] = string_or_default(raw_response[api_key], 'not_checked')
+      end
+    end
+
+    def updated_at
+      @data_created_at ||= Date.parse(raw_response[:data_age])
+    end
+
+    def errors
+      @errors ||= InvalidData.new('', return_code).errors
+    end
+
+    def as_json(opts = {})
+      {
+        account_number: account_number,
+        bank: bank.as_json(opts),
+        bic_candidates: bic_candidates.map { |c| c.as_json(opts) },
+        updated_at: updated_at,
+        checks: checks,
+      }
+    end
+
+    private
+
+    def string_or_default(input, default = '')
+      input.kind_of?(String) ? input : default
+    end
+  end
+end

data/lib/iban_calculator/version.rb

@@ -1,3 +1,3 @@
 module IbanCalculator
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/bic_candidate_spec.rb

@@ -0,0 +1,105 @@
+RSpec.describe IbanCalculator::BicCandidate do
+
+  subject { described_class.new(single_candidate[:item]) }
+
+  describe '.build_list' do
+    it 'returns an array if one item is added' do
+      expect(described_class.build_list(single_candidate).size).to eq(1)
+    end
+
+    it 'returns an array of multiple items' do
+      expect(described_class.build_list(multiple_candidates).size).to eq(2)
+    end
+
+    it 'returns BicCandiate objects' do
+      expect(described_class.build_list(single_candidate).first).to be_kind_of(described_class)
+    end
+  end
+
+  describe '.new' do
+    it 'assigns its bic' do
+      expect(subject.bic).to eq('BOFIIE2D')
+    end
+
+    it 'assigns its city' do
+      expect(subject.city).to eq('city')
+    end
+
+    it 'assigns its zip' do
+      expect(subject.zip).to eq('zip')
+    end
+
+    it 'assigns its www_count' do
+      expect(subject.www_count).to eq(0)
+    end
+
+    it 'assigns its sample_url' do
+      expect(subject.sample_url).to eq('sample_url')
+    end
+  end
+
+  describe '#source' do
+    it 'returns directory if document has no www count' do
+      subject.www_count = 0
+      expect(subject.source).to eq(:directory)
+    end
+
+    it 'returns www if document has www count' do
+      subject.www_count = 1
+      expect(subject.source).to eq(:www)
+    end
+  end
+
+  describe '#as_json' do
+    it 'takes a hash as argument to be compatible with rails' do
+      expect{ subject.as_json({}) }.to_not raise_error
+    end
+
+    it 'returns all attributes' do
+      expect(subject.as_json).to eq({
+        bic: 'BOFIIE2D',
+        zip: 'zip',
+        city: 'city',
+        sample_url: 'sample_url',
+        www_count: 0
+      })
+    end
+  end
+
+  def single_candidate
+    {
+      :item => {
+        :bic => 'BOFIIE2D',
+        :zip => 'zip',
+        :city => 'city',
+        :wwwcount => '0',
+        :sampleurl => 'sample_url',
+        :'@xsi:type' => 'tns:BICStruct'
+      },
+      :'@xsi:type' => 'SOAP-ENC:Array',
+      :'@soap_enc:array_type' => 'tns:BICStruct[1]'
+    }
+  end
+
+  def multiple_candidates
+    {
+      :item => [{
+        :bic => 'BOFIIE2D',
+        :zip => 'zip',
+        :city => 'city',
+        :wwwcount => '0',
+        :sampleurl => 'sample_url',
+        :'@xsi:type' => 'tns:BICStruct'
+      }, {
+        :bic => 'BOFIIE2D',
+        :zip => 'zip',
+        :city => 'city',
+        :wwwcount => '0',
+        :sampleurl => 'sample_url',
+        :'@xsi:type' => 'tns:BICStruct'
+      }],
+      :'@xsi:type' => 'SOAP-ENC:Array',
+      :'@soap_enc:array_type' => 'tns:BICStruct[1]'
+    }
+  end
+end

data/spec/iban_validator_response_spec.rb

@@ -0,0 +1,208 @@
+RSpec.describe IbanCalculator::IbanValidatorResponse do
+
+  let(:valid) { described_class.new(valid_response) }
+  let(:invalid) { described_class.new(invalid_response) }
+
+  describe '#valid?' do
+    it 'returns true if response is valid' do
+      expect(valid.valid?).to eq(true)
+    end
+
+    it 'returns false if response is not valid' do
+      expect(invalid.valid?).to eq(false)
+    end
+  end
+
+  describe '#return_code' do
+    it 'returns its code' do
+      expect(valid.return_code).to eq(0)
+    end
+  end
+
+  describe '#bic_candidates' do
+    it 'returns an array' do
+      expect(valid.bic_candidates).to be_instance_of(Array)
+    end
+  end
+
+  describe '#bank' do
+    it 'returns a bank hash' do
+      expect(valid.bank).to be_instance_of(IbanCalculator::Bank)
+    end
+
+    it 'returns bank name' do
+      expect(valid.bank.name).to eq('Bank of Ireland')
+    end
+
+    it 'returns bank address' do
+      expect(valid.bank.address).to eq('Dublin 2')
+    end
+
+    it 'returns bank code' do
+      expect(valid.bank.code).to eq('90-00-17')
+    end
+
+    it 'returns bank country' do
+      expect(valid.bank.country).to eq('IE')
+    end
+
+    it 'returns bank url' do
+      expect(valid.bank.url).to eq('')
+    end
+
+    it 'returns bank branch' do
+      expect(valid.bank.branch).to eq('')
+    end
+
+    it 'returns bank branch_code' do
+      expect(valid.bank.branch_code).to eq('')
+    end
+  end
+
+  describe '#account_number' do
+    it 'returns its account number' do
+      expect(valid.account_number).to eq('10027952')
+    end
+  end
+
+  describe '#checks' do
+    context 'valid response' do
+      it 'returns a hash of checks and their results' do
+        expect(valid.checks).to eq({
+          length: 'passed',
+          bank_code: 'passed',
+          account_number: 'passed',
+          iban_checksum: 'passed',
+        })
+      end
+    end
+
+    context 'invalid response' do
+      it 'returns a hash of checks and their results' do
+        expect(invalid.checks).to eq({
+          length: 'failed',
+          bank_code: 'not_checked',
+          account_number: 'not_checked',
+          iban_checksum: 'not_checked',
+        })
+      end
+    end
+  end
+
+  describe '#updated_at' do
+    it 'returns a proper date object' do
+      expect(valid.updated_at).to eq(Date.new(2014, 07, 06))
+    end
+  end
+
+  describe '#errors' do
+    context 'valid response' do
+      it 'returns an empty array' do
+        expect(valid.errors).to eq({})
+      end
+    end
+
+    context 'invalid response' do
+      it 'returns an empty array' do
+        expect(invalid.errors).to eq({ account_number: [:invalid_length] })
+      end
+    end
+  end
+
+  describe '#as_json' do
+    it 'returns an hash with all attributes' do
+      expect(valid.as_json).to eq({
+        account_number: '10027952',
+        bank: { code: '90-00-17', name: 'Bank of Ireland', country: 'IE', address: 'Dublin 2', url: '', branch: '', branch_code: '' },
+        bic_candidates: [{ bic: 'BOFIIE2D', zip: '', city: '', sample_url: '', www_count: 0 }],
+        checks: { length: 'passed', account_number: 'passed', bank_code: 'passed', iban_checksum: 'passed' },
+        updated_at: Date.new(2014, 7, 6)
+      })
+    end
+  end
+
+  def valid_response
+    {
+      :iban=>"IE92BOFI90001710027952",
+      :result=>"passed",
+      :return_code=>"0",
+      :checks=>{
+        :item=>["length", "bank_code", "account_number", "iban_checksum"],
+        :"@xsi:type"=>"SOAP-ENC:Array",
+        :"@soap_enc:array_type"=>"xsd:string[4]"},
+      :bic_candidates=>{
+        :item=>{
+          :bic=>"BOFIIE2D",
+          :zip=>{:"@xsi:type"=>"xsd:string"},
+          :city=>{:"@xsi:type"=>"xsd:string"},
+          :wwwcount=>"0",
+          :sampleurl=>{:"@xsi:type"=>"xsd:string"},
+          :"@xsi:type"=>"tns:BICStruct"},
+        :"@xsi:type"=>"SOAP-ENC:Array",
+        :"@soap_enc:array_type"=>"tns:BICStruct[1]"},
+      :country=>"IE",
+      :bank_code=>"90-00-17",
+      :bank=>"Bank of Ireland",
+      :bank_address=>"Dublin 2 ",
+      :bank_url=>{:"@xsi:type"=>"xsd:string"},
+      :branch=>{:"@xsi:type"=>"xsd:string"},
+      :branch_code=>{:"@xsi:type"=>"xsd:string"},
+      :in_scl_directory=>"no",
+      :sct=>{:"@xsi:type"=>"xsd:string"},
+      :sdd=>{:"@xsi:type"=>"xsd:string"},
+      :b2b=>{:"@xsi:type"=>"xsd:string"},
+      :account_number=>"10027952",
+      :account_validation_method=>{:"@xsi:type"=>"xsd:string"},
+      :account_validation=>{:"@xsi:type"=>"xsd:string"},
+      :length_check=>"passed",
+      :account_check=>"passed",
+      :bank_code_check=>"passed",
+      :iban_checksum_check=>"passed",
+      :data_age=>"20140706",
+      :iba_nformat=>"IEkk AAAA BBBB BBCC CCCC CC",
+      :formatcomment=>"The first 4 alphanumeric characters are the start of the SWIFT code. Then a 6 digit long routing code and an 8 digit account code follow, both numeric.",
+      :balance=>"1",
+      :"@xsi:type"=>"tns:IBANValResStruct"
+    }
+  end
+
+  def invalid_response
+    {
+      :iban => "IE92BOFI900017100",
+      :result => "failed",
+      :return_code => "512",
+      :checks => {
+        :item => "length",
+        :"@xsi:type" => "SOAP-ENC:Array",
+        :"@soap_enc:array_type" => "xsd:string[1]"
+      },
+      :bic_candidates => {
+        :"@xsi:type" => "SOAP-ENC:Array",
+        :"@soap_enc:array_type" => "tns:BICStruct[0]"
+      },
+      :country => "IE",
+      :bank_code => {:"@xsi:type" => "xsd:string"},
+      :bank => {:"@xsi:type" => "xsd:string"},
+      :bank_address => {:"@xsi:type" => "xsd:string"},
+      :bank_url => {:"@xsi:type" => "xsd:string"},
+      :branch => {:"@xsi:type" => "xsd:string"},
+      :branch_code => {:"@xsi:type" => "xsd:string"},
+      :in_scl_directory => "no",
+      :sct => {:"@xsi:type" => "xsd:string"},
+      :sdd => {:"@xsi:type" => "xsd:string"},
+      :b2b => {:"@xsi:type" => "xsd:string"},
+      :account_number => {:"@xsi:type" => "xsd:string"},
+      :account_validation_method => {:"@xsi:type" => "xsd:string"},
+      :account_validation => {:"@xsi:type" => "xsd:string"},
+      :length_check => "failed",
+      :account_check => {:"@xsi:type" => "xsd:string"},
+      :bank_code_check => {:"@xsi:type" => "xsd:string"},
+      :iban_checksum_check => {:"@xsi:type" => "xsd:string"},
+      :data_age => {:"@xsi:type" => "xsd:string"},
+      :iba_nformat => "IEkk AAAA BBBB BBCC CCCC CC",
+      :formatcomment => "The first 4 alphanumeric characters are the start of the SWIFT code. Then a 6 digit long routing code and an 8 digit account code follow, both numeric.",
+      :balance => "0",
+      :"@xsi:type" => "tns:IBANValResStruct"
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iban_calculator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Maximilian Schulz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-04 00:00:00.000000000 Z
+date: 2014-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -89,17 +89,23 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - iban_calculator.gemspec
 - lib/iban_calculator.rb
+- lib/iban_calculator/bank.rb
+- lib/iban_calculator/bic_candidate.rb
 - lib/iban_calculator/iban_bic.rb
+- lib/iban_calculator/iban_validator_response.rb
 - lib/iban_calculator/invalid_data.rb
 - lib/iban_calculator/version.rb
+- spec/bic_candidate_spec.rb
 - spec/iban_bic_spec.rb
 - spec/iban_calculator_spec.rb
+- spec/iban_validator_response_spec.rb
 - spec/invalid_data_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/railslove/iban_calculator
@@ -127,8 +133,10 @@ signing_key:
 specification_version: 4
 summary: Calculate IBAN and BIC for countries of Single European Payments Area (SEPA).
 test_files:
+- spec/bic_candidate_spec.rb
 - spec/iban_bic_spec.rb
 - spec/iban_calculator_spec.rb
+- spec/iban_validator_response_spec.rb
 - spec/invalid_data_spec.rb
 - spec/spec_helper.rb
 has_rdoc: