train-aws 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d2eedb07a382f6f5d0cae903e265844b5a8023d4f707a6960aeba9e0957c430
-  data.tar.gz: 700b012c62061f357d18e51b57d2ac2abba6dbf4b3f27c3870d8a74144e7c108
+  metadata.gz: f12716bfe83d525bf3283209f86ff9d94dbf6bb236d008f4755d7da1e5826c1b
+  data.tar.gz: 36181b6c56d09e996efc4c22020a9c5559e60472152ddb101b898e71b72f84c4
 SHA512:
-  metadata.gz: 6128d376a815570d4317f866d220dac7722cbf90635f42622b9a3882cdd8259918e4a846d160dd0d7e3c232dfe42a7558e57bca3ab88fd012a2aeade8f443df4
-  data.tar.gz: 23a5577ad1573158eedfba73a3c65169dcfaf67ead3b036b02a9328ff0eb92fdc9271ca1a20c8e570d96d89738b1a9c4d972392699451304c22849941a09820d
+  metadata.gz: af8a97cbf3101d0800e20cfc5722f3841fb8fcd07823a52eb8d91ad56f6c2d94db3d46c9c4135ca13e311f632e3aacbd45d2b97f413544582e5c70c83e45d333
+  data.tar.gz: c2697ec2c1f4ac129f80acac20c1a37d6a7bc5612796724f44efd1b209c25be9a4d9e7f9825c9b93142d87ab4a24dc4a9c6393b8b8fc7486fcfd73b2e9443ce4

data/lib/train-aws/version.rb

@@ -5,6 +5,6 @@
 
 module TrainPlugins
   module Aws
-    VERSION = "0.1.11".freeze
+    VERSION = "0.1.12".freeze
   end
 end

data/train-aws.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Chef InSpec Team"]
   spec.email         = ["inspec@chef.io"]
   spec.summary       = "AWS API Transport for Train"
-  spec.description   = "Allows applictaions using Train to speak to AWS; handles authentication, cacheing, and SDK dependency management."
+  spec.description   = "Allows applications using Train to speak to AWS; handles authentication, cacheing, and SDK dependency management."
   spec.homepage      = "https://github.com/inspec/train-aws"
   spec.license       = "Apache-2.0"
 
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   # It just filters what will actually be packaged in the gem (leaving
   # out tests, etc)
   spec.files = %w{
-    README.md train-aws.gemspec Gemfile
+    train-aws.gemspec Gemfile
   } + Dir.glob(
     "lib/**/*", File::FNM_DOTMATCH
   ).reject { |f| File.directory?(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: train-aws
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.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: aws-sdk-apigateway
@@ -654,7 +654,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
-description: Allows applictaions using Train to speak to AWS; handles authentication,
+description: Allows applications using Train to speak to AWS; handles authentication,
   cacheing, and SDK dependency management.
 email:
 - inspec@chef.io
@@ -663,7 +663,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- README.md
 - lib/train-aws.rb
 - lib/train-aws/connection.rb
 - lib/train-aws/platform.rb

data/README.md

@@ -1,109 +0,0 @@
-# train-aws - Train Plugin for connecting to AWS
-
-* **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).
-
-This plugin allows applications that rely on Train to communicate with the Amazon Web Services API.  For example, InSpec uses this to perform compliance checks against AWS infrastructure components.
-
-The plugin is a wrapper around `aws-sdk-core` version 3, with additional service-specific gems added where needed by the `inspec-aws` resource pack.
-
-Train itself has no CLI, nor a sophisticated test harness.  InSpec does have such facilities, so installing Train plugins will require an InSpec installation.  You do not need to use or understand InSpec.
-
-Train plugins may be developed without an InSpec installation.
-
-## To Install this as a User
-
-Train plugins are distributed as gems.  You may choose to manage the gem yourself, but if you are an InSpec user, InSPec can handle it for you.
-
-You will need InSpec v2.3 or later.
-
-Simply run:
-
-```
-$ inspec plugin install train-aws
-```
-
-You can then run:
-
-```
-$ inspec detect -t aws://
-== Platform Details
-
-Name:      aws
-Families:  cloud, api
-Release:   train-aws: v0.1.0, aws-sdk-core: 3.30.0
-Arch:      -
-```
-
-## Authenticating to AWS
-
-These instructions assume you are using InSpec.
-
-### Setting up AWS credentials for InSpec
-
-InSpec uses the standard AWS authentication mechanisms. Typically, you will create an IAM user specifically for auditing activities.
-
-* 1 Create an IAM user in the AWS console, with your choice of username. Check the box marked "Programmatic Access."
-* 2 On the Permissions screen, choose Direct Attach. Select the AWS-managed IAM Profile named "ReadOnlyAccess." If you wish to restrict the user further, you may do so; see individual InSpec resources to identify which permissions are required.
-* 3 After generating the key, record the Access Key ID and Secret Key.
-
-#### Using Environment Variables to provide credentials
-
-You may provide the credentials to InSpec by setting the following environment variables: `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_KEY_ID`. You may also use `AWS_PROFILE`, or if you are using MFA, `AWS_SESSION_TOKEN`. See the [AWS Command Line Interface Docs](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) for details.
-
-Once you have your environment variables set, you can verify your credentials by running:
-
-```bash
-you$ inspec detect -t aws://
-
-== Platform Details
-Name:      aws
-Families:  cloud, api
-Release:   aws-sdk-v2.10.125
-```
-
-#### Using the InSpec target option to provide credentials on AWS
-
-Look for a file in your home directory named `~/.aws/credentials`. If it does not exist, create it. Choose a name for your profile; here, we're using the name 'auditing'. Add your credentials as a new profile, in INI format:
-
-```bash
-[auditing]
-aws_access_key_id = AKIA....
-aws_secret_access_key = 1234....abcd
-```
-
-You may now run InSpec using the `--target` / `-t` option, using the format `-t aws://region/profile`.  For example, to connect to the Ohio region using a profile named 'auditing', use `-t aws://us-east-2/auditing`.  Any omitted portion will use teh environment variables.
-
-To verify your credentials,
-
-```bash
-you$ inspec detect -t aws://
-
-== Platform Details
-Name:      aws
-Families:  cloud, api
-Release:   aws-sdk-v2.10.125
-```
-
-## Reporting Issues
-
-Bugs, typos, limitations, and frustrations are welcome to be reported through the [GitHub issues page for the train-aws project](https://github.com/inspec/train-aws/issues).
-
-You may also ask questions in the #inspec channel of the CHef Community Slack team.  However, for an issue to get traction, please report it as a github issue.
-
-## Development on this Plugin
-
-### Development Process
-
-If you wish to contribute to this plugin, please use the usual fork-branch-push-PR cycle.  All functional changes need new tests, and bugfixes are expected to include a new test that demonstrates the bug.
-
-### Reference Information
-
-[Plugin Development](https://github.com/inspec/train/blob/master/docs/dev/plugins.md) is documented on the `train` project on GitHub.
-
-### Testing changes against AWS
-
-Live-fire testing against AWS may be performed by the `integration` set of tests.  To run the integration tests, you will need to have a set of AWS credentials exported to your environment.  See test/integration/live_connect_test.rb .