huck 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e205a66c535c1083e677ee4c21216c82a7e1871
-  data.tar.gz: 35f2101dd7b4bf04061a5551f10359d7c28ecfb5
+  metadata.gz: a73eb6afba2acf8dd3c721bb47af9255fbdb09aa
+  data.tar.gz: e5967e01e75d5adeecbe7d06863cfea33d1c6241
 SHA512:
-  metadata.gz: 9290fec08bc1f3f37ebab767daaa3b6c216eb8c5599d7287c86dfcc92e883342a0773cab1da1f2a8bdeb43645bc3cfc158a68184d068557a3d2b537467aa7464
-  data.tar.gz: 13fe443bd3e52143a0c9da1925ea104306335f3391a2ac96a52331b0f62a2e3da6c2b7f9c0090462f1469604bf7e447c9392d2ef27a24158b81dd4ce888243ff
+  metadata.gz: dbe365b4814a6050b0386e79a78dd2243ae062432484a92dcce2a92114e2fe663ebc1227513eba270835c407065f733771c0bff0854adbf2cf56394719074604
+  data.tar.gz: 99b9c4a04a7b5513795f6f4cd9f1d74a3e4a8887e5d3b792b89e0e53990decdfcf5fff50ac9a79ad5ccaccf245bf8866a4dc1352913b642dccfefb4cb30e6c36

data/bin/huck

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'huck'
+
+begin
+  options = Hash.new
+  OptionParser.new do |opts|
+    opts.on '-c [path]' do |v|
+      options[:config] = v
+    end
+  end.parse!
+
+  case ARGV[0]
+  when 'run'
+    Huck.run :config => options[:config]
+  when 'serve'
+    Huck.serve :config => options[:config]
+  else
+    puts <<EOF
+Usage: huck <run|serve>
+
+Options:
+  -c  The path to a configuration file
+      Defaults to ~/huck.conf
+EOF
+    exit 1
+  end
+rescue => e
+  puts "Error: #{e}"
+  exit 1
+end
+
+exit 0

data/lib/huck.rb

@@ -6,11 +6,14 @@ require 'huck/util'
 require 'huck/generator'
 require 'huck/generators/facter'
 require 'huck/generators/ohai'
+require 'huck/generators/yaml'
+require 'huck/generators/json'
 require 'huck/sender'
 require 'huck/senders/sqs'
 require 'huck/receiver'
 require 'huck/receivers/sqs'
 require 'huck/handler'
+require 'huck/handlers/echo'
 require 'huck/handlers/exec'
 
 module Huck
@@ -22,24 +25,23 @@ module Huck
   #   The name of the generator to use (default=facter)
   #
   def self.run kwargs = {}
-    config = Huck::config
+    conf_file = Huck::getarg kwargs, :config, nil
+    config = Huck::config :path => conf_file
+
     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
+    g = Generator::factory :name => gen_name, :config => config
 
     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 :name => send_name, :config => config
 
-    s = Sender::factory send_name
     s.send g.dump
   end
 
@@ -50,25 +52,29 @@ module Huck
   #   The receiver to use (default=sqs)
   #
   def self.serve kwargs = {}
-    config = Huck::config
+    conf_file = Huck::getarg kwargs, :config, nil
+    config = Huck::config :path => conf_file
+
     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
+    h = Handler::factory :name => hand_name, :config => config
 
     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 :name => recv_name, :config => config
 
-    r = Receiver::factory recv_name
-    r.receive do |msg|
-      h.handle msg
+    begin
+      r.receive do |msg|
+        h.handle msg
+      end
+    rescue Interrupt, SystemExit
+      return
     end
   end
 

data/lib/huck/generator.rb

@@ -2,6 +2,8 @@ module Huck
 
   class Generator
 
+    attr_accessor :config
+
     # This method will call the generation method, and return the data in the
     # desired format.
     def dump kwargs = {}
@@ -26,11 +28,16 @@ module Huck
     # == Parameters:
     # name::
     #   The name of the generator, or empty/nil to guess
+    # config::
+    #   A configuration hash
     #
     # == Returns:
     # A Huck::Generator instance
     #
-    def self.factory name
+    def self.factory kwargs = {}
+      name = Huck::getarg kwargs, :name, nil
+      config = Huck::getarg kwargs, :config, nil
+
       if name.nil?
         if Huck::try_load 'facter'
           name = 'facter'
@@ -43,14 +50,19 @@ module Huck
 
       case name
       when 'facter'
-        gen = Generators::FacterGenerator.new
+        g = Generators::FacterGenerator.new
       when 'ohai'
