pistachio 0.1.0 → 0.9.0

data/Gemfile.lock

@@ -18,6 +18,7 @@ GEM
       redis-namespace (~> 0.10.0)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES

data/README.rdoc

@@ -17,6 +17,42 @@ until the next message is available (or a timeout occurs).
 Pistachio combines this all into a single, easy-to-use Rack middleware for
 delivering realtime push notification events to HTTP clients like web browsers.
 
+== Using Pistachio in your Rack application
+
+Add the following to your config.ru file:
+
+  Pistachio.setup :default, :adapter   => :redis, 
+                            :namespace => 'myapp_name',
+                            :path      => '/message_path'
+                            
+  use Pistachio::Middleware
+  
+This will configure Pistachio to talk to Redis, store its messages in the
+'myapp_name' Redis namespace, and mount the Pistachio Rack middleware
+under the /message_path path.
+
+All messages must be sent to a given named endpoint. To send a message via
+Pistachio within your Rack application, do:
+
+  Pistachio[:foobar] << "my totally awesome message"
+
+Messages sent to the 'foobar' endpoint can be retrieved by making an HTTP GET
+request to /message_path/foobar. This will return one of two HTTP statuses:
+
+* 200: a message was retrieved successfully
+* 504: the request timed out before a message was received
+
+By default Pistachio uses a 30 second timeout. You can adjust this with the
+':timeout' parameter to Pistachio.setup.
+
+It's the responsibility of the client to hit the given message endpoint in a
+loop. If the client gets a 504 response it should retry. Any other HTTP
+responses should be considered errors, in which case it'd be good if the
+client utilized exponential backoff to avoid hammering Pistachio when errors
+are occurring.
+
+No reference clients are presently available. Pull requests happily accepted!
+
 == Copyright
 
 Copyright (c) 2010 Tony Arcieri. See file LICENSE for further details.

data/Rakefile

@@ -25,7 +25,7 @@ Jeweler::Tasks.new do |gem|
   gem.add_runtime_dependency "stash", ">= 1.0.0"
   gem.add_runtime_dependency "rack",  "~> 1.2.0"
   
-  gem.add_development_dependency 'rspec', '>= 2.1.0'
+  gem.add_development_dependency 'rack-test', '>= 0.5.0'
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.9.0

data/config.ru

@@ -1,5 +1,7 @@
 require 'bundler/setup'
-require File.expand_path('../lib/pistachio', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'pistachio'
 
 Bundler.setup :default
 run Pistachio.new

data/lib/pistachio.rb

@@ -1,41 +1,33 @@
 require 'rack'
 require 'stash'
+require 'pistachio/middleware'
 
-class Pistachio  
-  def initialize(connection_name, options = {})
-    unless connection_name == :default
-      raise ArgumentError, "only the default connection is supported, sorry"
-    end
+module Pistachio
+  class << self
+    attr_reader :path, :timeout
+  
+    def setup(connection_name, options = {})
+      unless connection_name == :default
+        raise ArgumentError, "only the default connection is supported, sorry"
+      end
     
-    opts = {
-      :path    => '/push_messages',
-      :adapter => 'redis',
-      :host    => 'localhost',
-      :timeout => 30
-    }.merge(options)
+      opts = {
+        :path    => '/push_messages',
+        :adapter => 'redis',
+        :host    => 'localhost',
+        :timeout => 30
+      }.merge(options)
     
-    @path    = opts[:path]
-    @timeout = opts[:timeout]
+      @path    = opts[:path]
+      @timeout = opts[:timeout]
     
-    Stash.setup :default, opts
-  end
-  
-  # Retrieve a Pistachio endpoint for the default connection
-  def [](endpoint)
-    Stash::List[endpoint]
-  end
+      Stash.setup :default, opts
+      true
+    end
   
-  def call(env)
-    request = Rack::Request.new(env)
-    result = request.path.match(/^#{@path}\/(\w+)$/) 
-    return unless result
-    
-    endpoint = result[1]
-    begin
-      message = Stash::List[endpoint].bshift @timeout
-      [200, {'Content-Type' => 'text/plain'}, message]
-    rescue Stash::TimeoutError
-      [504, {'Content-Type' => 'text/plain'}, "Timeout waiting for response"]
+    # Retrieve a Pistachio endpoint for the default connection
+    def [](endpoint)
+      Stash::List[endpoint]
     end
   end
 end

data/lib/pistachio/middleware.rb

@@ -0,0 +1,23 @@
+module Pistachio
+  class Middleware
+    def initialize
+      # Matches messages that should be processed by Pistachio
+      @path_regex = /^#{Pistachio.path}\/(\w+)$/
+      @timeout = Pistachio.timeout
+    end
+    
+    def call(env)
+      request = Rack::Request.new(env)
+      result = request.path.match(@path_regex) 
+      return unless result
+
+      endpoint = result[1]
+      begin
+        message = Stash::List[endpoint].bshift @timeout
+        [200, {'Content-Type' => 'text/plain'}, message]
+      rescue Stash::TimeoutError
+        [504, {'Content-Type' => 'text/plain'}, "Timeout waiting for response"]
+      end
+    end
+  end
+end

data/pistachio.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pistachio}
-  s.version = "0.1.0"
+  s.version = "0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tony Arcieri"]
-  s.date = %q{2010-12-13}
+  s.date = %q{2011-02-15}
   s.description = %q{Pistachio provides a simple HTTP long polling middleware for Rack which is backed by the Stash gem}
   s.email = %q{tony@medioh.com}
   s.extra_rdoc_files = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "config.ru",
     "lib/pistachio.rb",
+    "lib/pistachio/middleware.rb",
     "pistachio.gemspec",
     "test/helper.rb",
     "test/rack/test_pistachio.rb"
@@ -33,7 +34,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/tarcieri/pistachio}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{HTTP push middleware for Rack powered by Stash}
   s.test_files = [
     "test/helper.rb",
@@ -44,7 +45,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<stash>, ["~> 1.0.0"])
       s.add_runtime_dependency(%q<rack>, ["~> 1.2.0"])
       s.add_development_dependency(%q<rack-test>, ["~> 0.5.0"])
@@ -52,7 +53,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
       s.add_runtime_dependency(%q<stash>, [">= 1.0.0"])
       s.add_runtime_dependency(%q<rack>, ["~> 1.2.0"])
-      s.add_development_dependency(%q<rspec>, [">= 2.1.0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0.5.0"])
     else
       s.add_dependency(%q<stash>, ["~> 1.0.0"])
       s.add_dependency(%q<rack>, ["~> 1.2.0"])
@@ -61,7 +62,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
       s.add_dependency(%q<stash>, [">= 1.0.0"])
       s.add_dependency(%q<rack>, ["~> 1.2.0"])
-      s.add_dependency(%q<rspec>, [">= 2.1.0"])
+      s.add_dependency(%q<rack-test>, [">= 0.5.0"])
     end
   else
     s.add_dependency(%q<stash>, ["~> 1.0.0"])
@@ -71,7 +72,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
     s.add_dependency(%q<stash>, [">= 1.0.0"])
     s.add_dependency(%q<rack>, ["~> 1.2.0"])
-    s.add_dependency(%q<rspec>, [">= 2.1.0"])
+    s.add_dependency(%q<rack-test>, [">= 0.5.0"])
   end
 end
 

data/test/helper.rb

@@ -10,6 +10,9 @@ end
 require 'test/unit'
 require 'rack/test'
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'pistachio'
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'pistachio'
+
+Pistachio.setup :default, :adapter => :redis, 
+                          :namespace => 'test_pistachio'

data/test/rack/test_pistachio.rb

@@ -4,12 +4,11 @@ class TestPistachio < Test::Unit::TestCase
   include Rack::Test::Methods
   
   def app
-    Pistachio.new :default, :adapter => :redis, 
-                            :namespace => 'test_pistachio'
+    Pistachio::Middleware.new
   end
   
   def test_sending_messages
-    app[:lolendpoint] << 'ohai'
+    Pistachio[:lolendpoint] << 'ohai'
     
     get "/push_messages/lolendpoint"
     

metadata

@@ -1,151 +1,134 @@
 --- !ruby/object:Gem::Specification 
 name: pistachio
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: false
   segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+    - 0
+    - 9
+    - 0
+  version: 0.9.0
 platform: ruby
 authors: 
-- Tony Arcieri
+  - Tony Arcieri
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-12-13 00:00:00 -07:00
+date: 2011-02-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
-  name: stash
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
-  name: rack
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 2
-        - 0
-        version: 1.2.0
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  name: rack-test
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 0
-        - 5
-        - 0
-        version: 0.5.0
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  name: bundler
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  name: jeweler
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
-  name: stash
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
-  name: rack
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 2
-        - 0
-        version: 1.2.0
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  name: rspec
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 1
-        - 0
-        version: 2.1.0
-  version_requirements: *id008
+  - !ruby/object:Gem::Dependency 
+    name: stash
+    version_requirements: &id001 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 0
+              - 0
+            version: 1.0.0
+    requirement: *id001
+    prerelease: false
+    type: :runtime
+  - !ruby/object:Gem::Dependency 
+    name: rack
+    version_requirements: &id002 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 2
+              - 0
+            version: 1.2.0
+    requirement: *id002
+    prerelease: false
+    type: :runtime
+  - !ruby/object:Gem::Dependency 
+    name: rack-test
+    version_requirements: &id003 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+              - 5
+              - 0
+            version: 0.5.0
+    requirement: *id003
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: bundler
+    version_requirements: &id004 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 0
+              - 0
+            version: 1.0.0
+    requirement: *id004
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: jeweler
+    version_requirements: &id005 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 5
+              - 1
+            version: 1.5.1
+    requirement: *id005
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: stash
+    version_requirements: &id006 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 0
+              - 0
+            version: 1.0.0
+    requirement: *id006
+    prerelease: false
+    type: :runtime
+  - !ruby/object:Gem::Dependency 
+    name: rack
+    version_requirements: &id007 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 2
+              - 0
+            version: 1.2.0
+    requirement: *id007
+    prerelease: false
+    type: :runtime
+  - !ruby/object:Gem::Dependency 
+    name: rack-test
+    version_requirements: &id008 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+              - 5
+              - 0
+            version: 0.5.0
+    requirement: *id008
+    prerelease: false
+    type: :development
 description: Pistachio provides a simple HTTP long polling middleware for Rack which is backed by the Stash gem
 email: tony@medioh.com
 executables: []
@@ -153,55 +136,52 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+  - LICENSE
+  - README.rdoc
 files: 
-- .document
-- Gemfile
-- Gemfile.lock
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- config.ru
-- lib/pistachio.rb
-- pistachio.gemspec
-- test/helper.rb
-- test/rack/test_pistachio.rb
+  - .document
+  - Gemfile
+  - Gemfile.lock
+  - LICENSE
+  - README.rdoc
+  - Rakefile
+  - VERSION
+  - config.ru
+  - lib/pistachio.rb
+  - lib/pistachio/middleware.rb
+  - pistachio.gemspec
+  - test/helper.rb
+  - test/rack/test_pistachio.rb
 has_rdoc: true
 homepage: http://github.com/tarcieri/pistachio
 licenses: 
-- MIT
+  - MIT
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: HTTP push middleware for Rack powered by Stash
 test_files: 
-- test/helper.rb
-- test/rack/test_pistachio.rb
+  - test/helper.rb
+  - test/rack/test_pistachio.rb