vindicator 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vindicator.gemspec
+gemspec
+
+gem 'minitest'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Johnathan Ludwig
+
+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,32 @@
+# VINdicator
+
+VINdicator is a small gem that will allow you to verify that a VIN is valid based on its check digit.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vindicator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vindicator
+
+## Usage
+
+Using a VIN, call valid_vin? and it will return true or false.
+
+    $ Vindicator.valid_vin?('5GZCZ43D13S812715') => true
+    $ Vindicator.valid_vin?('TGZCZ43D13S812715') => false
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vindicator.rb

@@ -0,0 +1,39 @@
+require "vindicator/version"
+
+module Vindicator
+  # This method checks that an auto VIN is valid against its check digit
+
+  # Example
+  # valid_vin?('1GNEC233X9R191831')
+
+  def self.valid_vin?(vin)
+    # I, O, and Q are not valid letters in a VIN. A valid VIN is exactly 17 characters in length
+    vin = vin.to_s.downcase.gsub(/(i|o|q|\W|_)/i,'').split('')
+    return false if vin.size != 17
+
+    # The 9th character is the check digit
+    check_digit = vin[8]
+
+    # Set up the numeric values for alpha characters and the weight for each position in the VIN
+    alpha_values = {'a' => 1, 'b' => 2, 'c' => 3, 'd' => 4, 'e' => 5, 'f' => 6, 'g' => 7, 'h' => 8,
+                    'j' => 1, 'k' => 2, 'l' => 3, 'm' => 4, 'n' => 5,           'p' => 7,           'r' => 9,
+                              's' => 2, 't' => 3, 'u' => 4, 'v' => 5, 'w' => 6, 'x' => 7, 'y' => 8, 'z' => 9}
+    weight = [8,7,6,5,4,3,2,10,0,9,8,7,6,5,4,3,2]
+
+    total = 0
+    vin.each_with_index do |num,index|
+      next if index == 8 # skip the check digit
+      if num =~ /\d/
+        total += num.to_i * weight[index]
+      elsif num =~ /[a-z]/
+        total += alpha_values[num] * weight[index]
+      end
+    end
+
+    # The total divided my the remainder should be the same as the check digit.
+    # The check digit should be x if the remainder is 10
+    remainder = total % 11
+    remainder = 'x' if remainder == 10
+    check_digit.to_s == remainder.to_s
+  end
+end

data/lib/vindicator/version.rb

@@ -0,0 +1,3 @@
+module Vindicator
+  VERSION = "0.1.0"
+end

data/test/vindicator_test.rb

@@ -0,0 +1,41 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'vindicator'
+require 'rubygems'
+require 'minitest/autorun'
+
+class VindicatorTest < MiniTest::Unit::TestCase
+  describe "when using a valid vin" do
+    it "returns true " do
+      assert Vindicator.valid_vin?('1GNEC233X9R191831'), "valid_vin? returned false when a valid VIN was used"
+      assert Vindicator.valid_vin?('2HNYD2H22AH529160'), "valid_vin? returned false when a valid VIN was used"
+      assert Vindicator.valid_vin?('2HNYD18683H545668'), "valid_vin? returned false when a valid VIN was used"
+      assert Vindicator.valid_vin?('5GZCZ43D13S812715'), "valid_vin? returned false when a valid VIN was used"
+      assert Vindicator.valid_vin?('11111111111111111'), "valid_vin? returned false when a valid VIN was used"
+    end
+
+    it 'strips out non alphanumeric characters' do
+      assert Vindicator.valid_vin?('1GN-EC2_33X!9R1@918#31'), "valid_vin? returned false when a valid VIN was used"
+    end
+  end
+
+  describe "when using invalid vins" do
+    it 'returns false when vin is not 17 characters in length' do
+      # too long
+      assert !Vindicator.valid_vin?('2HNYD2H22AH529160W'), "valid_vin? returned true when an invalid VIN was used"
+      # too short
+      assert !Vindicator.valid_vin?('2HNYD2H22AH52916'), "valid_vin? returned true when an invalid VIN was used"
+    end
+
+    it 'strips out I, O, and Q' do
+      assert !Vindicator.valid_vin?('2HNYD2H22AH52916O'), "valid_vin? returned true when an invalid VIN was used"
+      assert !Vindicator.valid_vin?('2HNYD2H22AH52916I'), "valid_vin? returned true when an invalid VIN was used"
+      assert !Vindicator.valid_vin?('2HNYD2H22AH52916Q'), "valid_vin? returned true when an invalid VIN was used"
+    end
+
+    it "returns false when the check digit does not match" do
+      assert !Vindicator.valid_vin?('TGZCZ43D13S812715'), "valid_vin? returned true when an invalid VIN was used"
+      assert !Vindicator.valid_vin?('11111111211111111'), "valid_vin? returned true when an invalid VIN was used"
+    end
+  end
+end

data/vindicator.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vindicator/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "vindicator"
+  gem.version       = Vindicator::VERSION
+  gem.authors       = ["Johnathan Ludwig"]
+  gem.email         = ["john@johnathanludwig.com"]
+  gem.description   = %q{VINdicator is a small gem that will allow you to verify that a VIN is valid based on its check digit.}
+  gem.summary       = %q{VINdicator is a small gem that will allow you to verify that a VIN is valid based on its check digit.}
+  gem.homepage      = "https://github.com/JohnathanLudwig/vindicator"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: vindicator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Johnathan Ludwig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-12 00:00:00.000000000 Z
+dependencies: []
+description: VINdicator is a small gem that will allow you to verify that a VIN is
+  valid based on its check digit.
+email:
+- john@johnathanludwig.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vindicator.rb
+- lib/vindicator/version.rb
+- test/vindicator_test.rb
+- vindicator.gemspec
+homepage: https://github.com/JohnathanLudwig/vindicator
+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.25
+signing_key: 
+specification_version: 3
+summary: VINdicator is a small gem that will allow you to verify that a VIN is valid
+  based on its check digit.
+test_files:
+- test/vindicator_test.rb