tp_link_smartplug 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eac4dd14ffb0af2de298ea34c8084b954b927450ea1548f86cffdcebfbb70686
-  data.tar.gz: 2d459cc145b1c311e049a2af193bbb8141b19c6be933acd4a12244d83ff11d9a
+  metadata.gz: 41a05841cdc6ffdd697f903abc1d620debf999f2a9a6c5f248edc9ec93635e30
+  data.tar.gz: c3f77299aaeb6b90506f04730467c70889745d85e47148ba738ccc82de484cbd
 SHA512:
-  metadata.gz: ab4e8ba2f988b6f3b983706eed8dfbdcff0d97f6acb625235b55ddad803f423bc65ab12b8cca93e84b7f3d398b639289453250f82ae799e161f8811e4d9e5b96
-  data.tar.gz: 650a5edc7d2b10a9e67712b6587c1db755c3d700dc412e89820b79890445bac0c9997b9e5c95115b643e9aa0fe90b74d00d5d4a7b4381483c319641843320e59
+  metadata.gz: eac7e52a043aebdeeb595aba15df19be7923d2da40a6d214bb41955f4baf4da1e2853e935cd7ade3b410981bd8698024f9598a923b20a5c0311ed2398dbced01
+  data.tar.gz: 74f0ba6ff80393ee43560a76ec6cab25d94fb1b8b5b3b078884be64b9db274e657053f2c90007df89aa2bde7e849b63a049e4628c91ff4bb90cf1e29b59c7d23

data/lib/tp_link_smartplug.rb

@@ -1,7 +1,11 @@
-# frozen_string_literal: true
+require_relative 'tp_link_smartplug/_base'
+require_relative 'tp_link_smartplug/command'
+require_relative 'tp_link_smartplug/device'
+require_relative 'tp_link_smartplug/helpers'
+require_relative 'tp_link_smartplug/message'
+require_relative 'tp_link_smartplug/version'
 
-require 'tp_link_smartplug/command'
-require 'tp_link_smartplug/device'
-require 'tp_link_smartplug/helpers'
-require 'tp_link_smartplug/message'
-require 'tp_link_smartplug/version'
+# Top level module
+#
+# @author Ben Hughes
+module TpLinkSmartplug; end

data/lib/tp_link_smartplug/_base.rb

@@ -0,0 +1,15 @@
+require_relative 'helpers'
+
+module TpLinkSmartplug
+  # Base plug class.
+  #
+  # @author Ben Hughes
+  class Base
+    include TpLinkSmartplug::Helpers
+  end
+
+  # Base plug error class.
+  #
+  # @author Ben Hughes
+  class BaseError < StandardError; end
+end

data/lib/tp_link_smartplug/command.rb

@@ -1,31 +1,29 @@
-# frozen_string_literal: true
-
 module TpLinkSmartplug
   # Module containing the static commands for the plug
   module Command
     # Plug information command
-    INFO = '{"system":{"get_sysinfo":{}}}'
+    INFO = '{"system":{"get_sysinfo":{}}}'.freeze
     # Plug output on command
-    ON = '{"system":{"set_relay_state":{"state":1}}}'
+    ON = '{"system":{"set_relay_state":{"state":1}}}'.freeze
     # Plug output off command
-    OFF = '{"system":{"set_relay_state":{"state":0}}}'
+    OFF = '{"system":{"set_relay_state":{"state":0}}}'.freeze
     # Plug cloud info command
-    CLOUDINFO = '{"cnCloud":{"get_info":{}}}'
+    CLOUDINFO = '{"cnCloud":{"get_info":{}}}'.freeze
     # Plug WLAN SSID scan command
-    WLANSCAN = '{"netif":{"get_scaninfo":{"refresh":0}}}'
+    WLANSCAN = '{"netif":{"get_scaninfo":{"refresh":0}}}'.freeze
     # Plug time command
-    TIME = '{"time":{"get_time":{}}}'
+    TIME = '{"time":{"get_time":{}}}'.freeze
     # Plug schedule command
-    SCHEDULE = '{"schedule":{"get_rules":{}}}'
+    SCHEDULE = '{"schedule":{"get_rules":{}}}'.freeze
     # Plug countdown command
-    COUNTDOWN = '{"count_down":{"get_rules":{}}}'
+    COUNTDOWN = '{"count_down":{"get_rules":{}}}'.freeze
     # Plug antitheft command
-    ANTITHEFT = '{"anti_theft":{"get_rules":{}}}'
+    ANTITHEFT = '{"anti_theft":{"get_rules":{}}}'.freeze
     # Plug reboot command
-    REBOOT = '{"system":{"reboot":{"delay":1}}}'
+    REBOOT = '{"system":{"reboot":{"delay":1}}}'.freeze
     # Plug reset command
-    RESET = '{"system":{"reset":{"delay":1}}}'
+    RESET = '{"system":{"reset":{"delay":1}}}'.freeze
     # Plug energy command
-    ENERGY = '{"emeter":{"get_realtime":{}}}'
+    ENERGY = '{"emeter":{"get_realtime":{}}}'.freeze
   end
 end

data/lib/tp_link_smartplug/device.rb

@@ -1,10 +1,7 @@
-# frozen_string_literal: true
-
 require 'socket'
 require 'ipaddr'
 require 'json'
-require 'tp_link_smartplug/helpers'
-require 'tp_link_smartplug/message'
+require_relative './message'
 
 module TpLinkSmartplug
   # Provides an object to represent to a plug
@@ -14,17 +11,15 @@ module TpLinkSmartplug
   # @attr [Integer] port Port to connect to on the plug
   # @attr [Integer] timeout Timeout value for connecting and sending commands to the plug
   # @attr [true, false] debug Control debug logging
-  class Device
+  class Device < TpLinkSmartplug::Base
     include TpLinkSmartplug::Helpers
     include TpLinkSmartplug::Message
 
-    attr_accessor :address
-    attr_accessor :port
-    attr_accessor :timeout
-    attr_accessor :poll_auto_close
-    attr_accessor :debug
+    attr_accessor :address, :port, :timeout, :poll_auto_close, :debug
 
     def initialize(address:, port: 9999)
+      super
+
       @address = IPAddr.new(address, Socket::AF_INET)
       @port = port
       @timeout = 3
@@ -44,23 +39,32 @@ module TpLinkSmartplug
 
       begin
         @socket.connect_nonblock(@sockaddr)
+        debug_message('Connected') if @debug
       rescue IO::WaitWritable
         if IO.select(nil, [@socket], nil, timeout)
           begin
             @socket.connect_nonblock(@sockaddr)
           rescue Errno::EISCONN
-            debug_message('Connected') if debug
+            debug_message('Connected') if @debug
+          rescue Errno::ECONNREFUSED
+            @socket.close
+            raise TpLinkSmartplug::DeviceError, "Connection refused connecting to address #{@address}, port #{@port}!"
           rescue StandardError => e
             disconnect
-            debug_message('Unexpected exception encountered.') if debug
-            raise e
+            debug_message("Unexpected exception encountered. Error: #{e}") if @debug
+            raise
           end
         else
           @socket.close
-          raise "Connection timeout connecting to address #{@address}, port #{@port}."
+          raise TpLinkSmartplug::DeviceError, "Connection timeout connecting to address #{@address}, port #{@port}."
         end
       rescue Errno::EISCONN
-        debug_message('Connected') if debug
+        debug_message('Connected') if @debug
+      rescue Errno::EINPROGRESS
+        debug_message('Connection in progress') if @debug
+        retry
+      rescue Errno::ECONNREFUSED
+        raise TpLinkSmartplug::DeviceError, "Connection refused connecting to address #{@address}, port #{@port}."
       end
     end
 
@@ -113,11 +117,11 @@ module TpLinkSmartplug
         raise 'Error occured during disconnect' unless closed?
       end
 
-      raise 'No data received' if data.nil? || data.empty?
+      raise 'No data received' if nil_or_empty?(data)
 
-      debug_message("Received Raw: #{data}") if debug
+      debug_message("Received Raw: #{data}") if @debug
       data = decrypt(data[4..data.length])
-      debug_message("Received Decrypted: #{data}") if debug
+      debug_message("Received Decrypted: #{data}") if @debug
 
       data
     end
@@ -170,11 +174,13 @@ module TpLinkSmartplug
       :antitheft,
       :reboot,
       :reset,
-      :energy
+      :energy,
     ].each do |method|
       define_method method do
         JSON.parse(poll(command: TpLinkSmartplug::Command.const_get(method.upcase)))
       end
     end
   end
+
+  class DeviceError < TpLinkSmartplug::BaseError; end
 end

data/lib/tp_link_smartplug/helpers.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'time'
 
 module TpLinkSmartplug
@@ -10,7 +8,16 @@ module TpLinkSmartplug
     # @param string [String] the message to be formatted for debug output
     def debug_message(string)
       caller_method = caller_locations(1..1).first.label
-      STDOUT.puts(Time.now.strftime('%Y-%m-%d %H:%M:%S: ').concat("#{caller_method}: ").concat(string))
+      $stdout.puts(Time.now.strftime('%Y-%m-%d %H:%M:%S: ').concat("#{caller_method}: ").concat(string))
+    end
+
+    # Tests a variable for nil or empty status
+    #
+    # @param v  the variable to be tested
+    def nil_or_empty?(value)
+      return true if value.nil? || (value.respond_to?(:empty?) && value.empty?)
+
+      false
     end
   end
 end

data/lib/tp_link_smartplug/message.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: false
-
 module TpLinkSmartplug
   # Helper methods for plug communication messages
   module Message

data/lib/tp_link_smartplug/version.rb

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
 # @author Ben Hughes
 module TpLinkSmartplug
   # Gem version
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tp_link_smartplug
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Hughes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2021-01-24 00:00:00.000000000 Z
 dependencies: []
 description: Control and retrieve data from a TP-Link HS100/110 (Metered) Smartplug
 email: bmhughes@bmhughes.co.uk
@@ -17,6 +17,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - "./lib/tp_link_smartplug.rb"
+- "./lib/tp_link_smartplug/_base.rb"
 - "./lib/tp_link_smartplug/command.rb"
 - "./lib/tp_link_smartplug/device.rb"
 - "./lib/tp_link_smartplug/helpers.rb"
@@ -41,8 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: TP-Link HS100/110 Smart Plug interaction library