tp_link_smartplug 0.1.0.alpha1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23a1848523acc948dd653d39fa3b9cec937bdba9d2a0ad6970308bac4af64d8d
-  data.tar.gz: dd4d4a0fda92aeabfdc7adfb5f751f1b957438b168e5c96efaf4950d69e1bb3d
+  metadata.gz: c2553721065bc41fadca17408f6baacfa4fab953ec5df3e33d778c967910892f
+  data.tar.gz: 8b16c4709a255057a9db1f98b1e825d6e79eda470423a14e16da655db4be44f5
 SHA512:
-  metadata.gz: e2259524ac344b200b19d4824178dfe18b5b7d92c8fbead1b3a4c40f3c073a3078b529f73bf035c4e1505f9827c9323f2f5c8e98f8076270783ed701d1ce6058
-  data.tar.gz: 24ae9be641e069804c884abd18594ee8a2c355370033c06c36091dff990c0846325cc9878c1e08550658e88fabebe42e98ce60b0edf82cc57f71006b0b5d1753
+  metadata.gz: e9bf31292404284bc0705955133b20fcdf75bd34cf7e10e71b84e9332834c92f03697df54bfc472ae0502165771b64402c1c31cbdc1759414975a5820d5aaa80
+  data.tar.gz: a137ee0a57e53f4d85aa6841ac58cfdf1d14d29bf5e800759398a8d6767bb9e4b8b3a4a4249f002ea446ebc6d1e863f1f7de6e4cf10d80c0562ed7800d555cf2

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,17 @@
+require_relative 'helpers'
+
+module TpLinkSmartplug
+  # Base plug class.
+  #
+  # @author Ben Hughes
+  class Base
+    include TpLinkSmartplug::Helpers
+
+    def initialize; end
+  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,22 +11,22 @@ 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 :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
       @debug = false
-      @sockaddr = Addrinfo.getaddrinfo(address.to_s, port, Socket::PF_INET, :STREAM, 6).first.to_sockaddr
+      @sockaddr = Addrinfo.getaddrinfo(@address.to_s, @port, Socket::PF_INET, :STREAM, 6).first.to_sockaddr
       @socket = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM)
+      @poll_auto_close = true
     end
 
     # Open connection to plug
@@ -42,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
 
@@ -68,21 +74,23 @@ module TpLinkSmartplug
       @socket.close unless @socket.closed?
     end
 
-    # Return connection state
+    alias_method :close, :disconnect
+
+    # Return connection state open
     #
     # @return [True, False]
     def open?
       !@socket.closed?
     end
 
-    # Return connection state
+    # Return connection state closed
     #
     # @return [True, False]
     def closed?
       @socket.closed?
     end
 
-    # Polls a plug with a command
+    # Polls plug with a command
     #
     # @param command [String] the command to send to the plug
     # @return [Hash] the output from the plug command
@@ -102,16 +110,18 @@ module TpLinkSmartplug
       rescue IO::WaitReadable
         IO.select([@socket])
         retry
-      ensure
-        disconnect unless closed?
       end
 
-      raise 'Error occured during disconnect' unless closed?
-      raise 'No data received' if data.nil? || data.empty?
+      if @poll_auto_close && !closed?
+        disconnect
+        raise 'Error occured during disconnect' unless closed?
+      end
+
+      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
@@ -164,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.0.1'
+  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.alpha1
+  version: 0.2.1
 platform: ruby
 authors:
 - Ben Hughes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-08 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"
@@ -25,7 +26,8 @@ files:
 homepage: https://github.com/bmhughes/tp_link_smartplug
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  github_repo: ssh://github.com/bmhughes/tp_link_smartplug
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -37,12 +39,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      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