luhn 0.1.1

data/LICENSE

@@ -0,0 +1,19 @@
+# Copyright (c) 2010 Joel Junström, Oktavilla
+#
+# 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,44 @@
+= Ruby class for handling basic Luhn number generation and verification
+
+Includes a class to handle Swedish civic numbers (Personnummer)
+That interface supports checking validity (length, valid date and satisfies luhn),
+returning the sex, the control digit and generating random civic numbers.
+
+== Install
+
+  $ gem install luhn
+
+== Usage:
+
+=== Basic Luhn
+
+  Luhn.valid?('0465827879483596') # true
+  Luhn.control_digit('046582787948359') # 6
+  Luhn.generate(n) # returns a random number of n length that satisfies luhn
+
+  '0465827879483596'.valid_luhn? # true
+  0465827879483596.valid_luhn?   # true
+
+=== Swedish civic numbers
+
+  civic_number = Luhn::CivicNumber.new('19391030-3183')
+  civic_number.valid? # true
+  civic_number.sex    # 'male'
+  civic_number.male?  # true
+  civic_number.control_digit # 3
+
+  '391030-3183'.civic_number? # true
+  3910303183.civic_number?    # true
+
+== About the Luhn algorithm (from http://en.wikipedia.org/wiki/Luhn_formula)
+
+The Luhn algorithm or Luhn formula, also known as the "modulus 10" or "mod 10"
+algorithm, is a simple checksum formula used to validate a variety of
+identification numbers, such as credit card numbers, IMEI numbers,
+National Provider Identifier numbers in US and Canadian Social Insurance Numbers.
+It was created by IBM scientist Hans Peter Luhn and described in U.S. Patent
+No. 2,950,048, filed on January 6, 1954, and granted on August 23, 1960.
+
+== Copyright
+
+Copyright (c) 2010 Joel Junström. See LICENSE for details.

data/lib/luhn.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+require 'luhn/extensions'
+
+module Luhn
+  autoload :CivicNumber, 'luhn/civic_number'
+
+  class << self
+    def valid?(value)
+      self.checksum(value, :odd) % 10 == 0
+    end
+
+    def control_digit(value)
+      sum = self.checksum(value, :even)
+      (sum % 10 != 0) ? 10 - (sum % 10) : 0
+    end
+
+    def generate(size, options = {})
+      generated = options[:prefix] || ''
+      (size - generated.size - 1).times { |i| generated += rand(10).to_s }
+      generated + self.control_digit(generated).to_s
+    end
+
+  protected
+
+    def checksum(value, operation)
+      i = 0
+      value.reverse.split(//).inject(0) do |sum, c|
+        n = c.to_i
+        calc = if operation == :even
+          (i % 2 == 0) ? n * 2 : n
+        else
+          (i % 2 != 0) ? n * 2 : n
+        end
+        i += 1
+        sum += calc <= 9 ? calc : (calc % 10) + 1
+      end
+    end
+  end
+
+end

data/lib/luhn/civic_number.rb

@@ -0,0 +1,62 @@
+# encoding: UTF-8
+require 'ostruct'
+module Luhn
+  class CivicNumber
+    attr_reader :civic_number
+
+    def initialize(string)
+      @civic_number = cleanup_string(string.to_s)
+    end
+
+    def valid?
+      @valid ||= civic_number.length == 10 && valid_date? && Luhn.valid?(civic_number)
+    end
+
+    def valid_date?
+      (1..12).include?(birth_date.month) && (1..31).include?(birth_date.day)
+    end
+
+    def control_digit
+      @control_digit ||= Luhn.control_digit(civic_number[0...9])
+    end
+
+    def sex
+      @sex ||= valid? ? (civic_number[8...9].to_i.even? ? 'female' : 'male') : 'unknown'
+    end
+
+    def female?
+      sex == 'female'
+    end
+
+    def male?
+      sex == 'male'
+    end
+
+    def birth_date
+      @date ||= OpenStruct.new({
+        :year  => civic_number[0...2].to_i,
+        :month => civic_number[2...4].to_i,
+        :day   => civic_number[4...6].to_i
+      })
+    end
+
+    def to_s
+      civic_number
+    end
+
+    class << self
+      def generate
+        date = Time.local(Time.now.year - rand(100) - 1, rand(12) + 1, rand(31) + 1)
+        Luhn.generate(10, :prefix => date.strftime("%y%m%d"))
+      end
+    end
+
+  private
+
+    def cleanup_string(string)
+      string.gsub!(/\D/, '')
+      string.length == 12 ? string[2...12] : string
+    end
+
+  end
+end

data/lib/luhn/extensions.rb

@@ -0,0 +1,3 @@
+# encoding: UTF-8
+require 'luhn/extensions/string'
+require 'luhn/extensions/numeric'

data/lib/luhn/extensions/numeric.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+class Numeric
+
+  def valid_luhn?
+    self.to_s.valid_luhn?
+  end
+
+  def civic_number?
+    self.to_s.civic_number?
+  end
+end

data/lib/luhn/extensions/string.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+class String
+  def valid_luhn?
+    Luhn.valid?(self)
+  end
+
+  def civic_number?
+    Luhn::CivicNumber.new(self).valid?
+  end
+end

data/lib/luhn/version.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+module Luhn
+  Version = '0.1.1'
+end

data/spec/helper.rb

@@ -0,0 +1,7 @@
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'rubygems'
+gem 'minitest'
+require 'luhn'
+require 'minitest/benchmark' if ENV["BENCH"]
+require 'minitest/spec'
+require 'minitest/autorun'

data/spec/spec_civic_number.rb

@@ -0,0 +1,53 @@
+require 'helper'
+
+describe Luhn::CivicNumber do
+  it 'identifies if the civic number is valid' do
+    Luhn::CivicNumber.new('3910304298').valid?.must_equal true
+  end
+
+  it 'identifies if the civic number is invalid' do
+    Luhn::CivicNumber.new('3910304290').valid?.must_equal false
+  end
+
+  it 'requires a length of 10 to be valid' do
+    luhn_string = Luhn.generate(8, :prefix => '391030')
+    Luhn::CivicNumber.new(luhn_string).valid?.must_equal false
+  end
+
+  it 'requires the civic number to be a valid date' do
+    luhn_string = Luhn.generate(10, :prefix => '3999')
+    Luhn::CivicNumber.new(luhn_string).valid?.must_equal false
+  end
+
+  it 'calculates the control digit for a valid civic number' do
+    Luhn::CivicNumber.new('3910304298').control_digit.must_equal 8
+  end
+
+  it 'calculates the correct control digit for an invalid civic number' do
+    Luhn::CivicNumber.new('3910304290').control_digit.must_equal 8
+  end
+
+  it 'identifies if the civic number belongs to a male' do
+    Luhn::CivicNumber.new('3910304298').sex.must_equal 'male'
+  end
+
+  it 'identifies if the civic number belongs to a female' do
+    Luhn::CivicNumber.new('3910303183').sex.must_equal 'female'
+  end
+
+  it 'cleans up civic number with the full year supplied' do
+    Luhn::CivicNumber.new('19391030-3183').civic_number.must_equal '3910303183'
+  end
+
+  it 'knows the date of birth' do
+    civic_number = Luhn::CivicNumber.new('3001018194')
+    civic_number.birth_date.year.must_equal 30
+    civic_number.birth_date.month.must_equal 1
+    civic_number.birth_date.day.must_equal 1
+  end
+
+  it 'generates a valid random civic number' do
+    civic_number = Luhn::CivicNumber.generate
+    Luhn::CivicNumber.new(civic_number).valid?.must_equal true
+  end
+end

data/spec/spec_extensions.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+describe String do
+  it 'knows if it is a valid luhn' do
+    '3910304298'.valid_luhn?.must_equal true
+  end
+
+  it 'knows if it is an civic number' do
+    '3910304298'.civic_number?.must_equal true
+  end
+end
+
+describe Numeric do
+  it 'knows if it is a valid luhn' do
+    3910304298.valid_luhn?.must_equal true
+  end
+
+  it 'knows if it is an civic number' do
+    3910304298.civic_number?.must_equal true
+  end
+end

data/spec/spec_luhn.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+describe Luhn do
+  it "identifies if the number is valid" do
+    Luhn.valid?('1111111116').must_equal true
+  end
+
+  it 'identifies if the number is invalid' do
+    Luhn.valid?('1111111111').must_equal false
+  end
+
+  it 'generates a number string that satisfies luhn' do
+    luhn_string = Luhn.generate(rand(32)+1)
+    Luhn.valid?(luhn_string).must_equal true
+  end
+
+  it 'generate a number string with the size of the argument' do
+    luhn_string = Luhn.generate(5)
+    luhn_string.size.must_equal 5
+  end
+
+  it 'generate a a valid luhn with a given prefix' do
+    luhn_string = Luhn.generate(10, :prefix => '00001')
+    luhn_string.must_match /^00001/
+    Luhn.valid?(luhn_string).must_equal true
+  end
+
+  it 'calculates the control digit' do
+    Luhn.control_digit('111111111').must_equal 6
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: luhn
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.1
+platform: ruby
+authors: 
+- "Joel Junstr\xC3\xB6m"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id001
+description: 
+email: 
+- joel.junstrom@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/luhn/civic_number.rb
+- lib/luhn/extensions/numeric.rb
+- lib/luhn/extensions/string.rb
+- lib/luhn/extensions.rb
+- lib/luhn/version.rb
+- lib/luhn.rb
+- spec/helper.rb
+- spec/spec_civic_number.rb
+- spec/spec_extensions.rb
+- spec/spec_luhn.rb
+- LICENSE
+- README.rdoc
+homepage: http://github.com/joeljunstrom/ruby_luhn
+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.8
+signing_key: 
+specification_version: 3
+summary: A small implementation of the Luhn algorithm.
+test_files: []
+