timezone 0.3.11 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5db8fcfd27b22dcfad4d48baee5f73bcbda9926
-  data.tar.gz: 5154a1a3edec1bfb2c4b6a0d5afce051b0f1b890
+  metadata.gz: 9d2bc909888147c6c7fa503b834d851be11d210d
+  data.tar.gz: e4361fd7832d57ebfd1d54d9e5846badeaf7c489
 SHA512:
-  metadata.gz: 4913225fff663c6223f4c5fd0167bfe27a3f22561131439ab6a76bdab6f45c819309cb7f516e8e54ca18800a15c7db06242aa7a62a2c47e8c0152be12494d743
-  data.tar.gz: 99f0da933742fd40ead23cd7e6d6a15749adddc6b673dd961bebe03f5647bc7dbc7c471bdc7a1a150243b2b0e6576d873e51bd579dcdfc0c45319cf745bb6fcb
+  metadata.gz: a6e23b7d2937984bc404b826bca5f3d2ef6e4f05d05f42cf940c2e71de5edf10be6054561112c209ddcbac61d9a4b0cc3e0eb955e974da95c42629dfb62c4222
+  data.tar.gz: 982b85508bd4b1691c37c0b67036df691c75c9b5b1c821bc99d76187c967ee40e60d32a47b4e87af86d852b3beb03b209c9994475e18c5e2eb3fc460e95097a7

data/CHANGES.markdown

@@ -1,3 +1,7 @@
+# 0.4.0
+
+* Added Google Maps for Work signing support. (appfolio)
+
 # 0.3.11
 
 * Fixed `active_support_time_zone` to only include the 149 `ActiveSupport`

data/README.markdown

@@ -78,6 +78,7 @@ Next, add the following to your application.rb file, or before you perform a coo
 
     Timezone::Configure.begin do |c|
       c.google_api_key = 'your_google_api_key_goes_here'
+      c.google_client_id = 'your_google_client_id' # only if using 'Google for Work'
     end
 
 Finally, for either geonames or Google implementation, pass the coordinates to your timezone initialization function.

data/lib/timezone/configure.rb

@@ -40,6 +40,22 @@ module Timezone
       @google_api_key = api_key
     end
 
+    # The Google Client ID (for enterprise)
+    #
+    # @return [String]
+    #   the Google Client ('abc123')
+    def self.google_client_id
+      @google_client_id ||= nil
+    end
+
+    # Google Client ID (for enterprise)
+    #
+    # @param [String] client
+    #   the Google Client
+    def self.google_client_id=(client)
+      @google_client_id = client
+    end
+
     # Use Google API if key has been set
     #
     # @return [Boolean]
@@ -47,6 +63,13 @@ module Timezone
       !!google_api_key
     end
 
+    # Sign Google API request if client given (for enterprise)
+    #
+    # @return [Boolean]
+    def self.use_google_enterprise?
+      use_google? && !!google_client_id
+    end
+
     def self.lookup
       use_google? ? google_lookup : geonames_lookup
     end

data/lib/timezone/lookup/google.rb

@@ -2,6 +2,9 @@ require 'timezone/lookup/basic'
 require 'timezone/error'
 require 'json'
 require 'uri'
+require 'base64'
+require 'openssl'
+require 'cgi'
 
 module Timezone
   module Lookup
@@ -16,6 +19,10 @@ module Timezone
       def lookup(lat,lng)
         response = client.get(url(lat,lng))
 
+        if response.code == '403'
+          raise(Timezone::Error::Google, '403 Forbidden')
+        end
+
         return unless response.code =~ /^2\d\d$/
         data = JSON.parse(response.body)
 
@@ -30,13 +37,27 @@ module Timezone
 
       private
 
+      def authorize(url)
+        if config.use_google_enterprise?
+          url += "&client=#{CGI.escape(config.google_client_id)}"
+
+          sha1 = OpenSSL::Digest.new('sha1')
+          binary_key = Base64.decode64(config.google_api_key.tr('-_','+/'))
+          binary_signature = OpenSSL::HMAC.digest(sha1, binary_key, url)
+          signature = Base64.encode64(binary_signature).tr('+/','-_').strip
+
+          url + "&signature=#{signature}"
+        else
+          url + "&key=#{config.google_api_key}"
+        end
+      end
+
       def url(lat,lng)
-          query = URI.encode_www_form(
-            'location' => "#{lat},#{lng}",
-            'timestamp' => Time.now.to_i,
-            'key' => config.google_api_key)
+        query = URI.encode_www_form(
+          'location' => "#{lat},#{lng}",
+          'timestamp' => Time.now.to_i)
 
-          "/maps/api/timezone/json?#{query}"
+        authorize("/maps/api/timezone/json?#{query}")
       end
     end
   end

data/lib/timezone/version.rb

@@ -1,3 +1,3 @@
 module Timezone
-  VERSION = "0.3.11"
+  VERSION = "0.4.0"
 end

data/test/google_lookup_test.rb

@@ -1,13 +1,14 @@
 require 'timezone/configure'
 require 'timezone/lookup/google'
 require 'minitest/autorun'
+require 'timecop'
 require_relative 'http_test_client'
 
 class GoogleLookupTest < ::Minitest::Unit::TestCase
   def setup
     Timezone::Configure.begin do |c|
       c.http_client = HTTPTestClient
-      c.google_api_key = '123abc'
+      c.google_api_key = 'MTIzYWJj'
     end
   end
 
@@ -23,7 +24,7 @@ class GoogleLookupTest < ::Minitest::Unit::TestCase
     Timezone::Configure.begin{ |c| c.google_api_key = nil }
     assert_raises(::Timezone::Error::InvalidConfig){ lookup }
   ensure
-    Timezone::Configure.begin{ |c| c.google_api_key = '123abc' }
+    Timezone::Configure.begin{ |c| c.google_api_key = 'MTIzYWJj' }
   end
 
   def test_google_using_lat_lon_coordinates
@@ -39,6 +40,29 @@ class GoogleLookupTest < ::Minitest::Unit::TestCase
     end
   end
 
+  def test_url_non_enterprise
+    Timecop.freeze(Time.at(1433347661)) do
+      result = lookup.send(:url, '123', '123')
+      assert_equal "/maps/api/timezone/json?location=123%2C123&timestamp=1433347661&key=MTIzYWJj", result
+    end
+  end
+
+  def test_url_enterprise
+    Timezone::Configure.begin do |c|
+      c.google_client_id = '123&asdf'
+    end
+
+    Timecop.freeze(Time.at(1433347661)) do
+      result = lookup.send(:url, '123', '123')
+      assert_equal '/maps/api/timezone/json?location=123%2C123&timestamp=1433347661&client=123%26asdf&signature=B1TNSSvIw9Wvf_ZjjW5uRzGm4F4=', result
+    end
+
+  ensure
+    Timezone::Configure.begin do |c|
+      c.google_client_id = nil
+    end
+  end
+
   private
 
   def mock_path

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timezone
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.4.0
 platform: ruby
 authors:
 - Pan Thomakos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -721,7 +721,7 @@ rubyforge_project: timezone
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: timezone-0.3.11
+summary: timezone-0.4.0
 test_files:
 - test/basic_lookup_test.rb
 - test/data/Helsinki_rules_without_timestamps.json