ewelink 3.3.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d4567a179d6caccebab59ae35e794c4826419b6147461a9f6d9aaf268dea875
-  data.tar.gz: d79d86055e3a9c2d5dbc9d2a89be4f4fc60b2a53cd863084a17b13740d7db02e
+  metadata.gz: 8cba69a24adaf18a0be08cbf1618b612d6d0e90fd788d8b9f2360f7d19f67406
+  data.tar.gz: adc650eac1533d343320490132302827a79f0fc4a0571d0dcba91ef926e5f682
 SHA512:
-  metadata.gz: b79ebc640d8452951fc967ba52a99f6c5d09ccd486b3a6fdf17e10e23abdec94b2933d54566324f214972b6d7c22484c70ab76f0dbc8266a2c806c207f65373b
-  data.tar.gz: 42a11ae61affa75e02924cfa8408851568e0a67c33ba9a21d7a7fe3a42d2b025e0909720b371d6cf9b21bc53ad75862ff91216df8a760dd391b1a1b1e5653da1
+  metadata.gz: 39ab9a66085401bb70f34f74b9220e70ad691c5db65b180816d5a284462162064364d6e6ed3f2b5d990f9c3fa3450472fb0b13ba0b3ecbca1a22042de3926d28
+  data.tar.gz: 19b1627d07a411ef4fe04578f924a7d339413d65d7132b8cd7614877b1e72300b5cbd51f1f9a6469807fe3179e37a65c048f1e699601c4eb3b4f05b82b0e663f

data/VERSION

@@ -1 +1 @@
-3.3.1
+4.1.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,17 +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', '>= 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,11 +17,11 @@ module Ewelink
 
     attr_reader :email, :password, :phone_number
 
-    def initialize(async_actions: false, 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
@@ -85,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
@@ -115,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
@@ -126,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
@@ -167,11 +166,12 @@ 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:,
+              model: device['productModel'],
+              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)" } }
@@ -255,7 +255,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?
           {
@@ -302,7 +302,7 @@ module Ewelink
       return yield unless async_actions?
       @async_actions_thread_pool ||= Thread.pool(1)
       @async_actions_thread_pool.process(&block)
-      nil
+      true
     end
 
     def region
@@ -314,7 +314,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']
@@ -391,12 +391,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
@@ -413,7 +413,7 @@ module Ewelink
 
               begin
                 json = JSON.parse(message)
-              rescue => e
+              rescue
                 Ewelink.logger.error(self.class.name) { 'WebSocket JSON parse error' }
                 reload
                 next
@@ -436,7 +436,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]]}" }
@@ -483,13 +483,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

@@ -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)) 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ewelink
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2022-03-20 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,20 @@ 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
@@ -130,6 +130,46 @@ dependencies:
     - - "<"
       - !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: 1.25.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        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:
@@ -157,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.2.15
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Manage eWeLink devices