ewelink 2.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d17e40d48a819572e83369500edbe6295a991626c3333ce4ff0765876f25ed51
-  data.tar.gz: 9caca646a1355592a276e5e4595ab486e407ecaecb105a9e7134028ecab4cb42
+  metadata.gz: 1d4567a179d6caccebab59ae35e794c4826419b6147461a9f6d9aaf268dea875
+  data.tar.gz: d79d86055e3a9c2d5dbc9d2a89be4f4fc60b2a53cd863084a17b13740d7db02e
 SHA512:
-  metadata.gz: 6e8a2717428e2b57c7a30a7d4e9a1658032b1155a2f9bd2ba9b8b0cb2309748d248f24d66babfbe2212af9d8096e6be18ebdc3c60d799654571526edff1204d5
-  data.tar.gz: 9b9e517a3c8629d6a69b8195cab906d12f8f4d4231ab22311083deb75e5db97b02ec9c13a8509710017bb17cfcf1750c46919f52b393b73a0d453c423f120153
+  metadata.gz: b79ebc640d8452951fc967ba52a99f6c5d09ccd486b3a6fdf17e10e23abdec94b2933d54566324f214972b6d7c22484c70ab76f0dbc8266a2c806c207f65373b
+  data.tar.gz: 42a11ae61affa75e02924cfa8408851568e0a67c33ba9a21d7a7fe3a42d2b025e0909720b371d6cf9b21bc53ad75862ff91216df8a760dd391b1a1b1e5653da1

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 @@
-2.3.0
+3.3.1

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.rb

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

data/lib/ewelink/api.rb

@@ -18,12 +18,14 @@ 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)
-      @web_socket_authenticated_api_keys = Set.new
+      @update_devices_status_on_connect = update_devices_status_on_connect.present?
+      @web_socket_authenticated = false
       @web_socket_switches_statuses = {}
 
       raise(Error.new(':email or :phone_number must be specified')) if email.blank? && phone_number.blank?
@@ -31,33 +33,39 @@ 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
 
     def reload
-      Ewelink.logger.debug(self.class.name) { 'Reloading API (authentication token, devices, region, connections,...)' }
+      Ewelink.logger.debug(self.class.name) { 'Reloading API (authentication token, api key, devices, region, connections,...)' }
 
-      @web_socket_authenticated_api_keys.clear
+      @web_socket_authenticated = false
       @web_socket_switches_statuses.clear
 
       [@web_socket_ping_thread, @web_socket_thread].each do |thread|
