credit_card_validations 1.5.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9dc4aaa6683f8c4b1b0bcfea5ca31076fa3109f2
-  data.tar.gz: 33aba134c4e4b5e445f51796740ffe8477d6fdac
+  metadata.gz: 9132f1754e530b96267778bd96cecaf3838ec575
+  data.tar.gz: 7b805a21857451ce13ad3d86776c0c192e8ac5fa
 SHA512:
-  metadata.gz: 2bf428e04e75942465f12bec35b449943bd3825c20ecc709364a937f861041284c16909430afb74fd0e9cf76492c7b6f167580d6a8179f6273d60e8def127a65
-  data.tar.gz: f164f228a43fd51410c03040b11f0b0cdb3c09dd1d9a3a2aa7e193f166eec3ad6d43dd9616b9ffef557d237d07089132a5a75c3ed6762eb1c40546fcdb98b030
+  metadata.gz: 61bfa339a1c364fcededa512391ac3a43a57d102d41e95bb47782d920c6835a430b27ebd169323b22e8a555bcecff0150ba758f495ca778fb92c822c53184ea7
+  data.tar.gz: 7bcbc2632129f06dc3c429264b5d56820cfacae1fa5b709b636eabc0a5e343d0ffd24389dbd65e34d16308b27aba3da35a35f2729968fe3c9732dc2b3c91d345

data/.travis.yml

@@ -1,5 +1,8 @@
 language: ruby
 rvm:
   - 1.9.3
-  - jruby-19mode
   - 2.0.0
+  - 2.1.5
+  - 2.2.0
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-2.2.10

data/Changelog.md

@@ -0,0 +1,85 @@
+# 2.0.0
+
+  * added support for full brand names
+  * added possibility to remove card brands globally
+  * support for procs using :brand option for CreditCardNumberValidator
+  * :only and :except options for CreditCardNumberValidator
+  * credit card generator
+  * test unit -> specs migration
+  * card rules structure changed to allow custom options
+  * yaml storage implemented
+  * Maestro detection fix
+  * JCB detection fix
+
+
+# 1.5.1
+
+  * Maestro detection fix
+
+# 1.5.0
+
+  * Rupay detection support
+  * Hipercard detection support
+
+# 1.4.7
+
+  * Maestro and Switch detection fix
+
+# 1.4.6
+
+  * JCB detection fix
+
+# 1.4.5
+
+  * Diners detection fix
+
+# 1.4.4
+
+  * Visa detection fix
+
+# 1.4.3
+
+  * fix for Rails 4.+ dependency
+  * Maestro detection fixes
+
+# 1.4.2
+
+  * fix for Rails 4.1 dependency
+  * UnionPay and Discover detection fixes
+
+# 1.4.1
+
+  * fixed ActiveModel Validator syntax
+
+# 1.4.0
+
+  *  Dankrot brand support
+
+# 1.3.0
+
+  * MMI detection support
+
+# 1.2.0
+
+  * Allow brand restriction when detecting brand
+  * fix for Rails 4.0 dependency
+  * Allow to skip Luhn validation for certain brands
+
+# 1.1.2
+
+  * Credit card number sanitizing fix
+  * :any instead of brand name can be used with ActiveModel Validator
+
+# 1.1.1
+
+  * ActiveModel Validator was moved from root namespace
+
+# 1.1.0
+
+  * Added rules for Maestro brand
+  * String extension added
+
+# 1.0.1
+
+  * Dependency fixes
+  * Added usage instructions to README

data/README.md

@@ -1,12 +1,17 @@
 # CreditCardValidations
 
+[![Build Status](http://img.shields.io/travis/Fivell/credit_card_validations.svg)](https://travis-ci.org/Fivell/credit_card_validations)
+[![Dependency Status](http://img.shields.io/gemnasium/Fivell/credit_card_validations.svg)](https://gemnasium.com/Fivell/credit_card_validations)
+[![Coverage Status](http://img.shields.io/coveralls/Fivell/credit_card_validations.svg)](https://coveralls.io/r/Fivell/credit_card_validations)
+[![Code Climate](http://img.shields.io/codeclimate/github/Fivell/credit_card_validations.svg)](https://codeclimate.com/github/Fivell/credit_card_validations)
+[![Gem Version](http://img.shields.io/gem/v/credit_card_validations.svg)](https://rubygems.org/gems/credit_card_validations)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://Fivell.mit-license.org)
+
+
 Gem adds validator  to check whether or not a given number actually falls within the ranges of possible numbers prior to performing such verification, and, as such, CreditCardValidations simply verifies that the credit card number provided is well-formed.
 
 More info about card BIN numbers http://en.wikipedia.org/wiki/Bank_card_number
 
-[![Build Status](https://travis-ci.org/Fivell/credit_card_validations.png)](https://travis-ci.org/Fivell/credit_card_validations)
-[![Coverage Status](https://coveralls.io/repos/Fivell/credit_card_validations/badge.png)](https://coveralls.io/r/Fivell/credit_card_validations)
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -50,9 +55,11 @@ Examples using string monkey patch
 
 ```ruby
     require 'credit_card_validations/string'
-    '5274 5763 9425 9961'.credit_card_brand
-    '5274 5763 9425 9961'.valid_credit_card_brand?(:mastercard, :visa)  
-    '5274 5763 9425 9961'.valid_credit_card_brand?(:amex)  
+    '5274 5763 9425 9961'.credit_card_brand   #=> :mastercard
+    '5274 5763 9425 9961'.credit_card_brand_name   #=> "MasterCard"
+    '5274 5763 9425 9961'.valid_credit_card_brand?(:mastercard, :visa) #=> true
+    '5274 5763 9425 9961'.valid_credit_card_brand?(:amex) #=> false
+    '5274 5763 9425 9961'.valid_credit_card_brand?('MasterCard') #=> true
 ```
 
 ActiveModel support
@@ -85,13 +92,13 @@ Examples using CreditCardValidations::Detector class
     detector.issuer_category  #"Banking and financial"
 ```
 
-Also You can add your own rules to detect other credit card brands/types
+Also You can add your own brand rules to detect other credit card brands/types
 passing name,length(integer/array of integers) and prefix(string/array of strings)
 Example
 
 ```ruby	
-    CreditCardValidations.add_rule(:voyager, {length: 15, prefixes: '86'})
-    CreditCardValidations.add_rule(:en_route, {length: 15, prefixes: ['2014', '2149'], skip_luhn: true}) #skip luhn
+    CreditCardValidations.add_brand(:voyager, {length: 15, prefixes: '86'})
+    CreditCardValidations.add_brand(:en_route, {length: 15, prefixes: ['2014', '2149']}, {skip_luhn: true}) #skip luhn
           
     voyager_test_card_number = '869926275400212'
     CreditCardValidations::Detector.new(voyager_test_card_number).brand #:voyager
@@ -102,6 +109,14 @@ Example
     CreditCardValidations::Detector.new(en_route_test_card_number).en_route? #true
 ```
 
+Remove brands also supported
+
+```ruby
+    CreditCardValidations.delete_brand(:maestro)
+```
+
+
+
 Check luhn
 
 ```ruby	
@@ -110,6 +125,14 @@ Check luhn
     CreditCardValidations::Luhn.valid?(@credit_card_number)
 ```  
 
+Generate credit card numbers that pass validation
+
+```ruby
+ CreditCardValidations::Factory.random(:amex)
+ # => "348051773827666"
+ CreditCardValidations::Factory.random(:maestro)
+ # => "6010430241237266856"
+```
 
 ## Contributing
 

data/Rakefile

@@ -3,11 +3,11 @@ require 'bundler/gem_tasks'
 require 'rake'
 require 'rake/testtask'
 
-task :default => [:test_units]
+task :default => [:specs]
 
-desc "Run basic tests"
-Rake::TestTask.new("test_units") { |t|
-  t.pattern = 'test/*_test.rb'
+desc "Run basic specs"
+Rake::TestTask.new("specs") { |t|
+  t.pattern = 'spec/*_spec.rb'
   t.verbose = true
   t.warning = true
 }

data/credit_card_validations.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = CreditCardValidations::VERSION
   gem.authors       = ["Igor"]
   gem.email         = ["fedoronchuk@gmail.com"]
-  gem.description   = %q{A ruby gem for validating credit card numbers (a port of ZF2 Zend\Validator\CreditCard)}
-  gem.summary       = "gem for credit card numbers validation, card brands detections"
+  gem.description   = %q{A ruby gem for validating credit card numbers}
+  gem.summary       = "gem should be used for credit card numbers validation, card brands detections, luhn checks"
   gem.homepage      = "https://github.com/Fivell/credit_card_validations"
   gem.license     = 'MIT'
   

data/lib/active_model/credit_card_number_validator.rb

@@ -1,15 +1,80 @@
+# == ActiveModel Validations CreditCardNumberValidator
+#  Can  be used in combination with the +validates+ method
+#
+#   Only Amex and Maestro
+#
+#   class CreditCard
+#     attr_accessor :number
+#     include ActiveModel::Validations
+#     validates :number, credit_card_number: {only: [:amex, :maestro]}
+#   end
+#
+#   All numbers are valid except Maestro
+#
+#  class CreditCard
+#     attr_accessor :number
+#     include ActiveModel::Validations
+#     validates :number, credit_card_number: {except: [:maestro]}
+#  end
+#
+#  Proc can be used as well
+#
+#  class CreditCard
+#     attr_accessor :number, :card_type
+#     include ActiveModel::Validations
+#     validates :number, credit_card_number: {brands: ->{|record|  Array(record.accepted_brands) }  }
+#
+#     def accepted_brands
+#       if card_type == 'Maestro'
+#         :maestro
+#       elsif card_type == 'American Express'
+#         :amex
+#       else
+#         :visa
+#       end
+#     end
+#
+#  end
+#
+#
+
 module ActiveModel
   module Validations
     class CreditCardNumberValidator < EachValidator
 
       def validate_each(record, attribute, value)
-        brands = options.fetch(:brands, :any)
-        record.errors.add(attribute) unless credit_card_valid?(value, brands == :any ? [] : Array.wrap(brands))
+        record.errors.add(attribute) unless credit_card_valid?(value, extract_brands(record, options))
       end
 
       def credit_card_valid?(number, brands = [])
         CreditCardValidations::Detector.new(number).valid?(*brands)
       end
+
+      protected
+
+      def extract_brands(record, options)
+        if options.has_key?(:brands)
+          with_brands(record, options[:brands])
+        elsif options.has_key?(:only)
+          Array(options[:only])
+        elsif options.has_key?(:except)
+          Array(CreditCardValidations::Detector.brands.keys) - Array(options[:except])
+        else
+          []
+        end
+
+      end
+
+      def with_brands(record, brands)
+        if brands.is_a?(Proc)
+          brands.call(record)
+        elsif options[:brands] == :any
+          []
+        else
+          Array(options[:brands])
+        end
+      end
+
     end
   end
 end

data/lib/credit_card_validations.rb

@@ -3,25 +3,33 @@ require 'active_model'
 require 'active_support/core_ext'
 require 'active_model/validations'
 require 'active_model/credit_card_number_validator'
+require 'yaml'
 
 module CreditCardValidations
-   extend ActiveSupport::Autoload
-   autoload :VERSION, 'credit_card_validations/version'
-   autoload :Luhn, 'credit_card_validations/luhn'
-   autoload :CardRules , 'credit_card_validations/card_rules'
-   autoload :Detector , 'credit_card_validations/detector'
-   autoload :Mmi, 'credit_card_validations/mmi'
-   
-   def self.add_rule(name, options)
-     CreditCardValidations::Detector.add_rule(name, options.fetch(:length), options.fetch(:prefixes), options.fetch(:skip_luhn, false))   
-   end
-   
-   CardRules.rules.each do |name, rules|
-     rules.each do |rule_value|
-        add_rule(name, rule_value)
-     end
-   end
-end  
+  extend ActiveSupport::Autoload
+  autoload :VERSION, 'credit_card_validations/version'
+  autoload :Luhn, 'credit_card_validations/luhn'
+  autoload :Detector, 'credit_card_validations/detector'
+  autoload :Factory, 'credit_card_validations/factory'
+  autoload :Mmi, 'credit_card_validations/mmi'
+
+
+  def self.add_brand(key, rules, options = {})
+    Detector.add_brand(key, rules, options)
+  end
+
+  DATA = YAML.load_file(File.join(File.dirname(__FILE__),  'data', 'brands.yaml')) || {}
+
+  def self.reload!
+    Detector.brands = {}
+    DATA.each do |key, data|
+      add_brand(key, data.fetch(:rules), data.fetch(:options, {}))
+    end
+  end
+
+end
+
+CreditCardValidations.reload!
 
 
 

data/lib/credit_card_validations/detector.rb

@@ -1,10 +1,13 @@
+# == CreditCardValidations Detector
+#
+# class provides credit card number validations
 module CreditCardValidations
   class Detector
 
     include Mmi
 
-    class_attribute :rules
-    self.rules = {}
+    class_attribute :brands
+    self.brands = {}
 
     attr_reader :number
 
@@ -12,24 +15,21 @@ module CreditCardValidations
       @number = number.to_s.tr('- ', '')
     end
 
-    # credit card number
+    # credit card number validation
     def valid?(*brands)
       !!valid_number?(*brands)
     end
 
     #brand name
-    def brand(*brands)
-      valid_number?(*brands)
+    def brand(*keys)
+      valid_number?(*keys)
     end
 
-    def valid_number?(*brands)
-      number_length = number.length
-      brand_rules = brands.blank? ? self.rules : self.rules.slice(*brands.map { |el| el.downcase })
-      unless brand_rules.blank?
-        brand_rules.each do |brand_name, rules|
-          rules.each do |rule|
-            return brand_name if ((rule[:skip_luhn] || valid_luhn?) and rule[:length].include?(number_length) and number.match(rule[:regexp]))
-          end
+    def valid_number?(*keys)
+      selected_brands = keys.blank? ? self.brands : resolve_keys(*keys)
+      if selected_brands.any?
+        selected_brands.each do |key, brand|
+          return key if matches_brand?(brand)
         end
       end
       nil
@@ -40,30 +40,113 @@ module CreditCardValidations
       @valid_luhn ||= Luhn.valid?(number)
     end
 
+    def brand_name
+      self.class.brand_name(brand)
+    end
+
+    protected
+
+    def resolve_keys(*keys)
+      brand_keys = keys.map do |el|
+        if el.is_a? String
+          #try to find key by name
+          el = (self.class.brand_key(el) || el).to_sym
+        end
+        el.downcase
+      end
+      self.brands.slice(*brand_keys)
+    end
+
+    def matches_brand?(brand)
+      rules = brand.fetch(:rules)
+      options = brand.fetch(:options, {})
+
+      rules.each do |rule|
+        if (options[:skip_luhn] || valid_luhn?) &&
+            rule[:length].include?(number.length) &&
+            number.match(rule[:regexp])
+          return true
+        end
+      end
+      false
+    end
+
     class << self
 
-      #create regexp by array of prefixes
-      def compile_regexp(prefixes)
-        Regexp.new("^((#{prefixes.join(")|(")}))")
+      def has_luhn_check_rule?(key)
+        !brands[key].fetch(:options, {}).fetch(:skip_luhn, false)
+      end
+
+      #
+      # add brand
+      #
+      #   CreditCardValidations.add_brand(:en_route, {length: 15, prefixes: ['2014', '2149']}, {skip_luhn: true}) #skip luhn
+      #
+      def add_brand(key, rules, options = {})
+
+        brands[key] = {rules: [], options: options || {}}
+
+        Array.wrap(rules).each do |rule|
+          add_rule(key, rule[:length], rule[:prefixes])
+        end
+
+        define_brand_method(key)
+
+      end
+
+      def brand_name(brand_key)
+        brand = brands[brand_key]
+        if brand
+          brand.fetch(:options, {})[:brand_name] || brand_key.to_s.titleize
+        else
+          nil
+        end
+
+      end
+
+      def brand_key(brand_name)
+        brands.detect do |_, brand|
+          brand[:options][:brand_name] == brand_name
+        end.try(:first)
+      end
+
+      # CreditCardValidations.delete_brand(:en_route)
+      def delete_brand(key)
+        key = key.to_sym
+        undef_brand_method(key)
+        brands.reject! { |k, _| k == key }
       end
 
       #create rule for detecting brand
-      def add_rule(brand, length, prefixes, skip_luhn = false)
-        prefixes = Array.wrap(prefixes)
-        length = Array.wrap(length)
-        rules[brand] = [] if rules[brand].blank?
-        rules[brand] << {length: length, regexp: compile_regexp(prefixes), prefixes: prefixes, skip_luhn: skip_luhn}
+      def add_rule(key, length, prefixes)
+        unless brands.has_key?(key)
+          raise RuntimeError.new("brand #{key} is undefined, please use #add_brand method")
+        end
+        length, prefixes = Array(length), Array(prefixes)
+        brands[key][:rules] << {length: length, regexp: compile_regexp(prefixes), prefixes: prefixes}
+      end
 
-        define_method "#{brand}?".to_sym do
-          valid?(brand)
-        end unless method_defined?  "#{brand}?".to_sym
+      protected
 
-        rules[brand]
+      # create methods like visa?,  maestro? etc
+      def define_brand_method(key)
+        define_method "#{key}?".to_sym do
+          valid?(key)
+        end unless method_defined? "#{key}?".to_sym
       end
-    end
 
+      def undef_brand_method(key)
+        undef_method "#{key}?".to_sym if method_defined? "#{key}?".to_sym
+      end
 
-  end
 
+      #create regexp by array of prefixes
+      def compile_regexp(prefixes)
+        Regexp.new("^((#{prefixes.join(")|(")}))")
+      end
+
+    end
+
+  end
 
 end