moto_recall 0.0.21

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3047d39b482c25da37c2be06e7dc56f78d16974
+  data.tar.gz: c492a504c914cd7b7d9c4999957218431165f81a
+SHA512:
+  metadata.gz: cb197f7ae24a62a2971a5f06a697a499126791acd550ae260d84cfe00440bc2a856ea3da3e590981f8d9d1195f6002ac25ee4a484cbd631ff3fbf929873510ca
+  data.tar.gz: a7237eda7bbb1abe5496ea403db1e4b200d3eeb964b039527c42d741f3a88065785526ec3ea349bcf3a7c08bb94ce810160df4ae2731e7e990b9f0dbd07e7732

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+samples.csv

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in moto_recall.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jordan Stephens
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# MotoRecall
+
+Find vehicle recall info by manufacturer and VIN.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'moto_recall'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install moto_recall
+
+## Usage
+
+Find vehicle recall data by make and VIN.
+
+    MotoRecall.find(:chevrolet, "1G1ZC5E14BF265574")
+
+> **NOTE**: Toyota/Lexus/Scion are not supported right now because they require a CAPTCHA to be solved.
+
+## Maintenance and Sampling
+
+The problem of presenting uniform data from a disparate set of remote services is difficult—particularly from the perspective of maintenance, considering that breaking changes are likely to occur without warning. To help with monitoring the parity of the code and the remotes, we have included a rake task to aid in sampling responses from each of the remotes.
+
+```
+$ bundle exec rake samples
+```
+
+### Defining Samples
+
+This task uses a data in the file `data/sample_queries.yml` as input with the following format:
+
+```yaml
+---
+chevrolet: 2011 Chevrolet Malibu
+ford: 2013 Ford Explorer XLT
+chrysler: 2013 Chrysler 300
+# make: vehicle-description
+# ...
+```
+
+Each row in this file has two components: a make name, and a vehicle description. The vehicle description is used to find a set of VINs for that vehicle, each VIN is then passed to `MotoRecall.find` along with the make to get a list of recalls for that VIN.
+
+Because finding recalls are directly coupled to a specific VIN, it can be tedious to find appropriate VINs to use for testing. This setup is designed to minimize friction when needing to test MotoRecall with a particular manufacturer's service.
+
+### Examining Samples
+
+The `samples` task will write output to a file called `samples.csv`, which will contain a table of attributes for each of the found recalls. See [`samples-example.csv`](https://github.com/motologic/moto_recall/blob/master/samples-example.csv) for an example.
+
+### Adding New Samples
+
+When you want to test MotoRecall with a new manufacturer, it is recommended to start by identifying a class of vehicle with recently announced recalls. Head to Google with something like "_volkswagen recalls_". Somewhere in the first handful of results, you are likely to come across an article announcing that VW has announced recalls for some set of it's lineup. For example, let's say this set includes the _2014 Passat_. You would want to add a line to `data/sample_queries.yml` which looks like
+
+```yaml
+volkswagen: 2014 Volkswagen Passat
+```
+
+> **NOTE**: The _description_ component of the entry (the part after the make) is freeform text. This text is used to identify sample VINs to be tested.
+
+Now the next time you run the `samples` task, some VINs will be tested which belong to 2014 Passats. If no recalls are found for your query, try another class of vehicle.
+
+

data/Rakefile

@@ -0,0 +1,46 @@
+require "bundler/gem_tasks"
+require "moto_recall/sampler"
+require "pry-byebug"
+require "yaml"
+require "csv"
+
+task :samples do
+  include MotoRecall::Sampler::Util
+
+  MotoRecall::Sampler::CACHE.clear if ENV["NO_CACHE"] == "true"
+
+  queries_path = "data/sample_queries.yml"
+  output_path = "samples.csv"
+
+  counts = {}
+
+  queries = YAML.load_file(queries_path)
+  samples = MotoRecall::Sampler.run(queries)
+
+  CSV.open(output_path, "wb") do |csv|
+    csv << ["VIN", "make"] + MotoRecall::Recall::KEYS
+    samples.each do |sample|
+      sample.recalls.each do |recall|
+        counts[sample.make] ||= 0
+        counts[sample.make] += 1
+
+        csv << [sample.vin, sample.make] + recall.values
+      end
+    end
+  end
+
+  puts "\nSampled Counts by Make"
+
+  counts.each do |make, count|
+    log_colored_count(count, "\t#{make}")
+  end
+
+  puts
+  puts %Q(*** To clear cache, run with NO_CACHE=true)
+  puts
+  puts "*" * 60
+  puts %Q(Output written to "#{output_path}")
+  puts "*" * 60
+  puts
+end
+

data/data/class_map.yml

@@ -0,0 +1,41 @@
+---
+gm: &gm
+  GeneralMotors
+fd: &fd
+  Ford
+cy: &cy
+  Chrysler
+bmw: &bmw
+  Bmw
+jg: &jg
+  Jaguar
+
+buick: *gm
+cadillac: *gm
+chevrolet: *gm
+gmc_truck: *gm
+gmc: *gm
+geo: *gm
+hummer: *gm
+oldsmobile: *gm
+pontiac: *gm
+saab: *gm
+saturn: *gm
+
+ford: *fd
+lincoln: *fd
+mercury: *fd
+
+chrysler: *cy
+dodge: *cy
+jeep: *cy
+plymouth: *cy
+eagle: *cy
+ram: *cy
+fiat: *cy
+
+mini: *bmw
+bmw: *bmw
+b_m_w: *bmw
+
+land_rover: *jg

data/data/sample_queries.yml

@@ -0,0 +1,17 @@
+---
+chevrolet: 2011 Chevrolet Malibu
+ford: 2013 Ford Explorer XLT
+chrysler: 2013 Chrysler 300
+honda: 2008 Honda Pilot
+nissan: 2014 Nissan Altima SV
+infiniti: 2014 Infiniti Q70
+volkswagen: 2014 Volkswagen Passat
+audi: 2013 Audi A4
+hyundai: 2009 Hyundai Elantra
+kia: 2009 Kia Optima
+mazda: 2008 Mazda Mazda6
+mercedes: 2015 Mercedes CLS 400
+bmw: 2001 BMW 325i
+subaru: 2011 Subaru Impreza
+jaguar: 2004 Jaguar XJ
+volvo: 2012 Volvo S60

data/lib/moto_recall.rb

@@ -0,0 +1,38 @@
+require "moto_recall/version"
+require "moto_recall/class_map"
+require "moto_recall/recall"
+require "moto_recall/recall_set"
+require "moto_recall/client/generic_client"
+require "moto_recall/client/acura"
+require "moto_recall/client/audi"
+require "moto_recall/client/bmw"
+require "moto_recall/client/chrysler"
+require "moto_recall/client/ford"
+require "moto_recall/client/general_motors"
+require "moto_recall/client/honda"
+require "moto_recall/client/hyundai"
+require "moto_recall/client/infiniti"
+require "moto_recall/client/isuzu"
+require "moto_recall/client/jaguar"
+require "moto_recall/client/kia"
+require "moto_recall/client/mazda"
+require "moto_recall/client/mitsubishi"
+require "moto_recall/client/nissan"
+require "moto_recall/client/subaru"
+require "moto_recall/client/volkswagen"
+require "moto_recall/client/volvo"
+
+module MotoRecall
+  class ClientException < StandardError; end
+  class InvalidVinError < StandardError; end
+
+  def self.find(make, vin)
+    raise InvalidVinError, "VIN is not 17 chars" if vin.length != 17
+    client_class = ClassMap.class_for_make(make)
+    begin
+      client_class.new.find(vin)
+    rescue StandardError => error
+      raise MotoRecall::ClientException, "(#{client_class}) #{error.class}: #{error.inspect}\n#{error.backtrace.join("\n")}"
+    end
+  end
+end

data/lib/moto_recall/class_map.rb

@@ -0,0 +1,24 @@
+require "yaml"
+
+module MotoRecall
+  class UnsupportedMakeError < StandardError; end
+  module ClassMap
+    CLASS_MAP_PATH = "data/class_map.yml"
+
+    def self.class_for_make(make)
+      make_class_name = data[make.to_s.downcase] || make.capitalize
+      begin
+        Object.const_get("MotoRecall::Client::#{make_class_name}")
+      rescue NameError
+        raise UnsupportedMakeError, "Invalid Make: #{make}"
+      end
+    end
+
+    def self.data
+      path = File.join(File.dirname(__FILE__), "..", "..", CLASS_MAP_PATH)
+      @data || begin
+        YAML.load_file(path)
+      end
+    end
+  end
+end

data/lib/moto_recall/client/acura.rb

@@ -0,0 +1,32 @@
+require "json"
+
+# If you make any changes to this file, make sure to also make them in the
+# Honda client as they are pretty much the same running on different domains
+
+module MotoRecall::Client
+  class Acura < GenericClient
+    def self.url(vin)
+      "http://owners.acura.com/Recalls/GetRecallsByVin/#{vin}/true"
+    end
+
+    def process(response)
+      parsed_response = JSON.parse(response)
+      (parsed_response["CampaignTypes"][0]["Campaigns"] || []) rescue []
+    end
+
+    def format(recall)
+      {
+        type: recall["AgencyType"],
+        nhtsa_number: recall["RecallNumber"],
+        oem_number: recall["Id"],
+        date: recall["RecallDate"],
+        title: recall["Description"],
+        description: recall["RecallDescription"],
+        safety_risk: recall["SafetyRiskDescription"],
+        remedy: recall["RemedyDescription"],
+        status: recall["RecallStatus"],
+        notes: nil
+      }
+    end
+  end
+end

data/lib/moto_recall/client/audi.rb

@@ -0,0 +1,29 @@
+require "json"
+
+module MotoRecall::Client
+  class Audi < GenericClient
+    def self.url(vin = nil)
+      "http://web.audiusa.com/audirecall/vin/#{vin}"
+    end
+
+    def process(response)
+      parsed_response = JSON.parse(response)
+      parsed_response.has_key?("recalls") ? parsed_response["recalls"] : []
+    end
+
+    def format(recall)
+      {
+        type: recall["vwgoaActionType"],
+        nhtsa_number: recall["nhtsaRecallNumber"],
+        oem_number: recall["mfrRecallNumber"],
+        date: recall["recallDate"],
+        title: recall["vwgoaActionTitle"],
+        description: recall["recallDescription"],
+        safety_risk: recall["safetyRiskDescription"],
+        remedy: recall["remedyDescription"],
+        status: recall["mfrRecallStatus"],
+        notes: recall["mfrNotes"]
+      }
+    end
+  end
+end

data/lib/moto_recall/client/bmw.rb

@@ -0,0 +1,29 @@
+require "json"
+
+module MotoRecall::Client
+  class Bmw < GenericClient
+    def self.url(vin)
+      "http://www.bmwusa.com/Services/VinRecallService.svc/GetRecallCampaignsForVin/#{vin}"
+    end
+
+    def process(response)
+      parsed_data = JSON.parse(response)
+      parsed_data["ViewModel"]["RecallCampaigns"] rescue []
+    end
+
+    def format(recall)
+      {
+        type: nil,
+        nhtsa_number: recall["RecallNumber"],
+        oem_number: recall["ManufacturerRecallNumber"],
+        date: recall["RecallDate"],
+        title: recall["Title"],
+        description: recall["Description"],
+        safety_risk: recall["SafetyRiskDescription"],
+        remedy: recall["RemedyDescription"],
+        status: recall["ManufacturerRecallStatus"],
+        notes: recall["ManufacturerNotes"]
+      }
+    end
+  end
+end

data/lib/moto_recall/client/chrysler.rb

@@ -0,0 +1,51 @@
+module MotoRecall::Client
+  class Chrysler < GenericClient
+    def self.url(vin)
+      "https://www.moparownerconnect.com/oc/us/en-us/sub/Pages/RecallsResults.aspx?Vin=#{vin}"
+    end
+
+    def process(response)
+      doc = Nokogiri::HTML(response)
+      content = doc.css("#centerbodyContentWrp")
+      recalls = []
+
+      unless content.text.include?("No Outstanding Recalls or Customer Satisfaction Notifications Exist")
+        # Chrysler's response has two tables, one for "Safety Recalls"
+        # which is at this selector (`#divSafetyRecallsTable table`)
+        # and one for "Campaigns" (`#divCampaignTable table`).
+        # `2C4RC1BG9ER209216` shows an example of a "Safety Recall"
+        # but I haven't yet seen an example of a "Campaign." We will
+        # want to make sure that we return content from both tables.
+        tables = doc.css("#divSafetyRecallsTable table, #divCampaignTable table")
+
+        tables.each do |table|
+          headers = table.css("tr:first-child th").map { |th| th.text }
+          recalls << table.css("tr:not(:first-child)").map do |tr|
+            recall = {}
+            tr.css("td").each_with_index do |td, i|
+              recall[headers[i]] = td.text.strip
+            end
+            recall
+          end
+        end
+      end
+
+      recalls.flatten
+    end
+
+    def format(recall)
+      {
+        type: nil,
+        nhtsa_number: recall["NHTSA Recall #"],
+        oem_number: recall["Chrysler Recall #"],
+        date: recall["Recall Date"],
+        title: nil,
+        description: recall["Repair Description"],
+        safety_risk: recall["Safety Defect/Non Compliance Description and Safety Risk"],
+        remedy: nil,
+        status: recall["Recall Status"],
+        notes: nil
+      }
+    end
+  end
+end