train-rest 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1550899c2f8aad404793b83b1f7700ece96937efc8b78cb1eb7aebb8d6d2a2a2
-  data.tar.gz: b9251734100cc43233504afbe6e8d6fbd11bec1b07a16db7884720e907a164e2
+  metadata.gz: a003dbd0ea47ee7eb23e2173036951f9104493a761a7e1d8d9e1798ce933ddc3
+  data.tar.gz: ee585ad7ed98f701e20fe3d48384260073df3f69eb102faa05d79eb118a63f95
 SHA512:
-  metadata.gz: 1630381a0f378a7a4a275202fc19a60f71579b99f6b1ae50229c72b67cce2466e5d8b2f4a5b5c3c23f8c1c5c4ccc4817f768fc36cd65c3c8ac9c1b81609b1994
-  data.tar.gz: 02ed2d874ac736d016fc75f24a1c02e8b9209ec5f43cbb9281bf615106a04d53f4d49d26682e84cb7c2b7ab6a949dc2589823a769e9b87aa3c03aa428c50d919
+  metadata.gz: 6440c9ff603fe5af0042cd925c4c3729552fb65cc8a41162e4991e9301149ba3795bbf5fffcff87990d52f784331839ff70f99b20d9fceb230785d4e9cc1ba38
+  data.tar.gz: e92001e986dce6ead7361cb6b3e55213a1c17ba517a62ed99ce9b0275dc689857cec05e05d9b58a6039e1971c3ec7773a9622bb271d4d8f5c495d4bb1c6f6306

data/lib/train-rest/version.rb

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

data/train-rest.gemspec

@@ -9,21 +9,21 @@ Gem::Specification.new do |spec|
   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.homepage      = "https://github.com/tecracer-chef/train-rest"
   spec.license       = "Apache-2.0"
 
   spec.files = %w{
-    README.md train-rest.gemspec Gemfile
+    train-rest.gemspec
   } + Dir.glob(
     "lib/**/*", File::FNM_DOTMATCH
   ).reject { |f| File.directory?(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "train", "~> 3.0"
+  spec.add_dependency "train-core", "~> 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 "chefstyle", "~> 2.2"
   spec.add_development_dependency "guard", "~> 2.16"
   spec.add_development_dependency "mdl", "~> 0.9"
   spec.add_development_dependency "rake", "~> 13.0"

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: train-rest
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Thomas Heinen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2022-02-24 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,8 +115,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
-- README.md
 - lib/train-rest.rb
 - lib/train-rest/auth_handler.rb
 - lib/train-rest/auth_handler/anonymous.rb
@@ -129,7 +127,7 @@ files:
 - 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 +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,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.