synaccess_connect 0.2.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmRjYmQ0NmU2ZTE2Y2IwZTZiOGNjZGUwYTgyM2M5ZTk2MTIxNGI1OQ==
+  data.tar.gz: !binary |-
+    YTkyZGExYmZiMjA3ZDcxMTRlZjk4NjA0YzRlMTU5NThlYTU2YjUwNg==
+SHA512:
+  metadata.gz: !binary |-
+    MmU2NWFhMGVjMDg2MTdkMWZiMTA0MThlZmY2MTU4OGE1OGMzNGY0Y2ZmZjQ0
+    NzRhMGMzZTExNGRjYjZmMjBhZDdiNGZkNDA0MDEyZWU5OWRjYzI0NGVhNDQ0
+    MjM1YWJlNWYwODQxZTUyZDVjNTNiZWM4ZjZkNjMzMjBhZDI2ZGE=
+  data.tar.gz: !binary |-
+    ODg5NGEwNjdjYTIyMzU2YzgwNjQwNmY1NTVmZDdlOGMyZDk4MTAyODcwOTE2
+    ZDcyOTQzZjE0MWIxY2YxN2VjMzgzYTgzYzJhYmZmNzhmY2E0YWMwNzIxOGU5
+    MjJkNDE4OGM2OWZmMzJiNDQ0YWNkMzNiN2VjNGU5MGRkYWNjNjg=

data/README.md

@@ -0,0 +1,39 @@
+# Synaccess Connect
+
+Communication wrappers for Synaccess netBooter power relays.
+
+## Supported Firmware:
+   * NP-02
+   * NP-02B
+
+## Available interfaces
+```
+    NetBooter
+        Http
+            RevA
+            RevB
+        Telnet
+            RevA
+            RevB
+```
+
+## New connections
+
+`connection = NetBooter::PROTOCOL::RevX.new('XXX.XXX.XXX.XXX', options)`
+
+Options:
+
+   * username
+   * password
+
+## Interface
+
+All classes should implement the following methods:
+
+   * `initialize(host, options)`
+   * `status(outlet) => boolean`
+   * `statuses => Hash of { outlet => boolean }`
+   * `toggle(new_status, outlet) => new status boolean`
+
+
+

data/lib/synaccess_connect/net_booter/error.rb

@@ -0,0 +1,4 @@
+module NetBooter
+  class Error < StandardError
+  end
+end

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

@@ -0,0 +1,128 @@
+require "net/http"
+require 'nokogiri'
+
+class NetBooter::HttpConnection
+  def initialize(host, options = {})
+    @host = host
+    @options = {
+      :port => 80
+    }.merge(options)
+  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 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
+
+  # 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
+
+  # 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
+
+  # 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
+
+  # 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)
+      end
+    rescue => e
+      raise NetBooter::Error.new("Error connecting to relay: #{e.message}")
+    end
+    resp
+  end
+
+  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]
+
+      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."
+      end
+    end
+    resp
+  end
+
+end

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

@@ -0,0 +1,24 @@
+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
+
+  def statuses
+    resp   = get_request('/synOpStatus.shtml')
+
+    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
+      end
+    end
+    status
+  end
+end

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

@@ -0,0 +1,20 @@
+class NetBooter::Http::RevB < NetBooter::HttpConnection
+  def toggle_relay(outlet)
+    get_request("/cmd.cgi?rly=#{outlet - 1}")
+  end
+
+  def statuses
+    resp   = get_request('/status.xml')
+
+    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
+      end
+    end
+    status
+  end
+end

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

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,119 @@
+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

data/lib/synaccess_connect.rb

@@ -0,0 +1,34 @@
+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'
+
+
+
+# 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

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: synaccess_connect
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Jason Hanggi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: Ruby interface to connecting to Synaccess netBooter power relays
+email:
+- jason@tablexi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/synaccess_connect.rb
+- lib/synaccess_connect/net_booter/error.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
+homepage: https://github.com/tablexi/synaccess
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []