kinetic 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67a4ff614b5f65c94ff43ae5e18e7a73944c13e3
-  data.tar.gz: 41f13ae0b524573c98a63f853d7be3c458c12a96
+  metadata.gz: b7a08f594cae0d5c01c00f340386df7c7788a745
+  data.tar.gz: 280fe43699041a8a233b455887d795b6c47e42f8
 SHA512:
-  metadata.gz: 72ce1e7b862c33785117568f17944f7d40401c158e78e80a3a44e7b865d299ef1c521c24104a81b666397689e069273434be0cbaa553f5fb6f83b7a6411c4625
-  data.tar.gz: 575a3a38d19d22d92125da043f9a065cd18f53d348003f3eda1ac9ef0679476ed636f923bc0a2d722d6c16e3dd08d87df3f18a87f532869463f1f3f50cb8f1be
+  metadata.gz: 65871da55313e959082177229600037b1ffdf5e94b1886bebb525e9099effe4b249fb7b581f54d45ed908fa68eac60e0ce7e44841e96f0738d7ae1fc731a8c3f
+  data.tar.gz: e8452cb376cab92b21796269deff0ac5ab24306099675eca52eeb9d64071cced80ba649e0b6399748f77d113b13e6bdd7f7aecbcf1a4bc1cbf386faa30be73ff

data/.gitignore

