redfish_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef675df00d6ecec6a42816c288047a68a9cf85f6
+  data.tar.gz: 0a6d6dc6e5c8af0b70857f7fcf8d49ddfde0c2c8
+SHA512:
+  metadata.gz: 6c44c7d4045c017703ce35a137bbb8de69ce9e77bc18459b9fc333829d9b612f294ff05bce990895de7fadf92ab68019000ec62ec8491459b50baef4520f9cfd
+  data.tar.gz: 780cabd5d73abcb4a146e13ccd0ad548e07716fa0e499ea8014574b61638667fe533ab566f12944ef1b862c97e6c85ad97de6631e8512be42712ea88350843be

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  Exclude:
+    - redfish_client.gemspec
+    - Gemfile
+    - Rakefile
+    - bin/**
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_filter "/spec/"
+end

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+- 2.4.3
+deploy:
+  provider: rubygems
+  api_key:
+    secure: NdOd7EA9XQZNbnkzLFNXeJcOoaTi93uuwzjADS+fxFJ2HYGJs/T+gi98f742Oj4j187lBQjwICkdduGQjVn3BA/8YZD7sOkdywDSELupTjJmugf/hks6MiKJ0fex5GmHwspjZ7P+9iLPXGcaYWbGamWlSDL+Z/79s4bi8b5sBVwJ01YnIJvFn32/I5vPFwbwUzvH0n3HAjYHZ/kpZ122Zp/DhSpGam2azWF0Tynu7RNMsQrGamAH0mC1DzAscSD6VTyMcSMkD6XUr3GX7w7yvVO0qo7e6EcjrsJKMRC8/s2C/SWQ4pRDAldhQpd4C7/QSaHE0mmQcEYi2qsBmrbFb7cAfRmS5BKn8LSv7YPVH0VFl3fwYAycwqA068TZ68t99YPw7uVcJpDOWBODCQWA1wgV1tXHop7CJOcQW4MoXzyaRbbpF+6lyxXEgTz8Me8zEucMsHWzS9dI1E5x/bWl3TgEM9n+/G6BAcBj/mZv/dxC6H7kWp0ubKw0bRsdET/YmG53vxISaFbnLxNhsHzeE2mFeF+JL7a1amlC4aTiSBnxDgRzDdnoo42Hu8SUg/mp0xLjyoTME1w1zaB+GvmWCdrpkLQL2kNDgQUvBfOp+Zqfb37tKgc15zb7v2sru5acixkSG9UVElleDW8K4R1QcqXwLxCYccCi/ExVR1zSvSM=
+  gem: redfish_client
+  on:
+    tags: true
+    repo: xlab-si/redfish_client

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+-
+README.md

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in redfish_client.gemspec
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+# Redfish Ruby Client
+
+This repository contains source code for redfish_client gem that can be used
+to connect to Redfish services.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "redfish_client"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redfish_client
+
+
+## Usage
+
+Minimal program that uses this gem would look something like this:
+
+    require "redfish_client"
+
+    root = RedfishClient.new("https://localhost:8000",
+                             prefix: "/redfish/v1",
+                             verify: false)
+    puts root
+    root.login("username", "password")
+    puts root.Systems
+    root.logout
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redfish_client.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redfish_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redfish_client.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "redfish_client/connector"
+require "redfish_client/null_logger"
+require "redfish_client/root"
+require "redfish_client/version"
+
+module RedfishClient
+  def self.logger
+    @logger ||= NullLogger.new
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.new(url, prefix: "/redfish/v1", verify: true)
+    con = Connector.new(url, verify)
+    Root.new(con, oid: prefix)
+  end
+end

data/lib/redfish_client/connector.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "excon"
+require "json"
+
+module RedfishClient
+  # Connector serves as a low-level wrapper around HTTP calls that are used
+  # to retrieve data from the service API. It abstracts away implementation
+  # details such as sending the proper headers in request, which do not
+  # change between resource fetches.
+  #
+  # Library users should treat this class as an implementation detail and
+  # use higer-level {RedfishClient::Resource} instead.
+  class Connector
+    # Default headers, as required by Redfish spec
+    # https://redfish.dmtf.org/schemas/DSP0266_1.4.0.html#request-headers
+    DEFAULT_HEADERS = {
+      "Accept" => "application/json",
+      "OData-Version" => "4.0"
+    }.freeze
+
+    # Create new connector.
+    #
+    # @param url [String] base url of the Redfish service
+    # @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
+    end
+
+    # Add HTTP headers to the requests made by the connector.
+    #
+    # @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.
+    #
+    # Headers that are not currently set are silently ignored and no error is
+    # raised.
+    #
+    # @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.
+    #
+    # @param path [String] path to the resource, relative to the base url
+    # @return [Excon::Response] response object
+    def get(path)
+      @connection.get(path: path)
+    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
+    # @return [Excon::Response] response object
+    def post(path, body = nil)
+      params = { path: path }
+      params[:body] = body if body
+      @connection.post(params)
+    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
+    # @return [Excon::Response] response object
+    def patch(path, body = nil)
+      params = { path: path }
+      params[:body] = body if body
+      @connection.patch(params)
+    end
+
+
+    # Issue DELETE requests to the service.
+    #
+    # @param path [String] path to the resource, relative to the base
+    # @return [Excon::Response] response object
+    def delete(path)
+      @connection.delete(path: path)
+    end
+
+    private
+
+    def create_connection
+      Excon.new(@url, headers: @headers, ssl_verify_peer: @verify)
+    end
+  end
+end

data/lib/redfish_client/resource.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+require "json"
+
+module RedfishClient
+  # Resource is basic building block of Redfish client and serves as a
+  # container for the data that is retrieved from the Redfish service.
+  #
+  # When we interact with the Redfish service, resource will wrap the data
+  # retrieved from the service API and offer us dot-notation accessors for
+  # values stored.
+  #
+  # Resource will also load any sub-resource on demand when we access it.
+  # For example, if we have a root Redfish resource stored in `root`,
+  # accessing `root.SessionService` will automatically fetch the appropriate
+  # 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
+  # fresh values from the service, {#reset} call will flush the cache,
+  # causing next access to retrieve fresh data.
+  class Resource
+    # NoODataId error is raised when operation would need OpenData id of the
+    # resource to accomplish the task a hand.
+    class NoODataId < StandardError; end
+
+    # Create new resource.
+    #
+    # Resource can be created either by passing in OpenData identifier or
+    # supplying the content (hash). In the first case, connector will be used
+    # to fetch the resource data. In the second case, resource only wraps the
+    # passed-in hash and does no fetching.
+    #
+    # @param connector [RedfishClient::Connector] connector that will be used
+    #   to fetch the resources
+    # @param oid [String] OpenData id of the resource
+    # @param content [Hash]
+    def initialize(connector, oid: nil, content: nil)
+      if oid
+        resp = connector.get(oid)
+        @content = JSON.parse(resp.data[:body])
+        @content["@odata.id"] = oid
+        @headers = resp.data[:headers]
+      else
+        @content = content
+      end
+
+      @cache = {}
+      @connector = connector
+    end
+
+    # Access resource content.
+    #
+    # 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]`.
+    #
+    # Accessing non-existent or indexing non-collection resource key will
+    # raise `KeyError`. Accessing invalid index will raise `IndexError`.
+    #
+    # @param attr [String, Integer] key or index for accessing data
+    # @return associated value
+    def [](attr)
+      if attr.is_a?(Integer)
+        raise(KeyError, "Not a collection.") unless key?("Members")
+        cache("Members").fetch(attr)
+      else
+        cache(attr)
+      end
+    end
+
+    # Test if resource contains required key.
+    #
+    # @param name [String, Symbol] key name to test
+    # @return [Boolean] inclusion test result
+    def key?(name)
+      @content.key?(name.to_s)
+    end
+
+    # Convenience access for resource data.
+    #
+    # Calling `resource.Value` is exactly the same as `resource["Value"]`. The
+    # only difference is that accessing non-existent field will raise
+    # NoMethodError instead of KeyError as `[]` method does.
+    def method_missing(symbol, *args, &block)
+      name = symbol.to_s
+      key?(name) ? self[name] : super
+    end
+
+    def respond_to_missing?(symbol, include_private = false)
+      key?(symbol.to_s) || super
+    end
+
+    # Clear the cached sub-resources. Next sub-resource access will repopulate
+    # the cache.
+    def reset
+      @cache = {}
+    end
+
+    # Access raw JSON data that resource wraps.
+    #
+    # @return [Hash] wrapped data
+    def raw
+      @content
+    end
+
+    # Pretty-print the wrapped content.
+    #
+    # @return [String] JSON-serialized raw data
+    def to_s
+      JSON.pretty_generate(@content)
+    end
+
+    # Issue a POST requests to the selected endpoint.
+    #
+    # By default, POST request will be sent to the path, stored in `@odata.id`
+    # field. Source field can be changed by specifying the `field` parameter
+    # when calling this function. Specifying the `path` argument will bypass
+    # the field lookup altogether and POST directly to the requested path.
+    #
+    # In order to avoid having to manually serialize data to JSON, this
+    # function call takes Hash as a payload and encodes it before sending it
+    # to the endpoint.
+    #
+    # If the resource has no lookup field, {NoODataId} error will be raised,
+    # since posting to non-networked resources makes no sense and probably
+    # indicates bug in library consumer.
+    #
+    # @param field [String, Symbol] path lookup field
+    # @param path [String] path to post to
+    # @param payload [Hash<String, >] data to send
+    # @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 : "")
+    end
+
+    # Issue a PATCH requests to the selected endpoint.
+    #
+    # Works exactly the same as the {post} method, but issued a PATCH request
+    # to the server.
+    #
+    # @param field [String, Symbol] path lookup field
+    # @param path [String] path to patch
+    # @param payload [Hash<String, >] data to send
+    # @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 : "")
+    end
+
+    # Issue a DELETE requests to the endpoint of the resource.
+    #
+    # If the resource has no `@odata.id` field, {NoODataId} error will be
+    # raised, since deleting non-networked resources makes no sense and
+    # probably indicates bug in library consumer.
+    #
+    # @return [Excon::Response] response
+    # @raise  [NoODataId] resource has no OpenData id
+    def delete
+      @connector.delete(get_path("@odata.id", nil))
+    end
+
+    private
+
+    def get_path(field, path)
+      raise NoODataId if path.nil? and !key?(field)
+      path || @content[field]
+    end
+
+    def cache(name)
+      @cache[name] ||= build_resource(@content.fetch(name))
+    end
+
+    def build_resource(data)
+      case data
+      when Hash then build_hash_resource(data)
+      when Array then data.collect { |d| build_resource(d) }
+      else data
+      end
+    end
+
+    def build_hash_resource(data)
+      if data.key?("@odata.id")
+        Resource.new(@connector, oid: data["@odata.id"])
+      else
+        Resource.new(@connector, content: data)
+      end
+    end
+  end
+end

data/lib/redfish_client/root.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "redfish_client/resource"
+
+module RedfishClient
+  # Root resource represents toplevel entry point into Redfish service data.
+  # Its main purpose is to provide authentication support for the API.
+  class Root < Resource
+    # AuthError is raised if the user session cannot be created.
+    class AuthError < StandardError; end
+
+    # Token authentication header.
+    AUTH_HEADER = "X-Auth-Token"
+
+    # Authenticate against the service.
+    #
+    # Calling this method will try to create new session on the service using
+    # provided credentials. If the session creation fails, {AuthError} will be
+    # raised.
+    #
+    # @param username [String] username
+    # @param password [String] password
+    # @raise [AuthError] if user session could not be created
+    def login(username, password)
+      r = self.Links.Sessions.post(
+        payload: { "UserName" => username, "Password" => password }
+      )
+      raise AuthError unless r.status == 201
+
+      logout
+      rdata = r.data
+      @connector.add_headers(AUTH_HEADER => rdata[:headers][AUTH_HEADER])
+      @session = Resource.new(@connector, content: JSON.parse(rdata[:body]))
+    end
+
+    # Sign out of the service.
+    #
+    # If the session could not be deleted, {AuthError} will be raised.
+    def logout
+      return unless @session
+      r = @session.delete
+      raise AuthError unless r.status == 204
+      @session = nil
+      @connector.remove_headers([AUTH_HEADER])
+    end
+
+    # Find Redfish service object by OData ID field.
+    #
+    # @param oid [String] Odata id of the resource
+    # @return [Resource] new resource
+    def find(oid)
+      Resource.new(@connector, oid: oid)
+    end
+  end
+end

data/lib/redfish_client/version.rb

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

data/redfish_client.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redfish_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redfish_client"
+  spec.version       = RedfishClient::VERSION
+  spec.authors       = ["Tadej Borovšak"]
+  spec.email         = ["tadej.borovsak@xlab.si"]
+
+  spec.summary       = "Simple Redfish client library"
+  spec.homepage      = "https://github.com/xlab-si/redfish_client"
+  spec.license       = "Apache-2.0"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = "~> 2.1"
+
+  spec.add_runtime_dependency "excon", "~> 0.60"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", ">= 11.0"
+  spec.add_development_dependency "rspec", ">= 3.7"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: redfish_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tadej Borovšak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tadej.borovsak@xlab.si
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redfish_client.rb
+- lib/redfish_client/connector.rb
+- lib/redfish_client/resource.rb
+- lib/redfish_client/root.rb
+- lib/redfish_client/version.rb
+- redfish_client.gemspec
+homepage: https://github.com/xlab-si/redfish_client
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Simple Redfish client library
+test_files: []