ewelink 2.2.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 957d00b0d8171519a48b1cf828cbd78c21dbde34b93f2c1930273ad460d5a770
-  data.tar.gz: 0c636a47ac05f8428d9e099d952a0b89a512f8e199a3a85a72624c10a76590b3
+  metadata.gz: c9b83156bba48622088845d22bd8fc3b559d6e8732acf4664ba35886c6c19d35
+  data.tar.gz: d69303e93b04b56fd713fc27220d15c4ab66ca767190a289d6440932dc468532
 SHA512:
-  metadata.gz: c20dfab19c133d80913716e7be2b20e47958e841e61d7b401f28b73e642358d80ce698d5fd22410ede0bb783114c0e91dfc7a1b4760ebab3738aaba3081275af
-  data.tar.gz: 07664117dfacf9f32fa7e0965199bed938da619b75b313207d702d5ad83ebc2ceacbb76b266e40f3e995114542a110061ad271630a3b007fc2e4f1cbb2bccc58
+  metadata.gz: fa3fd8b8a36ad7e4570db2941ebdffc1d134106ea40ce93866eaebe7b81a4cc0a35920f5366a48c0a9141476101cc03be42adf244b15bcf98eeec64b0e77a312
+  data.tar.gz: d98f59eaec9c582dd0627a52a392c45e98e351676b69d36f081df4ec819153bd32e340ced77440152c674d58013f413d8e42a5e86a50f65d57efce5782f26943

data/README.mdown

@@ -75,6 +75,11 @@ api = Ewelink::Api.new(email: 'john@example.com', password: 'secr$t')
 api.press_rf_bridge_button!(button[:uuid])
 ```
 
+### Additional options
+
+- `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.2.1
+3.2.0

data/lib/ewelink/api.rb

@@ -11,26 +11,31 @@ module Ewelink
     URL = 'https://#{region}-api.coolkit.cc:8080'
     UUID_NAMESPACE = 'e25750fb-3710-41af-b831-23224f4dd609';
     VERSION = 8
+    WEB_SOCKET_CHECK_AUTHENTICATION_TIMEOUT = 30.seconds
     WEB_SOCKET_PING_TOLERANCE_FACTOR = 1.5
     SWITCH_STATUS_CHANGE_CHECK_TIMEOUT = 2.seconds
     WEB_SOCKET_WAIT_INTERVAL = 0.2.seconds
 
     attr_reader :email, :password, :phone_number
 
-    def initialize(email: nil, password:, phone_number: nil)
+    def initialize(email: nil, password:, phone_number: nil, update_devices_status_on_connect: false)
       @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?
+
+      raise(Error.new(':email or :phone_number must be specified')) if email.blank? && phone_number.blank?
+
+      start_web_socket_authentication_check_thread
     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? }) do
