train-habitat 0.1.1 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b8186bbf0eb9865517415f2f9270625140b5881b
-  data.tar.gz: f9680ef5db5b308a52c27efb2c4baa054de253db
+SHA256:
+  metadata.gz: 7b3bd86a77252c25b4cd62467713a3b2565c06c473e9d2ff1561f20c9f6f3fa9
+  data.tar.gz: b39c257fa768518b4df7db0f4f071da46889664aa1807c2bf57ae03ab4b3b25f
 SHA512:
-  metadata.gz: 49a883505104ab0e9c69356e9bbea5ab46663a11c4fb9be12ba599172e506c7c5ea7c8708639a0f58cb46fc3079e17c71abe6843cb5a257a721b3410fc9b265d
-  data.tar.gz: ac1de8ee00ae2ba8c5bdd087784f699b084d6c87f31047ae822e9fe683a3a76ef16ec70f29f9d539773e0903ea11fd845fe8ef745832e4b146a1a59dff7f1055
+  metadata.gz: 24654c94a9b4fcf75b0a55c58918d941fed7853eab8f45fd8388b484d2835e0f0476a2d0135202ccbd48bbe8c5c4c12b1debeb51bd1110b49e25cd3856997aff
+  data.tar.gz: 2a39149145e5bebb7d7899f2d3e1e69ac03bf4cda7a28f0d772ec046665b63d75a6793fed30896883d9fe9f1b6d1d3b9be541e072d3c030e9114fec7ccae9b00

data/Gemfile

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
 group :development do
-  gem 'byebug', '~> 11.0'
-  gem 'm', '~> 1.5'
-  gem 'minitest', '~> 5.11'
-  gem 'mocha', '~> 1.8'
-  gem 'pry', '~> 0.11'
-  gem 'rake', '~> 12.3'
-  gem 'rubocop', '~> 0.59'
+  gem "byebug", "~> 11.0"
+  gem "m", "~> 1.5"
+  gem "minitest", "~> 5.11"
+  gem "mocha", "~> 1.8"
+  gem "pry", "~> 0.11"
+  gem "rake", "~> 12.3"
+  gem "rubocop", "~> 0.59"
+  gem "chefstyle", "0.13.2"
 end

data/README.md

@@ -1,16 +1,16 @@
 # Train-Habitat
 
-`train-habitat` is a Train plugin and is used as a Train Transport to connect to Habitat installations.
+* **Project State: Active**
+* **Issues Response SLA: 3 business days**
+* **Pull Request Response SLA: 3 business days**
 
-## To Install this as a User
+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).
 
-You will need InSpec v2.3 or later.
+`train-habitat` is a Train plugin and is used as a Train Transport to connect to Habitat installations.
 
-Simply run:
+## To Install this as a User
 
-```
-$ inspec plugin install train-habitat
-```
+`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
 

data/lib/train-habitat/connection.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'net/http'
-require 'json'
-require 'train-habitat/httpgateway'
-require 'train-habitat/platform'
-require 'train-habitat/transport'
+require "net/http"
+require "json"
+require "train-habitat/httpgateway"
+require "train-habitat/platform"
+require "train-habitat/transport"
 
 module TrainPlugins
   module Habitat
@@ -27,7 +27,7 @@ module TrainPlugins
       end
 
       def api_options_provided?
-        have_transport_options_with_prefix?('api')
+        have_transport_options_with_prefix?("api")
       end
 
       def cli_options_provided?
@@ -41,11 +41,18 @@ module TrainPlugins
         raise CliNotAvailableError(cli_tranport_names) unless cli_options_provided?
 
         # TODO: - leverage exec_options to add things like JSON parsing, ENV setting, etc.
-        cli_connection.run_command(hab_path + ' ' + command)
+        cli_connection.run_command(hab_path + " " + command)
+      end
+
+      # See #run_command in BaseConnection.
+      def run_command_via_connection(*args)
+        raise CliNotAvailableError(cli_tranport_names) unless cli_options_provided?
+
+        cli_connection.run_command(*args)
       end
 
       def hab_path
-        '/bin/hab'
+        "/bin/hab"
       end
 
       def habitat_api_client
@@ -53,9 +60,9 @@ module TrainPlugins
           # Send all options beginning with api_ to the HTTPGateway, stripping the prefix
           api_options = {}
           transport_options.each do |option_name, option_value|
-            next unless option_name.to_s.start_with? 'api_'
+            next unless option_name.to_s.start_with? "api_"
 
-            api_options[option_name.to_s.sub(/^api_/, '').to_sym] = option_value
+            api_options[option_name.to_s.sub(/^api_/, "").to_sym] = option_value
           end
           HTTPGateway.new(api_options)
         end
@@ -69,14 +76,14 @@ module TrainPlugins
         end
 
         valid_cli_prefixes = TrainPlugins::Habitat::Transport.cli_transport_prefixes.keys.map(&:to_s)
-        seen_cli_options = transport_options.keys.map(&:to_s).select { |n| n.start_with?('cli_') }
+        seen_cli_options = transport_options.keys.map(&:to_s).select { |n| n.start_with?("cli_") }
 
         # All seen CLI options must start with a recognized prefix
         options_by_prefix = {}
         seen_cli_options.each do |option|
           prefix = valid_cli_prefixes.detect { |p| option.start_with?(p) }
           unless prefix
-            raise Train::TransportError, "All Habitat CLI connection options must begin with a recognized prefix (#{valid_cli_prefixes.join(', ')}) - saw #{option}"
+            raise Train::TransportError, "All Habitat CLI connection options must begin with a recognized prefix (#{valid_cli_prefixes.join(", ")}) - saw #{option}"
           end
 
           options_by_prefix[prefix] ||= []
@@ -85,7 +92,7 @@ module TrainPlugins
 
         # Only one prefix may be used (don't mix and match)
         if options_by_prefix.count > 1
-          raise Train::TransportError, "Only one set of Habitat CLI connection options may be used - saw #{options_by_prefix.keys.join(', ')}"
+          raise Train::TransportError, "Only one set of Habitat CLI connection options may be used - saw #{options_by_prefix.keys.join(", ")}"
         end
       end
 
@@ -110,7 +117,7 @@ module TrainPlugins
         seen_cli_transports = {}
         non_specific_options = {} # Things like :logger, :sudo, etc
         transport_options.each do |xport_option_name, xport_option_value|
-          unless xport_option_name.to_s.start_with?('cli_')
+          unless xport_option_name.to_s.start_with?("cli_")
             non_specific_options[xport_option_name] = xport_option_value
             next
           end
@@ -121,7 +128,7 @@ module TrainPlugins
 
             seen_cli_transports[xport_name] ||= {}
             # Remove the prefix from the option and store under transport name
-            seen_cli_transports[xport_name][xport_option_name.to_s.sub(/^#{prefix}_/, '').to_sym] = xport_option_value
+            seen_cli_transports[xport_name][xport_option_name.to_s.sub(/^#{prefix}_/, "").to_sym] = xport_option_value
           end
         end
 

data/lib/train-habitat/httpgateway.rb

@@ -1,5 +1,5 @@
-require 'uri'
-require 'net/http'
+require "uri"
+require "net/http"
 
 module TrainPlugins
   module Habitat
@@ -23,7 +23,7 @@ module TrainPlugins
         uri.path = path
         headers = {}
         unless auth_token.nil?
-          headers['Authorization'] = 'Bearer ' + auth_token # Set bearer token, see https://www.habitat.sh/docs/using-habitat/#authentication
+          headers["Authorization"] = "Bearer " + auth_token # Set bearer token, see https://www.habitat.sh/docs/using-habitat/#authentication
         end
 
         conn = Net::HTTP.start(uri.host, uri.port)

data/lib/train-habitat/illegal_state_error.rb

@@ -20,12 +20,12 @@ end
 
 class CliNotAvailableError < IllegalStateError
   def initialize(_cli_tranport_names)
-    super("No CLI-capable connection options passed - use one of #{cli_transport_names.join(', ')} option sets")
+    super("No CLI-capable connection options passed - use one of #{cli_transport_names.join(", ")} option sets")
   end
 end
 
 class MultipleCliTransportsError < IllegalStateError
   def initialize(_cli_tranport_names)
-    super("Too many CLI-capable transports specified - only one may be used at a time.  Saw: #{cli_transport_names.join(', ')}.")
+    super("Too many CLI-capable transports specified - only one may be used at a time.  Saw: #{cli_transport_names.join(", ")}.")
   end
 end

data/lib/train-habitat/platform.rb

@@ -4,8 +4,8 @@ module TrainPlugins
   module Habitat
     module Platform
       def platform
-        Train::Platforms.name('habitat').in_family('api')
-        force_platform!('habitat', release: TrainPlugins::Habitat::VERSION)
+        Train::Platforms.name("habitat").in_family("api")
+        force_platform!("habitat", release: TrainPlugins::Habitat::VERSION)
       end
     end
   end

data/lib/train-habitat/transport.rb

@@ -1,11 +1,11 @@
-require 'train'
-require 'train/plugins'
-require 'train-habitat/connection'
+require "train"
+require "train/plugins"
+require "train-habitat/connection"
 
 module TrainPlugins
   module Habitat
     class Transport < Train.plugin(1)
-      name 'habitat'
+      name "habitat"
 
       # The train-habitat plugins is a chimeric plugin, meaning it uses
       # multiple ways of connecting to its target. A user must specifiy
@@ -14,8 +14,8 @@ module TrainPlugins
 
       # For service listings and health, specify supervisor api options.
       # https://www.habitat.sh/docs/using-habitat/#monitor-services-through-the-http-api
-      option :api_url, required: false, desc: 'The url at which a Habitat Supervisor exposes its HTTP Gateway API'
-      option :api_auth_token, required: false, desc: 'A bearer token which may be used to authenticate to the Supervisor HTTP Gateway'
+      option :api_url, required: false, desc: "The url at which a Habitat Supervisor exposes its HTTP Gateway API"
+      option :api_auth_token, required: false, desc: "A bearer token which may be used to authenticate to the Supervisor HTTP Gateway"
 
       def self.cli_transport_prefixes
         {

data/lib/train-habitat/version.rb

@@ -2,6 +2,6 @@
 
 module TrainPlugins
   module Habitat
-    VERSION = '0.1.1'
+    VERSION = "0.2.7"
   end
 end

data/lib/train-habitat.rb

@@ -3,7 +3,7 @@
 libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
-require 'train-habitat/version'
-require 'train-habitat/transport'
-require 'train-habitat/platform'
-require 'train-habitat/connection'
+require "train-habitat/version"
+require "train-habitat/transport"
+require "train-habitat/platform"
+require "train-habitat/connection"

data/train-habitat.gemspec

@@ -1,29 +1,29 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'train-habitat/version'
+require "train-habitat/version"
 
 Gem::Specification.new do |spec|
-  spec.name        = 'train-habitat'
+  spec.name        = "train-habitat"
   spec.version     = TrainPlugins::Habitat::VERSION
-  spec.authors     = ['Chef InSpec Team']
-  spec.email       = ['inspec@chef.io']
-  spec.summary     = 'Habitat API Transport for Train'
-  spec.description = 'Allows applications using Train to speak to Habitat.'
-  spec.homepage    = 'https://github.com/inspec/train-habitat'
-  spec.license     = 'Apache-2.0'
+  spec.authors     = ["Chef InSpec Team"]
+  spec.email       = ["inspec@chef.io"]
+  spec.summary     = "Habitat API Transport for Train"
+  spec.description = "Allows applications using Train to speak to Habitat."
+  spec.homepage    = "https://github.com/inspec/train-habitat"
+  spec.license     = "Apache-2.0"
 
   spec.files = %w{
     README.md train-habitat.gemspec Gemfile
   } + Dir.glob(
-    'lib/**/*', File::FNM_DOTMATCH
+    "lib/**/*", File::FNM_DOTMATCH
   ).reject { |f| File.directory?(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
   # All plugins should mention train, > 1.4
-  spec.add_dependency 'train', '>= 1.7.5', '< 3.0'
+  spec.add_dependency "train", ">= 1.7.5", "< 3.0"
 
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-habitat
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.7
 platform: ruby
 authors:
 - Chef InSpec Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-28 00:00:00.000000000 Z
+date: 2019-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: train
@@ -94,8 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Habitat API Transport for Train