credit_card_info 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e1751e3d0337ae28f147917b8091ea6a4413a8e5c8e4fc0f73cab67e717415f
+  data.tar.gz: ec9285e450f14ec6dea2141f8e5218ce46119acd1e23fe66ac9400cc18755d14
+SHA512:
+  metadata.gz: 5dcabba34c37dc559488a2d8d24f1f91621fb89c044c0806efb82571ef12f926f48f83d843928b65728692c0256a1346c68e7ac97c98ae70f101f527041fd2c3
+  data.tar.gz: 3461a76e7c6d17574ad2765e7c196f9a1992fda4fc73e97ab0f804d06d075f703c09ccacea6c989a02e70230e0c1c6e23e2459288dda8da395e6edddbe40d6a8

data/CHANGELOG.md

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

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in credit-card-info.gemspec
+gemspec
+
+group :development, :test do
+  gem "rake", "~> 13.0"
+  gem "rubocop", "~> 1.11.0"
+  gem "rubocop-performance", "~> 1.10"
+end

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    credit_card_info (0.1.0)
+      credit_card_bins (~> 0.0.1)
+      dry-configurable (>= 0.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    credit_card_bins (0.0.3)
+    dry-configurable (0.14.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.6)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rubocop (1.11.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.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)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  credit_card_info!
+  rake (~> 13.0)
+  rubocop (~> 1.11.0)
+  rubocop-performance (~> 1.10)
+
+BUNDLED WITH
+   2.2.15

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2022 credit_card_info
+
+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,80 @@
+# CreditCardInfo
+
+The Issuer Identification Number (IIN), previously known as Bank Identification Number (BIN) is the first six numbers of a credit card. 
+These identify the institution that issued the card to the card holder and 
+provide useful information about the card that can help make your payments flow smarter.
+
+Uses two data providers:
+    * First bincodes.com API (require registration and api key).
+    * Second 'credit_card_bins' gem data.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'credit_card_info'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install credit_card_info
+
+
+## Configuration
+
+```ruby
+CreditCardInfo::Config.configure do |config|
+    config.bincodes.api_key = "your_api_key"
+    config.bincodes.api_url = "https://api.bincodes.com"
+    
+    # class for make HttpRequests
+    config.bincodes.http_klass = Net::HTTP
+    # set timeout for api request (10 by default)
+    config.bincodes.timeout = 10
+
+
+    # set cache provider class, Rails.cache by default when using in Rails application
+    config.cache.provider = Rails.cache
+    # set cache keys lifeitime, default is 31 day
+    config.cache.ttl = 2678400
+    # set cache keys prefix, result key will be prefix:bin
+    config.cache.key_prefix = "ccinfo"
+    
+    # also you can use custom logger instance, default is Rails.logger for Rails apps, and stdout for others
+    config.logger = Logger.new($stdout)
+end
+```
+
+## Usage
+
+You just need make call:
+
+```ruby
+bin = '515735'
+CreditCardInfo.fetch(bin)
+# { 
+#   bin: "515735", 
+#   bank: "CITIBANK, N.A.", 
+#   card: "MASTERCARD", 
+#   type: "CREDIT", 
+#   level: "WORLD CARD", 
+#   country: "United States", 
+#   countrycode: "US"
+# }
+```
+
+By default that call will be search firstly via bincodes.com, and if find nothing will search via `credit_card_bins` gem.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "credit_card_info"
+
+# 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/credit_card_info.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/credit_card_info/version"
+
+Gem::Specification.new do |s|
+  s.name          = "credit_card_info"
+  s.version       = CreditCardInfo::VERSION
+  s.authors     = ["Alexey Zhuravlev"]
+  s.email       = ["alexey.g.zhuravlev@gmail.com"]
+  s.summary     = "Find credit card info by BIN(IIN)"
+  s.description = <<-DESC
+    Fetch credit card info from www.bincodes.com with configurable fallback to https://github.com/hugolantaume/credit_card_bins data.
+    Also provides caching results for decreasing bincodesAPI request count/
+  DESC
+
+  s.license = "MIT"
+  s.homepage = "https://github.com/azhuravlev/credit_card_info"
+
+  s.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  s.required_ruby_version = ">= 2.7"
+
+  s.add_dependency "credit_card_bins", "~> 0.0.1"
+  s.add_dependency "dry-configurable", ">= 0.13"
+
+  s.files         = `find *`.split("\n").uniq.sort.reject(&:empty?)
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/lib/credit_card_info/cache.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CreditCardInfo
+  class Cache
+    def self.fetch(code, &block)
+      return yield unless config.provider
+
+      config.provider.fetch("#{config.key_prefix}:#{code}", expires_in: config.ttl, &block)
+    end
+
+    def self.config
+      CreditCardInfo.config.cache
+    end
+  end
+end

data/lib/credit_card_info/config.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "logger"
+require "dry-configurable"
+
+module CreditCardInfo
+  class Config
+    extend Dry::Configurable
+
+    setting :bincodes do
+      setting :api_key, default: ""
+      setting :api_url, default: "https://api.bincodes.com"
+      setting :timeout, default: 10
+      setting :http_klass, default: Net::HTTP
+    end
+
+    setting :cache do
+      setting :provider, default: defined?(Rails) ? Rails.cache : nil
+      setting :ttl, default: 2678400 # 31 days
+      setting :key_prefix, default: "ccinfo"
+    end
+
+    setting :logger, default: defined?(Rails) ? Rails.logger : Logger.new($stdout)
+  end
+end

data/lib/credit_card_info/providers/bincodes.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+
+module CreditCardInfo
+  module Providers
+    class Bincodes
+      def self.fetch(code)
+        uri = URI("#{config.api_url}/bin/json/#{config.api_key}/#{code}")
+
+        http = config.http_klass.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.read_timeout = config.timeout
+
+        request = Net::HTTP::Get.new(uri)
+        response = http.start { |h| h.request(request) }
+
+        parse_response(response)
+      rescue StandardError => e
+        CreditCardInfo::Response.new(error: { code: e.class, message: e.message })
+      end
+
+      def self.parse_response(response)
+        unless response.is_a?(Net::HTTPSuccess)
+          return CreditCardInfo::Response.new(error: { code:    response.code,
+                                                       message: "Unexpected error from bincodes api" })
+        end
+
+        data = JSON.parse(response.body, symbolize_names: true)
+
+        CreditCardInfo::Response.new(data: data).tap do |res|
+          res.error = { code: data[:error], message: data[:message] } if data[:error]
+        end
+      rescue JSONError => e
+        CreditCardInfo::Response.new(error: { code: e.class, message: "Invalid data from bincodes api: #{body}" })
+      end
+
+      def self.config
+        CreditCardInfo.config.bincodes
+      end
+    end
+  end
+end

data/lib/credit_card_info/providers/credit_card_bins.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "credit_card_bins"
+
+module CreditCardInfo
+  module Providers
+    class CreditCardBins
+      def self.fetch(code)
+        bin = CreditCardBin.new(code)
+        CreditCardInfo::Response.new(
+          data: {
+            bin:         bin.bin,
+            bank:        bin.issuer,
+            card:        bin.brand,
+            type:        bin.type,
+            level:       bin.category,
+            country:     bin.data.dig("country", "name"),
+            countrycode: bin.data.dig("country", "alpha_2")
+          }
+        )
+      rescue StandardError => e
+        CreditCardInfo::Response.new(error: { code: e.class, message: e.message })
+      end
+    end
+  end
+end

data/lib/credit_card_info/proxy.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "providers/bincodes"
+require_relative "providers/credit_card_bins"
+
+module CreditCardInfo
+  module Proxy
+    # @return [Hash, NilClass] bin description
+    def self.fetch(code)
+      bincode_response = Providers::Bincodes.fetch(code)
+      return bincode_response.data if bincode_response.valid?
+
+      bincode_response.log_error
+
+      card_bins_response = Providers::CreditCardBins.fetch(code)
+      return card_bins_response.data if card_bins_response.valid?
+
+      card_bins_response.log_error
+
+      nil
+    end
+  end
+end

data/lib/credit_card_info/response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CreditCardInfo
+  Response = Struct.new(:error, :data, keyword_init: true)
+  INFO_METHODS = %i[
+    bin
+    bank
+    card
+    type
+    level
+    country
+    countrycode
+  ].freeze
+
+  class Response
+    INFO_METHODS.each do |m|
+      define_method(m) { data.fetch(m, "") }
+    end
+
+    def valid?
+      error.nil?
+    end
+
+    def log_error
+      return unless CreditCardInfo.logger
+
+      CreditCardInfo.logger.warn "Wrong response: error_code=#{error[:code]} error_message=#{error[:message]}"
+    end
+  end
+end

data/lib/credit_card_info/version.rb

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

data/lib/credit_card_info.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "credit_card_info/proxy"
+require "credit_card_info/cache"
+require "credit_card_info/config"
+require "credit_card_info/response"
+require "credit_card_info/version"
+
+module CreditCardInfo
+  class Error < StandardError; end
+
+  def self.config
+    @config ||= Config.config
+  end
+
+  def self.fetch(value)
+    code = extract_bin(value)
+    Cache.fetch(code) { Proxy.fetch(code) }
+  end
+
+  def self.logger
+    @logger ||= config.logger
+  end
+
+  # @return [String] first 5 digits of credit card number i.e. BIN
+  def self.extract_bin(value)
+    value.to_s.delete("\s")[0..5]
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: credit_card_info
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Zhuravlev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: credit_card_bins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: |2
+      Fetch credit card info from www.bincodes.com with configurable fallback to https://github.com/hugolantaume/credit_card_bins data.
+      Also provides caching results for decreasing bincodesAPI request count/
+email:
+- alexey.g.zhuravlev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- credit_card_info.gemspec
+- lib/credit_card_info.rb
+- lib/credit_card_info/cache.rb
+- lib/credit_card_info/config.rb
+- lib/credit_card_info/providers/bincodes.rb
+- lib/credit_card_info/providers/credit_card_bins.rb
+- lib/credit_card_info/proxy.rb
+- lib/credit_card_info/response.rb
+- lib/credit_card_info/version.rb
+homepage: https://github.com/azhuravlev/credit_card_info
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Find credit card info by BIN(IIN)
+test_files: []