beanstalk-worker 0.0.1 → 0.0.2

data/Gemfile

@@ -4,6 +4,10 @@ source "http://rubygems.org"
 #   gem "activesupport", ">= 2.3.5"
 
 gem 'beanstalk-client'
+gem "mixlib-log", "~> 1.6.0"
+gem "mixlib-config", "~> 1.1.2"
+gem "mixlib-log-json", "~> 0.0.1"
+gem "yajl-ruby", "~> 1.1.0"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
@@ -15,5 +19,5 @@ group :development do
   gem "bundler", "~> 1.3.5"
   gem "jeweler", "~> 1.8.4"
   gem "beanstalk-client-rspec", ">= 0"
-  gem (RUBY_VERSION =~ /^1\.9/ ? "simplecov" : "rcov"), ">= 0"
+  gem (RUBY_VERSION.gsub('.', '').to_i >= 190 ? "simplecov" : "rcov"), ">= 0"
 end

data/Rakefile

@@ -2,7 +2,7 @@
 
 require 'rubygems'
 require 'bundler'
-require './lib/beanstalk-worker/version.rb'
+require './lib/beanstalk-worker.rb'
 
 begin
   Bundler.setup(:default, :development)
@@ -17,7 +17,7 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "beanstalk-worker"
-  gem.version = BeanStalk::Worker::Version::STRING
+  gem.version = BeanStalk::Worker::VERSION
   gem.homepage = "http://github.com/aia/beanstalk-worker"
   gem.license = "MIT"
   gem.summary = %Q{Beanstalkd Worker base class}

data/lib/beanstalk-worker/config.rb

@@ -0,0 +1,104 @@
+require 'mixlib/config'
+require 'yajl'
+require 'yaml'
+
+# The configuration object for the gemindexer worker.
+class BeanStalk::Worker
+  class Config
+    extend Mixlib::Config
+
+    # Return the configuration itself upon inspection.
+    def self.inspect
+      configuration.inspect
+    end
+
+    # Loads a given file and passes it to the appropriate parser.
+    #
+    # @raise [ IOError ] Any IO Exceptions that occur.
+    #
+    # @param [ String ] filename The filename to read.
+    # @param [ String ] parser The parser to use.
+    # @param [ String ] environment The environment to read config for.
+    def self.from_file(filename, parser="yaml", environment="development")
+      send("from_file_#{parser}".to_sym, filename, environment)
+    end
+
+    # Loads a given ruby file and runs instance_eval against it
+    # in the context of the current object.
+    #
+    # @raise [ IOError ] Any IO Exceptions that occur.
+    #
+    # @param [ String ] filename The file to read.
+    def self.from_file_ruby(filename, *args)
+      self.instance_eval(IO.read(filename), filename, 1)
+    end
+
+    # Loads a given yaml file and merges the current context
+    # configuration with the updated hash.
+    #
+    # @raise [ IOError ] Any IO Exceptions that occur.
+    # @raise [ Yajl::ParseError ] Raises Yajl Parsing error on improper json.
+    #
+    # @param [ String ] filename The file to read.
+    # @param [ String ] environment The environment to use.
+    def self.from_file_yaml(filename, environment)
+      configuration.merge!(YAML.load_file(filename)[environment])
+    end
+
+    # Loads a given json file and merges the current context
+    # configuration with the updated hash.
+    #
+    # @raise [ IOError ] Any IO Exceptions that occur.
+    # @raise [ Yajl::ParseError ] Raises Yajl Parsing error on improper json.
+    #
+    # @param [ String ] filename The file to read.
+    def self.from_file_json(filename, *args)
+      self.from_stream_json(IO.read(filename))
+    end
+
+    # Loads a given json input and merges the current context
+    # configuration with the updated hash.
+    #
+    # @raise [ IOError ] Any IO Exceptions that occur.
+    # @raise [ Yajl::ParseError ] Raises Yajl Parsing error on improper json.
+    #
+    # @param [ String ] input The json configuration input.
+    def self.from_stream_json(input, *args)
+      parser = Yajl::Parser.new(:symbolize_keys => true)
+      configuration.merge!(parser.parse(input))
+    end
+
+    # Helper method for generation the beanstalk uri
+    #
+    # @return [ String ] The beanstalk uri.
+    def self.beanstalk_uri
+      [self['beanstalk']['server'], self['beanstalk']['port']].join(":")
+    end
+
+    # When you are using ActiveSupport, they monkey-patch 'daemonize' into
+    # Kernel. So while this is basically identical to what method_missing
+    # would do, we pull it up here and get a real method written so that
+    # things get dispatched properly.
+    config_attr_writer :daemonize do |v|
+      configure do |c|
+        c[:daemonize] = v
+      end
+    end
+
+    # Enable debug
+    debug false
+
+    # Logging Settings
+    log_level :warn
+    log_location STDOUT
+    log_formatter :json
+
+    # Beanstalk config
+    beanstalk({
+      :server => '127.0.0.1',
+      :port => 11300,
+      :tube => 'worker1'
+    })
+
+  end
+end

