train-rest 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1550899c2f8aad404793b83b1f7700ece96937efc8b78cb1eb7aebb8d6d2a2a2
-  data.tar.gz: b9251734100cc43233504afbe6e8d6fbd11bec1b07a16db7884720e907a164e2
+  metadata.gz: 73a28c27d6e8385d3d8356c363847ddae1380ff0d0e75d6f919f64cefb315637
+  data.tar.gz: 1b0140ce7079d48ac070b05607acc1b142c987cd598a7f60fdc28ff3025dc3f6
 SHA512:
-  metadata.gz: 1630381a0f378a7a4a275202fc19a60f71579b99f6b1ae50229c72b67cce2466e5d8b2f4a5b5c3c23f8c1c5c4ccc4817f768fc36cd65c3c8ac9c1b81609b1994
-  data.tar.gz: 02ed2d874ac736d016fc75f24a1c02e8b9209ec5f43cbb9281bf615106a04d53f4d49d26682e84cb7c2b7ab6a949dc2589823a769e9b87aa3c03aa428c50d919
+  metadata.gz: 293e8e03b838b888108eb25ac164080f76aa0291420bcd04feb8503245c3149ff3d03257ad01df3ea3d2fae018094a0ec85c1e4a3b052b1a07c3cc0db69b0244
+  data.tar.gz: a816054a1e6db4bd24134249adaedd933b16b9796c3cfde7afa90f4e66ea70d9cdf744bea124ee2e93b383d6ad4b666e4bdd2a4ae363fa09056bad3eb85ada6f

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

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

@@ -0,0 +1,119 @@
+require 'aws-sigv4'
+require 'json'
+
+require_relative "../auth_handler"
+
+module TrainPlugins
+  module Rest
+    class AWSV4 < AuthHandler
+      VALID_CREDENTIALS = %w[
+        access_keys
+      ].freeze
+
+      SIGNED_HEADERS = %w[
+        content-type host x-amz-date x-amz-target
+      ].freeze
+
+      def check_options
+        options[:credentials] ||= "access_keys"
+
+        unless VALID_CREDENTIALS.include? credentials
+          raise ArgumentError.new("Invalid type of credentials: #{credentials}")
+        end
+
+        if access_keys?
+          raise ArgumentError.new('Missing `access_key` credential') unless access_key
+          raise ArgumentError.new('Missing `secret_access_key` credential') unless secret_access_key
+        end
+      end
+
+      def signature_based?
+        true
+      end
+
+      def process(payload: "", headers: {}, url: "", method: nil)
+        headers.merge! ({
+          'Accept-Encoding' => 'identity',
+          'User-Agent' => "train-rest/#{TrainPlugins::Rest::VERSION}",
+          'Content-Type' => 'application/x-amz-json-1.0'
+        })
+
+        signed_headers = headers.select do |name, _value|
+          SIGNED_HEADERS.include? name.downcase
+        end
+
+	@url = url
+
+        signature = signer(url).sign_request(
+          http_method: method.to_s.upcase,
+          url: url,
+          headers: signed_headers,
+          body: payload.to_json
+        )
+
+        {
+          headers: headers.merge(signature.headers)
+        }
+      end
+
+      def process_error(error)
+        raise AuthenticationError.new("Authentication failed: #{error.response.to_s.chop}") if error.response.code == 401
+        raise BadRequest.new("Bad request: #{error.response.to_s.chop}") if error.response.code == 400
+
+        message = JSON.parse(error.response.to_s)
+
+        raise AuthenticationError.new(message["message"] || message["__type"])
+      rescue JSON::ParserError => e
+        raise AuthenticationError.new(error.response.to_s)
+      end
+
+      def access_key
+        options[:access_key] || ENV['AWS_ACCESS_KEY_ID']
+      end
+
+      def region(url = default_url)
+        url.delete_prefix('https://').split('.').at(1)
+      end
+
+      private
+
+      def credentials
+        options[:credentials]
+      end
+
+      def default_url
+        options[:endpoint]
+      end
+
+      def access_keys?
+        credentials == 'access_keys'
+      end
+
+      def secret_access_key
+        options[:secret_access_key] || ENV['AWS_SECRET_ACCESS_KEY']
+      end
+
+      def service(url)
+        url.delete_prefix('https://').split('.').at(0)
+      end
+
+      def signer(url)
+        Aws::Sigv4::Signer.new(
+          service: service(url),
+          region:  region(url),
+
+          **signer_credentials
+        )
+      end
+
+      def signer_credentials
+        if access_keys?
+          {
+            access_key_id: access_key,
+            secret_access_key: secret_access_key
+          }
+        end
+      end
+    end
+  end
+end

data/lib/train-rest/auth_handler/hmac-signature.rb

@@ -0,0 +1,39 @@
+require_relative "../auth_handler"
+
+module TrainPlugins
+  module Rest
+    # Authentication via HMAC Signature.
+    class HmacSignature < AuthHandler
+      def check_options
+        raise ArgumentError.new("Need :hmac_secret for HMAC signatures") unless options[:hmac_secret]
+
+        options[:header] ||= "X-Signature"
+        options[:digest] ||= "SHA256"
+      end
+
+      def hmac_secret
+        options[:hmac_secret]
+      end
+
+      def digest
+        options[:digest]
+      end
+
+      def header
+        options[:header]
+      end
+
+      def signature_based?
+        true
+      end
+
+      def process(payload: "", headers: {}, url: "", method: nil)
+        {
+          headers: {
+            header => OpenSSL::HMAC.hexdigest(digest, hmac_secret, payload)
+          }
+        }
+      end
+    end
+  end
+end

data/lib/train-rest/auth_handler.rb

@@ -67,6 +67,30 @@ module TrainPlugins
         { headers: auth_headers }
       end
 
+      # This Auth Handler will need payload, URI and headers, e.g. for signatures.
+      #
+      # @return  [Boolean]
+      def signature_based?
+        false
+      end
+
+      # Return headers based on payload signing.
+      #
+      # @param [Hash] data different types of data for processing
+      # @option data [String] :payload contents of the message body
+      # @option data [Hash] :headers existing headers to the request
+      # @option data [String] :url URL which will be requested
+      # @option data [Symbol] :method Method to execute
+      # @returns [Hash]
+      def process(payload: "", headers: {}, url: "", method: nil)
+        {}
+      end
+
+      # Allow processing errors related to authentication.
+      #
+      # @param [RestClient::Exception] error raw error data
+      def process_error(_error); end
+
       class << self
         private
 
@@ -77,7 +101,8 @@ module TrainPlugins
         # @see https://github.com/chef/chef/blob/main/lib/chef/mixin/convert_to_class_name.rb
         def convert_to_snake_case(str)
           str = str.dup
-          str.gsub!(/[A-Z]/) { |s| "_" + s }
+          str.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          str.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
           str.downcase!
           str.sub!(/^\_/, "")
           str

data/lib/train-rest/connection.rb

@@ -114,6 +114,21 @@ module TrainPlugins
         # Merge override headers + request specific headers
         parameters[:headers].merge!(override_headers || {})
         parameters[:headers].merge!(headers)
+
+        # Merge payload based headers (e.g. signature-based auth)
+        if auth_handler.signature_based?
+          auth_signature = auth_handler.process(
+                                payload: data,
+                                headers: parameters[:headers],
+                                url: parameters[:url],
+                                method: method
+                              )
+
+          parameters[:headers].merge! auth_signature[:headers]
+        else
+          parameters[:headers].merge! auth_parameters[:headers]
+        end
+
         parameters.compact!
 
         logger.info format("[REST] => %s", parameters.to_s) if options[:debug_rest]
@@ -121,6 +136,9 @@ module TrainPlugins
 
         logger.info format("[REST] <= %s", response.to_s) if options[:debug_rest]
         transform_response(response, json_processing)
+
+      rescue RestClient::Exception => error
+        auth_handler.process_error(error)
       end
 
       # Allow switching generic handlers for an API-specific one.
@@ -144,12 +162,21 @@ module TrainPlugins
         options[:auth_type]
       end
 
+      attr_writer :auth_handler
+
       # Auth Handlers-faced API
 
       def auth_parameters
         auth_handler.auth_parameters
       end
 
+      def auth_handler
+        desired_handler = auth_handler_classes.detect { |handler| handler.name == auth_type.to_s }
+        raise NameError.new(format("Authentication handler %s not found", auth_type.to_s)) unless desired_handler
+
+        @auth_handler ||= desired_handler.new(self)
+      end
+
       private
 
       def global_parameters
@@ -160,8 +187,6 @@ module TrainPlugins
           headers: options[:headers],
         }
 
-        params.merge!(auth_parameters)
-
         params
       end
 
@@ -184,23 +209,14 @@ module TrainPlugins
         :basic if options[:username] && options[:password]
       end
 
-      attr_writer :auth_handler
-
       def auth_handler_classes
-        AuthHandler.descendants
+        ::TrainPlugins::Rest::AuthHandler.descendants
       end
 
       def auth_handlers
         auth_handler_classes.map { |handler| handler.name.to_sym }
       end
 
-      def auth_handler
-        desired_handler = auth_handler_classes.detect { |handler| handler.name == auth_type.to_s }
-        raise NameError.new(format("Authentication handler %s not found", auth_type.to_s)) unless desired_handler
-
-        @auth_handler ||= desired_handler.new(self)
-      end
-
       def login
         logger.info format("REST Login via %s authentication handler", auth_type.to_s) unless %i{anonymous basic}.include? auth_type
 

data/lib/train-rest/errors.rb

@@ -0,0 +1,6 @@
+module TrainPlugins
+  module Rest
+    class AuthenticationError < RuntimeError; end
+    class BadRequest < RuntimeError; end
+  end
+end

data/lib/train-rest/version.rb

@@ -1,5 +1,5 @@
 module TrainPlugins
   module Rest
-    VERSION = "0.4.0".freeze
+    VERSION = "0.5.0".freeze
   end
 end

data/lib/train-rest.rb

@@ -1,14 +1,18 @@
 libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
+require "train-rest/errors"
 require "train-rest/version"
 
 require "train-rest/transport"
 require "train-rest/connection"
 
+require "train-rest/auth_handler"
+require "train-rest/auth_handler/awsv4"
 require "train-rest/auth_handler/anonymous"
 require "train-rest/auth_handler/authtype-apikey"
-require "train-rest/auth_handler/header"
 require "train-rest/auth_handler/basic"
 require "train-rest/auth_handler/bearer"
+require "train-rest/auth_handler/header"
+require "train-rest/auth_handler/hmac-signature"
 require "train-rest/auth_handler/redfish"

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: train-rest
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Thomas Heinen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2022-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: train
+  name: aws-sigv4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: train-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -58,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -115,21 +129,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- README.md
+- LICENSE
 - lib/train-rest.rb
 - lib/train-rest/auth_handler.rb
 - lib/train-rest/auth_handler/anonymous.rb
 - lib/train-rest/auth_handler/authtype-apikey.rb
+- lib/train-rest/auth_handler/awsv4.rb
 - lib/train-rest/auth_handler/basic.rb
 - lib/train-rest/auth_handler/bearer.rb
 - lib/train-rest/auth_handler/header.rb
+- lib/train-rest/auth_handler/hmac-signature.rb
 - lib/train-rest/auth_handler/redfish.rb
 - lib/train-rest/connection.rb
+- lib/train-rest/errors.rb
 - lib/train-rest/transport.rb
 - lib/train-rest/version.rb
-- train-rest.gemspec
-homepage: https://github.com/sgre-chef/train-rest
+homepage: https://github.com/tecracer-chef/train-rest
 licenses:
 - Apache-2.0
 metadata: {}
@@ -148,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Train transport for REST

data/Gemfile

@@ -1,3 +0,0 @@
-source "https://rubygems.org"
-
-gemspec

data/README.md

@@ -1,280 +0,0 @@
-# train-rest - Train transport
-
-Provides a transport to communicate easily with RESTful APIs.
-
-## Requirements
-
-- Gem `rest-client` in Version 2.1
-
-## Installation
-
-You will have to build this gem yourself to install it as it is not yet on
-Rubygems.Org. For this there is a rake task which makes this a one-liner:
-
-```bash
-rake install:local
-```
-
-## Transport parameters
-
-| Option               | Explanation                             | Default     |
-| -------------------- | --------------------------------------- | ----------- |
-| `endpoint`           | Endpoint of the REST API                | _required_  |
-| `verify_ssl`         | Check certificate and chain             | true        |
-| `auth_type`          | Authentication type                     | `anonymous` |
-| `debug_rest`         | Enable debugging of HTTP traffic        | false       |
-| `logger`             | Alternative logging class               |             |
-
-## Authenticators
-
-### Anonymous
-
-Identifier: `auth_type: :anonymous`
-
-No actions for authentication, logging in/out or session handing are made. This
-assumes a public API.
-
-### Authtype Apikey
-
-This will inject a HTTP header `Authorization: Apikey xxxx` with the passed
-API key into requests.
-
-Identifier: `auth_type: :authtype_apikey`
-
-| Option               | Explanation                             | Default     |
-| -------------------- | --------------------------------------- | ----------- |
-| `apikey`             | API Key for authentication              | _required_  |
-
-### Basic (RFC 2617)
-
-Identifier: `auth_type: :basic`
-
-| Option               | Explanation                             | Default     |
-| -------------------- | --------------------------------------- | ----------- |
-| `username`           | Username for `basic` authentication     | _required_  |
-| `password`           | Password for `basic` authentication     | _required_  |
-
-If you supply a `username` and a `password`, authentication will automatically
-switch to `basic`.
-
-### Bearer (RFC 7650)
-
-This will inject a HTTP header `Authorization: Bearer xxxx` with the passed
-token into requests.
-
-Identifier: `auth_type: :bearer`
-
-| Option               | Explanation                             | Default     |
-| -------------------- | --------------------------------------- | ----------- |
-| `token`              | Tokenb to pass                          | _required_  |
-
-### Header-based
-
-This will inject an additional HTTP header with the passed value. If no name
-for the header is passed, it will default to `X-API-Key`.
-
-Identifier: `auth_type: :header`
-
-| Option               | Explanation                             | Default     |
-| -------------------- | --------------------------------------- | ----------- |
-| `apikey`             | API Key for authentication              | _required_  |
-| `header`             | Name of the HTTP header to include      | `X-API-Key` |
-
-### Redfish
-
-Identifier: `auth_type: :redfish`
-
-| Option               | Explanation                             | Default     |
-| -------------------- | --------------------------------------- | ----------- |
-| `username`           | Username for `redfish` authentication   | _required_  |
-| `password`           | Password for `redfish` authentication   | _required_  |
-
-For access to integrated management controllers on standardized server hardware.
-The Redfish standard is defined in <http://www.dmtf.org/standards/redfish> and
-this handler does initial login, reuses the received session and logs out when
-closing the transport cleanly.
-
-Known vendors which implement RedFish based management for their systems include
-HPE, Dell, IBM, SuperMicro, Lenovo, Huawei and others.
-
-## Debugging and use in Chef
-
-You can activate debugging by setting the `debug_rest` flag to `true'. Please
-note, that this will also log any confidential parts of HTTP traffic as well.
-
-For better integration into Chef custom resources, all REST debug output will
-be printed on `info` level. This allows debugging Chef resources without
-crawling through all other debug output:
-
-```ruby
-train  = Train.create('rest', {
-            endpoint:   'https://api.example.com/v1/',
-            debug_rest: true,
-            logger:     Chef::Log
-         })
-```
-
-## Request Methods
-
-This transport does not implement the `run_command` method, as there is no
-line-based protocol to execute commands against. Instead, it implements its own
-custom methods which suit REST interfaces. Trying to call this method will
-throw an Exception.
-
-### Generic Request
-
-The `request` methods allows to send free-form requests against any defined or
-custom methods.
-
-`request(path, method = :get, request_parameters: {}, data: nil, headers: {},
-json_processing: true)`
-
-- `path`: The path to request, which will be appended to the `endpoint`
-- `method`: The HTTP method in Ruby Symbol syntax
-- `request_parameters`: A hash of parameters to the `rest-client` request
-  method for additional settings
-- `data`: Data for actions like `:post` or `:put`. Not all methods accept
-  a data body.
-- `headers`: Additional headers for the request
-- `json_processing`: If the response is a JSON and you want to receive a
-  processed Hash/Array instead of text
-
-For `request_parameters` and `headers`, there is data mixed in to add
-authenticator responses, JSON processing etc. Please check the
-implementation in `connection.rb` for details.
-
-### Convenience Methods
-
-Simplified wrappers are generated for the most common request types:
-
-- `delete(path, request_parameters: {}, headers: {}, json_processing: true)`
-- `head(path, request_parameters: {}, headers: {}, json_processing: true)`
-- `get(path, request_parameters: {}, headers: {}, json_processing: true)`
-- `post(path, request_parameters: {}, data: nil, headers: {}, json_processing: true)`
-- `put(path, request_parameters: {}, data: nil, headers: {}, json_processing: true)`
-- `patch(path, request_parameters: {}, data: nil, headers: {}, json_processing: true)`
-
-## Example use
-
-```ruby
-require 'train-rest'
-
-train  = Train.create('rest', {
-            endpoint: 'https://api.example.com/v1/',
-
-            logger:   Logger.new($stdout, level: :info)
-         })
-conn   = train.connection
-
-# Get some hypothetical data
-data   = conn.get('device/1/settings')
-
-# Modify + Patch
-data['disabled'] = false
-conn.patch('device/1/settings', data)
-
-conn.close
-```
-
-Example for basic authentication:
-
-```ruby
-require 'train-rest'
-
-# This will immediately do a login and add headers
-train  = Train.create('rest', {
-            endpoint: 'https://api.example.com/v1/',
-
-            auth_type: :basic,
-            username: 'admin',
-            password: '*********'
-         })
-conn   = train.connection
-
-# ... do work, each request will resend Basic authentication headers ...
-
-conn.close
-```
-
-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://10.20.30.40',
-            verify_ssl: false,
-
-            auth_type: :redfish,
-            username: 'iloadmin',
-            password: '*********'
-         })
-conn   = train.connection
-
-# ... do work ...
-
-# Handles logout as well
-conn.close
-```
-
-## Use with Redfish, Your Custom Resources and Chef Target Mode
-
-1. Set up a credentials file under `~/.chef/credentials` or `/etc/chef/credentials`:
-
-   ```toml
-   ['10.0.0.1']
-   endpoint = 'https://10.0.0.1/redfish/v1/'
-   username = 'user'
-   password = 'pass'
-   verify_ssl = false
-   auth_type = 'redfish'
-   ```
-
-1. Configure Chef to use the REST transport in `client.rb`:
-
-   ```toml
-   target_mode.protocol = "rest"
-   ```
-
-1. Write your custom resources for REST APIs
-1. Mark them up using the REST methods for target mode:
-
-   ```ruby
-   provides :rest_resource, target_mode: true, platform: 'rest'
-   ```
-
-1. Run against the defiend targets via Chef Target Mode:
-
-   ```shell
-   chef-client --local-mode --target 10.0.0.1 --runlist 'recipe[my-cookbook::setup]'
-   ```
-
-## Use with Prerecorded API responses
-
-For testing during and after development, not all APIs can be used to verify your solution against.
-The VCR gem offers the possibility to hook into web requests and intercept them to play back canned
-responses.
-
-Please read the documentation of the VCR gem on how to record your API and the concepts like
-"cassettes", "libraries" and matchers.
-
-The following options are available in train-rest for this:
-
-| Option               | Explanation                             | Default      |
-| -------------------- | --------------------------------------- | ------------ |
-| `vcr_cassette`       | Name of the response file               | nil          |
-| `vcr_library`        | Directory to search responses in        | `vcr`        |
-| `vcr_match_on`       | Elements to match request by            | `method uri` |
-| `vcr_record`         | Recording mode                          | `none`       |
-| `vcr_hook_into`      | Base library for intercepting           | `webmock`    |
-
-VCR will only be required as a Gem and activated, if you supply a cassette name.
-
-You can use all these settings in your Chef Target Mode `credentials` file as well.

data/train-rest.gemspec

@@ -1,30 +0,0 @@
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "train-rest/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "train-rest"
-  spec.version       = TrainPlugins::Rest::VERSION
-  spec.authors       = ["Thomas Heinen"]
-  spec.email         = ["theinen@tecracer.de"]
-  spec.summary       = "Train transport for REST"
-  spec.description   = "Provides a transport to communicate easily with RESTful APIs."
-  spec.homepage      = "https://github.com/sgre-chef/train-rest"
-  spec.license       = "Apache-2.0"
-
-  spec.files = %w{
-    README.md train-rest.gemspec Gemfile
-  } + Dir.glob(
-    "lib/**/*", File::FNM_DOTMATCH
-  ).reject { |f| File.directory?(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "train", "~> 3.0"
-  spec.add_dependency "rest-client", "~> 2.1"
-
-  spec.add_development_dependency "bump", "~> 0.9"
-  spec.add_development_dependency "chefstyle", "~> 0.14"
-  spec.add_development_dependency "guard", "~> 2.16"
-  spec.add_development_dependency "mdl", "~> 0.9"
-  spec.add_development_dependency "rake", "~> 13.0"
-end