poweriq_client 0.1.1 → 0.2.0

data/README.rdoc

@@ -1,8 +1,72 @@
-= poweriq_client
+= Power IQ Client
 
-Power IQ Rest API client for Power IQ 3.1
+Power IQ Rest API client for Power IQ 3.1. For a complete list of resources, routes, and methods available
+see the online Power IQ documentation (http://www.raritan.com/support/power-iq).
 
-== Contributing to poweriq_client
+== Installation
+
+ % gem install poweriq_client
+
+== Console
+
+The Power IQ client comes with a interactive console. To run the console:
+
+ % poweriq_client
+
+==== Console Options
+
+  Usage: poweriq_client [options]
+    -l, --less-typing                Put resource objects in global namespace
+                                     (ie PowerIQ::Resource::Outlet becomes Outlet)
+    -c, --check-compatibility        Check client compatibility with server
+    -u, --user [USER]                User name for authentication
+    -p, --password [PASSWORD]        Password for authentication
+    -s, --server [HOST]              Host name or IP of Power IQ
+
+==== Console Configuration
+
+Create a file named .poweriq_client in your home directory. The contents of the file
+should look similiar to below, adjusted to your Power IQ server:
+
+ default:
+   host: vm163
+   user: admin
+   password: raritan
+
+If you do not use a configuration file, or through the command line options above, you'll
+need to provide the configuration manually:
+
+  % poweriq_client
+  >> PowerIQ::Configuration.configure("user"=>"foo","password"=>"bar","host"=>"vm150")
+
+==== Console Examples
+
+Retrieve all outlets:
+  >> outlets_resource = PowerIQ::Resource::Outlet.new
+  https://vm163/api/v2/outlets
+  >> outlets_resource.get
+  
+Retrieve one outlet:
+  >> outlet_resource = PowerIQ::Resource::Outlet.new('/381')
+  https://vm163/api/v2/outlets/381
+  >> outlet = outlet_resource.get
+
+Update an outlet:
+  >> outlet_resource = PowerIQ::Resource::Outlet.new('/381')
+  https://vm163/api/v2/outlets/381
+  >> outlet = outlet_resource.get
+  >> outlet['outlet']['outlet_name'] = "New Name"
+  >> outlet_resource.put outlet.to_json
+
+== Development
+
+The Power IQ rest client uses the rest-client gem, with some
+modifications to make it easier to query Power IQ resources.
+For now you'll need to view the source code for more details,
+however the usage is essentially the same as you see in the
+interactive console examples above.
+
+== Contributing to Power IQ Client
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -14,6 +78,5 @@ Power IQ Rest API client for Power IQ 3.1
 
 == Copyright
 
-Copyright (c) 2011 Ratian, INC. See LICENSE.txt for
+Copyright (c) 2011 Raritan, INC. See LICENSE.txt for
 further details.
-

data/bin/poweriq_client

@@ -3,18 +3,65 @@
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'rubygems'
+require 'optparse'
 require 'poweriq_client'
 require 'irb'
 require 'irb/completion'
 
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: poweriq_client [options]"
+  opts.on("-l", "--less-typing", "Put resource objects in global namespace","(ie PowerIQ::Resource::Outlet becomes Outlet)") do |l|
+    options[:less_typing] = l
+  end
+  opts.on("-c", "--check-compatibility", "Check client compatibility with server") do |c|
+    options[:check_compatability] = c
+  end
+  opts.on("-u", "--user [USER]", "User name for authentication") do |u|
+    options[:user] = u
+  end
+  opts.on("-p", "--password [PASSWORD]", "Password for authentication") do |p|
+    options[:password] = p
+  end
+  opts.on("-s", "--server [HOST]", "Host name or IP of Power IQ") do |h|
+    options[:host] = h
+  end
+end.parse!
+
 if File.exists? ".irbrc"
   ENV['IRBRC'] = ".irbrc"
 end
-begin
-  PowerIQ::Configuration.load_configuration("default")
-rescue
+unless(options[:user] || options[:password] || options[:host])
+  begin
+    PowerIQ::Configuration.load_configuration("default")
+  rescue
+  end
+else
+  PowerIQ::Configuration.configure(options)
+end
+
+def less_typing
+  resources = Dir.entries(File.join(File.dirname(__FILE__), '..', 'lib','poweriq_client','resource')).select { |x| x=~%r{\.rb$} }
+  resources.each { |r| load File.join(File.dirname(__FILE__), '..', 'lib','poweriq_client','resource',r) }
+  classes = ObjectSpace.each_object(Class).map { |x| x.to_s}.select { |x| x=~/PowerIQ::Resource/ }.reject { |x| x=~/Base$/ }
+  classes.each { |c|
+    Object.const_set(c.demodulize,c.constantize)
+  }
+end
+
+def check_compatability
+  client_version = PowerIQ::Compatibility.client_version
+  server_version = PowerIQ::Compatibility.server_version
+  unless(PowerIQ::Compatibility.compatible?)
+    raise Error.new("This client (#{client_version}) is not supported by your version of Power IQ (#{server_version})")
+  else
+    puts "This client (#{client_version}) is supported by your version of Power IQ (#{server_version})"
+  end
 end
 
+check_compatability if(options[:check_compatability])
+less_typing if(options[:less_typing])
+
 ARGV.clear
 IRB.start
 

data/lib/poweriq_client/compatibility.rb

@@ -0,0 +1,20 @@
+module PowerIQ
+  module Compatibility
+    API_COMPATIBILITY = %r{^3.1.*?}
+    @@system_info = nil
+    class << self
+      def compatible?
+        !!self.system_info['system_info']['poweriq_version'].match(API_COMPATIBILITY)
+      end
+      def server_version
+        self.system_info['system_info']['poweriq_version']
+      end
+      def client_version
+        PowerIQ::Version::STRING
+      end
+      def system_info
+        @@system_info ||= PowerIQ::Resource::SystemInfo.new.get
+      end
+    end
+  end
+end

data/lib/poweriq_client/configuration.rb

@@ -10,9 +10,10 @@ module PowerIQ
       end
       def configure(options=nil,&block)
         unless(options.nil?)
-          self.user = options["user"]
-          self.password = options["password"]
-          self.host = options["host"]
+          options.symbolize_keys!
+          self.user = options[:user]
+          self.password = options[:password]
+          self.host = options[:host]
         end
         if(block_given?)
           yield self

data/lib/poweriq_client/resource/aisle.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class Aisle < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/asset_strip.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class AssetStrip < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/circuit_breaker_reading.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class CircuitBreakerReading < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/circuit_breaker_readings_rollup.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class CircuitBreakerReadingsRollup < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/data_center.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class DataCenter < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/device.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class Device < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/event.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class Event < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/floor.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class Floor < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/job.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class Job < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/job_message.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class JobMessage < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/line_reading.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class LineReading < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/line_readings_rollup.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class LineReadingsRollup < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/outlet.rb

@@ -1,6 +1,5 @@
 module PowerIQ
   module Resource
-    class Outlet < PowerIQ::Resource::Base
-    end
+    class Outlet < PowerIQ::Resource::Base; end
   end
 end

data/lib/poweriq_client/resource/outlet_reading.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class OutletReading < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/outlet_readings_rollup.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class OutletReadingsRollup < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/pdu.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class Pdu < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/rack.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class Rack < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/rack_unit.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class RackUnit < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/room.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class Room < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/row.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class Sensor < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/sensor.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class Pdu < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/sensor_reading.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class SensorReading < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource/sensor_readings_rollup.rb

@@ -0,0 +1,7 @@
+module PowerIQ
+  module Resource
+    class SensorReadingsRollup < PowerIQ::Resource::Base; end
+  end
+end
+
+

data/lib/poweriq_client/resource.rb

@@ -1,7 +1,29 @@
 module PowerIQ
   module Resource
     autoload :Base, 'poweriq_client/resource/base'
-    autoload :SystemInfo, 'poweriq_client/resource/system_info'
+    autoload :Aisle, 'poweriq_client/resource/aisle'
+    autoload :AssetStrip, 'poweriq_client/resource/asset_strip'
+    autoload :CircuitBreakerReading, 'poweriq_client/resource/circuit_breaker_reading'
+    autoload :CircuitBreakerReadingsRollup, 'poweriq_client/resource/circuit_breaker_readings_rollup'
+    autoload :DataCenter, 'poweriq_client/resource/data_center'
+    autoload :Device, 'poweriq_client/resource/device'
+    autoload :Event, 'poweriq_client/resource/event'
+    autoload :Floor, 'poweriq_client/resource/floor'
+    autoload :Job, 'poweriq_client/resource/job'
+    autoload :JobMessage, 'poweriq_client/resource/job_message'
+    autoload :LineReading, 'poweriq_client/resource/line_reading'
+    autoload :LineReadingsRollup, 'poweriq_client/resource/line_readings_rollup'
     autoload :Outlet, 'poweriq_client/resource/outlet'
+    autoload :OutletReading, 'poweriq_client/resource/outlet_reading'
+    autoload :OutletReadingsRollup, 'poweriq_client/resource/outlet_readings_rollup'
+    autoload :Pdu, 'poweriq_client/resource/pdu'
+    autoload :Rack, 'poweriq_client/resource/rack'
+    autoload :RackUnit, 'poweriq_client/resource/rack_unit'
+    autoload :Room, 'poweriq_client/resource/room'
+    autoload :Row, 'poweriq_client/resource/row'
+    autoload :Sensor, 'poweriq_client/resource/sensor'
+    autoload :SensorReading, 'poweriq_client/resource/sensor_reading'
+    autoload :SensorReadingsRollup, 'poweriq_client/resource/sensor_readings_rollup'
+    autoload :SystemInfo, 'poweriq_client/resource/system_info'
   end
 end

data/lib/poweriq_client/version.rb

@@ -1,8 +1,8 @@
 module PowerIQ
   module Version
     MAJOR = 0
-    MINOR = 1
-    PATCH = 1
+    MINOR = 2
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/lib/poweriq_client.rb

@@ -3,6 +3,7 @@ require 'active_support/core_ext'
 
 module PowerIQ
   autoload :Version, "poweriq_client/version"
+  autoload :Compatibility, "poweriq_client/compatibility"
   autoload :Resource, "poweriq_client/resource"
   autoload :Configuration, "poweriq_client/configuration"
 end

data/poweriq_client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{poweriq_client}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Trent Albright}]
-  s.date = %q{2011-11-02}
+  s.date = %q{2011-11-03}
   s.description = %q{Power IQ Rest API client for Power IQ 3.1}
   s.email = %q{trent.albright@raritan.com}
   s.executables = [%q{poweriq_client}]
@@ -28,10 +28,33 @@ Gem::Specification.new do |s|
     "Rakefile",
     "bin/poweriq_client",
     "lib/poweriq_client.rb",
+    "lib/poweriq_client/compatibility.rb",
     "lib/poweriq_client/configuration.rb",
     "lib/poweriq_client/resource.rb",
+    "lib/poweriq_client/resource/aisle.rb",
+    "lib/poweriq_client/resource/asset_strip.rb",
     "lib/poweriq_client/resource/base.rb",
+    "lib/poweriq_client/resource/circuit_breaker_reading.rb",
+    "lib/poweriq_client/resource/circuit_breaker_readings_rollup.rb",
+    "lib/poweriq_client/resource/data_center.rb",
+    "lib/poweriq_client/resource/device.rb",
+    "lib/poweriq_client/resource/event.rb",
+    "lib/poweriq_client/resource/floor.rb",
+    "lib/poweriq_client/resource/job.rb",
+    "lib/poweriq_client/resource/job_message.rb",
+    "lib/poweriq_client/resource/line_reading.rb",
+    "lib/poweriq_client/resource/line_readings_rollup.rb",
     "lib/poweriq_client/resource/outlet.rb",
+    "lib/poweriq_client/resource/outlet_reading.rb",
+    "lib/poweriq_client/resource/outlet_readings_rollup.rb",
+    "lib/poweriq_client/resource/pdu.rb",
+    "lib/poweriq_client/resource/rack.rb",
+    "lib/poweriq_client/resource/rack_unit.rb",
+    "lib/poweriq_client/resource/room.rb",
+    "lib/poweriq_client/resource/row.rb",
+    "lib/poweriq_client/resource/sensor.rb",
+    "lib/poweriq_client/resource/sensor_reading.rb",
+    "lib/poweriq_client/resource/sensor_readings_rollup.rb",
     "lib/poweriq_client/resource/system_info.rb",
     "lib/poweriq_client/version.rb",
     "poweriq_client.gemspec",

metadata

@@ -2,7 +2,7 @@
 name: poweriq_client
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Trent Albright
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-02 00:00:00 Z
+date: 2011-11-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -120,10 +120,33 @@ files:
 - Rakefile
 - bin/poweriq_client
 - lib/poweriq_client.rb
+- lib/poweriq_client/compatibility.rb
 - lib/poweriq_client/configuration.rb
 - lib/poweriq_client/resource.rb
+- lib/poweriq_client/resource/aisle.rb
+- lib/poweriq_client/resource/asset_strip.rb
 - lib/poweriq_client/resource/base.rb
+- lib/poweriq_client/resource/circuit_breaker_reading.rb
+- lib/poweriq_client/resource/circuit_breaker_readings_rollup.rb
+- lib/poweriq_client/resource/data_center.rb
+- lib/poweriq_client/resource/device.rb
+- lib/poweriq_client/resource/event.rb
+- lib/poweriq_client/resource/floor.rb
+- lib/poweriq_client/resource/job.rb
+- lib/poweriq_client/resource/job_message.rb
+- lib/poweriq_client/resource/line_reading.rb
+- lib/poweriq_client/resource/line_readings_rollup.rb
 - lib/poweriq_client/resource/outlet.rb
+- lib/poweriq_client/resource/outlet_reading.rb
+- lib/poweriq_client/resource/outlet_readings_rollup.rb
+- lib/poweriq_client/resource/pdu.rb
+- lib/poweriq_client/resource/rack.rb
+- lib/poweriq_client/resource/rack_unit.rb
+- lib/poweriq_client/resource/room.rb
+- lib/poweriq_client/resource/row.rb
+- lib/poweriq_client/resource/sensor.rb
+- lib/poweriq_client/resource/sensor_reading.rb
+- lib/poweriq_client/resource/sensor_readings_rollup.rb
 - lib/poweriq_client/resource/system_info.rb
 - lib/poweriq_client/version.rb
 - poweriq_client.gemspec
@@ -142,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4361364567050479065
+      hash: -4058341116595240085
       segments: 
       - 0
       version: "0"