vin_decoder 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f129f1c9b8e8d9e6531231a078ea74d9b64b4b98c5e71ddabfebb263781c5bf9
-  data.tar.gz: 85a10ee709afb2807d4b40ec82c9c1e0909147b7d6c2e967fdb65917afb0aa16
+  metadata.gz: 073e7f76a91c5ffa0a0f51ce7e1e79eb841d64226ecec897ee3f0961fdadcd49
+  data.tar.gz: 569ca3f1aceaa812b5774a9918344fd5058d96805eb93c13e552409f97d25c43
 SHA512:
-  metadata.gz: dffa00fec79bb94acb69f5d54f5febfc5053e9067baf299c8d4c0d3522990dd5eaa13c4c015d76b52bf6644b844fc692d9495117c211dc797ff039dc37397735
-  data.tar.gz: ad03e97f4845f4b84a3e79ec0067e3711a0ea33011ab63150e29e1317f4729b4acb56fcdcfb9b5d2c46759161fec6ce96fff87fb0dbe5c0156a897c3d4026060
+  metadata.gz: 75ab1904faf87ca88d4168f932371cad5330224cd57eb3fbea73644b08928636e83f1483bd006067e8786b2e9983907e4fb739d378fb1579b87c76067124a875
+  data.tar.gz: 294b449d927b031fcc00cc0bb263d4e107195464b7724741049de395e864b9c1b5c94ebfc8a09eb8bb6261cebe1483c99387b86f0c43a7f00c96bf2892b271a6

data/README.md

@@ -2,6 +2,8 @@
 
 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.
 
+This is used on [Wenmar Pro](https://wenmarpro.com), a shop management software.
+
 ## Installation
 
 Add the gem to your project (when published):
@@ -31,14 +33,32 @@ end
 
 ## Usage
 
+### Module-level shortcut
+
+```ruby
+vehicle = VinDecoder.decode('1HGCM82633A004352')
+
+if vehicle.valid?
+  puts [vehicle.year, vehicle.make, vehicle.model].compact.join(' ')
+  # => "2003 HONDA Accord"
+else
+  warn 'VIN could not be decoded'
+end
+```
+
+### Client instance
+
 ```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 "Body style: #{vehicle.body_style}"
+  puts "Transmission: #{vehicle.transmission}"
+  puts "Drivetrain: #{vehicle.drivetrain}"
+  puts "Submodel: #{vehicle.submodel}"
   puts "Fuel type (raw accessor): #{vehicle['FuelTypePrimary']}"
   puts "Lot size (dynamic): #{vehicle.lot_size}"
 else
@@ -51,11 +71,33 @@ The client raises:
 - `VinDecoder::NotFoundError` when the API responds with HTTP 404.
 - `VinDecoder::ApiError` for any other non-200 HTTP status code.
 
+### Vehicle object
+
 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.
+- **Common helper methods**: `make`, `model`, `year`, `trim`, `submodel`, `body_style`, `engine`, `engine_cylinders`, `transmission`, `drivetrain`, `fuel_type`, `vin`.
+- **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.
+- **`to_h`** — Returns a plain Ruby hash with all structured fields, suitable for serializing or passing to form builders:
+
+```ruby
+vehicle.to_h
+# => {
+#   vin: "1HGCM82633A004352",
+#   year: "2003",
+#   make: "HONDA",
+#   model: "Accord",
+#   submodel: "EX-V6",
+#   body_style: "...",
+#   engine: "HONDA V6 240",
+#   transmission: "...",
+#   drivetrain: "...",
+#   fuel_type: "Gasoline",
+#   raw_data: { ... },
+#   trim: "EX-V6",
+#   engine_cylinders: "6"
+# }
+```
 
 ## Rails Integration
 
@@ -137,4 +179,4 @@ To refresh the live cassette, delete `spec/fixtures/vcr_cassettes/decode_success
 
 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.
+That's it—you now have a fully tested VIN decoder client ready for reuse or publication.

data/lib/vin_decoder/client.rb

@@ -13,17 +13,17 @@ module VinDecoder
     def decode(vin)
       response = @connection.get("DecodeVinValuesExtended/#{vin}", format: 'json')
 
-      handle_response(response)
+      handle_response(response, vin)
     end
 
     private
 
-    def handle_response(response)
+    def handle_response(response, vin)
       case response.status
       when 200
         payload = JSON.parse(response.body)
         result_hash = payload['Results']&.first || {}
-        Vehicle.new(result_hash)
+        Vehicle.new(result_hash, vin: vin)
       when 404
         raise NotFoundError, 'VIN not found'
       else

data/lib/vin_decoder/vehicle.rb

@@ -2,10 +2,11 @@
 
 module VinDecoder
   class Vehicle
-    attr_reader :raw_data
+    attr_reader :raw_data, :vin
 
-    def initialize(data)
+    def initialize(data, vin: nil)
       @raw_data = data || {}
+      @vin = vin
     end
 
     def make
@@ -20,12 +21,32 @@ module VinDecoder
       raw_data['ModelYear']
     end
 
+    def submodel
+      raw_data['Series']
+    end
+
+    def body_style
+      raw_data['BodyClass']
+    end
+
     def engine_cylinders
       raw_data['EngineCylinders']
     end
 
     def engine
-      raw_data['EngineConfiguration']
+      [
+        raw_data['EngineManufacturer'],
+        raw_data['EngineModel'],
+        raw_data['EngineHP']
+      ].compact.join(' ').presence
+    end
+
+    def transmission
+      raw_data['TransmissionDescriptor']
+    end
+
+    def drivetrain
+      raw_data['DriveType']
     end
 
     def fuel_type
@@ -45,7 +66,21 @@ module VinDecoder
     end
 
     def to_h
-      raw_data.dup
+      {
+        vin: vin,
+        year: year,
+        make: make,
+        model: model,
+        submodel: submodel,
+        body_style: body_style,
+        engine: engine,
+        transmission: transmission,
+        drivetrain: drivetrain,
+        fuel_type: fuel_type,
+        raw_data: raw_data,
+        trim: trim,
+        engine_cylinders: engine_cylinders
+      }
     end
 
     def method_missing(method_name, *args, &block)

data/lib/vin_decoder/version.rb

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

data/lib/vin_decoder.rb

@@ -19,5 +19,9 @@ module VinDecoder
       self.configuration ||= Configuration.new
       yield(configuration)
     end
+
+    def decode(vin)
+      Client.new.decode(vin)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vin_decoder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben D'Angelo
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.8
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A Ruby client for the NHTSA vPIC VIN decoding API.
 test_files: []