aws-inventory 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f5cff9d019cae6b629e6aa48890ea2aba7f665c
-  data.tar.gz: a691ebdb60ecca8946b3419dcf4c21f702768f1f
+  metadata.gz: e6ff7b0b1ed3072711ce24784770a6f105f33107
+  data.tar.gz: b36139703667195d8b14c0fa2fc786e6006ec53b
 SHA512:
-  metadata.gz: 1f9dea807fa8f915dc0db022954aff928b48cd699ce3e17f37961ceb8697010663ea074a9f17402f496871b82542b6ed5df814e56a6890e032bba2e7eda0e7b6
-  data.tar.gz: 1390a1d93c1edd1316c4c5ebcaed648b56d0e9444a792cb64c4fdb61d4414dbfc324eaffcbba307ce1655eca947a177286f5881f201d850f0b2593196d9f83c9
+  metadata.gz: dcf16a41f945d6d3f11932ca9c2acd9584bb1ede6527e277728537f72923f7b1f410fa0828140741f5ef33ea47aae281a2b5d77600a200c8c0654d8655dbe3d8
+  data.tar.gz: eea11e513d1f9b8155d542d2da738de54f9a32e4498a60022d01b8d7a6777ce3ed2698cbd6b2272f61dc70a906b8011b3312c0d71794a26aa509d7971a18d0f2

data/CHANGELOG.md

@@ -3,5 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.3.1]
+* add json presenter
+* add unused security group report
+* rename report-type option to report
+
 ## [0.3.0]
 - initial release

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    aws-inventory (0.2.1)
+    aws-inventory (0.3.0)
       actionview
       activesupport
       aws-sdk
       colorize
       facets
       hashie
+      json
       text-table
       thor
 
@@ -25,7 +26,7 @@ GEM
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    aws-partitions (1.48.0)
+    aws-partitions (1.53.0)
     aws-sdk (3.0.1)
       aws-sdk-resources (~> 3)
     aws-sdk-acm (1.2.0)
@@ -34,7 +35,7 @@ GEM
     aws-sdk-alexaforbusiness (1.0.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-apigateway (1.8.0)
+    aws-sdk-apigateway (1.9.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-applicationautoscaling (1.6.0)
@@ -88,7 +89,7 @@ GEM
     aws-sdk-cloudtrail (1.0.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-cloudwatch (1.3.0)
+    aws-sdk-cloudwatch (1.4.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-cloudwatchevents (1.1.0)
@@ -97,7 +98,7 @@ GEM
     aws-sdk-cloudwatchlogs (1.2.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-codebuild (1.4.0)
+    aws-sdk-codebuild (1.5.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-codecommit (1.2.0)
@@ -124,10 +125,10 @@ GEM
     aws-sdk-comprehend (1.0.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-configservice (1.4.0)
+    aws-sdk-configservice (1.5.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-core (3.11.0)
+    aws-sdk-core (3.13.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
@@ -161,13 +162,13 @@ GEM
     aws-sdk-dynamodbstreams (1.0.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-ec2 (1.21.0)
+    aws-sdk-ec2 (1.24.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-ecr (1.2.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-ecs (1.7.0)
+    aws-sdk-ecs (1.8.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-efs (1.0.0)
@@ -221,10 +222,10 @@ GEM
     aws-sdk-importexport (1.0.0)
       aws-sdk-core (~> 3)
       aws-sigv2 (~> 1.0)
-    aws-sdk-inspector (1.1.0)
+    aws-sdk-inspector (1.2.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-iot (1.2.0)
+    aws-sdk-iot (1.3.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-iotdataplane (1.0.0)
@@ -236,7 +237,7 @@ GEM
     aws-sdk-kinesis (1.1.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-kinesisanalytics (1.1.0)
+    aws-sdk-kinesisanalytics (1.2.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-kinesisvideo (1.0.0)
@@ -290,7 +291,7 @@ GEM
     aws-sdk-mediastore (1.0.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-mediastoredata (1.0.0)
+    aws-sdk-mediastoredata (1.1.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-migrationhub (1.0.0)
@@ -468,7 +469,7 @@ GEM
       aws-sdk-workmail (~> 1)
       aws-sdk-workspaces (~> 1)
       aws-sdk-xray (~> 1)
-    aws-sdk-route53 (1.5.0)
+    aws-sdk-route53 (1.6.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-route53domains (1.1.0)
@@ -478,7 +479,7 @@ GEM
       aws-sdk-core (~> 3)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.0)
-    aws-sdk-sagemaker (1.3.0)
+    aws-sdk-sagemaker (1.4.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-sagemakerruntime (1.0.0)
@@ -544,7 +545,7 @@ GEM
     aws-sdk-workmail (1.0.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-workspaces (1.0.0)
+    aws-sdk-workspaces (1.1.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-xray (1.1.0)
@@ -584,7 +585,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hashie (3.5.6)
+    hashie (3.5.7)
     i18n (0.9.1)
       concurrent-ruby (~> 1.0)
     jmespath (1.3.1)
@@ -599,7 +600,7 @@ GEM
     lumberjack (1.0.12)
     method_source (0.9.0)
     mini_portile2 (2.3.0)
-    minitest (5.10.3)
+    minitest (5.11.0)
     nenv (0.3.0)
     nokogiri (1.8.1)
       mini_portile2 (~> 2.3.0)
@@ -658,4 +659,4 @@ DEPENDENCIES
   rake
 
 BUNDLED WITH
-   1.16.0
+   1.16.1

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Tung Nguyen
+Copyright (c) 2017 Tung Nguyen
 
 MIT License
 

data/README.md

@@ -1,9 +1,8 @@
 # AWS Inventory
 
-AWS Inventory tool. Useful to get summarized information on AWS account.  The tool by default produces a reoprt that can easily be read from a terminal, but it can also be used produce a tab separated output report that can be pasted into a spreadsheet and then copied to a report.  This is controlled via a `AWS_INVENTORY_FORMAT` env variable and covered in the Format Options section.
+AWS Inventory tool. Useful to get summarized information on AWS account.  The tool by default produces a report that can easily be read from a terminal, but it can also be used produce a tab separated output report that can be pasted into a spreadsheet and then copied to a report.  This is controlled via a `AWS_INVENTORY_FORMAT` env variable and covered in the Format Options section.
 
 ## Usage
-
 ```sh
 aws-inventory acm             # report acm inventory
 aws-inventory cfn             # report cfn inventory
@@ -49,17 +48,35 @@ GREEN='\033[0;32m'
 NC='\033[0m' # No Color
 for i in $(aws ec2 describe-regions | jq -r '.Regions[].RegionName') ; do
   echo -e "$GREEN$i$NC"
-  AWS_REGION=$i inventory ec2
+  AWS_REGION=$i aws-inventory ec2
 done
 ```
 
 ### Format Option
 
-There are 2 supported formats: tab and table.  The default is table.  To switch between formats use the AWS_INVENTORY_FORMAT environment variable.
+There are a few supported formats: tab, table and json.  The default is table.  To switch between formats use the AWS_INVENTORY_FORMAT environment variable.
 
 ```sh
 export AWS_INVENTORY_FORMAT=tab
 aws-inventory ec2
 export AWS_INVENTORY_FORMAT=table
 aws-inventory ec2
+export AWS_INVENTORY_FORMAT=json
+aws-inventory ec2
 ```
+
+## Install
+
+```sh
+gem install aws-inventory
+```
+
+## Contributing
+
+I love pull requests! Happy to answer questions to help.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/inventory.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "text-table"
   spec.add_dependency "facets"
   spec.add_dependency "actionview"
+  spec.add_dependency "json"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

data/lib/inventory/base.rb

@@ -30,8 +30,8 @@ class Inventory::Base
     end
   end
 
-  def show(report_type)
-    ["all", report_type.to_s].include?(@options[:report_type])
+  def show(report)
+    ["all", report.to_s].include?(@options[:report])
   end
 
   class << self
@@ -62,10 +62,10 @@ class Inventory::Base
         class_name = path
                       .sub('.rb','')
                       .sub(%r{.*/inventory}, 'inventory')
-                      .sub('presenters', 'presenter') # special rule
                       .camelize
         # special rules
         class_name.sub!("Cli", "CLI")
+                  .sub!('Presenters', 'Presenter')
 
         class_name.constantize # use constantize instead of require
           # so we dont have to worry about require order.

data/lib/inventory/cli.rb

@@ -22,14 +22,14 @@ module Inventory
 
     desc "sg", "report security group inventory"
     long_desc Help.text(:sg)
-    option :report_type, default: "open", desc: "all, summary, or open"
+    option :report, default: "open", desc: "all, summary, open or unused"
     def sg
       SecurityGroup.new(options).report
     end
 
     desc "rds", "report rds inventory"
     long_desc Help.text(:rds)
-    option :report_type, default: "summary", desc: "all, summary, or port"
+    option :report, default: "summary", desc: "all, summary, or port"
     def rds
       Rds.new(options).report
     end
@@ -72,7 +72,7 @@ module Inventory
 
     desc "iam", "report iam inventory"
     long_desc Help.text(:iam)
-    option :report_type, default: "groups", desc: "all, groups, users, or summary"
+    option :report, default: "groups", desc: "all, groups, users, or summary"
     def iam
       Iam.new(options).report
     end

data/lib/inventory/help/iam.md

@@ -2,14 +2,14 @@ Reports the IAM inventory.
 
 List of groups and users in the groups:
 
-$ inventory iam --report-type groups # this is the default
+$ inventory iam --report groups # this is the default
 
 $ inventory iam  # same as above
 
 List of the users and their groups:
 
-$ inventory iam --report-type users
+$ inventory iam --report users
 
 Summary of number of groups and users
 
-$ inventory iam --report-type summary
+$ inventory iam --report summary

data/lib/inventory/help/rds.md

@@ -1,5 +1,5 @@
 Reports the RDS inventory
 
-$ inventory rds --report-type summary
+$ inventory rds --report summary
 
-$ inventory rds --report-type port
+$ inventory rds --report port

data/lib/inventory/presenter.rb

@@ -2,6 +2,7 @@ class Inventory::Presenter
   autoload :Base, "inventory/presenters/base"
   autoload :Tab, "inventory/presenters/tab"
   autoload :Table, "inventory/presenters/table"
+  autoload :Json, "inventory/presenters/json"
 
   def initialize(data)
     @data = data

data/lib/inventory/presenters/json.rb

@@ -0,0 +1,11 @@
+require "json"
+
+class Inventory::Presenter::Json < Inventory::Presenter::Base
+  def display
+    json_data = {
+      header: @data.shift,
+      data: @data
+    }
+    puts JSON.dump(json_data)
+  end
+end

data/lib/inventory/security_group.rb

@@ -2,10 +2,12 @@ class Inventory::SecurityGroup < Inventory::Base
   autoload :Shared, "inventory/security_group/shared"
   autoload :Summary, "inventory/security_group/summary"
   autoload :Open, "inventory/security_group/open"
+  autoload :Unused, "inventory/security_group/unused"
 
   # Default is the open report because it seems like the most useful report
   def report
     Summary.new(@options).report if show(:summary)
     Open.new(@options).report if show(:open)
+    Unused.new(@options.report).report if show(:unused)
   end
 end

data/lib/inventory/security_group/unused.rb

@@ -0,0 +1,15 @@
+class Inventory::SecurityGroup
+  class Unused < Inventory::Base
+    include Shared
+
+    def header
+      ["Security Group Name"]
+    end
+
+    def data
+      used_security_groups.map do |sg|
+        sg.group_name
+      end
+    end
+  end
+end

data/lib/inventory/version.rb

@@ -1,3 +1,3 @@
 module Inventory
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-inventory
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2018-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -260,6 +274,7 @@ files:
 - lib/inventory/keypair.rb
 - lib/inventory/presenter.rb
 - lib/inventory/presenters/base.rb
+- lib/inventory/presenters/json.rb
 - lib/inventory/presenters/tab.rb
 - lib/inventory/presenters/table.rb
 - lib/inventory/rds.rb
@@ -271,6 +286,7 @@ files:
 - lib/inventory/security_group/open.rb
 - lib/inventory/security_group/shared.rb
 - lib/inventory/security_group/summary.rb
+- lib/inventory/security_group/unused.rb
 - lib/inventory/shared.rb
 - lib/inventory/version.rb
 - lib/inventory/vpc.rb
@@ -298,7 +314,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Tool to inventory AWS account