kestrel-client 0.2.0 → 0.2.1

data/README.md

@@ -1,16 +1,81 @@
-# kestrel-client: Talk to Kestrel queue server from Ruby
+## kestrel-client: Talk to Kestrel queue server from Ruby
+
+kestrel-client is a library that allows you to talk to a [Kestrel](http://github.com/robey/kestrel) queue server from ruby. As Kestrel uses the memcache protocol, kestrel-client is implemented as a wrapper around the memcached gem.
+
+
+## Installation
+
+you will need to install memcached.gem, though rubygems should do this for you. just:
+
+    sudo gem install kestrel-client
+
+
+## Basic Usage
+
+`Kestrel::Client.new` takes a list of servers and an options hash. See the [rdoc for Memcached](http://blog.evanweaver.com/files/doc/fauna/memcached/classes/Memcached.html) for an explanation of what the various options do.
+
+    require 'kestrel'
+
+    $queue = Kestrel::Client.new('localhost:22133')
+    $queue.set('a_queue', 'foo')
+    $queue.get('a_queue') # => 'foo'
+
+
+## Client Proxies
+
+kestrel-client comes with a number of decorators that change the behavior of the raw client.
+
+    $queue = Kestrel::Client.new('localhost:22133')
+    $queue.get('empty_queue') # => nil
+
+    $queue = Kestrel::Client::Blocking.new(Kestrel::Client.new('localhost:22133'))
+    $queue.get('empty_queue') # does not return until it pulls something from the queue
+
+
+## Configuration Management
+
+Kestrel::Config provides some tools for pulling queue config out of a YAML config file.
+
+    Kestrel::Config.load 'path/to/kestrel.yml'
+    Kestrel::Config.environment = 'production' # defaults to development
+
+    $queue = Kestrel::Config.new_client
+
+This tells kestrel-client to look for `path/to/kestrel.yml`, and pull the client configuration out of
+the 'production' key in that file. Sample config:
+
+    defaults: &defaults
+      distribution: :random
+      timeout: 2
+      connect_timeout: 1
+
+    production:
+      <<: *defaults
+      servers:
+        - kestrel01.example.com:22133
+        - kestrel02.example.com:22133
+        - kestrel03.example.com:22133
+
+    development:
+      <<: *defaults
+      servers:
+        - localhost:22133
+      show_backtraces: true
+
+
+## License
 
 Copyright 2010 Twitter, Inc.
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
 
-http://www.apache.org/licenses/LICENSE-2.0
+    http://www.apache.org/licenses/LICENSE-2.0
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/kestrel-client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{kestrel-client}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Freels", "Rael Dornfest"]
-  s.date = %q{2010-02-11}
+  s.date = %q{2010-02-12}
   s.description = %q{Ruby client for the Kestrel queue server}
   s.email = %q{rael@twitter.com}
   s.extra_rdoc_files = [
@@ -27,12 +27,14 @@ Gem::Specification.new do |s|
      "lib/kestrel/client/blocking.rb",
      "lib/kestrel/client/envelope.rb",
      "lib/kestrel/client/json.rb",
+     "lib/kestrel/client/namespace.rb",
      "lib/kestrel/client/proxy.rb",
      "lib/kestrel/client/unmarshal.rb",
      "lib/kestrel/config.rb",
      "spec/kestrel/client/blocking_spec.rb",
      "spec/kestrel/client/envelope_spec.rb",
      "spec/kestrel/client/json_spec.rb",
+     "spec/kestrel/client/namespace_spec.rb",
      "spec/kestrel/client/unmarshal_spec.rb",
      "spec/kestrel/client_spec.rb",
      "spec/kestrel/config/kestrel.yml",
@@ -49,6 +51,7 @@ Gem::Specification.new do |s|
     "spec/kestrel/client/blocking_spec.rb",
      "spec/kestrel/client/envelope_spec.rb",
      "spec/kestrel/client/json_spec.rb",
+     "spec/kestrel/client/namespace_spec.rb",
      "spec/kestrel/client/unmarshal_spec.rb",
      "spec/kestrel/client_spec.rb",
      "spec/kestrel/config_spec.rb",

data/lib/kestrel.rb

@@ -8,3 +8,4 @@ require 'kestrel/client/proxy'
 require 'kestrel/client/envelope'
 require 'kestrel/client/blocking'
 require 'kestrel/client/unmarshal'
+require 'kestrel/client/namespace'

data/lib/kestrel/client/namespace.rb

@@ -0,0 +1,24 @@
+module Kestrel
+  class Client
+    class Namespace < Proxy
+      def initialize(namespace, client)
+        @namespace = namespace
+        super(client)
+      end
+
+      def get(key, *args)
+        client.get(namespace(key), *args)
+      end
+
+      def set(key, *args)
+        client.set(namespace(key), *args)
+      end
+
+      private
+
+      def namespace(key)
+        "#{@namespace}:#{key}"
+      end
+    end
+  end
+end

data/spec/kestrel/client/namespace_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Kestrel::Client::Namespace do
+  describe "Instance Methods" do
+    before do
+      Kestrel::Config.load TEST_CONFIG_FILE
+      @raw_kestrel_client = Kestrel::Client.new(*Kestrel::Config.default)
+      @kestrel = Kestrel::Client::Namespace.new('some_namespace', @raw_kestrel_client)
+    end
+
+    describe "#get and #set" do
+      describe "namespace" do
+        it "prepends a namespace to key on a set" do
+          mock(@raw_kestrel_client).set('some_namespace:a_queue', :mcguffin)
+          @kestrel.set('a_queue', :mcguffin)
+        end
+
+        it "prepends a namespace to key on a get" do
+          mock(@raw_kestrel_client).get('some_namespace:a_queue')
+          @kestrel.get('a_queue')
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kestrel-client
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Matt Freels
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-11 00:00:00 -08:00
+date: 2010-02-12 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,12 +43,14 @@ files:
 - lib/kestrel/client/blocking.rb
 - lib/kestrel/client/envelope.rb
 - lib/kestrel/client/json.rb
+- lib/kestrel/client/namespace.rb
 - lib/kestrel/client/proxy.rb
 - lib/kestrel/client/unmarshal.rb
 - lib/kestrel/config.rb
 - spec/kestrel/client/blocking_spec.rb
 - spec/kestrel/client/envelope_spec.rb
 - spec/kestrel/client/json_spec.rb
+- spec/kestrel/client/namespace_spec.rb
 - spec/kestrel/client/unmarshal_spec.rb
 - spec/kestrel/client_spec.rb
 - spec/kestrel/config/kestrel.yml
@@ -87,6 +89,7 @@ test_files:
 - spec/kestrel/client/blocking_spec.rb
 - spec/kestrel/client/envelope_spec.rb
 - spec/kestrel/client/json_spec.rb
+- spec/kestrel/client/namespace_spec.rb
 - spec/kestrel/client/unmarshal_spec.rb
 - spec/kestrel/client_spec.rb
 - spec/kestrel/config_spec.rb