swiftcodesapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c89e8b974a8efbbdbe7221f815ba2eb019442c8285ccb9bf6ce47e9802098f0
+  data.tar.gz: 222bd1b154f40b591e28a794439272dcf453a88f05e58267af2ed89e13287f52
+SHA512:
+  metadata.gz: 6c69580eacbc257affa71940139a63ba75f84ce3988cec40c53f09bb8e64fc5517b10f47493ef010b4092b7516567555a9eb4ce0be6bd7a5a56b6538d837d3e8
+  data.tar.gz: d94f3576b9c9f3901c838a146db8621a9b752ecbb67b443b875e18bc35ffd8238cb95a24a3a2182343da2f3bd7ebdbdf46b03cf506fe3b86317da77e4ddabeee

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,43 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Layout/ParameterAlignment:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-03-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in swiftcodesapi.gemspec
+gemspec
+
+gem "faraday", "~> 2"
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+group :test do
+  gem "webmock", "~> 3.8"
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    swiftcodesapi (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    faraday (2.2.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.1)
+    hashdiff (1.0.1)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.26.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  faraday (~> 2)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  swiftcodesapi!
+  webmock (~> 3.8)
+
+BUNDLED WITH
+   2.3.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Lubomir Vnenk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Swiftcodesapi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/swiftcodesapi`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swiftcodesapi'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install swiftcodesapi
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swiftcodesapi.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "swiftcodesapi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/lib/swiftcodesapi/base_api.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Swiftcodesapi
+  class BaseApi
+    API_URL = "/v1"
+
+    def self.request(uri, method = "POST", payload = nil)
+      client = initialize_client
+
+      response = client.send(method.downcase.to_sym) do |request|
+        request.headers["x-api-key"] = Swiftcodesapi.config.api_key
+        request.url("#{API_URL}#{uri}")
+        request.body = payload
+      end
+
+      raise ServiceError, response.body if response.status != 200
+
+      JSON.parse(response.body)
+    end
+
+    def self.initialize_client
+      Faraday.new(url: Swiftcodesapi.config.api_url) do |faraday|
+        faraday.request :json
+
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def self.get(path)
+      request(path, "GET")
+    end
+
+    def self.post(path, payload)
+      request(path, "POST", payload)
+    end
+
+    def self.delete(path)
+      request(path, "DELETE")
+    end
+
+    def self.put(path, payload)
+      request(path, "PUT", payload)
+    end
+  end
+end

data/lib/swiftcodesapi/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Swiftcodesapi
+  class Configuration
+    attr_accessor :api_key, :api_url
+
+    def initialize
+      @api_key = ENV["SWIFTCODESAPI_API_KEY"]
+      @api_url = ENV["SWIFTCODESAPI_API_URL"] || "https://swiftcodesapi.com"
+    end
+  end
+end

data/lib/swiftcodesapi/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Swiftcodesapi
+  class Error < StandardError
+  end
+end

data/lib/swiftcodesapi/iban.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Swiftcodesapi
+  class Iban
+    attr_reader :data, :id, :account_number, :national_bank_code, :national_branch_code, :swift, :country_iso2
+
+    def initialize(response)
+      @data = response["data"]
+      @id = data["id"]
+      @account_number = data["account_number"]
+      @national_bank_code = data["national_bank_code"]
+      @national_branch_code = data["national_branch_code"]
+      @swift = data["swift"]
+      @country_iso2 = data.dig("country", "id")
+    end
+
+    def swift_id
+      swift_data? && swift["id"]
+    end
+
+    def swift_address
+      swift_data? && swift["address"]
+    end
+
+    def swift_postcode
+      swift_data? && swift["postcode"]
+    end
+
+    def swift_branch_name
+      swift_data? && swift["branch_name"]
+    end
+
+    def swift_branch_code
+      swift_data? && swift["branch_code"]
+    end
+
+    def swift_country_iso2
+      swift_data? && swift.dig("country", "id")
+    end
+
+    def swift_city
+      swift_data? && swift.dig("city", "name")
+    end
+
+    def swift_bank
+      swift_data? && swift.dig("bank", "name")
+    end
+
+    protected
+
+    def swift_data?
+      swift&.count&.positive?
+    end
+  end
+end

data/lib/swiftcodesapi/ibans.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Swiftcodesapi
+  class Ibans < BaseApi
+    URL = "/ibans"
+
+    def self.find_by_iban(iban)
+      response = get("#{URL}/#{iban}")
+      raise IbanError, response["data"] unless response["success"]
+
+      Swiftcodesapi::Iban.new(response)
+    end
+
+    class IbanError < Swiftcodesapi::Error
+    end
+  end
+end

data/lib/swiftcodesapi/version.rb

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

data/lib/swiftcodesapi.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+require_relative "swiftcodesapi/error"
+require_relative "swiftcodesapi/version"
+require_relative "swiftcodesapi/configuration"
+require_relative "swiftcodesapi/base_api"
+require_relative "swiftcodesapi/iban"
+require_relative "swiftcodesapi/ibans"
+
+module Swiftcodesapi
+  @configuration = Configuration.new
+
+  def self.config
+    @configuration
+  end
+
+  def self.configure
+    yield(@configuration)
+  end
+end

data/sig/swiftcodesapi.rbs

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

data/swiftcodesapi.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/swiftcodesapi/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "swiftcodesapi"
+  spec.version = Swiftcodesapi::VERSION
+  spec.authors = ["Lubomir Vnenk"]
+  spec.email = ["lubomir.vnenk@zoho.com"]
+
+  spec.summary = "Gem to get iban info from swiftcodesapi.com"
+  spec.homepage = "https://github.com/lubosch/swiftcodesapi"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/lubosch/swiftcodesapi"
+  spec.metadata["changelog_uri"] = "https://github.com/lubosch/swiftcodesapi/blob/main/CHANGELOG.md"
+
+  # 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.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: swiftcodesapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lubomir Vnenk
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-28 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- lubomir.vnenk@zoho.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/swiftcodesapi.rb
+- lib/swiftcodesapi/base_api.rb
+- lib/swiftcodesapi/configuration.rb
+- lib/swiftcodesapi/error.rb
+- lib/swiftcodesapi/iban.rb
+- lib/swiftcodesapi/ibans.rb
+- lib/swiftcodesapi/version.rb
+- sig/swiftcodesapi.rbs
+- swiftcodesapi.gemspec
+homepage: https://github.com/lubosch/swiftcodesapi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lubosch/swiftcodesapi
+  source_code_uri: https://github.com/lubosch/swiftcodesapi
+  changelog_uri: https://github.com/lubosch/swiftcodesapi/blob/main/CHANGELOG.md
+  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.3
+signing_key:
+specification_version: 4
+summary: Gem to get iban info from swiftcodesapi.com
+test_files: []