Tests Code Climate Coverage Status Gem Version RubyGems

Edmunds Api ruby client.

Status: Beta. We are preparing the project for public release soon

Installation

Add this line to your application's Gemfile:

gem 'edmunds_api', '~> 0.1.8'

And then execute:

$ bundle

Or install it yourself as:

$ gem install edmunds_api

Usage

Add api_key in initializer:

  Edmunds.configure do |config|
    config.api_key = 'your-api-key'
    config.timeout = 5
  end

Basic usage:

vehicles_api = Edmunds::Api.new.vehicles
vehicles_api.makes.count

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

Supported endpoints

Endpoints

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.