ewelink 3.1.0 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45f904d5e72d0038360340adc26dd7eb963f664804b43eee8235ee02d48f60ff
-  data.tar.gz: 98ee94c2d9187ea17250c3f32c1932f8c0df8a2123c341a47159c32e2aec66e9
+  metadata.gz: 0fba630fc8ea0be922637f79d4618baccf676775fc37e35ffbd9847e479930f4
+  data.tar.gz: 8e03090c2c1f9e469b25a9b3ff4dc21da74fd150c6432196038c464cca1608bb
 SHA512:
-  metadata.gz: 42977ef17b87c9c6710973968ca739d642108d6595861a870090ef13fbe5332b7ff99fba0dc8444e8022dfba065f4334426daf2dc423ed08314b3939cc41e69a
-  data.tar.gz: 4fa2068348c252aecfa1f0d55f91013a17658a3403fa7813208f34f027757b2459181323aae9a9d8c71c915ac8c83e881150c4eacee77ed85832b1adaeadb451
+  metadata.gz: 854c5679733f93e5a54c3085858315874db86319b0d81898a64f807d6780f146cfe1f0767ce5b6e4c9ed576adcab59b3154a35399a2cae77a2d4bcac338e8d58
+  data.tar.gz: 328c7a4e3c10ca31d1b4d636c97c12e6a8af6358401aac77fea2739a0300cac162fa85ee1028dcf5097e42989a5d3035d39f8abf832030b3eabf0037dd43f244

data/README.mdown

