Gfw API Client

A Ruby Client library for the GFW-API. For now this library should not be used for any production apps.

Tested with Ruby 2.0.0, 2.1.0, 2.2.0, JRuby (1.9 mode)

Requires Rails >= 4.0

Add this line to your application's Gemfile:

gem 'gfw_api_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install gfw_api_client

Make the following constants, in config/gfw.yaml file:

development:
  gfw_api_url: http://staging.gfw-apis.appspot.com

test:
  gfw_api_url: http://staging.gfw-apis.appspot.com

# Read values from the environment in production mode.
production:
  gfw_api_url: <%= ENV["GFW_API_URL"] %>

Available data sets (table_space): imazon-alerts, umd-loss-gain, forma-alerts, nasa-active-fires, quicc-alerts, terrai-alerts

[table_space, concessions, wdpa_id, use_id, type, country, region, start_date, end_date, geo_json]

  require 'gfw_api_client'

  GfwApiClient.find_set({'table_space' => 'forma-alerts', 'concessions' => 'iso', 'country' => 'BRA', 'region' => '3', 'start_date' => '2014-01-01', 'end_date' => '2015-01-01'})

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.

Bug reports and pull requests are welcome on GitHub at http://github.com/vizzuality/gfw-ruby-client-library.

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