-        gen = Generators::OhaiGenerator.new
+        g = Generators::OhaiGenerator.new
+      when 'yaml'
+        g = Generators::YamlGenerator.new
+      when 'json'
+        g = Generators::JsonGenerator.new
       else
         raise RuntimeError, "bad generator: #{name}"
       end
 
-      return gen
+      g.config = config
+      return g
     end
 
   end

data/lib/huck/generators/json.rb

@@ -0,0 +1,34 @@
+module Huck
+
+  module Generators
+
+    # JSON generator reads json files for data
+    class JsonGenerator < Generator
+
+      # Load required modules for json generator
+      def initialize
+        require 'json'
+      end
+
+      # Ensure that all JSON config items are properly set
+      def verify_config
+        if !@config.has_key? 'json'
+          raise RuntimeError, 'missing json config'
+        end
+        if !@config['json'].has_key? 'file'
+          raise RuntimeError, 'missing json config: file'
+        end
+      end
+
+      # Reads in a configured JSON file and returns the data
+      #
+      # == Returns:
+      # A hash of facts read from the JSON file
+      def generate
+        verify_config
+        JSON.load IO.read(@config['json']['file'])
+      end
+
+    end
+  end
+end

data/lib/huck/generators/yaml.rb

@@ -0,0 +1,34 @@
+module Huck
+
+  module Generators
+
+    # YAML generator reads yaml files for data
+    class YamlGenerator < Generator
+
+      # Load required modules for yaml generator
+      def initialize
+        require 'yaml'
+      end
+
+      # Ensure that all YAML config items are properly set
+      def verify_config
+        if !@config.has_key? 'yaml'
+          raise RuntimeError, 'missing yaml config'
+        end
+        if !@config['yaml'].has_key? 'file'
+          raise RuntimeError, 'missing yaml config: file'
+        end
+      end
+
+      # Reads in a configured YAML file and returns the data
+      #
+      # == Returns:
+      # A hash of facts read from the YAML file
+      def generate
+        verify_config
+        YAML.load_file @config['yaml']['file']
+      end
+
+    end
+  end
+end

data/lib/huck/handler.rb

@@ -2,27 +2,36 @@ module Huck
 
   # Base handler class
   class Handler
+    attr_accessor :config
 
     # Given a handler's name (or no name), return a new handler instance
     #
     # == Parameters:
     # name::
     #   The name of the handler, or nil to guess
+    # config::
+    #   A configuration hash
     #
     # == Returns:
     # A Huck::Handler instance
     #
-    def self.factory name
-      name = 'exec' if name.nil?
+    def self.factory kwargs = {}
+      name = Huck::getarg kwargs, :name, nil
+      config = Huck::getarg kwargs, :config, nil
+
+      name = 'echo' if name.nil?
 
       case name
+      when 'echo'
+        h = Handlers::EchoHandler.new
       when 'exec'
-        hand = Handlers::ExecHandler.new
+        h = Handlers::ExecHandler.new
       else
         raise RuntimeError, "bad handler: #{name}"
       end
 
-      return hand
+      h.config = config
+      return h
     end
 
   end

data/lib/huck/handlers/echo.rb

@@ -0,0 +1,15 @@
+module Huck
+
+  module Handlers
+
+    # The most basic handler to echo messages to stdout
+    class EchoHandler < Handler
+
+      # Handles a message by printing it
+      def handle msg
+        puts msg
+      end
+
+    end
+  end
+end

data/lib/huck/handlers/exec.rb

@@ -6,21 +6,17 @@ module Huck
     # input on stdin.
     class ExecHandler < Handler
 
+      # Includes all required modules
       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'
+      def verify_config
+        if !@config.has_key? 'exec'
           raise RuntimeError, 'missing exec config'
         end
-        if !config['exec'].has_key? 'command'
+        if !@config['exec'].has_key? 'command'
           raise RuntimeError, 'missing exec config: command'
         end
       end
@@ -28,10 +24,9 @@ module Huck
       # Handle an individual message by running an executable, passing in the
       # gathered data via stdin.
       def handle msg
-        config = Huck::config
-        verify_config config
+        verify_config
 
-        Open3.popen2 config['exec']['command'] do |stdin, stdout, thread|
+        Open3.popen2 @config['exec']['command'] do |stdin, stdout, thread|
           stdin.print msg
         end
       end

data/lib/huck/receiver.rb

@@ -2,17 +2,23 @@ module Huck
 
   # Base receiver class
   class Receiver
