Contents

require 'timezone/error'

module Timezone
  module Lookup
    # @abstract Subclass and override {#lookup} to implement
    #   a custom Lookup class.
    class Basic
      attr_reader :config

      # @param config [#protocol, #url, #request_handler] a configuration
      #   object
      def initialize(config)
        if config.protocol.nil?
          raise(::Timezone::Error::InvalidConfig, 'missing protocol')
        end

        if config.url.nil?
          raise(::Timezone::Error::InvalidConfig, 'missing url')
        end

        @config = config
      end

      # Returns an instance of the request handler.
      #
      # @return [#get] an instance of a request handler
      def client
        # TODO: Remove http_client once on 1.0.0
        @client ||=
          if !config.request_handler.nil?
            config.request_handler.new(config)
          else
            config.http_client.new(config.protocol, config.url)
          end
      end

      # Returns a timezone name for a given lat, long pair.
      #
      # @param lat [Double] latitude coordinate
      # @param long [Double] longitude coordinate
      # @return [String] the timezone name
      # @return [nil] if the lat, long pair does not resolve to an
      #   actual timezone
      # @raise [Timezone::Error::Base] if an error occurred while
      #   while performing the lookup
      def lookup(_lat, _long)
        raise NoMethodError, 'lookup is not implemented'
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
timezone-0.99.2	lib/timezone/lookup/basic.rb
timezone-0.99.1	lib/timezone/lookup/basic.rb
timezone-0.99.0	lib/timezone/lookup/basic.rb