@@ -75,6 +75,14 @@ api = Ewelink::Api.new(email: 'john@example.com', password: 'secr$t')
 api.press_rf_bridge_button!(button[:uuid])
 ```
 
+### Additional options
+
+- `async_actions` (`true` | `false`): To perform actions (pressing an RF
+  bridge button or turning a switch on/off) in asynchronous mode. (default:
+  `false`).
+- `update_devices_status_on_connect` (`true` | `false`): To update devices
+  status (on, off) when connecting to Ewelink API (default: `false`).
+
 ### Configuring logger
 
 In order to have some debug informations about what kagu does, you could

data/VERSION

@@ -1 +1 @@
-3.1.0
+3.3.2

data/ewelink.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'activesupport', '>= 6.0.0', '< 7.0.0'
   s.add_dependency 'faye-websocket', '>= 0.11.0', '< 0.12.0'
   s.add_dependency 'httparty', '>= 0.18.0', '< 0.19.0'
+  s.add_dependency 'thread', '>= 0.2.0', '< 0.3.0'
 
   s.add_development_dependency 'byebug', '>= 11.0.0', '< 12.0.0'
-  s.add_development_dependency 'rake', '>= 12.0.0', '< 13.0.0'
+  s.add_development_dependency 'rake', '>= 13.0.0', '< 14.0.0'
 end

data/lib/ewelink/api.rb

@@ -18,11 +18,13 @@ module Ewelink
 
     attr_reader :email, :password, :phone_number
 
-    def initialize(email: nil, password:, phone_number: nil)
+    def initialize(async_actions: false, email: nil, password:, phone_number: nil, update_devices_status_on_connect: false)
+      @async_actions = async_actions.present?
       @email = email.presence.try(:strip)
       @mutexs = {}
       @password = password.presence || raise(Error.new(":password must be specified"))
       @phone_number = phone_number.presence.try(:strip)
+      @update_devices_status_on_connect = update_devices_status_on_connect.present?
       @web_socket_authenticated = false
       @web_socket_switches_statuses = {}
 
@@ -31,25 +33,31 @@ module Ewelink
       start_web_socket_authentication_check_thread
     end
 
+    def async_actions?
+      @async_actions
+    end
+
     def press_rf_bridge_button!(uuid)
-      synchronize(:press_rf_bridge_button) do
-        button = find_rf_bridge_button!(uuid)
-        web_socket_wait_for(-> { web_socket_authenticated? }, initialize_web_socket: true) do
-          params = {
-            'action' => 'update',
-            'apikey' => button[:api_key],
-            'deviceid' => button[:device_id],
-            'params' => {
-              'cmd' => 'transmit',
-              'rfChl' => button[:channel],
-            },
-            'sequence' => web_socket_sequence,
-            'ts' => 0,
-            'userAgent' => 'app',
-          }
-          Ewelink.logger.debug(self.class.name) { "Pressing RF bridge button #{button[:uuid].inspect}" }
-          send_to_web_socket(JSON.generate(params))
-          true
+      process_action do
+        synchronize(:press_rf_bridge_button) do
+          button = find_rf_bridge_button!(uuid)
+          web_socket_wait_for(-> { web_socket_authenticated? }, initialize_web_socket: true) do
+            params = {
+              'action' => 'update',
+              'apikey' => button[:api_key],
+              'deviceid' => button[:device_id],
+              'params' => {
+                'cmd' => 'transmit',
+                'rfChl' => button[:channel],
+              },
+              'sequence' => web_socket_sequence,
+              'ts' => 0,
+              'userAgent' => 'app',
+            }
+            Ewelink.logger.debug(self.class.name) { "Pressing RF bridge button #{button[:uuid].inspect}" }
+            send_to_web_socket(JSON.generate(params))
+            true
+          end
         end
       end
     end
@@ -171,31 +179,37 @@ module Ewelink
     end
 
     def turn_switch!(uuid, on)
-      if ['on', :on, 'true'].include?(on)
-        on = true
-      elsif ['off', :off, 'false'].include?(on)
-        on = false
-      end
-      switch = find_switch!(uuid)
-      @web_socket_switches_statuses[switch[:uuid]] = nil
-      web_socket_wait_for(-> { web_socket_authenticated? }, initialize_web_socket: true) do
-        params = {
-          'action' => 'update',
-          'apikey' => switch[:api_key],
-          'deviceid' => switch[:device_id],
-          'params' => {
-            'switch' => on ? 'on' : 'off',
-          },
-          'sequence' => web_socket_sequence,
-          'ts' => 0,
-          'userAgent' => 'app',
-        }
-        Ewelink.logger.debug(self.class.name) { "Turning switch #{switch[:uuid].inspect} #{on ? 'on' : 'off'}" }
-        send_to_web_socket(JSON.generate(params))
+      process_action do
+        if ['on', :on, 'true'].include?(on)
+          on = true
+        elsif ['off', :off, 'false'].include?(on)
+          on = false
+        end
+        switch = find_switch!(uuid)
+        @web_socket_switches_statuses[switch[:uuid]] = nil
+        web_socket_wait_for(-> { web_socket_authenticated? }, initialize_web_socket: true) do
+          params = {
+            'action' => 'update',
+            'apikey' => switch[:api_key],
+            'deviceid' => switch[:device_id],
+            'params' => {
+              'switch' => on ? 'on' : 'off',
+            },
+            'sequence' => web_socket_sequence,
+            'ts' => 0,
+            'userAgent' => 'app',
+          }
+          Ewelink.logger.debug(self.class.name) { "Turning switch #{switch[:uuid].inspect} #{on ? 'on' : 'off'}" }
+          send_to_web_socket(JSON.generate(params))
+        end
+        sleep(SWITCH_STATUS_CHANGE_CHECK_TIMEOUT)
+        switch_on?(switch[:uuid]) # Waiting for switch status update
+        true
       end
-      sleep(SWITCH_STATUS_CHANGE_CHECK_TIMEOUT)
-      switch_on?(switch[:uuid]) # Waiting for switch status update
-      true
+    end
+
+    def update_devices_status_on_connect?
+      @update_devices_status_on_connect
     end
 
     private
@@ -284,6 +298,13 @@ module Ewelink
       SecureRandom.hex[0, 8]
     end
 
+    def process_action(&block)
+      return yield unless async_actions?
+      @async_actions_thread_pool ||= Thread.pool(1)
+      @async_actions_thread_pool.process(&block)
+      true
+    end
+
     def region
       @region ||= DEFAULT_REGION
     end
@@ -411,6 +432,7 @@ module Ewelink
               if json['apikey'].present? && !@web_socket_authenticated && json['apikey'] == api_key
                 @web_socket_authenticated = true
                 Ewelink.logger.debug(self.class.name) { "WebSocket successfully authenticated API key: #{json['apikey'].truncate(16).inspect}" }
+                Thread.new { switches.each { |switch| switch_on?(switch[:uuid]) } } if update_devices_status_on_connect?
               end
 
               if json['deviceid'].present? && json['params'].is_a?(Hash) && json['params']['switch'].present?

data/lib/ewelink/runner.rb

@@ -3,7 +3,7 @@ module Ewelink
   class Runner
 
     def run
-      api = Api.new(options.slice(:email, :password, :phone_number))
+      api = Api.new(**options.slice(:email, :password, :phone_number))
       puts(JSON.pretty_generate(api.switches)) if options[:list_switches]
       puts(JSON.pretty_generate(api.rf_bridge_buttons)) if options[:list_rf_bridge_buttons]
       options[:turn_switches_on_uuids].each { |uuid| api.turn_switch!(uuid, :on) }

data/lib/ewelink.rb

@@ -10,6 +10,7 @@ require 'logger'
 require 'openssl'
 require 'optparse'
 require 'set'
+require 'thread/pool'
 require 'timeout'
 
 module Ewelink

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ewelink
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.2
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2021-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,6 +70,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: thread
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -96,20 +116,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 13.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 13.0.0
+        version: 14.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 13.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 13.0.0
+        version: 14.0.0
 description: Manage eWeLink smart home devices
 email: al@alweb.org
 executables:
@@ -144,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Manage eWeLink devices