huck 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a73eb6afba2acf8dd3c721bb47af9255fbdb09aa
-  data.tar.gz: e5967e01e75d5adeecbe7d06863cfea33d1c6241
+  metadata.gz: a79a3c9c263d302401491186d5ab0bd97a3ce51c
+  data.tar.gz: 600ea4d99d5c905796abbe425060e27e43cba421
 SHA512:
-  metadata.gz: dbe365b4814a6050b0386e79a78dd2243ae062432484a92dcce2a92114e2fe663ebc1227513eba270835c407065f733771c0bff0854adbf2cf56394719074604
-  data.tar.gz: 99b9c4a04a7b5513795f6f4cd9f1d74a3e4a8887e5d3b792b89e0e53990decdfcf5fff50ac9a79ad5ccaccf245bf8866a4dc1352913b642dccfefb4cb30e6c36
+  metadata.gz: d96f236417d31c5af714c20814cf95f3a11a8b266b68f8f879464218af21df3957fd3af53dab536079ff2865d023da3e9f6489f5b1525064c63569e82bb69379
+  data.tar.gz: ca82f5ca5ddd75d8c4a67e6cb45e9e059a01e9ad5055bcd4d562183889a81f02824e942c198f86e8de891a7c802fe53468c500450920c06e76a7e8bf76791533

data/lib/huck.rb

@@ -4,6 +4,7 @@ require 'yaml'
 require 'huck/version'
 require 'huck/util'
 require 'huck/generator'
+require 'huck/generators/basic'
 require 'huck/generators/facter'
 require 'huck/generators/ohai'
 require 'huck/generators/yaml'
@@ -21,8 +22,12 @@ module Huck
   # Main method to run Huck and dump info
   #
   # == Parameters:
+  # config::
+  #   Configuration file path
   # generator::
-  #   The name of the generator to use (default=facter)
+  #   The name of the generator to use
+  # sender::
+  #   The name of the sender to use
   #
   def self.run kwargs = {}
     conf_file = Huck::getarg kwargs, :config, nil

data/lib/huck/generator.rb

@@ -6,6 +6,14 @@ module Huck
 
     # This method will call the generation method, and return the data in the
     # desired format.
+    #
+    # == Parameters:
+    # format::
+    #   The serialization format (json or yaml)
+    #
+    # == Returns:
+    # A string of serialized text
+    #
     def dump kwargs = {}
       format = Huck::getarg kwargs, :format, 'json'
       data = generate
@@ -27,7 +35,7 @@ module Huck
     #
     # == Parameters:
     # name::
-    #   The name of the generator, or empty/nil to guess
+    #   The name of the generator
     # config::
     #   A configuration hash
     #
@@ -38,17 +46,11 @@ module Huck
       name = Huck::getarg kwargs, :name, nil
       config = Huck::getarg kwargs, :config, nil
 
-      if name.nil?
-        if Huck::try_load 'facter'
-          name = 'facter'
-        elsif Huck::try_load 'ohai'
-          name = 'ohai'
-        else
-          raise RuntimeError, 'unable to load any generators'
-        end
-      end
+      name = 'basic' if name.nil?
 
       case name
+      when 'basic'
+        g = Generators::BasicGenerator.new
       when 'facter'
         g = Generators::FacterGenerator.new
       when 'ohai'

data/lib/huck/generators/basic.rb

@@ -0,0 +1,25 @@
+module Huck
+
+  module Generators
+
+    # A very basic host info generator
+    class BasicGenerator < Generator
+
+      # Include required modules
+      def initialize
+        Huck::must_load 'socket'
+      end
+
+      # Generates bare minimum useful information
+      #
+      # == Returns:
+      # A hash of host information
+      #
+      def generate
+        {'hostname' => Socket.gethostname,
+         'platform' => RUBY_PLATFORM}
+      end
+
+    end
+  end
+end

data/lib/huck/generators/facter.rb

@@ -7,13 +7,14 @@ module Huck
 
       # Load required modules for facter generator
       def initialize
-        require 'facter'
+        Huck::must_load 'facter'
       end
 
-      # This method generates the data and returns it as a hash
+      # Generate data using facter
       #
       # == Returns:
       # A hash of facts as returned by facter
+      #
       def generate
         Facter.to_hash
       end

data/lib/huck/generators/json.rb

@@ -7,7 +7,7 @@ module Huck
 
       # Load required modules for json generator
       def initialize
-        require 'json'
+        Huck::must_load 'json'
       end
 
       # Ensure that all JSON config items are properly set
@@ -24,6 +24,7 @@ module Huck
       #
       # == Returns:
       # A hash of facts read from the JSON file
+      #
       def generate
         verify_config
         JSON.load IO.read(@config['json']['file'])

data/lib/huck/generators/ohai.rb

@@ -7,13 +7,14 @@ module Huck
 
       # Load required modules for ohai generator
       def initialize
-        require 'ohai/system'
+        Huck::must_load 'ohai/system'
       end
 
-      # This method generates the data and returns it as a hash
+      # Generate data using ohai
       #
       # == Returns
       # A hash of hints as returned by ohai
+      #
       def generate
         ohai = Ohai::System.new
         ohai.all_plugins

data/lib/huck/generators/yaml.rb

@@ -7,7 +7,7 @@ module Huck
 
       # Load required modules for yaml generator
       def initialize
-        require 'yaml'
+        Huck::must_load 'yaml'
       end
 
       # Ensure that all YAML config items are properly set
@@ -24,6 +24,7 @@ module Huck
       #
       # == Returns:
       # A hash of facts read from the YAML file
+      #
       def generate
         verify_config
         YAML.load_file @config['yaml']['file']

data/lib/huck/handlers/echo.rb

@@ -6,6 +6,11 @@ module Huck
     class EchoHandler < Handler
 
       # Handles a message by printing it
+      #
+      # == Parameters:
+      # msg::
+      #   The message to process
+      #
       def handle msg
         puts msg
       end

data/lib/huck/handlers/exec.rb

@@ -8,7 +8,7 @@ module Huck
 
       # Includes all required modules
       def initialize
-        require 'open3'
+        Huck::must_load 'open3'
       end
 
       # Ensures that configuration is set properly before executing
@@ -23,6 +23,11 @@ module Huck
 
       # Handle an individual message by running an executable, passing in the
       # gathered data via stdin.
+      #
+      # == Parameters:
+      # msg::
+      #   The message to process
+      #
       def handle msg
         verify_config
 

data/lib/huck/receivers/sqs.rb

@@ -7,7 +7,7 @@ module Huck
 
       # Includes all required modules for the SQS receiver
       def initialize
-        require 'aws-sdk'
+        Huck::must_load 'aws-sdk'
       end
 
       # Ensures that configuration is set properly before trying to use the

data/lib/huck/senders/sqs.rb

@@ -7,7 +7,7 @@ module Huck
 
       # Includes all required modules for the SQS sender
       def initialize
-        require 'aws-sdk'
+        Huck::must_load 'aws-sdk'
       end
 
       # Ensures that configuration is set properly before trying to use the
@@ -28,7 +28,7 @@ module Huck
       #
       # == Parameters:
       # msg::
-      #   The arbitrary text data to send
+      #   The message to process
       #
       def send msg
         verify_config

data/lib/huck/util.rb

@@ -50,4 +50,18 @@ module Huck
     true
   end
 
+  # Try to load a module, and raise a RuntimeError if it is not
+  # loadable. This is useful for trying to load certain provider
+  # code at runtime without dealing with LoadError.
+  #
+  # == Parameters:
+  # name::
+  #   The name of the module
+  #
+  def self.must_load name
+    if !self.try_load name
+      raise RuntimeError, "unable to load #{name}"
+    end
+  end
+
 end

data/lib/huck/version.rb

@@ -1,3 +1,3 @@
 module Huck
-  Version = '0.2.0'
+  Version = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: huck
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ryan Uber
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - lib/huck/generators/ohai.rb
 - lib/huck/generators/facter.rb
+- lib/huck/generators/basic.rb
 - lib/huck/generators/yaml.rb
 - lib/huck/generators/json.rb
 - lib/huck/senders/sqs.rb