ccheck 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+TAGS

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+# Copyright (c) 2012 Jose Pablo Barrantes
+#
+# 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,134 @@
+# CCheck
+
+## Description:
+
+Ruby credit cards checker using the Luhn algorithm.
+
+## Problem
+
+Before submitting a credit card to a payment gateway it's important that
+we run some sanity checks on the number.
+
+A common check that is performed upfront is to validate the card type
+based on the starting digits and length of card number. The main
+patterns that we care about are as follows:
+
+    +============+=============+===============+
+    | Card Type  | Begins With | Number Length |
+    +============+=============+===============+
+    | AMEX       | 34 or 37    | 15            |
+    +------------+-------------+---------------+
+    | Discover   | 6011        | 16            |
+    +------------+-------------+---------------+
+    | MasterCard | 51-55       | 16            |
+    +------------+-------------+---------------+
+    | Visa       | 4           | 13 or 16      |
+    +------------+-------------+---------------+
+
+All of these card types also generate numbers such that they can be
+validated by the Luhn algorithm, so that's the second check systems
+usually try. The steps are:
+
+1.  Starting with the next to last digit and continuing with every other
+    digit going back to the beginning of the card, double the digit
+2.  Sum all doubled and untouched digits in the number. For digits
+    greater than 9 you will need to split them and sum the independently
+    (i.e. `"10", 1 + 0`).
+3.  If that total is a multiple of 10, the number is valid.
+
+For example, given the card number `4408 0412 3456 7893`:
+
+    1 8 4 0 8 0 4 2 2 6 4 10 6 14 8 18 3
+    2 8+4+0+8+0+4+2+2+6+4+1+0+6+1+4+8+1+8+3 = 70
+    3 70 % 10 == 0
+
+Thus that card is valid.
+
+Let's try one more, `4417 1234 5678 9112`:
+
+    1 8 4 2 7 2 2 6 4 10 6 14 8 18 1 2 2
+    2 8+4+2+7+2+2+6+4+1+0+6+1+4+8+1+8+1+2+2 = 69
+    3 69 % 10 != 0
+
+This card is not valid.
+
+## Features
+
+Card numbers can be passed in line by line (one set of numbers per
+line). The program will print the card in the following format:
+
+    TYPE: NUMBERS (VALIDITY)
+
+## Input and Output
+
+Given the following credit cards:
+
+    4111111111111111
+    4111111111111
+    4012888888881881
+    378282246310005
+    6011111111111117
+    5105105105105100
+    5105 1051 0510 5106
+    9111111111111111
+
+It will output the following:
+
+    VISA: 4111111111111111       (valid)
+    VISA: 4111111111111          (invalid)
+    VISA: 4012888888881881       (valid)
+    AMEX: 378282246310005        (valid)
+    Discover: 6011111111111117   (valid)
+    MasterCard: 5105105105105100 (valid)
+    MasterCard: 5105105105105106 (invalid)
+    Unknown: 9111111111111111    (invalid)
+
+## Installation:
+
+With RubyGems, open a terminal and type:
+
+    $ {sudo} gem install ccheck
+
+Local installation:
+
+    $ git clone git@bitbucket.org:jpablobr/ccheck.git
+
+then:
+
+    $ cd ccheck
+    $ rake install 
+
+or with bundler
+
+    $ cd ccheck
+    $ bundle build
+    $ bundle install
+
+## Command line Usage:
+
+    -h   --help", "Print this help."
+    -v   --version", "Print version."
+
+    examples:
+      
+    $ ccheck 4111111111111111
+    $ ccheck 4111111111111111 9111111111111111 '5105 1051 0510 5106' 
+    $ cat cards-stdin.txt | while read card; do ccheck $card; done
+    
+Note: Remember to take account of native $SHELL expansion. Proper
+character escaping and the like is required.
+
+## Running Tests
+
+    $ cd ccheck
+    $ rake
+
+## Caveats
+
+ruby 1.9.3 is required (see `.rvmrc` file).
+
+## Copyright
+
+Copyright (c) 2012 Jose Pablo Barrantes. See [LICENSE][] for details.
+
+[license]: https://bitbucket.org/jpablobr/ccheck/src/master/LICENSE

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+namespace :test do
+  Rake::TestTask.new do |t|
+    t.name         = "minitest"
+    t.libs         << 'test'
+    t.test_files   = ['test/**/test_*.rb']
+    t.verbose      = true
+  end
+end
+
+task :default => "test:minitest"

data/bin/ccheck

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# Stdout/stderr should not buffer output
+$stdout.sync = true
+$stderr.sync = true
+
+require_relative '../lib/ccheck'
+
+ARGV << '--help' if ARGV.empty?
+CCheck::CLI.new.parse_options(ARGV)

data/ccheck.gemspec

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+require File.expand_path('../lib/ccheck/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name         = 'ccheck'
+  s.homepage     = 'http://github.com/jpablobr/ccheck'
+  s.summary      = 'A small implementation of the Luhn algorithm.'
+  s.require_path = 'lib'
+  s.authors      = ['Jose Pablo Barrantes']
+  s.email        = ['xjpablobrx@gmail.com']
+  s.version      = CCheck::Version
+  s.platform     = Gem::Platform::RUBY
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path  = 'lib'
+
+  s.add_development_dependency 'minitest', '~> 2.11'
+end

data/lib/ccheck.rb

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+module CCheck
+  autoload :CLI,  'ccheck/cli'
+  autoload :Card, 'ccheck/card'
+  autoload :Luhn, 'ccheck/luhn'
+
+  class << self
+
+    # Public: Verifies if number is a valid CC number according to
+    # Luhn algorithm.
+    #
+    # number - String
+    #
+    # Return Boolean
+    def valid? number
+      Luhn.new(number).valid?
+    end
+
+    # Public: Determines CC type.
+    #
+    # number - String
+    #
+    # Return String of CC type (Visa, MC). if not found "Unknown"
+    def type number
+      Card.new(number).type
+    end
+
+    # Public: Prints to stdout CC info.
+    #
+    # Input - String or Array
+    #
+    # If parameter is a String, prints CC info.
+    # if parameter is an Array, print their info one by one.
+    #
+    def print input
+      if input.is_a? Array
+        input.each { |number| puts Card.new(number).to_s }
+      else
+        puts Card.new(input).to_s
+      end
+    end
+  end
+end

data/lib/ccheck/card.rb

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+module CCheck
+  class Card
+    attr_reader :number
+
+    # Cleans the given raw CC number.
+    #
+    # raw_number - CC raw String
+    #
+    def initialize raw_number
+      @number = cleanup(raw_number)
+    end
+
+    # Public: Determines CC type/brand.
+    #
+    # Returns CC type as a String or "Unknown" if not found.
+    def type
+      case number
+      when /^3[47]\d{13}$/          ; return "AMEX"
+      when /^4(\d{15}|\d{12})$/     ; return "VISA"
+      when /^5\d{15}|36\d{14}$/     ; return "MasterCard"
+      when /^6011\d{12}|650\d{13}$/ ; return "Discover"
+      else                            return "Unknown"
+      end
+    end
+
+    # Public: Formats CC information as such:
+    # TYPE: NUMBERS (VALIDITY)
+    #
+    # Returns CC information as a String
+    def to_s
+      "%-28s (%s)\n" % [
+        "#{type}: #{number}",
+        Luhn.new(number).valid? ? 'valid' : 'invalid'
+      ]
+    end
+
+    private
+
+    # Private: Cleans up the given CC number
+    #
+    # raw_number - as String
+    #
+    # Returns CC number as String
+    def cleanup raw_number
+      raw_number.gsub(/\D/, '')
+    end
+  end
+end

data/lib/ccheck/cli.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+module CCheck
+  class CLI
+    require 'optparse'
+
+    # Public: Parses user CLI input and sends to CCheck#print the CCs.
+    #
+    # argv - ARGV Array
+    #
+    def parse_options argv
+      opts = OptionParser.new do |o|
+        o.banner = "Usage: ccheck [-v] [-h] [CARD]"
+        o.separator ""
+        o.on("-h", "--help", "Print this help.") { $stderr.puts(opts) }
+        o.on("-v", "--version", "Print version.") { return $stderr.puts(VERSION) }
+        o.separator ""
+        o.separator "Examples:"
+        o.separator "\$ ccheck 4111111111111111"
+        o.separator "\$ ccheck 4111111111111111 9111111111111111 '5105 1051 0510 5106'"
+        o.separator "\$ cat cards-stdin.txt | while read card; do ccheck \$card; done"
+      end
+      opts.parse!(argv) rescue return $stderr.puts(opts)
+      CCheck.print(argv)
+    end
+  end
+end

data/lib/ccheck/luhn.rb

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+module CCheck
+  class Luhn
+    attr_reader :card, :digits
+
+    # Sets @card and also builds its luhn @digits.
+    #
+    # card - CC String
+    #
+    def initialize card
+      @card   = card
+      @digits = luhn_digits
+    end
+
+    # Public: Verifies that the given number is a valid CC.
+    # Basically the third step of the Luhn algorighthm.
+    # If the result is a multiple of 10, the number is valid.
+    #
+    # Returns Boolean
+    def valid?
+      digits.split('').inject(0) do |sum, digit|
+        sum + digit.to_i
+      end % 10 == 0
+    end
+
+    private
+
+    # Private: Luhn's algorithm main logic.
+    # It perfoms the first two steps.
+    #
+    # 1.  Starting with the next to last digit and continuing with
+    #     every other digit going back to the beginning of the card,
+    #     double the digit
+    #
+    # 2.  Sum all doubled and untouched digits in the number. For
+    #     digits greater than 9 you will need to split them and sum
+    #     the independently (i.e. `"10", 1 + 0`).
+    #
+    # Returns String
+    def luhn_digits
+      digits = ''
+      card.reverse.chars.each_with_index do |digit,index|
+        digits += digit if index % 2 == 0
+        digits += (digit.to_i * 2).to_s if index % 2 == 1
+      end
+      digits
+    end
+
+  end
+end

data/lib/ccheck/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding: utf-8 -*-
+module CCheck
+  Version = '0.1.0'
+end

data/test/assets/cards-stdin

@@ -0,0 +1,8 @@
+4111111111111111
+4111111111111
+4012888888881881
+378282246310005
+6011111111111117
+5105105105105100
+5105 1051 0510 5106
+9111111111111111

data/test/ccheck/test_card.rb

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require 'test_helper'
+require 'minitest/autorun'
+
+module CCheck
+  class CardTest < MiniTest::Unit::TestCase
+
+    def test_returns_the_correct_card_type
+      [
+        %w[VISA 4111111111111111],
+        %w[VISA 4111111111111],
+        %w[VISA 4012888888881881],
+        %w[AMEX 378282246310005],
+        %w[Discover 6011111111111117],
+        %w[MasterCard 5105105105105100],
+        %w[MasterCard 5105105105105106],
+        %w[Unknown 9111111111111111]
+      ].each { |card| assert_equal(card[0], Card.new(card[1]).type) }
+    end
+
+    def test_to_s_method_returns_properly_formatted_card
+      assert_equal("VISA: 4111111111111111       (valid)\n",
+             Card.new('4111111111111111').to_s)
+      assert_equal("MasterCard: 5105105105105100 (valid)\n" ,
+             Card.new('5105105105105100').to_s)
+      assert_equal("MasterCard: 5105105105105106 (invalid)\n" ,
+             Card.new('5105 1051 0510 5106').to_s)
+    end
+  end
+end

data/test/ccheck/test_ccheck.rb

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+require 'test_helper'
+require 'minitest/autorun'
+
+module CCheck
+  class CCheckTest < MiniTest::Unit::TestCase
+
+    def test_returns_the_correct_card_type
+      assert_equal 'VISA'       , CCheck.type('4111111111111111')
+      assert_equal 'VISA'       , CCheck.type('4111111111111')
+      assert_equal 'VISA'       , CCheck.type('4012888888881881')
+      assert_equal 'AMEX'       , CCheck.type('378282246310005')
+      assert_equal 'Discover'   , CCheck.type('6011111111111117')
+      assert_equal 'MasterCard' , CCheck.type('5105105105105100')
+      assert_equal 'MasterCard' , CCheck.type('5105 1051 0510 5106')
+      assert_equal 'Unknown'    , CCheck.type('9111111111111111')
+    end
+
+    def test_validates_if_card_is_valid_or_invalid
+      assert CCheck.valid?('4111111111111111')    , 'Invalid card'
+      refute CCheck.valid?('4111111111111')       , 'valid card'
+      assert CCheck.valid?('4012888888881881')    , 'Invalid card'
+      assert CCheck.valid?('378282246310005')     , 'Invalid card'
+      assert CCheck.valid?('6011111111111117')    , 'Invalid card'
+      assert CCheck.valid?('5105105105105100')    , 'Invalid card'
+      refute CCheck.valid?('5105 1051 0510 5106') , 'valid card'
+      refute CCheck.valid?('9111111111111111')    , 'valid card'
+    end
+
+    def test_print_method_can_accept_an_array_of_cards
+      assert_output(EXP_CARDS_STDOUT) { CCheck.print(CARDS) }
+    end
+  end
+end

data/test/ccheck/test_cli.rb

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require 'test_helper'
+require 'minitest/autorun'
+
+module CCheck
+  class CLITest < MiniTest::Unit::TestCase
+
+    def test_validates_multiple_card_input
+      assert_output(EXP_CARDS_STDOUT) { CLI.new.parse_options(CARDS) }
+    end
+
+    def test_validates_single_card_input
+      assert_output(EXP_CARD_STDOUT) { CLI.new.parse_options(STDIN_CARD) }
+    end
+  end
+end

data/test/ccheck/test_luhn.rb

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require 'test_helper'
+require 'minitest/autorun'
+
+module CCheck
+  class LuhnTest < MiniTest::Unit::TestCase
+
+    def test_validates_card
+      assert Luhn.new('4111111111111111').valid?    , 'Invalid card'
+      refute Luhn.new('4111111111111').valid?       , 'valid card'
+      assert Luhn.new('4012888888881881').valid?    , 'Invalid card'
+      assert Luhn.new('378282246310005').valid?     , 'Invalid card'
+      assert Luhn.new('6011111111111117').valid?    , 'Invalid card'
+      assert Luhn.new('5105105105105100').valid?    , 'Invalid card'
+      refute Luhn.new('5105 1051 0510 5106').valid? , 'valid card'
+      refute Luhn.new('9111111111111111').valid?    , 'valid card'
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+lib_dir  = File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift lib_dir, File.dirname(__FILE__)
+
+require 'ccheck'
+
+CARDS = [
+  '4111111111111111', '4111111111111', '4012888888881881',
+  '378282246310005',  '6011111111111117', '5105105105105100',
+  '5105 1051 0510 5106', '9111111111111111',
+]
+
+EXP_CARDS_STDOUT = <<FORMAT
+VISA: 4111111111111111       (valid)
+VISA: 4111111111111          (invalid)
+VISA: 4012888888881881       (valid)
+AMEX: 378282246310005        (valid)
+Discover: 6011111111111117   (valid)
+MasterCard: 5105105105105100 (valid)
+MasterCard: 5105105105105106 (invalid)
+Unknown: 9111111111111111    (invalid)
+FORMAT
+
+STDIN_CARD = ['4111111111111111']
+
+EXP_CARD_STDOUT = "VISA: 4111111111111111       (valid)\n"

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: ccheck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jose Pablo Barrantes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &71844730 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: *71844730
+description: 
+email:
+- xjpablobrx@gmail.com
+executables:
+- ccheck
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ccheck
+- ccheck.gemspec
+- lib/ccheck.rb
+- lib/ccheck/card.rb
+- lib/ccheck/cli.rb
+- lib/ccheck/luhn.rb
+- lib/ccheck/version.rb
+- test/assets/cards-stdin
+- test/ccheck/test_card.rb
+- test/ccheck/test_ccheck.rb
+- test/ccheck/test_cli.rb
+- test/ccheck/test_luhn.rb
+- test/test_helper.rb
+homepage: http://github.com/jpablobr/ccheck
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: A small implementation of the Luhn algorithm.
+test_files: []
+has_rdoc: