license-validator 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f87d7f82477a2235831fa7bde0b2571cc60cc497968c032025d4de7009685d87
-  data.tar.gz: 49b4763e53ae8eb56ced5a57835e45f879d687fffd5be4ed9740ecbca8f34aaf
+  metadata.gz: 765d257c1c164253fc920091c417c0b23315ddee7e4d1be7cf2b53d0afa31e53
+  data.tar.gz: 9cdb4da632bdacc45fdeec2b0532e9b747f0b92f60646cf3f2779af52f6520a8
 SHA512:
-  metadata.gz: 5c114aa2a168430f45c70f9fac41885a989b15800d6bea4cc20c91b9ed99ce185f6454fbf410ae06affe540347fad02150327e3c91ed62db96acc41567b59528
-  data.tar.gz: d24b0a625aadc735460faadee07e3b086706bef76a4ffaa074e7a3cc6288b3bf4e49ac81e85786345c5065a555c262d38fc0275a475a1d05b318f833d7436f36
+  metadata.gz: 8397c4a34805f88648398cf4a2e9787255b803413f88e13c37d4d2aa81d99df5b4b9c5544bb5b6f938d7d5afc51515d891d232f5a4d300af8b858856f91449f1
+  data.tar.gz: 273c364371d31a1810e29446786c46326b1385438a58cad2448ec61ecf170564f71e2b34da9e7467b0bd01ea98d837cda73d330408df39292cdf6072b0916f72

data/lib/license-validator.rb

@@ -1,6 +1,118 @@
 # frozen_string_literal: true
 
+require 'active_model'
+
+require_relative 'license_validator/states'
+
+require_relative 'license_validator/driver'
+require_relative 'license_validator/validators'
 require_relative 'license_validator/version'
 
 module LicenseValidator
