nhtsa_vin 0.0.1

data/spec/lib/nhtsa_vin/query_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe NhtsaVin::Query do
+  let(:client) { NhtsaVin::Query.new('2G1WT57K291223396') }
+
+  let(:success_response) { File.read(File.join('spec', 'fixtures', 'success.json')) }
+  let(:not_found_response) { File.read(File.join('spec', 'fixtures', 'not_found.json')) }
+
+  describe '#initialize' do
+    it 'stores the complete URL of the request' do
+      expect(client.url)
+        .to eq 'https://vpic.nhtsa.dot.gov/api/vehicles/decodevin/2G1WT57K291223396?format=json'
+    end
+  end
+
+  describe '#get' do
+    context 'successful response' do
+      before do
+        allow(client).to receive(:fetch).and_return(success_response)
+        client.get
+      end
+      it 'fetches json and response is valid' do
+        expect(client.raw_response).to eq success_response
+        expect(client.valid?).to be true
+      end
+
+      context 'its response' do
+        let(:response) { client.get }
+        it 'returns a struct' do
+          expect(response.class).to be Struct::NhtsaResponse
+        end
+        it 'returns the correct vehicle data' do
+          expect(response.year).to eq '2004'
+          expect(response.make).to eq 'Cadillac'
+          expect(response.model).to eq 'SRX'
+          expect(response.body_style).to eq 'Wagon'
+          expect(response.doors).to eq 4
+        end
+        it 'parses out the type' do
+          expect(response.type).to eq 'Minivan'
+        end
+      end
+    end
+
+    context 'error response' do
+      before do
+        allow(client).to receive(:fetch).and_return(not_found_response)
+        client.get
+      end
+      it 'fetches json and response is not valid' do
+        expect(client.raw_response).to eq not_found_response
+        expect(client.valid?).to be false
+      end
+      it 'returns nil' do
+        expect(client.get).to be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'nhtsa_vin'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: nhtsa_vin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Barclay Loftus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: "# NHTSA Vin\n----\n\nA ruby gem for fetching and parsing vehicle identification
+  via the vehicle identification number (VIN) from the [NHTSA webservice](https://vpic.nhtsa.dot.gov/api/Home).
+  Note, this gem is not officially affiliated with the NHTSA.\n\nPlease note, this
+  gem is currently in early development. \n\n## Installation\n\nAdd this line to your
+  application's Gemfile:\n\n```ruby\ngem 'nhsta_vin'\n```\n\nAnd then execute:\n\n
+  \   bundle\n\nOr install it yourself as:\n\n    gem install nhsta_vin\n\n## Usage\n\nUsage
+  is fairly simple. Provide a VIN, and the gem will return a struct of vehicle data.
+  \n\n```ruby\nquery = NhtsaVin.get('1J4BA5H11AL143811')\nquery.valid? # => true\nquery.response
+  # => <Struct::NhtsaResponse make=\"Jeep\", model=\"Grand Cherokee\", trim=\"Laredo/Rocky
+  Mountain Edition\", type=\"SUV\", year=\"2008\", size=nil, ... doors=4>\n```\n\nIn
+  the result no match is found, the result will be `nil`, and `#valid?` will return
+  `false`. \n\nVehicle Types\n----\n\nFor brievity, we're reducing the `Vehicle Type`
+  response to an enumerated set of `[\"Car\", \"Truck\", \"Van\", \"SUV\", \"Minivan\"]`.
+  We're doing a rough parse of the type and body style to achieve this. It's probably
+  not perfect. \n\n\n## License\n\nLicensed under the MIT License.\n"
+email:
+- barclay@deliv.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/nhtsa_vin.rb
+- lib/nhtsa_vin/query.rb
+- lib/nhtsa_vin/version.rb
+- nhtsa_vin.gemspec
+- spec/fixtures/not_found.json
+- spec/fixtures/success.json
+- spec/lib/nhtsa_vin/query_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/deliv/nhtsa_vin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A ruby library for accessing vin records from the NHTSA
+test_files:
+- spec/fixtures/not_found.json
+- spec/fixtures/success.json
+- spec/lib/nhtsa_vin/query_spec.rb
+- spec/spec_helper.rb