a2 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ab4e4782cc17d7bdd25d29feda56c81d4dbff2e911f19e9d723f5ecf66801f7
-  data.tar.gz: 4993432169fd2305698ee7f1106b0b2a83576eef287ac7065d2543ed38b1cae4
+  metadata.gz: e724f7c4be83a1deeacacd760435708a7c8fa594fa62ba6397cac29ad07820c7
+  data.tar.gz: c218ab82d310845e7284edeb583b178800d21bca80603889baefc7c8f8897531
 SHA512:
-  metadata.gz: 5cdab720df6fc757d7392598e2ddefed1dfe0883013aca3eb63c95b9b8644ea02de60967b751758c73b312da36d2280ee758a1ae6cbbd92ba9a109ae9d1086ed
-  data.tar.gz: e61c4e157f94ff5aca7f69808967cafa12c487bb0978af6726b6772e71d69774791e04c4b04c512ab31857faa15fcca510e645cfc8f3b1d81f6a33b2f2894e3b
+  metadata.gz: 1417567e7b7ac76433c1d84d0e506555424721a85f558c08c2fe416da49960e0bb8af7cd9b048170633e0e333b1d83cfa6f97b18e874edbc471ece00f5691808
+  data.tar.gz: 32f613016abdd104ccfda2bbb1c8ff4a10ebc398e3fae4c875bdcb54318003f7789d7637b6c9f8869caa6f95016cee788d58bafd03b4ae3c470909eb4900aa83

data/.github/workflows/gem-push.yml

@@ -9,10 +9,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby 3.1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: 3.1.2
     - name: Publish to RubyGems
       run: |
         mkdir -p $HOME/.gem

data/.github/workflows/run-rake.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6']
+        ruby-version: ['2.6', '3.1']
 
     steps:
     - uses: actions/checkout@v2
@@ -21,6 +21,6 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
-        bundler: '2.2.15'
+        bundler: '2.3.26'
     - name: Run tests
       run: bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+## [v0.3.1](https://github.com/gscho/a2-cli/tree/HEAD)
+
+[Full Changelog](https://github.com/gscho/a2-cli/compare/v0.3.0...HEAD)
+
+**Merged pull requests:**
+
+- Ruby 3.1 support [\#6](https://github.com/gscho/a2-cli/pull/6) ([gscho](https://github.com/gscho))
+- Bump addressable from 2.7.0 to 2.8.0 [\#5](https://github.com/gscho/a2-cli/pull/5) ([gscho](https://github.com/gscho))
+
+## [v0.3.0](https://github.com/gscho/a2-cli/tree/HEAD)
+
+[Full Changelog](https://github.com/gscho/a2-cli/compare/v0.2.0...HEAD)
+
+**Merged pull requests:**
+
+- Add some basic unit tests for approved and filtered mixins [\#2](https://github.com/gscho/a2-cli/pull/2) ([gscho](https://github.com/gscho))
+- Release v0.2.0 [\#1](https://github.com/gscho/a2-cli/pull/1) ([gscho](https://github.com/gscho))
+
+## [v0.2.0](https://github.com/gscho/a2-cli/tree/v0.2.0) (2021-04-07)
+
+[Full Changelog](https://github.com/gscho/a2-cli/compare/v0.1.1...v0.2.0)
+
+## [v0.1.1](https://github.com/gscho/a2-cli/tree/v0.1.1) (2021-03-24)
+
+[Full Changelog](https://github.com/gscho/a2-cli/compare/v0.1.0...v0.1.1)
+
+## [v0.1.0](https://github.com/gscho/a2-cli/tree/v0.1.0) (2021-03-23)
+
+[Full Changelog](https://github.com/gscho/a2-cli/compare/783f8a6384a480f7b165ef5645aa1e8e4c4dfb45...v0.1.0)
+
+
+
+\* *This Changelog was automatically generated       by [github_changelog_generator]      (https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -2,5 +2,4 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in a2.gemspec
 gemspec

data/Gemfile.lock

@@ -1,23 +1,91 @@
 PATH
   remote: .
   specs:
-    a2 (0.2.0)
+    a2 (0.3.1)
       cmdparse
       httparty
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    async (1.28.9)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    async-http (0.54.1)
+      async (~> 1.25)
+      async-io (~> 1.28)
+      async-pool (~> 0.2)
+      protocol-http (~> 0.21.0)
+      protocol-http1 (~> 0.13.0)
+      protocol-http2 (~> 0.14.0)
+    async-http-faraday (0.9.0)
+      async-http (~> 0.42)
+      faraday
+    async-io (1.30.2)
+      async (~> 1.14)
+    async-pool (0.3.5)
+      async (~> 1.25)
     cmdparse (3.0.7)
-    httparty (0.18.1)
-      mime-types (~> 3.0)
+    concurrent-ruby (1.1.7)
+    console (1.10.2)
+      fiber-local
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.2.2)
+      faraday (~> 0.8)
+    fiber-local (1.0.0)
+    github_changelog_generator (1.16.1)
+      activesupport
+      async (>= 1.25.0)
+      async-http-faraday
+      faraday-http-cache
+      multi_json
+      octokit (~> 4.6)
+      rainbow (>= 2.2.1)
+      rake (>= 10.0)
+      retriable (~> 3.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    mini_mime (1.1.2)
     minitest (5.14.4)
+    multi_json (1.15.0)
     multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nio4r (2.5.4)
+    octokit (4.18.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    protocol-hpack (1.4.2)
+    protocol-http (0.21.0)
+    protocol-http1 (0.13.2)
+      protocol-http (~> 0.19)
+    protocol-http2 (0.14.2)
+      protocol-hpack (~> 1.4)
+      protocol-http (~> 0.18)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
     rake (13.0.3)
+    retriable (3.1.2)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    thread_safe (0.3.6)
+    timers (4.3.3)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -26,9 +94,10 @@ PLATFORMS
 
 DEPENDENCIES
   a2!
-  bundler (~> 2.2.15)
+  bundler (~> 2.3)
+  github_changelog_generator
   minitest (~> 5.0)
   rake (>= 12.3.3)
 
 BUNDLED WITH
-   2.2.15
+   2.3.26

data/README.md

@@ -3,11 +3,14 @@
 ![build status](https://github.com/gscho/a2-cli/actions/workflows/run-rake.yml/badge.svg?branch=main)
 [![Gem Version](https://badge.fury.io/rb/a2.svg)](https://badge.fury.io/rb/a2)
 
-This gem is a CLI for interacting with Chef Automate 2+ APIs.
+A CLI and ruby client for interacting with Chef Automate 2+ APIs.
 
 
 ## Usage
 
+* [CLI Usage](#using-from-the-command-line)
+* [Client Usage](#using-as-an-api-client)
+
 ### Using from the command line
 
 Install the CLI via rubygems:
@@ -21,7 +24,7 @@ Environment variables:
 ```
 AUTOMATE_URL="https://automate.example.com"
 AUTOMATE_TOKEN="my-token"
-SSL_NO_VERIFY=true
+AUTOMATE_SSL_NO_VERIFY=true
 ```
 
 List the available commands:
@@ -32,6 +35,7 @@ List the available commands:
     Available commands:
         compliance        Compliance management commands
           export-node-reports
+          list-reports
         help              Provide help for individual commands
         iam               Identity access management commands
           add-membership
@@ -74,9 +78,9 @@ List the available commands:
         -h, --help                       Show help
 
 
-### Using as a library
+### Using as an API Client
 
-You can also use it as a library by adding this line to your application's Gemfile:
+You can also use the ruby API client directly by adding this line to your application's Gemfile:
 
 ```ruby
 gem 'a2'

data/a2.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = A2::VERSION
   spec.authors       = ['gscho']
   spec.email         = ['greg.c.schofield@gmail.com']
-  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
-  spec.description   = %q{Write a longer description or delete this line.}
+  spec.summary       = %q{A gem for interacting with the Chef Automate 2+ API}
+  spec.description   = %q{A gem for interacting with the Chef Automate 2+ API}
   spec.homepage      = 'https://github.com/gscho/a2'
   spec.license       = 'MIT'
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
@@ -18,9 +18,14 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.add_development_dependency 'bundler', '~> 2.2.15'
+  spec.metadata = {
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/CHANGELOG.md"
+  }
+  spec.add_development_dependency 'bundler', '~> 2.3'
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'github_changelog_generator'
   spec.add_dependency 'cmdparse'
   spec.add_dependency 'httparty'
 end

data/lib/a2/client/reporting.rb

@@ -2,7 +2,11 @@ module A2
   class Client
     module Reporting
       def export_node_reports(json, output_file)
-        download_report '/api/v0/compliance/reporting/node/export', json, output_file
+        download_file '/api/v0/compliance/reporting/node/export', json, output_file
+      end
+
+      def list_reports(json)
+        post '/api/v0/compliance/reporting/reports', json
       end
     end
   end

data/lib/a2/client.rb

@@ -47,7 +47,7 @@ module A2
       JSON.parse(response.body)
     end
 
-    def download_report(path, json, output_file)
+    def download_file(path, json, output_file)
       File.open(output_file, "w") do |file|
         HTTParty.post(File.join(@automate_url, path).to_s, {
           verify: !@ssl_no_verify,

data/lib/a2/commands/compliance.rb

@@ -8,6 +8,7 @@ module A2
         short_desc('Compliance management commands')
         long_desc('Compliance management commands')
         add_command(A2::Subcommand::Reporting::ExportNodeReports.new)
+        add_command(A2::Subcommand::Reporting::ListReports.new)
       end
     end
   end

data/lib/a2/mixins/approved.rb

@@ -1,14 +1,13 @@
 module A2
   module Approved
-    def initialize(name, opts = {})
-      super(name, takes_commands: false)
-      @opt = {}
+    def add_approval_option!(options, opt = {})
       options.on('-y', '--yes', 'Auto approve the deletion prompt.') do
-        @opt[:yes] = true
+        opt[:auto_approved] = true
       end
+      opt
     end
 
-    def ask_for_approval(message)
+    def ask_for_approval(message = '')
       puts "Are you sure you want to #{message}?"
       puts "Only 'yes' will be accepted to proceed:"
       answer = $stdin.gets.chomp
@@ -16,9 +15,10 @@ module A2
       answer
     end
 
-    def with_approval(message, &block)
+    def with_approval(opts, &block)
+      opts[:auto_approved] = opts[:auto_approved] || false
       answer = 'yes'
-      answer = ask_for_approval(message) unless @opt[:yes]
+      answer = ask_for_approval(opts[:message]) unless opts[:auto_approved]
       block.call if answer.eql?('yes')
     end
   end

data/lib/a2/mixins/filtered.rb

@@ -1,8 +1,9 @@
 module A2
   class Filtered < CmdParse::Command
+    attr_reader :query_filter, :filter_key
     def initialize(name, opts = {})
       set_custom_opts!(opts)
-      super(name, opts)
+      super(name, takes_commands: opts[:takes_commands])
       set_filter_optparse_options!(options, @query_filter)
     end
 

data/lib/a2/subcommands/node_mgmt.rb

@@ -26,10 +26,11 @@ module A2
         include A2::Approved
         def initialize
           super('delete', takes_commands: false)
+          @opt = add_approval_option!(options)
         end
 
         def execute(id)
-          with_approval("delete node #{id}") do
+          with_approval(message: "delete node #{id}", auto_approved: @opt[:auto_approved]) do
             puts JSON.pretty_generate(A2::Client.new(command_parser.data).delete_managed_node(id))
           end
         end
@@ -38,10 +39,11 @@ module A2
         include A2::Approved
         def initialize
           super('bulk-delete-by-ids', takes_commands: false)
+          @opt = add_approval_option!(options)
         end
 
         def execute(ids)
-          with_approval("delete nodes") do
+          with_approval(message: "delete nodes", auto_approved: @opt[:auto_approved]) do
             puts JSON.pretty_generate(A2::Client.new(command_parser.data).bulk_delete_managed_nodes_by_id(id))
           end
         end
@@ -50,11 +52,12 @@ module A2
         include A2::Approved
         def initialize
           super('bulk-delete-by-filter', takes_commands: false)
+          @opt = add_approval_option!(options)
         end
 
         def execute
           with_paginated_filter_json do |json|
-            with_approval("delete nodes using filter") do
+            with_approval(message: "delete nodes using filter", auto_approved: @opt[:auto_approved]) do
               puts JSON.pretty_generate(A2::Client.new(command_parser.data).bulk_delete_managed_nodes_by_filter(json))
             end
           end

data/lib/a2/subcommands/reporting.rb

@@ -25,6 +25,37 @@ module A2
           end
         end
       end
+      class ListReports < Paginated
+        def initialize
+          super('list-reports', takes_commands: false, filter_key: 'type')
+          options.on('-i', '--skip-impact IMPACT', 'Only show reports with an impact score greater than the provided value.') do |impact|
+            @opt[:impact] = impact
+          end
+        end
+
+        def execute
+          impact = @opt.delete(:impact)
+          with_paginated_filter_json do |json|
+            reports_json = A2::Client.new(command_parser.data).list_reports(json)
+            reports_json = filter_by_min_impact(reports_json, impact) unless impact.nil?
+
+            puts JSON.pretty_generate(reports_json)
+          end
+        end
+
+        def filter_by_min_impact(report_json, impact)
+          report_json['reports'].delete_if do |report|
+            if impact == 'minor'
+              if report['controls']['failed']['major'].eql?(0) && report['controls']['failed']['critical'].eql?(0)
+                true
+              end
+            elsif impact == 'major'
+              true if report['controls']['failed']['critical'].eql?(0)
+            end
+          end
+          report_json
+        end
+      end
     end
   end
 end

data/lib/a2/subcommands/team.rb

@@ -50,10 +50,11 @@ module A2
         include A2::Approved
         def initialize
           super('delete-team', takes_commands: false)
+          @opt = add_approval_option!(options)
         end
 
         def execute(id)
-          with_approval("delete team #{id}") do
+          with_approval(message: "delete team #{id}", auto_approved: @opt[:auto_approved]) do
             puts JSON.pretty_generate(A2::Client.new(command_parser.data).delete_team(id))
           end
         end

data/lib/a2/subcommands/user.rb

@@ -50,10 +50,11 @@ module A2
         include A2::Approved
         def initialize
           super('delete-user', takes_commands: false)
+          @opt = add_approval_option!(options)
         end
 
         def execute(id)
-          with_approval("delete user #{id}") do
+          with_approval(message: "delete user #{id}", auto_approved: @opt[:auto_approved]) do
             puts JSON.pretty_generate(A2::Client.new(command_parser.data).delete_user(id))
           end
         end

data/lib/a2/version.rb

@@ -1,3 +1,3 @@
 module A2
-  VERSION = '0.2.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: a2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - gscho
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-07 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.15
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.15
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cmdparse
   requirement: !ruby/object:Gem::Requirement
@@ -80,19 +94,18 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Write a longer description or delete this line.
+description: A gem for interacting with the Chef Automate 2+ API
 email:
 - greg.c.schofield@gmail.com
 executables:
 - a2
-- console
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/gem-push.yml"
 - ".github/workflows/run-rake.yml"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -100,8 +113,6 @@ files:
 - Rakefile
 - a2.gemspec
 - bin/a2
-- bin/console
-- bin/setup
 - lib/a2.rb
 - lib/a2/client.rb
 - lib/a2/client/config_mgmt.rb
@@ -127,8 +138,10 @@ files:
 homepage: https://github.com/gscho/a2
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/gscho/a2
+  changelog_uri: https://github.com/gscho/a2/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,8 +156,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: A gem for interacting with the Chef Automate 2+ API
 test_files: []

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "a2"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here