uy-id 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uy-id.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    uy-id (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  rspec (~> 2.14.1)
+  uy-id!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alfonso Cora
+
+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/README.md

@@ -0,0 +1,44 @@
+# Uy::Id
+
+This gem includes the necessary helper methods to validate Uruguayan identification numbers ("Cédula de identidad").
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'uy-id'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uy-id
+
+## Usage
+
+```ruby
+require 'uy/id'
+
+# to validate an ID:
+Uy::Id.new('94475265').valid?
+# => true
+
+# to generate valid ID for testing purposes:
+Uy::Id.new.id
+# => "63228586"
+
+# note that ID numbers lower than 1000000 must contain the trailing zeros
+# this limitation might change in the future with the introduction of sanitizing features
+Uy::Id.new('1234561').valid? # => false
+Uy::Id.new('01234561').valid? # => true
+```
+
+## Contributing
+
+If you want to contribute to this project, just fork it, make your changes, run the tests and create a pull request. Also, feel free to report issues on the [issues section](issues).
+
+## Credits
+
+Thanks to @cschmeichel for facilitating the algorithms!

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+RSpec::Core::RakeTask.new do |task|
+  task.rspec_opts = ["-c", "-f progress"]
+  task.pattern    = 'spec/**/*_spec.rb'
+end

data/lib/uy/id.rb

@@ -0,0 +1,43 @@
+module Uy
+  class Id
+    FACTORS = [2,9,8,7,6,3,4]
+
+    attr_accessor :id
+
+    def initialize(id=nil)
+      @id = id || Id.generate
+    end
+
+    def is_valid?
+      return false unless @id =~ /\d{8}/
+      return false unless Id.calculate_check_digit(@id) == @id[7].to_i
+
+      true
+    end
+
+    alias valid? is_valid?
+
+    protected
+
+    def self.calculate_check_digit(id)
+      id = id.length == 8 ? id.chop : id
+      checksum =
+        id
+        .chars
+        .to_a
+        .map(&:to_i)
+        .zip(FACTORS)
+        .map {|d| d.reduce(&:*)}
+        .reduce(:+)
+      check_digit = (10 - (checksum % 10)) % 10
+      check_digit
+    end
+
+    def self.generate
+      id = ''
+      7.times { id += rand(0..9).to_s }
+      id += calculate_check_digit(id).to_s
+      id
+    end
+  end
+end

data/spec/id_spec.rb

@@ -0,0 +1,18 @@
+require 'uy/id'
+
+describe Uy::Id do
+  describe 'validations' do
+    it { expect(Uy::Id.new('')).not_to be_valid }
+    it { expect(Uy::Id.new('asdf')).not_to be_valid }
+    it { expect(Uy::Id.new('1122222')).not_to be_valid }
+    it { expect(Uy::Id.new('03555770')).not_to be_valid }
+    it { expect(Uy::Id.new('21922316')).to be_valid }
+    it { expect(Uy::Id.new('10253720')).to be_valid }
+  end
+
+  describe 'generation' do
+    it 'generates valid numbers' do
+      25.times { expect(Uy::Id.new).to be_valid }
+    end
+  end
+end

data/uy-id.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "uy-id"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Alfonso Cora"]
+  spec.email         = ["acora6@gmail.com"]
+  spec.description   = %q{Includes helper methods to validate Uruguayan identification numbers}
+  spec.summary       = %q{Uy::Id is a class that allows to validate ID numbers or generate fake ones for testing purposes}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: uy-id
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alfonso Cora
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Includes helper methods to validate Uruguayan identification numbers
+email:
+- acora6@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/uy/id.rb
+- spec/id_spec.rb
+- uy-id.gemspec
+homepage: ''
+licenses:
+- MIT
+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.25
+signing_key: 
+specification_version: 3
+summary: Uy::Id is a class that allows to validate ID numbers or generate fake ones
+  for testing purposes
+test_files:
+- spec/id_spec.rb
+has_rdoc: