schlep 0.2.1 → 0.2.2

data/Readme.md

@@ -1 +1,71 @@
 # schlep [![Build Status](https://secure.travis-ci.org/Movitas/schlep-ruby.png)](https://secure.travis-ci.org/Movitas/schlep-ruby) [![Dependency Status](https://gemnasium.com/Movitas/schlep-ruby.png)](https://gemnasium.com/Movitas/schlep-ruby)
+
+## Requirements
+
+Schlep needs a [Redis server](http://redis.io), a [Schlep server](http://github.com/Movitas/schlep), and some events. It's [tested on most versions of Ruby](https://secure.travis-ci.org/Movitas/schlep-ruby).
+
+## Installation
+
+```sh
+gem install schlep
+```
+
+or, add it to your Gemfile:
+
+```rb
+gem 'schlep'
+```
+
+and then run `bundle install`.
+
+## Configuration
+
+By default, Schlep will connect to Redis locally, use a blank string as the app name, and get the hostname by running `hostname`.
+
+To change this, you can configure things one at a time:
+
+```rb
+Schlep.app       = "My App"
+Schlep.hostname  = "localhost"
+Schlep.redis_url = "redis://redis:password@localhost:6379"
+```
+
+or in a block:
+
+```rb
+Schlep.configure do |config|
+  config.app       = "My App"
+  config.hostname  = "localhost"
+  config.redis_url = "redis://redis:password@localhost:6379"
+end
+```
+
+If you're using Rails, you should probably put the block above in `config/initializers/schlep.rb`.
+
+For other Ruby apps, anywhere before your first Schlep event is fine.
+
+## Usage
+
+### Basic event
+
+```rb
+Schlep.event "event_type", something
+```
+
+`something` can be almost any Ruby object, and Schlep will do it's best to serialize it to JSON.
+
+### Multiple events
+
+For performance, Schlep can send multiple events of the same type to Redis in a more efficient manner. To use this, simply call `Schlep.events` instead of `Schlep.event`, and pass an array of objects to serialize:
+
+```rb
+events = []
+
+1_000_000.times { |n| events << n }
+
+Schlep.events "load_test", events
+```
+
+## Support
+
+If you run into any problems, please [submit an issue](http://github.com/Movitas/schlep-ruby/issues).

data/lib/schlep.rb

@@ -42,7 +42,11 @@ module Schlep
   end
 
   def hostname
-    @hostname ||= `hostname`.split(".").first
+    @hostname ||= `hostname`
+
+    @hostname.gsub! /\s/, "" if @hostname =~ /\s/
+
+    @hostname
   end
 
   def redis

data/lib/schlep/version.rb

@@ -1,3 +1,3 @@
 module Schlep
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/test/schlep_test.rb

@@ -57,6 +57,15 @@ class SchlepTest < Test::Unit::TestCase
     should "be a string" do
       assert Schlep.hostname.is_a? String
     end
+
+    should "strip whitespace and newlines" do
+      Schlep.hostname = "test string\n"
+      assert_equal "teststring", Schlep.hostname
+    end
+
+    should "not include a newline from the hostname command" do
+      assert_nil Schlep.hostname =~ /\s/
+    end
   end
 
   context "redis_url" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schlep
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-13 00:00:00.000000000 Z
+date: 2012-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70336884445720 !ruby/object:Gem::Requirement
+  requirement: &70203744654020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70336884445720
+  version_requirements: *70203744654020
 - !ruby/object:Gem::Dependency
   name: guard-test
-  requirement: &70336884444540 !ruby/object:Gem::Requirement
+  requirement: &70203744652700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70336884444540
+  version_requirements: *70203744652700
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70336884443720 !ruby/object:Gem::Requirement
+  requirement: &70203744652060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70336884443720
+  version_requirements: *70203744652060
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70336884442280 !ruby/object:Gem::Requirement
+  requirement: &70203744650800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70336884442280
+  version_requirements: *70203744650800
 description: Ruby client for schlep. Schlep provides a simple interface for logging
   and broadcasting events.
 email: