redfish_client 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b945c1173e6a2b6e4f11611226c3de63bc3a7d0724ed1f4239cb14a01b115696
-  data.tar.gz: b38b4f8bef1d460d84bb0bb8d01060a0859cf4590b7c85c7ea92d18ff1da067e
+  metadata.gz: a0d5afda19f44e42b56223398478a6542c3001449eaa268a554adf53be44f169
+  data.tar.gz: 3a37535bab3af7cc4457c9aed9b9718da7b27922b2a70da58938d376576df10d
 SHA512:
-  metadata.gz: a6a95d53daede4e34e470eddf9f63ba08b411f8ad2dacccf4344a311e4aa38bfc5a9f7b00ce00220c114c3b54973eb9bedab30c06c3872a74fb2e7ec3c2059bc
-  data.tar.gz: d2f584fcf925dccbe82660182625643994b850820f0f81c6e5814745b77c0e19ff08723fd08c82e1c78933fe4f67c85820f6db16ec299346db8cdd5eebd26f30
+  metadata.gz: 23cf48798d7952009e20c450f9fcc22aa6116902ef01c6d2446c1c4f35ea2ed2ec4a9db6f817583dec42fb09221ff3764b72577e05fe9327bc92ffc1d4890f37
+  data.tar.gz: 83517b7ef8012c483e4b73afbe456e618e0ebf614d5d741ba42f2bf5fbf7ca0cdde35badb3e56512fc0a786503c84df424d97e2d617160105e58eafbeb534d46

data/.rubocop.yml

@@ -6,6 +6,9 @@ AllCops:
     - Rakefile
     - bin/**
 
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 

data/lib/redfish_client/connector.rb

@@ -25,9 +25,12 @@ module RedfishClient
     # @param verify [Boolean] verify SSL certificate of the service
     def initialize(url, verify = true)
       @url = url
-      @verify = verify
       @headers = DEFAULT_HEADERS.dup
-      @connection = create_connection
+      middlewares = Excon.defaults[:middlewares] +
+        [Excon::Middleware::RedirectFollower]
+      @connection = Excon.new(@url,
+                              ssl_verify_peer: verify,
+                              middlewares: middlewares)
     end
 
     # Add HTTP headers to the requests made by the connector.
@@ -35,7 +38,6 @@ module RedfishClient
     # @param headers [Hash<String, String>] headers to be added
     def add_headers(headers)
       @headers.merge!(headers)
-      @connection = create_connection
     end
 
     # Remove HTTP headers from requests made by the connector.
@@ -46,7 +48,6 @@ module RedfishClient
     # @param headers [List<String>] headers to remove
     def remove_headers(headers)
       headers.each { |h| @headers.delete(h) }
-      @connection = create_connection
     end
 
     # Issue GET request to service.
@@ -54,29 +55,25 @@ module RedfishClient
     # @param path [String] path to the resource, relative to the base url
     # @return [Excon::Response] response object
     def get(path)
-      @connection.get(path: path)
+      @connection.get(path: path, headers: @headers)
     end
 
     # Issue POST requests to the service.
     #
     # @param path [String] path to the resource, relative to the base
-    # @param body [String] data to be sent over the socket
+    # @param data [Hash] data to be sent over the socket, JSON encoded
     # @return [Excon::Response] response object
-    def post(path, body = nil)
-      params = { path: path }
-      params[:body] = body if body
-      @connection.post(params)
+    def post(path, data = nil)
+      @connection.post(prepare_request_params(path, data))
     end
 
     # Issue PATCH requests to the service.
     #
     # @param path [String] path to the resource, relative to the base
-    # @param body [String] data to be sent over the socket
+    # @param data [Hash] data to be sent over the socket
     # @return [Excon::Response] response object
-    def patch(path, body = nil)
-      params = { path: path }
-      params[:body] = body if body
-      @connection.patch(params)
+    def patch(path, data = nil)
+      @connection.patch(prepare_request_params(path, data))
     end
 
     # Issue DELETE requests to the service.
@@ -84,13 +81,20 @@ module RedfishClient
     # @param path [String] path to the resource, relative to the base
     # @return [Excon::Response] response object
     def delete(path)
-      @connection.delete(path: path)
+      @connection.delete(path: path, headers: @headers)
     end
 
     private
 
-    def create_connection
-      Excon.new(@url, headers: @headers, ssl_verify_peer: @verify)
+    def prepare_request_params(path, data)
+      params = { path: path }
+      if data
+        params[:body] = data.to_json
+        params[:headers] = @headers.merge("Content-Type" => "application/json")
+      else
+        params[:headers] = @headers
+      end
+      params
     end
   end
 end

data/lib/redfish_client/resource.rb

@@ -24,6 +24,13 @@ module RedfishClient
     # resource to accomplish the task a hand.
     class NoODataId < StandardError; end
 
+    # NoResource error is raised if the service cannot find requested
+    # resource.
+    class NoResource < StandardError; end
+
+    # Headers, returned from the service when resource has been constructed.
+    attr_reader :headers
+
     # Create new resource.
     #
     # Resource can be created either by passing in OpenData identifier or
@@ -34,19 +41,17 @@ module RedfishClient
     # @param connector [RedfishClient::Connector] connector that will be used
     #   to fetch the resources
     # @param oid [String] OpenData id of the resource
-    # @param content [Hash]
+    # @param content [Hash] content to populate resource with
+    # @raise [NoResource] resource cannot be retrieved from the service
     def initialize(connector, oid: nil, content: nil)
+      @cache = {}
+      @connector = connector
+
       if oid
-        resp = connector.get(oid)
-        @content = JSON.parse(resp.data[:body])
-        @content["@odata.id"] = oid
-        @headers = resp.data[:headers]
+        initialize_from_service(oid)
       else
         @content = content
       end
-
-      @cache = {}
-      @connector = connector
     end
 
     # Access resource content.
@@ -136,7 +141,7 @@ module RedfishClient
     # @return [Excon::Response] response
     # @raise  [NoODataId] resource has no OpenData id
     def post(field: "@odata.id", path: nil, payload: nil)
-      @connector.post(get_path(field, path), payload ? payload.to_json : "")
+      @connector.post(get_path(field, path), payload)
     end
 
     # Issue a PATCH requests to the selected endpoint.
@@ -150,7 +155,7 @@ module RedfishClient
     # @return [Excon::Response] response
     # @raise  [NoODataId] resource has no OpenData id
     def patch(field: "@odata.id", path: nil, payload: nil)
-      @connector.patch(get_path(field, path), payload ? payload.to_json : "")
+      @connector.patch(get_path(field, path), payload)
     end
 
     # Issue a DELETE requests to the endpoint of the resource.
@@ -167,6 +172,15 @@ module RedfishClient
 
     private
 
+    def initialize_from_service(oid)
+      resp = @connector.get(oid)
+      raise NoResource unless resp.status == 200
+
+      @content = JSON.parse(resp.data[:body])
+      @content["@odata.id"] = oid
+      @headers = resp.data[:headers]
+    end
+
     def get_path(field, path)
       raise NoODataId if path.nil? && !key?(field)
       path || @content[field]

data/lib/redfish_client/root.rb

@@ -46,8 +46,19 @@ module RedfishClient
     # Find Redfish service object by OData ID field.
     #
     # @param oid [String] Odata id of the resource
-    # @return [Resource] new resource
+    # @return [Resource, nil] new resource or nil if resource cannot be found
     def find(oid)
+      find!(oid)
+    rescue NoResource
+      nil
+    end
+
+    # Find Redfish service object by OData ID field.
+    #
+    # @param oid [String] Odata id of the resource
+    # @return [Resource] new resource
+    # @raise [NoResource] resource cannot be fetched
+    def find!(oid)
       Resource.new(@connector, oid: oid)
     end
 
@@ -60,7 +71,7 @@ module RedfishClient
     def session_login(username, password)
       r = @connector.post(
         @content["Links"]["Sessions"]["@odata.id"],
-        { "UserName" => username, "Password" => password }.to_json
+        "UserName" => username, "Password" => password
       )
       raise AuthError, "Invalid credentials" unless r.status == 201
 

data/lib/redfish_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RedfishClient
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redfish_client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Tadej Borovšak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Simple Redfish client library