data/lib/beanstalk-worker/logger.rb

@@ -0,0 +1,42 @@
+require 'logger'
+require 'mixlib/log'
+require 'mixlib/log/formatter'
+require 'mixlib/log/jsonformatter'
+
+# Beanstalk::Worker's internal logging facility.
+# Standardized to provide a consistent log format.
+module BeanStalk::Worker::Log
+  class << self
+    include Mixlib::Log
+
+    # Use Mixlib::Log.init when you want to set up the logger manually.  Arguments to this method
+    # get passed directly to Logger.new, so check out the documentation for the standard Logger class
+    # to understand what to do here.
+    #
+    # If this method is called with no arguments, it will log to STDOUT at the :warn level.
+    #
+    # It also configures the Logger instance it creates to use the custom Mixlib::Log::Formatter class.
+    def init(*opts)
+      reset!
+      @logger = logger_for(BeanStalk::Worker::Config[:log_location])
+      if @logger.respond_to?(:formatter=)
+        if BeanStalk::Worker::Config[:log_formatter].eql?(:json)
+          @logger.formatter = Mixlib::Log::JSONFormatter.new()
+        else
+          @logger.formatter = Mixlib::Log::Formatter.new()
+        end
+      end
+      @logger.level = Logger.const_get(
+        BeanStalk::Worker::Config[:log_level].to_s.upcase)
+      @logger
+    end
+  end
+
+  # Monkeypatch Formatter to allow local show_time updates.
+  class Formatter
+    # Allow enabling and disabling of time with a singleton.
+    def self.show_time=(*args)
+      Mixlib::Log::Formatter.show_time = *args
+    end
+  end
+end

data/lib/beanstalk-worker/version_class.rb

@@ -0,0 +1,52 @@
+module BeanStalk
+  class Worker
+    module Version
+      include Comparable
+      attr_reader :major, :minor, :patch
+
+      def initialize(str="")
+        parse(str)
+      end
+
+      def inspect
+        "#{@major}.#{@minor}.#{@patch}"
+      end
+
+      def to_s
+        "#{@major}.#{@minor}.#{@patch}"
+      end
+
+      def <=>(v)
+        [:major, :minor, :patch].each do |method|
+          ans = (self.send(method) <=> v.send(method))
+          return ans if ans != 0
+        end
+        0
+      end
+
+      def hash
+        to_s.hash
+      end
+
+      # For hash
+      def eql?(other)
+        other.is_a?(Version) && self == other
+      end
+
+      protected
+
+      def parse(str="")
+        @major, @minor, @patch =
+          case str.to_s
+          when /^(\d+)\.(\d+)\.(\d+)$/
+            [ $1.to_i, $2.to_i, $3.to_i ]
+          when /^(\d+)\.(\d+)$/
+            [ $1.to_i, $2.to_i, 0 ]
+          else
+            "'#{str.to_s}' does not match 'x.y.z' or 'x.y'"
+          end
+      end
+
+    end
+  end
+end

data/lib/beanstalk-worker/worker.rb

@@ -1,90 +1,51 @@
-require 'logger'
 require 'beanstalk-client'
 
-module BeanStalk
-  class Worker
-    attr_accessor :config, :log, :beanstalk, :stats
+class BeanStalk::Worker
+  attr_accessor :config, :log, :beanstalk, :stats
+  
+  def initialize(config = {})
+    @config = BeanStalk::Worker::Config
+    @config.merge!(config || {})
+    @logger = BeanStalk::Worker::Log
+
+    @logger.info("Logging started")
     
-    def initialize(config = {}, logger = nil)
-      @config = {
-        'beanstalk' => {
-          'server' => "127.0.0.1",
-          'port' => "11300",
-          'tube' => "worker1"
-        }
-      }
-      
-      @config['beanstalk'].merge!(config['beanstalk'] || {})
-      
-      initialize_logger unless logger
-      
-      @log = logger if logger
-      
-      @log.error("Logging started")
-      
-      @stats = {
-        'received' => 0
-      }
-      
-      initialize_beanstalk
-    end
+    @stats = {
+      'received' => 0
+    }
     
-    def initialize_logger
-      @config['log'] = {
-        'file' => $stdout,
-        'level' => 'INFO'
-      }.merge(@config['log'] || {})
-
-      log_initialize = [@config['log']['file']]
-      log_initialize << @config['log']['shift_age'] if @config['log']['shift_age']
-      log_initialize << @config['log']['shift_size'] if @config['log']['shift_size']
-
+    initialize_beanstalk
+  end
+  
+  def initialize_beanstalk
+    @beanstalk = Beanstalk::Pool.new([
+      BeanStalk::Worker::Config.beanstalk_uri
+    ])
+    
+    @beanstalk.watch(@config[:beanstalk][:tube])
+    @beanstalk.use(@config[:beanstalk][:tube])
+    @beanstalk.ignore('default')
+  end
+  
+  def start(received = -1)
+    while (received == -1) || (@stats['received'] < received)
       begin
-        @log = Logger.new(*log_initialize)
-        @log.level = Logger.const_get(@config['log']['level'])
+        job = @beanstalk.reserve
+        
+        @logger.debug("job #{job.inspect}")
+        @logger.debug("job #{job.body.inspect}")
+        
+        @stats['received'] += 1
+        
+        job.delete if work(job)
       rescue Exception => e
-        @config['log'] = {
-          'file' => $stdout,
-          'level' => 'INFO'
-        }
-        @log = Logger.new(@config['log']['file'])
-        @log.level = Logger.const_get(@config['log']['level'])
-        @log.error("Caught a problem with log settings")
-        @log.error("#{e.message}")
-        @log.error("Setting log settings to defaults")
+        @logger.error("Caught exception #{e.to_s}")
+        exit
       end
     end
-    
-    def initialize_beanstalk
-      @beanstalk = Beanstalk::Pool.new([
-        [@config['beanstalk']['server'], @config['beanstalk']['port']].join(":")
-      ])
-      
-      @beanstalk.watch(@config['beanstalk']['tube'])
-      @beanstalk.use(@config['beanstalk']['tube'])
-      @beanstalk.ignore('default')
-    end
-    
-    def start(received = -1)
-      while (received == -1) || (@stats['received'] < received)
-        begin
-          job = @beanstalk.reserve
-          
-          @log.info("job #{job.inspect}")
-          @log.info("job #{job.body.inspect}")
-          
-          @stats['received'] += 1
-          
-          job.delete if work(job)
-        rescue Exception => e
-          @log.error("Caught exception #{e.to_s}")
-          exit
-        end
-      end
-    end
-    
-    def work(job)
-      return true
-    end
   end
-end
+  
+  def work(job)
+    return true
+  end
+end

data/lib/beanstalk-worker.rb

@@ -1,4 +1,12 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
-require 'beanstalk-worker/version'
-require 'beanstalk-worker/worker'
+module BeanStalk
+  class Worker
+    VERSION = '0.0.2'
+  end
+end
+
+require 'beanstalk-worker/version_class'
+require 'beanstalk-worker/config'
+require 'beanstalk-worker/logger'
+require 'beanstalk-worker/worker'