+        web_socket_wait_for(-> { web_socket_authenticated? }, initialize_web_socket: true) do
           params = {
             'action' => 'update',
             'apikey' => button[:api_key],
@@ -51,15 +56,40 @@ module Ewelink
     end
 
     def reload
-      Ewelink.logger.debug(self.class.name) { 'Reloading API (authentication token, devices, region,...)' }
-      dispose_web_socket
+      Ewelink.logger.debug(self.class.name) { 'Reloading API (authentication token, api key, devices, region, connections,...)' }
+
+      @web_socket_authenticated = false
+      @web_socket_switches_statuses.clear
+
+      [@web_socket_ping_thread, @web_socket_thread].each do |thread|
+        next unless thread
+        if Thread.current == thread
+          thread[:stop] = true
+        else
+          thread.kill
+        end
+      end
+
+      if @web_socket.present?
+        begin
+          @web_socket.close if @web_socket.open?
+        rescue
+          # Ignoring close errors
+        end
+      end
+
       [
-        :@api_keys,
-        :@authentication_token,
+        :@authentication_infos,
         :@devices,
+        :@last_web_socket_pong_at,
         :@region,
         :@rf_bridge_buttons,
         :@switches,
+        :@web_socket_ping_interval,
+        :@web_socket_ping_thread,
+        :@web_socket_thread,
+        :@web_socket_url,
+        :@web_socket,
       ].each do |variable|
         remove_instance_variable(variable) if instance_variable_defined?(variable)
       end
@@ -103,7 +133,7 @@ module Ewelink
     def switch_on?(uuid)
       switch = find_switch!(uuid)
       if @web_socket_switches_statuses[switch[:uuid]].nil?
-        web_socket_wait_for(-> { web_socket_authenticated? }) do
+        web_socket_wait_for(-> { web_socket_authenticated? }, initialize_web_socket: true) do
           Ewelink.logger.debug(self.class.name) { "Checking switch #{switch[:uuid].inspect} status" }
           params = {
             'action' => 'query',
@@ -116,7 +146,7 @@ module Ewelink
           send_to_web_socket(JSON.generate(params))
         end
       end
-      web_socket_wait_for(-> { !@web_socket_switches_statuses[switch[:uuid]].nil? }) do
+      web_socket_wait_for(-> { !@web_socket_switches_statuses[switch[:uuid]].nil? }, initialize_web_socket: true) do
         @web_socket_switches_statuses[switch[:uuid]] == 'on'
       end
     end
@@ -149,7 +179,7 @@ module Ewelink
       end
       switch = find_switch!(uuid)
       @web_socket_switches_statuses[switch[:uuid]] = nil
-      web_socket_wait_for(-> { web_socket_authenticated? }) do
+      web_socket_wait_for(-> { web_socket_authenticated? }, initialize_web_socket: true) do
         params = {
           'action' => 'update',
           'apikey' => switch[:api_key],
@@ -169,39 +199,39 @@ module Ewelink
       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,
@@ -218,11 +248,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
@@ -239,40 +277,6 @@ module Ewelink
       end
     end
 
-    def dispose_web_socket
-      Ewelink.logger.debug(self.class.name) { 'Dispose WebSocket' }
-      @web_socket_authenticated_api_keys.clear
-      @web_socket_switches_statuses.clear
-
-      [@web_socket_ping_thread, @web_socket_thread].each do |thread|
-        next unless thread
-        if Thread.current == thread
-          thread[:stop] = true
-        else
-          thread.kill
-        end
-      end
-
-      if @web_socket.present?
-        begin
-          @web_socket.close if @web_socket.open?
-        rescue
-          # Ignoring close errors
-        end
-      end
-
-      [
-        :@last_web_socket_pong_at,
-        :@web_socket_ping_interval,
-        :@web_socket_ping_thread,
-        :@web_socket_thread,
-        :@web_socket_url,
-        :@web_socket,
-      ].each do |variable|
-        remove_instance_variable(variable) if instance_variable_defined?(variable)
-      end
-    end
-
     def find_rf_bridge_button!(uuid)
       rf_bridge_buttons.find { |button| button[:uuid] == uuid } || raise(Error.new("No such RF bridge button with UUID: #{uuid.inspect}"))
     end
@@ -301,7 +305,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
@@ -309,16 +313,30 @@ module Ewelink
     end
 
     def send_to_web_socket(message)
-      if web_socket_outdated_ping?
-        Ewelink.logger.warn(self.class.name) { 'WebSocket ping is outdated' }
-        dispose_web_socket
-      end
       web_socket.send(message)
     rescue => e
-      dispose_web_socket
+      reload
       raise Error.new(e)
     end
 
+    def start_web_socket_authentication_check_thread
+      raise Error.new('WebSocket authentication check must only be started once') if @web_socket_authentication_check_thread.present?
+
+      @web_socket_authentication_check_thread = Thread.new do
+        loop do
+          Ewelink.logger.debug(self.class.name) { 'Checking if WebSocket is authenticated' }
+          begin
+            web_socket_wait_for(-> { web_socket_authenticated? }, initialize_web_socket: true) do
+              Ewelink.logger.debug(self.class.name) { 'WebSocket is authenticated' }
+            end
+          rescue => e
+            Ewelink.logger.error(self.class.name) { e }
+          end
+          sleep(WEB_SOCKET_CHECK_AUTHENTICATION_TIMEOUT)
+        end
+      end
+    end
+
     def start_web_socket_ping_thread(interval)
       @last_web_socket_pong_at = Time.now
       @web_socket_ping_interval = interval
@@ -338,24 +356,34 @@ module Ewelink
     end
 
     def web_socket
+      if web_socket_outdated_ping?
+        Ewelink.logger.warn(self.class.name) { 'WebSocket ping is outdated' }
+        reload
+      end
+
       synchronize(:web_socket) do
         next @web_socket if @web_socket
 
+        # Initializes caches before opening WebSocket: important in order to
+        # NOT cumulate requests Timeouts from #web_socket_wait_for.
+        api_key
+        web_socket_url
+
+        Ewelink.logger.debug(self.class.name) { "Opening WebSocket to #{web_socket_url.inspect}" }
+
         @web_socket_thread = Thread.new do
           EventMachine.run do
-            Ewelink.logger.debug(self.class.name) { "Opening WebSocket to #{web_socket_url.inspect}" }
-
-            @web_socket = Faye::WebSocket::Client.new('wss://as-pconnect3.coolkit.cc:8080/api/ws')
+            @web_socket = Faye::WebSocket::Client.new(web_socket_url)
 
             @web_socket.on(:close) do |event|
               Ewelink.logger.debug(self.class.name) { 'WebSocket closed' }
-              dispose_web_socket
+              reload
             end
 
             @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|
@@ -371,11 +399,13 @@ module Ewelink
                 json = JSON.parse(message)
               rescue => e
                 Ewelink.logger.error(self.class.name) { 'WebSocket JSON parse error' }
+                reload
                 next
               end
 
               if json.key?('error') && json['error'] != 0
                 Ewelink.logger.error(self.class.name) { "WebSocket message error: #{message.inspect}" }
+                reload
                 next
               end
 
@@ -383,9 +413,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?
@@ -399,18 +430,14 @@ module Ewelink
           end
         end
 
-        Timeout.timeout(REQUEST_TIMEOUT) do
-          while @web_socket.blank?
-            sleep(WEB_SOCKET_WAIT_INTERVAL)
-          end
+        web_socket_wait_for(-> { @web_socket.present? }) do
+          @web_socket
         end
-
-        @web_socket
       end
     end
 
     def web_socket_authenticated?
-      api_keys == @web_socket_authenticated_api_keys
+      @web_socket_authenticated.present?
     end
 
     def web_socket_outdated_ping?
@@ -440,15 +467,18 @@ module Ewelink
       end
     end
 
-    def web_socket_wait_for(condition, &block)
-      web_socket # Initializes WebSocket
-      Timeout.timeout(REQUEST_TIMEOUT) do
-        while !condition.call
-          sleep(WEB_SOCKET_WAIT_INTERVAL)
+    def web_socket_wait_for(condition, initialize_web_socket: false, &block)
+      web_socket if initialize_web_socket
+      begin
+        Timeout.timeout(REQUEST_TIMEOUT) do
+          while !condition.call
+            sleep(WEB_SOCKET_WAIT_INTERVAL)
+          end
+          block_given? ? yield : true
         end
-        block_given? ? yield : true
-      rescue
-        dispose_web_socket
+      rescue => e
+        reload
+        raise Error.new(e)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ewelink
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2020-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport