GeostellarClient

This is a Ruby wrapper for the Geostellar API. You will need an API key to use this gem.

Installation

Add this line to your application's Gemfile:

gem 'geostellar_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install geostellar_client

Usage

Configure the client with your API key:

GeostellarClient = YOURAPIKEY

To fetch a user:

user = GeostellarClient::User.find(1)

A user has the following attributes:

id, Integer
email, String
phone, String
first_name, String
last_name, String
street_address_1, String
street_address_2, String
city, String
state, String
zip_code, String

Development

After checking out the repo, run bin/setup to install dependencies. Rename spec/credentials.yml.sample to spec/credentials.yml and replace the dummy API key with your own.

Then, run rake rspec 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/jpmoral/geostellar_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.