GoogleGeocodings
This gem provides a Ruby wrapper around the Google Geocodings API, using HTTParty. At this moment the gem does not support OAuth authentication and will only work with an API key.
Obtaining an API key
To be able to use this gem, you'll need a Google Places API key. To request an API key, point your browser to code.google.com/apis/console and follow the instructions there. You'll find your API key on the API Access tab under Simple API Access.
Installation
Add this line to your application's Gemfile:
gem 'google_geocodings'
And then execute:
$ bundle
Or install it yourself as:
$ gem install google_geocodings
Usage
Request
First register a new Client:
client = GoogleGeocodings::Client.new(API_KEY)
retrieve geometry by address
client.geocode("1600 Amphitheatre Parkway, Mountain View, CA")
retrieve address by geometry(latitude, longitude)
client.reverse_geocode("37.4230474802915", "-122.0843128697085")
change langauge (ex: ja), response ja data
client.geocode("秋田県大館市御成町1丁目3−1", language: 'ja')
Response
response
- GoogleGeocodings::Geocoding[]
GoogleGeocodings::Geocoding attribute
- types[], formatted_address, address_components[], postcode_localities[], geometry, partial_match, place_id see: https://developers.google.com/maps/documentation/geocoding/intro#GeocodingResponses
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/akichim/google_geocodings. 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.