trimble_maps

TrimbleMaps

Trimble Maps Gem is not in anyway supported by or connected to Trimble, its partners or subsidiaries in any way.

Installation

Add this line to your application's Gemfile:

gem 'trimble_maps'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install trimble_maps

Usage

To use this gem you will need to obtain an API Key from Trimble you can get one here.

You can reference their docs here

Once you have you API key issued (usually a few minutes) add it to your credentials file (in this example were using rails 6 credentials)

EDITOR="nano -w" rails credentials:edit

Add this to your credentials.yml

trimble:
  api_key: 'YOUR KEY HERE'

You should then be able to access it in rails console like so

Rails.application.credentials[:trimble][:api_key]

returns => 'YOUR KEY HERE'

After your key is saved to your credentials create an initializer in: config/initializers/trimble.rb and add the following:

TrimbleMaps.configure do |config|
  config.api_key = Rails.application.credentials[:trimble][:api_key]
end 

Checkout our Wiki for module examples

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 here. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Code of Conduct

Everyone interacting in the TrimbleMaps project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.