google_geocodings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed805fb97f1ac0e6317b13ded64272a3506b8349
+  data.tar.gz: b000e4b2b6ea4652f37cfe6fcbcd441637399b9e
+SHA512:
+  metadata.gz: b6a6c23b36656c2803aa21f4ca501fe03a3cea55f4b5562508372390e3383fd7f0182208c875075917233a6bdf174e8e6b1ebdc677541c168092aada3d017b2a
+  data.tar.gz: 3b61b7693985fb5806c859fa445f1796a65d46a2ce30922d9e856f64b1890d42c130f97424d53982f8b7f2ea56eec320d69bdeba8ccd2be4e6ad91a78bab2695

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+script: bundle exec rspec
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at afujiwara2012@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in google_geocodings.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 akichim21
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# 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:
+
+```ruby
+gem 'google_geocodings'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google_geocodings
+
+## Usage
+### Request
+
+First register a new Client:
+```ruby
+client = GoogleGeocodings::Client.new(API_KEY)
+```
+
+retrieve geometry by address
+```ruby
+client.geocode("1600 Amphitheatre Parkway, Mountain View, CA")
+```
+
+retrieve address by geometry(latitude, longitude)
+```ruby
+client.reverse_geocode("37.4230474802915", "-122.0843128697085")
+```
+
+change langauge (ex: ja), response ja data
+```ruby
+client.geocode("秋田県大館市御成町１丁目３−１", 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](https://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](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = "--color"
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "google_geocodings"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/google_geocodings

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "google_geocodings"

data/google_geocodings.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "google_geocodings/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "google_geocodings"
+  spec.version       = GoogleGeocodings::VERSION
+  spec.authors       = ["akichim21"]
+  spec.email         = ["afujiwara2012@gmail.com"]
+
+  spec.summary       = %q{google geocodings api wrapper}
+  spec.description   = %q{google geocodings api wrapper}
+  spec.homepage      = "https://github.com/akichim21/google_geocodings"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency             'httparty', '>= 0.13.1'
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.6.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+end

data/lib/google_geocodings.rb

@@ -0,0 +1,20 @@
+require "google_geocodings/version"
+require 'httparty'
+
+%w(client geocoding invalid_request_error not_found_error over_query_limit_error request_denied_error request rectangle unknown_error location).each do |file|
+  require File.join(File.dirname(__FILE__), 'google_geocodings', file)
+end
+
+module GoogleGeocodings
+  class << self
+    attr_accessor :api_key
+
+    def root
+      File.dirname __dir__
+    end
+
+    def configuration
+      yield self
+    end
+  end
+end

data/lib/google_geocodings/client.rb

@@ -0,0 +1,83 @@
+module GoogleGeocodings
+  class Client
+    # @return [String] the provided api key
+    attr_reader :api_key
+
+    # Creates a new Client instance which proxies the requests to the certain classes
+    #
+    # @param [String] api_key The api key to use for the requests
+    def initialize(api_key = @api_key)
+      @api_key = api_key
+    end
+
+    # geocode
+    #
+    # @return [Array<Geocoding>]
+    # @param [String] address
+    # @param [Hash] options
+    #   @option bounds [Hash]
+    #     @bounds start_latitude [Float]
+    #     @bounds start_longitude [Float]
+    #     @bounds end_latitude [Float]
+    #     @bounds end_longitude [Float]
+    #   @option language [String]
+    #   @option region [String]
+    # see: https://developers.google.com/maps/documentation/geocoding/intro#geocoding
+    # NOTE: Not yet correspond to components param
+    def geocode(address, options = {})
+      language   = options.delete(:language)
+      region     = options.delete(:region)
+      rectangle  = Rectangle.new(options.delete(:bounds))
+
+      options = {
+        key: api_key,
+        address: address,
+        language: language,
+        region: region,
+        bounds: rectangle.format,
+      }
+      request(:geocode, options)
+    end
+
+    # reverse geocode
+    #
+    # @return [Array<Geocoding>]
+    # @param [String] address
+    # @param [Hash] options
+    #   @option bounds [Hash]
+    #     @bounds start_latitude [Float]
+    #     @bounds start_longitude [Float]
+    #     @bounds end_latitude [Float]
+    #     @bounds end_longitude [Float]
+    #   @option language [String]
+    #   @option region [String]
+    # see: https://developers.google.com/maps/documentation/geocoding/intro#ReverseGeocoding
+    # NOTE: Not yet correspond to components param
+    def reverse_geocode(latitude, longitude, options = {})
+      language   = options.delete(:language)
+      region     = options.delete(:region)
+      rectangle  = Rectangle.new(options.delete(:bounds))
+
+      options = {
+        key: api_key,
+        latlng: Location.new(latitude, longitude).format,
+        language: language,
+        region: region,
+        bounds: rectangle.format,
+      }
+      request(:geocode, options)
+    end
+
+    private
+    def request(method, options)
+      results = []
+
+      response = Request.send(method, options)
+      response['results'].each do |result|
+        results << Geocoding.new(result, api_key)
+      end
+
+      results
+    end
+  end
+end

data/lib/google_geocodings/geocoding.rb

@@ -0,0 +1,17 @@
+module GoogleGeocodings
+  class Geocoding
+    attr_reader :address_components, :formatted_address, :geometry, :place_id, :types, :api_key
+    def initialize(json_result_object, api_key)
+      @address_components = json_result_object['address_components']
+      @formatted_address  = json_result_object['formatted_address']
+      @geometry           = json_result_object['geometry']
+      @place_id           = json_result_object['place_id']
+      @types              = json_result_object['types']
+      @api_key            = api_key
+    end
+
+    def [] (key)
+      send(key)
+    end
+  end
+end

data/lib/google_geocodings/invalid_request_error.rb

@@ -0,0 +1,10 @@
+module GoogleGeocodings
+  # Thrown when a request was rejected as invalid by the server
+  #
+  # This can be the case when:
+  # - querying the SPOT_LIST_URL <b>without</b> the following parameters:
+  # - - location
+  # - - radius
+  class InvalidRequestError < HTTParty::ResponseError
+  end
+end

data/lib/google_geocodings/location.rb

@@ -0,0 +1,8 @@
+module GoogleGeocodings
+  class Location
+    attr_reader :format
+    def initialize(latitude, longitude)
+      @format = [("%.8f" % latitude), ("%.8f" % longitude)].join(',')
+    end
+  end
+end

data/lib/google_geocodings/not_found_error.rb

@@ -0,0 +1,4 @@
+module GoogleGeocodings
+  class NotFoundError < HTTParty::ResponseError
+  end
+end

data/lib/google_geocodings/over_query_limit_error.rb

@@ -0,0 +1,4 @@
+module GoogleGeocodings
+  class OverQueryLimitError < HTTParty::ResponseError
+  end
+end

data/lib/google_geocodings/rectangle.rb

@@ -0,0 +1,19 @@
+module GoogleGeocodings
+  class Rectangle
+    attr_reader :format
+    # @param bounds [Hash]
+    #   @bounds start_latitude [Float]
+    #   @bounds start_longitude [Float]
+    #   @bounds end_latitude [Float]
+    #   @bounds end_longitude [Float]
+    def initialize(bounds = {})
+      bounds ||= {}
+      start_latitude  = bounds[:start_latitude]
+      start_longitude = bounds[:start_longitude]
+      end_latitude    = bounds[:end_latitude]
+      end_longitude   = bounds[:end_longitude]
+      return unless start_latitude && start_longitude && end_latitude && end_longitude
+      @format = [[("%.8f" % start_latitude), ("%.8f" % start_longitude)].join(','), [("%.8f" % end_latitude), ("%.8f" % end_longitude)].join(',')].join('|')
+    end
+  end
+end

data/lib/google_geocodings/request.rb

@@ -0,0 +1,37 @@
+module GoogleGeocodings
+  class Request
+    attr_reader :response, :options
+    include ::HTTParty
+    default_options.update(verify: false)
+    format :json
+
+    GEOCODE_URL = "https://maps.googleapis.com/maps/api/geocode/json".freeze
+
+    def self.geocode(options = {})
+      request = new(GEOCODE_URL, options)
+      request.parsed_response
+    end
+
+    def parsed_response
+      return @response.headers["location"] if @response.code >= 300 && @response.code < 400
+      case @response.parsed_response['status']
+      when 'OK', 'ZERO_RESULTS'
+        @response.parsed_response
+      when 'OVER_QUERY_LIMIT'
+        raise OverQueryLimitError.new(@response)
+      when 'REQUEST_DENIED'
+        raise RequestDeniedError.new(@response)
+      when 'INVALID_REQUEST'
+        raise InvalidRequestError.new(@response)
+      when 'UNKNOWN_ERROR'
+        raise UnknownError.new(@response)
+      when 'NOT_FOUND'
+        raise NotFoundError.new(@response)
+      end
+    end
+
+    def initialize(url, options, follow_redirects = true)
+      @response = self.class.get(url, query: options, follow_redirects: follow_redirects)
+    end
+  end
+end

data/lib/google_geocodings/request_denied_error.rb

@@ -0,0 +1,13 @@
+module GoogleGeocodings
+  # Thrown when a request was denied by the server
+  #
+  # This can be the case when:
+  # - API key is not authorized for the Geocodings API
+  # - querying the SPOT_LIST_URL <b>without</b> the following parameters:
+  # - - key
+  class RequestDeniedError < HTTParty::ResponseError
+    def to_s
+      response.parsed_response['error_message']
+    end
+  end
+end

data/lib/google_geocodings/unknown_error.rb

@@ -0,0 +1,4 @@
+module GoogleGeocodings
+  class UnknownError < HTTParty::ResponseError
+  end
+end

data/lib/google_geocodings/version.rb

@@ -0,0 +1,3 @@
+module GoogleGeocodings
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: google_geocodings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- akichim21
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: google geocodings api wrapper
+email:
+- afujiwara2012@gmail.com
+executables:
+- google_geocodings
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/google_geocodings
+- google_geocodings.gemspec
+- lib/google_geocodings.rb
+- lib/google_geocodings/client.rb
+- lib/google_geocodings/geocoding.rb
+- lib/google_geocodings/invalid_request_error.rb
+- lib/google_geocodings/location.rb
+- lib/google_geocodings/not_found_error.rb
+- lib/google_geocodings/over_query_limit_error.rb
+- lib/google_geocodings/rectangle.rb
+- lib/google_geocodings/request.rb
+- lib/google_geocodings/request_denied_error.rb
+- lib/google_geocodings/unknown_error.rb
+- lib/google_geocodings/version.rb
+homepage: https://github.com/akichim21/google_geocodings
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: google geocodings api wrapper
+test_files: []