sora_geocoding 0.1.0

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2020- SORA, inc.
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 hirontan
+
+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,82 @@
+# SoraGeocoding
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sora_geocoding`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sora_geocoding'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sora_geocoding
+
+## Usage
+
+### Search
+
+##### No options
+```
+SoraGeocoding.search('Tokyo')
+=> {:site=>"geocoding", :data=>"<?xml version='1.0' encoding='UTF-8'?>\n<result>\n<version>1.2</version>\n<address>Tokyo</address>\n<coordinate>\n<lat>35.676192</lat>\n<lng>139.650311</lng>\n<lat_dms>35,40,34.291</lat_dms>\n<lng_dms>139,39,1.118</lng_dms>\n</coordinate>\n<open_location_code>8Q7XMMG2+F4</open_location_code>\n<url>https://www.geocoding.jp/?q=Tokyo</url>\n<needs_to_verify>no</needs_to_verify>\n<google_maps>東京都</google_maps>\n</result>\n"}
+```
+
+##### Optional
+- set options
+  - site: 'yahoo'
+  - yahoo_app_id: 'xxxxxxxx'
+    - Get the ClientId: https://developer.yahoo.co.jp/start/
+
+```
+SoraGeocoding.search('東京都', {site: 'yahoo', yahoo_appid: 'xxxxxxxx'})
+=> {:site=>"yahoo", :data=>"<?xml version='1.0' encoding='UTF-8'?>\n<YDF firstResultPosition='1' totalResultsAvailable='1793198' totalResultsReturned='1' xmlns='http://olp.yahooapis.jp/ydf/1.0'><ResultInfo><Count>1</Count><Total>1793198</Total><Start>1</Start><Status>200</Status><Description/><Copyright/><Latency>0.036</Latency></ResultInfo><Feature><Id>13112</Id><Gid/><Name>東京都世田谷区</Name><Geometry><Type>point</Type><Coordinates>139.65324950,35.64657460</Coordinates><BoundingBox>139.58242700,35.59004000 139.68655700,35.68297400</BoundingBox></Geometry><Category/><Description/><Style/><Property><Uid>9b7486bd58ee135ffec334df2975f4f37690b3cf</Uid><CassetteId>b22fee69b0dcaf2c2fe2d6a27906dafc</CassetteId><Yomi>トウキョウトセタガヤク</Yomi><Country><Code>JP</Code><Name>日本</Name></Country><Address>東京都世田谷区</Address><AddressElement><Name>東京都</Name><Kana>とうきょうと</Kana><Level>prefecture</Level></AddressElement><AddressElement><Name>世田谷区</Name><Kana>せたがやく</Kana><Level>city</Level></AddressElement><GovernmentCode>13112</GovernmentCode><AddressMatchingLevel>2</AddressMatchingLevel><Approximation>0.429</Approximation><AddressType>特別区</AddressType><OpenForBusiness/><Detail><NameHiragana>とうきょうとせたがやく</NameHiragana><OldAddressFlag>false</OldAddressFlag></Detail></Property></Feature></YDF>\n<!-- xxxcache nohit 0.038, 0.001, 0.001 -->"}
+```
+
+### Coordinates
+
+##### No options
+```
+SoraGeocoding.coordinates('Tokyo')
+=> {:site=>"geocoding", :coordinates=>{:lat=>"35.676192", :lon=>"139.650311"}}
+```
+
+##### Optional
+- set options
+  - site: 'yahoo'
+  - yahoo_app_id: 'xxxxxxxxx'
+    - Get the ClientId: https://developer.yahoo.co.jp/start/
+
+```
+SoraGeocoding.coordinates('東京都', {site: 'yahoo', yahoo_appid: 'xxxxxxxxx'})
+=> {:site=>"yahoo", :coordinates=>{:lat=>"35.64657460", :lon=>"139.65324950"}}
+```
+
+## 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/[USERNAME]/sora_geocoding. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SoraGeocoding project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sora_geocoding/blob/master/CODE_OF_CONDUCT.md).
+
+## Reference
+- https://github.com/alexreisner/geocoder

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sora_geocoding'
+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 --path ./.bundle/
+
+# Do any other automated setup that you need to do here

data/lib/hash_recursive_merge.rb

@@ -0,0 +1,70 @@
+#
+# = Hash Recursive Merge
+#
+# Merges a Ruby Hash recursively, Also known as deep merge.
+# Recursive version of Hash#merge and Hash#merge!.
+#
+# Category::    Ruby
+# Package::     Hash
+# Author::      Simone Carletti <weppos@weppos.net>
+# Copyright::   2007-2008 The Authors
+# License::     MIT License
+# Link::        http://www.simonecarletti.com/
+# Source::      http://gist.github.com/gists/6391/
+#
+module HashRecursiveMerge
+  #
+  # Recursive version of Hash#merge!
+  #
+  # Adds the contents of +other_hash+ to +hsh+,
+  # merging entries in +hsh+ with duplicate keys with those from +other_hash+.
+  #
+  # Compared with Hash#merge!, this method supports nested hashes.
+  # When both +hsh+ and +other_hash+ contains an entry with the same key,
+  # it merges and returns the values from both arrays.
+  #
+  #    h1 = {"a" => 100, "b" => 200, "c" => {"c1" => 12, "c2" => 14}}
+  #    h2 = {"b" => 254, "c" => {"c1" => 16, "c3" => 94}}
+  #    h1.rmerge!(h2)   #=> {"a" => 100, "b" => 254, "c" => {"c1" => 16, "c2" => 14, "c3" => 94}}
+  #
+  # Simply using Hash#merge! would return
+  #
+  #    h1.merge!(h2)    #=> {"a" => 100, "b" = >254, "c" => {"c1" => 16, "c3" => 94}}
+  #
+  def rmerge!(other_hash)
+    merge!(other_hash) do |_key, oldval, newval|
+      oldval.class == self.class ? oldval.rmerge!(newval) : newval
+    end
+  end
+
+  #
+  # Recursive version of Hash#merge
+  #
+  # Compared with Hash#merge!, this method supports nested hashes.
+  # When both +hsh+ and +other_hash+ contains an entry with the same key,
+  # it merges and returns the values from both arrays.
+  #
+  # Compared with Hash#merge, this method provides a different approch
+  # for merging nasted hashes.
+  # If the value of a given key is an Hash and both +other_hash+ abd +hsh
+  # includes the same key, the value is merged instead replaced with
+  # +other_hash+ value.
+  #
+  #    h1 = {"a" => 100, "b" => 200, "c" => {"c1" => 12, "c2" => 14}}
+  #    h2 = {"b" => 254, "c" => {"c1" => 16, "c3" => 94}}
+  #    h1.rmerge(h2)    #=> {"a" => 100, "b" => 254, "c" => {"c1" => 16, "c2" => 14, "c3" => 94}}
+  #
+  # Simply using Hash#merge would return
+  #
+  #    h1.merge(h2)     #=> {"a" => 100, "b" = >254, "c" => {"c1" => 16, "c3" => 94}}
+  #
+  def rmerge(other_hash)
+    merge(other_hash) do |_key, oldval, newval|
+      oldval.class == self.class ? oldval.rmerge(newval) : newval
+    end
+  end
+end
+
+class Hash
+  include HashRecursiveMerge
+end

data/lib/sora_geocoding.rb

@@ -0,0 +1,48 @@
+require 'sora_geocoding/version'
+require 'sora_geocoding/configuration'
+require 'sora_geocoding/logger'
+require 'sora_geocoding/exceptions'
+require 'sora_geocoding/base'
+require 'sora_geocoding/query'
+require 'sora_geocoding/url'
+require 'sora_geocoding/request'
+require 'sora_geocoding/results/geocoding'
+require 'sora_geocoding/results/yahoo_geocoder'
+
+#
+# This library takes into account the number of API calls and address lookup to get the latitude and longitude.
+# The API uses the Geocoding API and the Yahoo! Geocoder API.
+#
+module SoraGeocoding
+  #
+  # Search for information about an address or a set of coordinates.
+  #
+  def self.search(query, options = {})
+    query = SoraGeocoding::Query.new(query, options) unless query.is_a?(SoraGeocoding::Query)
+    query.nil? ? nil : query.execute
+  end
+
+  #
+  # Look up the coordinates of the given street or IP address.
+  #
+  def self.coordinates(address, options = {})
+    results = search(address, options)
+    return if results.nil?
+
+    { site: results[:site], coordinates: site_specific_coordinates(results[:site], results[:data]) }
+  end
+
+  class << self
+    private
+      def site_specific_coordinates(site, data)
+        SoraGeocoding::Results.const_get(site_map[site]).new(data).coordinates
+      end
+
+      def site_map
+        {
+          'yahoo' => 'YahooGeocoder',
+          'geocoding' => 'Geocoding'
+        }
+      end
+  end
+end

data/lib/sora_geocoding/base.rb

@@ -0,0 +1,31 @@
+require 'timeout'
+
+module SoraGeocoding
+  class Base
+    #
+    # Symbol which is used in configuration to refer to this Lookup.
+    #
+    def handle
+      str = self.class.to_s
+      str[str.rindex(':') + 1..-1].gsub(/([a-z\d]+)([A-Z])/, '\1_\2').downcase.to_sym
+    end
+
+    #
+    # specific config data
+    #
+    def configuration
+      SoraGeocoding.config_for_lookup(handle)
+    end
+
+    #
+    # Raise exception.
+    # Return false if exception not raised.
+    #
+    def raise_error(error, message = nil)
+      exceptions = configuration.always_raise
+      raise error, message if (exceptions == :all) || exceptions.include?(error.is_a?(Class) ? error : error.class)
+
+      false
+    end
+  end
+end

data/lib/sora_geocoding/configuration.rb

@@ -0,0 +1,119 @@
+require 'singleton'
+require 'hash_recursive_merge'
+
+module SoraGeocoding
+  class ConfigurationHash < Hash
+    include HashRecursiveMerge
+
+    def method_missing(method, *args, &block)
+      key?(method) ? self[method] : super
+    end
+
+    def respond_to_missing?(method, include_private)
+      key?(method) ? true : super
+    end
+  end
+
+  #
+  # Configuration options should be set by passing a hash:
+  #
+  #   SoraGeocoding.configure(
+  #     :timeout     => 5,
+  #     :site        => 'yahoo',
+  #     :yahoo_appid => '2a9fsa983jaslfj982fjasd'
+  #   )
+  #
+  def self.configure(options = nil)
+    options ? Configuration.instance.configure(options) : config
+  end
+
+  #
+  # Read-only access to the singleton's config data.
+  #
+  def self.config
+    Configuration.instance.data
+  end
+
+  #
+  # Read-only access to specific config data.
+  #
+  def self.config_for_lookup(lookup_name)
+    data = config.clone
+    data.select! { |key, _value| Configuration::OPTIONS.include?(key) }
+    data.merge!(config[lookup_name]) if config.key?(lookup_name)
+    data
+  end
+
+  class Configuration
+    include Singleton
+
+    OPTIONS = %i[
+      timeout
+      http_headers
+      use_https
+      http_proxy
+      https_proxy
+      basic_auth
+      site
+      yahoo_appid
+      logger_level
+      always_raise
+    ].freeze
+
+    attr_accessor :data
+
+    def self.set_defaults
+      instance.set_defaults
+    end
+
+    OPTIONS.each do |o|
+      define_method o do
+        @data[o]
+      end
+      define_method "#{o}=" do |value|
+        @data[o] = value
+      end
+    end
+
+    def configure(options)
+      @data.rmerge!(options)
+    end
+
+    def initialize
+      @data = SoraGeocoding::ConfigurationHash.new
+      set_defaults
+    end
+
+    def set_defaults
+      # options
+      @data[:timeout]      = 3           # timeout (secs)
+      @data[:http_headers] = {}          # HTTP headers
+      @data[:use_https]    = false       # use HTTPS for requests?
+      @data[:http_proxy]   = nil         # HTTP proxy server (user:pass@host:port)
+      @data[:https_proxy]  = nil         # HTTPS proxy server (user:pass@host:port)
+      @data[:basic_auth]   = {}          # user and password for basic auth ({:user => "user", :password => "password"})
+      @data[:site]         = nil
+      @data[:yahoo_appid]  = nil         # API key for Yahoo Geocoder API
+      @data[:logger_level] = ::Logger::WARN # log level, if kernel logger is used
+
+      # [supports]
+      # - :all
+      # - SocketError
+      # - Timeout::Error
+      @data[:always_raise] = []
+    end
+
+    instance_eval(OPTIONS.map do |option|
+      o = option.to_s
+      <<-INSTANCE_DATA
+      def #{o}
+        instance.data[:#{o}]
+      end
+
+      def #{o}=(value)
+        instance.data[:#{o}] = value
+      end
+      INSTANCE_DATA
+    end.join("\n\n"))
+  end
+end

data/lib/sora_geocoding/exceptions.rb

@@ -0,0 +1,44 @@
+require 'timeout'
+
+module SoraGeocoding
+  class ConfigurationError < StandardError
+  end
+
+  class ResponseParseError < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+  end
+
+  class InvalidRequest < StandardError
+  end
+
+  class RequestDenied < StandardError
+  end
+
+  class PaymentRequiredError < StandardError
+  end
+
+  class ForbiddenError < StandardError
+  end
+
+  class NotFoundError < StandardError
+  end
+
+  class ProxyAuthenticationRequiredError < StandardError
+  end
+
+  class OverQueryLimitError < StandardError
+  end
+
+  class ServiceUnavailable < StandardError
+  end
+
+  class Timeout < ::Timeout::Error
+  end
+
+  class NetworkError < StandardError
+  end
+end