vin-validator 1.0.0 → 1.1.0.pre.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c3d04d4468c96f8cbed1cf0e44dd34ef3d46fdf263b7fe3ad09c48d90c9224b
-  data.tar.gz: '09f46ff94ce6201b670e23e0e7b0e7da1a1d9559420f459f280f4202e665b433'
+  metadata.gz: d8e5a52d479ddb4dd27dd04bd8f913aaaaea50fee21536ca8bed3062c1ef84b6
+  data.tar.gz: 728d00c37bfc36d52cb3d71e9e5ebdcac7fc37a15f704cabd175d095a51f426c
 SHA512:
-  metadata.gz: 893b7796831b1b524a0116e252ab5cb4c9ba8d2b16c5c65e15111e02513e373d7eb7fc38bc4adb3ab5594e683dfed9aef6361662a9ed41730623f7f991411a3b
-  data.tar.gz: a60f59a6b161b07bcce6d0b355f2b96a84376545ae879f55ebb55d3b20d677b6fbebfde52b44e204ac3d8cc53d03d0eaeba49edae705b809f97ba3d5d69085b0
+  metadata.gz: f89831b12d70327d1b8cc2b69dee43a09b1b0ae10453117021b45050bc0fdb7a35e7e935e875fccdff806c84f55b54dd56f7f1c138d8a53c1e7ba9fcaf17a78a
+  data.tar.gz: 940a7c613399ce02e4a2cd4e24f02ac069ce6869268326134267f86f76fa50b00bc848d9f536cadc265060edc021292b663348bfcbf5d2dc0dbe3d06eed1ec62

data/CHANGELOG.adoc

@@ -1,3 +1,8 @@
+= 1.1.0
+
+* Added ``VinValidator::Knowledge::validate``
+** Track revolving 30 years too
+
 = 1.0.0
 
 * Intial Release

data/README.adoc

@@ -21,6 +21,8 @@ Or install it yourself as:
 
 == Usage
 
+=== ``vin_info``
+
 [source,ruby]
 ----
 just_a_vin = 'AA5325L1588827'
@@ -86,6 +88,57 @@ Value hash:
 * ``type`` - The type of result (``error``, ``make``, ``year``, etc)
 * ``value`` - The value of the result
 
+=== ``validate``
+
+[source,ruby]
+----
+just_a_vin = 'AA5325L1588827'
+other_vins = %w[13N153201K1533942 1E9AA5325L1588827 1RND48A27GR039983 1RND53A33KR049282]
+
+VinValidator::Knowledge.validate(just_a_vin).fetch(just_a_vin)
+
+VinValidator::Knowledge.validate(just_a_vin, true).fetch(just_a_vin)
+
+VinValidator::Knowledge.validate(other_vins)
+
+VinValidator::Knowledge.validate(other_vins, true)
+----
+
+Every call to ``VinValidator::Knowledge::vin_info`` will return a hash.
+Each key in the result is one of the VINs provided, and each value is another hash.
+
+Value hash:
+
+|===
+|Key |Value |Description
+
+|``:valid``
+|``Boolean``
+|``false`` if there are errors or year/wmi is blank
+
+|``:year``
+|``Hash``, ``Nil``
+|``:letter``(``String``) and ``:year``(``Integer``)
+
+|``:wmi``
+|``Array<VinValidator::Result>``
+|Possible makes the VIN can have
+
+|``:infos``
+|``Array<String>``
+|The info messages
+
+|``:errors``
+|``Array<String>``
+|The error messages
+|===
+
+``VinValidator::Result`` has 3 attributes: ``vin``, ``type``, and ``value``.
+
+* ``vin`` - The vin the result belongs to
+* ``type`` - The type of result (``error``, ``make``, ``year``, etc)
+* ``value`` - The value of the result
+
 == Changelog
 
 See xref:./CHANGELOG.adoc[CHANGELOG] see changes

data/lib/vin-validator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
+require_relative 'vin_validator/base_model'
 require_relative 'vin_validator/knowledge'
 require_relative 'vin_validator/version'
 require 'net/http'

data/lib/vin_validator/base_model.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module VinValidator
+  class BaseModel
+    class << self
+      # Loads all objects
+      #
+      # @return [Hash]
+      #
+      def all
+        return @all if defined?(@all)
+
+        all = JSON.parse(File.read(File.join(__dir__, "#{filename}.json")), { symbolize_names: true }).map do |id, v|
+          [id.to_s, new(**v)]
+        end
+
+        @all = all.to_h
+      end
+
+      private
+
+        # Basename of the JSON file to read
+        #
+        # @return [String]
+        #
+        def filename
+          ''
+        end
+    end
+  end
+end

data/lib/vin_validator/knowledge.rb

@@ -3,11 +3,74 @@
 require_relative './api'
 require_relative './maker'
 require_relative './result'
+require_relative './year'
 require_relative './wmi'
 
 module VinValidator
   class Knowledge
     class << self
+      # Validates each vin provided
+      #
+      # @param vins [String, Array<String>]
+      # @param hit_nhtsa [Boolean] if `true`, query NHTSA. default: `false`
+      #
+      # @return [Hash]
+      #
+      def validate(vins, hit_nhtsa = false)
+        check_types = {
+          body_type: 'Body type',
+          trailer_type: 'Trailer type',
+          vehicle_type: 'Vehicle type',
+          gvw: 'GVW'
+        }
+
+        results = vin_info(vins, hit_nhtsa).map do |vin, simple_check|
+          unless simple_check.fetch(:errors).empty?
+            next [vin, {
+              valid: false,
+              wmi: [],
+              errors: simple_check.fetch(:errors).map(&:value)
+            }]
+          end
+
+          vin_split = vin.split('')
+
+          vin_wmi = vin_split[0..2].join
+          vin_year = vin_split[9].to_s
+          year = VinValidator::Year.find_by(letter: vin_year)
+
+          possible_wmis = Array(simple_check[:make])
+
+          errors = []
+
+          if possible_wmis.empty?
+            errors = [
+              'The manufacturer is not a manufacturer of trucking equipment.',
+              'If they are, contact the site admin to add them as a manufacturer.'
+            ]
+          end
+
+          infos = []
+          check_types.each do |type, human_type|
+            next if simple_check.dig(type).nil?
+            next if simple_check.fetch(type).value.nil?
+            next if simple_check.fetch(type).value.empty?
+
+            infos << "NHTSA says #{human_type} is #{simple_check.fetch(type).value}"
+          end
+
+          [vin, {
+            valid: !year.nil? && !possible_wmis.empty?,
+            year: year,
+            errors: errors,
+            wmi: possible_wmis.uniq(&:value),
+            infos: infos
+          }]
+        end
+
+        results.to_h
+      end
+
       # Gathers/builds info for each vin provided
       #
       # @param vins [String, Array<String>]

data/lib/vin_validator/maker.rb

@@ -1,22 +1,8 @@
 # frozen_string_literal: true
 
 module VinValidator
-  class Maker
+  class Maker < VinValidator::BaseModel
     class << self
-      # Loads all makers
-      #
-      # @return [Hash]
-      #
-      def all
-        return @all if defined?(@all)
-
-        all = JSON.parse(File.read(File.join(__dir__, 'makers.json')), { symbolize_names: true }).map do |id, v|
-          [id.to_s, new(**v)]
-        end
-
-        @all = all.to_h
-      end
-
       # Finds the maker with the given `id`
       #
       # @return [VinValidator::Maker]
@@ -24,6 +10,13 @@ module VinValidator
       def find(id)
         all.fetch(id.to_s)
       end
+
+      private
+
+        # @see super
+        def filename
+          'makers'
+        end
     end
 
     # @return [Integer]

data/lib/vin_validator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VinValidator
-  VERSION = '1.0.0'
+  VERSION = '1.1.0-rc.2'
 end

data/lib/vin_validator/wmi.rb

@@ -1,22 +1,8 @@
 # frozen_string_literal: true
 
 module VinValidator
-  class Wmi
+  class Wmi < VinValidator::BaseModel
     class << self
-      # Loads all wmis
-      #
-      # @return [Hash]
-      #
-      def all
-        return @all if defined?(@all)
-
-        all = JSON.parse(File.read(File.join(__dir__, 'wmis.json')), { symbolize_names: true }).map do |id, v|
-          [id.to_s, new(**v)]
-        end
-
-        @all = all.to_h
-      end
-
       # Finds the wmi with the given `id`
       #
       # @return [VinValidator::Wmi]
@@ -32,6 +18,13 @@ module VinValidator
       def where(wmi:)
         all.values.select { |w| w.wmi == wmi }
       end
+
+      private
+
+        # @see super
+        def filename
+          'wmis'
+        end
     end
 
     # @return [Integer]

