Geocodio

Geocodio is a lightweight Ruby wrapper around the geocod.io API.

Installation

In your Gemfile:

gem 'geocodio'

Usage

The point of entry to geocod.io's API is the Geocodio::Client class. Initialize one by passing your API key or allowing the initializer to automatically use the GEOCODIO_API_KEY environment variable:

geocodio = Geocodio::Client.new('0123456789abcdef')

# Or, if you've set GEOCODIO_API_KEY in your environment:
geocodio = Geocodio::Client.new

Geocoding

The Geocodio::Client#geocode method is used to request coordinates and expanded information on one or more addresses. It is possible for a geocoding request to yield multiple results with varying degrees of accuracy, so the geocode method will always return one Geocodio::AddressSet for each query made:

results = geocodio.geocode('1 Infinite Loop, Cupertino, CA 95014')
# => #<Geocodio::AddressSet:0x007fdf23a07f80 @query="1 Infinite Loop, Cupertino, CA 95014", @addresses=[...]>

AddressSets are enumerable, so you can iterate over each result and perform operations on the addresses:

results.each { |address| puts address }

If you just want the most accurate result, use the #best convenience method:

address = results.best
# => #<Geocodio::Address:0x007fb062e7fb20 @number="1", @street="Infinite", @suffix="Loop", @city="Monta Vista", @state="CA", @zip="95014", @latitude=37.331669, @longitude=-122.03074, @accuracy=1, @formatted_address="1 Infinite Loop, Monta Vista CA, 95014">

puts address
# => 1 Infinite Loop, Cupertino CA, 95014

puts address.latitude # or address.lat
# => 37.331669

puts address.longitude # or address.lng
# => -122.03074

To perform a batch geocoding operation, simply pass multiple addresses to Geocodio::Client#geocode:

result_sets = geocodio.geocode('1 Infinite Loop, Cupertino, CA 95014', '54 West Colorado Boulevard, Pasadena, CA 91105')
# => [#<Geocodio::AddressSet:0x007fdf23a07f80 @query="1 Infinite Loop, Cupertino, CA 95014", @addresses=[...]>, #<Geocodio::AddressSet:0x007fdf23a07f80 @query="54 West Colorado Boulevard, Pasadena, CA 91105", @addresses=[...]>]

cupertino = result_sets.first.best
# => #<Geocodio::Address:0x007fb062e7fb20 @number="1", @street="Infinite", @suffix="Loop", @city="Monta Vista", @state="CA", @zip="95014", @latitude=37.331669, @longitude=-122.03074, @accuracy=1, @formatted_address="1 Infinite Loop, Monta Vista CA, 95014">

Parsing

address = geocodio.parse('1 Infinite Loop, Cupertino, CA 95014')
# => #<Geocodio::Address:0x007fa3c15f41c0 @number="1", @street="Infinite", @suffix="Loop", @city="Cupertino", @state="CA", @zip="95014", @accuracy=nil, @formatted_address="1 Infinite Loop, Cupertino CA, 95014">

Note that this endpoint performs no geocoding; it merely formats a single provided address according to geocod.io's standards.

Testing Geocodio

When writing tests for an app that uses Geocodio, it would be wise to avoid network calls that result in wasted daily requests and potentially expensive test driven development.

Using Fakweb

Fakeweb allows us to fake a web request and avoid hitting the Geocodio API. First add fakeweb to your Gemfile under the :test group and then install.

group :test do
  ...
  gem 'fakeweb'
  ...
end

Next you should add your fake JSON response and the uri that is being faked to your spec/support/geocoding.rb file or wherever you keep your testing support files.

geocodio_json = <<-JSON
{
  "input": {
    "address_components": {
      "number": "1101",
      "street": "Pennsylvania",
      "suffix": "Ave",
      "postdirectional": "NW",
      "city": "Washington",
      "state": "DC"
    },
    "formatted_address": "1101 Pennsylvania Ave NW, Washington DC"
  },
  "results": [
    {
      "address_components": {
        "number": "1101",
        "street": "Pennsylvania",
        "suffix": "Ave",
        "postdirectional": "NW",
        "city": "Washington",
        "state": "DC",
        "zip": "20004"
      },
      "formatted_address": "1101 Pennsylvania Ave NW, Washington DC, 20004",
      "location": {
        "lat": 38.895019,
        "lng": -77.028095
      },
      "accuracy": 1
    },
    {
      "address_components": {
        "number": "1101",
        "street": "Pennsylvania",
        "suffix": "Ave",
        "postdirectional": "NW",
        "city": "Washington",
        "state": "DC",
        "zip": "20004"
      },
      "formatted_address": "1101 Pennsylvania Ave NW, Washington DC, 20004",
      "location": {
        "lat": 38.895016122449,
        "lng": -77.028084377551
      },
      "accuracy": 0.8
    }
  ]
}
JSON

FakeWeb.register_uri(:any, %r|http://api\.geocod\.io/v1/geocode|, :body => geocodio_json)

Lastly, include this support file in your testng environment!

Contributing

1. Fork it ( http://github.com/davidcelis/geocodio/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request