{"id":21474441,"url":"https://github.com/tab/regio","last_synced_at":"2025-07-15T08:32:43.763Z","repository":{"id":61121340,"uuid":"547881592","full_name":"tab/regio","owner":"tab","description":"Regio geocoding API lets you search for addresses from complete Estonian address database","archived":false,"fork":false,"pushed_at":"2024-06-03T12:59:42.000Z","size":114,"stargazers_count":5,"open_issues_count":4,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-13T01:48:47.673Z","etag":null,"topics":["geocoder","geocoding","geocoding-api","places","regio"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tab.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-08T13:36:54.000Z","updated_at":"2024-06-03T12:59:21.000Z","dependencies_parsed_at":"2024-06-03T14:12:28.068Z","dependency_job_id":null,"html_url":"https://github.com/tab/regio","commit_stats":{"total_commits":45,"total_committers":5,"mean_commits":9.0,"dds":0.4444444444444444,"last_synced_commit":"5a135064ded4ed197f7c513ed95cdd27cd86346e"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tab%2Fregio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tab%2Fregio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tab%2Fregio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tab%2Fregio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tab","download_url":"https://codeload.github.com/tab/regio/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225176109,"owners_count":17432914,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["geocoder","geocoding","geocoding-api","places","regio"],"created_at":"2024-11-23T10:22:56.008Z","updated_at":"2024-11-23T10:22:56.478Z","avatar_url":"https://github.com/tab.png","language":"Ruby","readme":"# Regio\n\n[![Gem Version](https://badge.fury.io/rb/regio.svg)](https://badge.fury.io/rb/regio)\n[![Release](https://github.com/tab/regio/actions/workflows/release.yaml/badge.svg?event=release)](https://github.com/tab/regio/actions/workflows/release.yaml)\n\n[Regio geocoding API](https://api.regio.ee/documentation/#docs/geocode) lets you search for addresses from complete Estonian address database.\n\n[Regio](https://www.regio.ee/en/)\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'regio', '~\u003e 0.3.5'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install regio\n\n## Usage\n\nGet your own API key\n\n```shell\nREGIO_API_KEY=SECRET\n```\n\n```\nexport REGIO_API_KEY=SECRET \u0026\u0026 irb -I lib\n\nirb(main):001:0\u003e require 'regio'\n=\u003e true\n\n...\n```\n\n### Geocoding\n\nUse `Geocode` class in your code\n\n```ruby\nrequire 'regio'\n\nclass Geocoding\n\n  private\n\n  def results\n    @results ||= Regio::Geocode.new(options).results\n  end\n\n  def options\n    {\n      address: 'Tartu maantee 83',\n      country: 'ee'\n    }\n  end\nend\n```\n\nCheck Regio [geocode](https://api.regio.ee/documentation/#docs/geocode) documentation\n\n### Reverse geocoding\n\nUse `ReverseGeocode` class in your code\n\n```ruby\nrequire 'regio'\n\nclass Geocoding\n\n  private\n\n  def results\n    @results ||= Regio::ReverseGeocode.new(options).results\n  end\n\n  def options\n    {\n      lat: 59.4276340999273,\n      lng: 24.7790924770962\n    }\n  end\nend\n```\n\nCheck Regio [reverse geocode](https://api.regio.ee/documentation/#docs/reverse_geocode) documentation\n\n### Gazetteer\n\nUse `Gazetteer` class in your code\n\n```ruby\nrequire 'regio'\n\nclass Geocoding\n\n  private\n\n  def results\n    @results ||= Regio::Gazetteer.new(options).results\n  end\n\n  def options\n    {\n      id: 16004253,\n      query: 'address_children'\n    }\n  end\nend\n```\n\nCheck Regio [Gazetteer](https://api.regio.ee/documentation/#docs/gazetteer) documentation\n\n### Routing and directions\n\nUse `Routing` class in your code\n\n```ruby\nrequire 'regio'\n\nclass Routing\n\n  private\n\n  def results\n    @results ||= Regio::Routing.new(options).results\n  end\n\n  def options\n    {\n      coordinates: [[24.649138022268, 59.14048887149], [25.853136227622, 59.00678681919]],\n      service: 'optimize',\n      overview: 'full'\n    }\n  end\nend\n```\n\nCheck Regio [routing and directions](https://api.regio.ee/documentation/#docs/routing_and_directions) documentation\n\n## Development\n\nBuild docker container with compose:\n\n```bash\ndocker-compose build\ndocker-compose up\n```\n\nAccess to the container:\n\n```bash\ndocker-compose exec regio sh\n```\n\nRun rspec or rubocop checks:\n\n```bash\n/package # bundle exec rubocop\n/package # bundle exec rspec\n```\n\n## Contributing\n\nBug 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](http://contributor-covenant.org) code of conduct.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the Regio project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tab/regio/blob/master/CODE_OF_CONDUCT.md).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftab%2Fregio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftab%2Fregio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftab%2Fregio/lists"}