winker 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5939f1cb0963428836c54e6a654a670b68b07265
-  data.tar.gz: d1f8c771cc61061e184dc97bfbb0707bb5118ecb
+  metadata.gz: 28e81dce292292d00f32065e6364a559a882c5d2
+  data.tar.gz: 8831f1e6c85907d2059c92c96a487c627eb92159
 SHA512:
-  metadata.gz: 692b4b4c63f637a979125811e0a13812b2a292c13990615285823fa270f966ed2d337a5bf45c2410e78b6a99cc08e986cc2e33fc08cdf946ba5b94fe2f4d5bd1
-  data.tar.gz: e6e84626eb776761ef5b2a24d133ea098d2dd7d1ba3a49c4315a92bea933158643d048e2c6ea73145e43548f2840448898ac4b5b62585c79b03c13acd6d54ae1
+  metadata.gz: e29dd7f3f720afd02da14958d5f338dfdd9740dbc66934b7506de3529d917aace53821ac90df021fb602fb95b75629a1b47b07d0778bfd83e8ebdb24fbc993d7
+  data.tar.gz: cc70bb390ca55386fa1a4e85c0a1eab83d801167eb44ba1d2ab2f0e9a089fe31e6617a406af93893ea67d2903ffb876eb15182f47c010d1cb75003604e99c4cf

data/README.md

@@ -36,6 +36,7 @@ Or install it yourself as:
       wink.username = "email@domain.com"
       wink.password = "**********"
       wink.endpoint = "https://winkapi.quirky.com"
+      wink.wait_for_updates = true #this is the default setting is optional
     end
 
     #retrieve the access_token and refresh_token
@@ -54,12 +55,25 @@ Or install it yourself as:
 #Device Methods/Attributes
 Some status methods are blocking in the sense that if a status change is sent, such as powering the device on or off, the next time you call powered? it will refresh every 2 seconds until last updated at time is greater than when the status change was called. If 20 seconds pass before an update then the it throws and error that it hasn't received an update. During my testing an update normally took about 4 seconds. But at times would take much longer.
 
+To temporarily disable or enable blocking use the Winker.wait_for_update block method
+
 examples
 
     devices = Winker.devices #returns an array of device objects
     devices[1].type
     => "light_bulb"
     
+    Winker.wait_for_update(false) do
+      devices[1].off
+    end
+    devices[1].powered? #it takes time for update to reach bulb and signal completion
+    => true
+    Winker.wait_for_update(true) do
+      devices[1].off
+    end
+    devices[1].powered? #blocks until status updated_at is greater than the time we called the off method
+    => false
+    
 Each device has it's own associated type. To make things easier when devices are loaded methods are included to help interact with the device so update(options) doesn't have to be called for every interaction.
 
 ##Generic

data/lib/winker/devices/device_methods.rb

@@ -23,18 +23,20 @@ module Winker
       end
   
       def wait_for_update(boolean_proc, options = {}, &block)
-        options = {
-          timeout: WAIT_BLOCK_TIMEOUT
-        }.merge(options)
-        start = Time.now
-        until (success = boolean_proc.call) || Time.now > start+options[:timeout]
-          result = yield
-          sleep WAIT_BLOCK_SLEEP
-        end
-        if success
-          return result
-        else
-          raise "Device #{self.type} #{self.name} not updated."
+        if Winker.wait_for_updates
+          options = {
+            timeout: WAIT_BLOCK_TIMEOUT
+          }.merge(options)
+          start = Time.now
+          until (success = boolean_proc.call) || Time.now > start+options[:timeout]
+            result = yield
+            sleep WAIT_BLOCK_SLEEP
+          end
+          if success
+            return result
+          else
+            raise "Device #{self.type} #{self.name} not updated and timed out after #{options[:timeout]}."
+          end
         end
       end
     end

data/lib/winker/version.rb

@@ -1,3 +1,3 @@
 module Winker
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
 end

data/lib/winker.rb

@@ -36,13 +36,26 @@ module Winker
   end
   
   module Configuration
-    attr_accessor :client_id, :client_secret, :access_token, :refresh_token, :username, :password, :endpoint, :server_time_dif
+    attr_accessor :client_id, :client_secret, :access_token, :refresh_token, :username, :password, :endpoint, :server_time_dif, :wait_for_updates
 
     def configure
+      self.wait_for_updates = true
       yield self
     end
   end
 
+  def self.wait_for_update(should_i_wait = true)
+    _default_setting = self.wait_for_updates
+    self.wait_for_updates = should_i_wait
+    begin
+      yield
+    rescue Exception => e
+      self.wait_for_updates = _default_setting
+      raise e
+    end
+  end
+
+
   extend Parser
   extend Configuration
   extend Connection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: winker
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Kelly Mahan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler