schlep 0.3.1 → 0.4.0

data/Guardfile

@@ -1,5 +1,5 @@
-guard :test do
-  watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
-  watch(%r{^test/.+_test\.rb$})
-  watch('test/test_helper.rb') { "test" }
+guard 'rspec', :version => 2, :cli => "--color" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
 end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Justin Campbell
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -4,9 +4,9 @@ rescue LoadError
   puts "Ruby >= 1.9 required for build tasks"
 end
 
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-task :default => :test
+task :default => :spec
 
-desc "Run basic tests"
-Rake::TestTask.new("test") { |t| t.pattern = 'test/*_test.rb' }
+desc "Run the test suite"
+RSpec::Core::RakeTask.new

data/lib/schlep.rb

@@ -7,12 +7,14 @@ require "uri"
 module Schlep
   extend self
 
-  attr_writer :app, :hostname, :redis_url
+  attr_writer :redis_url
 
   def app
     @app ||= ""
+  end
 
-    sanitize @app
+  def app=(string)
+    @app = sanitize string
   end
 
   def configure
@@ -30,23 +32,31 @@ module Schlep
   end
 
   def event(type, message)
-    redis.rpush 'schlep', envelope(type, message)
+    events type, [message]
   end
 
   def events(type, messages)
-    messages.map! { | message| envelope(type, message) }
+    messages.map! { |message| envelope type, message }
 
-    redis.pipelined do
-      while messages.any?
-        redis.rpush 'schlep', messages.pop
+    suppress_redis_errors do
+      redis.pipelined do
+        while messages.any?
+          redis.rpush key, messages.pop
+        end
       end
     end
   end
 
   def hostname
-    @hostname ||= `hostname`
+    @hostname ||= sanitize `hostname`
+  end
+
+  def hostname=(string)
+    @hostname = sanitize string
+  end
 
-    sanitize @hostname
+  def key
+    @key ||= :schlep
   end
 
   def redis
@@ -76,7 +86,9 @@ module Schlep
   end
 
   def serialize_message(message)
-    return message unless message.is_a? String
+    return message unless
+      message.is_a? String and
+      message.match /\{.+\}/
 
     begin
       JSON.parse message
@@ -98,4 +110,12 @@ module Schlep
 
     string
   end
+
+  def suppress_redis_errors
+    begin
+      yield
+    rescue Errno::ECONNREFUSED => e
+      puts e.inspect unless ENV['RUBY_ENV'] == 'test'
+    end
+  end
 end

data/lib/schlep/version.rb

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

data/schlep.gemspec

@@ -5,6 +5,7 @@ require "schlep/version"
 Gem::Specification.new do |s|
   s.name        = "schlep"
   s.version     = Schlep::VERSION
+  s.license     = "MIT"
   s.authors     = ["Justin Campbell"]
   s.email       = ["justin@justincampbell.me"]
   s.homepage    = "http://github.com/Movitas/schlep-ruby"
@@ -14,8 +15,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "schlep"
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency "redis"
@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
     s.add_runtime_dependency "system_timer"
   end
 
-  s.add_development_dependency "guard-test"
+  s.add_development_dependency "guard-rspec"
   s.add_development_dependency "rake"
-  s.add_development_dependency "shoulda"
+  s.add_development_dependency "rspec"
 end

data/spec/lib/schlep_spec.rb

@@ -0,0 +1,181 @@
+require "spec_helper"
+
+describe Schlep do
+  before :each do
+    Schlep.reset
+  end
+
+  after :each do
+    %w[REDIS_URL REDISTOGO_URL].each do |e|
+      ENV[e] = nil
+    end
+  end
+
+  it "should be defined as a module" do
+    Schlep.class.should be_a Module
+  end
+
+  context ".configure" do
+    it "should be configurable with setters" do
+      Schlep.app       = "test_app_1"
+      Schlep.hostname  = "test_hostname_1"
+      Schlep.redis_url = "redis://localhost:1234"
+
+      Schlep.app.should == "test_app_1"
+      Schlep.hostname.should == "test_hostname_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.redis_url = "redis://localhost:4321"
+      end
+
+      Schlep.app.should == "test_app_2"
+      Schlep.hostname.should == "test_hostname_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 }})
+    end
+
+    it "should accept types as strings" do
+      Schlep.envelope "test", "test"
+    end
+
+    it "should accept types as symbols" do
+      Schlep.envelope :test, "test"
+    end
+  end
+
+  context ".hostname" do
+    it "should be a string" do
+      Schlep.hostname.should be_instance_of String
+    end
+
+    it "should not include a newline from the hostname command" do
+      Schlep.hostname.should_not match /\s/
+    end
+
+    it "should not remove dashes, underscores, or periods" do
+      Schlep.hostname = "this-is_a.hostname"
+
+      Schlep.hostname.should == "this-is_a.hostname"
+    end
+  end
+
+  context ".redis_url" do
+    it "should connect locally by default" do
+      Schlep.redis.client.host.should == "127.0.0.1"
+      Schlep.redis.client.port.should == 6379
+    end
+
+    it "should connect to a basic url" do
+      Schlep.redis_url = "redis://1.2.3.4:1234"
+
+      Schlep.redis.client.host.should == "1.2.3.4"
+      Schlep.redis.client.port.should == 1234
+      Schlep.redis.client.password.should be_nil
+    end
+
+    it "should connect to a url with a username and password" do
+      Schlep.redis_url = "redis://redis:password@1.2.3.4:1234"
+
+      Schlep.redis.client.host.should == "1.2.3.4"
+      Schlep.redis.client.port.should == 1234
+      Schlep.redis.client.password.should == "password"
+    end
+
+    it "should detect the url from ENV[\"REDIS_URL\"]" do
+      ENV["REDIS_URL"] = "redis://redis:secret@4.3.2.1:4321"
+
+      Schlep.redis.client.host.should == "4.3.2.1"
+      Schlep.redis.client.port.should == 4321
+      Schlep.redis.client.password.should == "secret"
+    end
+
+    it "should detect the url from ENV[\"REDISTOGO_URL\"]" do
+      ENV["REDISTOGO_URL"] = "redis://redis:secret@4.3.2.1:4321"
+
+      Schlep.redis.client.host.should == "4.3.2.1"
+      Schlep.redis.client.port.should == 4321
+      Schlep.redis.client.password.should == "secret"
+    end
+  end
+
+  context ".reset" do
+    it "should reset instance variables to nil" do
+      Schlep.configure do |config|
+        config.app      = "test_app"
+        config.hostname = "test_hostname"
+      end
+
+      Schlep.reset
+
+      %w[app hostname redis].each do |ivar|
+        Schlep.instance_variable_get("@#{ivar}").should be_nil
+      end
+    end
+  end
+
+  context ".serialize message" do
+    it "should convert json to a hash" do
+      Schlep.serialize_message("{\"one\":{\"two\":3}}").should == ({ "one" => { "two" => 3 }})
+    end
+
+    it "should leave strings alone" do
+      Schlep.serialize_message("test string").should == "test string"
+    end
+
+    it "should leave arrays alone" do
+      Schlep.serialize_message([1,2,[3,4]]).should == [1,2,[3,4]]
+    end
+
+    it "should leave hashes alone" do
+      Schlep.serialize_message({ :one => { :two => 3 }}).should == ({ :one => { :two => 3 }})
+    end
+
+    it "should leave integers alone" do
+      Schlep.serialize_message(123).should == 123
+    end
+
+    it "should leave floats alone" do
+      Schlep.serialize_message(1.23).should == 1.23
+    end
+  end
+
+  context ".timestamp" do
+    it "should be a float" do
+      Schlep.timestamp.should be_a Float
+    end
+  end
+
+  # private
+
+  context ".sanitize" do
+    it "should strip whitespace" do
+      Schlep.send(:sanitize, "test string").should == "teststring"
+    end
+
+    it "should strip newlines" do
+      Schlep.send(:sanitize, "test\n").should == "test"
+    end
+
+    it "should replace special characters with a colon" do
+      Schlep.send(:sanitize, "a:b/c^d$$e").should == "a:b:c:d:e"
+    end
+
+    it "should remove special characters at the beginning or end or a string" do
+      Schlep.send(:sanitize, "$test$string$").should == "test:string"
+    end
+
+    it "should not replace periods" do
+      Schlep.send(:sanitize, "a.b.c.d.e").should == "a.b.c.d.e"
+    end
+  end
+end

data/spec/redis_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+REDIS_ENABLED = `which redis-server`.lines.any? && RUBY_PLATFORM != "java"
+
+describe Schlep do
+  before :all do
+    print "("
+  end
+
+  after :all do
+    stop_redis
+    print ")"
+  end
+
+  before :each do
+    start_redis
+    Schlep.reset
+    Schlep.redis_url = "redis://localhost:#{REDIS_OPTIONS[:port]}"
+    Schlep.redis.flushall
+  end
+
+  context ".event" do
+    it "should push an event to the schlep key" do
+      Schlep.event :test, "test"
+
+      Schlep.redis.llen(Schlep.key).should == 1
+    end
+
+    it "should suppress connection errors" do
+      stop_redis
+
+      Schlep.event :test, "test"
+    end
+  end
+
+  context ".events" do
+    it "should push multiple events to the schlep key" do
+      Schlep.events :test, [1,2,3]
+
+      Schlep.redis.llen(Schlep.key).should == 3
+    end
+
+    it "should suppress connection errors" do
+      stop_redis
+
+      Schlep.events :test, [1,2,3]
+    end
+  end
+end if REDIS_ENABLED

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+ENV['RUBY_ENV'] = 'test'
+
+require "schlep"
+
+REDIS_OPTIONS = {
+  :daemonize  => :yes,
+  :dbfilename => "dump.rdb",
+  :dir        => ".",
+  :pidfile    => "redis.pid",
+  :port       => 9736
+}
+
+def start_redis
+  until FileTest.exists? REDIS_OPTIONS[:pidfile]
+    `echo '#{REDIS_OPTIONS.map { |k, v| "#{k} #{v}" }.join('\n')}' | redis-server -`
+    sleep 0.01
+  end
+end
+
+def stop_redis
+  if FileTest.exists? REDIS_OPTIONS[:pidfile]
+    %x{
+      cat #{REDIS_OPTIONS[:pidfile]} | xargs kill -QUIT
+      rm -f #{REDIS_OPTIONS[:dir]}/#{REDIS_OPTIONS[:dbfilename]}
+      rm -f #{REDIS_OPTIONS[:dir]}/#{REDIS_OPTIONS[:pidfile]}
+    }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schlep
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-09 00:00:00.000000000 Z
+date: 2012-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70214599512660 !ruby/object:Gem::Requirement
+  requirement: &70158924470240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70214599512660
+  version_requirements: *70158924470240
 - !ruby/object:Gem::Dependency
-  name: guard-test
-  requirement: &70214599511460 !ruby/object:Gem::Requirement
+  name: guard-rspec
+  requirement: &70158924469800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70214599511460
+  version_requirements: *70158924469800
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70214599510660 !ruby/object:Gem::Requirement
+  requirement: &70158924469380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70214599510660
+  version_requirements: *70158924469380
 - !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: &70214599509520 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &70158924468960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70214599509520
+  version_requirements: *70158924468960
 description: Ruby client for schlep. Schlep provides a simple interface for logging
   and broadcasting events.
 email:
@@ -68,15 +68,18 @@ files:
 - .travis.yml
 - Gemfile
 - Guardfile
+- LICENSE
 - Rakefile
 - Readme.md
 - lib/schlep.rb
 - lib/schlep/version.rb
 - schlep.gemspec
-- test/schlep_test.rb
-- test/test_helper.rb
+- spec/lib/schlep_spec.rb
+- spec/redis_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/Movitas/schlep-ruby
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -100,5 +103,6 @@ signing_key:
 specification_version: 3
 summary: Ruby client for schlep http://github.com/Movitas/schlep
 test_files:
-- test/schlep_test.rb
-- test/test_helper.rb
+- spec/lib/schlep_spec.rb
+- spec/redis_spec.rb
+- spec/spec_helper.rb

data/test/schlep_test.rb

@@ -1,191 +0,0 @@
-begin
-  require "test_helper"
-rescue LoadError
-  require File.join(File.dirname(__FILE__), ".", "test_helper")
-end
-
-class SchlepTest < Test::Unit::TestCase
-  def setup
-    Schlep.reset
-  end
-
-  def teardown
-    %w[REDIS_URL REDISTOGO_URL].each do |e|
-      ENV[e] = nil
-    end
-  end
-
-  context "schlep" do
-    should "be defined as a module" do
-      assert_equal Module, Schlep.class
-    end
-  end
-
-  context "configure" do
-    should "be configurable with setters" do
-      Schlep.app       = "test_app_1"
-      Schlep.hostname  = "test_hostname_1"
-      Schlep.redis_url = "redis://localhost:1234"
-
-      assert_equal "test_app_1",             Schlep.app,       "app"
-      assert_equal "test_hostname_1",        Schlep.hostname,  "hostname"
-      assert_equal "redis://localhost:1234", Schlep.redis_url, "redis_url"
-    end
-
-    should "be configurable with a block" do
-      Schlep.configure do |config|
-        config.app       = "test_app_2"
-        config.hostname  = "test_hostname_2"
-        config.redis_url = "redis://localhost:4321"
-      end
-
-      assert_equal "test_app_2",             Schlep.app,       "app"
-      assert_equal "test_hostname_2",        Schlep.hostname,  "hostname"
-      assert_equal "redis://localhost:4321", Schlep.redis_url, "redis_url"
-    end
-  end
-
-  context "envelope" do
-    should "return valid json" do
-      assert_nothing_raised(Exception) {
-        JSON.parse(Schlep.envelope "test_type", { :one => { :two => 3 }})
-      }
-    end
-  end
-
-  context "hostname" do
-    should "be a string" do
-      assert Schlep.hostname.is_a? String
-    end
-
-    should "not include a newline from the hostname command" do
-      assert_nil Schlep.hostname =~ /\s/
-    end
-
-    should "not remove dashes, underscores, or periods" do
-      Schlep.hostname = "this-is_a.hostname"
-      assert_equal "this-is_a.hostname", Schlep.hostname
-    end
-  end
-
-  context "redis_url" do
-    should "connect locally by default" do
-      assert_equal "127.0.0.1", Schlep.redis.client.host
-      assert_equal 6379,        Schlep.redis.client.port
-    end
-
-    should "connect to a basic url" do
-      Schlep.redis_url = "redis://1.2.3.4:1234"
-
-      assert_equal "1.2.3.4", Schlep.redis.client.host
-      assert_equal 1234,      Schlep.redis.client.port
-      assert_nil              Schlep.redis.client.password
-    end
-
-    should "connect to a url with a username and password" do
-      Schlep.redis_url = "redis://redis:password@1.2.3.4:1234"
-
-      assert_equal "1.2.3.4",  Schlep.redis.client.host
-      assert_equal 1234,       Schlep.redis.client.port
-      assert_equal "password", Schlep.redis.client.password
-    end
-
-    should "detect the url from ENV[\"REDIS_URL\"]" do
-      ENV["REDIS_URL"] = "redis://redis:secret@4.3.2.1:4321"
-
-      assert_equal "4.3.2.1", Schlep.redis.client.host
-      assert_equal 4321,      Schlep.redis.client.port
-      assert_equal "secret",  Schlep.redis.client.password
-    end
-
-    should "detect the url from ENV[\"REDISTOGO_URL\"]" do
-      ENV["REDISTOGO_URL"] = "redis://redis:secret@4.3.2.1:4321"
-
-      assert_equal "4.3.2.1", Schlep.redis.client.host
-      assert_equal 4321,      Schlep.redis.client.port
-      assert_equal "secret",  Schlep.redis.client.password
-    end
-  end
-
-  context "reset" do
-    should "reset instance variables to nil" do
-      Schlep.configure do |config|
-        config.app      = "test_app"
-        config.hostname = "test_hostname"
-      end
-
-      Schlep.reset
-
-      %w[app hostname redis].each do |ivar|
-        assert_nil Schlep.instance_variable_get("@#{ivar}"), "@#{ivar}"
-      end
-    end
-  end
-
-  context "serialize message" do
-    should "convert json to a hash" do
-      assert_equal ({ "one" => { "two" => 3 }}),
-        Schlep.serialize_message("{\"one\":{\"two\":3}}")
-    end
-
-    should "leave strings alone" do
-      assert_equal "test string",
-        Schlep.serialize_message("test string")
-    end
-
-    should "leave arrays alone" do
-      assert_equal [1,2,[3,4]],
-        Schlep.serialize_message([1,2,[3,4]])
-    end
-
-    should "leave hashes alone" do
-      assert_equal ({ :one => { :two => 3 }}),
-        Schlep.serialize_message({ :one => { :two => 3 }})
-    end
-
-    should "leave integers alone" do
-      assert_equal 123,
-        Schlep.serialize_message(123)
-    end
-
-    should "leave floats alone" do
-      assert_equal 1.23,
-        Schlep.serialize_message(1.23)
-    end
-  end
-
-  context "timestamp" do
-    should "be a float" do
-      assert Schlep.timestamp.is_a? Float
-    end
-  end
-
-  # private
-
-  context "sanitize" do
-    should "strip whitespace" do
-      assert_equal "teststring",
-        Schlep.send(:sanitize, "test string")
-    end
-
-    should "strip newlines" do
-      assert_equal "test",
-        Schlep.send(:sanitize, "test\n")
-    end
-
-    should "replace special characters with a colon" do
-      assert_equal "a:b:c:d:e",
-        Schlep.send(:sanitize, "a:b/c^d$$e")
-    end
-
-    should "remove special characters at the beginning or end or a string" do
-      assert_equal "test:string",
-        Schlep.send(:sanitize, "$test$string$")
-    end
-
-    should "not replace periods" do
-      assert_equal "a.b.c.d.e",
-        Schlep.send(:sanitize, "a.b.c.d.e")
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,7 +0,0 @@
-require 'test/unit'
-require 'rubygems'
-require 'shoulda'
-
-$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
-
-require 'schlep'