luhnacy 0.1.0 → 0.2.0

data/README.rdoc

@@ -8,6 +8,8 @@ To require:
 
   require 'luhnacy'
 
+=== Generic Validation\Generation
+
 To validate:
 
   Luhnacy.valid?('49927398716')
@@ -20,6 +22,40 @@ To generate a string of 10 digits that does not satisfy Luhn algorithm:
 
   invalid_string = Luhnacy.generate(10, :invalid => true)
 
+To generate a string of 10 digits that satisfies Luhn and starts with predefined characters:
+
+  Luhnacy.generate(10, :prefix => '12345') #=> "1234597480"
+
+=== Named Generators/Validators
+
+There are named validators and generators for Visa, Mastercard and American Express credit cards. Note: Visa validation/generation only works for 16-digit credit card numbers.
+
+Example usage (mastercard)
+
+To validate a mastercard:
+
+  Luhnacy.mastercard?("5176290135048779")
+
+To generate a mastercard number that satisfies Luhn:
+
+  Luhnacy.mastercard #=> "5151199732615386"
+
+To generate a master card number that does not satisfy Luhn:
+
+  Luhnacy.mastercard(:invalid => true)
+
+Similar usage exists for Visa and American Express:
+
+  Luhnacy.visa
+  Luhnacy.visa?
+
+  Luhnacy.amex
+  Luhnacy.amex?
+
+== Planned changes
+
+At some point it may make sense to store the patterns for the named generator in a seperate class/module or even in a YAML file. This will be driven by the need for additional named generators. If a YAML file is used, then the very next release may also include the ability to pass Luhnacy a custom YAML file for generating/validating strings.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.
@@ -35,6 +71,8 @@ To generate a string of 10 digits that does not satisfy Luhn algorithm:
 * http://blog.flame.org/2008/3/24/checking-credit-card-numbers-in-ruby
 * http://www.missiondata.com/blog/web-development/25/credit-card-type-and-luhn-check-in-ruby/
 * http://en.wikipedia.org/wiki/Luhn
+* http://www.darkcoding.net/credit-card-numbers/
+* http://en.wikipedia.org/wiki/Credit_card_number
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/luhnacy.rb

@@ -1,11 +1,18 @@
 class Luhnacy
+  @cards = {
+    :mastercard => { :prefixes => [ '51', '52', '53', '54', '55' ], :size => 16 },
+    :visa => { :prefixes => ['4'], :size => 16 },
+    :amex => { :prefixes => ['34','37'], :size => 15 }
+  }
   def self.valid?(candidate)
     calc_modulus(candidate) == 0
   end
 
   def self.generate(string_size, options={})
-    output = ''
-    (string_size-1).times do |n|
+    raise ArgumentError, "prefix must be numeric" if options[:prefix] && !(options[:prefix] =~ /^\d*$/)
+
+    output = options[:prefix] || ''
+    (string_size-output.size-1).times do |n|
       output += rand(10).to_s
     end
     output += '0'
@@ -28,6 +35,14 @@ class Luhnacy
     output
   end
 
+  def self.method_missing(type, *args)
+    card_type, method_type = parse_method_name(type)
+                                                  
+    raise NoMethodError unless @cards[card_type] && @cards[card_type][:prefixes] && @cards[card_type][:size]
+
+    send(method_type, *(args.unshift(card_type)))
+  end
+
   private
   def self.double_and_fix(number)
     2 * number > 9 ? ( (2 * number) % 10 + 1 ) : 2 * number
@@ -46,4 +61,29 @@ class Luhnacy
 
     sum % 10
   end
+
+  def self.parse_method_name(method_name) 
+    method_name = method_name.to_s
+    case method_name
+    when /(.*)\?$/
+      [ $~[1].to_sym, :valid_card? ]
+    else 
+      [ method_name.to_sym, :generate_card ]
+    end
+  end
+
+  def self.valid_card?(card_type, card_number)
+    valid?(card_number) && valid_pattern?(card_type, card_number)
+  end
+
+  def self.generate_card(card_type, options={})
+      generate(@cards[card_type][:size], options.merge({:prefix => @cards[card_type][:prefixes][rand(@cards[card_type][:prefixes].size)]}))
+  end
+
+  def self.valid_pattern?(card_type, card_number)
+    @cards[card_type][:prefixes].each do |prefix|
+      return true if card_number =~ /^#{prefix}\d{#{@cards[card_type][:size] - prefix.size}}$/
+    end
+    false
+  end
 end

data/luhnacy.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{luhnacy}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rory McKinley"]
+  s.date = %q{2010-08-07}
+  s.description = %q{luhnacy can be used to validate strings for Luhn compliance as well as generating valid or invalid strings for the purposes of testing }
+  s.email = %q{rorymckinley@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/luhnacy.rb",
+     "luhnacy.gemspec",
+     "spec/luhnacy_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/rorymckinley/luhnacy}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A gem tohelp with the tedium of validating Luhn-compliant strings}
+  s.test_files = [
+    "spec/luhnacy_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/luhnacy_spec.rb

@@ -23,4 +23,51 @@ describe "Luhnacy" do
     candidate = Luhnacy.generate(string_size, :invalid => true)
     Luhnacy.valid?(candidate).should be_false
   end
+
+  it "should return a string that satisfies luhn and includes a given prefix" do
+    prefix = '12345'
+    string_size = 15
+    candidate = Luhnacy.generate(string_size, :prefix => prefix)
+    candidate.should match /^#{prefix}\d{#{string_size - prefix.size}}$/
+  end
+
+  it "should return an error if the prefix contains any non-numeric characters" do
+    prefix = 'AB123'
+    string_size = 15
+    lambda { Luhnacy.generate(string_size, :prefix => prefix) }.should raise_error ArgumentError
+  end
+
+  context "Named generators and validators" do
+    it "should validate a correct number" do
+      number = '5354334446769063'
+      Luhnacy.mastercard?(number).should be_true
+    end
+
+    it "should not validate a number if it does not satisfy Luhn" do
+      number = '5354334446769064'
+      Luhnacy.mastercard?(number).should be_false
+    end
+
+    it "should not validate a number if it does not have the correct prefix" do
+      number = Luhnacy.generate(16, :prefix => '49')
+      Luhnacy.mastercard?(number).should be_false
+    end
+
+    it "should not validate a number if it does not have the correct length" do
+      number = Luhnacy.generate(12, :prefix => '52')
+      Luhnacy.mastercard?(number).should be_false
+    end
+
+    it "should generate a valid number" do
+      Luhnacy.mastercard?(Luhnacy.mastercard).should be_true
+    end
+
+    it "should generate an invalid number" do
+      Luhnacy.mastercard?(Luhnacy.mastercard(:invalid => true)).should be_false
+    end
+
+    it "should raise an error if there is no matcher or validator with a given name" do
+      lambda { Luhnacy.superawesomecard?('123') }.should raise_error NoMethodError
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: luhnacy
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rory McKinley
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-19 00:00:00 +02:00
+date: 2010-08-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,6 +51,7 @@ files:
 - Rakefile
 - VERSION
 - lib/luhnacy.rb
+- luhnacy.gemspec
 - spec/luhnacy_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb