train-habitat 0.2.11 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b62d8190669df3c5ff6fcb21c79ef3bb90929d3d11ded797f0ae4f7402b1f4d8
-  data.tar.gz: faa07f88d8f64de08590624ad0718c7dac2985794fc1b2634332b8333fdb9063
+  metadata.gz: 2913079dec63f9db3973d1e38ed65db5be4469da068111b2a59b0c40059851e5
+  data.tar.gz: 697ede6866c1228258de1a7af25a91798f65f0281f3c44590dc62d00995f8e8b
 SHA512:
-  metadata.gz: eea7715cb9a253986c14a8d462e420a029d0204ad6a1029c43ab989ed2793846c8a0feaa4dfe8a5776508c7bd15cad439919527b71a1a6decb4318ff15f249d5
-  data.tar.gz: b88a874b1e211d2f7615b192fd77459413553df7b254cedb7699ab460ef1ee3fc5fb977110eda02c956298f57996c135765404a15c9113d38734e8b974d4e03f
+  metadata.gz: aa03009352c842b7c4a1a31b18f016f01b58501ffbf8cbc9a7d18ce06206e8dd463e659a5fd958043ca707b059770f1c3b92747fbecfa8dc1c589fc2716a460c
+  data.tar.gz: 25bdf2939a18613da6d0b2f4522e10069bfddcb68a75173f48ca62ab029bc4745162c5f16cd4da3c05fe2fa152ccf5809b9ec525e067b88ba85e784456762578

data/lib/train-habitat/version.rb

@@ -2,6 +2,6 @@
 
 module TrainPlugins
   module Habitat
-    VERSION = "0.2.11"
+    VERSION = "0.2.12"
   end
 end

data/train-habitat.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.license     = "Apache-2.0"
 
   spec.files = %w{
-    README.md train-habitat.gemspec Gemfile
+    train-habitat.gemspec Gemfile
   } + Dir.glob(
     "lib/**/*", File::FNM_DOTMATCH
   ).reject { |f| File.directory?(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-habitat
 version: !ruby/object:Gem::Version
-  version: 0.2.11
+  version: 0.2.12
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2019-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -46,7 +46,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- README.md
 - lib/train-habitat.rb
 - lib/train-habitat/connection.rb
 - lib/train-habitat/httpgateway.rb

data/README.md

@@ -1,163 +0,0 @@
-# Train-Habitat
-
-* **Project State: Active**
-* **Issues Response SLA: 3 business days**
-* **Pull Request Response SLA: 3 business days**
-
-For more information on project states and SLAs, see [this documentation](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md).
-
-`train-habitat` is a Train plugin and is used as a Train Transport to connect to Habitat installations.
-
-## To Install this as a User
-
-`train-habitat` is included with InSpec 4.7.3 and later. There is no need to separately install this plugin.
-
-## Using train-habitat from InSpec
-
-As `train-habitat` takes potentially many options, it is simplest to list the options in your `~/.inspec/config.json` file, then used the named set of options with `-t`.
-
-For example, if your config file contains:
-
-```
-{
-  "file_version": "1.1",
-  "credentials": {
-    "habitat": {
-      "dev-hab": {
-        "api_url": "http://dev-hab.my-corp.io",
-        "cli_ssh_host": "dev-hab.my-corp.io"
-      },
-      "prod-hab": {
-        "api_url": "https://prod-hab.my-corp.io",
-        "api_auth_token": "opensesame"
-      },
-    }
-  }
-}
-```
-
-Using this configuration, you could execute:
-
-```
-$ inspec exec some-profile -t habitat://dev-hab
-# Or
-$ inspec exec some-profile -t habitat://prod-hab
-```
-
-You may also pass `--config some-file.json` to use a config file at a different location.
-
-See the next section for the full list of options you may use with a `habitat` credential set in your configuration.
-
-## Using train-habitat from Ruby
-
-The options that may be passed to `Train.create` are listed below.
-
-### Dual-mode transport
-
-Because Habitat exposes some facts by its HTTP Gateway API, and some facts by its CLI tool `hab`, this Train Transport has three modes of operation:
-
- * Using only the HTTP API (no ability to query packages, but rich ability to query rings)
- * Using only the `hab` CLI command (limitations TBD)
- * Using both (full capabilities)
-
-When creating a `train-habitat` Connection, there are thus two sets of options, prefixed with `api_` and `cli_` respectively. You must provide at least one set.
-
-### API-Mode options
-
-API-mode options are used to connect to a Habitat Supervisor running with an exposed HTTP Gateway. They are prefixed with `api_`.
-
-```ruby
-Train.create(:habitat, api_url: 'http://my-hab.my-company.io:9631')
-```
-
-#### api_url
-
-Required for API-mode use. This is an HTTP or HTTPS URL that identifies a Supervisor HTTP Gateway.  If the port is omitted from the URL, the API standard port of 9631 is assumed; to use port 80, specify it explicitly.
-
-#### api_auth_token
-
-The supervisor may be configured to require a [Bearer Token Authorization](https://www.habitat.sh/docs/using-habitat/#monitor-services-through-the-http-api), in which the client and the gateway use a pre-shared secret. Use this option to specify the secret.
-
-### CLI Mode options
-
-CLI options are more varied, and are entirely dependent on the underlying transport chosen to reach the CLI. For example, if there were a supported transport named 'radio' that took options 'channel' and 'band', specify them to train-habitat like this:
-
-```ruby
-Train.create(:habitat, {cli_radio_band: 'VHF', cli_radio_channel: 23})
-```
-
-`train-habitat` identifies the underlying "sub-transport" using the prefixes of the provided options. For example, if you pass an option named `cli_ssh_host`, `train-habitat` will recognize that you intend to use the SSH transport to connect to a location that has access to the `hab` CLI tool.
-
-You may specify many options referring to the same sub-transport (such as credentials), but it is an error to specify more than one CLI sub-transport.
-
-Currently supported CLI transports include:
- * SSH
-
-Plans for future support include (in approximate order):
- * WinRM
- * Local
- * Docker
-
-#### General Options
-
-Any options not prefixed with `cli_` or `api_` are also passed to the CLI transport. This means you can use generic Train connection options such as the `sudo` and `shell` sets of options (see [train source code](https://github.com/inspec/train/blob/71679307903fc8853e09abd93f3901c83800e019/lib/train/extras/command_wrapper.rb#L31)), as well as `logger`.
-
-#### SSH Options
-
-`train-habitat` can accept any option that the Train SSH Transport accepts if the prefix `cli_ssh_` is added. This includes:
-
- * `cli_ssh_host` - String hostname or IP address
- * `cli_ssh_user` - String user to connect as
- * `cli_ssh_key_files` - Array of paths to private key files to use
-
-Other options are available; see [train source code](https://github.com/inspec/train/blob/71679307903fc8853e09abd93f3901c83800e019/lib/train/transports/ssh.rb#L45) for details.
-
-## Development
-
-### Testing
-```
-# Install development tools
-$ gem install bundler
-$ bundle install
-
-# Running style checker
-bundle exec rake lint
-
-# Running unit tests
-bundle exec rake test:unit
-
-# Running integration tests (requires Vagrant and VirtualBox)
-bundle exec rake test:integration
-```
-
-## Contributing
-
-1. Fork it
-1. Create your feature branch (git checkout -b my-new-feature)
-1. Commit your changes (git commit -sam 'Add some feature')
-1. Push to the branch (git push origin my-new-feature)
-1. Create new Pull Request
-
-## License
-
-| **Author:**          | Paul Welch
-
-| **Author:**          | David McCown
-
-| **Author:**          | Clinton Wolfe
-
-| **Copyright:**       | Copyright (c) 2018-2019 Chef Software Inc.
-
-| **License:**         | Apache License, Version 2.0
-
-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.