ibancom 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db212a5427dbb25699bbdec0aac5cd33031d6ae19ba4b3be96e5e2408090fffe
-  data.tar.gz: 527d056deb38d7c42cd8124a8e0dfa5fc67931057bb96cc5128feff794b1ca41
+  metadata.gz: 47cb70450c2d3171087a946ac9bb141c8d24fd23355bbaa3f281b1f0ff843b30
+  data.tar.gz: 18b1bb8d814c8688543a44175e90d480dd2bd31ed9a2a32a1aa38c074218e2bb
 SHA512:
-  metadata.gz: b098efd3c946d7adfe126bda574ba28361a61fec806f34ab18ce641705fd6b38260a9f963a016f2bcdf7bec55240a8b581a8f6b1a784913ea2f3224335bdf4d4
-  data.tar.gz: af899cab00d8c47782447a3d4004a4f7a8e9c2f690027c8fc9f41a70236782ae03e11b0b31d9d7e8dfe4f239be3abfe281df73d3b4ec030d57a4e0e4311c2dec
+  metadata.gz: 193f5a9634022ee954039f7287d3ac1532a8f73adba28eae1890dfc0de4fb4660f9c115959dae12ac83532b566889464665f3da9c3ea3caeb13b524329924356
+  data.tar.gz: e1de0d21ad7bc55b7a473fc987211286ff2487339a98ee459860a050758dc08e2d722800168c3b3b20de527671c06d783f981eab7aa187c7c3c684013b11d40f

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    ibancom (0.0.10)
+    ibancom (0.0.12)
       faraday (>= 0.15)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.1)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.2)
     coderay (1.1.3)
     crack (0.4.5)
@@ -51,14 +51,14 @@ GEM
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (5.0.1)
+    public_suffix (5.1.1)
     rainbow (3.1.1)
     rake (12.3.3)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     regexp_parser (2.7.0)
-    rexml (3.2.5)
+    rexml (3.4.2)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -106,6 +106,8 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  arm64-darwin-22
+  arm64-darwin-25
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -25,6 +25,7 @@ Or install it yourself as:
 This gem provides support for the following APIs:
 
 - Validation API v4
+- Sortware API v4
 
 ## Usage
 
@@ -34,6 +35,18 @@ The first step for using this gem is to instantiate the client:
 client = Ibancom::Client.new(apikey: "YOUR_API_KEY")
 ```
 
+HTTP logging is enabled by default through `Faraday::Response::Logger`. You can replace that middleware and pass extra options to it:
+
+```rb
+client = Ibancom::Client.new(
+  apikey: "YOUR_API_KEY",
+  logger_middleware: CustomMiddleware,
+  logger_options: { log_level: :debug }
+)
+```
+
+`logger_options` are merged over `{ headers: true, bodies: true }`. The middleware is initialized as `Middleware.new(app, nil, options)` and receives the existing password filter block. Set `logger_enabled: false` to skip logging.
+
 Once you have an authenticated client, you can validate any IBAN easily by using the validations service:
 
 ```rb
@@ -79,6 +92,44 @@ iban.failed_checks
 # #<Ibancom::Resources::IBAN::Check:0x00007f384a576cf8 @code="203", @message="IBAN Length is not correct. Spain IBAN must be 24 characters long.", @response=nil, @type=:length>]
 ```
 
+You can also validate United Kingdom Sort Code and Account Numbers:
+
+```rb
+scan = client.validations.validate_scan("200415", "38290008")
+scan.valid? # true
+
+# What is the bank/branch associated to this account?
+bank = scan.bank # <Ibancom::Resources::SCAN::Bank:0x0000000107c0fc80 ...
+bank.bank        # "BARCLAYS BANK UK PLC"
+bank.bic         # "BUKBGB22XXX"
+bank.branch      # "BARCLAYBANK B'CARD N'PTON"
+bank.address     # "Dept AC Barclaycard House "
+bank.city        # "Northampton"
+bank.zip         # "NN4 7SG"
+bank.phone       # "01604 234234"
+bank.country     # "GB"
+
+# What payment schemes does it support?
+scan.supported_schemes
+#[#<Ibancom::Resources::SCAN::Scheme:0x0000000107c0df70 @code=:FPS_PAYMENTS, @response=nil, @supported="YES">,
+# #<Ibancom::Resources::SCAN::Scheme:0x0000000107c0def8 @code=:CHAPS, @response=nil, @supported="YES">,
+# #<Ibancom::Resources::SCAN::Scheme:0x0000000107c0de80 @code=:BACS, @response=nil, @supported="YES">,
+# #<Ibancom::Resources::SCAN::Scheme:0x0000000107c0de08 @code=:CCC_PAYMENTS, @response=nil, @supported="YES">]
+
+# Does the SCAN supports faster payments?
+scan.supported_scheme?(:FPS_PAYMENTS) # true
+```
+
+In the same way as with the IBAN, when the SCAN is not valid the failed checks are available for inspection:
+
+```rb
+scan = client.validations.validate_scan("000001", "00000002")
+scan.valid? # false
+scan.failed_checks
+#[#<Ibancom::Resources::SCAN::Check:0x00000001088debf0 @code="202", @message="Sort Code not found in bank directory",
+# @response=nil, @type=:length>]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -86,8 +137,12 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then tag and push the new version:
 
 ```git
-git tag vx.x.x main
-git push origin vx.x.x
+bundle install
+git add .
+git commit -m 'feat(release): Bump to vX.X.X'
+git push
+git tag vX.X.X main
+git push origin vX.X.X
 ```
 
 The tagging will trigger the GitHub action defined in `release.yml`, pushing the gem to [rubygems.org](https://rubygems.org).

data/lib/ibancom/api/validation_service.rb

@@ -4,9 +4,14 @@ module Ibancom
   module API
     class ValidationService < Service
       def validate(iban)
-        response = client.post("/v4/iban/", { iban: iban, sci: 1 })
+        response = client.post("/v4/iban/", { iban: iban, sci: 1, sci_tips: 1 })
         Resources::IBAN::Validation.new(response, response.body)
       end
+
+      def validate_scan(sort_code, account_number)
+        response = client.post("/v4/sort/", { sortcode: sort_code, account: account_number })
+        Resources::SCAN::Validation.new(response, response.body)
+      end
     end
   end
 end

data/lib/ibancom/client.rb

@@ -13,7 +13,7 @@ module Ibancom
 
     BASE_URL = "https://api.iban.com/clients/api"
 
-    attr_reader :base_url, :user_agent, :proxy, :apikey, :logger_enabled
+    attr_reader :base_url, :user_agent, :proxy, :apikey, :logger_enabled, :logger_middleware, :logger_options
 
     def initialize(options = {})
       @base_url = options[:base_url] || BASE_URL
@@ -21,6 +21,8 @@ module Ibancom
       @proxy = options[:proxy]
       @apikey = options[:apikey] || ENV["IBANCOM_APIKEY"]
       @logger_enabled = options[:logger_enabled].nil? ? true : options[:logger_enabled]
+      @logger_middleware = options.fetch(:logger_middleware, Faraday::Response::Logger)
+      @logger_options = options.fetch(:logger_options, {})
       @services = {}
     end
 
@@ -34,7 +36,7 @@ module Ibancom
                          parser_options: { symbolize_names: true }
         builder.proxy = @proxy if proxy
         if @logger_enabled
-          builder.response :logger, nil, { headers: true, bodies: true } do |logger|
+          builder.use @logger_middleware, nil, { headers: true, bodies: true }.merge(@logger_options) do |logger|
             logger.filter(/("password":)"(\w+)"/, '\1[FILTERED]')
           end
         end

data/lib/ibancom/resources/base.rb

@@ -31,3 +31,10 @@ require_relative "iban/checks"
 require_relative "iban/check"
 require_relative "iban/schemes"
 require_relative "iban/scheme"
+require_relative "scan/validation"
+require_relative "scan/bank"
+require_relative "scan/account"
+require_relative "scan/checks"
+require_relative "scan/check"
+require_relative "scan/schemes"
+require_relative "scan/scheme"

data/lib/ibancom/resources/scan/account.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    module SCAN
+      class Account < Base
+        attr_accessor :sortcode,
+                      :account,
+                      :iban
+      end
+    end
+  end
+end

data/lib/ibancom/resources/scan/bank.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    module SCAN
+      class Bank < Base
+        attr_accessor :bic,
+                      :branch,
+                      :bank,
+                      :address,
+                      :city,
+                      :zip,
+                      :phone,
+                      :country
+      end
+    end
+  end
+end

data/lib/ibancom/resources/scan/check.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    module SCAN
+      class Check < Base
+        PASSED_MESSAGES = {
+          "001" => "Modulus Success: Check digit is valid",
+          "002" => "Sort Code found in bank directory",
+          "006" => "Sort Code does not contain illegal characters",
+          "007" => "Account Number does not contain illegal characters",
+          "008" => "Sort Code length is correct",
+          "009" => "Account Number length is correct",
+        }.freeze
+
+        attr_accessor :type,
+                      :code,
+                      :message
+
+        def passed?
+          PASSED_MESSAGES[code] == message
+        end
+
+        def failed?
+          !passed?
+        end
+      end
+    end
+  end
+end

data/lib/ibancom/resources/scan/checks.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    module SCAN
+      class Checks < Collection
+        def initialize(response, attributes_collection)
+          parsed = attributes_collection.map do |check_attributes|
+            {
+              type: check_attributes[0],
+              code: check_attributes[1][:code],
+              message: check_attributes[1][:message],
+            }
+          end
+          super(response, Check, parsed)
+        end
+      end
+    end
+  end
+end

data/lib/ibancom/resources/scan/scheme.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    module SCAN
+      class Scheme < Base
+        attr_accessor :code,
+                      :supported
+
+        def supported?
+          supported == "YES"
+        end
+      end
+    end
+  end
+end

data/lib/ibancom/resources/scan/schemes.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    module SCAN
+      class Schemes < Collection
+        def initialize(response, attributes_collection)
+          parsed = attributes_collection.map do |attributes|
+            {
+              code: attributes[0],
+              supported: attributes[1],
+            }
+          end
+          super(response, Scheme, parsed)
+        end
+      end
+    end
+  end
+end

data/lib/ibancom/resources/scan/validation.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    module SCAN
+      class Validation < Base
+        attr_reader :bank,
+                    :account,
+                    :checks,
+                    :schemes
+
+        def initialize(response, attributes = {})
+          super(response, attributes)
+          @bank = Bank.new(response, attributes[:bank_data])
+          @account = Account.new(response, attributes[:account_data])
+          @checks = Checks.new(response, attributes[:validations])
+          @schemes = Schemes.new(response, attributes[:payment_schemes])
+        end
+
+        def valid?
+          checks.all?(&:passed?)
+        end
+
+        def failed_checks
+          checks.select(&:failed?)
+        end
+
+        def supported_schemes
+          schemes.select(&:supported?)
+        end
+
+        def supported_scheme?(code)
+          scheme = supported_schemes.find { |supported| supported.code == code }
+
+          return false if scheme.nil?
+
+          scheme.supported?
+        end
+      end
+    end
+  end
+end

data/lib/ibancom/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ibancom
-  VERSION = "0.0.10"
+  VERSION = "0.0.12"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ibancom
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.12
 platform: ruby
 authors:
 - Aitor García Rey
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -198,6 +197,13 @@ files:
 - lib/ibancom/resources/iban/scheme.rb
 - lib/ibancom/resources/iban/schemes.rb
 - lib/ibancom/resources/iban/validation.rb
+- lib/ibancom/resources/scan/account.rb
+- lib/ibancom/resources/scan/bank.rb
+- lib/ibancom/resources/scan/check.rb
+- lib/ibancom/resources/scan/checks.rb
+- lib/ibancom/resources/scan/scheme.rb
+- lib/ibancom/resources/scan/schemes.rb
+- lib/ibancom/resources/scan/validation.rb
 - lib/ibancom/version.rb
 - sig/ibancom.rbs
 homepage: https://github.com/devengoapp/ibancom-ruby
@@ -207,7 +213,6 @@ metadata:
   homepage_uri: https://github.com/devengoapp/ibancom-ruby
   source_code_uri: https://github.com/devengoapp/ibancom-ruby
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -222,8 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby client for iban.com APIs
 test_files: []