nhtsa_vin 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b59380a0e5ddb9e3885510cc564dfe25aa0bc3f7
-  data.tar.gz: 5b5e62bc3c546f638da79f78defe1b549e20ec0e
+  metadata.gz: 304f6e9a4706dcfd739db613ae7c72498315105c
+  data.tar.gz: d4d6d09d018be6ad53808f6f1373fd2bf8ab1b62
 SHA512:
-  metadata.gz: ca9557397db41dceaa8e7db53e26f7560b63e6bee043912dfa39107490d0e36c51e3bd7ecb2f6bac7c60aadfb3b7c3d8d399be31fa1f3ad9994bc0fc5b67e02b
-  data.tar.gz: b73345bd38a58f64fe14b252f1d05b016d9770658560e5ff71e65803baf1adeca134b16a86fa27abf7ccff0e944d8954e5c9ac5b0cc03acffbcbe859c1496151
+  metadata.gz: 85c5e99bbd033576db5f582aeaff92ec8317fa74e459d58e8e68a396b134d2cdeebd601fb43d0446274e04ea26e24b7706d1047ae18ce1237b4f017cc4bc3716
+  data.tar.gz: 2d5b4cb48f8ebab768ce8ee7cda45bb5b2dc106e15bb6a09892195ea9570ea79da42ff06423c2f928a4b874d147c9b71c216594871dbc951807154a800592570

data/.gitignore

@@ -4,3 +4,5 @@ rdoc/*
 *.gem
 .bundle
 Gemfile.lock
+.idea/*
+coverage/*

data/README.md

@@ -30,16 +30,23 @@ Or install it yourself as:
 Validation
 ----
 
-Prior to dispatching a call to the web service, you can optionally validate a given VIN first. 
+Prior to dispatching a call to the web service, you can optionally validate a given VIN first. Calling `#validate` returns an `NhtsaVin::Validation`.
 
 ```ruby
-validation = NhtsaVin.Validate.new('1J4BA5H11AL143811') # => <#NhtsaVin.Validate>
+validation = NhtsaVin.validate('1J4BA5H11AL143811') # => <#NhtsaVin.Validate>
 validation.valid? # => true
-validation.checksum # => 1
 
-validation = NhtsaVin.Validate.new('SOMEBADVIN') # => <#NhtsaVin.Validate>
+validation = NhtsaVin.validate('SOMEBADVIN') # => <#NhtsaVin.Validate>
 validation.valid? # => false
-validation.checksum # => nil
+validation.error # => 'Invalid VIN format'
+```
+
+Once validated, the validation also provides the components of a VIN, and additional information
+
+```ruby
+validation = NhtsaVin.validate('1J4BA5H11AL143811') # => <#NhtsaVin.Validate>
+validation.checksum # => '1'
+validation.plant # => 'L'
 ```
 
 Query

data/lib/nhtsa_vin.rb

@@ -8,6 +8,10 @@ module NhtsaVin
   def get(vin, options={})
     query = NhtsaVin::Query.new(vin, options)
     query.get
-    return query
+    query
+  end
+
+  def validate(vin)
+    NhtsaVin::Validation.new(vin)
   end
 end

data/lib/nhtsa_vin/version.rb

@@ -1,3 +1,3 @@
 module NhtsaVin
-  VERSION = '0.0.5'.freeze
+  VERSION = '0.0.6'.freeze
 end

data/spec/lib/nhtsa_vin_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe NhtsaVin do
+  let(:vin) { '2G1WT57K291223396' }
+  describe '#get' do
+    let(:get) { NhtsaVin.get(vin) }
+    it 'returns a query' do
+      expect(get).to be_a NhtsaVin::Query
+    end
+  end
+  describe '#validate' do
+    let(:validate) { NhtsaVin.validate(vin) }
+    it 'returns a validation' do
+      expect(validate).to be_a NhtsaVin::Validation
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nhtsa_vin
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Barclay Loftus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -79,6 +79,7 @@ files:
 - spec/fixtures/success.json
 - spec/lib/nhtsa_vin/query_spec.rb
 - spec/lib/nhtsa_vin/validation_spec.rb
+- spec/lib/nhtsa_vin_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/deliv/nhtsa_vin
 licenses:
@@ -109,4 +110,5 @@ test_files:
 - spec/fixtures/success.json
 - spec/lib/nhtsa_vin/query_spec.rb
 - spec/lib/nhtsa_vin/validation_spec.rb
+- spec/lib/nhtsa_vin_spec.rb
 - spec/spec_helper.rb