vin_decoder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f129f1c9b8e8d9e6531231a078ea74d9b64b4b98c5e71ddabfebb263781c5bf9
+  data.tar.gz: 85a10ee709afb2807d4b40ec82c9c1e0909147b7d6c2e967fdb65917afb0aa16
+SHA512:
+  metadata.gz: dffa00fec79bb94acb69f5d54f5febfc5053e9067baf299c8d4c0d3522990dd5eaa13c4c015d76b52bf6644b844fc692d9495117c211dc797ff039dc37397735
+  data.tar.gz: ad03e97f4845f4b84a3e79ec0067e3711a0ea33011ab63150e29e1317f4729b4acb56fcdcfb9b5d2c46759161fec6ce96fff87fb0dbe5c0156a897c3d4026060

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,140 @@
+# VinDecoder
+
+vin_decoder is a lightweight Ruby client for the NHTSA vPIC API. It decodes 17-character VINs and exposes a tidy domain object so you can access make, model, year, powertrain data, and more without sifting through raw JSON.
+
+## Installation
+
+Add the gem to your project (when published):
+
+```ruby
+gem 'vin_decoder'
+```
+
+Or install directly from source:
+
+```bash
+git clone https://github.com/Wenmar-Pro/vin_decoder.git
+cd vin_decoder
+bundle install
+```
+
+## Configuration
+
+Use the top-level `VinDecoder.configure` block to customize the base URL (handy for mocking) or request timeout. Defaults target the official NHTSA API with a 10-second timeout.
+
+```ruby
+VinDecoder.configure do |config|
+  config.base_url = 'https://vpic.nhtsa.dot.gov/api/vehicles'
+  config.timeout = 5
+end
+```
+
+## Usage
+
+```ruby
+client = VinDecoder::Client.new
+vehicle = client.decode('1HGCM82633A004352')
+
+if vehicle.valid?
+  puts [vehicle.year, vehicle.make, vehicle.model].compact.join(' ')
+  puts "Engine: #{vehicle.engine} (#{vehicle.engine_cylinders} cylinders)"
+  puts "Fuel: #{vehicle.fuel_type}"
+  puts "Fuel type (raw accessor): #{vehicle['FuelTypePrimary']}"
+  puts "Lot size (dynamic): #{vehicle.lot_size}"
+else
+  warn 'VIN could not be decoded'
+end
+```
+
+The client raises:
+
+- `VinDecoder::NotFoundError` when the API responds with HTTP 404.
+- `VinDecoder::ApiError` for any other non-200 HTTP status code.
+
+Each `VinDecoder::Vehicle` exposes the entire response payload:
+
+- Common helper methods (`make`, `model`, `trim`, `engine`, etc.).
+- Hash-style access with string or symbol keys (`vehicle['ModelYear']` / `vehicle[:ModelYear]`).
+- Dynamic snake_case readers derived from the raw keys (`vehicle.vehicle_descriptor`, `vehicle.fuel_type_secondary`). Missing fields raise `NoMethodError` so mistakes are caught quickly.
+
+## Rails Integration
+
+Add the gem to your Rails app (from RubyGems or a local path while developing).
+
+```ruby
+# Gemfile
+gem 'vin_decoder', path: '../path/to/vin_decoder'
+```
+
+Create an initializer to configure timeouts and base URL:
+
+```ruby
+# config/initializers/vin_decoder.rb
+VinDecoder.configure do |config|
+  config.timeout = ENV.fetch('VIN_DECODER_TIMEOUT', 5).to_i
+  config.base_url = ENV.fetch('VIN_DECODER_BASE_URL', 'https://vpic.nhtsa.dot.gov/api/vehicles')
+end
+```
+
+Wrap the client in a PORO/service for controllers or jobs:
+
+```ruby
+# app/services/vin_lookup.rb
+class VinLookup
+  def initialize(client: VinDecoder::Client.new)
+    @client = client
+  end
+
+  def call(vin)
+    vehicle = @client.decode(vin)
+    raise VinDecoder::NotFoundError unless vehicle.valid?
+
+    vehicle
+  end
+end
+```
+
+Example controller usage:
+
+```ruby
+class VehiclesController < ApplicationController
+  def show
+    @vehicle = VinLookup.new.call(params[:vin])
+  rescue VinDecoder::NotFoundError
+    redirect_to root_path, alert: 'VIN not found'
+  end
+end
+```
+
+You can also enqueue lookups via ActiveJob/Sidekiq and cache results to avoid repeated external calls.
+
+## Testing & VCR Cassettes
+
+Tests run via RSpec and rely on VCR/WebMock for deterministic HTTP interactions.
+
+```bash
+bundle exec rspec
+```
+
+To refresh the live cassette, delete `spec/fixtures/vcr_cassettes/decode_success.yml` and rerun the specs. VCR will connect to the real API once, capture the response, and reuse it on subsequent runs.
+
+## Publishing Checklist
+
+1. Ensure version in `lib/vin_decoder/version.rb` reflects the release.
+2. Update `CHANGELOG` or release notes as needed (add one if not yet created).
+3. Build the gem and inspect the package contents:
+
+   ```bash
+   gem build vin_decoder.gemspec
+   gem install vin_decoder-<version>.gem
+   ```
+
+4. Push the artifact to RubyGems:
+
+   ```bash
+   gem push vin_decoder-<version>.gem
+   ```
+
+5. Tag the release in git and push tags to GitHub for reference.
+
+That’s it—you now have a fully tested VIN decoder client ready for reuse or publication.

data/lib/vin_decoder/client.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module VinDecoder
+  class Client
+    def initialize
+      config = VinDecoder.configuration || Configuration.new
+      @connection = Faraday.new(url: config.base_url) do |faraday|
+        faraday.options.timeout = config.timeout
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def decode(vin)
+      response = @connection.get("DecodeVinValuesExtended/#{vin}", format: 'json')
+
+      handle_response(response)
+    end
+
+    private
+
+    def handle_response(response)
+      case response.status
+      when 200
+        payload = JSON.parse(response.body)
+        result_hash = payload['Results']&.first || {}
+        Vehicle.new(result_hash)
+      when 404
+        raise NotFoundError, 'VIN not found'
+      else
+        raise ApiError, "API returned status #{response.status}: #{response.body}"
+      end
+    end
+  end
+end

data/lib/vin_decoder/configuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module VinDecoder
+  class Configuration
+    attr_accessor :base_url, :timeout
+
+    def initialize
+      @base_url = "https://vpic.nhtsa.dot.gov/api/vehicles"
+      @timeout = 10
+    end
+  end
+end

data/lib/vin_decoder/vehicle.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module VinDecoder
+  class Vehicle
+    attr_reader :raw_data
+
+    def initialize(data)
+      @raw_data = data || {}
+    end
+
+    def make
+      raw_data['Make']
+    end
+
+    def model
+      raw_data['Model']
+    end
+
+    def year
+      raw_data['ModelYear']
+    end
+
+    def engine_cylinders
+      raw_data['EngineCylinders']
+    end
+
+    def engine
+      raw_data['EngineConfiguration']
+    end
+
+    def fuel_type
+      raw_data['FuelTypePrimary']
+    end
+
+    def trim
+      raw_data['Trim']
+    end
+
+    def [](key)
+      raw_data[key.to_s]
+    end
+
+    def valid?
+      raw_data['ErrorCode'] == '0'
+    end
+
+    def to_h
+      raw_data.dup
+    end
+
+    def method_missing(method_name, *args, &block)
+      return super unless args.empty?
+
+      key = lookup_key(method_name)
+      return super unless key
+
+      raw_data[key]
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      lookup_key(method_name) || super
+    end
+
+    private
+
+    def lookup_key(method_name)
+      return if method_name.nil?
+
+      normalized_key_cache[method_name] ||= begin
+        normalized = method_name.to_s
+        raw_data.keys.find { |key| normalize_key(key) == normalized }
+      end
+    end
+
+    def normalized_key_cache
+      @normalized_key_cache ||= {}
+    end
+
+    def normalize_key(key)
+      key.to_s
+         .gsub(/[^a-zA-Z0-9]+/, '_')
+         .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+         .downcase
+    end
+  end
+end

data/lib/vin_decoder/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module VinDecoder
+  VERSION = '0.1.0'
+end

data/lib/vin_decoder.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "faraday"
+require "json"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module VinDecoder
+  class Error < StandardError; end
+  class ApiError < Error; end
+  class NotFoundError < Error; end
+
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: vin_decoder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben D'Angelo
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Decodes 17-character VINs to provide vehicle specifications like make,
+  model, and engine type.
+email:
+- ben@bendangelo.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/vin_decoder.rb
+- lib/vin_decoder/client.rb
+- lib/vin_decoder/configuration.rb
+- lib/vin_decoder/vehicle.rb
+- lib/vin_decoder/version.rb
+homepage: https://github.com/Wenmar-Pro/vin_decoder
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.8
+specification_version: 4
+summary: A Ruby client for the NHTSA vPIC VIN decoding API.
+test_files: []