View
 

Ruby Wrapper

Download | Installation | Documentation

 

The GeoAPI Ruby Wrapper, written by Chris Bruce, lets you utilize GeoAPI methods and data structures from within Ruby programs. Currently still in development and very much an alpha application, right now you are limited to doing simple searches and MQL queries, both of which return a Ruby hash.

 

Download          [Top]

 

To get the GeoAPI Ruby Wrapper, go to http://github.com/chrisabruce/geoapi and click the download button.

 

Installation and Requirements          [Top]

 

The Wrapper gem is hosted on Gemcutter. To install Gemcutter:

 

  gem install gemcutter

 gem tumble

 

To install GeoAPI after installing Gemcutter:

 

  gem install geoapi

 

geoapi has these gem dependencies:

 

  • rest-client >= 0.9
  • json >= 1.1.3
    • If you have ActiveSupport::JSON defined (either due to manual loading or when using geoapi in a Rails application), geoapi will ignore the json dependency and use ActiveSupport:JSON instead.

 

Of course, you also need a valid GeoAPI API Key.

 

Documentation           [Top]

 

See http://github.com/chrisabruce/GeoAPI/blob/master/README for documentation about and examples for the wrapper. For full API method specifications, see the pages in this wiki.