ewelink 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c58323e838b9fbbdca7c7ee0fdf22d1e7950c627fb4fcf8851b3263e69ce883
-  data.tar.gz: 475d05f731b079f7734fde4dd93ec8f151077d6e5b716a86e611f11bdbb8d49b
+  metadata.gz: d17e40d48a819572e83369500edbe6295a991626c3333ce4ff0765876f25ed51
+  data.tar.gz: 9caca646a1355592a276e5e4595ab486e407ecaecb105a9e7134028ecab4cb42
 SHA512:
-  metadata.gz: 50ba5474e9012f219e380c47515d599da29a72b50cc26c36a19e253623c997e429a32c1b279619eef0e2d8b7f454fccde519500f998575c38d028ac86e6c1ba4
-  data.tar.gz: 122f2997897893b395cd04204e3e169d90bac15fc1a9eaabbf31def8da1c7f754bd502341411727364a79011379791a89031e9d42090d22bf96be233a24a5958
+  metadata.gz: 6e8a2717428e2b57c7a30a7d4e9a1658032b1155a2f9bd2ba9b8b0cb2309748d248f24d66babfbe2212af9d8096e6be18ebdc3c60d799654571526edff1204d5
+  data.tar.gz: 9b9e517a3c8629d6a69b8195cab906d12f8f4d4231ab22311083deb75e5db97b02ec9c13a8509710017bb17cfcf1750c46919f52b393b73a0d453c423f120153

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.3.0

data/ewelink.gemspec

@@ -16,8 +16,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0.0'
 
   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 'websocket-client-simple', '>= 0.3.0', '< 0.4.0'
 
   s.add_development_dependency 'byebug', '>= 11.0.0', '< 12.0.0'
   s.add_development_dependency 'rake', '>= 12.0.0', '< 13.0.0'

data/lib/ewelink.rb

@@ -1,6 +1,8 @@
 require 'active_support'
 require 'active_support/core_ext'
 require 'byebug' if ENV['DEBUGGER']
+require 'eventmachine'
+require 'faye/websocket'
 require 'httparty'
 require 'io/console'
 require 'json'
@@ -9,7 +11,6 @@ require 'openssl'
 require 'optparse'
 require 'set'
 require 'timeout'
-require 'websocket-client-simple'
 
 module Ewelink
 

data/lib/ewelink/api.rb

@@ -5,13 +5,15 @@ module Ewelink
     APP_ID = 'oeVkj2lYFGnJu5XUtWisfW4utiN4u9Mq'
     APP_SECRET = '6Nz4n0xA8s8qdxQf2GqurZj2Fs55FUvM'
     DEFAULT_REGION = 'us'
+    REQUEST_TIMEOUT = 10.seconds
     RF_BRIDGE_DEVICE_UIID = 28
     SWITCH_DEVICES_UIIDS = [1, 5, 6, 24]
-    TIMEOUT = 10.seconds
     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
@@ -21,15 +23,18 @@ module Ewelink
       @mutexs = {}
       @password = password.presence || raise(Error.new(":password must be specified"))
       @phone_number = phone_number.presence.try(:strip)
-      @switches_statuses = {}
       @web_socket_authenticated_api_keys = Set.new
-      raise(Error.new(":email or :phone_number must be specified")) if email.blank? && phone_number.blank?
+      @web_socket_switches_statuses = {}
+
+      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
 
     def reload
       Ewelink.logger.debug(self.class.name) { 'Reloading API (authentication token, devices, region, connections,...)' }
-      dispose_web_socket
-      @switches_statuses.clear
+
+      @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
+
       [
         :@api_keys,
         :@authentication_token,
         :@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
@@ -102,23 +132,22 @@ module Ewelink
 
     def switch_on?(uuid)
       switch = find_switch!(uuid)
-      if @switches_statuses[switch[:uuid]].nil?
-        params = {
-          'action' => 'query',
-          'apikey' => switch[:api_key],
-          'deviceid' => switch[:device_id],
-          'sequence' => web_socket_sequence,
-          'ts' => 0,
-          'userAgent' => 'app',
-        }
-        web_socket_wait_for(-> { web_socket_authenticated? }) do
+      if @web_socket_switches_statuses[switch[:uuid]].nil?
+        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',
+            'apikey' => switch[:api_key],
+            'deviceid' => switch[:device_id],
+            'sequence' => web_socket_sequence,
+            'ts' => 0,
+            'userAgent' => 'app',
+          }
           send_to_web_socket(JSON.generate(params))
         end
       end
-      web_socket_wait_for(-> { !@switches_statuses[switch[:uuid]].nil? }) do
-        Ewelink.logger.debug(self.class.name) { "Switch #{switch[:uuid].inspect} is #{@switches_statuses[switch[:uuid]]}" }
-        @switches_statuses[switch[:uuid]] == 'on'
+      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,8 +178,8 @@ module Ewelink
         on = false
       end
       switch = find_switch!(uuid)
-      @switches_statuses[switch[:uuid]] = nil
-      web_socket_wait_for(-> { web_socket_authenticated? }) do
+      @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],
@@ -165,6 +194,7 @@ module Ewelink
         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
@@ -177,6 +207,24 @@ module Ewelink
       end
     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
+    end
+
     def authentication_headers
       { 'Authorization' => "Bearer #{authentication_token}" }
     end
@@ -221,36 +269,6 @@ module Ewelink
       end
     end
 
-    def dispose_web_socket
-      @web_socket_authenticated_api_keys = Set.new
-
-      if @web_socket_ping_thread
-        if Thread.current == @web_socket_ping_thread
-          Thread.current[:stop] = true
-        else
-          @web_socket_ping_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_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
@@ -272,7 +290,7 @@ module Ewelink
       method = method.to_s.upcase
       headers = (options[:headers] || {}).reverse_merge('Content-Type' => 'application/json')
       Ewelink.logger.debug(self.class.name) { "#{method} #{url}" }
-      response = HTTParty.send(method.downcase, url, options.merge(headers: headers).reverse_merge(timeout: TIMEOUT))
+      response = HTTParty.send(method.downcase, url, options.merge(headers: headers).reverse_merge(timeout: REQUEST_TIMEOUT))
       raise(Error.new("#{method} #{url}: #{response.code}")) unless response.success?
       if response['error'] == 301 && response['region'].present?
         @region = response['region']
@@ -286,15 +304,43 @@ module Ewelink
       raise Error.new(e)
     end
 
-    def send_to_web_socket(data)
-      if web_socket_outdated_ping?
-        Ewelink.logger.warn(self.class.name) { 'WebSocket ping is outdated' }
-        dispose_web_socket
+    def send_to_web_socket(message)
+      web_socket.send(message)
+    rescue => e
+      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
+      Ewelink.logger.debug(self.class.name) { "Creating thread for WebSocket ping every #{@web_socket_ping_interval} seconds" }
+      @web_socket_ping_thread = Thread.new do
+        loop do
+          break if Thread.current[:stop]
+          sleep(@web_socket_ping_interval)
+          Ewelink.logger.debug(self.class.name) { 'Sending WebSocket ping' }
+          send_to_web_socket('ping')
+        end
       end
-      web_socket.send(data)
-    rescue
-      dispose_web_socket
-      raise
     end
 
     def synchronize(name, &block)
@@ -302,96 +348,82 @@ 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
-        @web_socket ||= begin
-          api = self
+        next @web_socket if @web_socket
 
-          WebSocket::Client::Simple.connect(web_socket_url) do |web_socket|
-            Ewelink.logger.debug(self.class.name) { "Opening WebSocket to #{web_socket_url}" }
+        # Initializes caches before opening WebSocket: important in order to
+        # NOT cumulate requests Timeouts from #web_socket_wait_for.
+        api_keys
+        web_socket_url
 
-            web_socket.on(:close) do
-              api.instance_eval do
-                Ewelink.logger.debug(self.class.name) { 'WebSocket closed' }
-                dispose_web_socket
-              end
+        Ewelink.logger.debug(self.class.name) { "Opening WebSocket to #{web_socket_url.inspect}" }
+
+        @web_socket_thread = Thread.new do
+          EventMachine.run do
+            @web_socket = Faye::WebSocket::Client.new(web_socket_url)
+
+            @web_socket.on(:close) do |event|
+              Ewelink.logger.debug(self.class.name) { 'WebSocket closed' }
+              reload
             end
 
-            web_socket.on(:error) do |e|
-              api.instance_eval do
-                Ewelink.logger.warn(self.class.name) { "WebSocket error: #{e}" }
-                dispose_web_socket
-              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
             end
 
-            web_socket.on(:message) do |message|
-              api.instance_eval do
-                if message.data == 'pong'
-                  Ewelink.logger.debug(self.class.name) { "Received WebSocket #{message.data.inspect} message" }
-                  @last_web_socket_pong_at = Time.now
-                  next
-                end
+            @web_socket.on(:message) do |event|
+              message = event.data
 
-                begin
-                  response = JSON.parse(message.data)
-                rescue => e
-                  Ewelink.logger.error(self.class.name) { "WebSocket JSON parse error" }
-                  next
-                end
+              if message == 'pong'
+                Ewelink.logger.debug(self.class.name) { "Received WebSocket #{message.inspect} message" }
+                @last_web_socket_pong_at = Time.now
+                next
+              end
 
-                if response.key?('error') && response['error'] != 0
-                  Ewelink.logger.error(self.class.name) { "WebSocket message error: #{message.data}" }
-                  next
-                end
+              begin
+                json = JSON.parse(message)
+              rescue => e
+                Ewelink.logger.error(self.class.name) { 'WebSocket JSON parse error' }
+                reload
+                next
+              end
 
-                if !@web_socket_ping_thread && response.key?('config') && response['config'].key?('hbInterval')
-                  @last_web_socket_pong_at = Time.now
-                  # @web_socket_ping_interval = response['config']['hbInterval']
-                  @web_socket_ping_interval = 30.seconds
-                  Ewelink.logger.debug(self.class.name) { "Creating thread for WebSocket ping every #{@web_socket_ping_interval} seconds" }
-                  @web_socket_ping_thread = Thread.new do
-                    loop do
-                      break if Thread.current[:stop]
-                      sleep(@web_socket_ping_interval)
-                      Ewelink.logger.debug(self.class.name) { 'Sending WebSocket ping' }
-                      send_to_web_socket('ping')
-                    end
-                  end
-                end
+              if json.key?('error') && json['error'] != 0
+                Ewelink.logger.error(self.class.name) { "WebSocket message error: #{message.inspect}" }
+                reload
+                next
+              end
 
-                if response['apikey'].present? && !@web_socket_authenticated_api_keys.include?(response['apikey'])
-                  @web_socket_authenticated_api_keys << response['apikey']
-                  Ewelink.logger.debug(self.class.name) { "WebSocket successfully authenticated API key: #{response['apikey'].truncate(16).inspect}" }
-                end
+              if !@web_socket_ping_thread && json.key?('config') && json['config']['hb'] == 1 && json['config']['hbInterval'].present?
+                start_web_socket_ping_thread(json['config']['hbInterval'] + 7)
+              end
 
-                if response['deviceid'].present? && response['params'].is_a?(Hash) && response['params']['switch'].present?
-                  switch = switches.find { |switch| switch[:device_id] == response['deviceid'] }
-                  @switches_statuses[switch[:uuid]] = response['params']['switch'] if switch.present?
-                end
+              if json['apikey'].present? && !@web_socket_authenticated_api_keys.include?(json['apikey'])
+                @web_socket_authenticated_api_keys << json['apikey']
+                Ewelink.logger.debug(self.class.name) { "WebSocket successfully authenticated API key: #{json['apikey'].truncate(16).inspect}" }
               end
-            end
 
-            web_socket.on(:open) do
-              api.instance_eval do
-                Ewelink.logger.debug(self.class.name) { 'WebSocket opened' }
-                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))
+              if json['deviceid'].present? && json['params'].is_a?(Hash) && json['params']['switch'].present?
+                switch = switches.find { |switch| switch[:device_id] == json['deviceid'] }
+                if switch.present?
+                  @web_socket_switches_statuses[switch[:uuid]] = json['params']['switch']
+                  Ewelink.logger.debug(self.class.name) { "Switch #{switch[:uuid].inspect} is #{@web_socket_switches_statuses[switch[:uuid]]}" }
                 end
               end
             end
           end
         end
+
+        web_socket_wait_for(-> { @web_socket.present? }) do
+          @web_socket
+        end
       end
     end
 
@@ -426,16 +458,18 @@ module Ewelink
       end
     end
 
-    def web_socket_wait_for(condition, &block)
-      web_socket # Initializes WebSocket
-      Timeout.timeout(TIMEOUT) do
-        loop do
-          if condition.call
-            return yield if block_given?
-            return true
+    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
-          sleep(WEB_SOCKET_WAIT_INTERVAL)
+          block_given? ? yield : true
         end
+      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.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-02 00:00:00.000000000 Z
+date: 2020-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,45 +31,45 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 7.0.0
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.11.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.11.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
-  name: websocket-client-simple
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement