ewelink 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2f26d6875823958f38a894377c7dfbce3531d7f98b1c1c69b18bd88caf44c1d
-  data.tar.gz: d25335eb91529c57d2780c42e8cef5856cb7bfa7f222e5282816bff122854b08
+  metadata.gz: '03889642d2851312650d6419544fd7423b2b8ca0a64a272386de46646640b191'
+  data.tar.gz: b36f496794dce02953b423d601f4e71905afca7c0aebe4fe5bfc65d08f65daff
 SHA512:
-  metadata.gz: 42786625ddc6d8482a5d85922e25b4b650e080866148b378aeb579ad25e0dcee00d4f12b8ebf74492e207d80e6ed0d65b6f0c71ccdaf5c3f81280b1efbd4bc7b
-  data.tar.gz: 8eb9cc344312a30a7b0924ff02b052516bf5123a7d706acb15e000b91db2c91ecf56a2173d22543403f7fbbc31773e30d97d3c5379ad37ab42e34b55f8f67366
+  metadata.gz: c3a3349b5c5f5384eb4f02abcf3749b0674ef839c2354f38d319db4ff15e272f7ec551058b52601a1971307f225eac8d0c5c7cfee00d6537a527bb09f044aceb
+  data.tar.gz: 63035965d8732f4fda004b16331ee06a4ad6f55da7a4338b041585823397b14bb6dfecacf83123354b024f2a9fb8e1b724d32011862d9343babec527fff12d2e

data/README.mdown

@@ -80,8 +80,6 @@ api.press_rf_bridge_button!(button[:uuid])
 - `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
 

data/VERSION

@@ -1 +1 @@
-5.0.0
+6.0.0

data/ewelink.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 3.1.0'
 
   s.add_dependency 'activesupport', '>= 7.0.0', '< 8.0.0'
-  s.add_dependency 'faye-websocket', '>= 0.11.0', '< 0.12.0'
   s.add_dependency 'httparty', '>= 0.20.0', '< 0.21.0'
   s.add_dependency 'thread', '>= 0.2.0', '< 0.3.0'
 

data/lib/ewelink/api.rb

@@ -11,26 +11,17 @@ module Ewelink
     SWITCH_DEVICES_UIIDS = [1, 5, 6, 24].freeze
     URL = 'https://#{region}-apia.coolkit.cc'.freeze
     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(password:, async_actions: false, email: nil, phone_number: nil, update_devices_status_on_connect: false)
+    def initialize(password:, async_actions: false, email: nil, phone_number: nil)
       @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 = {}
 
       raise(Error.new(':email or :phone_number must be specified')) if email.blank? && phone_number.blank?
-
-      start_web_socket_authentication_check_thread
     end
 
     def async_actions?
@@ -63,39 +54,13 @@ module Ewelink
     def reload
       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
-
       %i(
         @authentication_infos
         @devices
         @homes_ids
-        @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
@@ -138,23 +103,18 @@ 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? }, 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(-> { !@web_socket_switches_statuses[switch[:uuid]].nil? }, initialize_web_socket: true) do
-        @web_socket_switches_statuses[switch[:uuid]] == 'on'
-      end
+      headers = authentication_headers.merge(
+        'X-CK-Appid' => APP_ID,
+        'X-CK-Nonce' => nonce,
+      )
+      params = {
+        'type' => 1,
+        'id' => switch[:device_id],
+        'params' => 'switch',
+      }
+      Ewelink.logger.debug(self.class.name) { "Checking switch #{switch[:uuid].inspect} status" }
+      response = rest_request(:get, '/v2/device/thing/status', headers:, query: params)
+      response['data']['params']['switch'] == 'on'
     end
 
     def switches
@@ -186,54 +146,30 @@ module Ewelink
           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
+        headers = authentication_headers.merge(
+          'X-CK-Appid' => APP_ID,
+          'X-CK-Nonce' => nonce,
+        )
+        params = {
+          'type' => 1,
+          'id' => switch[:device_id],
+          'params' => {
+            'switch' => on ? 'on' : 'off',
+          },
+        }
+        body = JSON.generate(params)
+        Ewelink.logger.debug(self.class.name) { "Turning switch #{switch[:uuid].inspect} #{on ? 'on' : 'off'}" }
+        response = rest_request(:post, '/v2/device/thing/status', headers:, body:)
+        response['error'] == 0
       end
     end
 
-    def update_devices_status_on_connect?
-      @update_devices_status_on_connect
-    end
-
     private
 
     def api_key
       authentication_infos[:api_key]
     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
@@ -353,173 +289,10 @@ module Ewelink
       raise Error.new(e)
     end
 
-    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
-    end
-
     def synchronize(name, &block)
       (@mutexs[name] ||= Mutex.new).synchronize(&block)
     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
-            @web_socket = Faye::WebSocket::Client.new(web_socket_url)
-
-            @web_socket.on(:close) do
-              Ewelink.logger.debug(self.class.name) { 'WebSocket closed' }
-              reload
-            end
-
-            @web_socket.on(:open) do
-              Ewelink.logger.debug(self.class.name) { 'WebSocket opened' }
-              @last_web_socket_pong_at = Time.now
-              authenticate_web_socket_api_key
-            end
-
-            @web_socket.on(:message) do |event|
-              message = event.data
-
-              if message == 'pong'
-                Ewelink.logger.debug(self.class.name) { "Received WebSocket #{message.inspect} message" }
-                @last_web_socket_pong_at = Time.now
-                next
-              end
-
-              begin
-                json = JSON.parse(message)
-              rescue
-                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
-
-              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 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?
-                switch = switches.find { |item| item[: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
-
-    def web_socket_authenticated?
-      @web_socket_authenticated.present?
-    end
-
-    def web_socket_outdated_ping?
-      @last_web_socket_pong_at.present? && @web_socket_ping_interval.present? && @last_web_socket_pong_at < (@web_socket_ping_interval * WEB_SOCKET_PING_TOLERANCE_FACTOR).seconds.ago
-    end
-
-    def web_socket_sequence
-      (Time.now.to_f * 1000).round.to_s
-    end
-
-    def web_socket_url
-      synchronize(:web_socket_url) do
-        @web_socket_url ||= begin
-          params = {
-            'appid' => APP_ID,
-            'nonce' => nonce,
-            'ts' => Time.now.to_i,
-            'version' => VERSION,
-          }
-          response = rest_request(:post, '/dispatch/app', body: JSON.generate(params), dispatch: true, headers: authentication_headers)
-          raise('Error while getting WebSocket URL') unless response['error'] == 0
-          domain = response['domain'].presence || raise("Can't get WebSocket server domain")
-          port = response['port'].presence || raise("Can't get WebSocket server port")
-          "wss://#{domain}:#{port}/api/ws".tap { |url| Ewelink.logger.debug(self.class.name) { "WebSocket URL is: #{url.inspect}" } }
-        end
-      end
-    end
-
-    def web_socket_wait_for(condition, initialize_web_socket: false)
-      web_socket if initialize_web_socket
-      begin
-        Timeout.timeout(REQUEST_TIMEOUT) do
-          sleep(WEB_SOCKET_WAIT_INTERVAL) until condition.call
-          block_given? ? yield : true
-        end
-      rescue => e
-        reload
-        raise Error.new(e)
-      end
-    end
-
   end
 
 end

data/lib/ewelink.rb

@@ -1,8 +1,6 @@
 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ewelink
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-09 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,26 +30,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 8.0.0
-- !ruby/object:Gem::Dependency
-  name: faye-websocket
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement