schlep 0.4.0 → 0.5.0

data/Readme.md

@@ -26,7 +26,7 @@ To change this, you can configure things one at a time:
 
 ```rb
 Schlep.app       = "My App"
-Schlep.hostname  = "localhost"
+Schlep.host      = "localhost"
 Schlep.redis_url = "redis://redis:password@localhost:6379"
 ```
 
@@ -35,7 +35,7 @@ or in a block:
 ```rb
 Schlep.configure do |config|
   config.app       = "My App"
-  config.hostname  = "localhost"
+  config.host      = "localhost"
   config.redis_url = "redis://redis:password@localhost:6379"
 end
 ```

data/lib/schlep.rb

@@ -21,38 +21,40 @@ module Schlep
     yield self
   end
 
-  def envelope(type, message)
+  def envelope(type, message, options = {})
     {
       :timestamp => timestamp,
-      :app =>       app,
-      :host =>      hostname,
+      :app =>       options[:app]  || app,
+      :host =>      options[:host] || host,
       :type =>      type,
       :message =>   serialize_message(message)
-    }.to_json
+    }
   end
 
-  def event(type, message)
-    events type, [message]
+  def event(type, message, options = {})
+    events type, [message], options
   end
 
-  def events(type, messages)
-    messages.map! { |message| envelope type, message }
+  def events(type, messages, options = {})
+    options.keys.each { |k| options[k] = sanitize(options[k]) }
+
+    messages.map! { |message| envelope(type, message, options).to_json }
 
     suppress_redis_errors do
       redis.pipelined do
         while messages.any?
-          redis.rpush key, messages.pop
+          redis.rpush key, messages.shift
         end
       end
     end
   end
 
-  def hostname
-    @hostname ||= sanitize `hostname`
+  def host
+    @host ||= sanitize `hostname`
   end
 
-  def hostname=(string)
-    @hostname = sanitize string
+  def host=(string)
+    @host = sanitize string
   end
 
   def key
@@ -80,7 +82,7 @@ module Schlep
   end
 
   def reset
-    %w[app hostname redis redis_url].each do |ivar|
+    %w[app host redis redis_url].each do |ivar|
       instance_variable_set "@#{ivar}", nil
     end
   end

data/lib/schlep/version.rb

@@ -1,3 +1,3 @@
 module Schlep
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/lib/schlep_spec.rb

@@ -18,30 +18,30 @@ describe Schlep do
   context ".configure" do
     it "should be configurable with setters" do
       Schlep.app       = "test_app_1"
-      Schlep.hostname  = "test_hostname_1"
+      Schlep.host      = "test_host_1"
       Schlep.redis_url = "redis://localhost:1234"
 
       Schlep.app.should == "test_app_1"
-      Schlep.hostname.should == "test_hostname_1"
+      Schlep.host.should == "test_host_1"
       Schlep.redis_url.should == "redis://localhost:1234"
     end
 
     it "should be configurable with a block" do
       Schlep.configure do |config|
         config.app       = "test_app_2"
-        config.hostname  = "test_hostname_2"
+        config.host      = "test_host_2"
         config.redis_url = "redis://localhost:4321"
       end
 
       Schlep.app.should == "test_app_2"
-      Schlep.hostname.should == "test_hostname_2"
+      Schlep.host.should == "test_host_2"
       Schlep.redis_url.should == "redis://localhost:4321"
     end
   end
 
   context ".envelope" do
-    it "should return valid json" do
-      JSON.parse(Schlep.envelope "test_type", { :one => { :two => 3 }})
+    it "should return a hash" do
+      Schlep.envelope("test", "test").should be_instance_of Hash
     end
 
     it "should accept types as strings" do
@@ -51,21 +51,40 @@ describe Schlep do
     it "should accept types as symbols" do
       Schlep.envelope :test, "test"
     end
