redfish_client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ef675df00d6ecec6a42816c288047a68a9cf85f6
-  data.tar.gz: 0a6d6dc6e5c8af0b70857f7fcf8d49ddfde0c2c8
+SHA256:
+  metadata.gz: 7927655fca079fcda9d87e9a2b528e747af59e9385a24ad3c59b92c0e0caa6dc
+  data.tar.gz: 7981e1da150898a1b5a084f8277eb7a8cb642182ee1ef109764e3252a3109c42
 SHA512:
-  metadata.gz: 6c44c7d4045c017703ce35a137bbb8de69ce9e77bc18459b9fc333829d9b612f294ff05bce990895de7fadf92ab68019000ec62ec8491459b50baef4520f9cfd
-  data.tar.gz: 780cabd5d73abcb4a146e13ccd0ad548e07716fa0e499ea8014574b61638667fe533ab566f12944ef1b862c97e6c85ad97de6631e8512be42712ea88350843be
+  metadata.gz: 6687e1bcc7461fef0bfba86dcd9b1436aed911ede07d917d5e28d8bb87aa19bb77eb6d106eb3f8f4fd2c1b75bbe2b566d496d70d884fd9350f5875c5f68b6e18
+  data.tar.gz: 81df752a968d94871a7409bc6a057662c2842848cb8f3f1c2f43fa77bf5e9818f5fe052f6ece86ae3f0a97476dbb16c6c7678d8bda7dcc1106ea8c72abb70a12

data/.codeclimate.yml

@@ -0,0 +1,3 @@
+plugins:
+  rubocop:
+    enabled: true

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  TargetRubyVersion: 2.3
   Exclude:
     - redfish_client.gemspec
     - Gemfile
@@ -14,6 +15,9 @@ Style/Documentation:
 Style/BracesAroundHashParameters:
   EnforcedStyle: context_dependent
 
+Metrics/AbcSize:
+  Max: 20
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*.rb

data/.travis.yml

@@ -1,8 +1,27 @@
 sudo: false
 language: ruby
 cache: bundler
+
 rvm:
 - 2.4.3
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=5bfd87f6c63155c74a46e37c94800e369d3b791988b2601113d843b1391474af
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+branches:
+  only:
+    - master
+    - /^\d+\.\d+(\.\d+)?(-\S*)?$/
+
 deploy:
   provider: rubygems
   api_key:

data/README.md

@@ -1,5 +1,12 @@
 # Redfish Ruby Client
 
+[![Build Status](https://travis-ci.org/xlab-si/redfish_client.svg?branch=master)](https://travis-ci.org/xlab-si/redfish_client)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ce990310be22db90c3e2/maintainability)](https://codeclimate.com/github/xlab-si/redfish_client/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/ce990310be22db90c3e2/test_coverage)](https://codeclimate.com/github/xlab-si/redfish_client/test_coverage)
+[![Dependency Status](https://beta.gemnasium.com/badges/github.com/xlab-si/redfish_client.svg)](https://beta.gemnasium.com/projects/github.com/xlab-si/redfish_client)
+[![security](https://hakiri.io/github/xlab-si/redfish_client/master.svg)](https://hakiri.io/github/xlab-si/redfish_client/master)
+
+
 This repository contains source code for redfish_client gem that can be used
 to connect to Redfish services.
 
@@ -37,16 +44,15 @@ Minimal program that uses this gem would look something like this:
 ## 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.
+run `bundle exec 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).
+To create new release, increment the version number, commit the change, tag
+the commit and push tag to the GitHub. Travis CI will pick from there on and
+create new release, publishing it on https://rubygems.org.
 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redfish_client.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/xlab-si/redfish_client.

data/lib/redfish_client/connector.rb

@@ -79,7 +79,6 @@ module RedfishClient
       @connection.patch(params)
     end
 
-
     # Issue DELETE requests to the service.
     #
     # @param path [String] path to the resource, relative to the base

data/lib/redfish_client/resource.rb

@@ -168,7 +168,7 @@ module RedfishClient
     private
 
     def get_path(field, path)
-      raise NoODataId if path.nil? and !key?(field)
+      raise NoODataId if path.nil? && !key?(field)
       path || @content[field]
     end
 

data/lib/redfish_client/root.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "base64"
 require "redfish_client/resource"
 
 module RedfishClient
@@ -9,39 +10,36 @@ module RedfishClient
     # AuthError is raised if the user session cannot be created.
     class AuthError < StandardError; end
 
-    # Token authentication header.
-    AUTH_HEADER = "X-Auth-Token"
+    # Basic and token authentication headers.
+    BASIC_AUTH_HEADER = "Authorization"
+    TOKEN_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.
+    # provided credentials. If the session creation fails, basic
+    # authentication will be attempted. If basic authentication 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]))
+      # Since session auth is more secure, we try it first and use basic auth
+      # only if session auth is not available.
+      if session_login_available?
+        session_login(username, password)
+      else
+        basic_login(username, password)
+      end
     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])
+      session_logout
+      basic_logout
     end
 
     # Find Redfish service object by OData ID field.
@@ -51,5 +49,47 @@ module RedfishClient
     def find(oid)
       Resource.new(@connector, oid: oid)
     end
+
+    private
+
+    def session_login_available?
+      !@content.dig("Links", "Sessions").nil?
+    end
+
+    def session_login(username, password)
+      r = self.Links.Sessions.post(
+        payload: { "UserName" => username, "Password" => password }
+      )
+      raise AuthError, "Invalid credentials" unless r.status == 201
+
+      session_logout
+
+      payload = r.data[:headers][TOKEN_AUTH_HEADER]
+      @connector.add_headers(TOKEN_AUTH_HEADER => payload)
+      @session = Resource.new(@connector, content: JSON.parse(r.data[:body]))
+    end
+
+    def session_logout
+      return unless @session
+      r = @session.delete
+      raise AuthError unless r.status == 204
+      @session = nil
+      @connector.remove_headers([TOKEN_AUTH_HEADER])
+    end
+
+    def auth_test_path
+      @content.values.map { |v| v["@odata.id"] }.compact.first
+    end
+
+    def basic_login(username, password)
+      payload = Base64.encode64("#{username}:#{password}").strip
+      @connector.add_headers(BASIC_AUTH_HEADER => "Basic #{payload}")
+      r = @connector.get(auth_test_path)
+      raise AuthError, "Invalid credentials" unless r.status == 200
+    end
+
+    def basic_logout
+      @connector.remove_headers([BASIC_AUTH_HEADER])
+    end
   end
 end

data/lib/redfish_client/version.rb

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

data/lib/redfish_client.rb

@@ -1,19 +1,10 @@
 # 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redfish_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tadej Borovšak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-25 00:00:00.000000000 Z
+date: 2018-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -129,6 +129,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Simple Redfish client library