sora_geocoding 0.1.0

data/lib/sora_geocoding/logger.rb

@@ -0,0 +1,59 @@
+require 'logger'
+require 'singleton'
+
+module SoraGeocoding
+  def self.log(level, message)
+    Logger.instance.log(level, message)
+  end
+
+  #
+  # Logger
+  #
+  class Logger
+    include Singleton
+
+    LOG_LEVEL = {
+      debug: ::Logger::DEBUG,
+      info: ::Logger::INFO,
+      warn: ::Logger::WARN,
+      error: ::Logger::ERROR,
+      fatal: ::Logger::FATAL
+    }.freeze
+
+    def log(level, message)
+      raise StandardError, 'SoraGeocoding tried to log a message with an invalid log level.' unless valid_level?(level)
+
+      if respond_to?(:add)
+        add(LOG_LEVEL[level], message)
+      else
+        raise SoraGeocoding::ConfigurationError, 'Please specify valid logger for SoraGeocoding. ' \
+                                                 'Logger specified must respond to `add(level, message)`.'
+      end
+      nil
+    end
+
+    def add(level, message)
+      return unless log_message_at_level?(level)
+
+      case level
+      when ::Logger::DEBUG, ::Logger::INFO
+        puts message
+      when ::Logger::WARN
+        warn message
+      when ::Logger::ERROR
+        raise message
+      when ::Logger::FATAL
+        raise message
+      end
+    end
+
+    private
+      def valid_level?(level)
+        LOG_LEVEL.keys.include?(level)
+      end
+
+      def log_message_at_level?(level)
+        level >= SoraGeocoding.config.logger_level
+      end
+  end
+end

data/lib/sora_geocoding/query.rb

@@ -0,0 +1,42 @@
+module SoraGeocoding
+  class Query < Base
+    attr_accessor :query, :opts, :url, :req
+
+    def initialize(query, options = {})
+      self.query = query
+      self.opts = configure(options)
+      self.url = SoraGeocoding::Url.new(query)
+      self.req = SoraGeocoding::Request.new
+    end
+
+    def to_s
+      query
+    end
+
+    def configure(func_opts)
+      SoraGeocoding.configure(func_opts)
+    end
+
+    def execute
+      data = req.fetch_data(url.get)
+      SoraGeocoding.log(:error, "The data could not be retrieved from #{url.site}") if data.nil?
+
+      {
+        site: url.site,
+        data: data.to_s
+      }
+    rescue StandardError
+      if url.site == 'yahoo'
+        initialize_geocoding
+        retry
+      end
+      SoraGeocoding.log(:warn, 'The information could not be retrieved. Please change your address.')
+    end
+
+    private
+      def initialize_geocoding
+        opts[:site] = 'geocoding'
+        initialize(query, opts)
+      end
+  end
+end

data/lib/sora_geocoding/request.rb

@@ -0,0 +1,146 @@
+require 'net/http'
+require 'net/https'
+require 'open-uri'
+require 'rexml/document'
+
+module SoraGeocoding
+  class Request < Base
+    def parse_xml(data)
+      REXML::Document.new(data)
+    rescue StandardError
+      unless raise_error(ResponseParseError.new(data))
+        SoraGeocoding.log(:warn, "API's response was not valid XML")
+        SoraGeocoding.log(:debug, "Raw response: #{data}")
+      end
+    end
+
+    def parse_raw_data(raw_data)
+      parse_xml(raw_data)
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def check_response_for_errors!(response)
+      if response.code.to_i == 400
+        raise_error(SoraGeocoding::InvalidRequest) ||
+          SoraGeocoding.log(:warn, 'API error: 400 Bad Request')
+      elsif response.code.to_i == 401
+        raise_error(SoraGeocoding::RequestDenied) ||
+          SoraGeocoding.log(:warn, 'API error: 401 Unauthorized')
+      elsif response.code.to_i == 402
+        raise_error(SoraGeocoding::PaymentRequiredError) ||
+          SoraGeocoding.log(:warn, 'API error: 402 Payment Required')
+      elsif response.code.to_i == 403
+        raise_error(SoraGeocoding::ForbiddenError) ||
+          SoraGeocoding.log(:warn, 'API error: 403 Forbidden')
+      elsif response.code.to_i == 404
+        raise_error(SoraGeocoding::NotFoundError) ||
+          SoraGeocoding.log(:warn, 'API error: 404 Not Found')
+      elsif response.code.to_i == 407
+        raise_error(SoraGeocoding::ProxyAuthenticationRequiredError) ||
+          SoraGeocoding.log(:warn, 'API error: 407 Proxy Authentication Required')
+      elsif response.code.to_i == 429
+        raise_error(SoraGeocoding::OverQueryLimitError) ||
+          SoraGeocoding.log(:warn, 'API error: 429 Too Many Requests')
+      elsif response.code.to_i == 503
+        raise_error(SoraGeocoding::ServiceUnavailable) ||
+          SoraGeocoding.log(:warn, 'API error: 503 Service Unavailable')
+      end
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+    def fetch_data(query)
+      parse_raw_data(fetch_raw_data(query))
+    rescue SocketError => e
+      raise_error(e) || SoraGeocoding.log(:warn, 'API connection cannot be established.')
+    rescue Errno::ECONNREFUSED => e
+      raise_error(e) || SoraGeocoding.log(:warn, 'API connection refused.')
+    rescue SoraGeocoding::NetworkError => e
+      raise_error(e) || SoraGeocoding.log(:warn, 'API connection is either unreacheable or reset by the peer')
+    rescue SoraGeocoding::Timeout => e
+      raise_error(e) || SoraGeocoding.log(:warn, 'API not responding fast enough ' \
+        '(use SoraGeocoding.configure(:timeout => ...) to set limit).')
+    end
+
+    #
+    # Make an HTTP(S) request to return the response object.
+    #
+    # rubocop:disable Metrics/AbcSize
+    def make_api_request(query_url)
+      uri = URI.parse(query_url)
+      SoraGeocoding.log(:debug, "HTTP request being made for #{uri}")
+      http_client.start(
+        uri.host,
+        uri.port,
+        use_ssl: use_ssl?(uri.port),
+        open_timeout: configuration.timeout,
+        read_timeout: configuration.timeout
+      ) do |client|
+        configure_ssl!(client) if use_ssl?
+        req = Net::HTTP::Get.new(uri.request_uri, configuration.http_headers)
+        if configuration.basic_auth[:user] && configuration.basic_auth[:password]
+          req.basic_auth(configuration.basic_auth[:user], configuration.basic_auth[:password])
+        end
+        client.request(req)
+      end
+    rescue Timeout::Error
+      raise SoraGeocoding::Timeout
+    rescue Errno::EHOSTUNREACH, Errno::ETIMEDOUT, Errno::ENETUNREACH, Errno::ECONNRESET
+      raise SoraGeocoding::NetworkError
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    #
+    # Detect if you are using ssl
+    #
+    def use_ssl?(http_port = nil)
+      if (http_port == 443) || (supported_protocols == [:https])
+        true
+      elsif supported_protocols == [:http]
+        false
+      else
+        configuration.use_https
+      end
+    end
+
+    def configure_ssl!(client); end
+
+    #
+    # Generate a string of http, https or protocol.
+    #
+    def protocol
+      'http' + (use_ssl? ? 's' : '')
+    end
+
+    #
+    # Make HTTP requests.
+    #
+    def http_client
+      proxy = configuration.send("#{protocol}_proxy")
+      if proxy
+        proxy_url = proxy =~ /^#{protocol}/ ? proxy : protocol + '://' + proxy
+        begin
+          uri = URI.parse(proxy_url)
+        rescue URI::InvalidURIError
+          raise ConfigurationError, "Error parsing #{protocol.upcase} proxy URL: '#{proxy_url}'"
+        end
+        Net::HTTP::Proxy(uri.host, uri.port, uri.user, uri.password)
+      else
+        Net::HTTP
+      end
+    end
+
+    #
+    # Supported Protocols
+    #
+    def supported_protocols
+      %i[http https]
+    end
+
+    private
+      def fetch_raw_data(query)
+        response = make_api_request(query)
+        check_response_for_errors!(response)
+        response.body
+      end
+  end
+end

data/lib/sora_geocoding/results/base.rb

@@ -0,0 +1,28 @@
+require 'rexml/document'
+
+module SoraGeocoding
+  module Results
+    #
+    # The Foundation for Returning Results
+    #
+    class Base
+      attr_accessor :data
+
+      def initialize(data)
+        @data = REXML::Document.new(data)
+      end
+
+      def coordinates
+        { lat: @data['lat'], lon: @data['lon'] }
+      end
+
+      def latitude
+        coordinates[:lat]
+      end
+
+      def longitude
+        coordinates[:lon]
+      end
+    end
+  end
+end

data/lib/sora_geocoding/results/geocoding.rb

@@ -0,0 +1,27 @@
+require 'sora_geocoding/results/base'
+
+module SoraGeocoding
+  module Results
+    #
+    # get the latitude and longitude of the Geocoding API
+    #
+    class Geocoding < Base
+      def coordinates
+        check_data_for_errors!
+
+        common = '/result/coordinate'
+        lat = @data.elements["#{common}/lat"].get_text
+        lon = @data.elements["#{common}/lng"].get_text
+        { lat: lat, lon: lon }
+      end
+
+      def check_data_for_errors!
+        error = @data.elements['/result/error']
+        return unless error
+
+        code = error.get_text.to_s
+        SoraGeocoding.log(:error, "Geocoding API error: #{code} Zero Results")
+      end
+    end
+  end
+end

data/lib/sora_geocoding/results/yahoo_geocoder.rb

@@ -0,0 +1,26 @@
+require 'sora_geocoding/results/base'
+
+module SoraGeocoding
+  module Results
+    #
+    # get the latitude and longitude of the Yahoo! Geocoder API
+    #
+    class YahooGeocoder < Base
+      def coordinates
+        check_data_for_errors!
+        lonlat = @data.elements['/YDF/Feature/Geometry/Coordinates'].get_text.to_s.split(',')
+        { lat: lonlat[1], lon: lonlat[0] }
+      end
+
+      def check_data_for_errors!
+        if @data.elements['/Error']
+          message = @data.elements['/Error/Message'].get_text.to_s
+          code = @data.elements['/Error/Code'].get_text.to_s
+          SoraGeocoding.log(:error, "Yahoo Geocoder API error: #{code} #{message}")
+        elsif @data.elements['/YDF'].attributes['totalResultsReturned'].to_i < 1
+          SoraGeocoding.log(:error, 'Yahoo Geocoder API error: 001 Zero Results')
+        end
+      end
+    end
+  end
+end

data/lib/sora_geocoding/url.rb

@@ -0,0 +1,64 @@
+require 'open-uri'
+require 'sora_geocoding/base'
+
+module SoraGeocoding
+  #
+  # generate url
+  #
+  class Url < Base
+    attr_accessor :site
+
+    BASE_YAHOO_URL = 'https://map.yahooapis.jp/geocode/V1/geoCoder'.freeze
+    BASE_GEOCODING_URL = 'https://www.geocoding.jp/api/'.freeze
+
+    def initialize(query)
+      @yahoo_appid = configuration.yahoo_appid
+      @site = configuration.site
+      @query = query
+    end
+
+    def get
+      switch_site
+      select
+    end
+
+    private
+      def select
+        if @yahoo_appid.nil? || @site == 'geocoding'
+          geocoding
+        elsif @site.nil? || @site == 'yahoo'
+          yahoo
+        end
+      end
+
+      def switch_site
+        if @yahoo_appid.nil? || @site == 'geocoding'
+          @site = 'geocoding'
+        elsif @site.nil? || @site == 'yahoo'
+          @site = 'yahoo'
+        else
+          raise 'Please specify the correct site.'
+        end
+      end
+
+      def yahoo
+        params = {
+          appid: @yahoo_appid,
+          query: @query,
+          results: '1',
+          detail: 'full',
+          output: 'xml'
+        }
+        "#{BASE_YAHOO_URL}?#{encode_uri(params)}"
+      end
+
+      def geocoding
+        params = { q: @query }
+        "#{BASE_GEOCODING_URL}?#{encode_uri(params)}"
+      end
+
+      def encode_uri(params)
+        URI.encode_www_form(params)
+      end
+  end
+end

data/lib/sora_geocoding/version.rb

@@ -0,0 +1,3 @@
+module SoraGeocoding
+  VERSION = '0.1.0'.freeze
+end

data/sora_geocoding.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sora_geocoding/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sora_geocoding'
+  spec.version       = SoraGeocoding::VERSION
+  spec.authors       = ['hirontan']
+  spec.email         = ['hirontan@sora.flights']
+
+  spec.summary       = 'Get the latitude and longitude from the Geocoding API and the Yahoo! Geocoder API.'
+  spec.description   = '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.'
+  spec.homepage      = 'https://rubygems.org/gems/sora_geocoding'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/hirontan/sora_geocoding'
+  spec.metadata['changelog_uri'] = 'https://github.com/hirontan/sora_geocoding/blob/master/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: sora_geocoding
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hirontan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: |-
+  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.
+email:
+- hirontan@sora.flights
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/hash_recursive_merge.rb
+- lib/sora_geocoding.rb
+- lib/sora_geocoding/base.rb
+- lib/sora_geocoding/configuration.rb
+- lib/sora_geocoding/exceptions.rb
+- lib/sora_geocoding/logger.rb
+- lib/sora_geocoding/query.rb
+- lib/sora_geocoding/request.rb
+- lib/sora_geocoding/results/base.rb
+- lib/sora_geocoding/results/geocoding.rb
+- lib/sora_geocoding/results/yahoo_geocoder.rb
+- lib/sora_geocoding/url.rb
+- lib/sora_geocoding/version.rb
+- sora_geocoding.gemspec
+homepage: https://rubygems.org/gems/sora_geocoding
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/sora_geocoding
+  source_code_uri: https://github.com/hirontan/sora_geocoding
+  changelog_uri: https://github.com/hirontan/sora_geocoding/blob/master/CHANGELOG.md
+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.7.6.2
+signing_key: 
+specification_version: 4
+summary: Get the latitude and longitude from the Geocoding API and the Yahoo! Geocoder
+  API.
+test_files: []