timezone 0.3.1 → 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46a05b3cbaa15e1f491d73af323de8afaa25d1fd
+  data.tar.gz: f8f66464396431dbf25a5e4f2573829a1ac7fe58
+SHA512:
+  metadata.gz: 68fd48be56823ac5a85b6f9c03c7d9a82356e056b6d3d503e5bb6f8b39a3f43d4692e1996929aab3f0eaef409963f49c25d07e9c86229a60d29dc02119564a4a
+  data.tar.gz: 60264e09a76c2a21c10d6cd2cf2c66551c48715dfac8a56b5b4d9568f94a1479adb2e60c185c1ed261133147a8ed343e0cd1108f475a20dd3cb3b9eba37e02fb

data/.gitignore

@@ -5,3 +5,4 @@
 .idea/*
 Gemfile.lock
 pkg/*
+.yardoc/

data/README.markdown

@@ -101,6 +101,27 @@ Finally, by default the **Zone#list** method will order the results by the timez
       c.order_list_by = :title 
     end
 
+## Using Your Own HTTP Client
+
+If you have non-standard http request needs or want to have more control over
+API calls to Geonames, you can write your own very simple http client wrapper
+instead of using the built-in default.
+
+    class MyHTTPClient
+      def initialize(protocol, host)
+      end
+
+      # Return a response object that responds to #body and #code
+      def get(url)
+      end
+    end
+
+    Timezone::Configure.begin do |c|
+      c.http_client = MyHTTPClient
+    end
+
+For an example, see `Timezone::NetHTTPClient` which uses the standard `Net::HTTP` library to perform API calls.
+
 ## Build Status [![Build Status](https://secure.travis-ci.org/panthomakos/timezone.png?branch=master)](http://travis-ci.org/panthomakos/timezone)
 
 ## Code Quality [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/panthomakos/timezone)

data/lib/timezone/configure.rb

@@ -1,22 +1,72 @@
+require 'timezone/net_http_client'
+
 module Timezone
   # Configuration class for the Timezone gem.
   #
-  #   Timezone::Configure.begin do |c| ... end
+  # You'll want to sign up for a geonames username at
+  # {http://www.geonames.org/login Geonames}. Use the username to
+  # configure your application for latitude and longitude based
+  # timezone searches.
+  #
+  # If you aren't going to initialize timezone objects based on lat,lng
+  # then this configuration is not necessary.
   #
-  # c.username = username - the geonames username you use to access the geonames timezone API.
+  # @example
+  #     Timezone::Configure.begin do |c|
+  #       c.url = 'api.geonames.org'
+  #       c.username = 'foo-bar'
+  #     end
   #
-  # Signup for a geonames username at http://www.geonames.org/login. Use that username to configure
-  # your application for latitude and longitude based timezone searches. If you aren't going to
-  # initialize timezone objects based on latitude and longitude then this configuration is not necessary.
   class Configure
+    # The Geonames API URL
+    #
+    # @return [Sting]
+    #   the Geonames API URL ('api.geonames.org')
     def self.url
       @@url ||= 'api.geonames.org'
     end
 
-    def self.url= url
+    # The Geonames API URL
+    #
+    # @param [Sting] url
+    #   the Geonames API URL
+    def self.url=(url)
       @@url = url
     end
 
+    # The Geonames API HTTP protocol
+    #
+    # @param [String] protocol
+    #   the Geonames API HTTP procotol
+    def self.protocol=(protocol)
+      @@protocol = protocol
+    end
+
+    # The Geonames API HTTP protocol
+    #
+    # @return [Sting]
+    #   the Geonames API URL ('api.geonames.org')
+    def self.protocol
+      @protocol ||= 'http'
+    end
+
+    # The HTTP client that handles requests to geonames
+    #
+    # @return [Object]
+    #   the HTTP client ({Timezone::NetHTTPClient Timezone::NetHTTPClient})
+    def self.http_client
+      @@http_client ||= Timezone::NetHTTPClient
+    end
+
+    # The HTTP client that handles requests to geonames
+    #
+    # @param [Object] client
+    #   the HTTP client that handles requests to geonames
+    #
+    def self.http_client=(client)
+      @@http_client = client
+    end
+
     def self.username
       @@username
     end
@@ -53,6 +103,5 @@ module Timezone
     def self.order_list_by=(order)
       @@order_by = order
     end
-
   end
 end

data/lib/timezone/net_http_client.rb

@@ -0,0 +1,23 @@
+require 'uri'
+require 'net/http'
+
+module Timezone
+  # A basic HTTP Client that handles requests to Geonames. 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
+  #     end
+  class NetHTTPClient
+    def initialize(protocol, host)
+      uri = URI.parse("#{protocol}://#{host}")
+      @http = Net::HTTP.new(uri.host, uri.port)
+    end
+
+    def get(url)
+      @http.request(Net::HTTP::Get.new(url))
+    end
+  end
+end

data/lib/timezone/version.rb

@@ -1,3 +1,3 @@
 module Timezone
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/lib/timezone/zone.rb

@@ -1,7 +1,7 @@
 require 'json'
 require 'date'
 require 'time'
-require 'net/http'
+
 require File.expand_path(File.dirname(__FILE__) + '/error')
 require File.expand_path(File.dirname(__FILE__) + '/configure')
 require File.expand_path(File.dirname(__FILE__) + '/active_support')
@@ -146,9 +146,17 @@ module Timezone
 
     def timezone_id lat, lon #:nodoc:
       begin
-        response = Net::HTTP.get(Timezone::Configure.url, "/timezoneJSON?lat=#{lat}&lng=#{lon}&username=#{Timezone::Configure.username}")
-        JSON.parse(response)['timezoneId']
-      rescue Exception => e
+        response = http_client.get("/timezoneJSON?lat=#{lat}&lng=#{lon}&username=#{Timezone::Configure.username}")
+        return nil unless response.code =~ /^2\d\d$/
+
+        data = JSON.parse(response.body)
+
+        if data['status'] && data['status']['value'] == 18
+          raise Timezone::Error::GeoNames, "api limit reached"
+        end
+
+        return data['timezoneId']
+      rescue => e
         raise Timezone::Error::GeoNames, e.message
       end
     end
@@ -161,5 +169,11 @@ module Timezone
       end
     end
 
+    private
+
+    def http_client #:nodoc:
+      @http_client ||= Timezone::Configure.http_client.new(
+        Timezone::Configure.protocol, Timezone::Configure.url)
+    end
   end
 end

data/test/mocks/api_limit_reached.txt

@@ -0,0 +1 @@
+{"status":{"message":"the daily limit of 30000 credits for XXXXX has been exceeded. Please throttle your requests or use the commercial service.","value":18}}

data/test/mocks/lat_lon_coords.txt

@@ -0,0 +1 @@
+{"time":"2013-10-29 15:30","countryName":"Australia","sunset":"2013-10-30 19:42","rawOffset":9.5,"dstOffset":9.5,"countryCode":"AU","gmtOffset":10.5,"lng":138.477041423321,"sunrise":"2013-10-30 06:17","timezoneId":"Australia/Adelaide","lat":-34.92771808058}

data/test/timezone_test.rb

@@ -1,6 +1,7 @@
 require 'timezone'
 require 'timezone/zone'
 require 'test/unit'
+require "mocha/setup"
 require 'timecop'
 
 class TimezoneTest < Test::Unit::TestCase
@@ -137,12 +138,48 @@ class TimezoneTest < Test::Unit::TestCase
     assert_equal local.to_i, timezone.time(utc).to_i
   end
 
+  class HTTPTestClient
+    class << self ; attr_accessor :body ; end
+
+    Response = Struct.new(:body) do
+      def code ; '200' ; end
+    end
+
+    def initialize(protocol, host)
+    end
+
+    def get(url)
+      HTTPTestClient::Response.new(self.class.body)
+    end
+  end
+
   def test_using_lat_lon_coordinates
-    Timezone::Configure.begin { |c| c.username = 'timezone' }
+    mock_path = File.expand_path(File.join(File.dirname(__FILE__), 'mocks'))
+    HTTPTestClient.body = File.open(mock_path + '/lat_lon_coords.txt').read
+
+    Timezone::Configure.begin do |c|
+      c.http_client = HTTPTestClient
+      c.username = 'timezone'
+    end
+
     timezone = Timezone::Zone.new :latlon => [-34.92771808058, 138.477041423321]
     assert_equal 'Australia/Adelaide', timezone.zone
   end
 
+  def test_api_limit_read_lat_lon_coordinates
+    mock_path = File.expand_path(File.join(File.dirname(__FILE__), 'mocks'))
+    HTTPTestClient.body = File.open(mock_path + '/api_limit_reached.txt').read
+
+    Timezone::Configure.begin do |c|
+      c.http_client = HTTPTestClient
+      c.username = 'timezone'
+    end
+
+    assert_raise Timezone::Error::GeoNames, 'api limit reached' do
+      Timezone::Zone.new :latlon => [-34.92771808058, 138.477041423321]
+    end
+  end
+
   def test_australian_timezone_with_dst
     timezone = Timezone::Zone.new :zone => 'Australia/Adelaide'
     utc = Time.utc(2010, 12, 23, 19, 37, 15)

data/timezone.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/panthomakos/timezone"
   s.summary     = "timezone-#{Timezone::VERSION}"
   s.description = %q{A simple way to get accurate current and historical timezone information based on zone or latitude and longitude coordinates. This gem uses the tz database (http://www.twinsun.com/tz/tz-link.htm) for historical timezone information. It also uses the geonames API for timezone latitude and longitude lookup (http://www.geonames.org/export/web-services.html).}
+  s.license     = 'MIT'
 
   s.rubyforge_project = "timezone"
 
@@ -24,4 +25,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rake')
   s.add_development_dependency('minitest', '~> 4.0')
   s.add_development_dependency('timecop')
+  s.add_development_dependency('mocha')
 end

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: timezone
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.3.2
 platform: ruby
 authors:
 - Pan Thomakos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-21 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,17 +41,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A simple way to get accurate current and historical timezone information
@@ -550,6 +557,7 @@ files:
 - lib/timezone/active_support.rb
 - lib/timezone/configure.rb
 - lib/timezone/error.rb
+- lib/timezone/net_http_client.rb
 - lib/timezone/parser.rb
 - lib/timezone/parser/data.rb
 - lib/timezone/parser/link.rb
@@ -565,6 +573,8 @@ files:
 - lib/timezone/zone.rb
 - test/data/Helsinki_rules_without_timestamps.json
 - test/data/asia
+- test/mocks/api_limit_reached.txt
+- test/mocks/lat_lon_coords.txt
 - test/timezone/parser/rule/on_rules_test.rb
 - test/timezone/parser/rule_test.rb
 - test/timezone/parser/zone/data_generator_test.rb
@@ -574,33 +584,35 @@ files:
 - test/timezone_test.rb
 - timezone.gemspec
 homepage: http://github.com/panthomakos/timezone
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: timezone
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
-summary: timezone-0.3.1
+specification_version: 4
+summary: timezone-0.3.2
 test_files:
 - test/data/Helsinki_rules_without_timestamps.json
 - test/data/asia
+- test/mocks/api_limit_reached.txt
+- test/mocks/lat_lon_coords.txt
 - test/timezone/parser/rule/on_rules_test.rb
 - test/timezone/parser/rule_test.rb
 - test/timezone/parser/zone/data_generator_test.rb