edmunds_ruby 0.1.0 → 1.0.0

data/README.md

@@ -0,0 +1,88 @@
+## Ruby wrapper for the Edmunds auto api
+
+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:
+
+    vim Gemfile
+
+    gem 'edmunds_ruby'
+
+    bundle
+
+Or if using from the console, just install the gem:
+
+    gem install 'edmunds_ruby'
+
+Now add your API key
+
+### Get Edmunds Vehicle API key:
+
+You will need to create an account with Edmunds and get a free developer Vehicle API key from here:
+
+    http://developer.edmunds.com
+
+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:
+
+Create a new file in config/initializers called edmunds.rb, like so:
+
+    vim config/initializers/edmunds.rb
+
+Add this line, with your api key:
+
+    Rails.configuration.edmunds_vehicle_api_key = "your_api_key_here"
+
+Save the file and exit.
+
+
+#### method 2 - put api key in your .bashrc script:
+
+Open .bashrc file:
+
+    vim ~/.bashrc
+
+Add this line near the top of the file:
+
+    export EDMUNDS_VEHICLE="your_api_key_here"
+
+Save and close the file, then source the file to make the changes take effect:
+
+    source ~/.bashrc
+
+Now you can use the Vehicle API as you like.
+
+
+## Usage:
+
+To use the gem, open a console and start playing.
+There are currently 5 classes you can call: Make, Model, ModelYear, Style, and Photo
+
+Some of the methods require inputs, others do not. Let's try an easy one first:
+
+    m = Edmunds::Make.new
+    m.find_all
+
+This should return a list of all vehicle makes in the system.
+
+For the Model class, you will have to provide an id first (which you can get from a Make response)
+
+    m = Edmunds::Model.new
+    m.find_by_id("Lamborghini_Diablo")
+
+
+More documentation on the way...
+
+
+## Bug reports and Pull requests
+
+Please open an issue on Github if you find a bug, and I will address it.
+
+If you have an improvement to submit, please fork the repo, add your code and send a pull request.
+
+

data/lib/edmunds/api.rb

@@ -0,0 +1,36 @@
+module Edmunds
+  class API
+    # Using this model requires setting your Edmunds API key in your ~/.bashrc file like so:
+    # export EDMUNDS_VEHICLE="your_api_key_here"
+
+    require 'rest_client'
+    require 'crack'
+    require 'crack/json'
+
+    attr_reader :base, :api_key, :image_base_url, :format, :base_url
+
+    def initialize
+      if set_key
+        @base = "http://api.edmunds.com/v1/api/vehicle"
+        @image_base_url = "http://media.ed.edmunds-media.com"
+        @format = "fmt=json&api_key=#{@api_key}"
+      else
+        return @errors
+      end
+    end
+
+    def set_key
+      @api_key = ENV["EDMUNDS_VEHICLE"] || Rails.configuration.edmunds_vehicle_api_key
+    rescue
+      @errors = "You need to set your Edmunds Vehicle API key first"
+      return false
+    end
+
+    def call_api
+      @base_url = @base + @url + @format
+      @resp = RestClient.get(@base_url)
+      @json = Crack::JSON.parse(@resp)
+    end
+  end
+
+end

data/lib/edmunds/make.rb

@@ -0,0 +1,65 @@
+module Edmunds
+  class Make < API
+    # Makes
+    def find_all
+      @url = "/makerepository/findall?"
+      call_api
+      @json["makeHolder"]
+    end
+
+    def find_by_id(make_id)
+      @url = "/makerepository/findbyid?id=#{make_id}&"
+      call_api
+      @json["makeHolder"]
+    end
+
+    def find_future_makes
+      @url = "/makerepository/findfuturemakes?"
+      call_api
+      @json["makeHolder"]
+    end
+
+    def find_make_by_name(make_name)
+      @url = "/makerepository/findmakebyname?name=#{make_name}&"
+      call_api
+      @json["makeHolder"]
+    end
+
+    def find_makes_by_model_year(model_year)
+      @url = "/makerepository/findmakesbymodelyear?year=#{model_year}&"
+      call_api
+      @json["makeHolder"]
+    end
+
+    def find_makes_by_publication_state(condition)
+      # should either be "new" or "used"
+      @url = "/makerepository/findmakesbypublicationstate?state=#{condition}&"
+      call_api
+      @json["makeHolder"]
+    end
+
+    def find_new_and_used
+      @url = "/makerepository/findnewandused?"
+      call_api
+      @json["makeHolder"]
+    end
+
+    def find_new_and_used_makes_by_model_year(year)
+      @url = "/makerepository/findnewandusedmakesbymodelyear?year=#{year}&"
+      call_api
+      @json["makeHolder"]
+    end
+
+    def find_new_makes
+      @url = "/makerepository/findnewmakes?"
+      call_api
+      @json["makeHolder"]
+    end
+
+    def find_used_makes
+      @url = "/makerepository/findusedmakes?"
+      call_api
+      @json["makeHolder"]
+    end
+  end
+end

data/lib/edmunds/model.rb

@@ -0,0 +1,67 @@
+module Edmunds
+  class Model < API
+
+    # models
+    def find_by_id(model_id)
+      @url = "/modelrepository/findbyid?id=#{model_id}&"
+      call_api
+      @json["modelHolder"]
+    end
+
+    def find_by_make_id(make_id)
+      @url = "/modelrepository/findbymakeid?makeid=#{make_id}&"
+      call_api
+      @json["modelHolder"]
+    end
+
+    def find_future_models_by_make_id(make_id)
+      @url = "/modelrepository/findfuturemodelsbymakeid?makeid=#{make_id}&"
+      call_api
+      @json["modelHolder"]
+    end
+
+    def find_model_by_make_model_name(make_name, model_name)
+      @url = "/modelrepository/findmodelbymakemodelname?make=#{make_name}&model=#{model_name}&"
+      call_api
+      @json["modelHolder"]
+    end
+
+    def find_models_by_make(make)
+      @url = "/modelrepository/findmodelsbymake?make=#{make}&"
+      call_api
+      @json["modelHolder"]
+    end
+
+    def find_models_by_make_and_publication_state(make, state)
+      # state should be "new", "used", etc..
+      @url = "/modelrepository/findmodelsbymakeandpublicationstate?make=#{make}&state=#{state}&"
+      call_api
+      @json["modelHolder"]
+    end
+
+    def find_models_by_make_and_year(make, year)
+      @url = "/modelrepository/findmodelsbymakeandyear?make=#{make}&year=#{year}&"
+      call_api
+      @json["modelHolder"]
+    end
+
+    def find_new_and_used_models_by_make_id(make_id)
+      @url = "/modelrepository/findnewandusedmodelsbymakeid?makeid=#{make_id}&"
+      call_api
+      @json["modelHolder"]
+    end
+
+    def find_new_models_by_make_id(make_id)
+      @url = "/modelrepository/findnewmodelsbymakeid?makeId=#{make_id}&"
+      call_api
+      @json["modelHolder"]
+    end
+
+    def find_used_models_by_make_id(make_id)
+      @url = "/modelrepository/findusedmodelsbymakeid?makeId=#{make_id}&"
+      call_api
+      @json["modelHolder"]
+    end
+
+  end
+end

data/lib/edmunds/model_year.rb

@@ -0,0 +1,83 @@
+module Edmunds
+  class ModelYear < API
+
+    def find_by_id(id)
+      @url = "/modelyearrepository/findbyid?id=#{id}&"
+      call_api
+      @json["modelYearHolder"]
+    end
+
+    def find_distinct_year_with_new
+      @url = "/modelyearrepository/finddistinctyearwithnew?"
+      call_api
+      @json
+    end
+
+    def find_distinct_year_with_new_or_used
+      @url = "/modelyearrepository/finddistinctyearwithneworused?"
+      call_api
+      @json
+    end
+
+    def find_distinct_year_with_used
+      @url = "/modelyearrepository/finddistinctyearwithused?"
+      call_api
+      @json
+    end
+
+    def find_future_model_years_by_model_id(model_id)
+      @url = "/modelyearrepository/findfuturemodelyearsbymodelid?modelId=#{model_id}&"
+      call_api
+      @json["modelYearHolder"]
+    end
+
+    def find_model_years_by_make_and_year(make, year)
+      @url = "/modelyearrepository/findmodelyearsbymakeandyear?make=#{make}&year=#{year}&"
+      call_api
+      @json["modelYearHolder"]
+    end
+
+    def find_model_years_by_make_model(make, model)
+      @url = "/modelyearrepository/findmodelyearsbymakemodel?make=#{make}&model=#{model}&"
+      call_api
+      @json["modelYearHolder"]
+    end
+
+    def find_new_and_used_model_years_by_makeid_and_year(make_id, year)
+      @url = "/modelyearrepository/findnewandusedmodelyearsbymakeidandyear?makeid=#{make_id}&year=#{year}&"
+      call_api
+      @json["modelYearHolder"]
+    end
+
+    def find_new_model_years_by_model_id(model_id)
+      @url = "/modelyearrepository/findnewmodelyearsbymodelid?modelId=#{model_id}&"
+      call_api
+      @json["modelYearHolder"]
+    end
+
+    def find_used_model_years_by_model_id(model_id)
+      @url = "/modelyearrepository/findusedmodelyearsbymodelid?modelId=#{model_id}&"
+      call_api
+      @json["modelYearHolder"]
+    end
+
+    def find_years_by_category_and_publication_state(category, state)
+      @url = "/modelyearrepository/findyearsbycategoryandpublicationstate?category=#{category}&state=#{state}&"
+      call_api
+      @json
+    end
+
+    def for_model_id(model_id)
+      @url = "/modelyearrepository/formodelid?modelid=#{model_id}&"
+      call_api
+      @json["modelYearHolder"]
+    end
+
+    def for_year_make_model(year, make, model)
+      @url = "/modelyearrepository/foryearmakemodel?year=#{year}&make=#{make}&model=#{model}&"
+      call_api
+      @json["modelYearHolder"]
+    end
+
+  end
+end

