carnivore 0.1.6 → 0.1.8

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v0.1.8
+* Clean up requires
+* Register sources by name for easy lookup
+* Fix hash symbolizer to not symbolize non-strings
+* Add confirmation helper method to message
+* Start including tests
+
 # v0.1.6
 * Do not register callback if no worker is created
 

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
+gem 'minitest'
+
 gemspec

data/README.md

@@ -19,7 +19,7 @@ stuff gets done. Super simple!
 Carnivore.configure do
   src = Source.build(:type => :test, :args => {})
   src.add_callback(:print_message) do |msg|
-    puts "Received message: #{message}"
+    puts "Received message: #{msg}"
   end
 end.start!
 ```
@@ -70,7 +70,7 @@ Carnivore.configure do
   src = Source.build(:type => :test, :args => {})
   src.add_callback(:print_message) do |msg|
     my_inst.be_awesome!
-    puts "Received message: #{message}"
+    puts "Received message: #{msg}"
   end
 end.start!
 ```
@@ -83,7 +83,7 @@ Carnivore.configure do
   src.add_callback(:print_message) do |msg|
     my_inst = AwesomeSauce.new
     my_inst.be_awesome!
-    puts "Received message: #{message}"
+    puts "Received message: #{msg}"
   end
 end.start!
 ```
@@ -103,7 +103,7 @@ Carnivore.configure do
       @my_inst = AwesomeSauce.new
     end
     @my_inst.be_awesome!
-    puts "Received message: #{message}"
+    puts "Received message: #{msg}"
   end
 end.start!
 ```

data/lib/carnivore/callback.rb

@@ -4,6 +4,7 @@ module Carnivore
   class Callback
 
     class << self
+      # Define number of workers to create
       attr_accessor :workers
     end
 
@@ -21,17 +22,24 @@ module Carnivore
       setup
     end
 
+    # Used by custom callback classes for setup
     def setup
     end
 
+    # Provide nice output when printed
     def inspect
       "callback<#{self.name}:#{self.object_id}>"
     end
+    alias_method :to_s, :inspect
 
+    # message:: Carnivore::Message
+    # Return true if message should be handled by this callback
     def valid?(message)
       true
     end
 
+    # message:: Carnivore::Message
+    # Pass message to registered callbacks
     def call(message)
       if(valid?(message))
         execute(message)

data/lib/carnivore/config.rb

@@ -8,12 +8,16 @@ module Carnivore
 
     class << self
 
+      # args:: configuration hash
+      # Merge provided args into configuration
       def configure(args)
         build(args[:config_path]) if args[:config_path]
         self.merge!(args)
         self
       end
 
+      # path_or_hash:: Path to JSON file or configuration Hash
+      # Populates the configuration
       def build(path_or_hash)
         if(path_or_hash.is_a?(Hash))
           conf = path_or_hash
@@ -31,6 +35,14 @@ module Carnivore
         self
       end
 
+      # ary: keys into a hash
+      # Returns value if exists or nil
+      #  Example:
+      #    Config.build(:my_app => {:port => 30})
+      #    Config.get(:my_app, :port) => 30
+      #    Config.get(:my_app, :host) => nil
+      #    Config.get(:other_app, :port) => nil
+      #    Config.get(:my_app, :mail, :server) => nil
       def get(*ary)
         ary.flatten.inject(self) do |memo, key|
           memo[key.to_s] || memo[key.to_sym] || break

data/lib/carnivore/container.rb

@@ -1,9 +1,10 @@
+require 'carnivore/utils'
 require 'celluloid/logger'
 
 module Carnivore
   class Container < Module
 
-    include Celluloid::Logger
+    include Carnivore::Utils::Logging
 
     class << self
       def log

data/lib/carnivore/message.rb

@@ -1,16 +1,25 @@
+require 'carnivore/source'
+
 module Carnivore
   class Message
 
     attr_reader :args
 
     def initialize(args={})
-      @args = args
+      unless(args[:source])
+        raise ArgumentError.new("A valid `Carnivore::Source` must be provided via `:source`")
+      end
+      @args = args.dup
     end
 
     def [](k)
       @args[k.to_sym] || @args[k.to_s]
     end
 
+    def confirm!
+      self[:source].confirm(self)
+    end
+
     def inspect
       "<Carnivore::Message[#{self.object_id}] @args=#{args}>"
     end

data/lib/carnivore/runner.rb

@@ -1,4 +1,5 @@
 require 'celluloid'
+require 'carnivore/config'
 require 'carnivore/source'
 require 'carnivore/container'
 

data/lib/carnivore/source/sqs.rb

@@ -69,25 +69,39 @@ module Carnivore
         msgs.map{|m| pre_process(m) }
       end
 
-      def transmit(message, dest=nil)
-        case dest
-        when Numeric
-          queue = @queues[dest]
-        when String, Symbol
-          queue = @queues[dest.to_s] || @queues.detect{|q| q.include?(dest.to_s)}
-        else
-          queue = @queues.first
-        end
+      def transmit(message, original=nil)
+        queue = determine_queue(original)
         @fog.send_message(queue, message)
       end
 
       def confirm(message)
-        debug "Source<#{name}> Confirming message<#{message.object_id}>"
-        @fog.delete_message(message['SourceQueue'], message['ReceiptHandle'])
+        queue = determine_queue(message)
+        debug "Source<#{name}> Confirming message<#{message}> on Queue<#{queue}>"
+        m = message.is_a?(Message) ? message[:message] : message
+        @fog.delete_message(queue, m['ReceiptHandle'])
       end
 
       private
 
+      def determine_queue(obj)
+        queue = nil
+        if(obj)
+          if(obj.is_a?(Message))
+            queue = obj[:message]['SourceQueue']
+          else
+            case obj
+            when Numeric
+              queue = @queues[dest]
+            when String, Symbol
+              queue = @queues[dest.to_s] || queues.detect{|q| q.end_with?(dest.to_s)}
+            when Hash
+              queue = obj['SourceQueue']
+            end
+          end
+        end
+        queue || queues.first
+      end
+
       def queues
         if(@processable_queues)
           @queues.map do |k,v|

data/lib/carnivore/source/test.rb

@@ -10,7 +10,7 @@ module Carnivore
       end
 
       def connect(*args)
-        puts 'Test connect called'
+        info 'Test connect called'
       end
 
       def receive(*args)
@@ -23,7 +23,7 @@ module Carnivore
       end
 
       def transmit(message)
-        puts "Transmit requested: #{message}"
+        info "Transmit requested: #{message}"
       end
 
     end

data/lib/carnivore/source.rb

@@ -1,21 +1,27 @@
+require 'celluloid'
 require 'carnivore/utils'
 require 'carnivore/callback'
 require 'carnivore/message'
 
 module Carnivore
-  class Source < Celluloid::SupervisionGroup
+  class Source
 
     class SourceContainer
 
       attr_reader :klass
       attr_reader :source_hash
 
+      # class_name:: Name of source class
+      # args:: argument hash to pass to source instance
       def initialize(class_name, args={})
         @klass = class_name
         @source_hash = args || {}
         @source_hash[:callbacks] = {}
       end
 
+      # name:: Name of callback
+      # klass:: Class of callback (optional)
+      # Add a callback to a source via Class or block
       def add_callback(name, klass=nil, &block)
         @source_hash[:callbacks][name] = klass || block
       end
@@ -23,29 +29,58 @@ module Carnivore
 
     class << self
 
+      # args:: Hash
+      #  :type -> Source type
+      #  :args -> arguments for `Source` instance
+      # Builds a source container of `:type`
       def build(args={})
         [:args, :type].each do |key|
           unless(args.has_key?(key))
             raise ArgumentError.new "Missing required parameter `:#{key}`"
           end
         end
-        require "carnivore/source/#{args[:type]}"
+        require Source.require_path(args[:type]) || "carnivore/source/#{args[:type]}"
         klass = args[:type].to_s.split('_').map(&:capitalize).join
         klass = Source.const_get(klass)
         args[:args][:name] ||= Celluloid.uuid
         inst = SourceContainer.new(klass, args[:args])
-        register(inst)
+        register(args[:args][:name], inst)
         inst
       end
 
