huck 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e205a66c535c1083e677ee4c21216c82a7e1871
+  data.tar.gz: 35f2101dd7b4bf04061a5551f10359d7c28ecfb5
+SHA512:
+  metadata.gz: 9290fec08bc1f3f37ebab767daaa3b6c216eb8c5599d7287c86dfcc92e883342a0773cab1da1f2a8bdeb43645bc3cfc158a68184d068557a3d2b537467aa7464
+  data.tar.gz: 13fe443bd3e52143a0c9da1925ea104306335f3391a2ac96a52331b0f62a2e3da6c2b7f9c0090462f1469604bf7e447c9392d2ef27a24158b81dd4ce888243ff

data/lib/huck/generator.rb

@@ -0,0 +1,57 @@
+module Huck
+
+  class Generator
+
+    # This method will call the generation method, and return the data in the
+    # desired format.
+    def dump kwargs = {}
+      format = Huck::getarg kwargs, :format, 'json'
+      data = generate
+      if !data.is_a? Hash
+        raise RuntimeError, 'cannot handle non-hash data'
+      end
+
+      case format
+      when 'json'
+        return JSON.dump data
+      when 'yaml'
+        return YAML.dump data
+      else
+        raise RuntimeError, "unknown format '#{format}'"
+      end
+    end
+
+    # Given a generator's name (or no name), return a new generator instance
+    #
+    # == Parameters:
+    # name::
+    #   The name of the generator, or empty/nil to guess
+    #
+    # == Returns:
+    # A Huck::Generator instance
+    #
+    def self.factory name
+      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
+
+      case name
+      when 'facter'
+        gen = Generators::FacterGenerator.new
+      when 'ohai'
+        gen = Generators::OhaiGenerator.new
+      else
+        raise RuntimeError, "bad generator: #{name}"
+      end
+
+      return gen
+    end
+
+  end
+end

data/lib/huck/generators/facter.rb

@@ -0,0 +1,23 @@
+module Huck
+
+  module Generators
+
+    # Facter provider for generating consumeable data
+    class FacterGenerator < Generator
+
+      # Load required modules for facter generator
+      def initialize
+        require 'facter'
+      end
+
+      # This method generates the data and returns it as a hash
+      #
+      # == Returns:
+      # A hash of facts as returned by facter
+      def generate
+        Facter.to_hash
+      end
+
+    end
+  end
+end

data/lib/huck/generators/ohai.rb

@@ -0,0 +1,29 @@
+module Huck
+
+  module Generators
+
+    # Ohai provider for generating consumeable data
+    class OhaiGenerator < Generator
+
+      # Load required modules for ohai generator
+      def initialize
+        require 'ohai/system'
+      end
+
+      # This method generates the data and returns it as a hash
+      #
+      # == Returns
+      # A hash of hints as returned by ohai
+      def generate
+        ohai = Ohai::System.new
+        ohai.all_plugins
+
+        # Need to load the JSON output, since ohai emits a 'mash' object map
+        # instead of normal hashes, making serialization ugly in some cases
+        # like YAML where canonical objects (eg. !ruby/mash) is emitted.
+        JSON.load ohai.json_pretty_print
+      end
+
+    end
+  end
+end

data/lib/huck/handler.rb

@@ -0,0 +1,29 @@
+module Huck
+
+  # Base handler class
+  class Handler
+
+    # Given a handler's name (or no name), return a new handler instance
+    #
+    # == Parameters:
+    # name::
+    #   The name of the handler, or nil to guess
+    #
+    # == Returns:
+    # A Huck::Handler instance
+    #
+    def self.factory name
+      name = 'exec' if name.nil?
+
+      case name
+      when 'exec'
+        hand = Handlers::ExecHandler.new
+      else
+        raise RuntimeError, "bad handler: #{name}"
+      end
+
+      return hand
+    end
+
+  end
+end

data/lib/huck/handlers/exec.rb

@@ -0,0 +1,41 @@
+module Huck
+
+  module Handlers
+
+    # A handler to execute arbitrary scripts, passing in the generated text as
+    # input on stdin.
+    class ExecHandler < Handler
+
+      def initialize
+        require 'open3'
+      end
+
+      # Ensures that configuration is set properly before executing
+      #
+      # == Parameters:
+      # config::
+      #   A hash of configuration data to verify
+      #
+      def verify_config config
+        if !config.has_key? 'exec'
+          raise RuntimeError, 'missing exec config'
+        end
+        if !config['exec'].has_key? 'command'
+          raise RuntimeError, 'missing exec config: command'
+        end
+      end
+
+      # Handle an individual message by running an executable, passing in the
+      # gathered data via stdin.
+      def handle msg
+        config = Huck::config
+        verify_config config
+
+        Open3.popen2 config['exec']['command'] do |stdin, stdout, thread|
+          stdin.print msg
+        end
+      end
+
+    end
+  end
+end

