train-rest 0.3.2 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45c7cbd2b28a41c2eba5d219545d4ff7e0bfbaf6305f239630352ce463bf8424
-  data.tar.gz: 6e5de06f898f95a2a2c519ac45bae42c797e39840e2aec0c80bb6204d5e69591
+  metadata.gz: bdaed9296e5756a522d6fbaf9fd8d5aca6ed8f2e74250387a97f65fbf58c51b2
+  data.tar.gz: 0bd7dd4791ea737ff122343445bb58a974c0e01e03431a31ab57616e548805aa
 SHA512:
-  metadata.gz: 48c46e55522807433595d89e5bf414a3d487c9167b7f8fd365a8a64645789fd533fc614a835b319f8d8e6590d907b01c1fbf864ea80fc735d333d2961c065ddf
-  data.tar.gz: 9e24f8c14aa8000541aade240e46d0aaaac67a70a337672f821f9760336da98f482af80337e963ef64c218637f4ed36b059744c8dcc1a2d21cd08d73b5e5154d
+  metadata.gz: dc8d624d5b44cf12e3fb1810cc0f3e84acd53230e503a4a46dee3d04335aef445d21178959b35a712e3b9d2e98eb6328eb45c6e8dc55684cecd1322f3a8be128
+  data.tar.gz: cd8d93fc0e5b0926ce86c6d1ab826f0a84c1996b0c15586e46cd7d78096e851127a4f82fac49998a34e57e3b04d626ef274b5870c771eb824450cf8179b7d2ce

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/authtype-apikey.rb

@@ -0,0 +1,24 @@
+require "base64" unless defined?(Base64)
+
+require_relative "../auth_handler"
+
+module TrainPlugins
+  module Rest
+    # Authentication via "Apikey" type in Authorization headers.
+    #
+    # Could not find a norm for this, just references in e.g. ElasticSearch & Cloud Conformity APIs.
+    class AuthtypeApikey < AuthHandler
+      def check_options
+        raise ArgumentError.new("Need :apikey for `Authorization: Apikey` authentication") unless options[:apikey]
+      end
+
+      def auth_parameters
+        {
+          headers: {
+            "Authorization" => format("Apikey %s", options[:apikey]),
+          },
+        }
+      end
+    end
+  end
+end

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

@@ -4,11 +4,13 @@ require_relative "../auth_handler"
 
 module TrainPlugins
   module Rest
-    # Authentication via HTTP Basic Authentication
+    # Authentication via Basic Authentication.
+    #
+    # @see https://www.rfc-editor.org/rfc/rfc2617#section-4.1
     class Basic < AuthHandler
       def check_options
-        raise ArgumentError.new("Need username for Basic authentication") unless options[:username]
-        raise ArgumentError.new("Need password for Basic authentication") unless options[:password]
+        raise ArgumentError.new("Need :username for Basic authentication") unless options[:username]
+        raise ArgumentError.new("Need :password for Basic authentication") unless options[:password]
       end
 
       def auth_parameters

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

@@ -0,0 +1,24 @@
+require "base64" unless defined?(Base64)
+
+require_relative "../auth_handler"
+
+module TrainPlugins
+  module Rest
+    # Authentication via Bearer Authentication.
+    #
+    # @see https://datatracker.ietf.org/doc/html/rfc6750#section-2.1
+    class Bearer < AuthHandler
+      def check_options
+        raise ArgumentError.new("Need :token for Bearer authentication") unless options[:token]
+      end
+
+      def auth_parameters
+        {
+          headers: {
+            "Authorization" => format("Bearer %s", options[:token]),
+          },
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require_relative "../auth_handler"
+
+module TrainPlugins
+  module Rest
+    # Authentication via additional Header.
+    #
+    # Header name defaults to "X-API-Key"
+    class Header < AuthHandler
+      def check_options
+        raise ArgumentError.new("Need :apikey for Header-based authentication") unless options[:apikey]
+
+        options[:header] = "X-API-Key" unless options[:header]
+      end
+
+      def auth_parameters
+        {
+          headers: {
+            options[:header] => options[:apikey],
+          },
+        }
+      end
+    end
+  end
+end

data/lib/train-rest/auth_handler.rb

@@ -13,7 +13,16 @@ module TrainPlugins
       #
       # @return [String]
       def self.name
-        self.to_s.split("::").last.downcase
+        class_name = self.to_s.split("::").last
+
+        convert_to_snake_case(class_name)
+      end
+
+      # List authentication handlers
+      #
+      # @return [Array] Classes derived from `AuthHandler`
+      def self.descendants
+        ObjectSpace.each_object(Class).select { |klass| klass < self }
       end
 
       # Store authenticator options and trigger validation
@@ -29,10 +38,18 @@ module TrainPlugins
       # @raise [ArgumentError] if options are not as needed
       def check_options; end
 
-      # Handle Login
+      # Handle login
       def login; end
 
-      # Handle Logout
+      # Handle session renewal
+      def renew_session; end
+
+      # Return if session renewal needs to happen soon
+      #
+      # @return [Boolean]
+      def renewal_needed?; end
+
+      # Handle logout
       def logout; end
 
       # Headers added to the rest-client call
@@ -50,11 +67,21 @@ module TrainPlugins
         { headers: auth_headers }
       end
 
-      # List authentication handlers
-      #
-      # @return [Array] Classes derived from `AuthHandler`
-      def self.descendants
-        ObjectSpace.each_object(Class).select { |klass| klass < self }
+      class << self
+        private
+
+        # Convert a class name to snake case.
+        #
+        # @param [String] Class name
+        # @return [String]
+        # @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.downcase!
+          str.sub!(/^\_/, "")
+          str
+        end
       end
     end
   end

data/lib/train-rest/connection.rb

@@ -86,6 +86,9 @@ module TrainPlugins
 
       # User-faced API
 
+      # Allow (programmatically) setting additional headers apart from global transport configuration
+      attr_accessor :override_headers
+
       %i{get post put patch delete head}.each do |method|
         define_method(method) do |path, **keywords|
           request(path, method, **keywords)
@@ -93,6 +96,8 @@ module TrainPlugins
       end
 
       def request(path, method = :get, request_parameters: {}, data: nil, headers: {}, json_processing: true)
+        auth_handler.renew_session if auth_handler.renewal_needed?
+
         parameters = global_parameters.merge(request_parameters)
 
         parameters[:method] = method
@@ -106,7 +111,9 @@ module TrainPlugins
           parameters[:payload] = data
         end
 
-        parameters[:headers].merge! headers
+        # Merge override headers + request specific headers
+        parameters[:headers].merge!(override_headers || {})
+        parameters[:headers].merge!(headers)
         parameters.compact!
 
         logger.info format("[REST] => %s", parameters.to_s) if options[:debug_rest]
@@ -116,6 +123,27 @@ module TrainPlugins
         transform_response(response, json_processing)
       end
 
+      # Allow switching generic handlers for an API-specific one.
+      #
+      # New handler needs to be loaded prior and be derived from TrainPlugins::REST::AuthHandler.
+      def switch_auth_handler(new_handler)
+        return if active_auth_handler == new_handler
+
+        logout
+
+        options[:auth_type] = new_handler.to_sym
+        @auth_handler = nil
+
+        login
+      end
+
+      # Return active auth handler.
+      #
+      # @return [Symbol]
+      def active_auth_handler
+        options[:auth_type]
+      end
+
       # Auth Handlers-faced API
 
       def auth_parameters

data/lib/train-rest/version.rb

@@ -1,5 +1,5 @@
 module TrainPlugins
   module Rest
-    VERSION = "0.3.2".freeze
+    VERSION = "0.4.2".freeze
   end
 end

data/lib/train-rest.rb

@@ -7,5 +7,8 @@ require "train-rest/transport"
 require "train-rest/connection"
 
 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/redfish"

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: train-rest
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.2
 platform: ruby
 authors:
 - Thomas Heinen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-08 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: train
+  name: train-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -58,14 +58,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,18 +115,19 @@ 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/basic.rb
+- lib/train-rest/auth_handler/bearer.rb
+- lib/train-rest/auth_handler/header.rb
 - lib/train-rest/auth_handler/redfish.rb
 - lib/train-rest/connection.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: {}
@@ -145,7 +146,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,246 +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.
-
-### Basic Authentication
-
-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`.
-
-### 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