google_timezone 0.0.1 → 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a58b018c388299fe698740b490d9d51bbb5ca56c8f8e37cbe7b32df1f72dabe9
+  data.tar.gz: 545603d1681053cb178989dc65a522c6abcb4f564a01353116fa104aac8f9f47
+SHA512:
+  metadata.gz: 190a8ac37e5ac71de5134726dca3812f639191391751edfa9f5e4f13bf18ea61d185413145cafdfa1f81d284e750315c606d2a404d516169c63fd6a67483a6f7
+  data.tar.gz: 1e4177b6f3934d4d95ecf5244283e82cd07201b472d365a6c8d9306494409a8f26e0901fbb086a50ac4130bda1f3c6e15b3d5c820df431c5d1437d1c9d511b06

data/README.md

@@ -18,16 +18,38 @@ Or install it yourself as:
 
 ## Usage
 
+You can pass latitude and longitude to gem in several ways: with array or separated values.
+
+    GoogleTimezone.fetch([latitude, longitude]) 
+    GoogleTimezone.fetch(latitude, longitude) 
+    
+Any other options which are described in google's documentation you can pass via options hash
+
+    GoogleTimezone.fetch(latitude, longitude, language: 'en', signature: 'key')
+
 It uses latitude and longitude to retrieve timezone info.
 
-    GoogleTimezone.fetch(50.1196004, 8.679918299999999)
+    result = GoogleTimezone.fetch(50.1196004, 8.679918299999999)
+    result.time_zone_name => 'Europe/Berlin'
 
 It will get `GoogleTimezone::Result` object which maps major google api responce items named in snake case.
 More information [here](https://developers.google.com/maps/documentation/timezone/)
 Also there is `GoogleTimezone::Result#success?` method. It returns true if responce was successful.
 
-The bang version `fetch!` raises an error if google responce is not ok.
+The bang version `fetch!` raises an `GoogleTimezone::Error` exception with error message if response from Google wasn't success.
+
+## Usage in tests/specs
+
+During tests, you probably don't want to make remote calls. To achieve this, you should set a default stub in your test/spec helper file, e.g.:
 
+    # spec/support/google_timezone.rb
+    GoogleTimezone.set_default_stub(
+      'dstOffset' => 3600,
+      'rawOffset' => -10800,
+      'status' => 'OK',
+      'timeZoneId' => 'America/Sao_Paulo',
+      'timeZoneName' => 'Brasilia Summer Time'
+    )
 
 ## Contributing
 

data/lib/google_timezone.rb

@@ -3,13 +3,17 @@ require 'google_timezone/base'
 require 'google_timezone/result'
 
 module GoogleTimezone
-  def fetch(*args)
-    Base.new(args).fetch
-  end
+  class << self
+    def fetch(*args)
+      Base.new(*args).fetch
+    end
 
-  def fetch!(*args)
-    Base.new(args).fetch!
-  end
+    def fetch!(*args)
+      Base.new(*args).fetch!
+    end
 
-  module_function :fetch, :fetch!
+    def set_default_stub(default_stub)
+      Base.default_stub = default_stub
+    end
+  end
 end

data/lib/google_timezone/base.rb

@@ -2,8 +2,15 @@ require 'json'
 require 'open-uri'
 
 module GoogleTimezone
+
+  class Error < StandardError; end
+
   class Base
-    @allowed_params = [:language, :sensor, :timestamp, :client, :signature]
+    ALLOWED_PARAMS = [:language, :timestamp, :client, :signature, :key]
+
+    class << self
+      attr_accessor :default_stub
+    end
 
     def initialize(*args)
       @lat, @lon = if args.first.is_a? Array
@@ -11,41 +18,40 @@ module GoogleTimezone
                    else
                      args[0..1]
                    end
+
       @options = extract_options!(args)
-      @options.reject! { |key, value| !@allowed_params.include? key }
+      @options.reject! { |key, _| !ALLOWED_PARAMS.include?(key) }
     end
 
     def fetch
       location = [@lat, @lon].join(',')
-      params = { location: location, sensor: false, timestamp: Time.now.to_i }.merge(@options)
+      params = { location: location, timestamp: Time.now.to_i }.merge(@options)
       result = get_result(params)
       Result.new(result)
     end
 
     def fetch!
-      result = fetch
-      raise_error(result.result) unless result.success?
-      result
+      fetch.tap do |result|
+        raise(GoogleTimezone::Error.new(result.result)) unless result.success?
+      end
     end
 
     private
+
     def hash_to_query(hash)
-      require 'cgi' unless defined?(CGI) && defined?(CGI.escape)
-      hash.collect{ |p|
-        p[1].nil? ? nil : p.map{ |i| CGI.escape i.to_s } * '='
-      }.compact.sort * '&'
+      hash.collect { |key, val| "#{key}=#{val}" }.join('&')
     end
 
     def url(params)
       "https://maps.googleapis.com/maps/api/timezone/json?#{hash_to_query(params)}"
     end
 
-    def extract_options!(*args)
-      args.last.is_a?(::Hash) ? pop : {}
+    def extract_options!(args)
+      args.last.is_a?(::Hash) ? args.pop : {}
     end
 
     def get_result(params)
-      open(url(params)) { |r| JSON.parse(r.read) }
+      self.class.default_stub || URI.open(url(params)) { |r| JSON.parse(r.read) }
     end
   end
-end
+end

data/lib/google_timezone/version.rb

@@ -1,3 +1,3 @@
 module GoogleTimezone
-  VERSION = "0.0.1"
+  VERSION = '0.0.6'
 end

data/spec/google_timezone_result_spec.rb

@@ -3,11 +3,11 @@ require 'google_timezone/result'
 describe GoogleTimezone::Result do
   it 'should be success' do
     result = GoogleTimezone::Result.new({ 'status' => 'OK' })
-    result.should be_success
+    expect(result).to be_success
   end
 
   it 'should not be succsess' do
     result = GoogleTimezone::Result.new({ 'status' => 'ZERO_RESULTS' })
-    result.should_not be_success
+    expect(result).to_not be_success
   end
-end
+end

data/spec/google_timezone_spec.rb

@@ -1,15 +1,84 @@
 require 'google_timezone'
 
 describe GoogleTimezone do
-  describe 'initialize' do
-    it 'correct with separate lat and lon' do
-      g = GoogleTimezone::Base.new(0,0)
-      g.should be_an_instance_of(GoogleTimezone::Base)
+  def self.stub_remote_calls!
+    let(:raw_result) { {} }
+
+    before do
+      allow_any_instance_of(GoogleTimezone::Base).to(
+        receive(:get_result).and_return(raw_result)
+      )
+    end
+  end
+
+  describe '.fetch' do
+    stub_remote_calls!
+
+    context 'without any optional parameters' do
+      it 'should accept separate lat/long paramenters' do
+        g = GoogleTimezone.fetch(0, 0)
+        expect(g).to be_an_instance_of(GoogleTimezone::Result)
+      end
+
+      it 'should accept a single lat/long array parameter' do
+        g = GoogleTimezone.fetch([0, 0])
+        expect(g).to be_an_instance_of(GoogleTimezone::Result)
+      end
+    end
+
+    context 'with optional parameters' do
+      let(:valid_params)   { { timestamp: 1331161200,
+                               key: 'A24br8v2w' } }
+      let(:invalid_params) { { timestamp: 1331161200,
+                               key: 'A24br8v2w',
+                               unallowed_param: true } }
+
+      it 'should pass allowed parameters on to the query' do
+        g = GoogleTimezone.fetch(0, 0, valid_params)
+        expect(g).to be_an_instance_of(GoogleTimezone::Result)
+      end
+
+      it 'should reject unallowed parameters' do
+        a_hash_excluding = -> (*keys) { satisfy { |actual| (keys & actual.keys).empty? } }
+        expect_any_instance_of(GoogleTimezone::Base).to receive(:get_result).with(a_hash_excluding[:unallowed_param])
+        g = GoogleTimezone.fetch(0, 0, invalid_params)
+        expect(g).to be_an_instance_of(GoogleTimezone::Result)
+      end
+    end
+  end
+
+  describe '.fetch!' do
+    stub_remote_calls!
+
+    describe 'if result is not successful' do
+      it 'should raise an error' do
+        expect { GoogleTimezone.fetch!(0, 0) }.to raise_error(GoogleTimezone::Error)
+      end
+    end
+
+    describe 'if result is successul' do
+      let(:raw_result) { { 'status' => 'OK' } }
+
+      it 'should return a result' do
+        g = GoogleTimezone.fetch!(0, 0)
+        expect(g).to be_an_instance_of(GoogleTimezone::Result)
+      end
+    end
+  end
+
+  describe '.set_default_stub' do
+    after { GoogleTimezone.set_default_stub(nil) }
+
+    it 'does not make a remote call' do
+      GoogleTimezone.set_default_stub({})
+      expect_any_instance_of(GoogleTimezone::Base).not_to receive(:open)
+      GoogleTimezone.fetch(0, 0)
     end
 
-    it 'correct with array lat and lon' do
-      g = GoogleTimezone::Base.new([0,0])
-      g.should be_an_instance_of(GoogleTimezone::Base)
+    it 'returns the configured stub' do
+      GoogleTimezone.set_default_stub('timeZoneId' => 'Europe/Berlin')
+      g = GoogleTimezone.fetch(0, 0)
+      expect(g.time_zone_id).to eq('Europe/Berlin')
     end
   end
 end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: google_timezone
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.6
 platform: ruby
 authors:
 - sck-v
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2021-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   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: rspec-mocks
   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'
 description: Get timezone info by known coordinates
@@ -50,7 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README
@@ -65,27 +60,25 @@ files:
 - spec/google_timezone_spec.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 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: 
-rubygems_version: 1.8.24
+rubygems_version: 3.1.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Small gem to get timezone info by known coordinates using google timezone
   api. https://developers.google.com/maps/documentation/timezone/
 test_files: