train-rest 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b0cc26cff4431701e6fba113884d8c06a943c16cb231e8a564c464e7ba01cf2
-  data.tar.gz: 78aa236a0c1b8a92480b096e9a40b9c3993be5dbafef907a01144cf630e4267f
+  metadata.gz: 59770f2304519af69df3caaac4f4ef19f964a0a4700952ff6a3b96834867bf13
+  data.tar.gz: 39546783f42569561a1f740c094d0f2adb1a31c49c710b5c9736f172a961306f
 SHA512:
-  metadata.gz: cb7767fe6dbc98466d9f8450a75f6849d21a8876f8672177db891a91edcdf07a075ab6f59ae98ae24759f827b87ce13ecaaa63934d94d44a8e469716c3e04116
-  data.tar.gz: 5f76c1a724b6b2c453f30240d71cd5717c818b722c0df527664980f94a32802492cfa267bab70bf105a37370e70dd61f0f28783980a2f584f7e9e9797298dce6
+  metadata.gz: c8b2b55eb1723538a552ecbc7ce452a3545bd8ae3e35a82c263f3bbc16d6bfed161d053a6a711b0e34723c4f332e6d7797a40035d6142fc9957618a10ad6dac6
+  data.tar.gz: 967e71707994db3086ea1f71e5d987324c405930ecb4473b9ad886ca59b32d15efb2e4c42f4f4075a607d642a11d78d4fe5e4fe6946468eb348735dd24bde514

data/README.md

@@ -119,14 +119,20 @@ conn   = train.connection
 conn.close
 ```
 
-Example for logging into a RedFish based system:
+Example for logging into a RedFish based system. Please note that the RedFish
+authentication handler will append `redfish/v1` to the endpoint automatically,
+if it is not present.
+
+Due to this, you can use RedFish systems either with a base URL like in the
+example below or with a full one. Your own code needs to match the style
+you choose.
 
 ```ruby
 require 'train-rest'
 
 # This will immediately do a login and add headers
 train  = Train.create('rest', {
-            endpoint: 'https://api.example.com/v1/',
+            endpoint: 'https://10.20.30.40',
             validate_ssl: false,
 
             auth_type: :redfish,

data/lib/train-rest/auth_handler/redfish.rb

@@ -13,7 +13,7 @@ module TrainPlugins
 
       def login
         response = connection.post(
-          "SessionService/Sessions/",
+          login_url,
           headers: {
             "Content-Type" => "application/json",
             "OData-Version" => "4.0",
@@ -24,10 +24,11 @@ module TrainPlugins
           }
         )
 
-        raise StandardError.new("Authentication with Redfish failed") unless response.code === 201
-
         @session_token = response.headers["x-auth-token"].first
         @logout_url = response.headers["location"].first
+
+      rescue ::RestClient::RequestFailed => err
+        raise StandardError.new("Authentication with Redfish failed: " + err.message)
       end
 
       def logout
@@ -39,6 +40,15 @@ module TrainPlugins
 
         { "X-Auth-Token": @session_token }
       end
+
+      private
+
+      # Prepend the RedFish base, if not a global setting in the connection URL
+      def login_url
+        return "SessionService/Sessions/" if options[:endpoint].include?("redfish/v1")
+
+        "redfish/v1/SessionService/Sessions/"
+      end
     end
   end
 end

data/lib/train-rest/connection.rb

@@ -13,6 +13,12 @@ module TrainPlugins
       def initialize(options)
         super(options)
 
+        # Plugin was called with an URI only
+        options[:endpoint] = options[:target].sub("rest://", "https://") unless options[:endpoint]
+
+        # Accept string (CLI) and boolean (API) options
+        options[:verify_ssl] = options[:verify_ssl].to_s == "false" ? false : true
+
         connect
       end
 
@@ -25,7 +31,7 @@ module TrainPlugins
       end
 
       def uri
-        components = URI.new(options[:endpoint])
+        components = URI(options[:endpoint])
         components.scheme = "rest"
         components.to_s
       end
@@ -35,7 +41,7 @@ module TrainPlugins
         OpenStruct.new({
           name: "rest",
           release: TrainPlugins::Rest::VERSION,
-          family_hierarchy: ["", "api"],
+          family_hierarchy: %w{rest api},
           family: "api",
           platform: "rest",
           platform_version: 0,
@@ -54,6 +60,7 @@ module TrainPlugins
 
       %i{get post put patch delete head}.each do |method|
         define_method(method) do |path, *parameters|
+          # TODO: "warning: Using the last argument as keyword parameters is deprecated; maybe ** should be added to the call"
           request(path, method, *parameters)
         end
       end
@@ -139,11 +146,15 @@ module TrainPlugins
       end
 
       def login
+        logger.info format("REST Login via %s authentication handler", auth_type.to_s) if auth_type != :anonymous
+
         auth_handler.options = options
         auth_handler.login
       end
 
       def logout
+        logger.info format("REST Logout via %s authentication handler", auth_type.to_s) if auth_type != :anonymous
+
         auth_handler.logout
       end
     end

data/lib/train-rest/version.rb

@@ -1,5 +1,5 @@
 module TrainPlugins
   module Rest
-    VERSION = "0.2.0".freeze
+    VERSION = "0.2.1".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-rest
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Thomas Heinen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-12 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: train