creditcard-identifier 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2971d1554919d8eaf0fd916f87d9003cee3aae39d07e0b6f6de388d19eff31f1
-  data.tar.gz: c51129f59758f48b10b24f1e7f7f2d6ee336b62aa8e91fceed7ead69d1005fcb
+  metadata.gz: 1ae87b47647670786be04ec29dbb4257da90c3264e1fdb5cb57df74cd6dc8c2b
+  data.tar.gz: 6d209a5a775ea4e95f9dce3daa5b9a190fa79904e72aae23532438e42b0c3a6c
 SHA512:
-  metadata.gz: 0b831eb2196ceab513b4b2e77907abd454d14cfb13052dc0e14eea01ad964bfff247f13fdfb382bb0f9bb210c0409721853f02e414a6c05cf6dea8c87c030df0
-  data.tar.gz: 10f73f531f751c2f48f347daed4b1d2f726cd19495ae579d4a80b6d40e5b4ea6a2f8b694f17f80d6d46bb8327a1530a936743e86382b5453d92de98ab3559e6e
+  metadata.gz: 613ec2e5e2e481e1fabb607c8f27b520ed0ab1d8fb8aa55cdf45c7069e1654afc22599a4bcf1db125db888daa8352277db00ecb92bb6765f8b9499b25cca013e
+  data.tar.gz: 8a60d7b35b49a581f47a514ca12f04436206d132d2dd9c315f1a6f204d7c345556e4a077d621b8a0e00c8476a7de7b4448e6f3c65267770f72e30cbe3339fe45

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Renato Augusto Viço Elias
+
+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

@@ -1,6 +1,21 @@
 # Credit Card Identifier - Ruby Library
 
-Ruby library for credit card BIN validation using bin-cc data.
+Ruby library for credit card BIN validation and identification.
+
+## Supported Card Brands
+
+- American Express (amex)
+- Aura
+- BaneseCard
+- Diners Club
+- Discover
+- Elo
+- Hipercard
+- JCB
+- Maestro
+- Mastercard
+- UnionPay
+- Visa
 
 ## Installation
 
@@ -31,7 +46,7 @@ require 'creditcard_identifier'
 
 # Identify card brand
 brand = CreditcardIdentifier.find_brand('4012001037141112')
-puts brand  # 'visa'
+puts brand[:name]  # 'visa'
 
 # Check if card is supported
 supported = CreditcardIdentifier.supported?('4012001037141112')
@@ -47,7 +62,12 @@ validator = CreditcardIdentifier::Validator.new
 
 # Identify brand
 brand = validator.find_brand('4012001037141112')
-puts brand  # 'visa'
+puts brand[:name]  # 'visa'
+
+# Get detailed brand info
+detailed = validator.find_brand('4012001037141112', detailed: true)
+puts detailed[:scheme]  # 'visa'
+puts detailed[:matched_pattern]  # { bin: '^4', length: [13, 16, 19], ... }
 
 # Check if supported
 supported = validator.supported?('4012001037141112')
@@ -59,11 +79,24 @@ puts valid  # true
 
 # Get brand info
 info = validator.get_brand_info('visa')
-puts info['regexpBin']
+puts info[:regexp_bin]
+
+# Get detailed brand info
+detailed = validator.get_brand_info_detailed('amex')
+puts detailed
 
 # List all brands
 brands = validator.list_brands
-puts brands  # ['elo', 'diners', 'visa', ...]
+puts brands
+# ['amex', 'aura', 'banesecard', 'diners', 'discover', 'elo', 'hipercard', 'jcb', 'maestro', 'mastercard', 'unionpay', 'visa']
+
+# Validate card number using Luhn algorithm
+is_valid = CreditcardIdentifier.luhn('4012001037141112')
+puts is_valid  # true
+
+# Or using validator instance
+is_valid = validator.luhn('4012001037141112')
+puts is_valid  # true
 ```
 
 ## API
@@ -76,7 +109,7 @@ Identify the credit card brand.
 **Parameters:**
 - `card_number` (String): The credit card number
 
-**Returns:** (String, nil) Brand name (e.g., 'visa', 'mastercard') or nil if not found
+**Returns:** (Hash, nil) Brand hash or nil if not found
 
 #### `CreditcardIdentifier.supported?(card_number)`
 Check if the card number is supported.
@@ -88,19 +121,17 @@ Check if the card number is supported.
 
 ### Validator Class
 
-#### `initialize(data_path = nil)`
-Initialize validator with brand data.
+#### `initialize`
+Initialize validator with embedded brand data.
 
-**Parameters:**
-- `data_path` (String, nil): Path to brands.json. If nil, uses bundled data.
-
-#### `find_brand(card_number)`
+#### `find_brand(card_number, detailed: false)`
 Identify the credit card brand.
 
 **Parameters:**
 - `card_number` (String): The credit card number
+- `detailed` (Boolean): If true, returns detailed brand info with matched pattern
 
-**Returns:** (String, nil) Brand name or nil if not found
+**Returns:** (Hash, nil) Brand hash or nil if not found
 
 #### `supported?(card_number)`
 Check if card number is supported.
@@ -110,12 +141,12 @@ Check if card number is supported.
 
 **Returns:** (Boolean) true if supported, false otherwise
 
-#### `validate_cvv(cvv, brand_name)`
+#### `validate_cvv(cvv, brand_or_name)`
 Validate CVV for a specific brand.
 
 **Parameters:**
 - `cvv` (String): CVV code
-- `brand_name` (String): Brand name (e.g., 'visa', 'mastercard')
+- `brand_or_name` (String | Hash): Brand name or brand hash from find_brand
 
 **Returns:** (Boolean) true if valid, false otherwise
 
@@ -127,16 +158,34 @@ Get information about a specific brand.
 
 **Returns:** (Hash, nil) Brand information or nil if not found
 
+#### `get_brand_info_detailed(scheme)`
+Get detailed information about a specific brand.
+
+**Parameters:**
+- `scheme` (String): Scheme name (e.g., 'visa', 'mastercard')
+
+**Returns:** (Hash, nil) Detailed brand information or nil if not found
+
 #### `list_brands`
 List all supported brands.
 
 **Returns:** (Array<String>) List of brand names
 
+#### `luhn(number)`
+Validate a credit card number using the Luhn algorithm.
+
+**Parameters:**
+- `number` (String): Credit card number (digits only)
+
+**Returns:** (Boolean) true if valid according to Luhn algorithm
+
+**Raises:** TypeError if input is not a string
+
 ## Data Source
 
 This library uses the BIN data from the [bin-cc project](https://github.com/renatovico/bin-cc).
 
-The data is bundled with the gem, and can be updated by installing a newer version.
+The data is embedded directly in the gem for optimal performance.
 
 ## Development
 
@@ -145,7 +194,7 @@ After checking out the repo, run `bundle install` to install dependencies.
 Run tests with:
 
 ```bash
-ruby test/test_validator.rb
+bundle exec ruby test/test_validator.rb
 ```
 
 ## License

data/lib/creditcard_identifier/brands.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Auto-generated by bin-cc build - DO NOT EDIT
-# Generated: 2026-01-11T20:12:36.612Z
+# Generated: 2026-01-11T21:09:29.401Z
 
 module CreditcardIdentifier
   # Credit card brand data
@@ -43,7 +43,7 @@ module CreditcardIdentifier
     },
     {
       name: "aura",
-      priority_over: [],
+      priority_over: ["maestro"],
       regexp_bin: /\A(50)/,
       regexp_full: /\A(?=.{16,19}$)(?:50)[0-9]*\z/,
       regexp_cvv: /\A\d{3}\z/,
@@ -55,6 +55,13 @@ module CreditcardIdentifier
       regexp_full: /\A(?=.{16}$)(?:636117|637473|637470|637472|650725|650046|650591|651668|651679)[0-9]*\z/,
       regexp_cvv: /\A\d{3}\z/,
     },
+    {
+      name: "maestro",
+      priority_over: [],
+      regexp_bin: /\A(5018|5020|5038|5893|6304|6759|676[1-3]|6706)/,
+      regexp_full: /\A(?=.{12,19}$)(?:5018|5020|5038|5893|6304|6759|676[1-3]|6706)[0-9]*\z/,
+      regexp_cvv: /\A\d{3}\z/,
+    },
     {
       name: "visa",
       priority_over: [],
@@ -64,10 +71,10 @@ module CreditcardIdentifier
     },
     {
       name: "discover",
-      priority_over: ["hipercard"],
-      regexp_bin: /\A(6011|622|64|65)/,
-      regexp_full: /\A(?=.{16}$)(?:6011|622|64|65)[0-9]*\z/,
-      regexp_cvv: /\A\d{4}\z/,
+      priority_over: ["hipercard", "unionpay"],
+      regexp_bin: /\A(6011|64[4-9]|65)/,
+      regexp_full: /\A(?=.{16,19}$)(?:6011|64[4-9]|65)[0-9]*\z/,
+      regexp_cvv: /\A\d{3}\z/,
     },
     {
       name: "hipercard",
@@ -76,5 +83,12 @@ module CreditcardIdentifier
       regexp_full: /\A(?=.{16,19}$)(?:38|60)[0-9]*\z/,
       regexp_cvv: /\A\d{3}\z/,
     },
+    {
+      name: "unionpay",
+      priority_over: [],
+      regexp_bin: /\A(62)/,
+      regexp_full: /\A(?=.{16,19}$)(?:62)[0-9]*\z/,
+      regexp_cvv: /\A\d{3}\z/,
+    },
   ].freeze
 end

data/lib/creditcard_identifier/brands_detailed.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Auto-generated by bin-cc build - DO NOT EDIT
-# Generated: 2026-01-11T20:12:36.612Z
+# Generated: 2026-01-11T21:09:29.401Z
 
 module CreditcardIdentifier
   # Credit card brand data (detailed)
@@ -237,7 +237,7 @@ module CreditcardIdentifier
       ],
       countries: ["BR"],
       metadata: { "sourceFile" => "aura.json" },
-      priority_over: [],
+      priority_over: ["maestro"],
       bins: []
     },
     {
@@ -312,6 +312,72 @@ module CreditcardIdentifier
       priority_over: ["discover"],
       bins: []
     },
+    {
+      scheme: "maestro",
+      brand: "Maestro",
+      type: "debit",
+      number: {
+        lengths: [12, 13, 14, 15, 16, 17, 18, 19],
+        luhn: true
+      },
+      cvv: {
+        length: 3
+      },
+      patterns: [
+        {
+          bin: "^5018",
+          length: [12, 13, 14, 15, 16, 17, 18, 19],
+          luhn: true,
+          cvv_length: 3
+        },
+        {
+          bin: "^5020",
+          length: [12, 13, 14, 15, 16, 17, 18, 19],
+          luhn: true,
+          cvv_length: 3
+        },
+        {
+          bin: "^5038",
+          length: [12, 13, 14, 15, 16, 17, 18, 19],
+          luhn: true,
+          cvv_length: 3
+        },
+        {
+          bin: "^5893",
+          length: [12, 13, 14, 15, 16, 17, 18, 19],
+          luhn: true,
+          cvv_length: 3
+        },
+        {
+          bin: "^6304",
+          length: [12, 13, 14, 15, 16, 17, 18, 19],
+          luhn: true,
+          cvv_length: 3
+        },
+        {
+          bin: "^6759",
+          length: [12, 13, 14, 15, 16, 17, 18, 19],
+          luhn: true,
+          cvv_length: 3
+        },
+        {
+          bin: "^676[1-3]",
+          length: [12, 13, 14, 15, 16, 17, 18, 19],
+          luhn: true,
+          cvv_length: 3
+        },
+        {
+          bin: "^6706",
+          length: [12, 13, 14, 15, 16, 17, 18, 19],
+          luhn: true,
+          cvv_length: 3
+        },
+      ],
+      countries: ["GLOBAL"],
+      metadata: { "sourceFile" => "maestro.json" },
+      priority_over: [],
+      bins: []
+    },
     {
       scheme: "visa",
       brand: "Visa",
@@ -453,41 +519,35 @@ module CreditcardIdentifier
       brand: "Discover",
       type: "credit",
       number: {
-        lengths: [16],
+        lengths: [16, 19],
         luhn: true
       },
       cvv: {
-        length: 4
+        length: 3
       },
       patterns: [
         {
           bin: "^6011",
-          length: [16],
+          length: [16, 19],
           luhn: true,
-          cvv_length: 4
-        },
-        {
-          bin: "^622",
-          length: [16],
-          luhn: true,
-          cvv_length: 4
+          cvv_length: 3
         },
         {
-          bin: "^64",
-          length: [16],
+          bin: "^64[4-9]",
+          length: [16, 19],
           luhn: true,
-          cvv_length: 4
+          cvv_length: 3
         },
         {
           bin: "^65",
-          length: [16],
+          length: [16, 19],
           luhn: true,
-          cvv_length: 4
+          cvv_length: 3
         },
       ],
       countries: ["US"],
       metadata: { "sourceFile" => "discover.json" },
-      priority_over: ["hipercard"],
+      priority_over: ["hipercard", "unionpay"],
       bins: []
     },
     {
@@ -520,5 +580,29 @@ module CreditcardIdentifier
       priority_over: [],
       bins: []
     },
+    {
+      scheme: "unionpay",
+      brand: "UnionPay",
+      type: "debit",
+      number: {
+        lengths: [16, 17, 18, 19],
+        luhn: true
+      },
+      cvv: {
+        length: 3
+      },
+      patterns: [
+        {
+          bin: "^62",
+          length: [16, 17, 18, 19],
+          luhn: true,
+          cvv_length: 3
+        },
+      ],
+      countries: ["CN", "GLOBAL"],
+      metadata: { "sourceFile" => "unionpay.json" },
+      priority_over: [],
+      bins: []
+    },
   ].freeze
 end

data/lib/creditcard_identifier.rb

@@ -8,7 +8,34 @@ require_relative 'creditcard_identifier/brands_detailed'
 #
 # This module provides credit card validation using bin-cc data.
 module CreditcardIdentifier
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
+
+  # Luhn lookup table for doubling digits
+  LUHN_LOOKUP = [0, 2, 4, 6, 8, 1, 3, 5, 7, 9].freeze
+
+  ##
+  # Validate a credit card number using the Luhn algorithm
+  #
+  # @param number [String] Credit card number (digits only)
+  # @return [Boolean] true if valid according to Luhn algorithm
+  # @raise [TypeError] if number is not a string
+  def self.luhn(number)
+    raise TypeError, 'Expected string input' unless number.is_a?(String)
+    return false if number.empty?
+
+    total = 0
+    x2 = true
+
+    (number.length - 1).downto(0) do |i|
+      value = number[i].ord - 48
+      return false if value < 0 || value > 9
+
+      x2 = !x2
+      total += x2 ? LUHN_LOOKUP[value] : value
+    end
+
+    (total % 10).zero?
+  end
 
   ##
   # Credit card validator using bin-cc data.
@@ -132,6 +159,15 @@ module CreditcardIdentifier
     def list_brands
       @brands.map { |b| b[:name] }
     end
+
+    ##
+    # Validate a credit card number using the Luhn algorithm
+    #
+    # @param number [String] Credit card number (digits only)
+    # @return [Boolean] true if valid according to Luhn algorithm
+    def luhn(number)
+      CreditcardIdentifier.luhn(number)
+    end
   end
 
   # Module-level convenience methods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: creditcard-identifier
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Renato Viço
@@ -44,6 +44,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/creditcard_identifier.rb
 - lib/creditcard_identifier/brands.rb