edmunds 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 481d130e3e474aae238c7dbfd8bc62ac6bd5510d
-  data.tar.gz: 7b17fb30d33fdf209fcb1186225e3207eb14cd77
+  metadata.gz: 5d74986e9b762968e63e37e2aaa81e6e3f4e7884
+  data.tar.gz: 2d4103061e4fa38c5c2caf2c073dc06202059e26
 SHA512:
-  metadata.gz: 9b33cbec6f69aefcb344037441d6974883124d549a9134988c1eb08762ea5b0576b993b4721da8433f9ab8326d30e4c828ec470a7313977db8528293e6c6290b
-  data.tar.gz: 4d9bb098ac68dcd54a16df24c270142b2363123f4ecf714e72ddaee1c328c225bdf80b7b279dc2092fbf871a36d93681ae5b7f0597717b2de8439e99cfc06cba
+  metadata.gz: 69bca0aee1e1c38fc5141c24f0290b1c6acab897381305fc4072bcfb97e146474c05efb33913e99263f5b3ca3f4b59daaa75eb399c78f82e6d6d720c6a3afad1
+  data.tar.gz: 185beb70694a9a93cb852340a4336e0d9c26faa6511cb67a512fbbe6ba94d75fc6f06abb327e0b915eff2dc9fd297cf7306dad264f553b4ba7420934983b64bc

data/README.md

@@ -1,6 +1,10 @@
-# edmunds
+# edmunds 
 Edmunds.com Ruby API Wrapper 
 
+[![Codeship Status for sovietaced/edmunds](https://codeship.io/projects/d03c61a0-a2bc-0132-516c-0e0102967270/status)](https://codeship.io/projects/65819)
+[![Code Climate](https://codeclimate.com/github/Sovietaced/edmunds/badges/gpa.svg)](https://codeclimate.com/github/Sovietaced/edmunds)
+[![Coverage Status](https://coveralls.io/repos/Sovietaced/edmunds/badge.svg?branch=master)](https://coveralls.io/r/Sovietaced/edmunds?branch=master)
+[![Gem Version](https://badge.fury.io/rb/edmunds.svg)](http://badge.fury.io/rb/edmunds)
 ## Installation
 Install the gem
 ```bash
@@ -12,7 +16,6 @@ export EDMUNDS_API_KEY=<api_key>
 ```
 
 ## Usage
-
 ```ruby
 require 'edmunds'
 => true
@@ -20,7 +23,6 @@ result = Edmunds::Vehicle::Specification::VinDecoding::Basic.find("JHMAP11461T00
 => #<Edmunds::Vehicle::Specification::VinDecoding::Basic:0x007faa2a0e4e40 @make="Honda", @model="S2000", @year=2001>
 
 ```
-
 ## License
 
 Please see LICENSE at the top level of the repository.

data/lib/edmunds.rb

@@ -1,8 +1,13 @@
-module Edmunds
-  API_URL_V1 = "https://api.edmunds.com/api/v1"
-  API_URL_V2 = "https://api.edmunds.com/api/v2"
-end
-
 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"
+
+module Edmunds
+
+end
+

data/lib/edmunds/api.rb

@@ -0,0 +1,15 @@
+module Edmunds
+  module 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)
+    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_V2 + "/vehicle"
+    API_URL_V1 = Edmunds::Api::URL_V1 + "/vehicle"
+    API_URL_V2 = Edmunds::Api::URL + "/vehicle/v2"
   end
 end

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

@@ -0,0 +1,60 @@
+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"
+
+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")
+          end
+
+          def self.find(api_params = {})
+            response = Edmunds::Api.get("#{MAKES_API_URL}", api_params)
+            attributes = JSON.parse(response.body)
+            new(attributes)
+          end
+        end
+
+        class Make
+          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")
+          end
+
+          def self.find(name, api_params = {})
+            response = Edmunds::Api.get("#{MAKE_API_URL}/#{name}", api_params)
+            attributes = JSON.parse(response.body)
+            new(attributes)
+          end
+        end
+
+        class MakesCount
+          attr_reader :count
+
+          def initialize(attributes)
+            @count = attributes["makesCount"]
+          end
+
+          def self.find(api_params = {})
+            response = Edmunds::Api.get("#{MAKES_COUNT_API_URL}", api_params)
+            attributes = JSON.parse(response.body)
+            new(attributes)
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'faraday'
+require 'json'
+
+MODEL_API_URL = Edmunds::Vehicle::API_URL_V2
+
+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")
+          end
+
+          def self.find(make_name, model_name, api_params = {})
+            response = Edmunds::Api.get("#{MODEL_API_URL}/#{make_name}/#{model_name}", api_params)
+            attributes = JSON.parse(response.body)
+            new(attributes)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'json'
+
+MODEL_YEAR_API_URL = Edmunds::Vehicle::API_URL_V2
+
+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")
+          end
+
+          def self.find(make_name, model_name, model_year, api_params = {})
+            response = Edmunds::Api.get("#{MODEL_API_URL}/#{make_name}/#{model_name}/#{model_year}", api_params)
+            attributes = JSON.parse(response.body)
+            new(attributes)
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'faraday'
+require 'json'
+
+STYLE_API_URL = Edmunds::Vehicle::API_URL_V2 + "/styles"
+
+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"]
+            # TODO: Not sure whether this is valuable or not to expose...
+            # @year = attributes["year"]["year"]
+            # @make_name = attributes["make"]["name"]
+            # @model_name = attributes["model"]["name"]
+          end
+
+          def self.find(id, api_params = {})
+            response = Edmunds::Api.get("#{STYLE_API_URL}/#{id}", api_params)
+            attributes = JSON.parse(response.body)
+            new(attributes)
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,12 +1,14 @@
 require 'faraday'
 require 'json'
 
-API_URL = Edmunds::Vehicle::API_URL_V1 + "/vin/"
+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
 
@@ -16,12 +18,39 @@ module Edmunds
             @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.
+          #
+          # @param [String] vin number of the vehicle to search for
+          # @return [Basic] object holding the results of the query
+          def self.find(vin)
+            response = Edmunds::Api.get("#{BASIC_API_URL}/#{vin}/configuration")
+            attributes = JSON.parse(response.body)
+            new(attributes)
+          end
+        end
+
+        class Full
+          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"]
+          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.
+          #
+          # @param [String] vin number of the vehicle to search for
+          # @return [Basic] object holding the results of the query
           def self.find(vin)
-            response = Faraday.get("#{API_URL}/#{vin}/configuration", { api_key: ENV['EDMUNDS_API_KEY'] })
+            response = Edmunds::Api.get("#{FULL_API_URL}/#{vin}")
             attributes = JSON.parse(response.body)
             new(attributes)
           end
         end
+
       end
     end
   end

data/lib/edmunds/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edmunds
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jason Parraga
@@ -131,7 +131,12 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/edmunds.rb
+- lib/edmunds/api.rb
 - lib/edmunds/vehicle.rb
+- lib/edmunds/vehicle/specification/make.rb
+- lib/edmunds/vehicle/specification/model.rb
+- lib/edmunds/vehicle/specification/model_year.rb
+- lib/edmunds/vehicle/specification/style.rb
 - lib/edmunds/vehicle/specification/vin_decoding.rb
 - lib/edmunds/version.rb
 homepage: ''