pupmin 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4927470f62bbad5510c489d24a494773d8a1f5d8bed9a4ab38faf9afce981282
+  data.tar.gz: 5a71fcc8ccd90adff46495e869c341033c4b4eba62f52405ded740b1199da73a
+SHA512:
+  metadata.gz: 37b7c451d2ba2acdf15d37231e923f491753c5ff70d850251e1212a0cd0b820dfaf70144dc9e110a2bfa971c19e8efb336515f966b61624eea3274c87a52f695
+  data.tar.gz: 316e87415fe24eb5547b03bafaef27c7f03e5689d68dd09ab72b61e3d0338060f9f8a9795c487e46c02c1aa101bfa5325046242e428347fd827ab20e12d24bd5

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/*.gem

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pupit.gemspec
+gemspec
+
+gem 'puppetdb-ruby'

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    pupmin (1.0.1)
+      puppetdb-ruby (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.17.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    multi_xml (0.6.0)
+    puppetdb-ruby (1.2.0)
+      httparty
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pupmin!
+  puppetdb-ruby
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Stephen Dunne
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# Pupmin
+
+Pupmin is a toolkit and utility collection for working with a Puppet cluster. Most options will require a working PuppetDB server. This gem isn't meant to replace or be an alternative to other Puppet/PuppetDB gems, but rather just serve to be a shortcut and interface into some common administrative and management tasks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pupmin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pupmin
+
+## Usage
+
+### In Script/Application
+
+Include the gem, then set the configuration before calling any of the classes/methods. At minimum, you need the PuppetDB server that you'll query:
+
+```ruby
+Pupmin.configure({:puppetdb_url => 'http://puppetdb.yourdomain.tld:8080'})
+```
+The PuppetDB class essentially just wraps the [VoxPupuli PuppetDB Gem](https://github.com/voxpupuli/puppetdb-ruby), so the same configuration block for SSL connections can be used here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pupmin"
+
+# 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

@@ -0,0 +1,8 @@
+#!/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

data/lib/pupmin.rb

@@ -0,0 +1,20 @@
+require_relative 'pupmin/version'
+require_relative 'pupmin/util'
+require_relative 'pupmin/puppetdb'
+require_relative 'pupmin/reports'
+require_relative 'pupmin/nodes'
+
+## main module file and configuration initialization
+module Pupmin
+  class << self
+    attr_accessor :puppetdb_url, :puppetca_host, :puppet_certs
+
+    def configure(puppetdb_url: nil, puppetca_host: nil, puppet_certs: {})
+      @puppetdb_url = puppetdb_url
+      @puppetca_host = puppetca_host
+      @puppet_certs = puppet_certs
+    end
+  end
+
+  class Error < StandardError; end
+end

data/lib/pupmin/nodes.rb

@@ -0,0 +1,31 @@
+module Pupmin
+  ## Node/Agent grouping and other informational helpers
+  class Nodes
+    ## Simple list all nodes by fqdn values
+    def self.all
+      puppetdb = Pupmin::PuppetDB.build
+      nodes = []
+      puppetdb.request('facts', ['=', 'name', 'fqdn']).data.each do |x|
+          nodes.push(x['value'])
+      end
+      nodes
+    end
+
+    ## Display a random number of hosts
+    def self.random(num = 5)
+      rand_hosts = []
+      all_hosts = all().shuffle!
+      # hosts.shuffle!
+      num.to_i.times do
+        rand_hosts.push(all_hosts.shift)
+      end
+      rand_hosts
+    end
+
+    def self.deactivate(certname)
+      pdb = Pupmin::PuppetDB.build
+      rsp = pdb.command('deactivate node', {'certname' => $certname, 'producer_timestamp' => Pupmin::Util.make_timestamp}, 3)
+      rsp.data
+    end
+  end
+end

data/lib/pupmin/puppetdb.rb

@@ -0,0 +1,10 @@
+require 'puppetdb'
+
+module Pupmin
+  ## wrapper for the VoxPupuli PuppetDB gem.
+  class PuppetDB < PuppetDB::Client
+    def self.build
+      ::PuppetDB::Client.new(server: Pupmin.puppetdb_url, pem: Pupmin.puppet_certs)
+    end
+  end
+end

data/lib/pupmin/reports.rb

@@ -0,0 +1,32 @@
+module Pupmin
+  ## shortcuts for some useful report information
+  class Reports
+    def self.call_query(query, options = {}, endpoint = 'reports')
+      puppetdb = Pupmin::PuppetDB.build
+      puppetdb.request(endpoint, query, options)
+    end
+
+    ## Get a list of reports by their status; defaults to just latest report
+    def self.by_status(status: 'changed', latest: true, options: {})
+      query = [
+        'AND',
+        ['=', 'status', status.to_s],
+        ['=', 'latest_report?', latest.to_s]
+      ]
+
+      call_query(query, options)
+    end
+
+    ## Get a list of "aged" agents, i.e servers that last submitted a
+    ##  report > threshold
+    def self.get_aged(threshold: 3600, options: {})
+      query = [
+        '<',
+        'catalog_timestamp',
+        Pupmin::Util.make_timestamp(threshold.to_i)
+      ]
+
+      call_query(query, options, 'nodes')
+    end
+  end
+end

data/lib/pupmin/util.rb

@@ -0,0 +1,12 @@
+module Pupmin
+  ## Utilities/helpers for various things
+  class Util
+    ## PuppetDB seems to use a timestamp that isn't quite standard, so this
+    ##  takes an offset, and creates the time used in reports
+    def self.make_timestamp(offset = 0)
+      current_time = Time.new.utc
+      adjusted_time = current_time - offset
+      adjusted_time.strftime('%FT%TZ')
+    end
+  end
+end

data/lib/pupmin/version.rb

@@ -0,0 +1,3 @@
+module Pupmin
+  VERSION = '1.0.1'
+end

data/pupmin.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pupmin/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pupmin"
+  spec.version       = Pupmin::VERSION
+  spec.authors       = ["Stephen Dunne"]
+  spec.email         = ["stephen@icanhazmail.net"]
+
+  spec.summary       = 'Puppet administrative and information toolkit'
+  spec.description   = 'Collection of methods and bindings for quick access to various puppet administrative tasks'
+  spec.homepage      = 'https://github.com/sedunne/pupmin.git'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = 'https://github.com/sedunne/pupmin.git'
+    spec.metadata["changelog_uri"] = 'https://github.com/sedunne/pupmin.git/CHANGELOG.md'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency 'puppetdb-ruby', "~> 1.2"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: pupmin
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Stephen Dunne
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: puppetdb-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Collection of methods and bindings for quick access to various puppet
+  administrative tasks
+email:
+- stephen@icanhazmail.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pupmin.rb
+- lib/pupmin/nodes.rb
+- lib/pupmin/puppetdb.rb
+- lib/pupmin/reports.rb
+- lib/pupmin/util.rb
+- lib/pupmin/version.rb
+- pupmin.gemspec
+homepage: https://github.com/sedunne/pupmin.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sedunne/pupmin.git
+  source_code_uri: https://github.com/sedunne/pupmin.git
+  changelog_uri: https://github.com/sedunne/pupmin.git/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Puppet administrative and information toolkit
+test_files: []