This gem implements the Aceroute API
Aceroute is a SaaS application for field management. Aceroute allows you to schedule customer visits, optimize driving routes and more.
This library is still very early and very much under development.
Add this line to your application's Gemfile:
gem 'aceroute'
And then execute:
$ bundle
Or install it yourself as:
$ gem install aceroute
First set the ACEROUTE_API_TOKEN environment variable to contain your Aceroute api key:
export ACEROUTE_API_TOKEN=mytoken
The following methods are currently available:
- Aceroute::list_customers
- Aceroute::create_customer
- Aceroute::delete_customer
- Aceroute::create_location
- Aceroute::delete_location
To create a customer, pass in a hash containing the required customer data.
john = {:name=>"John Smith", :email=>"john@example.com", :address=>{:description=>"Home", :address1=>"123 Fake Street", :address2=>"Springfield MO 12345", :phone=>"555-1212"}}
Aceroute::create_customer(john)
To delete a customer, pass in the aceroute id assigned when you created it.
Aceroute::delete_customer('11520001')
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.
- Fork it ( https://github.com/[my-github-username]/aceroute/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
This gem is available on github under an MIT License.