data/lib/huck/receiver.rb

@@ -0,0 +1,35 @@
+module Huck
+
+  # Base receiver class
+  class Receiver
+
+    # Given a receiver's name (or no name), return a new receiver instance
+    #
+    # == Parameters:
+    # name::
+    #   The name of the receiver, or nil to guess
+    #
+    # == Returns:
+    # A Huck::Receiver instance
+    #
+    def self.factory name
+      if name.nil?
+        if Huck::try_load 'aws-sdk'
+          name = 'sqs'
+        else
+          raise RuntimeError, 'unable to load any receivers'
+        end
+      end
+
+      case name
+      when 'sqs'
+        recv = Receivers::SQSReceiver.new
+      else
+        raise RuntimeError, "bad receiver: #{name}"
+      end
+
+      return recv
+    end
+
+  end
+end

data/lib/huck/receivers/sqs.rb

@@ -0,0 +1,52 @@
+module Huck
+
+  module Receivers
+
+    # A receiver that talks to Amazon Simple Queue Service
+    class SQSReceiver < Receiver
+
+      # Includes all required modules for the SQS receiver
+      def initialize
+        require 'aws-sdk'
+      end
+
+      # Ensures that configuration is set properly before trying to use the
+      # connection data to talk to AWS
+      #
+      # == Parameters:
+      # config::
+      #   A hash of configuration data to verify
+      #
+      def verify_config config
+        if !config.has_key? 'sqs'
+          raise RuntimeError, 'missing sqs config'
+        end
+        ['access_key_id', 'secret_access_key', 'region',
+         'queue_name'].each do |key|
+          if !config['sqs'].has_key? key
+            raise RuntimeError, "missing sqs config: #{key}"
+          end
+        end
+      end
+
+      # A long-running poller process which reads messages out of the remote
+      # queue and yields them to higher-order logic.
+      def receive
+        config = Huck::config
+        verify_config config
+
+        sqs = AWS::SQS.new(
+          :access_key_id => config['sqs']['access_key_id'],
+          :secret_access_key => config['sqs']['secret_access_key'],
+          :region => config['sqs']['region']
+        )
+
+        queue = sqs.queues.create config['sqs']['queue_name']
+        queue.poll do |msg|
+          yield msg.body
+        end
+      end
+
+    end
+  end
+end

data/lib/huck/sender.rb

@@ -0,0 +1,35 @@
+module Huck
+
+  # The base sender class
+  class Sender
+
+    # Given a sender's name (or no name), return a new sender instance
+    #
+    # == Parameters:
+    # name::
+    #   The name of the sender, or nil to guess
+    #
+    # == Returns:
+    # A Huck::Sender instance
+    #
+    def self.factory name
+      if name.nil?
+        if Huck::try_load 'aws-sdk'
+          name = 'sqs'
+        else
+          raise RuntimeError, 'unable to load any senders'
+        end
+      end
+
+      case name
+      when 'sqs'
+        send = Senders::SQSSender.new
+      else
+        raise RuntimeError, "bad sender: #{name}"
+      end
+
+      return send
+    end
+
+  end
+end

data/lib/huck/senders/sqs.rb

@@ -0,0 +1,54 @@
+module Huck
+
+  module Senders
+
+    # A sender that talks to Amazon Simple Queue Service
+    class SQSSender < Sender
+
+      # Includes all required modules for the SQS sender
+      def initialize
+        require 'aws-sdk'
+      end
+
+      # Ensures that configuration is set properly before trying to use the
+      # connection data to talk to AWS
+      #
+      # == Parameters:
+      # config::
+      #   A hash of configuration data to verify
+      #
+      def verify_config config
+        if !config.has_key? 'sqs'
+          raise RuntimeError, 'missing sqs sender config'
+        end
+        ['access_key_id', 'secret_access_key', 'region',
+         'queue_name'].each do |key|
+          if !config['sqs'].has_key? key
+            raise RuntimeError, "missing sqs sender config: #{key}"
+          end
+        end
+      end
+
+      # Send an arbitrary text message to the queue for processing
+      #
+      # == Parameters:
+      # msg::
+      #   The arbitrary text data to send
+      #
+      def send msg
+        config = Huck::config
+        verify_config config
+
+        sqs = AWS::SQS.new(
+          :access_key_id => config['sqs']['access_key_id'],
+          :secret_access_key => config['sqs']['secret_access_key'],
+          :region => config['sqs']['region']
+        )
+
+        queue = sqs.queues.create config['sqs']['queue_name']
+        queue.send_message msg
+      end
+
+    end
+  end
+end

data/lib/huck/util.rb

@@ -0,0 +1,52 @@
+module Huck
+
+  # Retrieve the value of an "emulated" kwarg easily
+  #
+  # == Parameters:
+  # args::
+  #   A hash of kwargs
+  # arg::
+  #   The name of the arg desired
+  # default::
+  #   If arg does not exist in args, return this
+  #
+  # == Returns:
+  # The value of the arg, or the default value
+  #
+  def self.getarg args, arg, default
+    return args.has_key?(arg) ? args[arg] : default
+  end
+
+  # Read configuration out of a file on the filesystem.
+  #
+  # == Parameters:
+  # path::
+  #   The path to the config file to read
+  #
+  # == Returns:
+  # A hash containing the configuration
+  #
+  def self.config kwargs = {}
+    path = self.getarg kwargs, 'path', '/etc/huck.conf'
+    YAML.load_file path
+  end
+
+  # Attempts to load a given module by name
+  #
+  # == Parameters:
+  # name::
+  #   The name of the module
+  #
+  # == Returns:
+  # bool
+  #
+  def self.try_load name
+    begin
+      require name
+    rescue LoadError
+      return false
+    end
+    true
+  end
+
+end

data/lib/huck/version.rb

@@ -0,0 +1,3 @@
+module Huck
+  Version = '0.1.0'
+end

data/lib/huck.rb

@@ -0,0 +1,75 @@
+require 'json'
+require 'yaml'
+
+require 'huck/version'
+require 'huck/util'
+require 'huck/generator'
+require 'huck/generators/facter'
+require 'huck/generators/ohai'
+require 'huck/sender'
+require 'huck/senders/sqs'
+require 'huck/receiver'
+require 'huck/receivers/sqs'
+require 'huck/handler'
+require 'huck/handlers/exec'
+
+module Huck
+
+  # Main method to run Huck and dump info
+  #
+  # == Parameters:
+  # generator::
+  #   The name of the generator to use (default=facter)
+  #
+  def self.run kwargs = {}
+    config = Huck::config
+    if config.has_key? 'generator'
+      gen_name = config['generator']
+    end
+
+    gen_arg = Huck::getarg kwargs, :generator, nil
+    gen_name = gen_arg if !gen_arg.nil?
+
+    g = Generator::factory gen_name
+
+    if config.has_key? 'sender'
+      send_name = config['sender']
+    end
+
+    send_arg = Huck::getarg kwargs, :sender, nil
+    send_name = send_arg if !send_arg.nil?
+
+    s = Sender::factory send_name
+    s.send g.dump
+  end
+
+  # Main method to receive messages from a Huck client
+  #
+  # == Parameters:
+  # receiver::
+  #   The receiver to use (default=sqs)
+  #
+  def self.serve kwargs = {}
+    config = Huck::config
+    if config.has_key? 'handler'
+      hand_name = config['handler']
+    end
+
+    hand_arg = Huck::getarg kwargs, :handler, nil
+    hand_name = hand_arg if !hand_arg.nil?
+    h = Handler::factory hand_name
+
+    if config.has_key? 'receiver'
+      recv_name = config['receiver']
+    end
+
+    recv_arg = Huck::getarg kwargs, :receiver, nil
+    recv_name = recv_arg if !recv_arg.nil?
+
+    r = Receiver::factory recv_name
+    r.receive do |msg|
+      h.handle msg
+    end
+  end
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: huck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Uber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: simplecov
+  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: coveralls
+  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'
+description: Open-ended information sharing framework
+email: ru@ryanuber.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/huck/generators/ohai.rb
+- lib/huck/generators/facter.rb
+- lib/huck/senders/sqs.rb
+- lib/huck/receiver.rb
+- lib/huck/sender.rb
+- lib/huck/util.rb
+- lib/huck/generator.rb
+- lib/huck/receivers/sqs.rb
+- lib/huck/handlers/exec.rb
+- lib/huck/version.rb
+- lib/huck/handler.rb
+- lib/huck.rb
+homepage: https://github.com/ryanuber/huck
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '1.8'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Information sharing framework
+test_files: []