-      def register(inst)
-        @sources ||= []
-        @sources << inst
+      def provide(type, require_path)
+        @source_klass ||= {}
+        @source_klass[type.to_sym] = require_path
         true
       end
 
+      def require_path(type)
+        @source_klass ||= {}
+        @source_klass[type.to_sym]
+      end
+
+      # name:: Name of source
+      # inst:: SourceContainer
+      # Register the container
+      def register(name, inst)
+        @sources ||= {}
+        @sources[name.to_sym] = inst
+        true
+      end
+
+      # name:: Name of registered source
+      # Return source container
+      def source(name)
+        if(@sources && @sources[name.to_sym])
+          @sources[name.to_sym]
+        else
+          raise KeyError.new("Requested named source is not registered: #{name}")
+        end
+      end
+
+      # Registered containers
       def sources
-        @sources || []
+        @sources ? @sources.values : []
       end
     end
 
@@ -61,10 +96,10 @@ module Carnivore
     def initialize(args={})
       @callbacks = []
       @callback_names = {}
-      @auto_process = true
+      @auto_process = args.fetch(:auto_process, true)
+      @auto_confirm = !!args[:auto_confirm]
       @callback_supervisor = Celluloid::SupervisionGroup.run!
       @name = args[:name] || Celluloid.uuid
-      @auto_confirm = !!args[:auto_confirm]
       if(args[:callbacks])
         args[:callbacks].each do |name, block|
           add_callback(name, block)
@@ -102,14 +137,16 @@ module Carnivore
       raise NoMethodError.new('Abstract method not valid for runtime')
     end
 
-    def transmit(message)
+    def transmit(message, original_message, args={})
       raise NoMethodError.new('Abstract method not valid for runtime')
     end
 
+    def confirm(message)
+      debug 'No custom confirm declared'
+    end
+
     def terminate
-      if(@callback_supervisor)
-        @callback_supervisor.actors.map(&:terminate)
-      end
+      @callback_supervisor.finalize
     end
 
     def add_callback(name, block_or_class)

data/lib/carnivore/utils.rb

@@ -1,3 +1,5 @@
+require 'celluloid'
+
 module Carnivore
   module Utils
 
@@ -5,8 +7,13 @@ module Carnivore
       def symbolize_hash(hash)
         Hash[*(
             hash.map do |k,v|
+              if(k.is_a?(String))
+                key = k.gsub(/(?<![A-Z])([A-Z])/, '_\1').sub(/^_/, '').downcase.to_sym
+              else
+                key = k
+              end
               [
-                k.gsub(/(?<![A-Z])([A-Z])/, '_\1').sub(/^_/, '').downcase.to_sym,
+                key,
                 v.is_a?(Hash) ? symbolize_hash(v) : v
               ]
             end.flatten(1)

data/lib/carnivore/version.rb

@@ -1,5 +1,5 @@
 module Carnivore
   class Version < Gem::Version
   end
-  VERSION = Version.new('0.1.6')
+  VERSION = Version.new('0.1.8')
 end

data/test/spec.rb

@@ -0,0 +1,11 @@
+require 'celluloid'
+Celluloid.logger.level = 4
+
+Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), 'specs/*.rb')).each do |path|
+  require path
+end
+
+MiniTest::Spec.before do
+  Celluloid.shutdown
+  Celluloid.boot
+end

data/test/specs/config.rb

@@ -0,0 +1,31 @@
+require 'minitest/autorun'
+require 'carnivore/config'
+
+describe 'Carnivore::Config' do
+  describe 'Direct Configuration' do
+    it 'allows direct configuration set' do
+      Carnivore::Config[:direct] = true
+      Carnivore::Config[:direct].must_equal true
+    end
+
+    it 'returns nil when configuration is undefined' do
+      Carnivore::Config[:missing].must_be_nil
+    end
+
+    it 'raises exception when accessing nested keys that do not exist' do
+      -> { Carnivore::Config[:missing][:key] }.must_raise NoMethodError
+    end
+
+  end
+
+  describe '#get helper' do
+    it 'returns the nested configuration value' do
+      Carnivore::Config[:nested] = {:value => 'hello world'}
+      Carnivore::Config.get(:nested, :value).must_equal 'hello world'
+    end
+
+    it 'returns `nil` when nested configuration does not exist' do
+      Carnivore::Config.get(:value, :does, :not, :exist).must_be_nil
+    end
+  end
+end

data/test/specs/container.rb

@@ -0,0 +1,13 @@
+require 'minitest/autorun'
+require 'carnivore/container'
+
+describe 'Carnivore::Container' do
+  it 'provides logging helpers' do
+    c = Carnivore::Container.new
+    Carnivore::Container.must_respond_to :log
+    c.must_respond_to :log
+    %w(debug info warn error).each do |key|
+      c.must_respond_to key
+    end
+  end
+end

data/test/specs/message.rb

@@ -0,0 +1,29 @@
+require 'minitest/autorun'
+require 'carnivore/message'
+
+describe 'Carnivore::Message' do
+
+  it 'requires a Source to be provided' do
+    -> { Carnivore::Message.new(:message => 'hi') }.must_raise ArgumentError
+  end
+
+  it 'provides argument access via `[]`' do
+    message = Carnivore::Message.new(:source => true, :message => 'hi')
+    message[:source].must_equal true
+    message[:message].must_equal 'hi'
+  end
+
+  it 'provides direct argument hash access via `args`' do
+    message = Carnivore::Message.new(:source => true, :message => 'hi')
+    message.args.must_be_kind_of Hash
+  end
+
+  it 'provides `confirm!` confirmation helper to Source' do
+    source = MiniTest::Mock.new
+    message = Carnivore::Message.new(:source => source, :message => 'hi')
+    source.expect(:confirm, true, [message])
+    message.confirm!
+    source.verify
+  end
+
+end

data/test/specs/source.rb

@@ -0,0 +1,82 @@
+require 'minitest/autorun'
+require 'carnivore/source'
+
+describe 'Carnivore::Source' do
+  describe 'Carnivore::Source::SourceContainer' do
+    before do
+      @src_ctn = Carnivore::Source::SourceContainer.new(:my_name, {:arg1 => true})
+    end
+
+    it 'should store name in `klass` attribute' do
+      @src_ctn.klass.must_equal :my_name
+    end
+
+    it 'should store argument hash in `source_hash` attribute' do
+      @src_ctn.source_hash.must_equal :arg1 => true, :callbacks => {}
+    end
+
+    describe 'callback additions' do
+      before do
+        @block = lambda{ 'hi' }
+        @src_ctn.add_callback(:hi, &@block)
+      end
+
+      it 'should store callback by name in `source_hash` under `:callbacks`' do
+        @src_ctn.source_hash.keys.must_include :callbacks
+        @src_ctn.source_hash[:callbacks].keys.must_include :hi
+        @src_ctn.source_hash[:callbacks].values.must_include @block
+      end
+    end
+  end
+
+  describe 'Custom source providers' do
+
+    before do
+      Carnivore::Source.provide(:meat_bag, 'carnivore-meat-bag/meat_bag')
+    end
+
+    it 'gives expected require path if registered' do
+      Carnivore::Source.require_path(:meat_bag).must_equal 'carnivore-meat-bag/meat_bag'
+    end
+
+    it 'gives `nil` require path if not registered' do
+      Carnivore::Source.require_path(:test).must_be_nil
+    end
+  end
+
+  describe 'Source registration' do
+    before do
+      @inst = Object.new
+      Carnivore::Source.register(:my_source, @inst)
+    end
+
+    it 'provides list of registered sources' do
+      Carnivore::Source.sources.must_include @inst
+    end
+
+    it 'allows accessing registered source by name' do
+      Carnivore::Source.source(:my_source).must_equal @inst
+    end
+  end
+
+  describe 'Processing with base Source instance' do
+    it 'should raise an exception' do
+      -> {
+        Carnivore::Source.new(:auto_process => false).process
+      }.must_raise NoMethodError
+    end
+  end
+
+  describe 'Source test instance' do
+    describe 'with no name argument' do
+      before do
+        require 'carnivore/source/test'
+        @source = Carnivore::Source::Test.new
+      end
+
+      it 'should generate name if none provided' do
+        @source.name.wont_be :empty?
+      end
+    end
+  end
+end

