vin_query 1.0.0

data/spec/fixtures/success_single.xml

@@ -0,0 +1,175 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<VINquery Version="1.0.0" Report_Type="EXTENDED" Date="10/22/2012">
+    <VIN Number="2G1WT57K291223396" Status="SUCCESS">
+        <Vehicle VINquery_Vehicle_ID="37163" Model_Year="2009" Make="Chevrolet" Model="Impala" Trim_Level="LT">
+            <Item Key="VINquery_Vehicle_ID" Value="37163" Unit="" />
+            <Item Key="Model Year" Value="2009" Unit="" />
+            <Item Key="Make" Value="Chevrolet" Unit="" />
+            <Item Key="Model" Value="Impala" Unit="" />
+            <Item Key="Trim Level" Value="LT" Unit="" />
+            <Item Key="Manufactured in" Value="CANADA" Unit="" />
+            <Item Key="Production Seq. Number" Value="223396" Unit="" />
+            <Item Key="Body Style" Value="SEDAN 4-DR" Unit="" />
+            <Item Key="Engine Type" Value="3.5L V6 OHV 12V FFV" Unit="" />
+            <Item Key="Transmission-short" Value="4A" Unit="" />
+            <Item Key="Transmission-long" Value="4-Speed Automatic" Unit="" />
+            <Item Key="Driveline" Value="FWD" Unit="" />
+            <Item Key="Tank" Value="17.00" Unit="gallon" />
+            <Item Key="Fuel Economy-city" Value="18 - 19" Unit="miles/gallon" />
+            <Item Key="Fuel Economy-highway" Value="29" Unit="miles/gallon" />
+            <Item Key="Anti-Brake System" Value="4-Wheel ABS" Unit="" />
+            <Item Key="Steering Type" Value="R&amp;P" Unit="" />
+            <Item Key="Front Brake Type" Value="Disc" Unit="" />
+            <Item Key="Rear Brake Type" Value="Disc" Unit="" />
+            <Item Key="Turning Diameter" Value="38.00" Unit="in." />
+            <Item Key="Front Suspension" Value="Ind" Unit="" />
+            <Item Key="Rear Suspension" Value="Ind" Unit="" />
+            <Item Key="Front Spring Type" Value="Coil" Unit="" />
+            <Item Key="Rear Spring Type" Value="Coil" Unit="" />
+            <Item Key="Tires" Value="225/60R16" Unit="" />
+            <Item Key="Front Headroom" Value="39.40" Unit="in." />
+            <Item Key="Rear Headroom" Value="37.80" Unit="in." />
+            <Item Key="Front Legroom" Value="42.30" Unit="in." />
+            <Item Key="Rear Legroom" Value="37.60" Unit="in." />
+            <Item Key="Front Shoulder Room" Value="58.70" Unit="in." />
+            <Item Key="Rear Shoulder Room" Value="58.60" Unit="in." />
+            <Item Key="Front Hip Room" Value="56.40" Unit="in." />
+            <Item Key="Rear Hip Room" Value="57.20" Unit="in." />
+            <Item Key="Interior Trim" Value="Ebony Cloth Interior | Gray Cloth Interior | Neutral Cloth Interior" Unit="" />
+            <Item Key="Exterior Color" Value="Aqua Blue Metallic | Black | Cyber Gray Metallic | Dark Silver Metallic | Gold Mist Metallic | Imperial Blue Metallic | Mocha Bronze Metallic | Red Jewel Tintcoat | Silver Ice Metallic | Slate Metallic | Victory Red | White" Unit="" />
+            <Item Key="Curb Weight-automatic" Value="3555" Unit="lbs" />
+            <Item Key="Curb Weight-manual" Value="No data" Unit="lbs" />
+            <Item Key="Overall Length" Value="200.40" Unit="in." />
+            <Item Key="Overall Width" Value="72.90" Unit="in." />
+            <Item Key="Overall Height" Value="58.70" Unit="in." />
+            <Item Key="Wheelbase" Value="110.50" Unit="in." />
+            <Item Key="Ground Clearance" Value="No data" Unit="in." />
+            <Item Key="Track Front" Value="62.40" Unit="in." />
+            <Item Key="Track Rear" Value="61.50" Unit="in." />
+            <Item Key="Cargo Length" Value="No data" Unit="in." />
+            <Item Key="Width at Wheelwell" Value="No data" Unit="in." />
+            <Item Key="Width at Wall" Value="No data" Unit="in." />
+            <Item Key="Depth" Value="No data" Unit="in." />
+            <Item Key="Standard Seating" Value="5" Unit="" />
+            <Item Key="Optional Seating" Value="6" Unit="" />
+            <Item Key="Passenger Volume" Value="No data" Unit="cu.ft." />
+            <Item Key="Cargo Volume" Value="18.60" Unit="cu.ft." />
+            <Item Key="Standard Towing" Value="No data" Unit="lbs" />
+            <Item Key="Maximum Towing" Value="No data" Unit="lbs" />
+            <Item Key="Standard Payload" Value="No data" Unit="lbs" />
+            <Item Key="Maximum Payload" Value="No data" Unit="lbs" />
+            <Item Key="Standard GVWR" Value="No data" Unit="lbs" />
+            <Item Key="Maximum GVWR" Value="No data" Unit="lbs" />
+            <Item Key="Basic-duration" Value="36" Unit="month" />
+            <Item Key="Basic-distance" Value="36,000" Unit="mile" />
+            <Item Key="Powertrain-duration" Value="60" Unit="month" />
+            <Item Key="Powertrain-distance" Value="100,000" Unit="mile" />
+            <Item Key="Rust-duration" Value="72" Unit="month" />
+            <Item Key="Rust-distance" Value="100,000" Unit="mile" />
+            <Item Key="MSRP" Value="$24,645" Unit="USD" />
+            <Item Key="Dealer Invoice" Value="$23,290" Unit="USD" />
+            <Item Key="Destination Charge" Value="$750" Unit="USD" />
+            <Item Key="Child Safety Door Locks" Value="Std." Unit="" />
+            <Item Key="Locking Pickup Truck Tailgate" Value="N/A" Unit="" />
+            <Item Key="Power Door Locks" Value="Std." Unit="" />
+            <Item Key="Vehicle Anti-Theft" Value="Std." Unit="" />
+            <Item Key="4WD/AWD" Value="N/A" Unit="" />
+            <Item Key="ABS Brakes" Value="Std." Unit="" />
+            <Item Key="Automatic Load-Leveling" Value="N/A" Unit="" />
+            <Item Key="Electronic Brake Assistance" Value="N/A" Unit="" />
+            <Item Key="Limited Slip Differential" Value="N/A" Unit="" />
+            <Item Key="Locking Differential" Value="N/A" Unit="" />
+            <Item Key="Traction Control" Value="Std." Unit="" />
+            <Item Key="Vehicle Stability Control System" Value="N/A" Unit="" />
+            <Item Key="Driver Airbag" Value="Std." Unit="" />
+            <Item Key="Front Side Airbag" Value="Std." Unit="" />
+            <Item Key="Front Side Airbag with Head Protection" Value="Std." Unit="" />
+            <Item Key="Passenger Airbag" Value="Std." Unit="" />
+            <Item Key="Side Head Curtain Airbag" Value="Std." Unit="" />
+            <Item Key="Second Row Side Airbag" Value="N/A" Unit="" />
+            <Item Key="Second Row Side Airbag with Head Protection" Value="N/A" Unit="" />
+            <Item Key="Electronic Parking Aid" Value="N/A" Unit="" />
+            <Item Key="First Aid Kit" Value="N/A" Unit="" />
+            <Item Key="Trunk Anti-Trap Device" Value="Std." Unit="" />
+            <Item Key="Keyless Entry" Value="Std." Unit="" />
+            <Item Key="Remote Ignition" Value="Std." Unit="" />
+            <Item Key="Air Conditioning" Value="Std." Unit="" />
+            <Item Key="Separate Driver/Front Passenger Climate Controls" Value="Std." Unit="" />
+            <Item Key="Cruise Control" Value="Std." Unit="" />
+            <Item Key="Tachometer" Value="Std." Unit="" />
+            <Item Key="Tilt Steering" Value="Std." Unit="" />
+            <Item Key="Tilt Steering Column" Value="Std." Unit="" />
+            <Item Key="Heated Steering Wheel" Value="N/A" Unit="" />
+            <Item Key="Leather Steering Wheel" Value="Opt." Unit="" />
+            <Item Key="Steering Wheel Mounted Controls" Value="Std." Unit="" />
+            <Item Key="Telescopic Steering Column" Value="N/A" Unit="" />
+            <Item Key="Adjustable Foot Pedals" Value="N/A" Unit="" />
+            <Item Key="Genuine Wood Trim" Value="N/A" Unit="" />
+            <Item Key="Tire Pressure Monitor" Value="Std." Unit="" />
+            <Item Key="Trip Computer" Value="Std." Unit="" />
+            <Item Key="AM/FM Radio" Value="Std." Unit="" />
+            <Item Key="Cassette Player" Value="N/A" Unit="" />
+            <Item Key="CD Player" Value="Std." Unit="" />
+            <Item Key="CD Changer" Value="N/A" Unit="" />
+            <Item Key="DVD Player" Value="Opt." Unit="" />
+            <Item Key="Voice Activated Telephone" Value="Std." Unit="" />
+            <Item Key="Navigation Aid" Value="N/A" Unit="" />
+            <Item Key="Second Row Sound Controls" Value="N/A" Unit="" />
+            <Item Key="Subwoofer" Value="N/A" Unit="" />
+            <Item Key="Telematics System" Value="Std." Unit="" />
+            <Item Key="Driver Multi-Adjustable Power Seat" Value="Std." Unit="" />
+            <Item Key="Front Cooled Seat" Value="N/A" Unit="" />
+            <Item Key="Front Heated Seat" Value="Opt." Unit="" />
+            <Item Key="Front Power Lumbar Support" Value="N/A" Unit="" />
+            <Item Key="Front Power Memory Seat" Value="N/A" Unit="" />
+            <Item Key="Front Split Bench Seat" Value="Opt." Unit="" />
+            <Item Key="Leather Seat" Value="Opt." Unit="" />
+            <Item Key="Passenger Multi-Adjustable Power Seat" Value="Opt." Unit="" />
+            <Item Key="Second Row Folding Seat" Value="Opt." Unit="" />
+            <Item Key="Second Row Heated Seat" Value="N/A" Unit="" />
+            <Item Key="Second Row Multi-Adjustable Power Seat" Value="N/A" Unit="" />
+            <Item Key="Second Row Removable Seat" Value="N/A" Unit="" />
+            <Item Key="Third Row Removable Seat" Value="N/A" Unit="" />
+            <Item Key="Cargo Area Cover" Value="N/A" Unit="" />
+            <Item Key="Cargo Area Tiedowns" Value="N/A" Unit="" />
+            <Item Key="Cargo Net" Value="Std." Unit="" />
+            <Item Key="Load Bearing Exterior Rack" Value="N/A" Unit="" />
+            <Item Key="Pickup Truck Bed Liner" Value="N/A" Unit="" />
+            <Item Key="Power Sunroof" Value="Opt." Unit="" />
+            <Item Key="Removable Top" Value="N/A" Unit="" />
+            <Item Key="Manual Sunroof" Value="Opt." Unit="" />
+            <Item Key="Automatic Headlights" Value="Std." Unit="" />
+            <Item Key="Daytime Running Lights" Value="Std." Unit="" />
+            <Item Key="Fog Lights" Value="N/A" Unit="" />
+            <Item Key="High Intensity Discharge Headlights" Value="N/A" Unit="" />
+            <Item Key="Pickup Truck Cargo Box Light" Value="N/A" Unit="" />
+            <Item Key="Running Boards" Value="N/A" Unit="" />
+            <Item Key="Front Air Dam" Value="Std." Unit="" />
+            <Item Key="Rear Spoiler" Value="Opt." Unit="" />
+            <Item Key="Skid Plate" Value="N/A" Unit="" />
+            <Item Key="Splash Guards" Value="Opt." Unit="" />
+            <Item Key="Wind Deflector for Convertibles" Value="N/A" Unit="" />
+            <Item Key="Power Sliding Side Van Door" Value="N/A" Unit="" />
+            <Item Key="Power Trunk Lid" Value="N/A" Unit="" />
+            <Item Key="Alloy Wheels" Value="Std." Unit="" />
+            <Item Key="Chrome Wheels" Value="N/A" Unit="" />
+            <Item Key="Full Size Spare Tire" Value="N/A" Unit="" />
+            <Item Key="Run Flat Tires" Value="N/A" Unit="" />
+            <Item Key="Steel Wheels" Value="N/A" Unit="" />
+            <Item Key="Power Windows" Value="Std." Unit="" />
+            <Item Key="Electrochromic Exterior Rearview Mirror" Value="N/A" Unit="" />
+            <Item Key="Glass Rear Window on Convertible" Value="N/A" Unit="" />
+            <Item Key="Heated Exterior Mirror" Value="Opt." Unit="" />
+            <Item Key="Electrochromic Interior Rearview Mirror" Value="Opt." Unit="" />
+            <Item Key="Power Adjustable Exterior Mirror" Value="Std." Unit="" />
+            <Item Key="Deep Tinted Glass" Value="N/A" Unit="" />
+            <Item Key="Interval Wipers" Value="Std." Unit="" />
+            <Item Key="Rain Sensing Wipers" Value="N/A" Unit="" />
+            <Item Key="Rear Window Defogger" Value="Std." Unit="" />
+            <Item Key="Rear Wiper" Value="N/A" Unit="" />
+            <Item Key="Sliding Rear Pickup Truck Window" Value="N/A" Unit="" />
+            <Item Key="Tow Hitch Receiver" Value="N/A" Unit="" />
+            <Item Key="Towing Preparation Package" Value="N/A" Unit="" />
+        </Vehicle>
+    </VIN>
+</VINquery>

data/spec/lib/vin_query/query_spec.rb

@@ -0,0 +1,135 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+describe VinQuery::Query do
+
+  let(:client) { VinQuery::Query.new('2G1WT57K291223396',
+                                     :url => 'http://www.vinquery.com/asdf/asdf.aspx',
+                                     :access_code => 'asdf1234-asdf1234-asdf1234') }
+
+  let(:xml_error)  { File.read(File.join('spec', 'fixtures', 'error.xml')) }
+  let(:xml_multi)  { File.read(File.join('spec', 'fixtures', 'success_multi.xml')) }
+  let(:xml_single) { File.read(File.join('spec', 'fixtures', 'success_single.xml')) }
+
+  describe '#initialize' do
+    it 'stores the complete URL of the VinQuery request (with default report type)' do
+      expect(client.url).to eq "http://www.vinquery.com/asdf/asdf.aspx?accessCode=asdf1234-asdf1234-asdf1234&vin=2G1WT57K291223396&reportType=2"
+    end
+
+    it 'creates an empty array of trim levels' do
+      expect(client.trim_levels).to eq []
+    end
+  end
+
+  describe '#validate' do
+    context 'when response is successful' do
+      it 'is valid' do
+        client.validate xml_single
+        expect(client.valid?).to eq true
+      end
+    end
+
+    context 'when response is an error' do
+      it 'is not valid' do
+        client.validate xml_error
+        expect(client.valid?).to eq false
+      end
+    end
+  end
+
+  describe '#parse' do
+    context 'when a single trim level is returned' do
+      before(:each) { client.parse xml_single }
+
+      it 'populates an array of trim levels with 1 trim level' do
+        expect(client.trim_levels.size).to be 1
+      end
+
+      it 'has an array of VinQuery::TrimLevel objects' do
+        expect(client.trim_levels.first).to be_an_instance_of VinQuery::TrimLevel
+      end
+
+      it 'has a trim level with vin and VinQuery attributes' do
+        expect(client.trim_levels.first.vin).to eq '2G1WT57K291223396'
+
+        expect(client.trim_levels.first.attributes[:model_year]).to eq '2009'
+        expect(client.trim_levels.first.attributes[:make]).to eq 'Chevrolet'
+        expect(client.trim_levels.first.attributes[:model]).to eq 'Impala'
+      end
+
+      it 'has a trim level with units appended to attributes if units are given' do
+        expect(client.trim_levels.first.attributes[:tank]).to eq '17.00 gallon'
+      end
+    end
+
+    context 'when multiple trim levels are returned' do
+      before(:each) { client.parse xml_multi }
+
+      it 'populates an array of trim levels with the number of trim levels' do
+        expect(client.trim_levels.size).to be 4
+      end
+
+      it 'has an array of VinQuery::TrimLevel objects' do
+        expect(client.trim_levels.first).to be_an_instance_of VinQuery::TrimLevel
+      end
+
+      it 'has the correct first trim level from xml' do
+        expect(client.trim_levels.first.attributes[:make]).to eq 'Nissan'
+        expect(client.trim_levels.first.attributes[:model]).to eq 'Sentra'
+        expect(client.trim_levels.first.attributes[:trim_level]).to eq '2.0'
+      end
+
+      it 'has the correct last trim level from xml' do
+        expect(client.trim_levels.last.attributes[:make]).to eq 'Nissan'
+        expect(client.trim_levels.last.attributes[:model]).to eq 'Sentra'
+        expect(client.trim_levels.last.attributes[:trim_level]).to eq '2.0 SR'
+      end
+    end
+
+    context 'when error is returned' do
+      it 'raises a VinQuery::ParseError' do
+        expect{ client.parse(xml_error) }.to raise_error VinQuery::ParseError
+      end
+    end
+  end
+
+  describe '#get' do
+    context 'success response' do
+      before(:each) do
+        client.stub(:fetch).and_return xml_multi
+        client.get
+      end
+
+      it 'fetches xml and response is valid' do
+        expect(client.valid?).to be true
+      end
+
+      it 'has 0 trim levels' do
+        expect(client.trim_levels.size).to eq 4
+      end
+    end
+
+    context 'error response' do
+      before(:each) do
+        client.stub(:fetch).and_return xml_error
+        client.get
+      end
+
+      it 'fetches xml and response is not valid' do
+        expect(client.valid?).to be false
+      end
+
+      it 'has 0 trim levels' do
+        expect(client.trim_levels.size).to eq 0
+      end
+    end
+
+    context '404 response' do
+      before(:each) { client.stub(:fetch).and_return '<html>404</html>' }
+
+      it 'fetches xml and response cannot be validated' do
+        expect{ client.get }.to raise_error VinQuery::ValidationError
+      end
+    end
+  end
+end

data/spec/lib/vin_query/trim_level_spec.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+describe VinQuery::TrimLevel do
+  describe '#initialize' do
+    let(:trim) { trim = VinQuery::TrimLevel.new('2G1WT57K291223396', {
+                                                :model_year => '2009',
+                                                :make => 'Chevrolet',
+                                                :model => 'Impala',
+                                                :trim_level => 'LT' }) }
+
+    it 'have a vin class attribute' do
+      expect(trim.vin).to eq '2G1WT57K291223396'
+    end
+
+    it 'creates a hash of VinQuery attributes' do
+      expect(trim.attributes[:model_year]).to eq '2009'
+      expect(trim.attributes[:make]).to eq 'Chevrolet'
+      expect(trim.attributes[:model]).to eq 'Impala'
+      expect(trim.attributes[:trim_level]).to eq 'LT'
+    end
+
+    it 'has a description string of VIN and trim level' do
+      expect(trim.to_s).to eq '2G1WT57K291223396 - LT'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+# -*- encoding: utf-8 -*-
+require 'vin_query'

data/vin_query.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/vin_query/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'vin_query'
+  gem.version       = VinQuery::VERSION
+  gem.platform      = Gem::Platform::RUBY
+
+  gem.summary       = 'A ruby library for accessing vinquery.com'
+  gem.description   = 'A ruby library for fetching and parsing VIN information from vinquery.com, a vehicle identification number decoding service.'
+  gem.homepage      = 'https://github.com/jyunderwood/vin_query'
+
+  gem.authors       = ['Jonathan Underwood']
+  gem.email         = ['jonathan@jyunderwood.com']
+
+  gem.date          = Date.today.to_s
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'nokogiri', '~> 1.5.6'
+
+  gem.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: vin_query
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan Underwood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby library for fetching and parsing VIN information from vinquery.com,
+  a vehicle identification number decoding service.
+email:
+- jonathan@jyunderwood.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/vin_query.rb
+- lib/vin_query/exceptions.rb
+- lib/vin_query/query.rb
+- lib/vin_query/trim_level.rb
+- lib/vin_query/version.rb
+- spec/fixtures/error.xml
+- spec/fixtures/success_multi.xml
+- spec/fixtures/success_single.xml
+- spec/lib/vin_query/query_spec.rb
+- spec/lib/vin_query/trim_level_spec.rb
+- spec/spec_helper.rb
+- vin_query.gemspec
+homepage: https://github.com/jyunderwood/vin_query
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A ruby library for accessing vinquery.com
+test_files:
+- spec/fixtures/error.xml
+- spec/fixtures/success_multi.xml
+- spec/fixtures/success_single.xml
+- spec/lib/vin_query/query_spec.rb
+- spec/lib/vin_query/trim_level_spec.rb
+- spec/spec_helper.rb