edmunds_ruby 1.0.1 → 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cfe4a81f60a0f4d6c32231a9853893e7c540a9e
+  data.tar.gz: fb5d4063730aa7808cefbaf14a91a20cd2ed2b07
+SHA512:
+  metadata.gz: d89114a9c780f6ec0eb5868487367e57ed360e4aaf674365462d6ff41f58af415e2bbbdc3b6ea99b20f96cdb1655fe8baa4b13ddf7dd3d49704e7260a820e618
+  data.tar.gz: 6e230a877f3383ef13ba80d7c85f36d59c9740192958d19bdb9178c4157d06798eaceeb5c0bd11e227c05dfa8955cdbc70d9d5f3258c5b41b43ff0e47351b339

data/README.md

@@ -1,9 +1,8 @@
-## Ruby wrapper for the Edmunds auto api
+## Ruby wrapper for the Edmunds Vehicle API (V1)
 
 This API wrapper will allow you to make calls to the Edmunds Vehicle API to get detailed information about nearly any make, model, and style (trim).
 You can also get production images for each vehicle.
 
-
 ## Setup:
 
 First, include the gem in your Gemfile:
@@ -28,7 +27,7 @@ You will need to create an account with Edmunds and get a free developer Vehicle
 
 Once you get your API key, either create an initializer file to place it in OR add it to your .bashrc script
 
-#### method 1 - put api key in an initializer file:
+#### option 1 - put api key in an initializer file:
 
 Create a new file in config/initializers called edmunds.rb, like so:
 
@@ -41,7 +40,7 @@ Add this line, with your api key:
 Save the file and exit.
 
 
-#### method 2 - put api key in your .bashrc script:
+#### option 2 - put api key in your .bashrc script:
 
 Open .bashrc file:
 
@@ -57,6 +56,14 @@ Save and close the file, then source the file to make the changes take effect:
 
 Now you can use the Vehicle API as you like.
 
+### Verify API key:
+
+Open a console and try this:
+
+    Edmunds::API.new.api_key
+
+You should see your API key returned... if not, go back to the above steps and verify that you have it in an initializer or your bashrc script as described.
+
 
 ## Usage:
 
@@ -75,9 +82,98 @@ For the Model class, you will have to provide an id first (which you can get fro
     m = Edmunds::Model.new
     m.find_by_id("Lamborghini_Diablo")
 
+## Here is a complete list of available methods:
 
-More documentation on the way...
+The method descriptions were pulled from the Edmunds API documentation.
+
+    http://developer.edmunds.com/docs/read/Home
+
+The method names in this wrapper were kept as close to the original Edmunds API method names as possible, to avoid confusion.
+
+While I plan on wrapping the entire Vehicle API, I currently only have the Make, Model, ModelYear, Style, and Photo methods covered.
+
+#### Edmunds::Make.new
+
+http://developer.edmunds.com/docs/read/the_vehicle_api/Make_Repository
+
+    find_all                                          # Get the list of all makes and their all their models
+    find_by_id(make_id)                               # Find a make and its models by providing a make ID
+    find_future_makes                                 # Find all future makes and their models
+    find_make_by_name(name)                           # Find a make details by its name
+    find_makes_by_model_year(model_year)              # Find a make by a year
+    find_makes_by_publication_state(state)            # Find makes by their state (new or used)
+    find_new_and_used                                 # Find all new and used makes
+    find_new_and_used_makes_by_model_year(model_year) # Find all new and used makes for a particular year
+    find_new_makes                                    # Find only new makes
+    find_used_makes                                   # Find only old makes
+
+#### Edmunds::Model.new
+
+http://developer.edmunds.com/docs/read/the_vehicle_api/Model_Repository
+
+    find_by_id(model_id)                                   # Get a vehicle's model details by the model ID
+    find_by_make_id(make_id)                               # Get a vehicle's model details by the make ID
+    find_future_models_by_make_id(make_id)                 # Get a list of all future models by the make ID
+    find_model_by_make_model_name(make, model)             # Get a vehicle model by the make and model names
+    find_models_by_make(make)                              # Get a list of models by the make name
+    find_models_by_make_and_publication_state(make, state) # Get a list of models by the make name and the publication state
+    find_models_by_make_and_year(make, year)               # Get a list of models by the make name and year
+    find_new_and_used_models_by_make_id(make_id)           # Get a list of new and used models by the make ID
+    find_new_models_by_make_id(make_id)                    # Get a list of new models by the make ID
+    find_used_models_by_make_id(make_id)                   # Get a list of used models by the make ID
+
+#### Edmunds::ModelYear.new
+
+http://developer.edmunds.com/docs/read/the_vehicle_api/Year_Repository
 
+    find_by_id(model_year_id)                                        # Get details on a specifc vehicle by its model year ID
+    find_distinct_year_with_new                                      # Get a list of years under which there are new vehicle listings
+    find_distinct_year_with_new_or_used                              # Get a list of years under which there are new or used vehicle listings
+    find_distinct_year_with_used                                     # Get a list of years under which there are used vehicle listings
+    find_future_model_years_by_model_id(model_id)                    # Get a list of future model years by the model ID
+    find_model_years_by_make_and_year(make, year)                    # Get a list of model years for a specific make and year
+    find_model_years_by_make_model(make, model)                      # Get a list of model years for a specific make and model
+    find_new_and_used_model_years_by_make_id_and_year(make_id, year) # Get a list of new and used model years for a specific make ID and year
+    find_new_model_years_by_model_id(model_id)                       # Get a list of new model years by the model ID
+    find_used_model_years_by_model_id(model_id)                      # Get a list of used model years by the model ID
+    find_years_by_category_and_publication_state(category, state)    # Get a list of model years for a specific category and publication state
+    for_model_id(model_id)                                           # Get a list of model years by the model ID
+    for_year_make_model(year, make, model)                           # Get a list of model years for a specific make, model and year
+
+#### Edmunds::Style.new
+
+http://developer.edmunds.com/docs/read/the_vehicle_api/Style_Repository
+
+    find_by_id(style_id)                              # Get a style details by the style ID
+    find_styles_by_make_model_year(make, model, year) # Get a list of styles by make, model and year
+    find_styles_by_model_year_id(model_year_id)       # Get a list of styles by model year ID
+
+#### Edmunds::Photo.new
+
+http://developer.edmunds.com/docs/read/the_vehicle_api/Photos
+
+    find_by_style_id(style_id)        # Get an array of photo detail objects for a particular vehicle style
+    find_sample_by_style_id(style_id)        # Get a sample photo url for a particular vehicle style - tries to get a exterior front view image if available.
+
+Note that the image arrays returned by the find_photos_by_style_id() method return an array of image links that will still need the base url attached to them in order to view the image.
+
+The image base url can be accessed from any of the classes, for instance these all return the same image base url:
+
+    Edmunds::API.new.image_base_url
+    Edmunds::Make.new.image_base_url
+    Edmunds::Photo.new.image_base_url
+
+or if you set the new instance to a variable:
+
+    p = Edmunds::Photo.new
+    p.image_base_url
+
+Will both return the base url (url prefix) that must be prepended to the links returned by the Photo API method.
+
+With this in mind, I added that last photo method to grab a sample url for an image of any style, then go ahead and add the image base url to the beginning, thus making a valid url that you can click on to see the image... it is not listed as an Edmunds API method, but I found it useful.
+
+
+More documentation on the way...
 
 ## Bug reports and Pull requests
 

data/lib/edmunds/photo.rb

@@ -11,12 +11,52 @@ module Edmunds
     # get the array of images, then sample one image from the group of exterior and front quarter panel (FQ) shots, then go ahead and append the base url so you can view the image directly.
     # if no sample is found, just return the entire array.
     def find_sample_by_style_id(style_id)
-      @url = "photo/service/findphotosbystyleid?styleId=#{style_id}&"
-      call_api
-      @image = @image_base_url + @json.select{|s| s["subType"] == "exterior" && s["shotTypeAbbreviation"] == "FQ" }.first["photoSrcs"].select{|s| s.match(/\d{3}(.jpg)/) }.max
+      if style_id.is_a?(Array)
+        style_id.each do |id|
+          fetch_image_groups(id)
+          break if @json.present?
+        end
+      else
+        fetch_image_groups(style_id)
+      end
+      select_group
+      concatenate
     rescue
       @json
     end
 
+    private
+
+    def fetch_image_groups(style_id)
+      @url = "photo/service/findphotosbystyleid?styleId=#{style_id}&"
+      call_api
+    end
+
+    def select_group
+      exterior = @json.select{|s| s["subType"] == "exterior" }
+      if exterior.present?
+        # first try to get a front quarter panel shot "FQ"
+        preferred = exterior.select{|s| s["shotTypeAbbreviation"] == "FQ" }
+        # if not available try to get any quarter panel shot "Q"
+        preferred = exterior.select{|s| s["shotTypeAbbreviation"].match(/Q/) } unless preferred.present?
+        # if not available try to get a front shot "F"
+        preferred = exterior.select{|s| s["shotTypeAbbreviation"] == "F" } unless preferred.present?
+        # if not available try to get a side shot "S"
+        preferred = exterior.select{|s| s["shotTypeAbbreviation"] == "S" } unless preferred.present?
+        if preferred.present?
+          selected = preferred.first
+        else
+          selected = exterior.first
+        end
+      else
+        selected = @json.first
+      end
+      @sample = selected["photoSrcs"].select{|s| s.match(/\d{3}(.jpg)/) }.max
+    end
+
+    def concatenate
+      @image = @image_base_url + @sample
+    end
+
   end
 end

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: edmunds_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.0.2
 platform: ruby
 authors:
 - JD Warren
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2013-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: crack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby warapper for the Edmunds auto API
@@ -79,26 +72,25 @@ files:
 - README.md
 homepage: https://github.com/johndavid400/edmunds_ruby
 licenses: []
+metadata: {}
 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.25
+rubygems_version: 2.1.0.rc.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Edmunds auto API
 test_files: []