google_timezone 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dea49ca959de6ba6012065a8aeff097548ac5b90
-  data.tar.gz: 5daf4c90ce40c1babbc0daa07810b51adb9b423d
+  metadata.gz: ae74565f590f1ed3353d714d67960da46128420b
+  data.tar.gz: 6aab6816a3c652bbdbd7b504d7d359e7f880e5dd
 SHA512:
-  metadata.gz: f067c96016a48390ed2904fa607e29a8a725e44184a923371cbc461a76c75e23ab43138e027bba52c02154e55aa1b44b2083b7253cace049a782cb742290fa92
-  data.tar.gz: 8af5396dcb560ea1d5a5c37375f96ecfe5c597c6e8d824c67eaff3ac0d7a485271787de9cd137f020e85d1a29ce64383a2f52751b348879b9db2002c083dc6d6
+  metadata.gz: 7dbdbc71964dd180eecb60a566c49246770dd9223f3b1de127215e6e87436295449845be1c66349c62b358c7ad6c8fd46d839c148ed53f34e1fb3dbd542ff5a9
+  data.tar.gz: 15121d942e69ec62b8b978b793dbea9501ed5b2218e65e0b646a90c16d9cafeb919217b2e228d5f4db0c932312ab3ceb215b852f376db17bbfd494ccd0db9fc2

data/README.md

@@ -38,6 +38,18 @@ Also there is `GoogleTimezone::Result#success?` method. It returns true if respo
 
 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

@@ -11,5 +11,9 @@ module GoogleTimezone
     def fetch!(*args)
       Base.new(*args).fetch!
     end
+
+    def set_default_stub(default_stub)
+      Base.default_stub = default_stub
+    end
   end
 end

data/lib/google_timezone/base.rb

@@ -6,7 +6,11 @@ module GoogleTimezone
   class Error < StandardError; end
 
   class Base
-    ALLOWED_PARAMS = [:language, :sensor, :timestamp, :client, :signature, :key]
+    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
@@ -21,15 +25,15 @@ module GoogleTimezone
 
     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(GoogleTimezone::Error.new(result.result)) unless result.success?
-      result
+      fetch.tap do |result|
+        raise(GoogleTimezone::Error.new(result.result)) unless result.success?
+      end
     end
 
     private
@@ -47,7 +51,7 @@ module GoogleTimezone
     end
 
     def get_result(params)
-      open(url(params)) { |r| JSON.parse(r.read) }
+      self.class.default_stub || open(url(params)) { |r| JSON.parse(r.read) }
     end
   end
 end

data/lib/google_timezone/version.rb

@@ -1,3 +1,3 @@
 module GoogleTimezone
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/google_timezone_spec.rb

@@ -1,23 +1,20 @@
 require 'google_timezone'
 
 describe GoogleTimezone do
-  describe '.fetch' do
-    context 'without any optional parameters' do
-      let(:base_instance) { spy }
-      let(:result) { GoogleTimezone::Result.new({}) }
+  def self.stub_remote_calls!
+    let(:raw_result) { {} }
 
-      before do
-        allow_any_instance_of(GoogleTimezone::Base).to(
-          receive(:new).with(any_args)
-                       .and_return(base_instance)
-        )
+    before do
+      allow_any_instance_of(GoogleTimezone::Base).to(
+        receive(:get_result).and_return(raw_result)
+      )
+    end
+  end
 
-        allow(base_instance).to(
-          receive(:fetch).with(no_args)
-                         .and_return(result)
-        )
-      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)
@@ -30,32 +27,20 @@ describe GoogleTimezone do
     end
 
     context 'with optional parameters' do
-      let(:base_instance) { spy }
-      let(:result) { GoogleTimezone::Result.new(0) }
       let(:valid_params)   { { timestamp: 1331161200,
                                key: 'A24br8v2w' } }
       let(:invalid_params) { { timestamp: 1331161200,
                                key: 'A24br8v2w',
                                unallowed_param: true } }
 
-      before(:each) do
-        allow_any_instance_of(GoogleTimezone::Base).to(
-          receive(:new).with(0, 0, valid_params)
-                       .and_return(base_instance)
-        )
-
-        allow(base_instance).to(
-          receive(:fetch).with(no_args)
-                         .and_return(result)
-        )
-      end
-
       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
@@ -63,21 +48,37 @@ describe GoogleTimezone do
   end
 
   describe '.fetch!' do
+    stub_remote_calls!
+
     describe 'if result is not successful' do
-      let(:result) { GoogleTimezone::Result.new({}) }
-      let(:error)  { GoogleTimezone::Error }
+      it 'should raise an error' do
+        expect { GoogleTimezone.fetch!(0, 0) }.to raise_error(GoogleTimezone::Error)
+      end
+    end
 
-      before { allow(result).to receive(:success?).and_return(false) }
-      before { allow(result).to receive(:result).and_return('error message') }
-      before {
-        allow_any_instance_of(GoogleTimezone::Base).to(
-          receive(:fetch).and_return(result)
-        )
-      }
+    describe 'if result is successul' do
+      let(:raw_result) { { 'status' => 'OK' } }
 
-      it 'should raise an error' do
-        expect { GoogleTimezone.fetch!(0,0) }.to raise_error(error)
+      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 '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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_timezone
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - sck-v
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-25 00:00:00.000000000 Z
+date: 2015-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec