luhnacy 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rory McKinley
+
+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.rdoc

@@ -0,0 +1,41 @@
+= luhnacy
+
+A tiny (hopefully) gem that will automate some of the painful tasks of generating / validating strings of numbers based on the Luhn algorithm (e.g. credit card numbers, ID numbers).
+
+== Usage
+
+To require:
+
+  require 'luhnacy'
+
+To validate:
+
+  Luhnacy.valid?('49927398716')
+
+To generate a string of 10 digits that satisfies the Luhn algorithm:
+
+  valid_string = Luhnacy.generate(10)
+
+To generate a string of 10 digits that does not satisfy Luhn algorithm:
+
+  invalid_string = Luhnacy.generate(10, :invalid => true)
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Sources
+
+* 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
+
+== Copyright
+
+Copyright (c) 2010 Rory McKinley. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "luhnacy"
+    gem.summary = %Q{A gem tohelp with the tedium of validating Luhn-compliant strings}
+    gem.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 }
+    gem.email = "rorymckinley@gmail.com"
+    gem.homepage = "http://github.com/rorymckinley/luhnacy"
+    gem.authors = ["Rory McKinley"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "luhnacy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/luhnacy.rb

@@ -0,0 +1,49 @@
+class Luhnacy
+  def self.valid?(candidate)
+    calc_modulus(candidate) == 0
+  end
+
+  def self.generate(string_size, options={})
+    output = ''
+    (string_size-1).times do |n|
+      output += rand(10).to_s
+    end
+    output += '0'
+
+    if options[:invalid]
+      case calc_modulus(output)
+      when 0
+        output = output[0...-1] + (rand(8) + 1).to_s
+      when [1..8]
+        output = output[0...-1] + ((10 - calc_modulus(output))/2).to_s
+      when 9
+        output = output[0...-1] + (rand(7) + 2).to_s
+      end
+    else
+      unless calc_modulus(output) == 0
+        output = output[0...-1] + (10 - calc_modulus(output)).to_s
+      end
+    end
+
+    output
+  end
+
+  private
+  def self.double_and_fix(number)
+    2 * number > 9 ? ( (2 * number) % 10 + 1 ) : 2 * number
+  end
+
+  def self.calc_modulus(candidate)
+    working = candidate.reverse
+    double_up = false;
+    sum = 0
+
+    working.each_char do |ch|
+      num = ch.to_i
+      sum += double_up ? double_and_fix(num) : num
+      double_up = !double_up
+    end
+
+    sum % 10
+  end
+end

data/spec/luhnacy_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Luhnacy" do
+  it "should be able to identify if a number satisfies Luhn" do
+    valid_number = '49927398716'
+    Luhnacy.valid?(valid_number).should be_true
+  end
+
+  it "should be able to identify if a number does not satisfy Luhn" do
+    invalid_number = '49927398715'
+    Luhnacy.valid?(invalid_number).should be_false
+  end
+
+  it "should return a string of digits that satisfies Luhn" do
+    string_size = 5
+    candidate = Luhnacy.generate(string_size)
+    candidate.should match /^\d{#{string_size}}$/
+    Luhnacy.valid?(candidate).should be_true
+  end
+
+  it "should return a string of digits that does not satisfy Luhn" do
+    string_size = 5
+    candidate = Luhnacy.generate(string_size, :invalid => true)
+    Luhnacy.valid?(candidate).should be_false
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'luhnacy'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: luhnacy
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rory McKinley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-19 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: "luhnacy can be used to validate strings for Luhn compliance as well as generating valid or invalid strings for the purposes of testing "
+email: rorymckinley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/luhnacy.rb
+- spec/luhnacy_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/rorymckinley/luhnacy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A gem tohelp with the tedium of validating Luhn-compliant strings
+test_files: 
+- spec/luhnacy_spec.rb
+- spec/spec_helper.rb