credit_card_validator 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-03-12
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/credit_card_validator.rb
+lib/credit_card_validator/validator.rb
+test/test_credit_card_validator.rb
+test/test_helper.rb

data/README.rdoc

@@ -0,0 +1,70 @@
+= credit_card_validator
+
+* http://github.com/tobias/credit_card_validator
+
+== DESCRIPTION:
+
+A gem that provides credit card validation. It is basically a ruby port of the javascript credit card validator by Thomas Fuchs (madrobby) (http://github.com/madrobby/creditcard_js).
+
+== SYNOPSIS:
+
+Usage:
+  CreditCardValidator::Validator.valid?('1111 2222 3333 4444')
+
+  # allow test numbers to be valid (for development) 
+  CreditCardValidator::Validator.options[:test_numbers_are_valid] = true
+  CreditCardValidator::Validator.valid?('1111 2222 3333 4444')
+
+  # limit the card types you allow
+  CreditCardValidator::Validator.options[:allowed_card_types] = [:visa, :mastercard]
+  CreditCardValidator::Validator.valid?('1111 2222 3333 4444')
+
+Supported card types:
+  :amex, :discover, :diners_club, :master_card, :visa
+
+Whitespace is stripped from the number automatically.
+
+The following things are tested:
+1. does the luhn validation code add up? (see http://en.wikipedia.org/wiki/Luhn_algorithm)
+2. does the number range and length seem right? (see http://en.wikipedia.org/wiki/Bank_card_number)
+3. is it one of several well-known test numbers?
+
+Note: this only validates that the number is of a valid format, it does not check if it is an actual credit card number. You will need to talk to your payment gateway to learn that.
+
+You can also use the validator to learn about the type of the card:
+
+  # gives the type back as a string (visa, master_card, etc)
+  CreditCardValidator::Validator.card_type(number)
+  
+  CreditCardValidator::Validator.is_visa?(number)
+  CreditCardValidator::Validator.is_master_card?(number)
+  # etc. - works for all of the supported card types
+
+  CreditCardValidator::Validator.is_allowed_card_type?(number)
+
+== INSTALL:
+
+* gem install tobias-credit_card_validator --source http://gems.github.com
+
+== LICENSE:
+
+Copyright (c) 2009 Tobias Crawley & Bruce Hauman
+
+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/Rakefile

@@ -0,0 +1,27 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/credit_card_validator'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('credit_card_validator', CreditCardValidator::VERSION) do |p|
+  p.developer('Tobias Crawley', 'tcrawley@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/credit_card_validator.rb

@@ -0,0 +1,8 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require File.join(File.dirname(__FILE__), 'credit_card_validator', 'validator')
+
+module CreditCardValidator
+  VERSION = '0.1.0'
+end

data/lib/credit_card_validator/validator.rb

@@ -0,0 +1,87 @@
+module CreditCardValidator
+  CARD_TYPES = {
+    :visa => /^4[0-9]{12}(?:[0-9]{3})?$/,
+    :master_card => /^5[1-5][0-9]{14}$/,
+    :diners_club => /^3(?:0[0-5]|[68][0-9])[0-9]{11}$/,
+    :amex => /^3[47][0-9]{13}$/,
+    :discover => /^6(?:011|5[0-9]{2})[0-9]{12}$/
+  }
+
+  TEST_NUMBERS = %w{
+    378282246310005 371449635398431 378734493671000
+    30569309025904 38520000023237 6011111111111117
+    6011000990139424 5555555555554444 5105105105105100
+    4111111111111111 4012888888881881 4222222222222
+  }
+  
+  class Validator
+    class << self
+      def valid?(number)
+        is_allowed_card_type?(number) and
+          verify_luhn(number) and
+          card_type(number) and
+          (options[:test_numbers_are_valid] ? true : !is_test_number(number))
+      end
+    
+      def options
+        @@options ||= {}
+      end
+    
+      def card_type(number)
+        CARD_TYPES.keys.each do |t|
+          return t.to_s if card_is(t, number)
+        end
+        nil
+      end
+    
+      def is_allowed_card_type?(number)
+        card_type = card_type(number)
+        if options[:allowed_card_types] and options[:allowed_card_types].respond_to?('include?')
+          options[:allowed_card_types].include?(card_type.to_sym)
+        else
+          !card_type.nil?
+        end
+      end
+    
+      def is_test_number(number)
+        TEST_NUMBERS.include?(strip(number))
+      end
+
+      def verify_luhn(number)
+        total = strip(number).reverse().split(//).inject([0,0]) do |accum,n|
+          n = n.to_i
+          accum[0] += (accum[1] % 2 == 1  ? rotate(n * 2)  : n)
+          accum[1] += 1
+          accum
+        end
+        
+        (total[0] % 10 == 0)
+      end
+      
+      CARD_TYPES.keys.each do |card_type|
+        self.class_eval do
+          define_method "is_#{card_type.to_s}?" do |number|
+            card_is(card_type, number)
+          end
+        end
+      end
+      
+      protected
+      def strip(number)
+        number.gsub(/\s/,'')
+      end
+      
+      def rotate(number)
+        if number > 9
+          number = number % 10 + 1
+        end
+        number
+      end
+      
+      def card_is(type, number)
+        type = type.to_sym
+        (CARD_TYPES[type] and strip(number) =~ CARD_TYPES[type])
+      end
+    end
+  end
+end

data/test/test_credit_card_validator.rb

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestCreditCardValidator < Test::Unit::TestCase
+
+  def setup
+    @v = CreditCardValidator::Validator
+    @v.options.clear
+  end
+  
+  
+  def test_recognize_card_type
+    assert_equal 'visa', @v.card_type('4111111111111111')
+    assert_equal 'master_card', @v.card_type('5555555555554444')
+    assert_equal 'diners_club', @v.card_type('30569309025904')
+    assert_equal 'amex', @v.card_type('371449635398431')
+    assert_equal 'discover', @v.card_type('6011000990139424')
+
+  end
+
+  def test_detect_specific_types
+    assert @v.is_visa?('4111111111111111')
+    assert !@v.is_visa?('5555555555554444')
+    assert !@v.is_visa?('30569309025904')
+    assert !@v.is_visa?('371449635398431')
+    assert !@v.is_visa?('6011000990139424')
+    assert @v.is_master_card?('5555555555554444')
+    assert @v.is_diners_club?('30569309025904')
+    assert @v.is_amex?('371449635398431')
+    assert @v.is_discover?('6011000990139424')
+  end
+
+  def  test_luhn_verification
+    assert @v.verify_luhn('49927398716')
+    assert @v.verify_luhn('049927398716')
+    assert @v.verify_luhn('0049927398716')
+    assert !@v.verify_luhn('49927398715')
+    assert !@v.verify_luhn('49927398717')
+  end
+
+  def test_ignore_whitespace
+    assert_equal '4111111111111111', @v.send('strip', '4111 1111 1111 1111 ')
+
+    assert_equal 'visa', @v.card_type('4111 1111 1111 1111 ')
+    assert_equal 'visa', @v.card_type(' 4111 1111 1111 1111 ')
+    assert_equal 'visa', @v.card_type("\n4111 1111\t 1111 1111 ")
+    assert @v.verify_luhn(' 004 992739 87 16')
+    assert @v.is_test_number('601 11111111111 17')
+  end
+
+  def test_should_recognize_test_numbers
+     %w(
+    378282246310005 371449635398431 378734493671000
+    30569309025904 38520000023237 6011111111111117
+    6011000990139424 5555555555554444 5105105105105100
+    4111111111111111 4012888888881881 4222222222222
+  ).each do |n|
+      assert @v.is_test_number(n)
+    end
+
+    assert !@v.is_test_number('1234')
+  end
+  
+  def test_test_number_validity_cases
+    assert !@v.valid?('378282246310005')
+    @v.options[:test_numbers_are_valid] = true
+    assert @v.valid?('378282246310005')
+  end
+
+  def test_is_allowed_card_type
+    assert @v.is_allowed_card_type?('378282246310005')
+    @v.options[:allowed_card_types] = [:visa]
+    assert @v.is_allowed_card_type?('4012888888881881')
+    assert !@v.is_allowed_card_type?('378282246310005')
+
+  end
+    
+  def test_card_type_allowance
+    @v.options[:test_numbers_are_valid] = true
+    assert @v.valid?('378282246310005')
+    @v.options[:allowed_card_types] = [:visa]
+    assert @v.valid?('4012888888881881')
+    assert !@v.valid?('378282246310005')
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/credit_card_validator'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: credit_card_validator
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tobias Crawley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-04 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: A gem that provides credit card validation. It is basically a ruby port of the javascript credit card validator by Thomas Fuchs (madrobby) (http://github.com/madrobby/creditcard_js).
+email: 
+- tcrawley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/credit_card_validator.rb
+- lib/credit_card_validator/validator.rb
+- test/test_credit_card_validator.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/tobias/credit_card_validator
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: credit_card_validator
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A gem that provides credit card validation
+test_files: 
+- test/test_credit_card_validator.rb
+- test/test_helper.rb