redfish_client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45295e03b5e8ec0dda4fd0d7401f95516c92d48eba415337d25d3d2ef210a869
-  data.tar.gz: bfe94afbb669fdd6bb4b407b8ddacfaf17695b49f4bdd2d83645290f97f7b5b6
+  metadata.gz: 4b1f7a963b818e8c87405bd16dc08ad715d703a9bc4368a268180f3f75efd9b9
+  data.tar.gz: 12972d4bb0c529e2a78bb6142622ef161da444ee7d409fe0677f1fdd28846311
 SHA512:
-  metadata.gz: c99e489c2328e9a1fb3ada71d3c62f0a3ce9d75e93bf78206e56490a4153d60a20601bc5d7fee351485ede848a6c640310f7df3b29c3c73c138ac4b466f62b3d
-  data.tar.gz: 20b278901afbfaa467ec1bd72056f6fbf7420d6ab62f9352193023a46a9e44b7712a37ebb495db1016d6b77a8ca1a7eb729c06ab56c7e8061150e894b64a22f2
+  metadata.gz: dbe8c7587ea30dc6483b42e8b17416d2a432b6f1753774b5e2f55373dc195a7b2907ab44c22dcba8db672adb6266fe24dd97b40a9c6c821c7f1587ef83f9bacf
+  data.tar.gz: cd9cb0800c58554b877dc41c481a18e612b3d557f795ee4546fd9230e4299ac1c5c5e3eb66ca6ac279f12945679e72d86d2c699a0d7fbbfa6d5401042b69d9ec

data/lib/redfish_client/event_listener.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "json"
+require "uri"
+
+module RedfishClient
+  # EventListener class can be used to stream events from Redfish service. It
+  # is a thin wrapper around SSE listener that does the dirty work of
+  # splitting each event into its EventRecords and reporting them as separate
+  # events.
+  class EventListener
+    # Create new EventListener instance.
+    #
+    # @param sse_client [ServerSentEvents::Client] SSE client
+    def initialize(sse_client)
+      @sse_client = sse_client
+    end
+
+    # Stream events from redfish service.
+    #
+    # Events that this method yields are actually EventRecords, extracted from
+    # the actual Redfish Event.
+    def listen
+      @sse_client.listen do |event|
+        split_event_into_records(event).each { |r| yield(r) }
+      end
+    end
+
+    private
+
+    def split_event_into_records(event)
+      JSON.parse(event.data).fetch("Events", [])
+    end
+  end
+end

data/lib/redfish_client/root.rb

@@ -2,6 +2,8 @@
 
 require "base64"
 require "json"
+require "server_sent_events"
+
 require "redfish_client/resource"
 
 module RedfishClient
@@ -62,6 +64,18 @@ module RedfishClient
       Resource.new(@connector, oid: oid)
     end
 
+    # Return event listener.
+    #
+    # If the service does not support SSE, this function will return nil.
+    #
+    # @return [EventListener, nil] event listener
+    def event_listener
+      address = dig("EventService", "ServerSentEventUri")
+      return nil if address.nil?
+
+      EventListener.new(ServerSentEvents.create_client(address))
+    end
+
     private
 
     def session_login_available?

data/lib/redfish_client/version.rb

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

data/redfish_client.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = "~> 2.1"
 
   spec.add_runtime_dependency "excon", "~> 0.60"
+  spec.add_runtime_dependency "server_sent_events", "~> 0.1"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", ">= 11.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redfish_client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tadej Borovšak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-12 00:00:00.000000000 Z
+date: 2018-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: server_sent_events
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +158,7 @@ files:
 - lib/redfish_client.rb
 - lib/redfish_client/caching_connector.rb
 - lib/redfish_client/connector.rb
+- lib/redfish_client/event_listener.rb
 - lib/redfish_client/resource.rb
 - lib/redfish_client/root.rb
 - lib/redfish_client/version.rb