@@ -78,8 +86,7 @@ module Ewelink
       end
 
       [
-        :@api_keys,
-        :@authentication_token,
+        :@authentication_infos,
         :@devices,
         :@last_web_socket_pong_at,
         :@region,
@@ -172,66 +179,68 @@ 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
 
-    def api_keys
-      synchronize(:api_keys) do
-        @api_keys ||= Set.new(devices.map { |device| device['apikey'] })
-      end
+    def api_key
+      authentication_infos[:api_key]
     end
 
-    def authenticate_web_socket_api_keys
-      api_keys.each do |api_key|
-        params = {
-          'action' => 'userOnline',
-          'apikey' => api_key,
-          'appid' => APP_ID,
-          'at' => authentication_token,
-          'nonce' => nonce,
-          'sequence' => web_socket_sequence,
-          'ts' => Time.now.to_i,
-          'userAgent' => 'app',
-          'version' => VERSION,
-        }
-        Ewelink.logger.debug(self.class.name) { "Authenticating WebSocket API key: #{api_key.truncate(16).inspect}" }
-        send_to_web_socket(JSON.generate(params))
-      end
+    def authenticate_web_socket_api_key
+      params = {
+        'action' => 'userOnline',
+        'apikey' => api_key,
+        'appid' => APP_ID,
+        'at' => authentication_token,
+        'nonce' => nonce,
+        'sequence' => web_socket_sequence,
+        'ts' => Time.now.to_i,
+        'userAgent' => 'app',
+        'version' => VERSION,
+      }
+      Ewelink.logger.debug(self.class.name) { "Authenticating WebSocket API key: #{api_key.truncate(16).inspect}" }
+      send_to_web_socket(JSON.generate(params))
     end
 
     def authentication_headers
       { 'Authorization' => "Bearer #{authentication_token}" }
     end
 
-    def authentication_token
-      synchronize(:authentication_token) do
-        @authentication_token ||= begin
+    def authentication_infos
+      synchronize(:authentication_infos) do
+        @authentication_infos ||= begin
           params = {
             'appid' => APP_ID,
             'imei' => SecureRandom.uuid.upcase,
@@ -248,11 +257,19 @@ module Ewelink
           body = JSON.generate(params)
           response = rest_request(:post, '/api/user/login', { body: body, headers: { 'Authorization' => "Sign #{Base64.encode64(OpenSSL::HMAC.digest('SHA256', APP_SECRET, body))}" } })
           raise(Error.new('Authentication token not found')) if response['at'].blank?
-          response['at'].tap { Ewelink.logger.debug(self.class.name) { 'Authentication token found' } }
+          raise(Error.new('API key not found')) if response['user'].blank? || response['user']['apikey'].blank?
+          {
+            authentication_token: response['at'].tap { Ewelink.logger.debug(self.class.name) { 'Authentication token found' } },
+            api_key: response['user']['apikey'].tap { Ewelink.logger.debug(self.class.name) { 'API key found' } },
+          }
         end
       end
     end
 
+    def authentication_token
+      authentication_infos[:authentication_token]
+    end
+
     def devices
       synchronize(:devices) do
         @devices ||= begin
@@ -281,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)
+      nil
+    end
+
     def region
       @region ||= DEFAULT_REGION
     end
@@ -297,7 +321,7 @@ module Ewelink
         Ewelink.logger.debug(self.class.name) { "Switched to region #{region.inspect}" }
         return rest_request(method, path, options)
       end
-      remove_instance_variable(:@authentication_token) if instance_variable_defined?(:@authentication_token) && [401, 403].include?(response['error'])
+      remove_instance_variable(:@authentication_infos) if instance_variable_defined?(:@authentication_infos) && [401, 403].include?(response['error'])
       raise(Error.new("#{method} #{url}: #{response['error']} #{response['msg']}".strip)) if response['error'].present? && response['error'] != 0
       response.to_h
     rescue Errno::ECONNREFUSED, OpenSSL::OpenSSLError, SocketError, Timeout::Error => e
@@ -358,7 +382,7 @@ module Ewelink
 
         # Initializes caches before opening WebSocket: important in order to
         # NOT cumulate requests Timeouts from #web_socket_wait_for.
-        api_keys
+        api_key
         web_socket_url
 
         Ewelink.logger.debug(self.class.name) { "Opening WebSocket to #{web_socket_url.inspect}" }
@@ -375,7 +399,7 @@ module Ewelink
             @web_socket.on(:open) do |event|
               Ewelink.logger.debug(self.class.name) { 'WebSocket opened' }
               @last_web_socket_pong_at = Time.now
-              authenticate_web_socket_api_keys
+              authenticate_web_socket_api_key
             end
 
             @web_socket.on(:message) do |event|
@@ -405,9 +429,10 @@ module Ewelink
                 start_web_socket_ping_thread(json['config']['hbInterval'] + 7)
               end
 
-              if json['apikey'].present? && !@web_socket_authenticated_api_keys.include?(json['apikey'])
-                @web_socket_authenticated_api_keys << json['apikey']
+              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?
@@ -428,7 +453,7 @@ module Ewelink
     end
 
     def web_socket_authenticated?
-      api_keys == @web_socket_authenticated_api_keys
+      @web_socket_authenticated.present?
     end
 
     def web_socket_outdated_ping?

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) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ewelink
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-09 00:00:00.000000000 Z
+date: 2021-06-15 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