ibancom 0.0.1

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ibancom.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/ibancom/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ibancom"
+  spec.version = Ibancom::VERSION
+  spec.authors = ["Aitor García Rey"]
+  spec.email = ["aitor@devengo.com"]
+
+  spec.summary = "Ruby client for iban.com APIs"
+  spec.description = "Ruby client for iban.com APIs"
+  spec.homepage = "https://github.com/devengo/ibancom-ruby"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/devengo/ibancom-ruby"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.add_dependency "faraday", ">= 0.15"
+
+  spec.add_development_dependency "guard", "~> 2.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.0"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.2"
+  spec.add_development_dependency "rubocop-performance", "~> 1.0"
+  spec.add_development_dependency "rubocop-rake", "~> 0.6"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.0"
+  spec.add_development_dependency "test-prof", "~> 1.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+end

data/lib/ibancom/api/service.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module API
+    class Service
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+    end
+  end
+end

data/lib/ibancom/api/services.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "service"
+require_relative "validation_service"
+
+module Ibancom
+  module API
+    module Services
+      def validations
+        @services[:validation] ||= API::ValidationService.new(self)
+      end
+    end
+  end
+end

data/lib/ibancom/api/validation_service.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module API
+    class ValidationService < Service
+      def validate(iban)
+        response = client.post("/v4/iban/", { iban: iban, sci: 1 })
+        Resources::IBAN::Validation.new(response, response.body)
+      end
+    end
+  end
+end

data/lib/ibancom/client.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "securerandom"
+
+# require "faraday_middleware"
+require_relative "api/services"
+require_relative "resources/base"
+
+module Ibancom
+  class Client
+    include Ibancom::API::Services
+
+    BASE_URL = "https://api.iban.com/clients/api"
+
+    attr_reader :base_url, :user_agent, :proxy, :apikey, :logger_enabled
+
+    def initialize(options = {})
+      @base_url = options[:base_url] || BASE_URL
+      @user_agent = options[:user_agent] || default_user_agent
+      @proxy = options[:proxy]
+      @apikey = options[:apikey] || ENV["IBANCOM_APIKEY"]
+      @logger_enabled = options[:logger_enabled].nil? ? true : options[:logger_enabled]
+      @services = {}
+    end
+
+    def connection
+      @connection ||= Faraday.new do |builder|
+        builder.request :url_encoded
+        builder.use Faraday::Response::RaiseError
+        builder.response :json,
+                         content_type: /\bjson$/,
+                         preserve_raw: true,
+                         parser_options: { symbolize_names: true }
+        builder.proxy = @proxy if proxy
+        if @logger_enabled
+          builder.response :logger, nil, { headers: true, bodies: true } do |logger|
+            logger.filter(/("password":)"(\w+)"/, '\1[FILTERED]')
+          end
+        end
+        builder.adapter :net_http
+      end
+    end
+
+    def resources
+      @resources ||= {}
+    end
+
+    def default_user_agent
+      "Ibancom/#{Ibancom::VERSION} Ruby Client (Faraday/#{Faraday::VERSION})"
+    end
+
+    def get(path, options = {})
+      execute :get, path, nil, options
+    end
+
+    def post(path, data = nil, options = {})
+      execute :post, path, data, options
+    end
+
+    def patch(path, data = nil, options = {})
+      execute :patch, path, data, options
+    end
+
+    def execute(method, path, data = nil, options = {})
+      request(method, path, data, options)
+    end
+
+    def request(method, path, data = nil, options = {})
+      request_options = request_options(method, path, data, options)
+      uri = "#{base_url}#{path}"
+
+      begin
+        connection.run_request(method, uri, request_options[:body], request_options[:headers])
+      rescue StandardError => e
+        handle_request_error(e)
+      end
+    end
+
+    def request_options(_method, _path, data, _options)
+      default_options.tap do |defaults|
+        defaults[:body] = defaults[:body].merge(data)
+      end
+    end
+
+    def handle_request_error(error)
+      case error
+      when Faraday::ClientError
+        if error.response
+          handle_error_response(error)
+        else
+          handle_network_error(error)
+        end
+      else
+        raise error
+      end
+    end
+
+    def handle_error_response(error)
+      puts "ERROR #{error.response}"
+      raise error
+    end
+
+    def handle_network_error(error)
+      raise error
+    end
+
+    private def default_options
+      {
+        url: base_url,
+        headers: {
+          "User-Agent": default_user_agent,
+        },
+        body: {
+          format: "json",
+          api_key: apikey,
+        },
+      }
+    end
+  end
+end

data/lib/ibancom/resources/base.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    class Base
+      attr_reader :response
+
+      def initialize(response, attributes = {})
+        @response = response
+        attributes.each do |key, value|
+          m = "#{key}=".to_sym
+          send(m, value) if respond_to?(m)
+        end
+      end
+
+      def self.map(original_attribute, mapped_attributes)
+        class_eval { attr_writer original_attribute.to_sym }
+        mapped_attributes = [mapped_attributes].flatten
+        mapped_attributes.each do |mapped_attribute|
+          define_method(mapped_attribute) { instance_variable_get("@#{original_attribute}") }
+        end
+      end
+    end
+  end
+end
+
+require_relative "collection"
+require_relative "iban/validation"
+require_relative "iban/bank"
+require_relative "iban/checks"
+require_relative "iban/check"
+require_relative "iban/schemes"
+require_relative "iban/scheme"

data/lib/ibancom/resources/collection.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    class Collection
+      include Enumerable
+      attr_reader :response
+
+      def initialize(response, item_klass, attributes_collection = [])
+        @response = response
+        @attributes_collection = attributes_collection
+        @items = attributes_collection.map { |attributes_item| item_klass.new(nil, attributes_item) }
+      end
+
+      def each(&block)
+        @items.each(&block)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    module IBAN
+      class Bank < Base
+        attr_accessor :bic,
+                      :branch,
+                      :bank,
+                      :address,
+                      :city,
+                      :state,
+                      :zip,
+                      :phone,
+                      :fax,
+                      :www,
+                      :email,
+                      :country,
+                      :country_iso,
+                      :account,
+                      :bank_code,
+                      :branch_code
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    module IBAN
+      class Check < Base
+        PASSED_MESSAGES = {
+          "001" => "IBAN Check digit is correct",
+          "002" => "Account Number check digit is correct",
+          "003" => "IBAN Length is correct",
+          "005" => "IBAN structure is correct",
+          "006" => "IBAN does not contain illegal characters",
+          "007" => "Country supports IBAN standard",
+        }.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/iban/checks.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    module IBAN
+      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/iban/scheme.rb

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

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    module IBAN
+      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/iban/validation.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Ibancom
+  module Resources
+    module IBAN
+      class Validation < Base
+        attr_reader :bank,
+                    :checks,
+                    :schemes
+
+        def initialize(response, attributes = {})
+          super(response, attributes)
+          @bank = Bank.new(response, attributes[:bank_data])
+          @checks = Checks.new(response, attributes[:validations])
+          @schemes = Schemes.new(response, attributes[:sepa_data])
+        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 }
+          scheme&.supported?
+        end
+      end
+    end
+  end
+end

data/lib/ibancom/version.rb

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

data/lib/ibancom.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "ibancom/version"
+require_relative "ibancom/client"
+
+module Ibancom
+end

data/sig/ibancom.rbs

@@ -0,0 +1,4 @@
+module Ibancom
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,228 @@
+--- !ruby/object:Gem::Specification
+name: ibancom
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aitor García Rey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: test-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby client for iban.com APIs
+email:
+- aitor@devengo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".markdownlint.yaml"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_devengo.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ibancom.gemspec
+- lib/ibancom.rb
+- lib/ibancom/api/service.rb
+- lib/ibancom/api/services.rb
+- lib/ibancom/api/validation_service.rb
+- lib/ibancom/client.rb
+- lib/ibancom/resources/base.rb
+- lib/ibancom/resources/collection.rb
+- lib/ibancom/resources/iban/bank.rb
+- lib/ibancom/resources/iban/check.rb
+- lib/ibancom/resources/iban/checks.rb
+- lib/ibancom/resources/iban/scheme.rb
+- lib/ibancom/resources/iban/schemes.rb
+- lib/ibancom/resources/iban/validation.rb
+- lib/ibancom/version.rb
+- sig/ibancom.rbs
+homepage: https://github.com/devengo/ibancom-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/devengo/ibancom-ruby
+  source_code_uri: https://github.com/devengo/ibancom-ruby
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Ruby client for iban.com APIs
+test_files: []