synaccess_connect 0.2.2 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmRjYmQ0NmU2ZTE2Y2IwZTZiOGNjZGUwYTgyM2M5ZTk2MTIxNGI1OQ==
+    ZmIyY2NiZjNjYjU0OGJkN2ZiYzQwOTMzODQwNWFjODczN2I4Zjc0Yw==
   data.tar.gz: !binary |-
-    YTkyZGExYmZiMjA3ZDcxMTRlZjk4NjA0YzRlMTU5NThlYTU2YjUwNg==
+    ODYwYzRjM2E2ODdhNjRlOWM2OGU4MWE1MTFkYjBhMmYwMWVhMDVkMQ==
 SHA512:
   metadata.gz: !binary |-
-    MmU2NWFhMGVjMDg2MTdkMWZiMTA0MThlZmY2MTU4OGE1OGMzNGY0Y2ZmZjQ0
-    NzRhMGMzZTExNGRjYjZmMjBhZDdiNGZkNDA0MDEyZWU5OWRjYzI0NGVhNDQ0
-    MjM1YWJlNWYwODQxZTUyZDVjNTNiZWM4ZjZkNjMzMjBhZDI2ZGE=
+    NTlmZWJhOWM3ZDJmMmY0NDRiZjM3YTgwNWQ4NmZmMmZjYTlkNzcwODM0NjY4
+    OWM0MDY2ZjIxNjM0MzYyZGQ1MDExNGVhZjNmMDk5MGJhNzZlNDEwNDZlMGQz
+    MWE3YTI3YmY2Y2Q1MTRlMzU4OTA5YzczMzNhYjMzNDhlOWQ1MGU=
   data.tar.gz: !binary |-
-    ODg5NGEwNjdjYTIyMzU2YzgwNjQwNmY1NTVmZDdlOGMyZDk4MTAyODcwOTE2
-    ZDcyOTQzZjE0MWIxY2YxN2VjMzgzYTgzYzJhYmZmNzhmY2E0YWMwNzIxOGU5
-    MjJkNDE4OGM2OWZmMzJiNDQ0YWNkMzNiN2VjNGU5MGRkYWNjNjg=
+    YTBjZjdiODU0NDU0MWY1OGEwYzUyYmY3M2JlYWZhNTQ4N2M2YmRkMzc5ZTZk
+    ZDJiNTM4YWI4NjIyMTliNDMwN2Q2NGE1NTE3ZGJmMjA1MTcyNTMzMmEwZTcw
+    NGFjYzRmMzllOTg3NzY3NDQyYTMzN2FjMDQ4YjMxY2ZjN2Q4MGE=

data/README.md

@@ -12,19 +12,25 @@ Communication wrappers for Synaccess netBooter power relays.
         Http
             RevA
             RevB
-        Telnet
-            RevA
-            RevB
 ```
 
-## New connections
+The Telnet interface was removed in version 0.3.0 because it was unreliable. You
+should switch to using the Http interface.
 
-`connection = NetBooter::PROTOCOL::RevX.new('XXX.XXX.XXX.XXX', options)`
+## Usage
 
-Options:
+* Add `gem "synaccess_connect", "~> 0.3.0" to your Gemfile.
 
-   * username
-   * password
+## Example
+
+```ruby
+connection = NetBooter::Http::RevA.new('XXX.XXX.XXX.XXX', username: "admin", password: "admin")
+connection.status(1)
+=> true
+connection.toggle(false, 1)
+connection.status(1)
+=> false
+```
 
 ## Interface
 

data/lib/synaccess_connect.rb

@@ -1,34 +1,5 @@
-module NetBooter
-  module Telnet
-  end
-  module Http
-  end
-end
-
 require 'synaccess_connect/net_booter/error'
-require 'synaccess_connect/net_booter/telnet/telnet_connection'
-require 'synaccess_connect/net_booter/telnet/rev_a'
-require 'synaccess_connect/net_booter/telnet/rev_b'
-
-require 'synaccess_connect/net_booter/http/http_connection'
-require 'synaccess_connect/net_booter/http/rev_a'
-require 'synaccess_connect/net_booter/http/rev_b'
-
+require 'synaccess_connect/net_booter/http'
 
-
-# if defined?(Rails)
-#   module SynaccessConnect
-#     class Railtie < Rails::Railtie
-#       # initializer "carrierwave.setup_paths" do
-#       #   CarrierWave.root = Rails.root.join(Rails.public_path).to_s
-#       #   CarrierWave.base_path = ENV['RAILS_RELATIVE_URL_ROOT']
-#       # end
-
-#       # initializer "carrierwave.active_record" do
-#       #   ActiveSupport.on_load :active_record do
-#       #     require 'carrierwave/orm/activerecord'
-#       #   end
-#       # end
-#     end
-#   end
-# end
+module NetBooter
+end

data/lib/synaccess_connect/net_booter/http.rb

@@ -0,0 +1,8 @@
+require 'synaccess_connect/net_booter/http/http_connection'
+require 'synaccess_connect/net_booter/http/rev_a'
+require 'synaccess_connect/net_booter/http/rev_b'
+
+module NetBooter
+  module Http
+  end
+end

data/lib/synaccess_connect/net_booter/http/http_connection.rb

@@ -1,128 +1,133 @@
-require "net/http"
+require 'net/http'
 require 'nokogiri'
 
-class NetBooter::HttpConnection
-  def initialize(host, options = {})
-    @host = host
-    @options = {
-      :port => 80
-    }.merge(options)
-  end
+module NetBooter
+
+  class HttpConnection
 
-  # Get the status of an outlet
-  #
-  # Example:
-  #   >> netbooter.status(2)
-  #   => false
-  #
-  # Arguments:
-  # +outlet+ Outlet number you want to check (1-based)
-  #
-  # Returns:
-  # boolean - on/off status of the outlet
-  def status(outlet = 1)
-    statuses.fetch outlet do
-      raise NetBooter::Error.new('Error communicating with relay')
+    def initialize(host, options = {})
+      @host = host
+      @options = {
+        :port => 80
+      }.merge(options)
     end
-  end
 
-  # Turn on the specified outlet
-  # Example:
-  #   >> netbooter.toggle_on(2)
-  #   => true
-  #
-  # Arguments:
-  # +outlet+ Outlet you want to turn on (1-based)
-  #
-  # Returns:
-  # boolean - The new status of the outlet (should be true)
-  def toggle_on(outlet = 1)
-    toggle(outlet, true)
-  end
+    # Get the status of an outlet
+    #
+    # Example:
+    #   >> netbooter.status(2)
+    #   => false
+    #
+    # Arguments:
+    # +outlet+ Outlet number you want to check (1-based)
+    #
+    # Returns:
+    # boolean - on/off status of the outlet
+    def status(outlet = 1)
+      statuses.fetch outlet do
+        raise NetBooter::Error.new('Error communicating with relay')
+      end
+    end
 
-  # Turn off the specified outlet
-  # Example:
-  #   >> netbooter.toggle_off(2)
-  #   => true
-  #
-  # Arguments:
-  # +outlet+ Outlet you want to turn off (1-based)
-  #
-  # Returns:
-  # boolean - The new status of the outlet (should be false)
-  def toggle_off(outlet = 1)
-    toggle(outlet, false)
-  end
+    # Turn on the specified outlet
+    # Example:
+    #   >> netbooter.toggle_on(2)
+    #   => true
+    #
+    # Arguments:
+    # +outlet+ Outlet you want to turn on (1-based)
+    #
+    # Returns:
+    # boolean - The new status of the outlet (should be true)
+    def toggle_on(outlet = 1)
+      toggle(outlet, true)
+    end
 
-  # Toggle the status of an outlet
-  #
-  # Example:
-  #  >> netbooter.toggle(1, false)
-  #  => false
-  #
-  # Arguments:
-  # +outlet+ The outlet you want to toggle
-  # +status+ Boolean. true to turn on, false to turn off
-  #
-  # Returns:
-  # boolean - The new status of the outlet
-  def toggle(outlet, status)
-    current_status = status(outlet)
-    toggle_relay(outlet) if current_status != status
-    status
-  end
+    # Turn off the specified outlet
+    # Example:
+    #   >> netbooter.toggle_off(2)
+    #   => true
+    #
+    # Arguments:
+    # +outlet+ Outlet you want to turn off (1-based)
+    #
+    # Returns:
+    # boolean - The new status of the outlet (should be false)
+    def toggle_off(outlet = 1)
+      toggle(outlet, false)
+    end
 
-  # Get the status of all outlets on the device. Needs to be defined
-  # in a subclass.
-  #
-  # Example:
-  #   >> netbooter.statuses
-  #   => { 1 => true, 2 => false }
-  #
-  # Arguments: none
-  #
-  # Returns:
-  # A hash containing the outlet numbers and their respective status
-  def statuses
-    raise NotImplementedError.new
-  end
+    # Toggle the status of an outlet
+    #
+    # Example:
+    #  >> netbooter.toggle(1, false)
+    #  => false
+    #
+    # Arguments:
+    # +outlet+ The outlet you want to toggle
+    # +status+ Boolean. true to turn on, false to turn off
+    #
+    # Returns:
+    # boolean - The new status of the outlet
+    def toggle(outlet, status)
+      current_status = status(outlet)
+      toggle_relay(outlet) if current_status != status
+      status
+    end
 
-  # The method that contains the network command the relay. Needs to be defined
-  # in a subclass.
-  def toggle_relay(outlet)
-    raise NotImplementedError.new('Must implement toggle_relay in subclass')
-  end
+    # Get the status of all outlets on the device. Needs to be defined
+    # in a subclass.
+    #
+    # Example:
+    #   >> netbooter.statuses
+    #   => { 1 => true, 2 => false }
+    #
+    # Arguments: none
+    #
+    # Returns:
+    # A hash containing the outlet numbers and their respective status
+    def statuses
+      raise NotImplementedError.new
+    end
 
-private
+    # The method that contains the network command the relay. Needs to be defined
+    # in a subclass.
+    def toggle_relay(outlet)
+      raise NotImplementedError.new('Must implement toggle_relay in subclass')
+    end
+
+    private
 
-  # Make an http request and return the result.
-  def get_request(path)
-    resp = nil
-    begin
-      Timeout::timeout(5) do
-        resp = do_http_request(path)
+    # Make an http request and return the result.
+    def get_request(path)
+      resp = nil
+      begin
+        Timeout::timeout(5) do
+          resp = do_http_request(path)
+        end
+      rescue => e
+        raise NetBooter::Error.new("Error connecting to relay: #{e.message}")
       end
-    rescue => e
-      raise NetBooter::Error.new("Error connecting to relay: #{e.message}")
+      resp
     end
-    resp
-  end
 
-  def do_http_request(path)
-    resp = nil
-    Net::HTTP.start(@host) do |http|
-      req = Net::HTTP::Get.new(path)
+    def do_http_request(path)
+      resp = nil
+      Net::HTTP.start(@host) do |http|
+        req = Net::HTTP::Get.new(path)
 
-      req.basic_auth @options[:username], @options[:password] if @options[:username] && @options[:password]
+        req.basic_auth @options[:username], @options[:password] if @options[:username] && @options[:password]
 
-      resp = http.request(req)
+        resp = http.request(req)
 
-      # Error checking. Allow 200s and 302s
-      unless ['200', '302'].include? resp.code
-        raise NetBooter::Error.new "Relay responded with #{resp.code}. Perhaps you have the wrong relay type specified."
+        # Error checking. Allow 200s and 302s
+        unless ['200', '302'].include? resp.code
+          raise NetBooter::Error.new "Relay responded with #{resp.code}. Perhaps you have the wrong relay type specified."
+        end
       end
+      resp
     end
-    resp
+
   end
 
 end

data/lib/synaccess_connect/net_booter/http/rev_a.rb

@@ -1,24 +1,32 @@
-class NetBooter::Http::RevA < NetBooter::HttpConnection
-  # So here's the deal... When you hit the switch page (pwrSw1.cgi) nothing happens.
-  # It's only when hitting the status page AFTER visiting a swith page that
-  # the relay is toggled.
-  def toggle_relay(outlet)
-    get_request("/pwrSw#{outlet}.cgi")
-    get_request("/synOpStatus.shtml")
-  end
+module NetBooter
+
+  module Http
+
+    class RevA < HttpConnection
+      # So here's the deal... When you hit the switch page (pwrSw1.cgi) nothing happens.
+      # It's only when hitting the status page AFTER visiting a swith page that
+      # the relay is toggled.
+      def toggle_relay(outlet)
+        get_request("/pwrSw#{outlet}.cgi")
+        get_request("/synOpStatus.shtml")
+      end
 
-  def statuses
-    resp   = get_request('/synOpStatus.shtml')
+      def statuses
+        resp   = get_request('/synOpStatus.shtml')
 
-    doc    = Nokogiri::HTML(resp.body)
-    nodes  = doc.xpath('//img')
-    status = {}
+        doc    = Nokogiri::HTML(resp.body)
+        nodes  = doc.xpath('//img')
+        status = {}
 
-    nodes.each do |node|
-      if node.values[0].match(/^led(off|on).gif$/)
-        status[node.parent.parent.xpath('th').first.content.to_i] = $1 == 'on' ? true : false
+        nodes.each do |node|
+          if node.values[0].match(/^led(off|on).gif$/)
+            status[node.parent.parent.xpath('th').first.content.to_i] = $1 == 'on' ? true : false
+          end
+        end
+        status
       end
     end
-    status
+
   end
+
 end

data/lib/synaccess_connect/net_booter/http/rev_b.rb

@@ -1,20 +1,30 @@
-class NetBooter::Http::RevB < NetBooter::HttpConnection
-  def toggle_relay(outlet)
-    get_request("/cmd.cgi?rly=#{outlet - 1}")
-  end
+module NetBooter
+
+  module Http
+
+    class RevB < HttpConnection
+
+      def toggle_relay(outlet)
+        get_request("/cmd.cgi?rly=#{outlet - 1}")
+      end
 
-  def statuses
-    resp   = get_request('/status.xml')
+      def statuses
+        resp   = get_request('/status.xml')
 
-    doc    = Nokogiri::XML(resp.body)
-    nodes  = doc.xpath('/response/*')
+        doc    = Nokogiri::XML(resp.body)
+        nodes  = doc.xpath('/response/*')
 
-    status = {}
-    nodes.each do |node|
-      if node.name.match(/^rly(\d+)$/)
-        status[$1.to_i + 1] = node.content == '1' ? true : false
+        status = {}
+        nodes.each do |node|
+          if node.name.match(/^rly(\d+)$/)
+            status[$1.to_i + 1] = node.content == '1' ? true : false
+          end
+        end
+        status
       end
+
     end
-    status
+
   end
-end
+
+end

data/lib/synaccess_connect/version.rb

@@ -0,0 +1,3 @@
+module SynaccessConnect
+  VERSION = "0.3.0".freeze
+end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: synaccess_connect
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
-- Jason Hanggi
+- Table XI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -68,7 +68,7 @@ dependencies:
         version: '1.16'
 description: Ruby interface to connecting to Synaccess netBooter power relays
 email:
-- jason@tablexi.com
+- devs@tablexi.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -76,12 +76,11 @@ files:
 - README.md
 - lib/synaccess_connect.rb
 - lib/synaccess_connect/net_booter/error.rb
+- lib/synaccess_connect/net_booter/http.rb
 - lib/synaccess_connect/net_booter/http/http_connection.rb
 - lib/synaccess_connect/net_booter/http/rev_a.rb
 - lib/synaccess_connect/net_booter/http/rev_b.rb
-- lib/synaccess_connect/net_booter/telnet/rev_a.rb
-- lib/synaccess_connect/net_booter/telnet/rev_b.rb
-- lib/synaccess_connect/net_booter/telnet/telnet_connection.rb
+- lib/synaccess_connect/version.rb
 homepage: https://github.com/tablexi/synaccess
 licenses: []
 metadata: {}
@@ -101,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: ''

data/lib/synaccess_connect/net_booter/telnet/rev_a.rb

@@ -1,23 +0,0 @@
-class NetBooter::Telnet::RevA < NetBooter::TelnetConnection
-
-  def override_options
-    {
-      :prompt => /^\r>$/n,
-      :status_string => 'On'
-    }
-  end
-
-  def local_statuses
-    parse_status @connection.cmd("pshow")
-  end
-
-private
-  def authenticate
-    sleep 0.1
-    @connection.puts(@options[:username])
-    sleep 0.1
-    @connection.puts(@options[:password])
-    @connection.cmd('')
-    sleep 0.1
-  end
-end

data/lib/synaccess_connect/net_booter/telnet/rev_b.rb

@@ -1,17 +0,0 @@
-class NetBooter::Telnet::RevB < NetBooter::TelnetConnection
-  def local_statuses
-    @connection.cmd("")
-    sleep 0.25
-    parse_status @connection.cmd("pshow")
-  end
-
-private
-
-  def authenticate
-    @connection.cmd('login')
-    sleep 0.25
-    @connection.puts(@options[:username])
-    sleep 0.25
-    @connection.puts(@options[:password])
-  end
-end

data/lib/synaccess_connect/net_booter/telnet/telnet_connection.rb

@@ -1,119 +0,0 @@
-require 'net/telnet'
-
-class NetBooter::TelnetConnection
-  def initialize(host, options = {})
-    @host = host
-    @options = { :port => 23,
-      :binmode => false,
-      :prompt => /^[>]/n,
-      :timeout => 1,
-      :status_string => 'ON'
-      }.merge(override_options).merge(options)
-  end
-
-  def override_options
-    {}
-  end
-
-  def status(outlet = 1)
-    statuses.fetch outlet do
-      raise NetBooter::Error.new('Error communicating with relay')
-    end
-  end
-
-  def statuses
-    with_connection :default => {} do
-      local_statuses
-    end
-  end
-
-  def toggle_on(outlet = 1)
-    toggle(true, outlet)
-  end
-
-  def toggle_off(outlet = 1)
-    toggle(false, outlet)
-  end
-
-  def toggle(outlet, status)
-    status_string = status ? '1' : '0'
-    with_connection do
-      @connection.cmd("pset #{outlet} #{status_string}")
-    end
-    status
-  end
-
-private
-
-  def authenticate
-    raise NotImplementedException.new('Must implement in subclass')
-  end
-
-  # Parse the text that we get back from pshow
-  # returns hash of { channel => boolean_status }
-  def parse_status(response)
-    statuses = {}
-    return statuses unless response
-
-    response.split("\n").each do |line|
-      parts = line.split('|').map &:strip
-      next unless parts[0] =~ /^\d+/
-      statuses[parts[0].to_i] = parts[2] == @options[:status_string]
-    end
-    statuses
-  end
-
-  def connect
-    retry_block 5 do
-      @connection = Net::Telnet::new(
-        'Host' => @host,
-        'Port' => @options[:port],
-        'Binmode' => @options[:binmode],
-        'Prompt' => @options[:prompt],
-        'Timeout' => @options[:timeout]
-      )
-      authenticate if @options[:username] && @options[:password]
-    end
-  end
-
-  def disconnect
-    begin
-      @connection.close if @connection
-    rescue
-      # do nothing
-    end
-    # needs a little bit of delay after disconnecting
-    # if so the next connection doesn't get refused while
-    # this one is closing. Number arrived at by experimentation
-    sleep 0.02
-  end
-
-  def with_connection options = {}
-    begin
-      connect
-      raise NetBooter::Error.new('Unable to connect') if @connection.nil?
-      output = yield
-    rescue => e
-      puts "ERROR! #{e.message}"
-      # puts e.backtrace.join("\n")
-      output = options[:default] if options[:default]
-    ensure
-      disconnect
-    end
-
-    output
-  end
-
-  def retry_block max_attempts, options = {}
-    max_attempts.times do |i|
-      begin
-        yield
-        break # if we made it through the yield without an error we can break
-      rescue => e
-        puts e.message
-        raise e if i + 1 >= max_attempts
-      end
-    end
-  end
-
-end