Centaman
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/centaman
. To experiment with that code, run bin/console
for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
Installation
Add this line to your application's Gemfile:
gem 'centaman'
And then execute:
$ bundle
Or install it yourself as:
$ gem install centaman
Usage
TODO: Write usage instructions here
Required Environment Variables
This gem assumes the following environment variables are defined by the application
- CENTAMAN_API_URL (Centaman API endpoint, ex: https://taxi.centaman.net/CentamanAPI)
- CENTAMAN_API_USERNAME (Centaman API username)
- CENTAMAN_API_PASSWORD (Centaman API password)
- FIXIE_URL (Optional. Used with FIXIE proxy to route outbound requests through a set of static IP addresses)
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also 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
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/centaman.
License
The gem is available as open source under the terms of the MIT License.