redfish_client 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e862a2537bbbd1e6e613e82de07b10ca25dcd1f359642197fc6265b8e2f69bd5
-  data.tar.gz: 08de46ba2381857fea6e789ff46aee373bb87e014db1cdad70015c4a0ab15d99
+  metadata.gz: 45295e03b5e8ec0dda4fd0d7401f95516c92d48eba415337d25d3d2ef210a869
+  data.tar.gz: bfe94afbb669fdd6bb4b407b8ddacfaf17695b49f4bdd2d83645290f97f7b5b6
 SHA512:
-  metadata.gz: dbaceb5601e1bc015570ee83257379fe442d2dd949d3c7158818d2165a5b28b34392fd669b94419c4ece0fd2a486fb511384cbd1cd1ed69b6f34adda419715f1
-  data.tar.gz: 58965e7242bcd7805ab003aedaf6e2ea81146a7a1a4d1e37812b23aa7fd8f5266da899db8471a2e3c3e29c9867511037310cf70f50333196fbd44be757947d27
+  metadata.gz: c99e489c2328e9a1fb3ada71d3c62f0a3ce9d75e93bf78206e56490a4153d60a20601bc5d7fee351485ede848a6c640310f7df3b29c3c73c138ac4b466f62b3d
+  data.tar.gz: 20b278901afbfaa467ec1bd72056f6fbf7420d6ab62f9352193023a46a9e44b7712a37ebb495db1016d6b77a8ca1a7eb729c06ab56c7e8061150e894b64a22f2

data/lib/redfish_client.rb

@@ -1,12 +1,23 @@
 # frozen_string_literal: true
 
+require "redfish_client/caching_connector"
 require "redfish_client/connector"
 require "redfish_client/root"
 require "redfish_client/version"
 
 module RedfishClient
-  def self.new(url, prefix: "/redfish/v1", verify: true)
-    con = Connector.new(url, verify)
+  # Create new Redfish API client.
+  #
+  # @param url [String] base URL of Redfish API
+  # @param prefix [String] Redfish API prefix
+  # @param verify [Boolean] verify certificates for https connections
+  # @param use_cache [Boolean] cache API responses
+  def self.new(url, prefix: "/redfish/v1", verify: true, use_cache: true)
+    con = if use_cache
+            CachingConnector.new(url, verify)
+          else
+            Connector.new(url, verify)
+          end
     Root.new(con, oid: prefix)
   end
 end

data/lib/redfish_client/caching_connector.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "redfish_client/connector"
+
+module RedfishClient
+  # Variant of {RedfishClient::Connector} that caches GET responses.
+  class CachingConnector < Connector
+    # Create new caching connector.
+    #
+    # @param url [String] base url of the Redfish service
+    # @param verify [Boolean] verify SSL certificate of the service
+    def initialize(url, verify = true)
+      super
+      @cache = {}
+    end
+
+    # Issue GET request to service.
+    #
+    # Request is only issued if there is no cache entry for the existing path.
+    #
+    # @param path [String] path to the resource, relative to the base url
+    # @return [Excon::Response] response object
+    def get(path)
+      @cache[path] ||= super
+    end
+
+    # Clear the cached responses.
+    #
+    # Next GET request will repopulate the cache.
+    def reset(path: nil)
+      if path.nil?
+        @cache = {}
+      else
+        @cache.delete(path)
+      end
+    end
+  end
+end

data/lib/redfish_client/resource.rb

@@ -16,7 +16,7 @@ module RedfishClient
   # resource from the API.
   #
   # In order to reduce the amount of requests being sent to the service,
-  # resource also caches responses for later reuse. If we would like to get
+  # resource can also utilise caching connector. If we would like to get
   # fresh values from the service, {#reset} call will flush the cache,
   # causing next access to retrieve fresh data.
   class Resource
@@ -44,7 +44,6 @@ module RedfishClient
     # @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
@@ -59,22 +58,10 @@ module RedfishClient
     # This function offers a way of accessing resource data in the same way
     # that hash exposes its content.
     #
-    # In addition to accessing values associated with keys, this function can
-    # also be used to access members of collection by directly indexing into
-    # Members array. This means that `res["Members"][3]` can be shortened into
-    # `res[3]`.
-    #
-    # Indexing non-collection resource key will # raise `KeyError`.
-    #
-    # @param attr [String, Integer] key or index for accessing data
+    # @param attr [String] key for accessing data
     # @return associated value or `nil` if attr is missing
     def [](attr)
-      if attr.is_a?(Integer)
-        raise(KeyError, "Not a collection.") unless key?("Members")
-        cache("Members")[attr]
-      else
-        cache(attr)
-      end
+      build_resource(@content[attr])
     end
 
     # Safely access nested resource content.
@@ -109,10 +96,11 @@ module RedfishClient
       key?(symbol.to_s) || super
     end
 
-    # Clear the cached sub-resources. Next sub-resource access will repopulate
-    # the cache.
+    # Clear the cached sub-resources.
+    #
+    # This method is a no-op if connector in use does not support caching.
     def reset
-      @cache = {}
+      @connector.reset if @connector.respond_to?(:reset)
     end
 
     # Access raw JSON data that resource wraps.
@@ -195,10 +183,6 @@ module RedfishClient
       path || @content[field]
     end
 
-    def cache(name)
-      @cache[name] ||= build_resource(@content[name])
-    end
-
     def build_resource(data)
       return nil if data.nil?
 

data/lib/redfish_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redfish_client
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Tadej Borovšak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-31 00:00:00.000000000 Z
+date: 2018-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -142,6 +142,7 @@ files:
 - bin/console
 - bin/setup
 - lib/redfish_client.rb
+- lib/redfish_client/caching_connector.rb
 - lib/redfish_client/connector.rb
 - lib/redfish_client/resource.rb
 - lib/redfish_client/root.rb