puppetdb_cli 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 42d242aeb659eede85c99de3e9eb3aba62601f6b
-  data.tar.gz: a9c1b2185eacbe0303cb24344ddf708090c8b475
+SHA256:
+  metadata.gz: 522c9ff47c587943f222c5c31080c769c74677887732249dedc54f1a9ddfec6d
+  data.tar.gz: b2d276ff0b97575e7cea4c06764c3a39fdae768d4a984fe91cdb4db8529dc27a
 SHA512:
-  metadata.gz: ad17edfa9dea21e21ae34998da28f30b4ef5dc6bcda62fca751b3273191015d1280083e9a4508f25bc7a556a319bc60862d58c08c90e291b6f948cf6330a8fe3
-  data.tar.gz: 3608ab3405b2ad0fdf15d0ee5d25f873b5b08b1588d95575d73f51b86519da9831f37639adc4c2d9f94959407e661259e5b4ea158d4ea25a35a519e570ba6811
+  metadata.gz: 9e131e3fccbb258bb1769e745f6c4f75aa0c648a621ce02ab3559843dfcd0b40e15757617468d307588a7faaac14bacf9e8f4308fe71c34d649630b5637dbe65
+  data.tar.gz: 769347fcc381f159fe378cc16fc2aeb95274f6c6c83f2bd75924b585b0a40f367783d79251e13aee64de75e88a14c7949d2ab776465946b9456cc4b178c318ad

data/.rubocop.yml

@@ -19,3 +19,7 @@ Metrics/BlockLength:
     - puppetdb_cli.gemspec
 Metrics/LineLength:
   Max: 120
+Metrics/MethodLength:
+  Max: 20
+Metrics/AbcSize:
+  Max: 20

data/CODEOWNERS

@@ -0,0 +1 @@
+* @austb @Zak-Kent

data/README.md

@@ -6,11 +6,10 @@
 > **Note**: This repository is still under active development. Stay tuned for
 > release dates and functionality changes.
 
-The PuppetDB CLI project provide Puppet subcommands for querying PuppetDB data,
+The PuppetDB CLI project provides Puppet subcommands for querying PuppetDB data,
 via `puppet query <query>`, and PuppetDB administrative tasks, `puppet db
 <import|export|status>`. The `query` subcommand will allow you to query PuppetDB
-using either the upcoming PQL syntax of the traditional PuppetDB query syntax
-(also known as AST). The `db` subcommand is a replacement for the older
+using either PQL or AST syntax. The `db` subcommand is a replacement for the older
 `puppetdb <export|import>` commands with faster startup times and much
 friendlier error messages.
 
@@ -22,30 +21,27 @@ and greater.
 
 ## Installation
 
-Please see
-[the PuppetDB documentation](https://docs.puppet.com/puppetdb/latest/pdb_client_tools.html)
-for instructions on how to install the `puppet-client-tools` package.
+### Prerequisites
 
-## Installation from source
+* Ruby
 
-Using `rustc` and `cargo` (stable, beta, or nightly):
+### Installation from rubygems
 
-```bash
+The PuppetDB CLI can be installed via a `gem install`.
 
-  $ export PATH=./target/debug:$PATH
-  $ cargo build
-  
+```bash
+gem install --bindir /opt/puppetlabs/bin puppetdb_cli
 ```
 
-When building on OSX or Windows you will also need to install openssl and use
-that for building the PuppetDB CLI. For OSX users the simplest way to do this is
-using Homebrew and running the following commands before the `cargo build`:
+If the machine does not have Puppet installed, you can simply use `gem install puppetdb_cli`
+and use the `puppet-query` and `puppet-db` executables directly.
 
-```bash
+### Installation from source
 
-  $ export OPENSSL_LIB_DIR=$(brew --prefix)/lib
-  $ export OPENSSL_INCLUDE_DIR=$(brew --prefix)/include
+From the cloned repository
 
+```bash
+bundle exec rake install
 ```
 
 ## Usage
@@ -53,7 +49,6 @@ using Homebrew and running the following commands before the `cargo build`:
 Example usage:
 
 ```bash
-
 $ puppet-query 'nodes[certname]{}'
 [
   {
@@ -88,7 +83,6 @@ $ puppet-db status
     "status": {}
   }
 }
-
 ```
 
 ## Configuration

data/lib/puppetdb_cli.rb

@@ -19,32 +19,6 @@ module PuppetDBCLI
     summary 'PuppetDB CLI'
     description 'A command line tool for interacting with PuppetDB'
     default_subcommand 'help'
-
-    flag :v, :version, 'Show version of puppetdb cli tool.' do |_, _|
-      puts PuppetDBCLI::VERSION
-      exit 0
-    end
-
-    flag :h, :help, 'Show help for this command.' do |_, c|
-      puts c.help
-      exit 0
-    end
-
-    flag :d, :debug, 'Enable debug output.' do |_, _|
-      PuppetDBCLI.logger.enable_debug_mode
-    end
-
-    option :c, :config, 'The path to the PuppetDB CLI config', argument: :required
-
-    option nil, :urls, 'The urls of your PuppetDB instances (overrides SERVER_URLS).', argument: :required
-
-    option nil, :cacert, 'Overrides the path for the Puppet CA cert', argument: :required
-
-    option nil, :cert, 'Overrides the path for the Puppet client cert.', argument: :required
-
-    option nil, :key, 'Overrides the path for the Puppet client private key.', argument: :required
-
-    option nil, :token, 'Overrides the path for the RBAC token (PE only).', argument: :required
   end
 
   require 'puppetdb_cli/query'

data/lib/puppetdb_cli/db.rb

@@ -5,16 +5,13 @@
 # This subcommand has no functionalty other than --help. It's purpose is to contain
 # subcommands for compatibility with usage as 'puppet db'.
 module PuppetDBCLI
-  @db_cmd = @base_cmd.define_command do
-    name 'db'
-    usage 'db [options] <subcommand>'
-    summary 'manage PuppetDB administrative tasks'
-    default_subcommand 'help'
+  @db_cmd = @base_cmd.define_command do |dsl|
+    dsl.name 'db'
+    dsl.usage 'db [options] <subcommand>'
+    dsl.summary 'manage PuppetDB administrative tasks'
+    dsl.default_subcommand 'help'
 
-    flag :h, :help, 'Show help for this command.' do |_, c|
-      puts c.help
-      exit 0
-    end
+    PuppetDBCLI::Utils::DefaultOptions.include_default_options(dsl)
   end
 
   @db_cmd.add_command Cri::Command.new_basic_help

data/lib/puppetdb_cli/db/export.rb

@@ -21,7 +21,7 @@ module PuppetDBCLI
     usage 'export [options] <path>'
     summary 'export an archive from PuppetDB'
 
-    option :a, :anonymization, 'Archive anonymization profile (low, moderate, high)',
+    option :a, :anonymization, 'Archive anonymization profile (low, moderate, full)',
            default: :none,
            argument: :required,
            transform: AnonymizationTransformer.new

data/lib/puppetdb_cli/query.rb

@@ -6,18 +6,14 @@ require 'json'
 #
 # The query command submits queries to /pdb/query/v4
 module PuppetDBCLI
-  @query_cmd = @base_cmd.define_command do
-    name 'query'
-    usage 'query [options] <query>'
-    summary 'Query puppetdb with AST or PQL'
+  @query_cmd = @base_cmd.define_command do |dsl|
+    dsl.name 'query'
+    dsl.usage 'query [options] <query>'
+    dsl.summary 'Query puppetdb with AST or PQL'
 
-    flag :h, :help, 'Show help for this command.' do |_, c|
-      c.add_command Cri::Command.new_basic_help
-      puts c.help
-      exit 0
-    end
+    PuppetDBCLI::Utils::DefaultOptions.include_default_options(dsl)
 
-    run do |opts, args, cmd|
+    dsl.run do |opts, args, cmd|
       PuppetDBCLI::Utils.log_command_start cmd.name, opts, args
 
       if args.count.zero?

data/lib/puppetdb_cli/utils.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'puppetdb_cli/utils/default_options'
+
 # Utils for PuppetDBCLI
 #
 # Primarily used for interaction with the PuppetDB::Client

data/lib/puppetdb_cli/utils/default_options.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module PuppetDBCLI
+  module Utils
+    # Defaults for puppet-query and puppet-db
+    module DefaultOptions
+      def self.include_default_options(dsl)
+        dsl.flag :v, :version, 'Show version of puppetdb cli tool.' do |_, _|
+          puts PuppetDBCLI::VERSION
+          exit 0
+        end
+
+        dsl.flag :h, :help, 'Show help for this command.' do |_, c|
+          puts c.help
+          exit 0
+        end
+
+        dsl.flag :d, :debug, 'Enable debug output.' do |_, _|
+          PuppetDBCLI.logger.enable_debug_mode
+        end
+
+        dsl.option :c, :config, 'The path to the PuppetDB CLI config', argument: :required
+
+        dsl.option nil, :urls, 'The urls of your PuppetDB instances (overrides SERVER_URLS).', argument: :required
+
+        dsl.option nil, :cacert, 'Overrides the path for the Puppet CA cert', argument: :required
+
+        dsl.option nil, :cert, 'Overrides the path for the Puppet client cert.', argument: :required
+
+        dsl.option nil, :key, 'Overrides the path for the Puppet client private key.', argument: :required
+
+        dsl.option nil, :token, 'Overrides the path for the RBAC token (PE only).', argument: :required
+      end
+    end
+  end
+end

data/lib/puppetdb_cli/version.rb

@@ -2,5 +2,5 @@
 
 # PuppetDB CLI version
 module PuppetDBCLI
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

data/puppetdb_cli.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'cri', '~> 2.15'
-  spec.add_runtime_dependency 'pl-puppetdb-ruby', '~> 2.0.2'
+  spec.add_runtime_dependency 'pl-puppetdb-ruby', '~> 2.0.3'
 
   spec.add_development_dependency 'bundler', '>= 1.15.0', '< 3.0.0'
   spec.add_development_dependency 'pry-byebug', '~> 3.7'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppetdb_cli
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Austin Blatt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-08 00:00:00.000000000 Z
+date: 2019-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cri
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +128,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CODEOWNERS
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -154,6 +155,7 @@ files:
 - lib/puppetdb_cli/logger.rb
 - lib/puppetdb_cli/query.rb
 - lib/puppetdb_cli/utils.rb
+- lib/puppetdb_cli/utils/default_options.rb
 - lib/puppetdb_cli/version.rb
 - man/puppet-db.pod
 - man/puppet-query.pod
@@ -178,8 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A command line tool to query puppetdb