+    attr_accessor :config
 
     # Given a receiver's name (or no name), return a new receiver instance
     #
     # == Parameters:
     # name::
     #   The name of the receiver, or nil to guess
+    # config::
+    #   A configuration hash
     #
     # == Returns:
     # A Huck::Receiver instance
     #
-    def self.factory name
+    def self.factory kwargs = {}
+      name = Huck::getarg kwargs, :name, nil
+      config = Huck::getarg kwargs, :config, nil
+
       if name.nil?
         if Huck::try_load 'aws-sdk'
           name = 'sqs'
@@ -23,12 +29,13 @@ module Huck
 
       case name
       when 'sqs'
-        recv = Receivers::SQSReceiver.new
+        r = Receivers::SQSReceiver.new
       else
         raise RuntimeError, "bad receiver: #{name}"
       end
 
-      return recv
+      r.config = config
+      return r
     end
 
   end

data/lib/huck/receivers/sqs.rb

@@ -12,18 +12,13 @@ module Huck
 
       # 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'
+      def verify_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
+          if !@config['sqs'].has_key? key
             raise RuntimeError, "missing sqs config: #{key}"
           end
         end
@@ -32,16 +27,15 @@ module Huck
       # 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
+        verify_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']
+          :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 = sqs.queues.create @config['sqs']['queue_name']
         queue.poll do |msg|
           yield msg.body
         end

data/lib/huck/sender.rb

@@ -2,17 +2,23 @@ module Huck
 
   # The base sender class
   class Sender
+    attr_accessor :config
 
     # Given a sender's name (or no name), return a new sender instance
     #
     # == Parameters:
     # name::
     #   The name of the sender, or nil to guess
+    # config::
+    #   A configuration hash
     #
     # == Returns:
     # A Huck::Sender instance
     #
-    def self.factory name
+    def self.factory kwargs = {}
+      name = Huck::getarg kwargs, :name, nil
+      config = Huck::getarg kwargs, :config, nil
+
       if name.nil?
         if Huck::try_load 'aws-sdk'
           name = 'sqs'
@@ -23,12 +29,13 @@ module Huck
 
       case name
       when 'sqs'
-        send = Senders::SQSSender.new
+        s = Senders::SQSSender.new
       else
         raise RuntimeError, "bad sender: #{name}"
       end
 
-      return send
+      s.config = config
+      return s
     end
 
   end

data/lib/huck/senders/sqs.rb

@@ -12,18 +12,13 @@ module Huck
 
       # 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'
+      def verify_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
+          if !@config['sqs'].has_key? key
             raise RuntimeError, "missing sqs sender config: #{key}"
           end
         end
@@ -36,16 +31,15 @@ module Huck
       #   The arbitrary text data to send
       #
       def send msg
-        config = Huck::config
-        verify_config config
+        verify_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']
+          :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 = sqs.queues.create @config['sqs']['queue_name']
         queue.send_message msg
       end
 

data/lib/huck/util.rb

@@ -27,7 +27,8 @@ module Huck
   # A hash containing the configuration
   #
   def self.config kwargs = {}
-    path = self.getarg kwargs, 'path', '/etc/huck.conf'
+    path = self.getarg kwargs, :path, nil
+    path = File.join(Dir.home, 'huck.conf') if path.nil?
     YAML.load_file path
   end
 

data/lib/huck/version.rb

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

data/spec/huck/huck_spec.rb

@@ -0,0 +1,9 @@
+require 'huck'
+require 'aws-sdk'
+#AWS::Stub!
+
+describe 'Running Huck Client' do
+  it 'should run the client without errors' do
+    Huck.run
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huck
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryan Uber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,28 +52,17 @@ dependencies:
     - - '>='
       - !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: []
+executables:
+- huck
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/huck/generators/ohai.rb
 - lib/huck/generators/facter.rb
+- lib/huck/generators/yaml.rb
+- lib/huck/generators/json.rb
 - lib/huck/senders/sqs.rb
 - lib/huck/receiver.rb
 - lib/huck/sender.rb
@@ -81,9 +70,12 @@ files:
 - lib/huck/generator.rb
 - lib/huck/receivers/sqs.rb
 - lib/huck/handlers/exec.rb
+- lib/huck/handlers/echo.rb
 - lib/huck/version.rb
 - lib/huck/handler.rb
 - lib/huck.rb
+- bin/huck
+- spec/huck/huck_spec.rb
 homepage: https://github.com/ryanuber/huck
 licenses:
 - MIT
@@ -108,4 +100,5 @@ rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Information sharing framework
-test_files: []
+test_files:
+- spec/huck/huck_spec.rb