vin_utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3efe802d6ba3c5d94db3e7c646830c484363a96db6f3ce2d65a2681c2115c44
+  data.tar.gz: 73ed8f278fe68109fa66a7bc74142be026cf9be3300d7445632eeb079ee5cf4f
+SHA512:
+  metadata.gz: 6d87ad1a054f3e98ede2943ba8e1bc883dc995ec2912e1c85e86d310f52d79c0f2ebdb763f4505c0b3350554cf86dea9bd16d43b5a6c36551edb9e2b70ea5415
+  data.tar.gz: ad6fa27bcfb837bb7a5c15f55ce9257b2c2597f15dd19f6710cf3b73e294edeb151f65ddd8eabf7fcc06ba3aca2a3085165ed1ccdd2e9b13ce34694466ae633d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,89 @@
+# Adapted from https://gist.github.com/jhass/a5ae80d87f18e53e7b56
+
+AllCops:
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 1500
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/SymbolArray:
+  Enabled: true
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/PreferredHashMethods:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    reduce: "inject"
+
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Lint/SuppressedException:
+  Enabled: false
+
+Layout/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+Lint/Debugger:
+  Enabled: false
+
+Style/MethodDefParentheses:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vin_utils.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    vin_utils (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  vin_utils!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Diego Stiehl
+
+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,53 @@
+# VinUtils
+
+A gem to check and suggest [VIN](https://en.wikipedia.org/wiki/Vehicle_identification_number) identifiers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vin_utils'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install vin_utils
+
+## Usage
+
+You can use this gem in your code to check the validity of a given VIN.
+
+```ruby
+input_vin = '11111111111111111'
+validator = VinUtils::Validator.new(input_vin)
+validator.valid? # true
+validator.calculate_check_digit # "1"
+validator.suggest_valid_vin # "11111111111111111"
+```
+
+> Both `calculate_check_digit` and `suggest_valid_vin` will return `:invalid` incase of an invalid input (invalid characters, size or data type).
+
+## Example
+
+There is an example console application that can be run by typing:
+
+```bash
+bin/example <VIN>
+```
+
+And it will print to the console something like the example below:
+
+```bash
+Provided VIN: <VIN>
+Check Digit: VALID
+This looks like a VALID VIN!
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'vin_utils'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/example

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/vin_utils/validator'
+
+if ARGV[0].nil?
+  puts 'You must provide a VIN'
+  return
+end
+
+vin = ARGV[0].to_s
+
+validator = VinUtils::Validator.new(vin)
+puts "Provided VIN: #{validator.vin}"
+if validator.valid?
+  puts 'Check Digit: VALID'
+  puts 'This looks like a VALID VIN!'
+else
+  suggested_vin = validator.suggest_valid_vin
+  if suggested_vin == :invalid
+    puts 'You provided an invalid VIN'
+  else
+    puts 'Check Digit: INVALID'
+    puts "Suggested VIN: #{validator.suggest_valid_vin}"
+  end
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vin_utils.rb

@@ -0,0 +1,4 @@
+require 'vin_utils/version'
+
+module VinUtils
+end

data/lib/vin_utils/validator.rb

@@ -0,0 +1,55 @@
+module VinUtils
+  class Validator
+    attr_accessor :vin
+
+    DIGIT_BASE = %w[0 1 2 3 4 5 6 7 8 9 . A B C D E F G H . . J K L M N . P . R . . S T U V W X Y Z].freeze
+    MAP = %w[0 1 2 3 4 5 6 7 8 9 X].freeze
+    WEIGHTS = [8, 7, 6, 5, 4, 3, 2, 10, 0, 9, 8, 7, 6, 5, 4, 3, 2].freeze
+
+    def initialize(vin)
+      @vin = vin
+      @vin = @vin.upcase if @vin.instance_of?(String)
+    end
+
+    def valid?
+      return false unless valid_input?
+
+      calculate_check_digit == @vin[8]
+    end
+
+    def calculate_check_digit
+      return :invalid unless valid_input?
+
+      sum = 0
+      @vin.chars.each_with_index do |char, i|
+        sum += transliterate(char) * WEIGHTS[i]
+      end
+
+      MAP[sum % 11]
+    end
+
+    def suggest_valid_vin
+      return :invalid unless valid_input?
+      return @vin if valid?
+
+      new_vin = @vin.dup
+      new_vin[8] = calculate_check_digit
+      new_vin
+    end
+
+    private
+
+    def transliterate(char)
+      DIGIT_BASE.index(char) % 10
+    end
+
+    def valid_input?
+      return false unless @vin.instance_of?(String)
+      return false if @vin.chars.size != 17
+
+      @vin.chars.all? do |char|
+        DIGIT_BASE.include?(char) && char != '.'
+      end
+    end
+  end
+end

data/lib/vin_utils/version.rb

@@ -0,0 +1,3 @@
+module VinUtils
+  VERSION = '0.1.0'.freeze
+end

data/vin_utils.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/vin_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vin_utils'
+  spec.version       = VinUtils::VERSION
+  spec.authors       = ['Diego Stiehl']
+  spec.email         = ['seccomiro@users.noreply.github.com']
+
+  spec.summary       = 'A gem to check and suggest VIN identifiers'
+  spec.description   = 'A gem to check and suggest VIN identifiers'
+  spec.homepage      = 'https://github.com/seccomiro/vin_utils'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/seccomiro/vin_utils'
+  spec.metadata['changelog_uri'] = 'https://github.com/seccomiro/vin_utils'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: vin_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Diego Stiehl
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-26 00:00:00.000000000 Z
+dependencies: []
+description: A gem to check and suggest VIN identifiers
+email:
+- seccomiro@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/example
+- bin/setup
+- lib/vin_utils.rb
+- lib/vin_utils/validator.rb
+- lib/vin_utils/version.rb
+- vin_utils.gemspec
+homepage: https://github.com/seccomiro/vin_utils
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/seccomiro/vin_utils
+  source_code_uri: https://github.com/seccomiro/vin_utils
+  changelog_uri: https://github.com/seccomiro/vin_utils
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A gem to check and suggest VIN identifiers
+test_files: []