edmunds 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 917937e5e9df9c64fb0706dbb87c72f8d0ef8c18
-  data.tar.gz: 8fbb2d8f8d64f41b847cbe8f139cf22b814b0a47
+  metadata.gz: 1344f0bd011e7414e7e8d61633f8d6e4138244b6
+  data.tar.gz: 99f01d3fa5e0ec85c904c1a1ed76e600e337224b
 SHA512:
-  metadata.gz: 4065f0b0cbc1c39b37a4dc6e8e3d984bff0f4731796ffdf92ca83eec83a85c1928fc001ed643d1aae38747884793b5e78dd49f40576ba27cd8b1deabdf648692
-  data.tar.gz: d9b2fcfe8e45cd6b2ceb447763b76b8e0984b0eddfd557bd8342bde244d689a6feccc9a5f9a2af5baff1678e143f9b4b6bd076ee980a6ed51a32961a57bc28e9
+  metadata.gz: 5b77c3fa390cdb4792ee925d23102cf95189ebd88b8f416699ab1a7a46d8a7dbc32f624d185dbde28cfc79f8bfaefa02db28324c91c210478a7ddf953cb98542
+  data.tar.gz: 59ab4ce5eeea4c4c2f4d85f62167e4c2ae93531ab14ccb80bd9ebb4e8d8cd73d5a21320d312848f26200abcae8578fe66e640fcf04f0ca332edfc252c3fc9ef0

data/README.md

@@ -16,13 +16,21 @@ export EDMUNDS_API_KEY=<api_key>
 ```
 
 ## Usage
+The module naming scheme of this gem is inline with how the API is documented.
 ```ruby
 require 'edmunds'
 => true
 result = Edmunds::Vehicle::Specification::VinDecoding::Basic.find("JHMAP11461T005905")
 => #<Edmunds::Vehicle::Specification::VinDecoding::Basic:0x007faa2a0e4e40 @make="Honda", @model="S2000", @year=2001>
+result = Edmunds::Vehicle::Specification::Style::StylesDetails.find("honda", "s2000", 2001)
+ => #<Edmunds::Vehicle::Specification::Style::StylesDetails:0x007fbc719fd028 @count=1, @styles=[#<Edmunds::Vehicle::Specification::Style::Style:0x007fbc719fcf88 @id=100001280, @name="2dr Roadster (2.0L 4cyl 6M)", @trim="Base", @body="Convertible">]> 
 
 ```
+
+## Contributors
+Feel free to fork this repository and open a pull request. 
+If you have any questions you can open an issue or contact me directly [here](https://twitter.com/Sovietaced).
+
 ## License
 
 Please see LICENSE at the top level of the repository.

data/lib/edmunds.rb

@@ -1,13 +1,13 @@
-require_relative "edmunds/version"
-require_relative "edmunds/api"
-require_relative "edmunds/vehicle"
-require_relative "edmunds/vehicle/specification/make"
-require_relative "edmunds/vehicle/specification/model"
-require_relative "edmunds/vehicle/specification/model_year"
-require_relative "edmunds/vehicle/specification/style"
-require_relative "edmunds/vehicle/specification/vin_decoding"
+require_relative 'edmunds/version'
+require_relative 'edmunds/api'
+require_relative 'edmunds/vehicle'
+require_relative 'edmunds/vehicle/specification/make'
+require_relative 'edmunds/vehicle/specification/model'
+require_relative 'edmunds/vehicle/specification/model_year'
+require_relative 'edmunds/vehicle/specification/style'
+require_relative 'edmunds/vehicle/specification/color'
+require_relative 'edmunds/vehicle/specification/option'
+require_relative 'edmunds/vehicle/specification/vin_decoding'
 
 module Edmunds
-
 end
-

data/lib/edmunds/api.rb

@@ -1,15 +1,29 @@
 module Edmunds
   module Api
-
-    URL = "https://api.edmunds.com/api"
+    URL = 'https://api.edmunds.com/api'
     URL_V1 = "#{URL}/v1"
 
     # Wrapper around Faraday.get that passses the API key
     def self.get(url, api_params = {})
       api_key_hash = { api_key: ENV['EDMUNDS_API_KEY'] }
       api_params = api_params.merge(api_key_hash)
-      Faraday.get(url, api_params)
+      response = Faraday.get(url, api_params)
+
+      if not response.success?
+        raise Exception.new(response)
+      end
+
+      return response
     end
 
+    class Exception < StandardError
+      attr_reader :error_type, :message
+      def initialize(response)
+        error = JSON.parse(response.body)
+
+        @error_type = error['error']['errorType']
+        @message = error['error']['message']
+      end
+    end
   end
-end
+end

data/lib/edmunds/vehicle.rb

@@ -2,7 +2,7 @@ require 'edmunds'
 
 module Edmunds
   module Vehicle
-    API_URL_V1 = Edmunds::Api::URL_V1 + "/vehicle"
-    API_URL_V2 = Edmunds::Api::URL + "/vehicle/v2"
+    API_URL_V1 = Edmunds::Api::URL_V1 + '/vehicle'
+    API_URL_V2 = Edmunds::Api::URL + '/vehicle/v2'
   end
-end
+end

data/lib/edmunds/vehicle/specification/color.rb

@@ -0,0 +1,59 @@
+require 'faraday'
+require 'json'
+
+STYLE_API_URL = Edmunds::Vehicle::API_URL_V2 + '/styles'
+COLORS_API_URL = Edmunds::Vehicle::API_URL_V2 + '/colors'
+
+module Edmunds
+  module Vehicle
+    module Specification
+      module Color
+        
+        class ColorsByStyle
+          attr_reader :colors, :count
+
+          def initialize(attributes)
+            @colors = attributes['colors'].map { |json| ColorsDetails.new(json) } if attributes.key?('colors')
+            @count = attributes['colorsCount']
+          end
+
+          def self.find(style_id, api_params = {})
+            response = Edmunds::Api.get("#{STYLE_API_URL}/#{style_id}/colors", api_params)
+            attributes = JSON.parse(response.body)
+            new(attributes)
+          end
+        end
+
+        class ColorsDetails
+          attr_reader :id, 
+                      :name, 
+                      :equipment_type, 
+                      :availability, 
+                      :manufacture_option_name, 
+                      :manufacture_option_code, 
+                      :category, 
+                      :attributes, #not implemented
+                      :color_chips, #not_implemented
+                      :fabric_Types #not implemented
+
+          def initialize(attributes)
+            @id = attributes['id']
+            @name = attributes['name']
+            @equipment_type = attributes['equipmentType']
+            @availability = attributes['availability']
+            @manufacture_option_name = attributes['manufactureOptionName']
+            @manufacture_option_code = attributes['manufactureOptionCode']
+            @category = attributes['category']
+          end
+
+          def self.find(color_id, api_params = {})
+            response = Edmunds::Api.get("#{COLORS_API_URL}/#{color_id}", api_params)
+            attributes = JSON.parse(response.body)
+            new(attributes)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/edmunds/vehicle/specification/make.rb

@@ -2,19 +2,18 @@ require 'faraday'
 require 'json'
 
 MAKE_API_URL = Edmunds::Vehicle::API_URL_V2
-MAKES_API_URL = MAKE_API_URL + "/makes"
-MAKES_COUNT_API_URL = MAKES_API_URL + "/count"
+MAKES_API_URL = MAKE_API_URL + '/makes'
+MAKES_COUNT_API_URL = MAKES_API_URL + '/count'
 
 module Edmunds
   module Vehicle
     module Specification
       module Make
-
         class Makes
           attr_reader :makes
 
           def initialize(attributes)
-           @makes = attributes["makes"].map {|json| Make.new(json)} if attributes.key?("makes")
+            @makes = attributes['makes'].map { |json| Make.new(json) } if attributes.key?('makes')
           end
 
           def self.find(api_params = {})
@@ -28,9 +27,9 @@ module Edmunds
           attr_reader :id, :name, :models
 
           def initialize(attributes)
-            @id = attributes["id"]
-            @name = attributes["name"]
-            @models = attributes["models"].map {|json| Edmunds::Vehicle::Specification::Model::Model.new(json)} if attributes.key?("models")
+            @id = attributes['id']
+            @name = attributes['name']
+            @models = attributes['models'].map { |json| Edmunds::Vehicle::Specification::Model::Model.new(json) } if attributes.key?('models')
           end
 
           def self.find(name, api_params = {})
@@ -44,7 +43,7 @@ module Edmunds
           attr_reader :count
 
           def initialize(attributes)
-            @count = attributes["makesCount"]
+            @count = attributes['makesCount']
           end
 
           def self.find(api_params = {})
@@ -53,7 +52,6 @@ module Edmunds
             new(attributes)
           end
         end
-
       end
     end
   end

data/lib/edmunds/vehicle/specification/model.rb

@@ -7,14 +7,13 @@ module Edmunds
   module Vehicle
     module Specification
       module Model
-
         class Model
           attr_reader :id, :name, :years
 
           def initialize(attributes)
-            @id = attributes["id"]
-            @name = attributes["name"]
-            @years = attributes["years"].map {|json| Edmunds::Vehicle::Specification::ModelYear::ModelYear.new(json)} if attributes.key?("years")
+            @id = attributes['id']
+            @name = attributes['name']
+            @years = attributes['years'].map { |json| Edmunds::Vehicle::Specification::ModelYear::ModelYear.new(json) } if attributes.key?('years')
           end
 
           def self.find(make_name, model_name, api_params = {})
@@ -28,8 +27,8 @@ module Edmunds
           attr_reader :models, :count
 
           def initialize(attributes)
-            @count = attributes["modelsCount"]
-            @models = attributes["models"].map {|json| Model.new(json)} if attributes.key?("models")
+            @count = attributes['modelsCount']
+            @models = attributes['models'].map { |json| Model.new(json) } if attributes.key?('models')
           end
 
           def self.find(make_name, api_params = {})
@@ -43,7 +42,7 @@ module Edmunds
           attr_reader :count
 
           def initialize(attributes)
-            @count = attributes["modelsCount"]
+            @count = attributes['modelsCount']
           end
 
           def self.find(make_name, api_params = {})
@@ -52,7 +51,6 @@ module Edmunds
             new(attributes)
           end
         end
-
       end
     end
   end

data/lib/edmunds/vehicle/specification/model_year.rb

@@ -7,14 +7,13 @@ module Edmunds
   module Vehicle
     module Specification
       module ModelYear
-
         class ModelYear
           attr_reader :id, :year, :styles
 
-          def initialize(attributes)  
-            @id = attributes["id"]
-            @year = attributes["year"]
-            @styles = attributes["styles"].map {|json| Edmunds::Vehicle::Specification::Style::Style.new(json)} if attributes.key?("styles")
+          def initialize(attributes)
+            @id = attributes['id']
+            @year = attributes['year']
+            @styles = attributes['styles'].map { |json| Edmunds::Vehicle::Specification::Style::Style.new(json) } if attributes.key?('styles')
           end
 
           def self.find(make_name, model_name, model_year, api_params = {})
@@ -27,9 +26,9 @@ module Edmunds
         class ModelYears
           attr_reader :model_years, :count
 
-          def initialize(attributes)  
-            @count = attributes["yearsCount"]
-            @model_years = attributes["years"].map {|json| ModelYear.new(json)} if attributes.key?("years")
+          def initialize(attributes)
+            @count = attributes['yearsCount']
+            @model_years = attributes['years'].map { |json| ModelYear.new(json) } if attributes.key?('years')
           end
 
           def self.find(make_name, model_name, api_params = {})
@@ -42,8 +41,8 @@ module Edmunds
         class ModelYearsCount
           attr_reader :count
 
-          def initialize(attributes)  
-            @count = attributes["yearsCount"]
+          def initialize(attributes)
+            @count = attributes['yearsCount']
           end
 
           def self.find(make_name, model_name, api_params = {})
@@ -52,7 +51,6 @@ module Edmunds
             new(attributes)
           end
         end
-
       end
     end
   end

data/lib/edmunds/vehicle/specification/option.rb

@@ -0,0 +1,64 @@
+require 'faraday'
+require 'json'
+
+STYLE_API_URL = Edmunds::Vehicle::API_URL_V2 + '/styles'
+OPTIONS_API_URL = Edmunds::Vehicle::API_URL_V2 + '/options'
+
+module Edmunds
+  module Vehicle
+    module Specification
+      module Option
+        
+        class OptionsByStyle
+          attr_reader :options, 
+                      :count
+
+          def initialize(attributes)
+            @options = attributes['options'].map { |json| Option.new(json) } if attributes.key?('options')
+            @count = attributes['optionsCount']
+          end
+
+          def self.find(style_id, api_params = {})
+            response = Edmunds::Api.get("#{STYLE_API_URL}/#{style_id}/options", api_params)
+            attributes = JSON.parse(response.body)
+            new(attributes)
+          end
+        end
+
+        class Option
+          attr_reader :id, 
+                      :name,
+                      :description,
+                      :equipment_type, 
+                      :availability,
+                      :manufacture_option_name,
+                      :manufacture_option_code,
+                      :category, 
+                      :attributes,
+                      :equipment #not implemented
+                      #TODO: The rest with pricing
+
+          def initialize(attributes)
+            @id = attributes['id']
+            @name = attributes['name']
+            @description = attributes['description']
+            @equipment_type = attributes['equipmentType']
+            @availability = attributes['availability']
+            @manufacture_option_name = attributes['manufactureOptionName']
+            @manufacture_option_code = attributes['manufactureOptionCode']
+            @category = attributes['category']
+            @attributes = attributes['attributes']
+            @equipment = attributes['equipment']
+          end
+
+          def self.find(option_id, api_params = {})
+            response = Edmunds::Api.get("#{OPTIONS_API_URL}/#{option_id}", api_params)
+            attributes = JSON.parse(response.body)
+            new(attributes)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/edmunds/vehicle/specification/style.rb

@@ -1,22 +1,21 @@
 require 'faraday'
 require 'json'
 
-STYLE_API_URL = Edmunds::Vehicle::API_URL_V2 + "/styles"
+STYLE_API_URL = Edmunds::Vehicle::API_URL_V2 + '/styles'
 BASE_API_URL = Edmunds::Vehicle::API_URL_V2
 
 module Edmunds
   module Vehicle
     module Specification
       module Style
-
         class Style
           attr_reader :id, :name, :trim, :body, :year, :make_name, :model_name
 
           def initialize(attributes)
-            @id = attributes["id"]
-            @name = attributes["name"]
-            @trim = attributes["trim"]
-            @body = attributes["submodel"]["body"]
+            @id = attributes['id']
+            @name = attributes['name']
+            @trim = attributes['trim']
+            @body = attributes['submodel']['body']
             # TODO: Not sure whether this is valuable or not to expose...
             # @year = attributes["year"]["year"]
             # @make_name = attributes["make"]["name"]
@@ -34,8 +33,8 @@ module Edmunds
           attr_reader :styles, :count
 
           def initialize(attributes)
-            @count = attributes["stylesCount"]
-            @styles = attributes["styles"].map {|json| Style.new(json)} if attributes.key?("styles")
+            @count = attributes['stylesCount']
+            @styles = attributes['styles'].map { |json| Style.new(json) } if attributes.key?('styles')
           end
 
           def self.find(make_name, model_name, model_year, api_params = {})
@@ -65,7 +64,7 @@ module Edmunds
           attr_reader :count
 
           def initialize(attributes)
-            @count = attributes["stylesCount"]
+            @count = attributes['stylesCount']
           end
 
           def self.find(make_name, model_name, model_year, api_params = {})
@@ -79,7 +78,7 @@ module Edmunds
           attr_reader :count
 
           def initialize(attributes)
-            @count = attributes["stylesCount"]
+            @count = attributes['stylesCount']
           end
 
           def self.find(make_name, model_name, api_params = {})
@@ -93,7 +92,7 @@ module Edmunds
           attr_reader :count
 
           def initialize(attributes)
-            @count = attributes["stylesCount"]
+            @count = attributes['stylesCount']
           end
 
           def self.find(make_name, api_params = {})
@@ -107,7 +106,7 @@ module Edmunds
           attr_reader :count
 
           def initialize(attributes)
-            @count = attributes["stylesCount"]
+            @count = attributes['stylesCount']
           end
 
           def self.find(api_params = {})
@@ -116,7 +115,6 @@ module Edmunds
             new(attributes)
           end
         end
-
       end
     end
   end

data/lib/edmunds/vehicle/specification/vin_decoding.rb

@@ -1,21 +1,20 @@
 require 'faraday'
 require 'json'
 
-BASIC_API_URL = Edmunds::Vehicle::API_URL_V1 + "/vin"
-FULL_API_URL = Edmunds::Vehicle::API_URL_V2 + "/vins"
+BASIC_API_URL = Edmunds::Vehicle::API_URL_V1 + '/vin'
+FULL_API_URL = Edmunds::Vehicle::API_URL_V2 + '/vins'
 
 module Edmunds
   module Vehicle
     module Specification
       module VinDecoding
-
         class Basic
           attr_reader :make, :model, :year
 
           def initialize(attributes)
-            @make = attributes["make"]["name"]
-            @model = attributes["model"]["name"]
-            @year = attributes["year"]
+            @make = attributes['make']['name']
+            @model = attributes['model']['name']
+            @year = attributes['year']
           end
 
           # Get vehicle make, model, year, type, fuel type, number of cylinders and list of styles by decoding the vehicle's VIN.
@@ -33,11 +32,11 @@ module Edmunds
           attr_reader :make, :model, :years, :mpg_highway, :mpg_city
 
           def initialize(attributes)
-            @make = Edmunds::Vehicle::Specification::Make::Make.new(attributes["make"])
-            @model = Edmunds::Vehicle::Specification::Model::Model.new(attributes["model"])
-            @years = attributes["years"].map {|json| Edmunds::Vehicle::Specification::ModelYear::ModelYear.new(json)} if attributes.key?("years")
-            @mpg_highway = attributes["MPG"]["highway"]
-            @mpg_city = attributes["MPG"]["city"]
+            @make = Edmunds::Vehicle::Specification::Make::Make.new(attributes['make'])
+            @model = Edmunds::Vehicle::Specification::Model::Model.new(attributes['model'])
+            @years = attributes['years'].map { |json| Edmunds::Vehicle::Specification::ModelYear::ModelYear.new(json) } if attributes.key?('years')
+            @mpg_highway = attributes['MPG']['highway']
+            @mpg_city = attributes['MPG']['city']
           end
 
           # Get all vehicle details from make, model, year and fuel type to list of options, features and standard equipment. All this information is returned by decoding the vehicle's VIN.
@@ -50,7 +49,6 @@ module Edmunds
             new(attributes)
           end
         end
-
       end
     end
   end

data/lib/edmunds/version.rb

@@ -1,3 +1,3 @@
 module Edmunds
-  VERSION = "0.0.4"
+  VERSION = '0.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: edmunds
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jason Parraga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-04 00:00:00.000000000 Z
+date: 2015-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,9 +133,11 @@ files:
 - lib/edmunds.rb
 - lib/edmunds/api.rb
 - lib/edmunds/vehicle.rb
+- lib/edmunds/vehicle/specification/color.rb
 - lib/edmunds/vehicle/specification/make.rb
 - lib/edmunds/vehicle/specification/model.rb
 - lib/edmunds/vehicle/specification/model_year.rb
+- lib/edmunds/vehicle/specification/option.rb
 - lib/edmunds/vehicle/specification/style.rb
 - lib/edmunds/vehicle/specification/vin_decoding.rb
 - lib/edmunds/version.rb