data/test/specs/utils.rb

@@ -0,0 +1,47 @@
+require 'minitest/autorun'
+require 'carnivore/utils'
+
+describe 'Carnivore::Utils' do
+  describe 'Carnivore::Utils::Logging' do
+    before do
+      @obj = Object.new
+      @obj.extend(Carnivore::Utils::Logging)
+      Celluloid.logger.level = 0
+    end
+
+    after do
+      Celluloid.logger.level = 4
+    end
+
+    it 'adds logging methods' do
+      %w(debug info warn error).each do |key|
+        @obj.must_respond_to(key)
+      end
+    end
+
+    it 'includes object information in logging output' do
+      out, err = capture_subprocess_io do
+        @obj.info 'hello world'
+      end
+      err.must_match %r{I,\s*\[.*?\]\s*INFO\s*--\s*:\s*#{Regexp.escape(@obj.inspect)}:\s*hello world\n}
+    end
+  end
+
+  describe 'Carnivore::Utils::Params' do
+    before do
+      @obj = Object.new
+      @obj.extend(Carnivore::Utils::Params)
+    end
+
+    it 'adds `symbolize_hash` method' do
+      @obj.must_respond_to :symbolize_hash
+    end
+
+    it 'converts hash keys to symbols' do
+      h = {'string' => {'another' => {'OneHere' => 'more'}}}
+      converted = @obj.symbolize_hash(h)
+      converted.keys.first.must_equal :string
+      converted[:string][:another].keys.first.must_equal :one_here
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carnivore
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2013-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -111,13 +111,19 @@ files:
 - lib/carnivore/utils.rb
 - lib/carnivore/container.rb
 - lib/carnivore.rb
+- test/spec.rb
+- test/specs/source.rb
+- test/specs/config.rb
+- test/specs/message.rb
+- test/specs/utils.rb
+- test/specs/container.rb
 - examples/test_http.rb
 - examples/test_class.rb
 - examples/test_block.rb
 - Gemfile
 - README.md
+- carnivore-0.1.6.gem
 - CHANGELOG.md
-- Gemfile.lock
 - carnivore.gemspec
 homepage: https://github.com/heavywater/carnivore
 licenses: []

data/Gemfile.lock

@@ -1,64 +0,0 @@
-PATH
-  remote: .
-  specs:
-    carnivore (0.1.0)
-      bunny
-      celluloid
-      fog
-      mixlib-config
-      reel
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    builder (3.2.2)
-    bunny (0.8.0)
-    celluloid (0.15.1)
-      timers (~> 1.1.0)
-    celluloid-io (0.15.0)
-      celluloid (>= 0.15.0)
-      nio4r (>= 0.5.0)
-    certified (0.1.1)
-    excon (0.25.3)
-    fog (1.15.0)
-      builder
-      excon (~> 0.25.0)
-      formatador (~> 0.2.0)
-      mime-types
-      multi_json (~> 1.0)
-      net-scp (~> 1.1)
-      net-ssh (>= 2.1.3)
-      nokogiri (~> 1.5)
-      ruby-hmac
-    formatador (0.2.4)
-    http (0.4.0)
-      certified
-      http_parser.rb
-    http_parser.rb (0.5.3)
-    mime-types (1.25)
-    mini_portile (0.5.1)
-    mixlib-config (1.1.2)
-    multi_json (1.8.0)
-    net-scp (1.1.2)
-      net-ssh (>= 2.6.5)
-    net-ssh (2.6.8)
-    nio4r (0.5.0)
-    nokogiri (1.6.0)
-      mini_portile (~> 0.5.0)
-    rack (1.5.2)
-    reel (0.3.0)
-      celluloid-io (>= 0.8.0)
-      http (>= 0.2.0)
-      http_parser.rb (>= 0.5.3)
-      rack (>= 1.4.0)
-      websocket_parser (>= 0.1.0)
-    ruby-hmac (0.4.0)
-    timers (1.1.0)
-    websocket_parser (0.1.4)
-      http
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  carnivore!