data/lib/vin_validator/year.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module VinValidator
+  class Year < VinValidator::BaseModel
+    class << self
+      # Finds the year with the given `letter`
+      #
+      # @return [VinValidator::Year]
+      #
+      def find_by(letter:)
+        all.dig(letter.to_s)
+      end
+
+      private
+
+        # @see super
+        def filename
+          'years'
+        end
+    end
+
+    # @return [Integer]
+    attr_accessor :id
+    # @return [Integer]
+    attr_accessor :year
+    # @return [String]
+    attr_accessor :letter
+
+    # :nodoc:
+    def initialize(id:, year:, letter:)
+      @id = id
+      @year = year
+      @letter = letter
+    end
+  end
+end

data/lib/vin_validator/years.json

@@ -0,0 +1,152 @@
+{
+  "1": {
+    "id": 1,
+    "letter": "1",
+    "year": "2001"
+  },
+  "2": {
+    "id": 2,
+    "letter": "2",
+    "year": "2002"
+  },
+  "3": {
+    "id": 3,
+    "letter": "3",
+    "year": "2003"
+  },
+  "4": {
+    "id": 4,
+    "letter": "4",
+    "year": "2004"
+  },
+  "5": {
+    "id": 5,
+    "letter": "5",
+    "year": "2005"
+  },
+  "6": {
+    "id": 6,
+    "letter": "6",
+    "year": "2006"
+  },
+  "7": {
+    "id": 7,
+    "letter": "7",
+    "year": "2007"
+  },
+  "8": {
+    "id": 8,
+    "letter": "8",
+    "year": "2008"
+  },
+  "9": {
+    "id": 9,
+    "letter": "9",
+    "year": "2009"
+  },
+  "A": {
+    "id": 10,
+    "letter": "A",
+    "year": "2010"
+  },
+  "B": {
+    "id": 11,
+    "letter": "B",
+    "year": "2011"
+  },
+  "C": {
+    "id": 12,
+    "letter": "C",
+    "year": "2012"
+  },
+  "D": {
+    "id": 13,
+    "letter": "D",
+    "year": "2013"
+  },
+  "E": {
+    "id": 14,
+    "letter": "E",
+    "year": "2014"
+  },
+  "F": {
+    "id": 15,
+    "letter": "F",
+    "year": "2015"
+  },
+  "G": {
+    "id": 16,
+    "letter": "G",
+    "year": "2016"
+  },
+  "H": {
+    "id": 17,
+    "letter": "H",
+    "year": "2017"
+  },
+  "J": {
+    "id": 18,
+    "letter": "J",
+    "year": "2018"
+  },
+  "K": {
+    "id": 19,
+    "letter": "K",
+    "year": "2019"
+  },
+  "L": {
+    "id": 20,
+    "letter": "L",
+    "year": "2020"
+  },
+  "M": {
+    "id": 21,
+    "letter": "M",
+    "year": "2021"
+  },
+  "N": {
+    "id": 22,
+    "letter": "N",
+    "year": "2022"
+  },
+  "P": {
+    "id": 23,
+    "letter": "P",
+    "year": "2023"
+  },
+  "R": {
+    "id": 24,
+    "letter": "R",
+    "year": "2024"
+  },
+  "S": {
+    "id": 25,
+    "letter": "S",
+    "year": "1995"
+  },
+  "T": {
+    "id": 26,
+    "letter": "T",
+    "year": "1996"
+  },
+  "V": {
+    "id": 27,
+    "letter": "V",
+    "year": "1997"
+  },
+  "W": {
+    "id": 28,
+    "letter": "W",
+    "year": "1998"
+  },
+  "X": {
+    "id": 29,
+    "letter": "X",
+    "year": "1999"
+  },
+  "Y": {
+    "id": 30,
+    "letter": "Y",
+    "year": "2000"
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vin-validator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0.pre.rc.2
 platform: ruby
 authors:
 - Brands Insurance
@@ -36,6 +36,7 @@ files:
 - README.adoc
 - lib/vin-validator.rb
 - lib/vin_validator/api.rb
+- lib/vin_validator/base_model.rb
 - lib/vin_validator/knowledge.rb
 - lib/vin_validator/maker.rb
 - lib/vin_validator/makers.json
@@ -43,6 +44,8 @@ files:
 - lib/vin_validator/version.rb
 - lib/vin_validator/wmi.rb
 - lib/vin_validator/wmis.json
+- lib/vin_validator/year.rb
+- lib/vin_validator/years.json
 homepage: https://github.com/BrandsInsurance/vin-validator/
 licenses:
 - MIT
@@ -62,9 +65,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.10
 signing_key: