Vinbot
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:
- Get a random, decodable vin
- 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
- Fork it ( https://github.com/[my-github-username]/vinbot/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request