sidekick-client 0.2.4 → 0.2.5

data/README.rdoc

@@ -1,6 +1,7 @@
 = sidekick-client
 
-Description goes here.
+Single-threaded RabbitMQ reader that subscribes on a single queue. The 
+queue is configured via a sidekick.conf file. See example in config/
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/config/example_sidekick.conf

@@ -0,0 +1,8 @@
+--- 
+:broker:
+  :ip: 127.0.0.1
+  :port: 5672
+:queue_name: vamp_dev
+:exchange: amq.direct
+:routing_key: vamp_dev
+:timeout: 5

data/lib/sidekick/client/sidekick_client.rb

@@ -1,33 +1,49 @@
+require 'rubygems'
 require 'yaml'
 require 'logger'
 require "uuidtools"
 require "#{File.dirname(__FILE__)}/../shared/sidekick_logger"
 require "#{File.dirname(__FILE__)}/../shared/sidekick_queue_publisher"
 
-SIDEKICK_CONFIG = "/etc/vamp/sidekick.conf" unless defined?(SIDEKICK_CONFIG)
-DEFAULT_LOG_LOCATION = "/var/log/cft/sidekick/sidekick_client.log"
-# TODO: this client must be used from within a rails application right now
-# because it relies on RAILS_ROOT to find its config file
-#
 class SidekickClient
+
+  class << self
+    attr_accessor :config
+    attr_accessor :log
+  end
+
+  self.log = "/var/log/cft/sidekick/sidekick_client.log"
+
   attr_reader :logger
   attr_reader :config
   
   def initialize(config_override={})
-    if File.exists? SIDEKICK_CONFIG
-      @config ||= YAML.load_file(SIDEKICK_CONFIG).with_indifferent_access.merge(config_override)
+    load_config(config_override)
+    @logger.info "Initialized SidekickClient with config #{@config.inspect}"
+    @qconn = SidekickQueuePublisher.new(@config, @logger)   
+  end    
+
+  def load_config(config_override)
+    if SidekickClient.config && File.exists?(SidekickClient.config)
+      @config ||= YAML.load_file(SidekickClient.config).with_indifferent_access.merge(config_override)
+    elsif SidekickClient.config
+      raise LoadError, "Missing configuration: #{SidekickClient.config}"
     else
-      @config ||= config_override.with_indifferent_access
+      warn "Set the sidekick config path using SidekickClient.config='/path/to/sidekick.conf'"
     end
+    @config ||= config_override.with_indifferent_access
+    @config[:sidekick_log_file] ||= SidekickClient.log
+
+    # If STDOUT is specified as a value use the actual stream to log to STDOUT
+    if @config[:sidekick_log_file] == 'STDOUT'
+      @config[:sidekick_log_file] = Kernel.const_get('STDOUT')
+    end
+
+    FileUtils.mkdir_p(File.dirname(@config[:sidekick_log_file])) if @config[:sidekick_log_file].is_a?(String)
+    @logger = SidekickLogger.new(@config[:sidekick_log_file])
 
-    @config[:sidekick_log_file] ||= DEFAULT_LOG_LOCATION
-    @logger = SidekickLogger.new(@config[:sidekick_log_file].to_s.gsub("sidekick.log","sidekick_client.log")) 
-    
     @config[:exchange] ||= "amq.direct"
-    
-    @logger.info "Initialized SidekickClient with config #{@config.inspect}"
-    @qconn = SidekickQueuePublisher.new(@config, @logger)   
-  end    
+  end
 
   def self.send_and_disconnect(cmd, args={}, queue_name=nil)
     SidekickClient.new.send_and_disconnect(cmd,args,queue_name)

data/lib/sidekick/shared/sidekick_queue_publisher.rb

@@ -6,6 +6,12 @@ class SidekickQueuePublisher
   def initialize(config, logger)
     @logger = logger
     @config = config.with_indifferent_access
+
+    # Deprecations section
+    if @config[:brokers]
+      raise SyntaxError, "ERROR: 'brokers' is a deprecated config value. Please use something like:\n:broker:\n  :ip: 127.0.0.1\n  :port: 1234"
+    end
+
   end
 
   # Publish a message using a given routing key
@@ -75,7 +81,8 @@ class SidekickQueuePublisher
   end
 
   def init_bunny_connection(temp_reply_queue_name=nil)
-    @broker = @config[:brokers].first              
+    @broker = @config[:broker]
+
     logger.info "Establishing connection to RabbitMQ broker #{@broker.inspect}."          
     @b = Bunny.new(:host => (@broker[0] || "localhost"), :port => (@broker[1] || 5672), :timeout => @config[:timeout])          
     @b.start
@@ -90,4 +97,4 @@ class SidekickQueuePublisher
     logger.log_connection_error_and_sleep(e)
     retry
   end
-end
+end

data/sidekick-client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sidekick-client}
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["yan"]
-  s.date = %q{2010-04-22}
+  s.date = %q{2011-11-02}
   s.email = %q{yan@pritzker.ws}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "config/example_sidekick.conf",
      "lib/ext/README",
      "lib/ext/bunny-0.6.0/LICENSE",
      "lib/ext/bunny-0.6.0/README.rdoc",
@@ -110,7 +111,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/cohesive/sidekick-client}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{RabbitMQ client specific to ESOD's Sidekick server}
   s.test_files = [
     "test/helper.rb",

data/test/test_sidekick-client.rb

@@ -1,14 +1,29 @@
+$: << File.dirname(__FILE__)
 require 'helper'
 
+
 class TestSidekickClient < Test::Unit::TestCase
-  should "instantiate" do
-    SidekickClient.new
-  end
-  
-  should "use config override" do
-    expected_config = {:foo => :bar}
+  context "sidekick client" do
+    setup do
+      SidekickClient.log = "STDOUT"
+    end
+
+    should "instantiate" do
+      SidekickClient.new
+    end
     
-    client = SidekickClient.new(expected_config)
-    assert_equal :bar, client.config[:foo]
+    should "use config override" do
+      expected_config = {:foo => :bar}
+      
+      client = SidekickClient.new(expected_config)
+      assert_equal :bar, client.config[:foo]
+    end
+
+    should "warn about missing config file" do
+      assert_raise(LoadError) do
+        SidekickClient.config = "/foo/bar/doesnotexist"
+        SidekickClient.new
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: sidekick-client
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - yan
@@ -9,19 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-22 00:00:00 -07:00
+date: 2011-11-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 description: 
 email: yan@pritzker.ws
 executables: []
@@ -39,6 +46,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- config/example_sidekick.conf
 - lib/ext/README
 - lib/ext/bunny-0.6.0/LICENSE
 - lib/ext/bunny-0.6.0/README.rdoc
@@ -135,18 +143,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: RabbitMQ client specific to ESOD's Sidekick server