+  # Validates the provided driver's DL#
+  #
+  # @raise [ActiveModel::ValidationError] if driver is invalid
+  #
+  # @see LicenseValidator::Driver#new params
+  #
+  # @return [Hash]
+  #
+  def validate!(**kwargs)
+    driver = LicenseValidator::Driver.new(**kwargs)
+
+    validator =
+      LicenseValidator::Validations
+        .const_get("LicenseValidator::Validations::State#{driver.state.capitalize}")
+        .new(driver)
+
+    validator.validate
+
+    return validator.validation_results
+  end
+
+  module_function :validate!
+
+  private
+
+    # Only for development
+    def generate_state_files
+      LicenseValidator::States::ABVS.each do |abv|
+        ruby = <<~RUBY
+          # frozen_string_literal: true
+
+          module LicenseValidator
+            module Validations
+              class State#{abv.capitalize} < LicenseValidator::Validations::Base
+                def initialize(driver)
+                  super(driver)
+                end
+
+                # @see super
+                def validate
+                  super
+                end
+              end
+            end
+          end
+        RUBY
+
+        File.write("lib/license_validator/validations/state_#{abv.downcase}.rb", ruby)
+      end
+    end
+
+    module_function :generate_state_files
+
+    # Only for development
+    def generate_test_files
+      LicenseValidator::States::ABVS.each do |abv|
+        test = <<~SPEC
+          # frozen_string_literal: true
+
+          state_klass = LicenseValidator::Validations::State#{abv.capitalize}
+
+          module ValidAttributes
+            module State#{abv.capitalize}
+              # @see super
+              def valid_attributes
+                super.map do |valid_attrs|
+                  valid_attrs
+                end
+              end
+
+              # @see super
+              def invalid_attributes
+                super.map do |invalid_attrs|
+                  invalid_attrs
+                end
+              end
+
+              private
+
+                # @see super
+                def valid_license_nums
+                  %w[AB123456]
+                end
+
+                # @see super
+                def invalid_license_nums
+                  %w[AB]
+                end
+
+                # @see super
+                def state
+                  '#{abv}'
+                end
+            end
+          end
+
+          state_klass.extend(ValidAttributes::State#{abv.capitalize})
+
+          test_klass(state_klass)
+        SPEC
+
+        File.write("spec/license_validator/validations/state_#{abv.downcase}_spec.rb", test)
+      end
+    end
+
+    module_function :generate_test_files
 end

data/lib/license_validator/driver.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  class Driver
+    include ActiveModel::Model
+
+    validates :age, numericality: { greater_than_or_equal_to: 0 }, if: -> (d) { d.dob.present? }
+    validates :cdl_class, inclusion: { in: ['A', 'B', 'No CDL'], message: 'is invalid' }
+    validates :license_num, presence: true
+    validates :state, inclusion: { in: LicenseValidator::States::ABVS, message: 'is invalid' }
+    validates :years_exp, numericality: { greater_than_or_equal_to: 0 }
+
+    # @return [Integer]
+    attr_accessor :age
+    # @return [Boolean]
+    attr_accessor :bad
+    # @return [String]
+    attr_accessor :cdl_class
+    # @return [Date]
+    attr_accessor :dob
+    # @return [String]
+    attr_accessor :first_name
+    # @return [String]
+    attr_accessor :last_name
+    # @return [String]
+    attr_accessor :license_num
+    # @return [String] abv
+    attr_accessor :state
+    # @return [Integer]
+    attr_accessor :years_exp
+
+    # @see super
+    def self.human_attribute_name(attr, options = {})
+      return 'CDL Class' if attr == 'cdl_class'
+
+      return 'License #' if attr == 'license_num'
+
+      super
+    end
+
+    # @param attributes [Hash]
+    def initialize(attributes = {})
+      super
+
+      if dob.blank? && !dob.is_a?(Date)
+        @dob = nil
+      end
+
+      @license_num = license_num.to_s
+
+      validate!
+    end
+
+    # @return [Hash]
+    def attributes
+      {
+        state: state,
+        years_exp: years_exp,
+        dob: dob,
+        age: age,
+        cdl_class: cdl_class,
+        license_num: license_num,
+        first_name: first_name,
+        last_name: last_name,
+        bad: bad
+      }
+    end
+  end
+end

data/lib/license_validator/states.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module States
+    ABVS = %w[
+      AK AL AR AZ CA CO CT DE FL GA
+      HI IA ID IL IN KS KY LA MA MD
+      ME MI MN MO MS MT NC ND NE NH
+      NJ NM NV NY OH OK OR PA RI SC
+      SD TN TX UT VA VT WA WI WV WY
+      DC
+    ].freeze
+  end
+end

data/lib/license_validator/validations/base.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class Base
+      # @return [LicenseValidator::Driver]
+      attr_accessor :driver
+      # @return [ActiveModel::Errors]
+      attr_accessor :errors
+      # @return [ActiveModel::Errors]
+      attr_accessor :infos
+      # @return [ActiveModel::Errors]
+      attr_accessor :warnings
+
+      # @param driver [LicenseValidator::Driver]
+      def initialize(driver)
+        @errors = ActiveModel::Errors.new(self)
+        @warnings = ActiveModel::Errors.new(self)
+        @infos = ActiveModel::Errors.new(self)
+
+        @driver = driver
+      end
+
+      # Common validations
+      def validate
+        return if driver.dob.nil?
+
+        age = driver.age
+
+        if age < 21
+          warnings.add(:dob, 'Drivers under 21 do not qualify for an interstate CDL.')
+        elsif age < 23
+          warnings.add(
+            :dob,
+            'Drivers under 23 are underage for all markets unless underwriters have specifically approved.'
+          )
+        elsif age > 65
+          warnings.add(
+            :dob,
+            [
+              'Drivers is older than 65, check underwriting guidelines to determine if they should be submitted',
+              'for approval.'
+            ].join(' ')
+          )
+        end
+
+        return unless driver.bad
+
+        warnings.add(:bad, 'Driver is on the bad drivers list.')
+      end
+
+      # @return [Hash]
+      def validation_results
+        {
+          errors: errors,
+          warnings: warnings,
+          infos: infos,
+          validated_with: driver.attributes
+        }
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_ak.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateAk < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        unless driver.license_num.match?(/\A\d{7}\z/i)
+          errors.add(:license_num, 'License number requires 7 numeric digits for AK.')
+        end
+
+        if driver.last_name.blank?
+          errors.add(:last_name, 'Last name required for AK.')
+        end
+
+        return if driver.dob.present?
+
+        errors.add(:dob, 'D.O.B. required for AK.')
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_al.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateAl < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        lic_num = driver.license_num
+
+        return if lic_num.match?(/\A\d{7,8}\z/i)
+
+        return if lic_num.match?(/\A[a-z]\d{6,8}\z/i)
+
+        return if lic_num.match?(/\AID\d{5,6}\z/i)
+
+        errors.add(
+          :license_num,
+          [
+            'License number requires 7-8 Numeric or "I", 6-8 Numeric or "ID", 5-6 Numeric or 1 Alphabetic, 6-8 Numeric',
+            'for AL'
+          ].join(' ')
+        )
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_ar.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateAr < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        unless driver.license_num.match?(/\A\d{9}\z/i)
+          errors.add(:license_num, 'License number requires 9 numeric digits for AR.')
+        end
+
+        return if driver.dob.present?
+
+        errors.add(:dob, 'D.O.B. is required for AR.')
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_az.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateAz < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        if driver.last_name.blank?
+          errors.add(:last_name, 'Last name required for AZ.')
+        end
+
+        if driver.first_name.blank?
+          errors.add(:first_name, 'First name required for AZ.')
+        end
+
+        if driver.dob.blank?
+          errors.add(:dob, 'D.O.B. required for AZ.')
+        end
+
+        lic_num = driver.license_num
+
+        return if lic_num.match?(/\A[a-z]\d{8}\z/i)
+
+        return if lic_num.match?(/\A\d{9}\z/i)
+
+        errors.add(:license_num, 'License number requires 1 Alphabetic, 8 Numeric or 9 Numeric for AZ.')
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_ca.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateCa < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        unless driver.license_num.match?(/\A[a-z]\d{7}\z/i)
+          errors.add(:license_num, 'License number requires 1 Alphabetic, 7 Numeric for CA.')
+        end
+
+        return if driver.last_name.present?
+
+        errors.add(:last_name, 'Last name required for CA.')
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_co.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateCo < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        if driver.dob.blank?
+          errors.add(:dob, 'D.O.B. is required for CO.')
+        end
+
+        lic_num = driver.license_num
+
+        return if lic_num.match?(/\A\d{9}\z/i)
+
+        return if lic_num.match?(/\A[a-z]\d{3,6}\z/i)
+
+        errors.add(:license_num, 'License number requires 9 numeric or 1 alphabetic, 3-6 numeric for CO.')
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_ct.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateCt < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        if driver.last_name.blank?
+          errors.add(:last_name, 'Last name required for CT.')
+        end
+
+        # 9 Numeric, 1st two positions are month of birth in odd or
+        # even year. 01-12 Jan-Dec odd years, 13 - 24 Jan-Dec even years, 99 unknown
+
+        if driver.dob.blank?
+          errors.add(:dob, 'D.O.B. is required for CT.')
+
+          return
+        end
+
+        year = driver.dob.year
+        month = driver.dob.month
+
+        month += 12 if year.even?
+
+        month = "#{0 if month < 10}#{month}"
+
+        regex = Regexp.new("\\A#{month}\\d{7}\\z", 'i')
+
+        return if driver.license_num.match?(regex)
+
+        errors.add(
+          :license_num,
+          "License number requires 9 numeric for CT. For DOB in #{year}, license number must start with #{month}"
+        )
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_dc.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateDc < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        unless driver.license_num.match?(/\A[a-z0-9]{7,9}\z/i)
+          errors.add(:license_num, 'License number requires 7-9 alphanumeric for DC.')
+        end
+
+        if driver.last_name.blank?
+          errors.add(:last_name, 'Last name required for DC.')
+        end
+
+        return if driver.dob.present?
+
+        errors.add(:dob, 'D.O.B. required for DC.')
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_de.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateDe < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        return if driver.license_num.match?(/\A\d{1,7}\z/i)
+
+        errors.add(:license_num, 'License requires 1-7 numeric for DE.')
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_fl.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateFl < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        return if driver.license_num.match?(/\A[a-zA-Z]\d{12}\z/i)
+
+        errors.add(:license_num, 'License number requires 1 alphabetic and 12 numeric for FL.')
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_ga.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateGa < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        unless driver.license_num.match?(/\A\d{9}\z/i)
+          errors.add(:license_num, 'License number requires 9 numeric digits for GA.')
+        end
+
+        if driver.first_name.blank?
+          errors.add(:first_name, 'First name required for GA.')
+        end
+
+        if driver.last_name.blank?
+          errors.add(:last_name, 'Last name required for GA.')
+        end
+
+        return if driver.dob.present?
+
+        errors.add(:dob, 'D.O.B. required for GA.')
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_hi.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateHi < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        if driver.last_name.blank?
+          errors.add(:last_name, 'Last name required for HI.')
+        end
+
+        if driver.dob.blank?
+          errors.add(:dob, 'D.O.B. required for HI.')
+        end
+
+        lic_num = driver.license_num
+
+        return if lic_num.match?(/\A\d{9}\z/i)
+
+        return if lic_num.match?(/\AH\d{8}\z/i)
+
+        errors.add(:license_num, 'License number needs 9 numeric or "H", 8 numeric for HI.')
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_ia.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateIa < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        lic_num = driver.license_num
+
+        return if lic_num.match?(/\A\d{3}[a-z]{2}\d{4}\z/i)
+
+        return if lic_num.match?(/\A\d{9}\z/i)
+
+        errors.add(
+          :license_num,
+          'License number requires 3 Numeric and 2 Alphabetic and 4 Numeric, or 9 numeric for IA.'
+        )
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_id.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateId < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        if driver.last_name.blank?
+          errors.add(:last_name, 'Last name required for ID.')
+        end
+
+        if driver.dob.blank?
+          errors.add(:dob, 'D.O.B. required for ID.')
+        end
+
+        lic_num = driver.license_num
+
+        return if lic_num.match?(/\A[a-z]{2}\d{6}[a-z]\z/i)
+
+        return if lic_num.match?(/\A\d{9}\z/i)
+
+        errors.add(:license_num, 'License number requires 2 Alphabetic, 6 Numeric, 1 Alphabetic or 9 Numeric for ID.')
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_il.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateIl < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        return if driver.license_num.match?(/\A[a-z]\d{11}\z/i)
+
+        errors.add(:license_num, 'License number requires 1 alphabetic and 11 numeric for IL.')
+      end
+    end
+  end
+end

data/lib/license_validator/validations/state_in.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module LicenseValidator
+  module Validations
+    class StateIn < LicenseValidator::Validations::Base
+      # @see super
+      def validate
+        super
+
+        return if driver.license_num.match?(/\A\d{10}\z/i)
+
+        errors.add(:license_num, 'License number requires 10 numeric digits for IN.')
+      end
+    end
+  end
+end