brid 0.1.3 → 0.2.0

data/.rspec

@@ -1 +1,2 @@
 --color
+--debug

data/README.md

@@ -5,7 +5,9 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'brid'
+``` ruby
+gem 'brid'
+```
 
 And then execute:
 
@@ -15,9 +17,60 @@ Or install it yourself as:
 
     $ gem install brid
 
+## Components
+
+* CPF object with validation (brazilian document)
+* CNPJ object with validation (brazilian document)
+* Título de Eleitor object with validation (brazilian document)
+* PIS object with validation (brazilian document)
+* Cred Card object with validation (generic)
+* Generic ID validation (can validate bank account and other things)
+* Luhn algorithms modulus 10 and 11 http://en.wikipedia.org/wiki/Luhn_algorithm
+
 ## Usage
 
-TODO: Write usage instructions here
+### Validating a CPF
+
+``` ruby
+CPF.new('135246876-01').valid?                     # true
+CPF.new('135.246.876-01').valid?                   # true
+CPF.new('13524687601').valid?                      # true
+CPF.new(13524687601).valid?                        # true
+(Mod11.new('135246876') * 2).to_s == '13524687601' # true
+'135246876'.mod11(2)              == '13524687601' # true
+```
+
+### Validating a CNPJ
+
+``` ruby
+CNPJ.new('18.781.203/0001-28').valid?                                    # true
+(Mod11.new('8.781.203/0001', :base => 2..9) * 2).to_s == '8781203000128' # true
+'8.781.203/0001'.mod11(2, :base => 2..9)              == '8781203000128' # true
+
+``` 
+  
+### Validating a Bank Account
+
+``` ruby
+GenericID.new('12345-5').valid?           # true
+(Mod11.new('12345') * 1).to_s == '123455' # true
+'12345'.mod11                 == '123455' # true
+
+```
+
+### Validating a Cred Card
+
+``` ruby
+CredCard.new('411119876333502').valid? # true
+(Mod10.new('41111987633350') * 1).to_s == '411119876333502' # true
+'41111987633350'.mod10                 == '411119876333502' # true
+```
+
+
+## Next Steps
+
+* Develop a rails plugin built on top of ActiveRecord
+* Develop a smart generator for fixture on tests (I thought of doing built on top of ffaker, like my othre gem: [ffaker-cpfcnpj](https://github.com/halan/ffaker-cpfcnpj) )
 
 ## Contributing
 
@@ -26,3 +79,28 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## License
+
+Copyright (c) 2012 Halan Pinheiro
+
+MIT License
+
+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/lib/brid/algorithms/luhn.rb

@@ -0,0 +1,48 @@
+class LuhnBase
+  def initialize number, options = {}
+    @mod, @base = 0, 0..100
+    @number     = number.to_s.scan(/\d/).join
+    @base       = options[:base]  if options.has_key? :base
+    @mod        = options[:mod]   if options.has_key? :mod
+  end
+
+  def check_digit
+    sum / @mod
+  end
+
+  def * digits
+    digits.times.reduce(self) do |number, digit|
+      number += self.class.new(number, :base => @base, :mode => @mod).check_digit
+    end
+  end
+
+  def + digit
+    self.class.new(@number += digit.to_s.scan(/\d/).join, :base => @base, :mode => @mod)
+  end
+
+  def to_s
+    @number.to_s
+  end
+
+  def == other
+    self.to_s == other.to_s
+  end
+
+  protected
+  def bases
+    multipliers = ([*@base] * (@number.length/@base.count+1))[0..(@number.length-1)].reverse
+  end
+
+  def numbers_list
+    @number.chars.map &:to_i
+  end
+
+  def sum
+    bases.zip(numbers_list).reduce(0) {|total, n| total += before_sum(*n) }
+  end
+
+  def before_sum base, number
+    base * number
+  end
+end
+

data/lib/brid/algorithms/mod10.rb

@@ -0,0 +1,20 @@
+class Mod10 < LuhnBase
+  def initialize number, options = {}
+    super number, :base => [2, 1], :mod => 10
+  end
+
+  def check_digit
+    10 - (sum % 10) 
+  end
+
+  private
+  def before_sum base, number
+    super(base, number).to_s.chars.map(&:to_i).reduce(:+)
+  end
+end
+
+class String
+  def mod10 digits = 1, options = {}
+    (Mod10.new(self, options) * digits).to_s
+  end
+end

data/lib/brid/algorithms/mod11.rb

@@ -0,0 +1,17 @@
+class Mod11 < LuhnBase
+  def initialize number, options = {}
+    options[:mod] = 11
+    super number, {:base => 2..11}.merge(options)
+  end
+
+  def check_digit
+    ((10 * sum) % @mod) % 10
+  end
+end
+
+class String
+  def mod11 digits = 1, options = {}
+    (Mod11.new(self, options) * digits).to_s
+  end
+end
+

data/lib/brid/ids/cnpj.rb

@@ -13,8 +13,8 @@ module Brid
     end
 
     private
-    def mod11 number
-      Mod11.new(number, :base => 2..9)
+    def valid_number
+      sequential.mod11(check_digits_length, :base => 2..9)
     end
   end
 end

data/lib/brid/ids/cred_card.rb

@@ -0,0 +1,37 @@
+module Brid
+  class CredCard < GenericID
+    def initialize number
+      @number = clear_number(number)
+
+      raise ArgumentError.new "invalid number" unless (14..19).include? @number.length
+    end
+
+    def sequential 
+      @sequential ||= begin
+        @number[/^(.*).$/, 1]
+      end
+    end
+
+    def association
+      return :dinners  if @number.length == 14 and @number =~ /^3(0[0-5]|[68])/   # 300xxx-305xxx, 36xxxx, 38xxxx
+      return :amex     if @number.length == 15 and @number =~ /^3[47]/            # 34xxxx, 37xxxx
+      return :visa     if [13,16].include?(@number.length) and @number =~ /^4/    # 4xxxxx
+      return :master   if @number.length == 16 and @number =~ /^5[1-5]/           # 51xxxx-55xxxx
+      return :discover if @number.length == 16 and @number =~ /^6011/             # 6011xx
+      return false
+    end
+
+    def invalid_sequential?
+      @invalid_sequential ||=begin
+        association != false
+      end
+    end
+
+    private
+    def valid_number
+      sequential.mod10
+    end
+  end
+end
+
+CredCard = Brid::CredCard if not defined? CredCard

data/lib/brid/{generic_id.rb → ids/generic_id.rb}

@@ -41,12 +41,8 @@ class GenericID
   end
 
   protected
-  def mod11 number
-    Mod11.new(number)
-  end
-
   def valid_number
-    mod11(sequential) * check_digits_length
+    sequential.mod11(check_digits_length)
   end
 
   def clear_number number

data/lib/brid/ids/pis.rb

@@ -20,12 +20,8 @@ module Brid
     end
 
     private
-    def mod11 number
-      Mod11.new(number, :base => 2..9)
-    end
-
     def valid_number
-      mod11(sequential) * 1
+      sequential.mod11(check_digits_length, :base => 2..9)
     end
   end
 end

data/lib/brid/ids/titulo_eleitor.rb

@@ -1,11 +1,14 @@
 module Brid
   class TituloEleitor < GenericID
-    def number_length; 10; end;
+    def number_length; 12; end;
 
     def initialize number
-      @number = clear_number(number)
+      @number = clear_number(number).rjust number_length, '0'
+
+      raise ArgumentError.new "invalid number" if @number.length != number_length
     end
 
+
     def sequential 
       @sequential ||= begin
         @number[/^(.*)....$/, 1]
@@ -33,9 +36,13 @@ module Brid
     end
 
     private
+    def mod number
+      Mod11.new number
+    end
+
     def valid_number
-      first_check_digit   = mod11(sequential).cdigi.to_s
-      second_check_digit  = mod11(uf_digit+first_check_digit).cdigi.to_s
+      first_check_digit   = mod(sequential).check_digit.to_s
+      second_check_digit  = mod(uf_digit+first_check_digit).check_digit.to_s
 
       sequential + uf_digit + first_check_digit + second_check_digit
     end

data/lib/brid/version.rb

@@ -1,3 +1,3 @@
 module Brid
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/brid.rb

@@ -1,11 +1,29 @@
-['version.rb', 'mod11.rb', 'generic_id.rb'].each do |filename|
-  require File.join(File.dirname(__FILE__), 'brid', filename)
-end
+#requires
+
+root_dir = File.join(File.dirname(__FILE__), 'brid')
 
-['cpf.rb', 'cnpj.rb', 'titulo_eleitor.rb', 'pis.rb'].each do |filename|
-  require File.join(File.dirname(__FILE__), 'brid', 'ids', filename)
+require File.join(root_dir, 'version.rb')
+
+#mod algorithms
+[
+  'luhn.rb',
+  'mod10.rb',
+  'mod11.rb'
+].each do |filename|
+  require File.join(root_dir, 'algorithms', filename)
 end
 
+#ids and documents
+[
+  'generic_id',
+  'cpf.rb',
+  'cnpj.rb',
+  'titulo_eleitor.rb',
+  'pis.rb',
+  'cred_card.rb'
+].each do |filename|
+  require File.join(root_dir, 'ids', filename)
+end
 
 require File.join(File.dirname(__FILE__), 'brid', 'detector.rb')
 

data/spec/cred_card_spec.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'brid.rb')
+
+describe Mod10 do
+  it { CredCard.new('411119876333502').should  be_valid }
+  it { CredCard.new('211119876333501').should_not  be_valid }
+
+end

data/spec/mod10_spec.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'brid.rb')
+
+describe Mod10 do
+  it { Mod10.new('01230067896').check_digit.should    ==  3 }
+  it { Mod10.new('3011119876333').check_digit.should  ==  5 }
+  it { Mod10.new('2799811').check_digit.should        ==  1 }
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: brid
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Halan Pinheiro
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-18 00:00:00 Z
+date: 2012-07-24 00:00:00 Z
 dependencies: []
 
 description: Brazilian identifications like CPF, CNPJ, Titulo de Eleitor
@@ -36,18 +36,23 @@ files:
 - Rakefile
 - brid.gemspec
 - lib/brid.rb
+- lib/brid/algorithms/luhn.rb
+- lib/brid/algorithms/mod10.rb
+- lib/brid/algorithms/mod11.rb
 - lib/brid/detector.rb
-- lib/brid/generic_id.rb
 - lib/brid/ids/cnpj.rb
 - lib/brid/ids/cpf.rb
+- lib/brid/ids/cred_card.rb
+- lib/brid/ids/generic_id.rb
 - lib/brid/ids/pis.rb
 - lib/brid/ids/titulo_eleitor.rb
-- lib/brid/mod11.rb
 - lib/brid/version.rb
 - spec/brid_spec.rb
 - spec/cnpj_spec.rb
 - spec/cpf_spec.rb
+- spec/cred_card_spec.rb
 - spec/generic_id_spec.rb
+- spec/mod10_spec.rb
 - spec/mod11_spec.rb
 - spec/pis_spec.rb
 - spec/titulo_spec.rb
@@ -88,7 +93,9 @@ test_files:
 - spec/brid_spec.rb
 - spec/cnpj_spec.rb
 - spec/cpf_spec.rb
+- spec/cred_card_spec.rb
 - spec/generic_id_spec.rb
+- spec/mod10_spec.rb
 - spec/mod11_spec.rb
 - spec/pis_spec.rb
 - spec/titulo_spec.rb

data/lib/brid/mod11.rb

@@ -1,55 +0,0 @@
-class Mod11
-  def initialize number, options = {}
-    options = {:base => 2..11, :mod => 11}.merge options
-
-    @number = number.to_s.scan(/\d/).join
-    @base   = options[:base]
-    @mod    = options[:mod]
-  end
-
-  def check_digit
-    if block_given?
-      yield sum, @mod
-    else
-      ((10 * sum) % @mod) % 10
-    end
-  end
-
-  alias :cdigi :check_digit
-
-  def * digits
-    digits.times.reduce(self) do |number, digit|
-      number += Mod11.new(number, :base => @base, :mode => @mod).cdigi
-    end
-  end
-
-  alias :>> :*
-
-  def + digit
-    Mod11.new(@number += digit.to_s.scan(/\d/).join, :base => @base, :mode => @mod)
-  end
-
-  alias :<< :+
-
-  def to_s
-    @number.to_s
-  end
-
-  def == other
-    self.to_s == other.to_s
-  end
-
-  private
-  def bases
-    multipliers = ([*@base] * (@number.length/@base.count+1))[0..(@number.length-1)].reverse
-  end
-
-  def numbers_list
-    @number.chars.map &:to_i
-  end
-
-  def sum
-    bases.zip(numbers_list).reduce(0) {|total, n| total += n[0] * n[1]}
-  end
-end
-