edmunds_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38ef22ebe088587aae7b6b5dfd427a35856d0635
+  data.tar.gz: 798d1baabef4bac00aa4008dc300e37653f455cf
+SHA512:
+  metadata.gz: 668cfd88b25687e1c89797df93841c1cab3cc0d1c223a8ffc07e28df97fc3373b28c4a94c19a71261d035155ff4851919cf86f8a1b7228449fc7d959709f8039
+  data.tar.gz: 7265458a80f33fab16838995e316db007e092d4124e3861ea22ceb6b4e35631a32464b16130d7304c5428517e4b0b2b830950a527a21cb9a7c7d31388e6b410d

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+tags

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in edmunds_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Webstreak LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+Edmunds Api ruby client.
+
+> *Status*: Beta. We are preparing the project for public release soon
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'edmunds-api-ruby', '~> 0.1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install edmunds-api-ruby
+
+## Usage
+Add api_key in initializer:
+
+```ruby
+  Edmunds.configure do |config|
+    config.api_key = 'your-api-key'
+  end
+```
+Basic usage:
+```ruby
+vehicle_api = Edmunds::Api.new.vehicles
+vehicle_api.makes.count
+```
+You can also pass options to an Api endpoint:
+```ruby
+vehicle_api = Edmunds::Api.new.vehicle
+vehicle_api.make('Lexus', {state: 'new'})
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/webstreak/edmunds-api-ruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "edmunds-api-ruby"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/edmunds_api.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'edmunds/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'edmunds_api'
+  spec.version       = Edmunds::VERSION
+  spec.authors       = ['Alexander Belyaev']
+  spec.email         = ['alex@webstreak.com']
+
+  spec.summary       = 'Edmunds Api ruby client'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/webstreak/edmunds-api-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0'
+
+  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 'rspec', '~> 3.5'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+end

data/lib/edmunds.rb

@@ -0,0 +1,24 @@
+require 'json'
+require 'http'
+require 'configurations'
+
+require 'edmunds/version'
+require 'edmunds/configuration'
+require 'edmunds/request'
+require 'edmunds/error'
+require 'edmunds/api'
+require 'edmunds/vehicle'
+require 'edmunds/vehicle/makes'
+require 'edmunds/vehicle/models'
+require 'edmunds/vehicle/vin'
+require 'edmunds/vehicle/styles'
+require 'edmunds/vehicle/engines'
+require 'edmunds/vehicle/transmissions'
+require 'edmunds/vehicle/colors'
+require 'edmunds/vehicle/options'
+require 'edmunds/vehicle/equipment'
+require 'edmunds/vehicle/squishvins'
+require 'edmunds/vehicle/safety'
+require 'edmunds/vehicle/grades'
+require 'edmunds/media'
+require 'edmunds/media/photos'

data/lib/edmunds/api.rb

@@ -0,0 +1,15 @@
+module Edmunds
+  class Api
+
+    include Edmunds::Request
+
+    def vehicles
+      self.extend Edmunds::Vehicle
+    end
+
+    def media
+      self.extend Edmunds::Media
+    end
+
+  end
+end

data/lib/edmunds/configuration.rb

@@ -0,0 +1,14 @@
+module Edmunds
+
+  include Configurations
+
+  not_configured :api_key do |prop|
+    raise NoMethodError, "#{prop} must be configured"
+  end
+
+  configuration_defaults do |c|
+    c.request_params.fmt = 'json'
+    c.api_version = 2
+  end
+
+end

data/lib/edmunds/error.rb

@@ -0,0 +1,40 @@
+module Edmunds
+  class Error < StandardError
+
+    BadRequest = Class.new self
+    Unauthorized = Class.new self
+    Forbidden = Class.new self
+    NotFound = Class.new self
+    InternalServerError = Class.new self
+    BadGateway = Class.new self
+    ServiceUnavailable = Class.new self
+    GatewayTimeout = Class.new self
+
+    ERRORS = {
+      400 => Edmunds::Error::BadRequest,
+      401 => Edmunds::Error::Unauthorized,
+      403 => Edmunds::Error::Forbidden,
+      404 => Edmunds::Error::NotFound,
+      500 => Edmunds::Error::InternalServerError,
+      502 => Edmunds::Error::BadGateway,
+      503 => Edmunds::Error::ServiceUnavailable,
+      504 => Edmunds::Error::GatewayTimeout
+    }.freeze
+
+
+    def self.from_response(code, body)
+      message = "http code: #{code}. "
+      if body['message']
+        message << "Http message: #{body['message']}"
+      else
+        message = 'No message in http body'
+      end
+      new message
+    end
+
+    def initialize(message)
+      super message
+    end
+
+  end
+end

data/lib/edmunds/media.rb

@@ -0,0 +1,15 @@
+module Edmunds
+
+  module Media
+    def send_request(path, options={})
+      api_call 'media', path, options
+    end
+  end
+
+  class Api
+    def photos
+      self.extend Edmunds::Media::Photos
+    end
+  end
+
+end

data/lib/edmunds/media/photos.rb

@@ -0,0 +1,24 @@
+module Edmunds
+  module Media
+    module Photos
+
+      def by_year_make_model(year, make, model)
+        send_request "/#{make}/#{model}/#{year}/photos"
+      end
+
+      def by_tag(tag, options={})
+        options = {tag: tag}.merge(options)
+        send_request '/photoset', options
+      end
+
+      def by_style_id(style_id, options={})
+        send_request "/styles/#{style_id}/photos", options
+      end
+
+      def by_make_model(make, model, options={})
+        send_request "/#{make}/#{model}/photos", options
+      end
+
+    end
+  end
+end

data/lib/edmunds/request.rb

@@ -0,0 +1,52 @@
+module Edmunds
+  module Request
+
+    API_URL = 'https://api.edmunds.com/api'
+
+    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)
+      parse_response response
+    end
+
+    def build_api_url(api_path, path)
+      api_version = 'v' + Edmunds.configuration.api_version.to_s
+      API_URL + '/' + api_path + '/' + api_version + path
+    end
+
+    def merge_required_params(options)
+      {
+        api_key: Edmunds.configuration.api_key,
+        fmt: Edmunds.configuration.request_params.fmt
+      }.merge(options)
+    end
+
+    def http_headers
+      {
+        'User-Agent' => 'EdmundsApi ruby client',
+        'Accept' => 'application/json'
+      }
+    end
+
+    def parse_response(response)
+      begin
+        body = JSON.parse response.body
+      rescue
+        body = {}
+      end
+
+      if response.code == 200
+        body
+      else
+        raise_error response.code, body
+      end
+    end
+
+    def raise_error(code, body)
+      klass = Edmunds::Error::ERRORS[code]
+      raise klass.from_response code, body
+    end
+
+  end
+end

data/lib/edmunds/vehicle.rb

@@ -0,0 +1,59 @@
+module Edmunds
+
+  module Vehicle
+    def send_request(path, options={})
+      api_call 'vehicle', path, options
+    end
+  end
+
+  class Api
+    def makes
+      self.extend Edmunds::Vehicle::Makes
+    end
+
+    def models
+      self.extend Edmunds::Vehicle::Models
+    end
+
+    def vin
+      self.extend Edmunds::Vehicle::Vin
+    end
+
+    def styles
+      self.extend Edmunds::Vehicle::Styles
+    end
+
+    def engines
+      self.extend Edmunds::Vehicle::Engines
+    end
+
+    def transmissions
+      self.extend Edmunds::Vehicle::Transmissions
+    end
+
+    def colors
+      self.extend Edmunds::Vehicle::Colors
+    end
+
+    def options
+      self.extend Edmunds::Vehicle::Options
+    end
+
+    def equipment
+      self.extend Edmunds::Vehicle::Equipment
+    end
+
+    def squishvins
+      self.extend Edmunds::Vehicle::Squishvins
+    end
+
+    def safety
+      self.extend Edmunds::Vehicle::Safety
+    end
+
+    def grades
+      self.extend Edmunds::Vehicle::Grades
+    end
+  end
+
+end

data/lib/edmunds/vehicle/colors.rb

@@ -0,0 +1,15 @@
+module Edmunds
+  module Vehicle
+    module Colors
+
+      def details(color_id)
+        send_request "/colors/#{color_id}"
+      end
+
+      def by_style_id(style_id, options={})
+        send_request "/styles/#{style_id}/colors", options
+      end
+
+    end
+  end
+end

data/lib/edmunds/vehicle/engines.rb

@@ -0,0 +1,15 @@
+module Edmunds
+  module Vehicle
+    module Engines
+
+      def details(engine_id)
+        send_request "/engines/#{engine_id}"
+      end
+
+      def by_style_id(style_id, options={})
+        send_request "/styles/#{style_id}/engines", options
+      end
+
+    end
+  end
+end

data/lib/edmunds/vehicle/equipment.rb

@@ -0,0 +1,15 @@
+module Edmunds
+  module Vehicle
+    module Equipment
+
+      def details(equipment_id)
+        send_request "/equipment/#{equipment_id}"
+      end
+
+      def by_style_id(style_id, options={})
+        send_request "/styles/#{style_id}/equipment", options
+      end
+
+    end
+  end
+end

data/lib/edmunds/vehicle/grades.rb

@@ -0,0 +1,23 @@
+module Edmunds
+  module Vehicle
+    module Grades
+
+      def by_style_id(style_id)
+        send_request "/styles/#{style_id}/grade"
+      end
+
+      def details(make, model, year)
+        send_request "/#{make}/#{model}/#{year}/grade"
+      end
+
+      def rating(make, model, year)
+        send_request "/grade/#{make}/#{model}/#{year}"
+      end
+
+      def by_review_id(make, model, year, review_id)
+        send_request "/#{make}/#{model}/#{year}/grade/#{review_id}"
+      end
+
+    end
+  end
+end

data/lib/edmunds/vehicle/makes.rb

@@ -0,0 +1,19 @@
+module Edmunds
+  module Vehicle
+    module Makes
+
+      def count(options={})
+        send_request '/makes/count', options
+      end
+
+      def all_makes(options={})
+        send_request '/makes', options
+      end
+
+      def make(make, options={})
+        send_request "/#{make}", options
+      end
+
+    end
+  end
+end

data/lib/edmunds/vehicle/models.rb

@@ -0,0 +1,19 @@
+module Edmunds
+  module Vehicle
+    module Models
+
+      def count(make, options={})
+        send_request "/#{make}/models/count", options
+      end
+
+      def models(make, options={})
+        send_request "/#{make}/models", options
+      end
+
+      def model(make, model, options={})
+        send_request "/#{make}/#{model}", options
+      end
+
+    end
+  end
+end

data/lib/edmunds/vehicle/options.rb

@@ -0,0 +1,15 @@
+module Edmunds
+  module Vehicle
+    module Options
+
+      def details(option_id)
+        send_request "/options/#{option_id}"
+      end
+
+      def by_style_id(style_id, options={})
+        send_request "/styles/#{style_id}/options", options
+      end
+
+    end
+  end
+end

data/lib/edmunds/vehicle/safety.rb

@@ -0,0 +1,18 @@
+module Edmunds
+  module Vehicle
+    module Safety
+
+      def ratings(*args)
+        if args.count == 1
+          send_request "/styles/#{args[0]}/safety"
+        else
+          make = args[0]
+          model = args[1]
+          year = args[2]
+          send_request "/#{make}/#{model}/#{year}/safety"
+        end
+      end
+
+    end
+  end
+end

data/lib/edmunds/vehicle/squishvins.rb

@@ -0,0 +1,11 @@
+module Edmunds
+  module Vehicle
+    module Squishvins
+
+      def decode(vin)
+        send_request "/squishvins/#{vin}"
+      end
+
+    end
+  end
+end

data/lib/edmunds/vehicle/styles.rb

@@ -0,0 +1,35 @@
+module Edmunds
+  module Vehicle
+    module Styles
+
+      def count(options={})
+        send_request '/styles/count', options
+      end
+
+      def make_count(make, options={})
+        send_request "/#{make}/styles/count", options
+      end
+
+      def make_model_count(make, model, options={})
+        send_request "/#{make}/#{model}/styles/count", options
+      end
+
+      def make_model_year_count(make, model, year, options={})
+        send_request "/#{make}/#{model}/#{year}/styles/count", options
+      end
+
+      def id(style_id, options={})
+        send_request "/styles/#{style_id}", options
+      end
+
+      def make_model_year(make, model, year, options={})
+        send_request "/#{make}/#{model}/#{year}/styles", options
+      end
+
+      def chrome_data(chrome_id, options={})
+        send_request "/partners/chrome/styles/#{chrome_id}", options
+      end
+
+    end
+  end
+end

data/lib/edmunds/vehicle/transmissions.rb

@@ -0,0 +1,15 @@
+module Edmunds
+  module Vehicle
+    module Transmissions
+
+      def details(transmission_id)
+        send_request "/transmissions/#{transmission_id}"
+      end
+
+      def by_style_id(style_id, options={})
+        send_request "/styles/#{style_id}/transmissions", options
+      end
+
+    end
+  end
+end

data/lib/edmunds/vehicle/vin.rb

@@ -0,0 +1,11 @@
+module Edmunds
+  module Vehicle
+    module Vin
+
+      def decode(vin, options={})
+        send_request "/vins/#{vin}", options
+      end
+
+    end
+  end
+end

data/lib/edmunds/version.rb

@@ -0,0 +1,3 @@
+module Edmunds
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: edmunds_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Belyaev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: configurations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: ''
+email:
+- alex@webstreak.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- edmunds_api.gemspec
+- lib/edmunds.rb
+- lib/edmunds/api.rb
+- lib/edmunds/configuration.rb
+- lib/edmunds/error.rb
+- lib/edmunds/media.rb
+- lib/edmunds/media/photos.rb
+- lib/edmunds/request.rb
+- lib/edmunds/vehicle.rb
+- lib/edmunds/vehicle/colors.rb
+- lib/edmunds/vehicle/engines.rb
+- lib/edmunds/vehicle/equipment.rb
+- lib/edmunds/vehicle/grades.rb
+- lib/edmunds/vehicle/makes.rb
+- lib/edmunds/vehicle/models.rb
+- lib/edmunds/vehicle/options.rb
+- lib/edmunds/vehicle/safety.rb
+- lib/edmunds/vehicle/squishvins.rb
+- lib/edmunds/vehicle/styles.rb
+- lib/edmunds/vehicle/transmissions.rb
+- lib/edmunds/vehicle/vin.rb
+- lib/edmunds/version.rb
+homepage: https://github.com/webstreak/edmunds-api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Edmunds Api ruby client
+test_files: []