timezone 0.6.0 → 0.99.0

data/lib/timezone/lookup/test.rb

@@ -3,26 +3,26 @@ require 'timezone/error'
 
 module Timezone
   module Lookup
+    # @!visibility private
     class Test < ::Timezone::Lookup::Basic
-      def initialize(config)
+      def initialize(_config)
         @stubs = {}
-        # Regular config w/ protocol and URL checks does not apply for stubs.
       end
 
-      def stub(lat, lng, timezone)
-        @stubs[key(lat, lng)] = timezone
+      def stub(lat, long, timezone)
+        @stubs[key(lat, long)] = timezone
       end
 
-      def lookup(lat, lng)
-        @stubs.fetch(key(lat, lng)) do
+      def lookup(lat, long)
+        @stubs.fetch(key(lat, long)) do
           raise ::Timezone::Error::Test, 'missing stub'
         end
       end
 
       private
 
-      def key(lat, lng)
-        "#{lat},#{lng}"
+      def key(lat, long)
+        "#{lat},#{long}"
       end
     end
   end

data/lib/timezone/lookup.rb

@@ -1,2 +1,70 @@
 require 'timezone/lookup/geonames'
 require 'timezone/lookup/google'
+require 'timezone/lookup/test'
+require 'timezone/net_http_client'
+
+module Timezone
+  # Configure timezone lookups.
+  module Lookup
+    class << self
+      MISSING_LOOKUP = 'No lookup configured'.freeze
+      private_constant :MISSING_LOOKUP
+
+      # Returns the lookup object
+      #
+      # @return [#lookup] the lookup object
+      # @raise [Timezone::Error::InvalidConfig] if the lookup has not
+      #   been configured
+      def lookup
+        @lookup || raise(::Timezone::Error::InvalidConfig, MISSING_LOOKUP)
+      end
+
+      # Configure a lookup object
+      #
+      # @param lookup [:google, :geonames, :test] use a built-in lookup
+      # @param lookup [Class] a custom lookup class
+      # @yieldparam [OpenStruct] an object on which to set configuration
+      #   options
+      #
+      # @return [#lookup] the lookup object
+      def config(lookup)
+        options = OptionSetter.new(lookup)
+        yield(options.config) if block_given?
+        @lookup = options.make_lookup
+      end
+
+      # Responsible for collecting options in the DSL and creating
+      # lookup objects using those options.
+      class OptionSetter
+        LOOKUPS = {
+          geonames: ::Timezone::Lookup::Geonames,
+          google: ::Timezone::Lookup::Google,
+          test: ::Timezone::Lookup::Test
+        }.freeze
+
+        INVALID_LOOKUP = 'Invalid lookup specified'.freeze
+
+        attr_reader :config
+
+        def initialize(lookup)
+          if lookup.is_a?(Symbol)
+            lookup = LOOKUPS.fetch(lookup) do
+              raise ::Timezone::Error::InvalidConfig, INVALID_LOOKUP
+            end
+          end
+
+          @lookup = lookup
+
+          @config = OpenStruct.new
+        end
+
+        def make_lookup
+          config.request_handler ||= ::Timezone::NetHTTPClient
+          @lookup.new(config)
+        end
+      end
+
+      private_constant :OptionSetter
+    end
+  end
+end

data/lib/timezone/net_http_client.rb

@@ -2,20 +2,34 @@ require 'uri'
 require 'net/http'
 
 module Timezone
-  # A basic HTTP Client that handles requests to Geonames and Google. You
-  # can create your own version of this class if you want to use a proxy
-  # or a different http library such as faraday but be aware that the 
-  # Google timezone API uses https protocol.
+  # @!visibility private
+  # A basic HTTP Client that handles requests to Geonames and Google.
+  #
+  # You can create your own version of this class if you want to use
+  # a proxy or a different http library such as faraday.
   #
   # @example
-  #     Timezone::Configure.begin do |c|
-  #       c.http_client = Timezone::NetHTTPClient
+  #     Timezone::Lookup.config(:google) do |c|
+  #       c.api_key = 'foo'
+  #       c.request_handler = Timezone::NetHTTPClient
   #     end
+  #
   class NetHTTPClient
-    def initialize(protocol, host)
-      uri = URI.parse("#{protocol}://#{host}")
+    def initialize(protocol, url = nil)
+      # TODO: Remove once on 1.0.0 #initialize(config)
+      config = protocol
+
+      if url
+        config = OpenStruct.new
+        config.protocol = protocol
+        config.url = url
+      end
+
+      uri = URI.parse("#{config.protocol}://#{config.url}")
       @http = Net::HTTP.new(uri.host, uri.port)
-      @http.use_ssl = (protocol == 'https')
+      @http.open_timeout = config.open_timeout || 5
+      @http.read_timeout = config.read_timeout || 5
+      @http.use_ssl = (config.protocol == 'https'.freeze)
     end
 
     def get(url)

data/lib/timezone/nil_zone.rb

@@ -0,0 +1,32 @@
+module Timezone
+  # A "nil" timezone object - representative of a missing timezone.
+  class NilZone
+    # A stubbed timezone name.
+    #
+    # @return [nil]
+    def name
+      nil
+    end
+
+    # A stubbed timezone display string.
+    #
+    # @return [String]
+    def to_s
+      'NilZone'.freeze
+    end
+
+    # A stubbed timezone debug string.
+    #
+    # @return [String]
+    def inspect
+      '#<Timezone::NilZone>'.freeze
+    end
+
+    # If this is a valid timezone.
+    #
+    # @return [false]
+    def valid?
+      false
+    end
+  end
+end

data/lib/timezone/parser.rb

@@ -1,6 +1,8 @@
 require 'time'
 
 module Timezone
+  # @!visibility private
+  # Responsible for parsing timezone data into an exportable format.
   class Parser
     LINE = /\s*(.+)\s*=\s*(.+)\s*isdst=(\d+)\s*gmtoff=([\+\-]*\d+)/
 
@@ -19,15 +21,14 @@ module Timezone
       end
     end
 
-    private
-
+    # Represents a single timezone data file line.
     class Line
       attr_accessor :source, :name, :dst, :offset
 
       SOURCE_FORMAT = '%a %b %e %H:%M:%S %Y %Z'.freeze
 
       def initialize(match)
-        self.source = Time.strptime(match[1]+'C', SOURCE_FORMAT).to_i
+        self.source = Time.strptime(match[1] + 'C', SOURCE_FORMAT).to_i
         self.name = match[2].split(' ').last
         self.dst = match[3].to_i
         self.offset = match[4].to_i
@@ -42,8 +43,12 @@ module Timezone
       end
     end
 
+    private_constant :Line
+
+    private
+
     def parse(file)
-      zone = file.gsub("#{zoneinfo}/right/",'')
+      zone = file.gsub("#{zoneinfo}/right/", '')
       print "Parsing #{zone}... "
       data = zdump(zone)
 
@@ -51,7 +56,7 @@ module Timezone
       result = []
 
       data.split("\n").each do |line|
-        match = line.gsub('right/'+zone+' ','').match(LINE)
+        match = line.gsub('right/' + zone + ' ', '').match(LINE)
         next if match.nil?
 
         line = Line.new(match)

data/lib/timezone/version.rb

@@ -1,3 +1,4 @@
 module Timezone
-  VERSION = '0.6.0'.freeze
+  # The current gem version.
+  VERSION = '0.99.0'.freeze
 end