ewelink 3.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9b83156bba48622088845d22bd8fc3b559d6e8732acf4664ba35886c6c19d35
-  data.tar.gz: d69303e93b04b56fd713fc27220d15c4ab66ca767190a289d6440932dc468532
+  metadata.gz: b8e686b44abcc1c59621d612a64b930f89a0041ac4607070bd47c801f04148ac
+  data.tar.gz: 3990a53b5d57e0c0523ba83050e7af904dd54a96337692a5fc800e6e3d0edaa9
 SHA512:
-  metadata.gz: fa3fd8b8a36ad7e4570db2941ebdffc1d134106ea40ce93866eaebe7b81a4cc0a35920f5366a48c0a9141476101cc03be42adf244b15bcf98eeec64b0e77a312
-  data.tar.gz: d98f59eaec9c582dd0627a52a392c45e98e351676b69d36f081df4ec819153bd32e340ced77440152c674d58013f413d8e42a5e86a50f65d57efce5782f26943
+  metadata.gz: 41aaa80ba63866bf04728c60489ed91b3b8294a61dc7e7d78779628b7530006bd41d306adb4e6a72ccdb1e72ed8322dd94efe897053ed02ce1da977e7560319a
+  data.tar.gz: c6af766c67c28efffd27a4186c3b603e9c4d3ab48e5fb8bc8ca1b52b5ce7aec8969297b932134c3c640ca5ece581ab70c6932ffb8a5597ebb54cc831b9bbfb98

data/README.mdown

@@ -77,6 +77,9 @@ 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`).
 

data/VERSION

@@ -1 +1 @@
-3.2.0
+4.0.0

data/bin/ewelink

@@ -2,7 +2,7 @@
 
 require_relative '../lib/ewelink'
 
-Ewelink.logger = Logger.new(STDOUT, formatter: -> (severity, time, progname, message) {
+Ewelink.logger = Logger.new($stdout, formatter: lambda { |_severity, _time, progname, message|
   text = ''
   text << "[#{progname}] " if progname.present?
   text << message.to_s << "\n"

data/ewelink.gemspec

@@ -9,16 +9,19 @@ Gem::Specification.new do |s|
   s.description = 'Manage eWeLink smart home devices'
   s.license = 'MIT'
 
-  s.files = `git ls-files | grep -vE '^(spec/|test/|\\.|Gemfile|Rakefile)'`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = %x(git ls-files | grep -vE '^(spec/|test/|\\.|Gemfile|Rakefile)').split("\n")
+  s.executables = %x(git ls-files -- bin/*).split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 3.1.0'
 
-  s.add_dependency 'activesupport', '>= 6.0.0', '< 7.0.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.18.0', '< 0.19.0'
+  s.add_dependency 'httparty', '>= 0.20.0', '< 0.21.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'
+  s.add_development_dependency 'rubocop', '>= 1.25.0', '< 2.0.0'
+  s.add_development_dependency 'rubocop-rake', '>= 0.6.0', '< 1.0.0'
 end

data/lib/ewelink/api.rb

@@ -2,14 +2,13 @@ module Ewelink
 
   class Api
 
-    APP_ID = 'oeVkj2lYFGnJu5XUtWisfW4utiN4u9Mq'
-    APP_SECRET = '6Nz4n0xA8s8qdxQf2GqurZj2Fs55FUvM'
-    DEFAULT_REGION = 'us'
+    APP_ID = 'oeVkj2lYFGnJu5XUtWisfW4utiN4u9Mq'.freeze
+    APP_SECRET = '6Nz4n0xA8s8qdxQf2GqurZj2Fs55FUvM'.freeze
+    DEFAULT_REGION = 'us'.freeze
     REQUEST_TIMEOUT = 10.seconds
     RF_BRIDGE_DEVICE_UIID = 28
-    SWITCH_DEVICES_UIIDS = [1, 5, 6, 24]
-    URL = 'https://#{region}-api.coolkit.cc:8080'
-    UUID_NAMESPACE = 'e25750fb-3710-41af-b831-23224f4dd609';
+    SWITCH_DEVICES_UIIDS = [1, 5, 6, 24].freeze
+    URL = 'https://#{region}-api.coolkit.cc:8080'.freeze
     VERSION = 8
     WEB_SOCKET_CHECK_AUTHENTICATION_TIMEOUT = 30.seconds
     WEB_SOCKET_PING_TOLERANCE_FACTOR = 1.5
@@ -18,10 +17,11 @@ module Ewelink
 
     attr_reader :email, :password, :phone_number
 
-    def initialize(email: nil, password:, phone_number: nil, update_devices_status_on_connect: false)
+    def initialize(password:, async_actions: false, email: nil, 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"))
+      @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
@@ -32,25 +32,31 @@ 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
@@ -78,19 +84,19 @@ module Ewelink
         end
       end
 
-      [
-        :@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|
+      %i(
+        @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
       self
@@ -108,10 +114,10 @@ module Ewelink
             device_name = device['name'].presence || next
             buttons = device['params']['rfList'].each do |rf|
               button = {
-                api_key: api_key,
+                api_key:,
                 channel: rf['rfChl'],
-                device_id: device_id,
-                device_name: device_name,
+                device_id:,
+                device_name:,
               }
               remote_info = device['tags']['zyx_info'].find { |info| info['buttonName'].find { |data| data.key?(button[:channel].to_s) } }.presence || next
               remote_name = remote_info['name'].try(:squish).presence || next
@@ -119,10 +125,10 @@ module Ewelink
               button_name = button_info.values.first.try(:squish).presence || next
               button.merge!({
                 name: button_name,
-                remote_name: remote_name,
+                remote_name:,
                 remote_type: remote_info['remote_type'],
               })
-              button[:uuid] = Digest::UUID.uuid_v5(UUID_NAMESPACE, "#{button[:device_id]}/#{button[:channel]}")
+              button[:uuid] = Digest::UUID.uuid_v5(Digest::UUID::DNS_NAMESPACE, "#{button[:device_id]}/#{button[:channel]}")
               buttons << button
             end
           end
@@ -160,11 +166,11 @@ module Ewelink
             device_id = device['deviceid'].presence || next
             name = device['name'].presence || next
             switch = {
-              api_key: api_key,
-              device_id: device_id,
-              name: name,
+              api_key:,
+              device_id:,
+              name:,
             }
-            switch[:uuid] = Digest::UUID.uuid_v5(UUID_NAMESPACE, switch[:device_id])
+            switch[:uuid] = Digest::UUID.uuid_v5(Digest::UUID::DNS_NAMESPACE, switch[:device_id])
             switches << switch
           end
         end.tap { |switches| Ewelink.logger.debug(self.class.name) { "Found #{switches.size} switch(es)" } }
@@ -172,31 +178,33 @@ 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?
@@ -246,7 +254,7 @@ module Ewelink
             params['phoneNumber'] = phone_number
           end
           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))}" } })
+          response = rest_request(:post, '/api/user/login', { body:, headers: { 'Authorization' => "Sign #{Base64.encode64(OpenSSL::HMAC.digest('SHA256', APP_SECRET, body))}" } })
           raise(Error.new('Authentication token not found')) if response['at'].blank?
           raise(Error.new('API key not found')) if response['user'].blank? || response['user']['apikey'].blank?
           {
@@ -289,6 +297,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)
+      true
+    end
+
     def region
       @region ||= DEFAULT_REGION
     end
@@ -298,7 +313,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: REQUEST_TIMEOUT))
+      response = HTTParty.send(method.downcase, url, options.merge(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']
@@ -375,12 +390,12 @@ module Ewelink
           EventMachine.run do
             @web_socket = Faye::WebSocket::Client.new(web_socket_url)
 
-            @web_socket.on(:close) do |event|
+            @web_socket.on(:close) do
               Ewelink.logger.debug(self.class.name) { 'WebSocket closed' }
               reload
             end
 
-            @web_socket.on(:open) do |event|
+            @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
@@ -397,7 +412,7 @@ module Ewelink
 
               begin
                 json = JSON.parse(message)
-              rescue => e
+              rescue
                 Ewelink.logger.error(self.class.name) { 'WebSocket JSON parse error' }
                 reload
                 next
@@ -420,7 +435,7 @@ module Ewelink
               end
 
               if json['deviceid'].present? && json['params'].is_a?(Hash) && json['params']['switch'].present?
-                switch = switches.find { |switch| switch[:device_id] == json['deviceid'] }
+                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]]}" }
@@ -467,13 +482,11 @@ module Ewelink
       end
     end
 
-    def web_socket_wait_for(condition, initialize_web_socket: false, &block)
+    def web_socket_wait_for(condition, initialize_web_socket: false)
       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) until condition.call
           block_given? ? yield : true
         end
       rescue => e

data/lib/ewelink/runner.rb

@@ -3,13 +3,13 @@ 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) }
       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)) if options[:switch_status_uuids].present?
+      puts(JSON.pretty_generate(options[:switch_status_uuids].to_h { |uuid| [uuid, api.switch_on?(uuid) ? 'on' : 'off'] })) if options[:switch_status_uuids].present?
     end
 
     private
@@ -56,23 +56,21 @@ module Ewelink
         end
         arguments = parser.parse!
         if arguments.any?
-          STDERR.puts("Invalid option specified: #{arguments.first}")
-          STDERR.puts(parser.summarize)
+          warn("Invalid option specified: #{arguments.first}")
+          warn(parser.summarize)
           exit(1)
         end
         if options[:email].blank? && options[:phone_number].blank?
-          STDERR.puts('Email or phone number must be specified')
-          STDERR.puts(parser.summarize)
+          warn('Email or phone number must be specified')
+          warn(parser.summarize)
           exit(1)
         end
-        if [:list_switches, :list_rf_bridge_buttons, :turn_switches_on_uuids, :turn_switches_off_uuids, :press_rf_bridge_buttons_uuids, :switch_status_uuids].map { |action| options[action] }.all?(&:blank?)
-          STDERR.puts('An action must be specified (listing switches, press RF bridge button, etc.)')
-          STDERR.puts(parser.summarize)
+        if %i(list_switches list_rf_bridge_buttons turn_switches_on_uuids turn_switches_off_uuids press_rf_bridge_buttons_uuids switch_status_uuids).map { |action| options[action] }.all?(&:blank?)
+          warn('An action must be specified (listing switches, press RF bridge button, etc.)')
+          warn(parser.summarize)
           exit(1)
         end
-        while options[:password].blank?
-          options[:password] = IO::console.getpass("Enter eWeLink account's password: ")
-        end
+        options[:password] = IO.console.getpass("Enter eWeLink account's password: ") while options[:password].blank?
         options
       end
     end

data/lib/ewelink.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ewelink
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2022-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 7.0.0
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -56,20 +56,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.21.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,60 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 13.0.0
     - - "<"
+      - !ruby/object:Gem::Version
+        version: 14.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: 13.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 14.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 1.25.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 13.0.0
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: Manage eWeLink smart home devices
 email: al@alweb.org
 executables:
@@ -137,14 +197,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Manage eWeLink devices