puppetdb-model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3955e9caf235d79e7db2bb101833588a07598ef564a98057e543fe432a0a2d88
+  data.tar.gz: f37fc2719124a8b4cc88f998ecb13665e055a4582ab4c8ea3c09caec1cd9a9f8
+SHA512:
+  metadata.gz: f50a8f4cffd9eee6363323680857580691f518fa4c9ea148ef8534f7c1a3e9708ce51db901084d4f644a99d37fe51e590b4587294b1894cbd8994671ab7a10dc
+  data.tar.gz: aabf6c930f0910a33785e6ce2d0e416154534db19899b22f0063ae1491af5722bbe6bc931992f6a947e1aa870f9438ce527d33cce25c5266aa6acaea4d62903e

data/README.md

@@ -0,0 +1,24 @@
+# Model for PuppetDB queries
+
+This library provides classes for retreiving objects from the puppet DB
+
+## Example usage
+
+```ruby
+require 'puppetdb/model'
+
+PuppetDB::Model::Base.client = PuppetDB::Client.new(server: 'puppetserver.daho.im')
+
+# get nodes reporting to production environment
+PuppetDB::Model::Nodes.get(report_environment: 'production').each { |node| puts node.certname }
+
+# get Resources exported by a node
+PuppetDB::Model::Resource.get(exported: true, certname: 'dbserver.daho.im').each { |r| puts r.title }
+
+# get Resources from node with regular expressions
+PuppetDB::Model::Resource.get(certname: 'db.*daho.im', regexp: true).each { |r| puts r.title }
+
+# get all exporte Resources
+PuppetDB::Model::Resource.get(exported: true)
+
+```

data/lib/puppetdb/model/base.rb

@@ -0,0 +1,76 @@
+module PuppetDB
+  module Model
+    class Base
+
+      # Parses objects from PuppetDB
+      #
+      # The parser expects an array of hashes where each item in the array is parsed into a separate object.
+      # The keys of the hashes are turned into getters of the resulting object returning the associated values.
+      def initialize(attributes)
+        attributes.each do |attribute_name, attribute_value|
+          # this will create an `attr_reader` for each attribute passed
+          self.class.send(:define_method, attribute_name.to_sym) do
+            instance_variable_get("@#{attribute_name}")
+          end
+
+          # set an instance variable for each attribute like `@certname`
+          instance_variable_set("@#{attribute_name}", attribute_value)
+        end
+      end
+
+      # Saves the PuppetDB client into a class variable which is shared among all object created from this class
+      #
+      # @param client [PuppetDB::Client]
+      def self.client=(client)
+        # rubocop:disable Style/ClassVars
+        @@client = client
+        # rubocop:enable Style/ClassVars
+      end
+
+      # Return the PuppetDB Client
+      #
+      # @return [PuppetDB::Client] instance
+      def self.client
+        @@client
+      end
+
+      # Query the Puppet DB an build new Objects from the result
+      #
+      # @param query [String] The PQL query to execute
+      def self.query(query)
+        request(query).map { |object| new(object) }
+      end
+
+      def self.request(query)
+        client.request('', query).data
+      end
+
+      # Get object from Puppet DB
+      #
+      # Pass a list of key: val arguments as filters for the query.
+      #
+      # @param regexp [Boolean] Set this to true for regular expression matching
+      # @param object [String] The name of the object from The PuppetDB
+      #
+      # @example Get exported Resources
+      #   PuppetDB::Model::Base.get(object: 'resources', exported: true)
+      # @example Regexp search Resources by title
+      #   PuppetDB::Model::Resource.get(object: 'resources', title: '^foo.*bar', regexp: true)
+      def self.get(object:, regexp: false, **filters)
+        # use strict comparator by default, because this is less performance intensive
+        comparator = regexp ? '~' : '='
+
+        filters = filters.map do |key, value|
+          # Boolean values doesn't support regexp operator(~) and must not be escaped
+          if [TrueClass, FalseClass].include?(value.class)
+            "#{key} = #{value}"
+          else
+            "#{key} #{comparator} #{value.to_s.dump}"
+          end
+        end
+
+        query("#{object} {#{filters.join(' and ')}}")
+      end
+    end
+  end
+end

data/lib/puppetdb/model/fact.rb

@@ -0,0 +1,35 @@
+module PuppetDB
+  module Model
+    # Parses fact_contents from PuppetDB
+    #
+    # All attributes retreived from the puppetdb be added as getter to the object
+    class Fact < Base
+      attr_reader :name
+
+      def initialize(attributes)
+        super(**attributes)
+        self.name = attributes[:name]
+      end
+
+      # set the name of the fact
+      #
+      # @param name [String] accepts fact name where subfacts can be separated by period(.)
+      def name=(name)
+        @path ||= name.split('.')
+        @name = name
+      end
+
+      # gets the value for the fact and certname combination
+      #
+      # The value of value is lazy loaded on call and saved in the object
+      def value
+        pql = "fact_contents[value] { certname = '#{certname}' and path = #{@path}}"
+        @value ||= self.class.request(pql).first.values
+      end
+
+      def to_s
+        value
+      end
+    end
+  end
+end

data/lib/puppetdb/model/inventory.rb

@@ -0,0 +1,20 @@
+module PuppetDB
+  module Model
+    class Inventory < Base
+
+      # Get object from Puppet DB
+      #
+      # Pass a list of key: val arguments as filters for the query.
+      #
+      # @param regexp [Boolean] Set this to true for regular expression matching
+      #
+      # @example Get by certname
+      #   PuppetDB::Model::Resource.get(certname: 'daho.im')
+      # @example Regexp search in title
+      #   PuppetDB::Model::Resource.get(title: '^foo.*bar', regexp: true)
+      def self.get(**arguments)
+        super object: 'inventory', **arguments
+      end
+    end
+  end
+end

data/lib/puppetdb/model/node.rb

@@ -0,0 +1,113 @@
+module PuppetDB
+  module Model
+    # Parses Nodes from Puppetdb
+    #
+    # All attributes returned by for the node from the puppetdb will be added as getter to the object
+    #
+    # @example print uptime for hardware
+    #   servers =  PuppetDB::Model::Node.all_hardware_servers.each do |server|
+    #     puts server.certname
+    #     puts server.uptime
+    #   end
+    #
+    # @example get nodes by fact
+    #   PuppetDB::Model::Node.by_fact({'custom_fact' => 'FooBar'}).each do |server|
+    #     puts server.certname
+    #   end
+    class Node < Base
+
+      # parses the data returned by a puppetdb query of 'node' objects and parses it
+      # @param attributes The data returned by a PuppetDB query
+      def initialize(attributes)
+        @facts = {}
+        attributes[:environment] = attributes[:catalog_environment]
+        super(attributes)
+      end
+
+      # Get object from Puppet DB
+      #
+      # Pass a list of key: val arguments as filters for the query.
+      #
+      # @param regexp [Boolean] Set this to true for regular expression matching
+      #
+      # @example Get nodes in environment
+      #   PuppetDB::Model::Nodes.get(report_environment: production)
+      #
+      # @example Regexp search in title
+      #   PuppetDB::Model::Node.get(title: '^foo.*bar', regexp: true)
+      def self.get(**arguments)
+        super object: 'nodes', **arguments
+      end
+
+      # get nodes by name
+      #
+      # @param fqdn [String] FQDN to search
+      # @param regexp [Boolean] Defines if the matching is done with regexp. Default : False
+      def by_name(fqdn, regexp: false)
+        # use strict comparator by default, because this is less performance intensive
+        comparator = regexp ? '~' : '='
+
+        query("node { certname #{comparator} #{fqdn.dump}}")
+      end
+
+      # get nodes with a specific class
+      #
+      # @param classname [String] The name of the Class to search the Nodes
+      # @example Nodes with 'Environment' class loaded
+      #   PuppetDB::Model::Node.by_class('Environment').each do |server|
+      #     puts server.uptime
+      #   end
+      def self.by_class(classname)
+        query("nodes { resources { type = 'Class' and title = #{classname.dump} }}")
+      end
+
+      # get nodes by matching facts
+      #
+      # @param facts [Hash] name value pair for matching facts. Subfacts can be separated by period(.)
+      # @param regexp [Boolean] Defines if the matching is done with regexp. Default : False
+      def self.by_fact(facts, regexp: false)
+        # use strict comparator by default, because this is less performance intensive
+        comparator = regexp ? '~' : '='
+
+        filters = facts.map do |key, value|
+          # Boolean values doesn't support regexp operator(~) and must not be escaped
+          if [TrueClass, FalseClass].include?(value.class)
+            "facts.#{key} = #{value}"
+          else
+            "facts.#{key} #{comparator} #{value.to_s.dump}"
+          end
+        end
+
+        query("nodes { inventory { #{filters.join(' and ')} }}")
+      end
+
+      # get all hardware servers
+      def self.all_hardware_servers
+        query("nodes { inventory { facts.virtual = 'physical'  and facts.dmi.chassis.type != 'Desktop' }}")
+      end
+
+      # get all nodes
+      def self.all
+        query('nodes {}')
+      end
+
+      # get a fact associated with this node
+      #
+      # @example get dmi info from host
+      #   Bios = PuppetDB::Model::Node.by_name.fact('dmi.bios.).value
+      def fact(name)
+        @facts[name] ||= Fact.new(certname: certname, name: name)
+      end
+
+      # get the bios version
+      def bios_version
+        fact('dmi.bios.version').value
+      end
+
+      # get the uptime
+      def uptime
+        fact('system_uptime.uptime').value
+      end
+    end
+  end
+end

data/lib/puppetdb/model/resource.rb

@@ -0,0 +1,20 @@
+module PuppetDB
+  module Model
+    class Resource < Base
+      # Get object from Puppet DB
+      #
+      # Pass a list of key: val arguments as filters for the query.
+      #
+      # @param regexp [Boolean] Set this to true for regular expression matching
+      #
+      # @example Get exported Resources
+      #   PuppetDB::Model::Resource.get(exported: true)
+      #
+      # @example Regexp search in title
+      #   PuppetDB::Model::Resource.get(title: '^foo.*bar', regexp: true)
+      def self.get(**arguments)
+        super object: 'resources', **arguments
+      end
+    end
+  end
+end

data/lib/puppetdb/model/version.rb

@@ -0,0 +1,5 @@
+module PuppetDB
+  module Model
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/puppetdb/model.rb

@@ -0,0 +1,5 @@
+require 'puppetdb/model/base'
+require 'puppetdb/model/node'
+require 'puppetdb/model/fact'
+require 'puppetdb/model/inventory'
+require 'puppetdb/model/resource'

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: puppetdb-model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Moritz Kraus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-10-06 00:00:00.000000000 Z
+dependencies: []
+description: Provides objects for PuppetDB
+email: moritz.kraus@makandra.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/puppetdb/model.rb
+- lib/puppetdb/model/base.rb
+- lib/puppetdb/model/fact.rb
+- lib/puppetdb/model/inventory.rb
+- lib/puppetdb/model/node.rb
+- lib/puppetdb/model/resource.rb
+- lib/puppetdb/model/version.rb
+homepage: https://makandra.com
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+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.3.7
+signing_key: 
+specification_version: 4
+summary: Provides objects for PuppetDB
+test_files: []