Giter VIP home page Giter VIP logo

vin_query's Introduction

VinQuery

Build Status

A ruby library for fetching and parsing VIN information from vinquery.com, a vehicle identification number decoding service.

Note, this gem is not officially affiliated with vinquery.com.

Installation

Add this line to your application's Gemfile:

gem 'vin_query'

And then execute:

bundle

Or install it yourself as:

gem install vin_query

Usage

Pass in the URL and access code provided by vinquery.com as well as the report type you want (defaults to report type '2' -- the extended report type).

Note, A VinQuery::Query class has an array of trim levels. This is due to the VinQuery service returning a array of possible trim levels for certain makes/models.

query = VinQuery.get('1C3CC4FB8AN236750',
                     url: 'vinquery-url-here',
                     access_code: 'access-code-here',
                     report_type: 'report-type-here')

query.valid? # => true

Configuration

It also accepts a configuration block to streamline gets.

VinQuery.configure do |config|
  config.url = 'vinquery-url-here'
  config.access_code = 'access-code-here'
  config.report_type = VinQuery::ReportType::EXTENDED
end

query = VinQuery.get('1C3CC4FB8AN236750')
query.valid? # => true

Note, trim_levels will always be an array. Empty, or otherwise.

vehicle = query.trim_levels.first

vehicle.attributes[:make]              # => Chrysler
vehicle.attributes[:model]             # => Sebring
vehicle.attributes[:trim_level]        # => Sedan Touring
vehicle.attributes[:fuel_economy_city] # => 21

Resources

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

Licensed under the MIT License.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.