edmunds_api 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 73f5adc573d2e1f4905104d789f3b7fee710191c
-  data.tar.gz: 7f73428ab7acd594426eb14430105afab4d2d1a8
+SHA256:
+  metadata.gz: b77f91e47eb5a9b5cb8848166eeab73765ebce2b941da060cb59eb7c0c1d58cd
+  data.tar.gz: '00901f5ecd771d640f429c302efd2c5adb1b3dfe78f2baec20df94a4681f4678'
 SHA512:
-  metadata.gz: 085e4d256162462ea33f91226382798ef755a90bf3895e080b54f49c86093a35d60d14344e101b5812c3b4a33b0584d27b8aa5387dfe99cb2733490d314a71a9
-  data.tar.gz: a5b1cff2393aa2d95b571ab54c770ba838672255a047b3cdeb5ca0f76f2be4810504aebd3e4d12f5239afad61d53310d06cc9f1df8d222180c3e6d1745baace8
+  metadata.gz: e344196ce8164c02b9d6068099372785df6bd3502e8ffe6b605f19cbce6be09f2643f575f58c74ac2c39f1100e89a0db0791d21fa57a49f12aa956cd8585a73c
+  data.tar.gz: f08d86280787d2e08136d6d9897c3efff36a67894ae67cd42952a9b5ee929db792f9b4096f6b18ae9221e726b18f30d1067a35e57b48ce760225c1d1d0abf135

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: jiOAN8YTWc1vAphD3slALGYNPhnkJ981n

data/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+on:
+  push:
+    branches: master
+
+env:
+  RACK_ENV: test
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.4, 2.5, 2.6, 2.7, '3.0']
+
+    name: Tests
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run spec
+        run: |
+          bundle exec rspec

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_group 'lib', 'lib'
+end

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in edmunds_api.gemspec
+group :test do
+  gem 'coveralls', require: false
+  gem 'simplecov'
+end
+
 gemspec

data/README.md

@@ -1,3 +1,9 @@
+![Tests](https://github.com/webstreak/edmunds-api-ruby/actions/workflows/ci.yml/badge.svg)
+[![Code Climate](https://codeclimate.com/github/webstreak/edmunds-api-ruby/badges/gpa.svg)](https://codeclimate.com/github/webstreak/edmunds-api-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/webstreak/edmunds-api-ruby/badge.svg)](https://coveralls.io/github/webstreak/edmunds-api-ruby)
+[![Gem Version](https://badge.fury.io/rb/edmunds_api.svg)](https://badge.fury.io/rb/edmunds_api)
+[![RubyGems](http://img.shields.io/gem/dt/edmunds_api.svg?style=flat)](http://rubygems.org/gems/edmunds_api)
+
 Edmunds Api ruby client.
 
 > *Status*: Beta. We are preparing the project for public release soon
@@ -7,7 +13,7 @@ Edmunds Api ruby client.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'edmunds_api', '~> 0.1.3'
+gem 'edmunds_api', '~> 0.1.8'
 ```
 
 And then execute:
@@ -24,6 +30,7 @@ Add api_key in initializer:
 ```ruby
   Edmunds.configure do |config|
     config.api_key = 'your-api-key'
+    config.timeout = 5
   end
 ```
 Basic usage:
@@ -36,6 +43,10 @@ You can also pass options to an Api endpoint:
 vehicles_api = Edmunds::Api.new.vehicles
 vehicles_api.make('Lexus', {state: 'new'})
 ```
+See supported options for each Api endpoint on [Edmunds website](http://developer.edmunds.com/api-documentation/overview/)  
+
+## Supported endpoints
+[Endpoints](endpoints.md)
 
 ## Contributing
 

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "edmunds-api-ruby"
+require "edmunds_api"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/edmunds_api.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'http', '~> 2.0'
   spec.add_dependency 'configurations', '~> 2.2'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 11.3'
+  spec.add_development_dependency 'bundler', '> 1'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'webmock', '~> 2.1'
 end

data/endpoints.md

@@ -0,0 +1,116 @@
+## Vehicle API
+
+### Makes
+[Makes EdmundsApi docs](http://developer.edmunds.com/api-documentation/vehicle/spec_make/v2/)  
+
+| Endpoint  | Description |
+|-----------|-------------|
+| `Edmunds::Api.new.vehicles.makes.count(options)` | Total Count of Car Makes |
+| `Edmunds::Api.new.vehicles.makes.all_makes(options)` | A List of Car Makes |
+| `Edmunds::Api.new.vehicles.makes.make("Make", options)` | Details on a Specific Car Make |
+
+### Models
+[Models EdmundsApi docs](http://developer.edmunds.com/api-documentation/vehicle/spec_model/v2/)  
+
+| Endpoint  | Description |
+|-----------|-------------|
+| `Edmunds::Api.new.vehicles.models.count("Make", options)` | Total Count of Models for a Car Make |
+| `Edmunds::Api.new.vehicles.models.models("Make", options)` | Get a List of Car Models for a Specific Car Make |
+| `Edmunds::Api.new.vehicles.models.model("Make", "Model", options)` | Get Details on a Specific Car Model |
+
+### Styles
+[Styles EdmundsApi docs](http://developer.edmunds.com/api-documentation/vehicle/spec_style/v2/)  
+
+| Endpoint  | Description |
+|-----------|-------------|
+| `Edmunds::Api.new.vehicles.styles.count(options)` | Styles Count |
+| `Edmunds::Api.new.vehicles.styles.make_count("Make", options)` | Style Count by Car Make |
+| `Edmunds::Api.new.vehicles.styles.make_model_count("Make", "Model", options)` | Style Count by Car Make and Model |
+| `Edmunds::Api.new.vehicles.styles.make_model_year_count("Make", "Model", "Year", options)` | Style Count by Car Make/Model/Year |
+| `Edmunds::Api.new.vehicles.styles.id(style_id, options)` | Car Style Details by Car Style ID |
+| `Edmunds::Api.new.vehicles.styles.make_model_year("Make", "Model", "Year", options)` | Car Style Details by Car Make/Model/Year |
+| `Edmunds::Api.new.vehicles.styles.chrome_data(chrome_id, options)` | Car Style Details by Car Chrome Data ID |
+
+### Engines
+[Engines EdmundsApi docs](http://developer.edmunds.com/api-documentation/vehicle/spec_engine_and_transmission/v2/)  
+
+| Endpoint  | Description |
+|-----------|-------------|
+| `Edmunds::Api.new.vehicles.engines.details(engine_id)` | Engine Details by ID |
+| `Edmunds::Api.new.vehicles.engines.by_style_id(style_id, options)` | Engines for a Car Style |
+
+### Transmissions
+[Transmissions EdmundsApi docs](http://developer.edmunds.com/api-documentation/vehicle/spec_engine_and_transmission/v2/)  
+
+| Endpoint  | Description |
+|-----------|-------------|
+| `Edmunds::Api.new.vehicles.transmissions.details(transmission_id)` | Transmission Details by ID |
+| `Edmunds::Api.new.vehicles.transmissions.by_style_id(style_id, options)` | Transmissions for a Car Style |
+
+### Colors
+[Colors EdmundsApi docs](http://developer.edmunds.com/api-documentation/vehicle/spec_colors_and_options/v2/)  
+
+| Endpoint  | Description |
+|-----------|-------------|
+| `Edmunds::Api.new.vehicles.colors.details(color_id)` | Color Details by ID |
+| `Edmunds::Api.new.vehicles.colors.by_style_id(style_id, options)` | Colors for a Car Style |
+
+### Options
+[Options EdmundsApi docs](http://developer.edmunds.com/api-documentation/vehicle/spec_colors_and_options/v2/)  
+
+| Endpoint  | Description |
+|-----------|-------------|
+| `Edmunds::Api.new.vehicles.options.details(option_id)` | Option Details by ID |
+| `Edmunds::Api.new.vehicles.options.by_style_id(style_id, options)` | Options for a Car Style |
+
+### Equipment
+[Equipment EdmundsApi docs](http://developer.edmunds.com/api-documentation/vehicle/spec_equipment/v2/)  
+
+| Endpoint  | Description |
+|-----------|-------------|
+| `Edmunds::Api.new.vehicles.equipment.details(equipment_id)` | Equipment Details by ID |
+| `Edmunds::Api.new.vehicles.equipment.by_style_id(style_id, options)` | Equipment for a Car Style |
+
+### Squish vin
+[Squish vin EdmundsApi docs](http://developer.edmunds.com/api-documentation/vehicle/spec_squishvin/v2/)  
+
+| Endpoint  | Description |
+|-----------|-------------|
+| `Edmunds::Api.new.vehicles.squishvins.decode(VIN)` | Vehicle Details by Squish VIN |
+
+### VIN Decoding
+[VIN decoding EdmundsApi docs](http://developer.edmunds.com/api-documentation/vehicle/spec_vin_decoding/v2/)  
+
+| Endpoint  | Description |
+|-----------|-------------|
+| `Edmunds::Api.new.vehicles.vin.decode(VIN, options)` | Vehicle Details by VIN |
+
+### Safety
+[Safety EdmundsApi docs](http://developer.edmunds.com/api-documentation/vehicle/service_safety/v2/)  
+
+| Endpoint  | Description |
+|-----------|-------------|
+| `Edmunds::Api.new.vehicles.safety.ratings(style_id)` | Safety ratings by Style ID |
+| `Edmunds::Api.new.vehicles.safety.ratings("Make", "Model", "Year")` | Safety ratings by Make/Model/Year |
+
+### Letter Grade Rating
+[Grades rating EdmundsApi docs](http://developer.edmunds.com/api-documentation/vehicle/content_letter_grade/v2/)  
+
+| Endpoint  | Description |
+|-----------|-------------|
+| `Edmunds::Api.new.vehicles.grades.by_style_id(style_id)` | Rating Details by Style ID |
+| `Edmunds::Api.new.vehicles.grades.details("Make", "Model", "Year")` | All Rating Details Reviews by Make/Model/Year |
+| `Edmunds::Api.new.vehicles.grades.rating("Make", "Model", "Year")` | Letter Grade Rating by Make/Model/Year |
+| `Edmunds::Api.new.vehicles.grades.by_review_id("Make", "Model", "Year", review_id)` | Rating Details by Make/Model/Year and Review ID |
+
+## Media API
+
+### Photos
+[Photos EdmundsApi docs](http://developer.edmunds.com/api-documentation/media/photos/v2/)  
+
+| Endpoint  | Description |
+|-----------|-------------|
+| `Edmunds::Api.new.media.photos.by_year_make_model("Year", "Make", "Model", options)` | Find photos by Make/Model/Year |
+| `Edmunds::Api.new.media.photos.by_tag(tag, options)` | Find photos by Tag |
+| `Edmunds::Api.new.media.photos.by_style_id(style_id, options)` | Find photos by Style ID |
+| `Edmunds::Api.new.media.photos.by_make_model("Make", "Model", options)` | Find photos by Make/Model |

data/lib/edmunds/request.rb

@@ -1,23 +1,32 @@
+require 'timeout'
+
 module Edmunds
   module Request
 
     API_URL = 'https://api.edmunds.com/api'
+    API_VERSION = Edmunds.configuration.api_version.to_s
+    DEFAULT_TIMEOUT = 15
 
     def api_call(api_path, path, options={})
       url = build_api_url api_path, path
       request_params = merge_required_params options
-      response = HTTP.headers(http_headers).get(url, params: request_params)
+      raise 'No api_key found' if request_params[:api_key].empty?
+      response = Timeout::timeout(timeout) {
+        HTTP.headers(http_headers).get(url, params: request_params)
+      }
       parse_response response
     end
 
+    private
+
     def build_api_url(api_path, path)
-      api_version = 'v' + Edmunds.configuration.api_version.to_s
+      api_version = 'v' + API_VERSION
       API_URL + '/' + api_path + '/' + api_version + path
     end
 
     def merge_required_params(options)
       {
-        api_key: Edmunds.configuration.api_key,
+        api_key: Edmunds.configuration.api_key.to_s.strip,
         fmt: Edmunds.configuration.request_params.fmt
       }.merge(options)
     end
@@ -29,6 +38,10 @@ module Edmunds
       }
     end
 
+    def timeout
+      Edmunds.configuration.timeout || DEFAULT_TIMEOUT
+    end
+
     def parse_response(response)
       begin
         body = JSON.parse response.body

data/lib/edmunds/vehicle/models.rb

@@ -6,7 +6,7 @@ module Edmunds
         send_request "/#{make}/models/count", options
       end
 
-      def models(make, options={})
+      def all_models(make, options={})
         send_request "/#{make}/models", options
       end
 

data/lib/edmunds/version.rb

@@ -1,3 +1,3 @@
 module Edmunds
-  VERSION = '0.1.3'
+  VERSION = '0.1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: edmunds_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Alexander Belyaev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-29 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -42,30 +42,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -101,8 +101,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
+- ".simplecov"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -110,6 +113,7 @@ files:
 - bin/console
 - bin/setup
 - edmunds_api.gemspec
+- endpoints.md
 - lib/edmunds/api.rb
 - lib/edmunds/configuration.rb
 - lib/edmunds/error.rb
@@ -135,7 +139,7 @@ homepage: https://github.com/webstreak/edmunds-api-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,9 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Edmunds Api ruby client
 test_files: []