vinquery 0.4.2 → 0.5.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vinquery (0.4.1)
+    vinquery (0.4.2)
       nokogiri (>= 1.4.4)
 
 GEM
@@ -21,7 +21,7 @@ GEM
     rspec-mocks (2.6.0)
     vin_exploder (0.4.3)
     webmock (1.6.4)
-      addressable (> 2.2.5, ~> 2.2)
+      addressable (~> 2.2, > 2.2.5)
       crack (>= 0.1.7)
 
 PLATFORMS

data/lib/vinquery.rb

@@ -1,80 +1,71 @@
 require 'net/http'
 require 'nokogiri'
 require 'logger'
+require 'vinquery/vinquery_exception'
 
 class Vinquery
   attr_reader :attributes, :errors, :result
-
+  
   def self.get(vin, options={})
-    request = Vinquery.new(options[:url], options[:access_code], options[:report_type], options[:logger])
-    doc = request.fetch vin
-    result = request.parse doc
+    request = Vinquery.new(vin, options[:url], options[:access_code], options[:report_type], options[:logger])
+    request.fetch
+    request.parse
     request
   end
 
-  def initialize(url, access_code, report_type, log = nil)
+  def initialize(vin, url, access_code, report_type, log = nil)
+    @vin = vin
     @url = url
+    @errors = []
     @access_code = access_code
     @report_type = report_type
     log ||= Logger.new(nil)
     @log = log
   end
   
-  def fetch(vin)
+  def fetch
     # use reducable=FALSE to get additional fields like fuel_type
     # use vt=true to get vehicle_type
+    # use gvwr=TRUE to get GVWR
     # http://www.vinquery.com/ws_POQCXTYNO1D/xml_v100_QA7RTS8Y.aspx?accessCode=6958785b-ac0a-4303-8b28-40e14aa836ce&vin=YourVINToDecode&reportType=0&vt=true&gvwr=true
     @uri ||= "#{@url}?accessCode=#{@access_code}&reportType=#{@report_type}&reducable=FALSE&vt=TRUE&gvwr=TRUE"
-    url_s = @uri + "&vin=#{vin}"
+    url_s = @uri + "&vin=#{@vin}"
     @log.info{"Vinquery#fetch - uri: #{url_s}"}
     url = URI.parse(url_s)
     begin
       @result = Net::HTTP.get url
       @log.debug{"Vinquery#fetch - result: #{@result}"}
+      @doc = Nokogiri::HTML(@result)
     rescue Exception => e
-      @log.error{"ERROR - #{e.message}"}
-      @log.error{"ERROR - #{e.backtrace[0]}"}
-      xml = Nokogiri::XML::Builder.new do |doc|
-        doc.vin(:number => vin,:status => "FAILED") {
-          doc.message(:Key => "VinQuery unavailable", :Value => "Oops, it looks like our VIN decoder is unavailable at the moment. Please try again later.")
-        }
-      end
-      @result = xml.to_xml
+      raise VinqueryException.new(e.message, e)
     end
-    @doc = Nokogiri::HTML(@result)
   end
 
-  def parse(doc)
-    set_attributes doc
-    set_errors_hash doc
-    attributes
-  end
+  def parse
+    raise create_exception unless valid?
 
-  def set_attributes(doc)
     attributes = {}
-    doc.xpath('//vehicle[1]/item').each do |item|
+    @doc.xpath('//vehicle[1]/item').each do |item|
       attributes[item.attributes['key'].value.downcase.gsub('.', '').gsub(/ /, '_').to_sym] = item.attributes['value'].value
     end
     @log.info{"Vinquery#set_attributes - number of attributes parsed: #{attributes.size}"}
     if attributes.size > 0
-      vin = doc.css('vin').first.attributes['number'].value
+      vin = @doc.css('vin').first.attributes['number'].value
       attributes[:vin_key] = make_vin_key(vin)
-      attributes[:vendor_result] = doc.to_xml
+      attributes[:vendor_result] = @doc.to_xml
       attributes[:number_of_cylinders] = attributes[:engine_type].upcase.match(/ [LV](\d{1,2}) /) ? $1 : nil
       attributes[:has_turbo] = attributes[:engine_type].upcase.match(/ ([TURBO|SUPERCHARGED]) /) ? true : false
     end
     @attributes = attributes
   end
 
-  def set_errors_hash(doc)
-    @errors = []
-    @valid = doc.css('vin').first.attributes['status'].value == "SUCCESS"
-    doc.css('message').each{|msg| @errors << {msg.attributes['key'].value => msg.attributes['value'].value} } unless valid?
-    @errors.each{|msg| @log.error{"Vinquery#set_errors_hash - error: #{msg.to_s}"}} unless @errors.empty?
+  def create_exception
+    @doc.css('message').each{|msg| @errors << {msg.attributes['key'].value => msg.attributes['value'].value} }
+    VinqueryException.new(@errors.map{|msg| "#{msg.keys[0]}: #{msg.values[0]}"}.join("\n")) unless @errors.empty?
   end
 
   def valid?
-    @valid
+    @valid ||= @doc.css('vin').first.attributes['status'].value == "SUCCESS" rescue false
   end
   
   def make_vin_key(vin)

data/lib/vinquery/version.rb

@@ -1,3 +1,3 @@
 class Vinquery
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

data/lib/vinquery/vinquery_exception.rb

@@ -0,0 +1,7 @@
+class VinqueryException < StandardError 
+  attr_accessor :original_exception
+  def initialize(msg=nil, exception=nil)
+    super(msg)
+    original_exception = exception
+  end
+end

data/spec/vin_exploder_adapter_spec.rb

@@ -9,7 +9,7 @@ describe VinqueryAdapter do
 
   before(:each) do
     
-    @query = Vinquery.new 'http://www.vinlookupservice.com', 'access_code', 'report_type_2'
+    @query = Vinquery.new 'valid_vin', 'http://www.vinlookupservice.com', 'access_code', 'report_type_2'
     @adapter = VinqueryAdapter.new({})
     @test_xml_data ||= File.new("#{File.dirname(__FILE__)}/vinquery_test.xml", "r").read
     stub_request(:any, /.*vinlookupservice.*/).to_return(:body => @test_xml_data, :status => 200, :headers => { 'Content-Length' => @test_xml_data.length})
@@ -26,14 +26,16 @@ describe VinqueryAdapter do
     hash[:errors].empty?.should == true
   end
   
-  it 'should include an errors hash with an invalid vin number' do
+  it 'should raise an error with an invalid vin number' do
     res = '<?xml version="1.0" encoding="utf-8" standalone="yes"?>\r\n<VINquery Version="1.0.0" Report_Type="BASIC" Date="2/19/2011">\r\n    <VIN Number="ABCDEFGHIJKLMNOPQ" Status="FAILED">\r\n        <Message Key="5" Value="Invalid VIN number: This VIN number contains invalid letters: I,O or Q." />\r\n    </VIN>\r\n</VINquery>'
     stub_request(:any, /.*invalidvin.*/).to_return(:body => res, :status => 200, :headers => { 'Content-Length' => res.length})
-    query = Vinquery.new('http://www.invalidvin.com', 'access_code', 'report_type_2')
+    query = Vinquery.new('BAD_VIN', 'http://www.invalidvin.com', 'access_code', 'report_type_2')
     Vinquery.should_receive(:new){ query }
-    hash = @adapter.explode('BAD_VIN')
-    hash[:errors].size.should == 1
-    hash[:errors].first['5'].should == 'Invalid VIN number: This VIN number contains invalid letters: I,O or Q.'
+    
+    expect { @adapter.explode('BAD_VIN') }.to raise_error(VinqueryException, /Invalid VIN number/)
+
+    # hash[:errors].size.should == 1
+    # hash[:errors].first['5'].should == 'Invalid VIN number: This VIN number contains invalid letters: I,O or Q.'
   end
   
 end

data/spec/vinquery_spec.rb

@@ -6,7 +6,7 @@ describe Vinquery do
 
   before(:each) do
     
-    @query = Vinquery.new 'http://www.vinlookupservice.com', 'access_code', 'report_type_2'
+    @query = Vinquery.new 'valid_vin', 'http://www.vinlookupservice.com', 'access_code', 'report_type_2'
     
     @test_xml_data ||= File.new("#{File.dirname(__FILE__)}/vinquery_test.xml", "r").read
     stub_request(:any, /.*vinlookupservice.*/).to_return(:body => @test_xml_data, :status => 200, :headers => { 'Content-Length' => @test_xml_data.length})
@@ -16,63 +16,54 @@ describe Vinquery do
     WebMock.reset!
   end
 
-  describe 'set attributes' do
-    it 'should return a set of vehicle attributes given a Nokogiri document' do
+  describe '#valid?' do
+    it 'should return true when the returned doc has a status of SUCCESS' do
       doc = Nokogiri::HTML(@test_xml_data)
-      @query.set_attributes(doc)
-      # @query.attributes.each_pair{|k,v| puts "#{k} - #{v}"}
-      @query.attributes[:body_style].should == "CREW CAB PICKUP 4-DR"
-      @query.attributes[:vin_key].should == "3D7LU38C3G"
+      
+      @query.instance_variable_set("@doc", doc)
+      @query.valid?.should == true
     end
 
-    it 'should recover from poorly formatted or unexpected xml document' do
-      xml_s = '<?xml version="1.0"?>\\n<blah status="FAILED" number="vin"\\n'
-      doc = Nokogiri::HTML(xml_s)
-      @query.set_attributes(doc).should == {}
+    it 'should return false when status is anything other than SUCCESS' do
+      doc = Nokogiri::HTML(@test_xml_data.gsub(/SUCCESS/, 'FAILED'))
+      
+      @query.instance_variable_set("@doc", doc)
+      @query.valid?.should == false
     end
   end
 
-  describe '#set_errors_hash' do
-    it 'should give the reason for failure within an errors hash' do
+  describe '#create_exception' do
+    it 'should return a VinqueryException with the vinquery error message' do
       doc = Nokogiri::HTML '<?xml version="1.0" encoding="utf-8" standalone="yes"?>\r\n<VINquery Version="1.0.0" Report_Type="BASIC" Date="2/19/2011">\r\n    <VIN Number="ABCDEFGHIJKLMNOPQ" Status="FAILED">\r\n        <Message Key="5" Value="Invalid VIN number: This VIN number contains invalid letters: I,O or Q." />\r\n    </VIN>\r\n</VINquery>'
-      @query.set_errors_hash(doc)
+      @query.instance_variable_set("@doc", doc)
       @query.valid?.should == false
-      @query.errors.should == [{"5" => "Invalid VIN number: This VIN number contains invalid letters: I,O or Q."}]
+      e = @query.create_exception
+      e.class.should == VinqueryException
+      e.message.should == "5: Invalid VIN number: This VIN number contains invalid letters: I,O or Q."
     end
   end
 
-  describe 'get_doc' do
-    it "should return valid xml parsed by nokogiri pulled from VinQuery.com" do
-      n_xml = @query.fetch('abcdefghijklmnopq')
-
-      n_xml.class.should equal(Nokogiri::HTML::Document)
-      !!n_xml.css('vin').should == true
+  describe '#parse' do
+    it "should return a hash with all vin attributes" do
+      doc = Nokogiri::HTML(@test_xml_data)
+      
+      @query.instance_variable_set("@doc", doc)
+      @query.valid?.should == true
+      h = @query.parse
+      h.class.should == Hash
+      h[:vin_key].should == '3D7LU38C3G'
     end
 
-    it "should rescue from error if the request misfires" do
-      stub_request(:any, /.*bad\.service\.url.*/).to_timeout
-      @query.instance_variable_set(:@url,"http://bad.service.url")
-      doc = @query.fetch('')
-      doc.css('vin').first.attributes['status'].value.should == "FAILED"
-      doc.css('message').first.attributes['key'].value.should == "VinQuery unavailable"
-      doc.css('message').first.attributes['value'].value.should == "Oops, it looks like our VIN decoder is unavailable at the moment. Please try again later."
-    end
-  end
-
-  describe 'parse_doc' do
-    it 'should take nokogiri document and separate to attributes and errors hash' do
-      doc = Nokogiri::HTML(@test_xml_data)
-      @query.should_receive(:set_attributes).with(an_instance_of(Nokogiri::HTML::Document))
-      @query.parse(doc)
+    it "should raise an VinException if request FAILED" do
+      doc = Nokogiri::HTML '<?xml version="1.0" encoding="utf-8" standalone="yes"?>\r\n<VINquery Version="1.0.0" Report_Type="BASIC" Date="2/19/2011">\r\n    <VIN Number="ABCDEFGHIJKLMNOPQ" Status="FAILED">\r\n        <Message Key="5" Value="Invalid VIN number: This VIN number contains invalid letters: I,O or Q." />\r\n    </VIN>\r\n</VINquery>'
+      @query.instance_variable_set("@doc", doc)
+      @query.valid?.should == false
+      expect { @query.parse }.to raise_error(VinqueryException, /Invalid VIN number/)
     end
   end
 
-  describe 'request' do
-    before(:each) do
-      
-    end
-    
-    it 'should make the call to VinQuery.com and return attributes on valid number' do      
+  describe '#get' do
+    it 'should make the call to VinQuery.com and return attributes on valid vin' do      
       stub_request(:any, /.*fakeurl.*/).to_return(:body => @test_xml_data, :status => 200, :headers => { 'Content-Length' => @test_xml_data.length})
       query = Vinquery.get('1G1ND52F14M587843', {:url => 'http://www.fakeurl.com', :access_code => 'access_code', :report_type => 'report_type_2'})
       query.valid?.should == true
@@ -81,12 +72,10 @@ describe Vinquery do
       query.attributes[:make].should == 'Dodge'
     end
     
-    it 'should return an errors array with an invalid vin number' do
+    it 'should raise an exception with an invalid vin number' do
       res = '<?xml version="1.0" encoding="utf-8" standalone="yes"?>\r\n<VINquery Version="1.0.0" Report_Type="BASIC" Date="2/19/2011">\r\n    <VIN Number="ABCDEFGHIJKLMNOPQ" Status="FAILED">\r\n        <Message Key="5" Value="Invalid VIN number: This VIN number contains invalid letters: I,O or Q." />\r\n    </VIN>\r\n</VINquery>'
       stub_request(:any, /.*invalidvin.*/).to_return(:body => res, :status => 200, :headers => { 'Content-Length' => res.length})
-      results = Vinquery.get('BADVIN', {:url => 'http://www.invalidvin.com', :access_code => 'access_code', :report_type => 'report_type_2'})
-      results.valid?.should == false
-      results.errors.class.should == Array
+      expect { Vinquery.get('BADVIN', {:url => 'http://www.invalidvin.com', :access_code => 'access_code', :report_type => 'report_type_2'}) }.to raise_error(VinqueryException)
     end
   end
 

metadata

@@ -1,76 +1,74 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: vinquery
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.5.0
   prerelease: 
-  version: 0.4.2
 platform: ruby
-authors: 
+authors:
 - Jake Mallory
 - George South
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-08 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70282070376260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.4.4
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70282070376260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70282070375780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.6.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70282070375780
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70282070375300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.6.4
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: vin_exploder
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70282070375300
+- !ruby/object:Gem::Dependency
+  name: vin_exploder
+  requirement: &70282070374820 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.4.0
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: *70282070374820
 description: A client for the Vinquery.com vin decoding web service.
 email: tinomen@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - Gemfile
 - Gemfile.lock
 - Rakefile
 - README.textile
-files: 
+files:
 - lib/vinquery/version.rb
 - lib/vinquery/vin_exploder/adapter.rb
+- lib/vinquery/vinquery_exception.rb
 - lib/vinquery.rb
 - Gemfile
 - Gemfile.lock
@@ -82,37 +80,35 @@ files:
 - spec/vinquery_test.xml
 homepage: http://github.com/tinomen/vinquery
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --title
 - A client for vinquery.com
 - --main
 - README.rdoc
 - --line-numbers
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A client for vinquery.com
-test_files: 
+test_files:
 - spec/spec_helper.rb
 - spec/vin_exploder_adapter_spec.rb
 - spec/vinquery_spec.rb