data/lib/edmunds/photo.rb

@@ -0,0 +1,22 @@
+module Edmunds
+  class Photo < API
+
+    # get an array of images available from this style id
+    def find_by_style_id(style_id)
+      @url = "photo/service/findphotosbystyleid?styleId=#{style_id}&"
+      call_api
+      @json
+    end
+
+    # 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
+    rescue
+      @json
+    end
+
+  end
+end

data/lib/edmunds/style.rb

@@ -0,0 +1,23 @@
+module Edmunds
+  class Style < API
+
+    def find_by_id(style_id)
+      @url = "/stylerepository/findbyid?id=#{style_id}&"
+      call_api
+      @json["styleHolder"]
+    end
+
+    def find_styles_by_make_model_year(make, model, year)
+      @url = "/stylerepository/findstylesbymakemodelyear?make=#{make}&model=#{model}&year=#{year}&"
+      call_api
+      @json["styleHolder"]
+    end
+
+    def find_styles_by_model_year_id(model_year_id)
+      @url = "/stylerepository/findstylesbymodelyearid?modelyearid=#{model_year_id}&"
+      call_api
+      @json["styleHolder"]
+    end
+
+  end
+end

data/lib/edmunds/version.rb

@@ -0,0 +1,3 @@
+module Edmunds
+  VERSION = "1.0.0"
+end

data/lib/edmunds_ruby.rb

@@ -1,40 +1,7 @@
-require 'edmunds_ruby/make_finders'
-require 'edmunds_ruby/model_finders'
-require 'edmunds_ruby/model_year_finders'
-require 'edmunds_ruby/style_finders'
-require 'edmunds_ruby/image_finders'
+require 'edmunds/api'
+require 'edmunds/photo'
+require 'edmunds/make'
+require 'edmunds/model'
+require 'edmunds/model_year'
+require 'edmunds/style'
 
-module EdmundsRuby
-
-  class API
-    include MakeFinders
-    include ModelFinders
-    include ModelYearFinders
-    include StyleFinders
-    include ImageFinders
-
-    # Using this model requires setting your Edmunds API key in your ~/.bashrc file like so:
-    # export EDMUNDS_VEHICLE="your_api_key_here"
-
-    require 'rest_client'
-    require 'crack'
-    require 'crack/json'
-
-    attr_reader :data, :image, :images
-
-    def initialize
-      @base = "http://api.edmunds.com/v1/api/vehicle"
-      @api_key = ENV["EDMUNDS_VEHICLE"]
-      @image_base_url = "http://media.ed.edmunds-media.com"
-      @format = "fmt=json&api_key=#{@api_key}"
-    end
-
-    def call_api
-      @base_url = @base + @url + @format
-      @resp = RestClient.get(@base_url)
-      @json = Crack::JSON.parse(@resp)
-    end
-
-  end
-
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edmunds_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-07 00:00:00.000000000 Z
+date: 2013-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -67,46 +67,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/tasks/edmunds_ruby_tasks.rake
-- lib/edmunds_ruby/image_finders.rb
-- lib/edmunds_ruby/model_year_finders.rb
-- lib/edmunds_ruby/version.rb
-- lib/edmunds_ruby/make_finders.rb
-- lib/edmunds_ruby/model_finders.rb
-- lib/edmunds_ruby/style_finders.rb
 - lib/edmunds_ruby.rb
+- lib/edmunds/photo.rb
+- lib/edmunds/model.rb
+- lib/edmunds/version.rb
+- lib/edmunds/model_year.rb
+- lib/edmunds/style.rb
+- lib/edmunds/api.rb
+- lib/edmunds/make.rb
 - MIT-LICENSE
 - Rakefile
-- README.rdoc
-- test/edmunds_ruby_test.rb
-- test/dummy/script/rails
-- test/dummy/README.rdoc
-- test/dummy/public/500.html
-- test/dummy/public/422.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/404.html
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/application.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/boot.rb
-- test/dummy/Rakefile
-- test/dummy/config.ru
-- test/test_helper.rb
+- README.md
 homepage: http://isotope11.com
 licenses: []
 post_install_message: 
@@ -127,38 +98,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Edmunds auto API
-test_files:
-- test/edmunds_ruby_test.rb
-- test/dummy/script/rails
-- test/dummy/README.rdoc
-- test/dummy/public/500.html
-- test/dummy/public/422.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/404.html
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/application.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/boot.rb
-- test/dummy/Rakefile
-- test/dummy/config.ru
-- test/test_helper.rb
+test_files: []

data/README.rdoc

@@ -1,3 +0,0 @@
-= EdmundsRuby
-
-This project rocks and uses MIT-LICENSE.

data/lib/edmunds_ruby/image_finders.rb

@@ -1,29 +0,0 @@
-module EdmundsRuby::ImageFinders
-
-  def get_image(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
-  rescue
-    "http://webmuseum.mit.edu/mobiusicons/no_image.jpg"
-  end
-
-  def get_images(style_id)
-    @url = "photo/service/findphotosbystyleid?styleId=#{style_id}&"
-    call_api
-    @images = []
-    @json.each do |image|
-      if image["photoSrcs"].select{|s| s.match(/\d{3}(.jpg)/) }.present?
-        @images.push(@image_base_url + image["photoSrcs"].select{|s| s.match(/\d{3}(.jpg)/) }.max)
-      end
-    end
-    @images
-  rescue
-    if @images.present?
-      @images
-    else
-      ["http://webmuseum.mit.edu/mobiusicons/no_image.jpg"]
-    end
-  end
-
-end

data/lib/edmunds_ruby/make_finders.rb

@@ -1,53 +0,0 @@
-module EdmundsRuby::MakeFinders
-  # Makes
-  def find_all_makes
-    @url = "/makerepository/findall?"
-    call_api
-  end
-
-  def find_make_by_id(make_id)
-    @url = "/makerepository/findbyid?id=#{make_id}&"
-    call_api
-  end
-
-  def find_future_makes
-    @url = "/makerepository/findfuturemakes?"
-    call_api
-  end
-
-  def find_make_by_name(make_name)
-    @url = "/makerepository/findmakebyname?name=#{make_name}&"
-    call_api
-  end
-
-  def find_makes_by_model_year(model_year)
-    @url = "/makerepository/findmakesbymodelyear?year=#{model_year}&"
-    call_api
-  end
-
-  def find_makes_by_publication_state(condition)
-    # should either be "new" or "used"
-    @url = "/makerepository/findmakesbypublicationstate?state=#{condition}&"
-    call_api
-  end
-
-  def find_new_and_used
-    @url = "/makerepository/findnewandused"
-    call_api
-  end
-
-  def find_new_and_used_makes_by_model_year(year)
-    @url = "/makerepository/findnewandusedmakesbymodelyear?year=#{year}&"
-    call_api
-  end
-
-  def find_new_makes
-    @url = "/makerepository/findnewmakes?"
-    call_api
-  end
-
-  def find_used_makes
-    @url = "/makerepository/findusedmakes?"
-    call_api
-  end
-end

data/lib/edmunds_ruby/model_finders.rb

@@ -1,24 +0,0 @@
-module EdmundsRuby::ModelFinders
-
-  # models
-  def find_model_by_id(model_id)
-    @url = "/modelrepository/findbyid?id=#{model_id}&"
-    call_api
-  end
-
-  def find_models_by_make_id(make_id)
-    @url = "/modelrepository/findbymakeid?makeid=#{make_id}&"
-    call_api
-  end
-
-  def find_new_models_by_make_id(make_id)
-    @url = "/modelrepository/findnewmodelsbymakeid?makeId=#{make_id}&"
-    call_api
-  end
-
-  def find_used_models_by_make_id(make_id)
-    @url = "/modelrepository/findusedmodelsbymakeid?makeId=#{make_id}&"
-    call_api
-  end
-
-end

data/lib/edmunds_ruby/model_year_finders.rb

@@ -1,8 +0,0 @@
-module EdmundsRuby::ModelYearFinders
-
-  def get_model_years_from_model_id(model_id)
-    @url = "/modelyearrepository/formodelid?modelid=#{model_id}&"
-    call_api
-  end
-
-end

data/lib/edmunds_ruby/style_finders.rb

@@ -1,14 +0,0 @@
-module EdmundsRuby::StyleFinders
-
-  # styles
-  def get_model_year_styles(model_year_id)
-    @url = "/stylerepository/findstylesbymodelyearid?modelyearid=#{model_year_id}&"
-    call_api
-  end
-
-  def trim_info(style_id)
-    @url = "/stylerepository/findbyid?id=#{style_id}&"
-    call_api
-  end
-
-end