@@ -17,3 +17,5 @@ test/version_tmp
 tmp
 .idea/**
 *.iml
+doc/**
+*.pid

data/.travis.yml

@@ -0,0 +1,4 @@
+script: rspec spec
+rvm:
+  - "1.9.3"
+  - "2.0.0"

data/README.md

@@ -1,5 +1,9 @@
 # Kinetic
 
+[<img src="https://secure.travis-ci.org/fugufish/kinetic.png">](http://travis-ci.org/fugufish/kinetic)
+[![Code Climate](https://codeclimate.com/repos/52b06fa413d637197401ebb7/badges/c71d7f47797b4caec5ae/gpa.png)](https://codeclimate.com/repos/52b06fa413d637197401ebb7/feed)
+
+
 Kinetic is an AMQP worker framework designed in vein of microframeworks such as sinatra. Its goal is to provide an
  easy way to configure and run AMQP consumers in order to reduce developer overhead when working with AMQP. Kinetic
  follows the master/worker convention used in Unicorn, and its prefork code is mostly based on that of Unicorn's.

data/kinetic.gemspec

@@ -28,7 +28,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'yard'
 
 
 end

data/lib/kinetic/base.rb

@@ -17,6 +17,8 @@ require_relative '../kinetic/version'
 require_relative '../kinetic/configuration'
 require_relative '../kinetic/master'
 require_relative '../kinetic/worker'
+require_relative '../kinetic/dsl'
+require_relative '../kinetic/errors'
 
 module Kinetic
 
@@ -34,28 +36,10 @@ module Kinetic
   class Base
 
     class << self
+      include Kinetic::DSL
 
-      attr_reader :exchanges
-
-      def set(key, value)
-        config[key] = value
-      end
-
-      def config
-        @config ||= Kinetic::Configuration.new
-      end
-
-      def logger
-        @logger ||= reopen_logger
-      end
-
-      def reopen_logger
-        @logger = Logger.new(STDOUT)
-      end
-
-      def on(key, &block)
-        logger.debug "Setting up '#{key}' on 'direct'"
-        direct[key] = block
+      def exchanges
+        @exchanges ||= {}
       end
 
       private
@@ -65,22 +49,11 @@ module Kinetic
       end
 
 
-      def exchanges
-        @exchanges ||= {}
-      end
-
-    end
 
-    delegate :logger, to: :class
-    delegate :config, to: :class
 
-    def reopen_logger
-      self.class.reopen_logger
     end
 
-    def exchanges
-      self.class.send(:exchanges)
-    end
+    delegate :logger, :set, :get, :get!, :exchanges,  to: :class
 
   end
 

data/lib/kinetic/configuration.rb

@@ -6,6 +6,7 @@ module Kinetic
       root:     File.dirname($0),
       app_file: $0,
       workers:  1,
+      log_file: STDOUT,
     }
 
     def initialize

data/lib/kinetic/dsl.rb

@@ -0,0 +1,74 @@
+module Kinetic
+
+  module DSL
+
+    # Sets a configuration value
+    #
+    # @param [Symbol] key the configuration key to set
+    # @param [Symbol] value the configuration value
+    #
+    # @return [Boolean] returns true
+    def set(key, value)
+      config[key.to_sym] = value
+      true
+    end
+
+    # Gets a configuration value
+    #
+    # @param [Symbol] key the key of the value to get
+    #
+    # @return [Object, nil] returns the requested configuration value or nil if the value does not exist
+    def get(key)
+      config[key.to_sym]
+    end
+
+    # Gets a configuration value and returns an exception if the value is not present
+    #
+    # @param [Symbol] key the key of the value to get
+    #
+    # @return [Object]
+    #
+    # @raise [Kinetic::Errors::MissingConfigurationValue] if the value does not exist
+    def get!(key)
+      raise Kinetic::Errors::MissingConfigurationValue.new(key) unless (value = get(key))
+      value
+    end
+
+    # Defines a direct queue subscription. Direct queues do not allow fuzzy matching so all messages sent to this queue
+    # must exactly match the key.
+    #
+    # @param [String] key the key of the queue to which to subscribe.
+    #
+    # @yield [message] yields the message passed to the queue to the block
+    #
+    # @raise [Kinetic::Errors::NoSubcriberBlock] if a block is not passed
+    # @raise [Kinetic::Errors::KeyMustBeString]  if the passed key is not a string
+    def on_direct(key, &block)
+      raise Kinetic::Errors::NoSubscriberBlock unless block_given?
+      raise Kinetic::Errors::KeyMustBeString   unless key.is_a? String
+      logger.debug "Setting up '#{key}' on 'direct'"
+      direct[key] = block
+    end
+
+    alias :on :on_direct
+
+    # @return [Logger] returns the application logger instance
+    def logger
+      @logger ||= reopen_logger
+    end
+
+    private
+
+    def config
+      @config ||= Kinetic::Configuration.new
+    end
+
+    def reopen_logger
+      @logger = Logger.new(config.log_file)
+    end
+
+
+
+  end
+
+end

data/lib/kinetic/errors.rb

@@ -3,16 +3,17 @@ module Kinetic
 
     class KineticError < StandardError; end
 
-    class ConnectionError < KineticError
+    class NoSubscriberBlock < KineticError; end
+    class KeyMustBeString   < KineticError; end
 
-      def initialize(error)
-        message   = error.message
-        backtrace = error.backtrace
-        super message
-        self.set_backtrace(backtrace)
+    class MissingConfigurationValue < KineticError
+
+      def initialize(key)
+        super "Expected configuration for '#{key}' but the configuration was not found."
       end
 
     end
 
+
   end
 end

data/lib/kinetic/master.rb

@@ -7,8 +7,8 @@ module Kinetic
     WORKERS    = {}
     SIG_QUEUE  = []
 
-    delegate :logger, to: :app
-    delegate :config, to: :app
+    delegate :logger, :get, :get!, :set, to: :app
+
 
     attr_reader :app
 
@@ -23,12 +23,15 @@ module Kinetic
       begin
         logger.info "Starting Kinetic #{Kinetic::VERSION} with PID #{Process.pid}"
         logger.debug 'Configuration:'
-        logger.ap    config.to_hash
+        logger.ap    app.class.send(:config).to_hash
         write_pidfile!
         initialize_self_pipe!
         initialize_signal_traps!
         spawn_missing_workers
         join
+      rescue => e
+        logger.fatal e
+        logger.fatal 'Unable to start worker!'
       ensure
         call_on_exit_callbacks
         exit!
@@ -53,11 +56,24 @@ module Kinetic
 
     private
 
+    def master_sleep(time)
+      IO.select([ SELF_PIPE[0] ], nil, nil, time) or return
+      SELF_PIPE[0].kgio_tryread(11)
+    end
+
     def join
-      logger.debug "joining thread"
-      loop do
-        sleep 1
-      end
+      logger.debug 'Joining thread'
+      case SIG_QUEUE.shift
+      when :QUIT
+        break
+      when :TERM, :INT
+        logger.warn "#{get(:name)} is shutting down immediately!"
+        exit!(1)
+        break
+      else
+        master_sleep(0.5)
+      end while true
+      logger.warn "#{get(:name)} is going down!"
     end
 
     # Based on Unicorn's self-pipe
@@ -73,33 +89,40 @@ module Kinetic
     end
 
     def awaken_master
-      logger.debug 'Awakening master'
       SELF_PIPE[1].kgio_trywrite('.')
     end
 
     def write_pidfile!
-      config.pid ||= File.join(config.root, "#{config.name}.pid")
-      logger.info "Writing PID file to #{config.pid}"
-      File.open(config.pid, 'w') { |f| f.write(Process.pid) }
+      set(:pid, File.join(get!(:root), "#{get!(:name)}.pid"))
+      logger.info "Writing PID file to #{get!(:pid)}"
+      File.open(get!(:pid), 'w') { |f| f.write(Process.pid) }
     end
 
     def call_on_exit_callbacks
     ensure
-      FileUtils.rm(config.pid)
+      FileUtils.rm(get(:pid)) if get(:pid)
     end
 
     def spawn_missing_workers
       logger.debug 'Spawning missing workers'
       worker_nr = -1
-      until (worker_nr += 1) == config.workers
+      until (worker_nr += 1) == get!(:workers)
         WORKERS.value?(worker_nr) and next
+        #noinspection RubyArgCount
         worker = Worker.new(worker_nr, @app)
         logger.debug 'Calling before_fork block'
         before_fork.call(self, worker)
         logger.debug 'Forking worker'
+        parent = Process.pid
         pid = fork do
-          app.reopen_logger
-          worker.run
+          begin
+            #noinspection RubyArgCount
+            worker.run
+          rescue => e
+            logger.fatal e
+            logger.fatal 'Unable to start workers'
+            Process.kill(:TERM, parent)
+          end
         end
         logger.debug "Worker #{worker_nr} started on #{pid}"
       end

data/lib/kinetic/version.rb

@@ -1,3 +1,3 @@
 module Kinetic
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/lib/kinetic/worker.rb

@@ -1,8 +1,7 @@
 module Kinetic
   class Worker
 
-    delegate :logger, to: :app
-    delegate :config, to: :app
+    delegate :logger, :get, :get!, :set, to: :app
 
     attr_reader :id, :app, :channel, :exchanges
 
@@ -24,9 +23,8 @@ module Kinetic
     end
 
     def run
-      logger.debug "Establishing connection host: '#{config.host}', port: '#{config.port}'"
-      AMQP.start(host: config.host, port: config.port) do |connection|
-        app.reopen_logger
+      logger.debug "Establishing connection host: '#{get!(:host)}', port: '#{get!(:port)}'"
+      AMQP.start(host: get!(:host), port: get!(:port)) do |connection|
         logger.debug "AMQP started with conneciton #{connection}"
         initialize_channel!(connection)
         initialize_exchanges!
@@ -45,7 +43,7 @@ module Kinetic
     def initialize_exchanges!
       logger.debug 'Initializing exchanges'
       @exchanges = {}
-      prefix = config.name
+      prefix = get!(:name)
       app.exchanges.each_key do |name|
         logger.debug "   Initializing #{name} exchange"
         @exchanges[name] = channel.send(name, "#{prefix}.#{name}")

data/spec/base_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require_relative '../lib/kinetic/base'
+
+describe Kinetic::Base do
+
+
+
+end

data/spec/dsl_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+require_relative '../lib/kinetic/dsl'
+require_relative '../lib/kinetic/errors'
+class TestClass
+  extend Kinetic::DSL
+end
+
+describe Kinetic::DSL do
+  # setting this to open brackes helps us test the returns true case
+
+  let(:config) { { key: 'value' } }
+
+  before :each do
+    stub_const("Kinetic::Configuration", config)
+  end
+
+  subject do
+    TestClass
+  end
+
+  before :each do
+    subject.stub(config: config)
+  end
+
+  describe '::set' do
+
+    it 'returns true' do
+      subject.set('foo', 'baz').should == true
+    end
+
+    it 'sets the configuration value' do
+      subject.set(:baz, 'bar')
+      subject.send(:config)[:baz].should == 'bar'
+    end
+
+    it 'symbolizes strings into keys' do
+      subject.set('foo', 'bar')
+      subject.send(:config)[:foo].should == 'bar'
+    end
+
+  end
+
+  describe '::get' do
+
+    it 'returns the value of the config key' do
+      config[:foo] = 'bar'
+      subject.get(:foo).should == 'bar'
+    end
+
+    it 'symbolizes the key' do
+      config[:baz] = 'bar'
+      subject.get('baz').should == 'bar'
+    end
+
+  end
+
+  describe '::get!' do
+
+    it 'raises Kinetic::Errors::MissingConfigurationValue if the value is not present' do
+      expect do
+        subject.send(:get!, :nonexistentkey)
+      end.to raise_error(Kinetic::Errors::MissingConfigurationValue)
+    end
+
+    it 'returns the value if the value is present and does not raise an exception' do
+      config[:existentkey] = 'foo'
+      expect do
+        subject.get!(:existentkey).should == 'foo'
+      end.not_to raise_error
+    end
+
+    it 'symbolizes the key' do
+      config[:akey] = 'foo'
+      expect do
+        subject.get!(:akey)
+      end.not_to raise_error
+    end
+
+  end
+
+  describe '::logger' do
+
+    let(:logger) { double('Logger') }
+
+    after :each do
+      subject.instance_variable_set(:@logger, nil)
+    end
+
+    it 'returns calls reopen_logger and returns the result if @logger is nil' do
+      subject.instance_variable_set(:@logger, nil)
+      subject.should_receive(:reopen_logger).and_return(logger)
+      subject.logger.should == logger
+    end
+
+    it 'returns the existing logger if already set' do
+      subject.instance_variable_set(:@logger, logger)
+      subject.should_not_receive(:reopen_logger)
+      subject.logger.should == logger
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinetic
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jarod Reid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-16 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: confstruct
@@ -136,6 +136,34 @@ dependencies:
     - - '>='
       - !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: yard
+  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: A powerful yet simple AMQP worker framework
 email:
 - jreid@voyst.com
@@ -144,6 +172,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -154,11 +183,15 @@ files:
 - lib/kinetic/base.rb
 - lib/kinetic/cli.rb
 - lib/kinetic/configuration.rb
+- lib/kinetic/dsl.rb
 - lib/kinetic/errors.rb
 - lib/kinetic/master.rb
 - lib/kinetic/publisher.rb
 - lib/kinetic/version.rb
 - lib/kinetic/worker.rb
+- spec/base_spec.rb
+- spec/dsl_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -183,5 +216,8 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A powerful yet simple AMQP worker framework
-test_files: []
+test_files:
+- spec/base_spec.rb
+- spec/dsl_spec.rb
+- spec/spec_helper.rb
 has_rdoc: