pubsubstub 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8e3bd526a5467ef4743ae56b53494580dcdb2f1
-  data.tar.gz: 56214dcdc3e9dcd228724e986c118e64f8ff4bd8
+  metadata.gz: 13fa1f1bf8d271516e2ed2389138bf55184d8b13
+  data.tar.gz: dd1bfc72703d76dc3f6a826bd8b69121efaf1a42
 SHA512:
-  metadata.gz: fe3f0a3d0476c7efdb9e1d1e970e621a10dd4a26011f4cd3032952fa0b5b9f0c818fea9bf0b8f26f9c932b20bc759cc1aee726ee20739fc590cf329bb47b4632
-  data.tar.gz: a0683e93134dff4296d28cb41b8f4e979c67fd7dc86a8db82aef765b66a91c5f7b537c5ecd4e3231dad35091c004393246f0855b6b3355b63dc78585e5fee44d
+  metadata.gz: d3948cd0bbbc474de69185969dd120135941a16ecc4eb8c24fe508f80f83130a3b3f6faf4d0a7c6845f1050580222b059bb0581630d4bb4f09916593c0c9dd82
+  data.tar.gz: 03fe2195a09f6c5bf6cb275399e0f2a447a609c4241e355f3ca7b732edb7d0307157bcb17aee95d89bba99126b4a3c6aa914811d80a6dbc7f436cb5a9a466154

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
+  - 2.2.2
 script: rspec spec
+services:
+  - redis-server

data/example/Gemfile

@@ -0,0 +1,2 @@
+gem 'pubsubstub', path: '../'
+gem 'puma'

data/example/config.ru

@@ -0,0 +1,3 @@
+require 'pubsubstub'
+
+run Pubsubstub::Application

data/lib/pubsubstub/action.rb

@@ -4,6 +4,12 @@ module Pubsubstub
       enable :logging
     end
 
+    configure :test do
+      set :dump_errors, false
+      set :raise_errors, true
+      set :show_exceptions, false
+    end
+
     def initialize(*)
       @channels = Hash.new { |h, k| h[k] = Channel.new(k) }
       @connections = []

data/lib/pubsubstub/channel.rb

@@ -27,7 +27,6 @@ module Pubsubstub
       pubsub.publish(event)
     end
 
-    private
     def scrollback(connection, last_event_id)
       return unless last_event_id
       pubsub.scrollback(last_event_id) do |event|
@@ -35,6 +34,8 @@ module Pubsubstub
       end
     end
 
+    private
+
     def broadcast(json)
       string = Event.from_json(json).to_message
       @connections.each do |connection|

data/lib/pubsubstub/event.rb

@@ -1,35 +1,38 @@
 module Pubsubstub
   class Event
-    attr_reader :id, :name, :data
+    attr_reader :id, :name, :data, :retry_after
 
     def initialize(data, options = {})
       @id = options[:id] || time_now
       @name = options[:name]
+      @retry_after = options[:retry_after]
       @data = data
     end
 
     def to_json
-      {id: @id, name: @name, data: @data}.to_json
+      {id: @id, name: @name, data: @data, retry_after: @retry_after}.to_json
     end
 
     def to_message
       data = @data.split("\n").map{ |segment| "data: #{segment}" }.join("\n")
       message = "id: #{id}" << "\n"
       message << "event: #{name}" << "\n" if name
+      message << "retry: #{retry_after}" << "\n" if retry_after
       message << data << "\n\n"
       message
     end
 
     def self.from_json(json)
       hash = JSON.load(json)
-      new(hash['data'], name: hash['name'], id: hash['id'])
+      new(hash['data'], name: hash['name'], id: hash['id'], retry_after: hash['retry_after'])
     end
 
     def ==(other)
-      id == other.id && name == other.name && data == other.data
+      id == other.id && name == other.name && data == other.data && retry_after == other.retry_after
     end
 
     private
+
     def time_now
       (Time.now.to_f * 1000).to_i
     end

data/lib/pubsubstub/redis_pub_sub.rb

@@ -17,14 +17,21 @@ module Pubsubstub
     end
 
     def scrollback(since_event_id)
-      self.class.nonblocking_redis.zrangebyscore(key('scrollback'), "(#{since_event_id.to_i}", '+inf') do |events|
+      redis = if EventMachine.reactor_running?
+        self.class.nonblocking_redis
+      else
+        self.class.blocking_redis
+      end
+
+      redis.zrangebyscore(key('scrollback'), "(#{since_event_id.to_i}", '+inf') do |events|
         events.each do |json|
           yield Pubsubstub::Event.from_json(json)
         end
       end
     end
 
-    protected
+    private
+
     def key(purpose)
       [@channel_name, purpose].join(".")
     end
@@ -40,11 +47,15 @@ module Pubsubstub
       end
 
       def blocking_redis
-        @blocking_redis ||= Redis.new(url: (ENV['REDIS_URL'] || "redis://localhost:6379"))
+        @blocking_redis ||= Redis.new(url: redis_url)
       end
 
       def nonblocking_redis
-        @nonblocking_redis ||= EM::Hiredis.connect(ENV['REDIS_URL'] || "redis://localhost:6379")
+        @nonblocking_redis ||= EM::Hiredis.connect(redis_url)
+      end
+
+      def redis_url
+        ENV['REDIS_URL'] || "redis://localhost:6379"
       end
     end
   end

data/lib/pubsubstub/stream_action.rb

@@ -1,5 +1,7 @@
 module Pubsubstub
   class StreamAction < Pubsubstub::Action
+    RECONNECT_TIMEOUT = 10_000
+
     def initialize(*)
       super
       start_heartbeat
@@ -12,31 +14,72 @@ module Pubsubstub
         'X-Accel-Buffering' => 'no',
         'Connection' => 'keep-alive',
       })
+
+      if EventMachine.reactor_running?
+        subscribe_connection
+      else
+        return_scrollback
+      end
+    end
+
+    private
+
+    def return_scrollback
+      buffer = ''
+      ensure_connection_has_event(buffer)
+
+      with_each_channel do |channel|
+        channel.scrollback(buffer, last_event_id)
+      end
+
+      buffer
+    end
+
+    def last_event_id
+      request.env['HTTP_LAST_EVENT_ID']
+    end
+
+    def subscribe_connection
       stream(:keep_open) do |connection|
         @connections << connection
-        channels = params[:channels] || [:default]
-        channels.each do |channel_name|
-          channel(channel_name).subscribe(connection, last_event_id: request.env['HTTP_LAST_EVENT_ID'])
+        ensure_connection_has_event(connection)
+        with_each_channel do |channel|
+          channel.subscribe(connection, last_event_id: last_event_id)
         end
 
         connection.callback do
           @connections.delete(connection)
-          channels.each do |channel_name|
-            channel(channel_name).unsubscribe(connection)
+          with_each_channel do |channel|
+            channel.unsubscribe(connection)
           end
         end
       end
     end
 
-    private
+    def ensure_connection_has_event(connection)
+      return if last_event_id
+      connection << heartbeat_event.to_message
+    end
+
     def start_heartbeat
       @heartbeat = Thread.new do
         loop do
           sleep Pubsubstub.heartbeat_frequency
-          event = Event.new('ping', name: 'heartbeat').to_message
+          event = heartbeat_frequency.to_message
           @connections.each { |connection| connection << event }
         end
       end
     end
+
+    def with_each_channel(&block)
+      channels = params[:channels] || [:default]
+      channels.each do |channel_name|
+        yield channel(channel_name)
+      end
+    end
+
+    def heartbeat_event
+      Event.new('ping', name: 'heartbeat', retry_after: RECONNECT_TIMEOUT)
+    end
   end
 end

data/lib/pubsubstub/version.rb

@@ -1,3 +1,3 @@
 module Pubsubstub
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/pubsubstub.gemspec

@@ -25,7 +25,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.2"
-  spec.add_development_dependency "rspec", "~> 2.14"
-  spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "rspec", "3.1.0"
+  spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "thin", "~> 1.6"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "em-spec"
 end

data/spec/channel_spec.rb

@@ -80,4 +80,14 @@ describe Pubsubstub::Channel do
       subject.send(:broadcast, event.to_json)
     end
   end
+
+  context "#scrollback" do
+    it "sends events to the connection buffer" do
+      event = Pubsubstub::Event.new("message")
+      expect(pubsub).to receive(:scrollback).and_yield(event)
+      connection = ""
+      subject.scrollback(connection, 1)
+      expect(connection).to eq(event.to_message)
+    end
+  end
 end

data/spec/event_spec.rb

@@ -1,15 +1,17 @@
 require 'spec_helper'
 
 describe Pubsubstub::Event do
-  subject { Pubsubstub::Event.new("refresh #1500\nnew #1400", id: 12345678, name: "toto") }
+  subject {
+    Pubsubstub::Event.new("refresh #1500\nnew #1400", id: 12345678, name: "toto", retry_after: 1_000)
+  }
 
   it "#to_json serialization" do
-    expect(subject.to_json).to be == {id: 12345678, name: "toto", data: "refresh #1500\nnew #1400"}.to_json
+    expect(subject.to_json).to be == {id: 12345678, name: "toto", data: "refresh #1500\nnew #1400", retry_after: 1_000}.to_json
   end
 
   context "#to_message" do
     it "serializes to sse" do
-      expect(subject.to_message).to be == "id: 12345678\nevent: toto\ndata: refresh #1500\ndata: new #1400\n\n"
+      expect(subject.to_message).to be == "id: 12345678\nevent: toto\nretry: 1000\ndata: refresh #1500\ndata: new #1400\n\n"
     end
 
     it "does not have event if no name is specified" do

data/spec/redis_pub_sub_spec.rb

@@ -65,7 +65,7 @@ describe Pubsubstub::RedisPubSub do
     it "yields the events in the scrollback" do
       redis = double('redis')
       expect(redis).to receive(:zrangebyscore).with('test.scrollback', '(1234', '+inf').and_yield([event1.to_json, event2.to_json])
-      expect(Pubsubstub::RedisPubSub).to receive(:nonblocking_redis).and_return(redis)
+      expect(Pubsubstub::RedisPubSub).to receive(:blocking_redis).and_return(redis)
       expect { |block| subject.scrollback(1234, &block) }.to yield_successive_args(event1, event2)
     end
   end

data/spec/spec_helper.rb

@@ -1,18 +1,21 @@
+require 'rack/test'
+require 'pry'
+require 'pry-byebug'
+require 'timecop'
+require 'em-spec/rspec'
+
+ENV['RACK_ENV'] = 'test'
 require_relative '../lib/pubsubstub'
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.include Rack::Test::Methods
+
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
+  config.color = true
 
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
   config.order = 'random'
+
+  config.before(:each) { Pubsubstub::RedisPubSub.blocking_redis.flushdb }
 end
+

data/spec/stream_action_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe "Pubsubstub::StreamAction without EventMachine" do
+  before {
+    allow(EventMachine).to receive(:reactor_running?).and_return(false)
+  }
+
+  let(:app) { Pubsubstub::StreamAction.new }
+  it "returns a heartbeat if there is no LAST_EVENT_ID" do
+    Timecop.freeze(DateTime.parse("2015-01-01T00:00:00+00:00")) do
+      event = Pubsubstub::Event.new(
+        'ping',
+        name: 'heartbeat',
+        retry_after: Pubsubstub::StreamAction::RECONNECT_TIMEOUT,
+      )
+      get "/"
+      expect(last_response.body).to eq(event.to_message)
+    end
+  end
+
+  it "returns an empty body if a LAST_EVENT_ID is provided and there is no scrollback" do
+    get "/", {}, 'HTTP_LAST_EVENT_ID' => 1
+    expect(last_response.body).to eq('')
+  end
+
+  it "returns the content of the scrollback" do
+    event = Pubsubstub::Event.new("test")
+    expect_any_instance_of(Pubsubstub::Channel).to receive(:scrollback).and_return([event])
+
+    get "/", {}, 'HTTP_LAST_EVENT_ID' => 1
+  end
+end
+
+describe "Pubsubstub::StreamAction with EventMachine" do
+  include EventMachine::SpecHelper
+
+  let(:app) {
+    Pubsubstub::StreamAction.new
+  }
+
+  it "returns a heartbeat if there is no LAST_EVENT_ID" do
+    Timecop.freeze(DateTime.parse("2015-01-01T00:00:00+00:00")) do
+      event = Pubsubstub::Event.new(
+        'ping',
+        name: 'heartbeat',
+        retry_after: Pubsubstub::StreamAction::RECONNECT_TIMEOUT,
+      )
+      get "/"
+      expect(last_response.body).to eq(event.to_message)
+    end
+  end
+
+  it "subscribes the connection to the channel" do
+    event = Pubsubstub::Event.new('ping')
+    channel = Pubsubstub::Channel.new(:default)
+    allow_any_instance_of(Pubsubstub::StreamAction).to receive(:with_each_channel).and_yield(channel)
+
+    em do
+      env = current_session.send(:env_for, "/", 'HTTP_LAST_EVENT_ID' => 1)
+      request = Rack::Request.new(env)
+      status, headers, body = app.call(request.env)
+
+      response = Rack::MockResponse.new(status, headers, body, env["rack.errors"].flush)
+      channel.send(:broadcast, event.to_json)
+
+      EM.next_tick {
+        body.close
+        response.finish
+
+        expect(response.body).to eq(event.to_message)
+        EM.stop
+      }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pubsubstub
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Guillaume Malette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2015-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -98,30 +98,30 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Pubsubstub can be added to a rack Application or deployed standalone.
   It uses Redis to do the Pub/Sub
 email:
@@ -151,6 +193,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- example/Gemfile
+- example/config.ru
 - lib/pubsubstub.rb
 - lib/pubsubstub/action.rb
 - lib/pubsubstub/application.rb
@@ -165,6 +209,7 @@ files:
 - spec/event_spec.rb
 - spec/redis_pub_sub_spec.rb
 - spec/spec_helper.rb
+- spec/stream_action_spec.rb
 homepage: https://github.com/gmalette/pubsubstub
 licenses:
 - MIT
@@ -185,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Pubsubstub is a rack middleware to add Pub/Sub
@@ -194,3 +239,4 @@ test_files:
 - spec/event_spec.rb
 - spec/redis_pub_sub_spec.rb
 - spec/spec_helper.rb
+- spec/stream_action_spec.rb