+
+    it "should allow the app to be overridden" do
+      Schlep.app = "test_app"
+      e = Schlep.envelope("test", "test", :app => "another_app")
+      e[:app].should == "another_app"
+      Schlep.app.should == "test_app"
+    end
+
+    it "should allow the host to be overridden" do
+      Schlep.host = "test_host"
+      e = Schlep.envelope("test", "test", :host => "another_host")
+      e[:host].should == "another_host"
+      Schlep.host.should == "test_host"
+    end
+
+    it "should not allow the timestamp to be overridden" do
+      e = Schlep.envelope("test", "test", :timestamp => 1234567890)
+      e[:timestamp].should_not == 1234567890
+    end
   end
 
-  context ".hostname" do
+  context ".host" do
     it "should be a string" do
-      Schlep.hostname.should be_instance_of String
+      Schlep.host.should be_instance_of String
     end
 
     it "should not include a newline from the hostname command" do
-      Schlep.hostname.should_not match /\s/
+      Schlep.host.should_not match /\s/
     end
 
     it "should not remove dashes, underscores, or periods" do
-      Schlep.hostname = "this-is_a.hostname"
+      Schlep.host = "this-is_a.host"
 
-      Schlep.hostname.should == "this-is_a.hostname"
+      Schlep.host.should == "this-is_a.host"
     end
   end
 
@@ -112,12 +131,12 @@ describe Schlep do
     it "should reset instance variables to nil" do
       Schlep.configure do |config|
         config.app      = "test_app"
-        config.hostname = "test_hostname"
+        config.host = "test_host"
       end
 
       Schlep.reset
 
-      %w[app hostname redis].each do |ivar|
+      %w[app host redis].each do |ivar|
         Schlep.instance_variable_get("@#{ivar}").should be_nil
       end
     end

data/spec/redis_spec.rb

@@ -24,6 +24,16 @@ describe Schlep do
       Schlep.event :test, "test"
 
       Schlep.redis.llen(Schlep.key).should == 1
+      envelope = JSON.parse(Schlep.redis.lpop(Schlep.key))
+      envelope['type'].should    == "test"
+      envelope['message'].should == "test"
+    end
+
+    it "should sanitize overridden options" do
+      Schlep.event "test", "test", :app => "a:b/c^d$$e", :host => "a:b/c^d$$e"
+      envelope = JSON.parse(Schlep.redis.lpop(Schlep.key))
+      envelope['app'].should  == "a:b:c:d:e"
+      envelope['host'].should == "a:b:c:d:e"
     end
 
     it "should suppress connection errors" do
@@ -38,6 +48,19 @@ describe Schlep do
       Schlep.events :test, [1,2,3]
 
       Schlep.redis.llen(Schlep.key).should == 3
+
+      (1..3).each do |n|
+        envelope = JSON.parse(Schlep.redis.lpop(Schlep.key))
+        envelope['type'].should    == "test"
+        envelope['message'].should == n
+      end
+    end
+
+    it "should sanitize overridden options" do
+      Schlep.events "test", ["test"], :app => "a:b/c^d$$e", :host => "a:b/c^d$$e"
+      envelope = JSON.parse(Schlep.redis.lpop(Schlep.key))
+      envelope['app'].should  == "a:b:c:d:e"
+      envelope['host'].should == "a:b:c:d:e"
     end
 
     it "should suppress connection errors" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schlep
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-11 00:00:00.000000000 Z
+date: 2012-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70158924470240 !ruby/object:Gem::Requirement
+  requirement: &70191267022160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70158924470240
+  version_requirements: *70191267022160
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70158924469800 !ruby/object:Gem::Requirement
+  requirement: &70191267021720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158924469800
+  version_requirements: *70191267021720
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70158924469380 !ruby/object:Gem::Requirement
+  requirement: &70191267021300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158924469380
+  version_requirements: *70191267021300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70158924468960 !ruby/object:Gem::Requirement
+  requirement: &70191267020820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70158924468960
+  version_requirements: *70191267020820
 description: Ruby client for schlep. Schlep provides a simple interface for logging
   and broadcasting events.
 email: