black_book 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04cdab15a4cfd41ea1f1383ab293ad3d66066f3b
-  data.tar.gz: 12b9b06d5fd558aec24fe7530d25691c376c0ca1
+  metadata.gz: 46be316110f2e73d8fe95206b4ad38c5a2a74524
+  data.tar.gz: e546837e012a178a55fe8b870dcf28720884acb1
 SHA512:
-  metadata.gz: f5143fd3198438654d84270eb5f57d99c099108b9cd83c5b32168c3c314adcacb8132975354545803a37aa912e3b3ddf903a0193b46db93fcd99f218782fece5
-  data.tar.gz: 1c9dc6c4018efb69a97f295624cbacc0af639713f6af388c4ca7f70b8e4bafd017ccb3627fc55092b25c9f5facf79be66007f3e20409a883fe3245c0a91c053c
+  metadata.gz: a06ba8a599fc5c39b9a3b5fb0aacc83546dc6817e6ec8d6114ed9ab45e942b48c79e4b8d0936d40feb6998593eb2b65f71c191ba88b83193203086d567edbd70
+  data.tar.gz: e8884128aa51213cdc57cbd8feb4e45d4f4c2e83454295ff92f378fefe9cb1696a666c4c96e8eb6b9124d8ed38e4e33e70c575f1e75447207346bfbd7922ae99

data/lib/black_book/errors.rb

@@ -1,4 +1,8 @@
 module BlackBook
   class BlackBookError < StandardError; end
   class VinNotFound < BlackBookError; end
+  class MakesNotFound < BlackBookError; end
+  class ModelsNotFound < BlackBookError; end
+  class SeriesNotFound < BlackBookError; end
+  class StylesNotFound < BlackBookError; end
 end

data/lib/black_book/used_cars.rb

@@ -5,10 +5,10 @@ module BlackBook
         "https://www.blackbookws.com/UsedCarWSX.asmx?WSDL"
       end
 
-      def current_valuation_for(vin, mileage, state, options={})
+      def current_valuation_from_vin(vin, mileage, state, options={})
         response = request(:get_current_vin_values, {
-          "sCountryCode" => "U",
-          "sFrequencyCode" => "W",
+          "sCountryCode" => (options[:country] || "U"),
+          "sFrequencyCode" => (options[:frequency] || "W"),
           "sVIN" => vin,
           "iMileage" => mileage,
           "sState" => state,
@@ -30,6 +30,120 @@ module BlackBook
       rescue Savon::SOAPFault => e
         raise BlackBookError.new e
       end
+
+      def current_valuation_from_data(year, make, model, series, style, mileage, state, options={})
+        response = request(:get_current_values, {
+          "sCountryCode" => (options[:country] || "U"),
+          "sFrequencyCode" => (options[:frequency] || "W"),
+          "sYear" => year,
+          "sMake" => make,
+          "sModel" => model,
+          "sSeries" => series,
+          "sStyle" => style,
+          "iMileage" => mileage,
+          "sState" => state,
+          "iExtraCleanAddDeductAdj" => (options[:extra_clean_adjustment] || 0),
+          "iCleanAddDeductAdj" => (options[:clean_adjustment] || 0),
+          "iAverageAddDeductAdj" => (options[:average_adjustment] || 0),
+          "iRoughAddDeductAdj" => (options[:rough_adjustment] || 0),
+          "bFillDrilldown" => "false",
+          "bReturnMileage" => "true",
+          "bReturnAddDeducts" => "true"
+        })
+
+        envelope = response.hash[:envelope]
+
+        raise VehicleNotFound if envelope[:header][:user_credentials][:returncode] == "20"
+        raise BlackBookError if envelope[:header][:user_credentials][:returncode] != "0"
+
+        envelope[:body][:current_values_response][:current_values_result]
+      rescue Savon::SOAPFault => e
+        raise BlackBookError.new e
+      end
+
+      def years(options={})
+        response = request(:get_years, {
+          "sCountryCode" => (options[:country] || "U")
+        })
+
+        envelope = response.hash[:envelope]
+
+        raise BlackBookError if envelope[:header][:user_credentials][:returncode] != "0"
+
+        envelope[:body][:years_response][:years_result][:years][:year]
+      rescue Savon::SOAPFault => e
+        raise BlackBookError.new e
+      end
+
+      def makes(year, options={})
+        response = request(:get_makes, {
+          "sCountryCode" => (options[:country] || "U"),
+          "sYear" => year
+        })
+
+        envelope = response.hash[:envelope]
+
+        raise BlackBookError if envelope[:header][:user_credentials][:returncode] != "0"
+        raise MakesNotFound if envelope[:body][:makes_response][:makes_result][:makes].nil?
+
+        envelope[:body][:makes_response][:makes_result][:makes][:make]
+      rescue Savon::SOAPFault => e
+        raise BlackBookError.new e
+      end
+
+      def models(year, make, options={})
+        response = request(:get_models, {
+          "sCountryCode" => (options[:country] || "U"),
+          "sYear" => year,
+          "sMake" => make
+        })
+
+        envelope = response.hash[:envelope]
+
+        raise BlackBookError if envelope[:header][:user_credentials][:returncode] != "0"
+        raise ModelsNotFound if envelope[:body][:models_response][:models_result][:models].nil?
+
+        envelope[:body][:models_response][:models_result][:models][:model]
+      rescue Savon::SOAPFault => e
+        raise BlackBookError.new e
+      end
+
+      def series(year, make, model, options={})
+        response = request(:get_series, {
+          "sCountryCode" => (options[:country] || "U"),
+          "sYear" => year,
+          "sMake" => make,
+          "sModel" => model
+        })
+
+        envelope = response.hash[:envelope]
+
+        raise BlackBookError if envelope[:header][:user_credentials][:returncode] != "0"
+        raise SeriesNotFound if envelope[:body][:series_response][:series_result][:series].nil?
+
+        envelope[:body][:series_response][:series_result][:series][:vehseries]
+      rescue Savon::SOAPFault => e
+        raise BlackBookError.new e
+      end
+
+      def styles(year, make, model, series, options={})
+        response = request(:get_styles, {
+          "sCountryCode" => (options[:country] || "U"),
+          "sYear" => year,
+          "sMake" => make,
+          "sModel" => model,
+          "sSeries" => series
+        })
+
+        envelope = response.hash[:envelope]
+
+        raise BlackBookError if envelope[:header][:user_credentials][:returncode] != "0"
+        raise StylesNotFound if envelope[:body][:body_styles_response][:body_styles_result][:styles].nil?
+
+        envelope[:body][:body_styles_response][:body_styles_result][:styles][:style]
+      rescue Savon::SOAPFault => e
+        raise BlackBookError.new e
+      end
     end
   end
 end

data/lib/black_book/version.rb

@@ -1,3 +1,3 @@
 module BlackBook
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/black_book/used_cars_test.rb

@@ -1,18 +1,18 @@
 require_relative "../minitest_helper"
 
 describe BlackBook::UsedCars do
+  before do
+    BlackBook.configure do |config|
+      config.user_id = "xxxxx"
+      config.password = "xxxxx"
+    end
+  end
+
   it "returns a proper WSDL URL" do
     BlackBook::UsedCars.wsdl_url.must_equal "https://www.blackbookws.com/UsedCarWSX.asmx?WSDL"
   end
 
   describe "current valuation for a given VIN, mileage and state" do
-    before do
-      BlackBook.configure do |config|
-        config.user_id = "xxxx"
-        config.password = "xxxx"
-      end
-    end
-
     it "should have a list of services" do
       VCR.use_cassette("wsdl") do
         BlackBook::UsedCars.operations.must_include :get_current_vin_values
@@ -22,7 +22,7 @@ describe BlackBook::UsedCars do
     it "should get the current values of a given VIN" do
       VCR.use_cassette("wsdl") do
         VCR.use_cassette("valid_request") do
-          BlackBook::UsedCars.current_valuation_for("1D7HW22K45S177616", 50_000, "IL")[:value_array].must_include :bb_value
+          BlackBook::UsedCars.current_valuation_from_vin("1D7HW22K45S177616", 50_000, "IL")[:value_array].must_include :bb_value
         end
       end
     end
@@ -30,7 +30,7 @@ describe BlackBook::UsedCars do
     it "should raise an exception when a VIN is not found" do
       VCR.use_cassette("wsdl") do
         VCR.use_cassette("vin_not_found") do
-          proc { BlackBook::UsedCars.current_valuation_for("NOT_FOUND", 50_000, "IL") }.must_raise BlackBook::VinNotFound
+          proc { BlackBook::UsedCars.current_valuation_from_vin("NOT_FOUND", 50_000, "IL") }.must_raise BlackBook::VinNotFound
         end
       end
     end
@@ -38,9 +38,185 @@ describe BlackBook::UsedCars do
     it "should raise an exception when passing bad request data" do
       VCR.use_cassette("wsdl") do
         VCR.use_cassette("savon_error") do
-          proc { BlackBook::UsedCars.current_valuation_for("1D7HW22K45S177616", "", "") }.must_raise BlackBook::BlackBookError
+          proc { BlackBook::UsedCars.current_valuation_from_vin("1D7HW22K45S177616", "", "") }.must_raise BlackBook::BlackBookError
+        end
+      end
+    end
+  end
+
+  describe "current valuation for make, model, series, and style" do
+    it "should have a list of services" do
+      VCR.use_cassette("wsdl") do
+        BlackBook::UsedCars.operations.must_include :get_current_values
+      end
+    end
+
+    it "should get the current values" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("value_valid_request") do
+          BlackBook::UsedCars.current_valuation_from_data(2013, "Ford", "Fiesta", "SE", "4D Hatchback", 10_000, "IL")[:value_array].must_include :bb_value
+        end
+      end
+    end
+
+    it "should raise an exception when passing bad request data" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("value_savon_error") do
+          proc { BlackBook::UsedCars.current_valuation_from_data(2013, "Ford", "Fiesta", "SE", "4D Hatchback", 10_000, "IL", { country: "INVALID" }) }.must_raise BlackBook::BlackBookError
+        end
+      end
+    end
+  end
+
+  describe "years" do
+    it "should have a list of services" do
+      VCR.use_cassette("wsdl") do
+        BlackBook::UsedCars.operations.must_include :get_years
+      end
+    end
+
+    it "should get the current years" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("years_valid_request") do
+          BlackBook::UsedCars.years.must_include "2013"
+        end
+      end
+    end
+
+    it "should raise an exception when passing bad request data" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("years_savon_error") do
+          proc { BlackBook::UsedCars.years({ country: "INVALID" }) }.must_raise BlackBook::BlackBookError
+        end
+      end
+    end
+  end
+
+  describe "makes" do
+    it "should have a list of services" do
+      VCR.use_cassette("wsdl") do
+        BlackBook::UsedCars.operations.must_include :get_makes
+      end
+    end
+
+    it "should get the current years" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("makes_valid_request") do
+          BlackBook::UsedCars.makes(2013).must_include "Ford"
+        end
+      end
+    end
+
+    it "should raise an exception when passing bad request data" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("make_savon_error") do
+          proc { BlackBook::UsedCars.makes(2013, { country: "INVALID" }) }.must_raise BlackBook::BlackBookError
+        end
+      end
+    end
+
+    it "should raise an exception when no vehicles are found" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("makes_error") do
+          proc { BlackBook::UsedCars.makes(1864) }.must_raise BlackBook::MakesNotFound
+        end
+      end
+    end
+  end
+
+  describe "models" do
+    it "should have a list of services" do
+      VCR.use_cassette("wsdl") do
+        BlackBook::UsedCars.operations.must_include :get_models
+      end
+    end
+
+    it "should get the current years" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("models_valid_request") do
+          BlackBook::UsedCars.models(2013, "Ford").must_include "Fiesta"
+        end
+      end
+    end
+
+    it "should raise an exception when passing bad request data" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("model_savon_error") do
+          proc { BlackBook::UsedCars.models(2013, "Ford", { country: "INVALID" }) }.must_raise BlackBook::BlackBookError
+        end
+      end
+    end
+
+    it "should raise an exception when no vehicles are found" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("model_error") do
+          proc { BlackBook::UsedCars.models(1864, "Ford") }.must_raise BlackBook::ModelsNotFound
+        end
+      end
+    end
+  end
+
+  describe "series" do
+    it "should have a list of services" do
+      VCR.use_cassette("wsdl") do
+        BlackBook::UsedCars.operations.must_include :get_series
+      end
+    end
+
+    it "should get the current series" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("series_valid_request") do
+          BlackBook::UsedCars.series(2013, "Ford", "Fiesta").must_include "SE"
+        end
+      end
+    end
+
+    it "should raise an exception when passing bad request data" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("series_savon_error") do
+          proc { BlackBook::UsedCars.series(2013, "Ford", "Fiesta", { country: "INVALID" }) }.must_raise BlackBook::BlackBookError
+        end
+      end
+    end
+
+    it "should raise an exception when no vehicles are found" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("series_error") do
+          proc { BlackBook::UsedCars.series(1864, "Ford", "Fiesta") }.must_raise BlackBook::SeriesNotFound
+        end
+      end
+    end
+  end
+
+  describe "styles" do
+    it "should have a list of services" do
+      VCR.use_cassette("wsdl") do
+        BlackBook::UsedCars.operations.must_include :get_styles
+      end
+    end
+
+    it "should get the current styles" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("styles_valid_request") do
+          BlackBook::UsedCars.styles(2013, "Ford", "Fiesta", "SE").must_include "4D Hatchback"
+        end
+      end
+    end
+
+    it "should raise an exception when passing bad request data" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("style_savon_error") do
+          proc { BlackBook::UsedCars.styles(2013, "Ford", "Fiesta", "SE", { country: "INVALID" }) }.must_raise BlackBook::BlackBookError
+        end
+      end
+    end
+
+    it "should raise an exception when no vehicles are found" do
+      VCR.use_cassette("wsdl") do
+        VCR.use_cassette("styles_error") do
+          proc { BlackBook::UsedCars.styles(1864, "Ford", "Fiesta", "SE") }.must_raise BlackBook::StylesNotFound
         end
       end
     end
   end
-end
+end

data/test/fixtures/vcr_cassettes/make_savon_error.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.blackbookws.com/UsedCarWSX.asmx
+    body:
+      encoding: US-ASCII
+      string: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?><env:Envelope xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"
+        xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:tns=\"https://blackbookws.com/UsedCarWSX\"
+        xmlns:env=\"http://schemas.xmlsoap.org/soap/envelope/\"><env:Header><UserCredentials
+        xmlns=\"https://blackbookws.com/UsedCarWSX\">\n            <userid>xxxxx</userid>\n
+        \           <password>xxxxx</password>\n            <customer/>\n            <producttype>W</producttype>\n
+        \           <returncode>0</returncode>\n            <returnmessage/>\n          </UserCredentials></env:Header><env:Body><tns:Makes><tns:sCountryCode>INVALID</tns:sCountryCode><tns:sYear>2013</tns:sYear></tns:Makes></env:Body></env:Envelope>"
+    headers:
+      Soapaction:
+      - ! '"https://blackbookws.com/UsedCarWSX/Makes"'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Content-Length:
+      - '705'
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private, max-age=0
+      Content-Type:
+      - text/xml; charset=utf-8
+      Server:
+      - Microsoft-IIS/7.5
+      X-Aspnet-Version:
+      - 2.0.50727
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Thu, 06 Jun 2013 17:34:34 GMT
+      Content-Length:
+      - '619'
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Header><UserCredentials
+        xmlns="https://blackbookws.com/UsedCarWSX"><userid>xxxxx</userid><password>xxxxx</password><customer
+        /><producttype>W</producttype><returncode>31</returncode><returnmessage>Invalid
+        or missing country code</returnmessage></UserCredentials></soap:Header><soap:Body><MakesResponse
+        xmlns="https://blackbookws.com/UsedCarWSX"><MakesResult /></MakesResponse></soap:Body></soap:Envelope>
+    http_version:
+  recorded_at: Thu, 06 Jun 2013 17:34:34 GMT
+recorded_with: VCR 2.5.0

data/test/fixtures/vcr_cassettes/makes_error.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.blackbookws.com/UsedCarWSX.asmx
+    body:
+      encoding: US-ASCII
+      string: ! "<?xml version=\"1.0\" encoding=\"UTF-8\"?><env:Envelope xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"
+        xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:tns=\"https://blackbookws.com/UsedCarWSX\"
+        xmlns:env=\"http://schemas.xmlsoap.org/soap/envelope/\"><env:Header><UserCredentials
+        xmlns=\"https://blackbookws.com/UsedCarWSX\">\n            <userid>xxxxx</userid>\n
+        \           <password>xxxxx</password>\n            <customer/>\n            <producttype>W</producttype>\n
+        \           <returncode>0</returncode>\n            <returnmessage/>\n          </UserCredentials></env:Header><env:Body><tns:Makes><tns:sCountryCode>U</tns:sCountryCode><tns:sYear>1864</tns:sYear></tns:Makes></env:Body></env:Envelope>"
+    headers:
+      Soapaction:
+      - ! '"https://blackbookws.com/UsedCarWSX/Makes"'
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Content-Length:
+      - '699'
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private, max-age=0
+      Content-Type:
+      - text/xml; charset=utf-8
+      Server:
+      - Microsoft-IIS/7.5
+      X-Aspnet-Version:
+      - 2.0.50727
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Thu, 06 Jun 2013 17:34:32 GMT
+      Content-Length:
+      - '625'
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Header><UserCredentials
+        xmlns="https://blackbookws.com/UsedCarWSX"><userid>xxxxx</userid><password>xxxxx</password><customer
+        /><producttype>W</producttype><returncode>0</returncode><returnmessage>success
+        - (makes)</returnmessage></UserCredentials></soap:Header><soap:Body><MakesResponse
+        xmlns="https://blackbookws.com/UsedCarWSX"><MakesResult><makes /></MakesResult></MakesResponse></soap:Body></soap:Envelope>
+    http_version:
+  recorded_at: Thu, 06 Jun 2013 17:34:33 GMT
+recorded_with: VCR 2.5.0