Project

vinbot

0.02
Low commit activity in last 3 years
A long-lived project that still receives updates
Vinbot generates decodeable vins and provides a vehicle object that includes real vehicle data.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

> 1.8
>= 0
~> 10.0
>= 0

Runtime

>= 0
~> 2.7.3
>= 3.1.0
 Project Readme

Vinbot

Build Status

Vinbot generates decodable vins for you to use in your applications. Vinbot will also give you a vehicle object that contains the decoded information. Vinbot is an API around the vin_bank database (https://github.com/manheim/vin_bank).

Installation

Add this line to your application's Gemfile:

Ruby
gem 'vinbot'
JRuby
gem 'vinbot', :platform => :jruby

And then execute:

$ bundle install

Or install it yourself as:

$ gem install vinbot

Usage

There are two ways to use vinbot:

  1. Get a random, decodable vin
  2. Get a vehicle object that contains the vin and all decoded information for the vehicle.
Get a random vin
Vinbot::Vin.generate
=> "WBADT43443G749665"
Get a decoded vehicle object
Vinbot::Vehicle.new
=> #<Vinbot::Vehicle:0x007fc06bd34068
 @body_type="4Dr SUV",
 @drivetrain="FWD",
 @engine_type="3.6L 6 Cylinder",
 @exterior_colors=["Silver"],
 @interior_colors=["Off-white"],
 @make="GMC",
 @model="Acadia",
 @transmission="Automatic",
 @trim="SLE 4dr SUV ",
 @vehicle_type="SUV",
 @vin="1GKKRNED9CJ550307",
 @year=2012>

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/vinbot/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request