data/spec/beanstalk-worker_spec.rb

@@ -2,24 +2,19 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'spec_helper'
 require 'beanstalk-client-rspec'
-require 'pp'
 
 describe "BeanStalk" do
   describe "Worker" do
     before(:each) do
-      @default_config = {
-        'beanstalk' => {
-          'server' => "127.0.0.1",
-          'port' => "11300",
-          'tube' => "worker1"
-        }
-      }
+      BeanStalk::Worker::Config[:log_location] = '/dev/null'
+      BeanStalk::Worker::Log.init
+      BeanStalk::Worker::Log.reset!
       
       @test_config = {
-        'beanstalk' => {
-          'server' => '10.10.10.10',
-          'port' => '11111',
-          'tube' => 'testqueue'
+        :beanstalk => {
+          :server => '10.10.10.10',
+          :port => 11111,
+          :tube => 'testqueue'
         }
       }
       
@@ -29,39 +24,21 @@ describe "BeanStalk" do
       stub_const("Beanstalk::Pool", Beanstalk::MockPool)
     end
     
-    it "should initialize with defaults" do
-      @worker = BeanStalk::Worker.new
-      
-      @worker.config['beanstalk'].should eql @default_config['beanstalk']
-    end
-    
     it "should initialize with configuration" do
       @worker = BeanStalk::Worker.new(@test_config)
-      
-      @worker.config['beanstalk'].should eql @test_config['beanstalk']
+      @worker.config[:beanstalk].should eql @test_config[:beanstalk]
     end
     
     it "should receive queued messages" do
       @worker = BeanStalk::Worker.new(@test_config)
-      
       @worker.beanstalk.put("foo")
-      
       job = @worker.beanstalk.reserve
-      
       job.body.should eql "foo"
     end
     
-    it "should log messages" do
-      logger = mock Logger
-      logger.should_receive(:error).with("Logging started")
-      @worker = BeanStalk::Worker.new(@test_config, logger)
-    end
-    
     it "should start" do
       @worker = BeanStalk::Worker.new(@test_config)
-      
       @worker.beanstalk.put("foo")
-      
       @worker.start(1)
     end
     
@@ -78,7 +55,6 @@ describe "BeanStalk" do
       @worker = BeanStalk::Worker.new(@test_config)
       
       3.times { @worker.beanstalk.put("foo") }
-      
       expect {
         @worker.start(4)
       }.to raise_exception
@@ -89,8 +65,7 @@ describe "BeanStalk" do
     it "should start to receive undefined number of messages" do
       @worker = BeanStalk::Worker.new(@test_config)
 
-      3.times { @worker.beanstalk.put("foo") }
-      
+      3.times { @worker.beanstalk.put("foo") }      
       expect {
         @worker.start(4)
       }.to raise_exception
@@ -98,4 +73,4 @@ describe "BeanStalk" do
       @worker.stats['received'].should eql 3
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
-if RUBY_VERSION =~ /^1\.9/
+if RUBY_VERSION.gsub('.', '').to_i >= 190
   require 'simplecov'
 
   module SimpleCov::Configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beanstalk-worker
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-24 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beanstalk-client
@@ -27,6 +27,70 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mixlib-log
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: mixlib-config
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: mixlib-log-json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -173,7 +237,9 @@ files:
 - features/step_definitions/beanstalk-worker_steps.rb
 - features/support/env.rb
 - lib/beanstalk-worker.rb
-- lib/beanstalk-worker/version.rb
+- lib/beanstalk-worker/config.rb
+- lib/beanstalk-worker/logger.rb
+- lib/beanstalk-worker/version_class.rb
 - lib/beanstalk-worker/worker.rb
 - spec/beanstalk-worker_spec.rb
 - spec/spec_helper.rb
@@ -192,7 +258,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -623351978344314384
+      hash: -3743712853818560544
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/beanstalk-worker/version.rb

@@ -1,12 +0,0 @@
-module BeanStalk
-  class Worker
-    module Version
-      MAJOR = 0
-      MINOR = 0
-      PATCH = 1
-      BUILD = nil
-
-      STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
-    end
-  end
-end