credit_card_support 1.0.0

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development, :test do
+  gem "activemodel" # for rails validations
+  gem "rspec"
+  gem "yard"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 mxrguspxrt
+
+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,119 @@
+CreditCardSupport
+=================
+
+Intro
+-----
+
+* Internationalization and localization support for validations
+* At the moment knows AMEX, DinersClub, Discover, Enroute, Maestro, MasterCard, JCB, Solo, VISA (if you need more, create an issue and request for it :)
+
+
+Basic usage
+-----------
+
+```ruby
+credit_card = CreditCardSupport.Instrument.new(
+  number: '4222222222222',
+  expire_year: 13,
+  expire_month: 11,
+  holder_name: 'A B'         # optional!
+  verification: '1234'       # optional!
+)
+
+credit_card.expired?          # returns false
+credit_card.expire_date       # Date (last day of the month for expire month)
+credit_card.issuer            # VISA
+credit_card.is_testcard?     # true
+```
+
+For better understanding read the source and RSpec.
+
+
+Validations support
+-------------------
+
+### Define
+
+##### ActiveRecord or Mongoid
+
+```ruby
+class CreditCard < ActiveRecord::Base
+
+  attr_accessable :number, :expiry_year, :expiry_month
+
+  validates :number, credit_card: {
+                                    expiry_year: :expiry_year,                # default: :expiry_year
+                                    expiry_month: :expiry_month,              # default: :expiry_month
+                                    allowed_issuers: [:visa, :mastercard],    # default: all known issuers
+                                    allow_testcards: !Rails.env.production?   # default: False
+                                  }
+
+end
+```
+
+##### Only ActiveModel
+
+```ruby
+class CreditCard
+  extend  ActiveModel::Naming
+  extend  ActiveModel::Translation
+  include ActiveModel::Validations
+  include ActiveModel::Conversion
+
+  attr_accessor :number, :expiry_year, :expiry_month
+  attr_accessable :number, :expiry_year, :expiry_month
+
+  validates :number, credit_card: {
+                                    expiry_year: :expiry_year,                # default: :expiry_year
+                                    expiry_month: :expiry_month,              # default: :expiry_month
+                                    allowed_issuers: [:visa, :mastercard],    # default: all known issuers
+                                    allow_testcards: !Rails.env.production?   # default: False
+                                  }
+
+end
+```
+
+### Use
+
+After you have defined your CreditCard
+
+```ruby
+today      = Date.today
+```
+
+```ruby
+# RAILS_ENV == 'test'
+creditcard = CreditCard.new(number: '4000111111111115', expiry_year: today.year, expiry_month: today.month)
+creditcard.valid? # True
+
+# RAILS_ENV == 'production'
+creditcard = CreditCard.new(number: '4000111111111115', expiry_year: today.year, expiry_month: today.month)
+creditcard.valid? # False
+creditcard.errors # {number: ["is a test number"]}
+
+# RAILS_ENV == 'test'
+creditcard = CreditCard.new(number: '3566003566003566', expiry_year: today.year-1, expiry_month: today.month)
+creditcard.valid? # False
+creditcard.errors # {number: ["is a JCB card number and is not supported", expiry_year: ["is in the past"], expiry_month: ["is in the past"]]}
+
+```
+
+
+Problems?
+=========
+
+Create an issue or submit a patch.
+
+
+Inspired by
+===========
+
+* https://github.com/tobias/credit_card_validator
+* https://github.com/pda/am_credit_card
+* http://rubygems.org/gems/creditcard
+
+
+Author
+======
+
+Margus Pärt

data/lib/credit_card_support/credit_card_validator.rb

@@ -0,0 +1,78 @@
+raise "ActiveModel not included" unless Object.const_defined?(:ActiveModel)
+I18n.load_path << File.dirname(__FILE__) + '/locale/en.yml'
+
+class CreditCardValidator < ActiveModel::EachValidator
+
+  def validate_each(record, attribute, value)
+    @record          = record
+
+    opts              = options.dup
+    opts[:number]     ||= attribute
+
+    number            = record.send(opts[:number]||:number) rescue (raise ":number not defined")
+    expiry_year       = record.send(opts[:expiry_year]||:expiry_year) rescue (raise ":expiry_year not defined")
+    expiry_month      = record.send(opts[:expiry_month]||:expiry_month) rescue (raise ":expiry_month not defined")
+    @allowed_issuers  = opts[:allowed_issuers]
+    @allow_testcards  = opts[:allow_testcards]
+
+    @opts             = opts
+    @instrument       = CreditCardSupport::Instrument.new(number: number, expiry_year: expiry_year, expiry_month: expiry_month)
+
+    validate_number
+  end
+
+
+  private
+
+  def errors
+    @record.errors
+  end
+
+  def instrument
+    @instrument
+  end
+
+  def validate_number
+    validate_luhn
+    validate_issuer
+    validate_testcard
+    validate_expiry_year
+    validate_expiry_month
+    validate_expiration_date rescue false
+  end
+
+  def validate_luhn
+    errors.add(@opts[:number], t(:luhn_not_valid)) unless @instrument.has_valid_luhn?
+  end
+
+  def validate_issuer
+    errors.add(@opts[:number], t(:issuer_not_known)) unless @instrument.issuer
+    if @allowed_issuers and @instrument.issuer and !@allowed_issuers.map(&:to_sym).include?(@instrument.issuer)
+      errors.add(@opts[:number], t(:issuer_not_supported, issuer: @instrument.issuer.to_s.upcase))
+    end
+  end
+
+  def validate_testcard
+    errors.add(@opts[:number], t(:testcard_not_supported)) if !@allow_testcards && @instrument.is_testcard?
+  end
+
+  def validate_expiry_year
+    errors.add(@opts[:expiry_year], t(:cant_be_blank)) unless @instrument.expiry_year
+  end
+
+  def validate_expiry_month
+    errors.add(@opts[:expiry_month], t(:cant_be_blank)) unless @instrument.expiry_month
+  end
+
+  def validate_expiration_date
+    if @instrument.expired?
+      errors.add(@opts[:expiry_year], t(:cant_be_expired))
+      errors.add(@opts[:expiry_month], t(:cant_be_expired))
+    end
+  end
+
+  def t(code, *args)
+     I18n.t("credit_card_validator.messages.#{code}", *args)
+  end
+
+end

data/lib/credit_card_support/instrument.rb

@@ -0,0 +1,162 @@
+module CreditCardSupport
+
+  # Usage:
+  #
+  # credit_card = CreditCardSupport.Instrument.new(
+  #    number: '4222222222222',
+  #    expiry_year: 13,
+  #    expiry_month: 11,
+  #    holder_name: 'A B'
+  #    verification: '1234'       # optional!
+  #    )
+  #
+  # credit_card.expired?          # returns false
+  # credit_card.expiration_date   # Date (last day of the month for expiry month)
+  # credit_card.issuer            # VISA
+  # credit_card.is_testcard?      # true
+
+
+  class Instrument
+
+    NUMBERS = {
+      amex: /^3[47][0-9]{13}$/,
+      diners_club: /^3(?:0[0-5]|[68][0-9])[0-9]{11}$/,
+      discover: /^6(?:011|5[0-9]{2})[0-9]{12}$/,
+      enroute: /^2(014|149)\d{11}$/,
+      maestro: /(^6759[0-9]{2}([0-9]{10})$)|(^6759[0-9]{2}([0-9]{12})$)|(^6759[0-9]{2}([0-9]{13})$)/,
+      master_card: /^5[1-5][0-9]{14}$/,
+      jcb: /^35[0-9]{14}$/,
+      solo: /^6(3(34[5-9][0-9])|767[0-9]{2})\d{10}(\d{2,3})?$/,
+      visa: /^4[0-9]{12}(?:[0-9]{3})?$/
+    }.freeze
+
+    TESTCARD_NUMBERS = {
+      amex: [
+        '378282246310005',
+        '371449635398431',
+        '378734493671000',
+        '343434343434343',
+        '371144371144376',
+        '341134113411347'
+        ],
+      diners_club: [
+        '30569309025904',
+        '38520000023237',
+        '36438936438936'
+        ],
+      discover: [
+        '6011000990139424',
+        '6011111111111117',
+        '6011016011016011',
+        '6011000000000004',
+        '6011000995500000',
+        '6500000000000002'
+        ],
+      master_card: [
+        '5555555555554444',
+        '5105105105105100',
+        '5500005555555559',
+        '5555555555555557',
+        '5454545454545454',
+        '5555515555555551',
+        '5405222222222226',
+        '5478050000000007',
+        '5111005111051128',
+        '5112345112345114'
+        ],
+      visa: [
+        '4111111111111111',
+        '4012888888881881',
+        '4222222222222',
+        '4005519200000004',
+        '4009348888881881',
+        '4012000033330026',
+        '4012000077777777',
+        '4217651111111119',
+        '4500600000000061',
+        '4000111111111115'
+        ],
+      jcb: [
+        '3566003566003566',
+        '3528000000000007'
+      ]
+    }.freeze
+
+    def self.numbers
+      self::NUMBERS
+    end
+
+    def self.testcard_numbers
+      self::TESTCARD_NUMBERS
+    end
+
+    def self.determine_issuer(number)
+      numbers.each do |issuer, issuer_regexp|
+        return issuer if number.match(issuer_regexp)
+      end
+      nil
+    end
+
+    def self.is_testcard?(number)
+      testcard_numbers.values.flatten.include?(number)
+    end
+
+    def self.has_valid_luhn?(number)
+      CreditCardSupport::LuhnNumber.new(number).valid?
+    end
+
+    attr_accessor   :number,
+                    :expiry_year,
+                    :expiry_month,
+                    :holder_name,
+                    :verification
+
+    attr_reader :issuer
+
+    def initialize(opts={}, &block)
+      self.number       = opts[:number]
+      self.expiry_year  = opts[:expiry_year]
+      self.expiry_month = opts[:expiry_month]
+      self.holder_name  = opts[:holder_name]
+      self.verification = opts[:verification]
+
+      block.call(self) if block
+    end
+
+    def number=(number)
+      @number           = number.to_s.gsub(/[^0-9]/, '')
+      @issuer           = self.class.determine_issuer(self.number)
+      @is_testcard      = self.class.is_testcard?(self.number)
+      @has_valid_luhn   = self.class.has_valid_luhn?(self.number)
+    end
+
+    def expiry_year=(expiry_year)
+      @expiry_year = expiry_year.to_i if expiry_year
+    end
+
+    def expiry_month=(expiry_month)
+      @expiry_month = expiry_month.to_i if expiry_month
+    end
+
+    def expiry_year
+      (@expiry_year < 1900 ? 2000 + @expiry_year : @expiry_year) if @expiry_year
+    end
+
+    def expiration_date
+      Date.new(expiry_year, expiry_month, -1)
+    end
+
+    def expired?
+      expiration_date < Date.today
+    end
+
+    def is_testcard?
+      @is_testcard
+    end
+
+    def has_valid_luhn?
+      @has_valid_luhn
+    end
+
+  end
+end

data/lib/credit_card_support/locale/en.yml

@@ -0,0 +1,9 @@
+en:
+  credit_card_validator:
+    messages:
+      luhn_not_valid: "is not valid"
+      issuer_not_known: "not known issuer"
+      issuer_not_supported: "%{issuer} not supported"
+      testcard_not_supported: "testcards not supported"
+      cant_be_blank: "can't be blank"
+      is_expired: "is expired"

data/lib/credit_card_support/luhn_number.rb

@@ -0,0 +1,44 @@
+module CreditCardSupport
+
+  class LuhnNumber
+
+    attr_accessor :full_number
+
+    def initialize(full_number)
+      self.full_number = full_number
+    end
+
+    def full_number=(full_number)
+      @full_number = full_number.gsub(/[^0-9]/, '').to_s
+    end
+
+    def number_part
+      full_number[0, full_number.length-1] if full_number
+    end
+
+    def check_digit_part
+      full_number[-1, 1] if full_number
+    end
+
+    def valid?
+      return false unless full_number and full_number.length > 2
+      parts   = full_number.split(//).map(&:to_i)
+
+      double  = parts.length % 2 == 0
+      parts   = parts.collect do |part|
+        number  = double ? part*2 : part
+        double  = !double
+        number
+      end
+
+      sum     = parts.join("").split(//).map(&:to_i).inject(:+)
+      sum % 10 == 0
+    end
+
+    def invalid?
+      !valid?
+    end
+
+  end
+
+end

data/lib/credit_card_support/version.rb

@@ -0,0 +1,9 @@
+module CreditCardSupport
+  module Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+
+    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

data/lib/credit_card_support.rb

@@ -0,0 +1,2 @@
+require 'credit_card_support/luhn_number'
+require 'credit_card_support/instrument'

data/spec/lib/credit_card_support/credit_card_validator_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+require 'active_model'
+require 'credit_card_support/credit_card_validator'
+
+
+class CreditCard
+  extend  ActiveModel::Naming
+  extend  ActiveModel::Translation
+  include ActiveModel::Validations
+  include ActiveModel::Conversion
+
+  attr_accessor :number, :expiry_year, :expiry_month
+
+  def initialize(opts={})
+    @errors = ActiveModel::Errors.new(self)
+    opts.each do |k,v|
+      send(:"#{k}=", v)
+    end
+  end
+
+end
+
+class CreditCardTest < CreditCard
+  validates :number, credit_card: {
+                              expiry_year: :expiry_year,
+                              expiry_month: :expiry_month,
+                              allowed_issuers: [:visa, :mastercard],
+                              allow_testcards: true
+                            }
+end
+
+class CreditCardProduction < CreditCard
+  validates :number, credit_card: {
+                              expiry_year: :expiry_year,
+                              expiry_month: :expiry_month,
+                              allowed_issuers: [:visa, :mastercard],
+                              allow_testcards: false
+                            }
+end
+
+
+
+describe CreditCardValidator do
+  let(:today) { Date.today }
+
+  describe "validatable" do
+
+    subject { CreditCardTest.new(number: '4012888888881881', expiry_year: today.year, expiry_month: today.month) }
+
+    it "is valid" do
+      subject.should be_valid
+    end
+
+    describe "#number" do
+      it "must exist" do
+        subject.number = nil
+        subject.should_not be_valid
+      end
+      it "must be luhn" do
+        subject.number = '4000111111111116'
+        subject.should_not be_valid
+      end
+      context "production" do
+        subject { CreditCardProduction.new(number: '4485071359608368', expiry_year: today.year, expiry_month: today.month) }
+        context "testnumber" do
+          it "is invalid" do
+            subject.number = '4012888888881881'
+            subject.should be_invalid
+          end
+        end
+        context "valid number" do
+          it "is valid" do
+            subject.should be_valid
+          end
+        end
+      end
+    end
+
+    describe "#expiry_year" do
+      it "must exist" do
+        subject.expiry_year = nil
+        subject.should_not be_valid
+      end
+      context "in the future" do
+        it "is valid" do
+          subject.expiry_year = today.year + 1
+          subject.should be_valid
+        end
+      end
+      context "in the past" do
+        it "is invalid" do
+          subject.expiry_year = today.year - 1
+          subject.should be_invalid
+        end
+      end
+    end
+
+    describe "#expiry_month" do
+      it "must exist" do
+        subject.expiry_month = nil
+        subject.should_not be_valid
+      end
+      context "in the future" do
+        it "is valid" do
+          subject.expiry_month = today.month + 1
+          subject.should be_valid
+        end
+      end
+      context "in the past" do
+        it "is invalid" do
+          subject.expiry_month = today.month - 1
+          subject.should be_invalid
+        end
+      end
+    end
+
+  end
+
+end
+

data/spec/lib/credit_card_support/instrument_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+require 'date'
+
+describe CreditCardSupport::Instrument do
+  let(:today) { Date.today }
+  subject { described_class.new(number: 4222222222222, expiry_year: "#{today.year}", expiry_month: "12", holder_name: 'A B', verification: '1234') }
+
+  describe ".numbers" do
+    it "returns hash containing of issuer: number_regexp" do
+      described_class.numbers.should be_a(Hash)
+    end
+  end
+
+  describe ".testcard_numbers" do
+    it "returns hash containing of testcard numbers" do
+      described_class.testcard_numbers.should be_a(Hash)
+    end
+  end
+
+  describe ".determine_issuer" do
+    described_class.testcard_numbers.each do |issuer, numbers|
+      context "#{issuer}" do
+        it "knows the numbers" do
+          numbers.each do |number|
+            described_class.determine_issuer(number).should == issuer
+          end
+        end
+      end
+    end
+  end
+
+  describe ".is_testcard?" do
+    it "determines if number is testnumber" do
+      described_class.is_testcard?("4000111111111115").should be_true
+      described_class.is_testcard?("4000111111111116").should be_false
+    end
+  end
+
+  describe "#initialize" do
+    it "supports a hash" do
+      instrument = described_class.new(number: "123")
+      instrument.number.should == "123"
+    end
+    it "supports a block" do
+      instrument = described_class.new do |instrument_object|
+        instrument_object.number = "123"
+      end
+      instrument.number.should == "123"
+    end
+  end
+
+  describe "#number" do
+    it "returns number as a string" do
+      subject.number = "1-2-3-412345"
+      subject.number.should == "123412345"
+    end
+  end
+
+  describe "#expiry_year" do
+    it "returns expiry year as NNNN integer" do
+      subject.expiry_year = "#{today.year-2000}"
+      subject.expiry_year.should == today.year
+    end
+  end
+
+  describe "#expiry_month" do
+    it "returns expiry month as NN integer" do
+      subject.expiry_month = "#{today.month}"
+      subject.expiry_month.should == today.month
+    end
+  end
+
+  describe "#expiration_date" do
+    it "returns last day of the month when expiring" do
+      subject.expiration_date.should == Date.new(today.year, 12, 31)
+    end
+  end
+
+  describe "#expired?" do
+    context "not expired" do
+      it "returns false" do
+        subject.expired?.should be_false
+      end
+    end
+    context "expired" do
+      it "returns true" do
+        subject.expiry_year = today.year
+        subject.expiry_month = today.month-1
+        subject.expired?.should be_true
+      end
+    end
+  end
+
+  describe "#is_testcard?" do
+    context "not a testcard" do
+      it "returns false" do
+        subject.number = 4222222222223
+        subject.is_testcard?.should be_false
+      end
+    end
+    context "a testcard" do
+      it "returns true" do
+        subject.number = 4222222222222
+        subject.is_testcard?.should be_true
+      end
+    end
+  end
+
+  describe "has_valid_luhn?" do
+    context "valid luhn" do
+      it "returns true" do
+        subject.number = 4222222222222
+        subject.is_testcard?.should be_true
+      end
+    end
+    context "invalid luhn" do
+      it "returns false" do
+        subject.number = 4222222222223
+        subject.is_testcard?.should be_false
+      end
+    end
+  end
+
+
+end

data/spec/lib/credit_card_support/luhn_number_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe CreditCardSupport::LuhnNumber do
+
+  subject { described_class.new("4485071359608368") }
+
+  describe "#initialize" do
+    it "sets full_number" do
+      described_class.any_instance.should_receive(:full_number=).with('123')
+      described_class.new('123')
+    end
+  end
+
+  describe "#full_number" do
+    it "returns only number part of set value" do
+      subject.full_number = '123 abc-'
+      subject.full_number.should == '123'
+    end
+  end
+
+  describe "#number_part" do
+    it "returns number part of full_number" do
+      subject.number_part.should == "448507135960836"
+    end
+  end
+
+  describe "#check_digit_part" do
+    it "returns number part of full_number" do
+      subject.check_digit_part.should == "8"
+    end
+  end
+
+  describe "#valid?" do
+    it "returns if luhn algorytm % 10 is true" do
+      subject.should be_valid
+    end
+  end
+
+  describe "#valid?" do
+    context "valid luhn" do
+      it "returns true" do
+        described_class.new("5500005555555559").should be_valid
+        described_class.new("5555555555555557").should be_valid
+        described_class.new("5454545454545454").should be_valid
+        described_class.new("5555515555555551").should be_valid
+        described_class.new("5405222222222226").should be_valid
+        described_class.new("5478050000000007").should be_valid
+      end
+    end
+    context "invalid luhn" do
+      it "returns false" do
+        described_class.new("5500005555555558").should be_invalid
+        described_class.new("5555555555555556").should be_invalid
+        described_class.new("5454545454545453").should be_invalid
+        described_class.new("5555515555555550").should be_invalid
+        described_class.new("5405222222222225").should be_invalid
+        described_class.new("5478050000000006").should be_invalid
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'credit_card_support'

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: credit_card_support
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Margus Pärt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-21 00:00:00.000000000 Z
+dependencies: []
+description: Detects issuer from number, has ActiveModel validations and translations
+  support.
+email: margus@tione.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- LICENSE.txt
+- lib/credit_card_support/credit_card_validator.rb
+- lib/credit_card_support/instrument.rb
+- lib/credit_card_support/locale/en.yml
+- lib/credit_card_support/luhn_number.rb
+- lib/credit_card_support/version.rb
+- lib/credit_card_support.rb
+- spec/lib/credit_card_support/credit_card_validator_spec.rb
+- spec/lib/credit_card_support/instrument_spec.rb
+- spec/lib/credit_card_support/luhn_number_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tione/credit_card_support
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Libary to handle CreditCard number, expiration and Luhn.
+test_files: []
+has_rdoc: