Regio

Regio geocoding API lets you search for addresses from complete Estonian address database.

Installation

Add this line to your application's Gemfile:

gem 'regio', '~> 0.2.0'

And then execute:

$ bundle

Or install it yourself as:

$ gem install regio

Usage

Get your own API key

REGIO_API_KEY=SECRET

Geocoding

Use Geocode class in your code

require 'regio'

class Geocoding

  private

  def results
    @results ||= Regio::Geocode.new(options).results
  end

  def options
    {
      address: 'Tartu maantee 83',
      country: 'ee'
    }
  end
end

Check Regio geocode documentation

Reverse geocoding

Use ReverseGeocode class in your code

require 'regio'

class Geocoding

  private

  def results
    @results ||= Regio::ReverseGeocode.new(options).results
  end

  def options
    {
      lat: 59.4276340999273,
      lng: 24.7790924770962
    }
  end
end

Check Regio reverse geocode documentation

Gazetteer

Use Gazetteer class in your code

require 'regio'

class Geocoding

  private

  def results
    @results ||= Regio::Gazetteer.new(options).results
  end

  def options
    {
      id: 16004253,
      query: 'address_children'
    }
  end
end

Check Regio Gazetteer documentation

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 on GitHub at https://github.com/tab/regio. 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.

Code of Conduct

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

ashgaliyev/regio