ewelink 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f2548dd14bcfce1ce4cacb1a2768687d88e15bb4dae14223cadccd61176ab3d
-  data.tar.gz: 995f4281dd22f168ffe90dc2f072209bd25b13487bb171d5dbcc4efc94380811
+  metadata.gz: 97046b44715a988f6ae92d986c0fad17ab4d5cae6420a125c10f23854cfaadc9
+  data.tar.gz: b95e52d88f8d57d5bf9f54b67d5a8c0779d26b66faadbc252e13eadb80854292
 SHA512:
-  metadata.gz: 74821997ef9c625b2506ebda9229ddac0605f7e4dda4ac836c60974fa6d17a2ebcb9cfd306947c60d958409e5277b6d2ebe1189effef32f91730bfa0be2a9883
-  data.tar.gz: 0d1999216c2006a5f70102190196a9c890ef9ab0c9aa6464402f8c843a51c8211852c560e62778d901eb91bf19f331f1008dd500b998cb59daf6ebe72477e5b1
+  metadata.gz: f153a280ff50b245434b2039cd3bb88341da6bd7688556a8a7c3fe4558a2b13a6be5c1497f5b06dc381495cb63d8c26d4d3f2625ea5bd4148e4c55a2f28b2faf
+  data.tar.gz: e3b69fa1607599325ea0f2867fbd0d32fd3abd56a4e7bd8d07107e083d4ebbfaf919bc4af34b28948163d1fb5340a53489aec1839cc59ba238f2917a8db03cc5

data/VERSION

@@ -1 +1 @@
-1.3.0
+2.0.0

data/ewelink.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activesupport', '>= 6.0.0', '< 7.0.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

@@ -7,6 +7,9 @@ require 'json'
 require 'logger'
 require 'openssl'
 require 'optparse'
+require 'set'
+require 'timeout'
+require 'websocket-client-simple'
 
 module Ewelink
 

data/lib/ewelink/api.rb

@@ -7,10 +7,11 @@ module Ewelink
     DEFAULT_REGION = 'us'
     RF_BRIDGE_DEVICE_UIID = 28
     SWITCH_DEVICES_UIIDS = [1, 5, 6, 24]
-    TIMEOUT = 10
+    TIMEOUT = 10.seconds
     URL = 'https://#{region}-api.coolkit.cc:8080'
     UUID_NAMESPACE = 'e25750fb-3710-41af-b831-23224f4dd609';
     VERSION = 8
+    WEB_SOCKET_WAIT_INTERVAL = 0.2.seconds
 
     attr_reader :email, :password, :phone_number
 
@@ -19,31 +20,38 @@ 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?
     end
 
     def press_rf_bridge_button!(uuid)
       synchronize(:press_rf_bridge_button) do
         button = find_rf_bridge_button!(uuid)
-        params = {
-          'appid' => APP_ID,
-          'deviceid' => button[:device_id],
-          'nonce' => nonce,
-          'params' => {
-            'cmd' => 'transmit',
-            'rfChl' => button[:channel],
-          },
-          'ts' => Time.now.to_i,
-          'version' => VERSION,
-        }
-        rest_request(:post, '/api/user/device/status', body: JSON.generate(params), headers: authentication_headers)
-        true
+        web_socket_wait_for(-> { web_socket_authenticated? }) 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',
+          }
+          send_to_web_socket(JSON.generate(params))
+          true
+        end
       end
     end
 
     def reload
-      Ewelink.logger.debug(self.class.name) { 'Reloading API (authentication token, devices & region cache)' }
-      [:@authentication_token, :@devices, :@rf_bridge_buttons, :@region, :@switches].each do |variable|
+      Ewelink.logger.debug(self.class.name) { 'Reloading API (authentication token, devices, region,...)' }
+      dispose_web_socket
+      @switches_statuses.clear
+      [:@api_keys, :@authentication_token, :@devices, :@rf_bridge_buttons, :@region, :@switches, :@web_socket, :@web_socket_url].each do |variable|
         remove_instance_variable(variable) if instance_variable_defined?(variable)
       end
       self
@@ -56,10 +64,12 @@ module Ewelink
             Ewelink.logger.debug(self.class.name) { "Found #{devices.size} RF 433MHz bridge device(s)" }
           end
           rf_bridge_devices.each do |device|
+            api_key = device['apikey'].presence || next
             device_id = device['deviceid'].presence || next
             device_name = device['name'].presence || next
             buttons = device['params']['rfList'].each do |rf|
               button = {
+                api_key: api_key,
                 channel: rf['rfChl'],
                 device_id: device_id,
                 device_name: device_name,
@@ -83,15 +93,22 @@ module Ewelink
 
     def switch_on?(uuid)
       switch = find_switch!(uuid)
-      params = {
-        'appid' => APP_ID,
-        'deviceid' => switch[:device_id],
-        'nonce' => nonce,
-        'ts' => Time.now.to_i,
-        'version' => VERSION,
-      }
-      response = rest_request(:get, '/api/user/device/status', headers: authentication_headers, query: params)
-      response['params']['switch'] == 'on'
+      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
+          send_to_web_socket(JSON.generate(params))
+        end
+      end
+      web_socket_wait_for(-> { !@switches_statuses[switch[:uuid]].nil? }) do
+        @switches_statuses[switch[:uuid]] == 'on'
+      end
     end
 
     def switches
@@ -99,9 +116,11 @@ module Ewelink
         @switches ||= [].tap do |switches|
           switch_devices = devices.select { |device| SWITCH_DEVICES_UIIDS.include?(device['uiid']) }
           switch_devices.each do |device|
+            api_key = device['apikey'].presence || next
             device_id = device['deviceid'].presence || next
             name = device['name'].presence || next
             switch = {
+              api_key: api_key,
               device_id: device_id,
               name: name,
             }
@@ -119,22 +138,32 @@ module Ewelink
         on = false
       end
       switch = find_switch!(uuid)
-      params = {
-        'appid' => APP_ID,
-        'deviceid' => switch[:device_id],
-        'nonce' => nonce,
-        'params' => {
-          'switch' => on ? 'on' : 'off',
-        },
-        'ts' => Time.now.to_i,
-        'version' => VERSION,
-      }
-      rest_request(:post, '/api/user/device/status', body: JSON.generate(params), headers: authentication_headers)
-      true
+      @switches_statuses[switch[:uuid]] = nil
+      web_socket_wait_for(-> { web_socket_authenticated? }) 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',
+        }
+        send_to_web_socket(JSON.generate(params))
+        true
+      end
     end
 
     private
 
+    def api_keys
+      synchronize(:api_keys) do
+        @api_keys ||= Set.new(devices.map { |device| device['apikey'] })
+      end
+    end
+
     def authentication_headers
       { 'Authorization' => "Bearer #{authentication_token}" }
     end
@@ -179,6 +208,18 @@ module Ewelink
       end
     end
 
+    def dispose_web_socket
+      @web_socket_authenticated_api_keys = Set.new
+      if instance_variable_defined?(:@web_socket)
+        begin
+          @web_socket.close if @web_socket.open?
+        rescue
+          # Ignoring close errors
+        end
+        remove_instance_variable(:@web_socket) if instance_variable_defined?(:@web_socket)
+      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
@@ -209,15 +250,127 @@ module Ewelink
       end
       remove_instance_variable(:@authentication_token) if instance_variable_defined?(:@authentication_token) && [401, 403].include?(response['error'])
       raise(Error.new("#{method} #{url}: #{response['error']} #{response['msg']}".strip)) if response['error'].present? && response['error'] != 0
-      response
+      response.to_h
     rescue Errno::ECONNREFUSED, OpenSSL::OpenSSLError, SocketError, Timeout::Error => e
       raise Error.new(e)
     end
 
+    def send_to_web_socket(data)
+      web_socket.send(data)
+    rescue
+      dispose_web_socket
+      raise
+    end
+
     def synchronize(name, &block)
       (@mutexs[name] ||= Mutex.new).synchronize(&block)
     end
 
+    def web_socket
+      synchronize(:web_socket) do
+        @web_socket ||= begin
+          api = self
+
+          WebSocket::Client::Simple.connect(web_socket_url) do |web_socket|
+            Ewelink.logger.debug(self.class.name) { "Opening WebSocket to #{web_socket_url}" }
+
+            web_socket.on(:close) do
+              api.instance_eval do
+                Ewelink.logger.debug(self.class.name) { 'WebSocket closed' }
+                dispose_web_socket
+              end
+            end
+
+            web_socket.on(:error) do |e|
+              api.instance_eval do
+                Ewelink.logger.warn(self.class.name) { "WebSocket error: #{e}" }
+                dispose_web_socket
+              end
+            end
+
+            web_socket.on(:message) do |message|
+              api.instance_eval do
+                response = JSON.parse(message.data)
+
+                if response.key?('error') && response['error'] != 0
+                  Ewelink.logger.error(self.class.name) { "WebSocket message error: #{message.data}" }
+                  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'].inspect}" }
+                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
+              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.inspect}" }
+                  send_to_web_socket(JSON.generate(params))
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def web_socket_authenticated?
+      api_keys == @web_socket_authenticated_api_keys
+    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 = {
+            'accept' => 'ws',
+            'appid' => APP_ID,
+            'nonce' => nonce,
+            'ts' => Time.now.to_i,
+            'version' => VERSION,
+          }
+          response = rest_request(:post, '/dispatch/app', body: JSON.generate(params), 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, &block)
+      web_socket # Initializes WebSocket
+      Timeout.timeout(TIMEOUT) do
+        loop do
+          return yield if condition.call
+          sleep(WEB_SOCKET_WAIT_INTERVAL)
+        end
+      end
+    end
+
   end
 
 end

data/lib/ewelink/runner.rb

@@ -9,7 +9,7 @@ module Ewelink
       options[:turn_switches_on_uuids].each { |uuid| api.turn_switch!(uuid, :on) }
       options[:turn_switches_off_uuids].each { |uuid| api.turn_switch!(uuid, :off) }
       options[:press_rf_bridge_buttons_uuids].each { |uuid| api.press_rf_bridge_button!(uuid) }
-      puts(JSON.pretty_generate(options[:switch_status_uuids].map { |uuid| [uuid, api.switch_on?(uuid) ? 'on' : 'off'] }.to_h))
+      puts(JSON.pretty_generate(options[:switch_status_uuids].map { |uuid| [uuid, api.switch_on?(uuid) ? 'on' : 'off'] }.to_h)) if options[:switch_status_uuids].present?
     end
 
     private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ewelink
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-31 00:00:00.000000000 Z
+date: 2020-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -50,6 +50,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement