poweriq_client 0.2.0 → 0.3.0

data/README.rdoc

@@ -23,7 +23,7 @@ The Power IQ client comes with a interactive console. To run the console:
     -p, --password [PASSWORD]        Password for authentication
     -s, --server [HOST]              Host name or IP of Power IQ
 
-==== Console Configuration
+==== 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:
@@ -33,13 +33,13 @@ should look similiar to below, adjusted to your Power IQ server:
    user: admin
    password: raritan
 
-If you do not use a configuration file, or through the command line options above, you'll
+If you do not use a configuration file, or 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
+==== Examples
 
 Retrieve all outlets:
   >> outlets_resource = PowerIQ::Resource::Outlet.new
@@ -58,6 +58,93 @@ Update an outlet:
   >> outlet['outlet']['outlet_name'] = "New Name"
   >> outlet_resource.put outlet.to_json
 
+=== Error Handling
+
+When an error occurs with API calls, the Power IQ server will return an appropriate HTTP response code, and include
+a json response with error details. On the client side, an exception is thrown. Either the exception or the
+resource object can be used to reveal details about what went wrong:
+
+  >> outlet_resource = PowerIQ::Resource::Outlet.new('/381')
+  https://vm163/api/v2/outlets/381
+  >> outlet_json = outlet_resource.get
+  {
+    "outlet" => {
+                 "id" => 381,
+          "outlet_id" => 11,
+        "outlet_name" => "Outlet 11",
+          "device_id" => nil,
+              "state" => "ON",
+             "pdu_id" => 40,
+            "reading" => {}
+    }
+  }
+  >> outlet_json['outlet']['outlet_name']="foo"
+  "foo"
+  >> outlet_resource.put outlet_json.to_json
+  RestClient::UnprocessableEntity: 422 Unprocessable Entity
+        from /Users/tba/.rvm/gems/ruby-1.9.2-p180@poweriq_client/gems/rest-client-1.6.7/lib/restclient/abstract_response.rb:48:in `return!'
+        from /Users/tba/Workspaces/local/poweriq_client/lib/poweriq_client/resource/base.rb:11:in `block in create'
+        from /Users/tba/.rvm/gems/ruby-1.9.2-p180@poweriq_client/gems/rest-client-1.6.7/lib/restclient/request.rb:228:in `call'
+        from /Users/tba/.rvm/gems/ruby-1.9.2-p180@poweriq_client/gems/rest-client-1.6.7/lib/restclient/request.rb:228:in `process_result'
+        from /Users/tba/.rvm/gems/ruby-1.9.2-p180@poweriq_client/gems/rest-client-1.6.7/lib/restclient/request.rb:178:in `block in transmit'
+        from /Users/tba/.rvm/rubies/ruby-1.9.2-p180/lib/ruby/1.9.1/net/http.rb:627:in `start'
+        from /Users/tba/.rvm/gems/ruby-1.9.2-p180@poweriq_client/gems/rest-client-1.6.7/lib/restclient/request.rb:172:in `transmit'
+        from /Users/tba/.rvm/gems/ruby-1.9.2-p180@poweriq_client/gems/rest-client-1.6.7/lib/restclient/request.rb:64:in `execute'
+        from /Users/tba/.rvm/gems/ruby-1.9.2-p180@poweriq_client/gems/rest-client-1.6.7/lib/restclient/request.rb:33:in `execute'
+        from /Users/tba/.rvm/gems/ruby-1.9.2-p180@poweriq_client/gems/rest-client-1.6.7/lib/restclient/resource.rb:76:in `put'
+        from (irb):4
+        from bin/poweriq_client:66:in `<main>'
+
+The resource will always hold the last response from the latest rest invocation:
+
+  >> outlet_resource.response.json
+  {
+       "error" => "Job::JobError",
+    "messages" => [
+        [0] "Job(ID:5) with 1 error(s) and status COMPLETED completed",
+        [1] "Confirmed existence of foo",
+        [2] "Confirmed existence of 192.168.45.234 for outlet  foo.",
+        [3] "Retrieved plugin for 192.168.45.234.",
+        [4] "Failed to set outlet id: 381 label on PDU 192.168.45.234.  PowerIQ was unable to reach 192.168.45.234."
+    ],
+         "job" => {
+        "description" => nil,
+           "end_time" => "2011/11/06 00:56:47 +0000",
+         "has_errors" => true,
+                 "id" => 5,
+         "start_time" => "2011/11/06 00:56:28 +0000",
+             "status" => "COMPLETED",
+            "user_id" => 1
+    },
+       "trace" => "/var/oculan/home/tba/rails/src/lib/messaging/job_polling.rb:31:...."
+   }
+
+You can also catch the exception, and the exception will have the response object in it:
+
+  >> exc = nil
+  >> begin outlet_resource.put outlet_json.to_json; rescue => exc; end
+  >> exc.response.json
+  {
+       "error" => "Job::JobError",
+    "messages" => [
+        [0] "Job(ID:5) with 1 error(s) and status COMPLETED completed",
+        [1] "Confirmed existence of foo",
+        [2] "Confirmed existence of 192.168.45.234 for outlet  foo.",
+        [3] "Retrieved plugin for 192.168.45.234.",
+        [4] "Failed to set outlet id: 381 label on PDU 192.168.45.234.  PowerIQ was unable to reach 192.168.45.234."
+    ],
+         "job" => {
+        "description" => nil,
+           "end_time" => "2011/11/06 00:56:47 +0000",
+         "has_errors" => true,
+                 "id" => 5,
+         "start_time" => "2011/11/06 00:56:28 +0000",
+             "status" => "COMPLETED",
+            "user_id" => 1
+    },
+       "trace" => "/var/oculan/home/tba/rails/src/lib/messaging/job_polling.rb:31:...."
+   }
+
 == Development
 
 The Power IQ rest client uses the rest-client gem, with some

data/lib/poweriq_client/resource/base.rb

@@ -8,10 +8,8 @@ module PowerIQ
         Proc.new { |response,request,result,&block|
           resource.request = request
           resource.response = response
-          body = response.return!(request, result, &block)
-          if(body.kind_of?(String))
-            ActiveSupport::JSON.decode(body)
-          end
+          response.return!(request, result, &block)
+          response.json
         }
       end
     end

data/lib/poweriq_client/response.rb

@@ -0,0 +1,12 @@
+module RestClient
+  module Response
+
+    def json
+      if(!@json && headers[:content_type]=~%r{application/json} && !body.nil? && body.size>0)
+        @json = ActiveSupport::JSON.decode(body)
+      end
+      @json
+    end
+
+  end
+end

data/lib/poweriq_client/version.rb

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

data/lib/poweriq_client.rb

@@ -1,5 +1,6 @@
 
 require 'active_support/core_ext'
+require 'poweriq_client/response'
 
 module PowerIQ
   autoload :Version, "poweriq_client/version"

data/poweriq_client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{poweriq_client}
-  s.version = "0.2.0"
+  s.version = "0.3.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-03}
+  s.date = %q{2011-11-06}
   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}]
@@ -56,6 +56,7 @@ Gem::Specification.new do |s|
     "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/response.rb",
     "lib/poweriq_client/version.rb",
     "poweriq_client.gemspec",
     "spec/poweriq_client_spec.rb",

metadata

@@ -2,7 +2,7 @@
 name: poweriq_client
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Trent Albright
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-03 00:00:00 Z
+date: 2011-11-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -148,6 +148,7 @@ files:
 - 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/response.rb
 - lib/poweriq_client/version.rb
 - poweriq_client.gemspec
 - spec/poweriq_client_spec.rb
@@ -165,7 +166,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4058341116595240085
+      hash: -3473045824434038177
       segments: 
       - 0
       version: "0"