pubsubstub 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 90b72c7935cf8e1f3f6320f1b6a4ea00844a4144
-  data.tar.gz: 81620ee43f4d51c1dc06822c66864430b0196263
+SHA256:
+  metadata.gz: 115205de6d2987f1c983becef16c87452d844b33001a335105eb96f9a945ba74
+  data.tar.gz: d32a258717cb23cecc7d81e954938c499ffa6d8a9fdd68340a9e62cecbcffb17
 SHA512:
-  metadata.gz: a9a40ad176ccb066f1d3fd2514e4d2b3e3402bf2e072a7540ae94a7283244c5ecbc4bbe9e8be63e9311db38668d275c466990b8c8de7655994cec9c5f95f03de
-  data.tar.gz: 4420554341dd097571627040b898c40c8790722c0da008b7a9e6d9f370d2c02780ad186379d5fb36aba28625bc5350fdfe5103535341209807d749ce15392198
+  metadata.gz: f92c6a3acf01542564683a9adf952ac0660bbc82612f294d34ba15864aac95d22b0ac9d778a7474101612528c6948e528a3291286c65e410a42394cbc5d9d2a3
+  data.tar.gz: 3caa10c0cebbe247632faf75d1259e4cba5fdfa8504b594f10826d8e6840ca560bb3d037c11d0e51acc65186ae73e1597199180a2d0880aea11d587fabc8feeb

data/.travis.yml

@@ -1,6 +1,12 @@
 language: ruby
 rvm:
-  - 2.2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6.3
+gemfile:
+  - gemfiles/Gemfile.rack-1.x
+  - gemfiles/Gemfile.rack-2.x
 services:
   - redis-server
 

data/Gemfile

@@ -3,10 +3,11 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in pubsubstub.gemspec
 gemspec
 
-gem "rspec", "3.1.0"
+gem 'rspec', '~> 3.8'
 gem "pry-byebug"
+gem "byebug", '~> 10.0'
 gem "puma", "~> 3.4"
 gem "thin", "~> 1.6"
 gem "rack-test"
 gem "timecop"
-gem "rake", "~> 10.0"
+gem "rake"

data/Rakefile

@@ -4,3 +4,23 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+namespace :spec do
+  task :all do
+    Dir['gemfiles/*'].reject { |p| p.end_with?('.lock') }.each do |gemfile|
+      command = %(BUNDLE_GEMFILE=#{gemfile} bundle exec rspec)
+      puts command
+      system(command)
+    end
+  end
+end
+
+namespace :gemfiles do
+  task :update do
+    Dir['gemfiles/*'].reject { |p| p.end_with?('.lock') }.each do |gemfile|
+      command = %(BUNDLE_GEMFILE=#{gemfile} bundle update)
+      puts command
+      system(command)
+    end
+  end
+end

data/example/config.ru

@@ -1,4 +1,3 @@
-p File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 require 'pubsubstub'
 

data/gemfiles/Gemfile.rack-1.x

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rack', '< 2'
+gem 'redis', '~> 4.0'
+gem 'rspec', '~> 3.8'
+gem "pry-byebug"
+gem "byebug", '~> 10.0'
+gem "puma", "~> 3.4"
+gem "thin", "~> 1.6"
+gem "rack-test"
+gem "timecop"
+gem "rake"

data/gemfiles/Gemfile.rack-1.x.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    coderay (1.1.2)
+    daemons (1.3.1)
+    diff-lcs (1.3)
+    eventmachine (1.2.7)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    puma (3.12.1)
+    rack (1.6.11)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (12.3.3)
+    redis (4.1.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thin (1.7.2)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    timecop (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 10.0)
+  pry-byebug
+  puma (~> 3.4)
+  rack (< 2)
+  rack-test
+  rake
+  redis (~> 4.0)
+  rspec (~> 3.8)
+  thin (~> 1.6)
+  timecop
+
+BUNDLED WITH
+   1.17.3

data/gemfiles/Gemfile.rack-2.x

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rack', '~> 2.0'
+gem 'redis', '~> 4.0'
+gem 'rspec', '~> 3.8'
+gem "pry-byebug"
+gem "byebug", '~> 10.0'
+gem "puma", "~> 3.4"
+gem "thin", "~> 1.6"
+gem "rack-test"
+gem "timecop"
+gem "rake"

data/gemfiles/Gemfile.rack-2.x.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    coderay (1.1.2)
+    daemons (1.3.1)
+    diff-lcs (1.3)
+    eventmachine (1.2.7)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    puma (3.12.1)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (12.3.3)
+    redis (4.1.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thin (1.7.2)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    timecop (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 10.0)
+  pry-byebug
+  puma (~> 3.4)
+  rack (~> 2.0)
+  rack-test
+  rake
+  redis (~> 4.0)
+  rspec (~> 3.8)
+  thin (~> 1.6)
+  timecop
+
+BUNDLED WITH
+   1.17.3

data/lib/pubsubstub.rb

@@ -3,7 +3,7 @@ require "mutex_m"
 require "json"
 require "set"
 
-require "sinatra"
+require "rack/request"
 require "redis"
 require "pubsubstub/version"
 require "pubsubstub/logging"
@@ -11,7 +11,7 @@ require "pubsubstub/channel"
 require "pubsubstub/subscriber"
 require "pubsubstub/subscription"
 require "pubsubstub/event"
-require "pubsubstub/action"
+require "pubsubstub/stream"
 require "pubsubstub/stream_action"
 require "pubsubstub/publish_action"
 require "pubsubstub/application"
@@ -21,7 +21,8 @@ module Pubsubstub
 
   class << self
     attr_accessor :heartbeat_frequency, :redis_url, :channels_scrollback_size,
-      :channels_scrollback_ttl, :logger, :reconnect_timeout, :error_handler
+      :channels_scrollback_ttl, :logger, :reconnect_timeout, :error_handler,
+      :use_persistent_connections
 
     def publish(channel_name, *args)
       Channel.new(channel_name).publish(Event.new(*args))
@@ -69,6 +70,7 @@ module Pubsubstub
   self.channels_scrollback_size = 1000
   self.channels_scrollback_ttl = 24 * 60 * 60
   self.reconnect_timeout = 10_000
+  self.use_persistent_connections = true
 
   # Deprecated. Use Pubsubstub.publish instead
   module RedisPubSub

data/lib/pubsubstub/application.rb

@@ -1,6 +1,22 @@
 module Pubsubstub
-  class Application < Sinatra::Base
-    use PublishAction
-    use StreamAction
+  class Application
+    def initialize(*)
+      @publish = PublishAction.new
+      @stream = StreamAction.new
+    end
+
+    def self.call(env)
+      @instance ||= new
+      @instance.call(env)
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      if request.get?
+        @stream.call(env)
+      else
+        @publish.call(env)
+      end
+    end
   end
 end

data/lib/pubsubstub/publish_action.rb

@@ -1,10 +1,14 @@
 module Pubsubstub
-  class PublishAction < Pubsubstub::Action
-    post '/' do
-      (params[:channels] || [:default]).each do |channel_name|
-        Pubsubstub.publish(channel_name, params[:data], name: params[:event])
+  class PublishAction
+    def initialize(*)
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      channels = (request.params['channels'] || [:default]).each do |channel_name|
+        Pubsubstub.publish(channel_name, request.params['data'], name: request.params['event'])
       end
-      ""
+      [200, {}, ['']]
     end
   end
 end

data/lib/pubsubstub/stream.rb

@@ -0,0 +1,25 @@
+class Stream
+  def initialize(&callback)
+    @callback = callback
+    @closed = false
+  end
+
+  def close
+    @closed = true
+  end
+
+  def each(&front)
+    @front = front
+    @callback.call(self)
+    close
+  end
+
+  def <<(data)
+    @front.call(data.to_s)
+    self
+  end
+
+  def closed?
+    @closed
+  end
+end

data/lib/pubsubstub/stream_action.rb

@@ -1,60 +1,55 @@
 module Pubsubstub
-  class StreamAction < Pubsubstub::Action
+  class StreamAction
+    HEADERS = {
+      'Content-Type' => 'text/event-stream',
+      'Cache-Control' => 'no-cache',
+      'X-Accel-Buffering' => 'no',
+      'Connection' => 'keep-alive',
+    }.freeze
     include Logging
 
     def initialize(*)
-      super
       @subscriptions = Set.new
       @mutex = Mutex.new
     end
 
-    get '/', provides: 'text/event-stream' do
-      status(200)
-      headers({
-        'Cache-Control' => 'no-cache',
-        'X-Accel-Buffering' => 'no',
-        'Connection' => 'keep-alive',
-      })
+    def call(env)
+      spawn_helper_threads
+      last_event_id = env['HTTP_LAST_EVENT_ID']
+      request = Rack::Request.new(env)
+      channels = (request.params['channels'] || [:default]).map(&Channel.method(:new))
 
-      if event_machine?
-        send_scrollback
+      stream = if use_persistent_connections?
+        subscribe_connection(channels, last_event_id)
       else
-        subscribe_connection
+        send_scrollback(channels, last_event_id)
       end
-    end
-
-    def call(*)
-      spawn_helper_threads
-      super
+      [200, HEADERS.dup, stream]
     end
 
     private
 
-    def last_event_id
-      request.env['HTTP_LAST_EVENT_ID']
-    end
-
-    def send_scrollback
+    def send_scrollback(channels, last_event_id)
       scrollback_events = []
       scrollback_events = channels.flat_map { |c| c.scrollback(since: last_event_id) } if last_event_id
       scrollback_events = [Pubsubstub.heartbeat_event] if scrollback_events.empty?
-      stream do |connection|
+      Stream.new do |connection|
         scrollback_events.each do |event|
           connection << event.to_message
         end
       end
     end
 
-    def event_machine?
-      defined?(EventMachine) && EventMachine.reactor_running?
+    def use_persistent_connections?
+      Pubsubstub.use_persistent_connections && !event_machine?
     end
 
-    def channels
-      (params[:channels] || [:default]).map(&Channel.method(:new))
+    def event_machine?
+      defined?(EventMachine) && EventMachine.reactor_running?
     end
 
-    def subscribe_connection
-      stream do |connection|
+    def subscribe_connection(channels, last_event_id)
+      Stream.new do |connection|
         subscription = register(channels, connection)
         begin
           subscription.stream(last_event_id)

data/lib/pubsubstub/subscriber.rb

@@ -31,7 +31,7 @@ module Pubsubstub
       # redis.client.call allow to bypass the client mutex
       # Since we now that the only other possible caller is blocking on reading the socket this is safe
       synchronize do
-        redis.client.call(['punsubscribe', pubsub_pattern])
+        redis._client.call(['punsubscribe', pubsub_pattern])
       end
     end
 

data/lib/pubsubstub/version.rb

@@ -1,3 +1,3 @@
 module Pubsubstub
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/pubsubstub.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'sinatra', "~> 1.4"
-  spec.add_dependency 'redis', "~> 3.0"
+  spec.add_dependency 'rack'
+  spec.add_dependency 'redis', "~> 4.0"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler"
 end

data/spec/channel_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Pubsubstub::Channel do
+RSpec.describe Pubsubstub::Channel do
   subject { described_class.new('foobar') }
 
   it "has a name" do

data/spec/event_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Pubsubstub::Event do
+RSpec.describe Pubsubstub::Event do
   subject {
     Pubsubstub::Event.new("refresh #1500\nnew #1400", id: 12345678, name: "toto", retry_after: 1_000)
   }

data/spec/publish_action_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Pubsubstub::StreamAction do
+RSpec.describe Pubsubstub::StreamAction do
   let(:app) { Pubsubstub::PublishAction.new }
   let(:channel) { Pubsubstub::Channel.new('foo') }
 

data/spec/spec_helper.rb

@@ -19,7 +19,7 @@ Pubsubstub.logger.level = Logger::DEBUG
 # Fake EM
 module EventMachine
   extend self
-  
+
   def reactor_running?
     false
   end
@@ -36,4 +36,9 @@ RSpec.configure do |config|
   config.order = 'random'
 
   config.before(:each) { Redis.new(url: Pubsubstub.redis_url).flushdb }
+
+  # Clean threads after finish
+  config.after(:each) do
+    Thread.list.each { |thread| thread.join(0.5) if thread != Thread.current }
+  end
 end

data/spec/stream_action_spec.rb

@@ -1,5 +1,23 @@
 require 'spec_helper'
 
+RSpec.shared_examples "short lived connections" do
+  it "immediately returns the scrollback" do
+    Pubsubstub.publish('foo', 'bar', id: 1)
+    Pubsubstub.publish('foo', 'baz', id: 2)
+
+    get '/?channels[]=foo', {}, 'HTTP_LAST_EVENT_ID' => 1
+    expect(last_response.body).to eq("id: 2\ndata: baz\n\n")
+  end
+
+  it "returns and heartbeat if scrollback is empty" do
+    Timecop.freeze('2015-01-01T00:00:00+00:00') do
+      get '/'
+      message = "id: 1420070400000\nevent: heartbeat\nretry: #{Pubsubstub.reconnect_timeout}\ndata: ping\n\n"
+      expect(last_response.body).to eq(message)
+    end
+  end
+end
+
 describe Pubsubstub::StreamAction do
   let(:app) { Pubsubstub::StreamAction.new }
 
@@ -8,21 +26,18 @@ describe Pubsubstub::StreamAction do
       allow(EventMachine).to receive(:reactor_running?).and_return(true)
     end
 
-    it "immediately returns the scrollback" do
-      Pubsubstub.publish('foo', 'bar', id: 1)
-      Pubsubstub.publish('foo', 'baz', id: 2)
+    it_behaves_like "short lived connections"
+  end
 
-      get '/?channels[]=foo', {}, 'HTTP_LAST_EVENT_ID' => 1
-      expect(last_response.body).to eq("id: 2\ndata: baz\n\n")
+  context "with persistent connections disabled" do
+    around :example do |example|
+      previous = Pubsubstub.use_persistent_connections
+      Pubsubstub.use_persistent_connections = false
+      example.run
+      Pubsubstub.use_persistent_connections = previous
     end
 
-    it "returns and heartbeat if scrollback is empty" do
-      Timecop.freeze('2015-01-01T00:00:00+00:00') do
-        get '/'
-        message = "id: 1420070400000\nevent: heartbeat\nretry: #{Pubsubstub.reconnect_timeout}\ndata: ping\n\n"
-        expect(last_response.body).to eq(message)
-      end
-    end
+    it_behaves_like "short lived connections"
   end
 
   it "immediately send a heartbeat event if there is no scrollback" do

data/spec/subscriber_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Pubsubstub::Subscriber do
+RSpec.describe Pubsubstub::Subscriber do
   describe "#start" do
     let(:channel) { Pubsubstub::Channel.new('plop') }
     let(:events) { (1..10).map { |i| Pubsubstub::Event.new("refresh ##{i}", id: i) } }
@@ -10,12 +10,17 @@ describe Pubsubstub::Subscriber do
       subject.add_event_listener('plop', -> (event) { published_events << event })
       subscribe_thread = Thread.new { subject.start }
 
-      expect { subject.subscribed? }.to happen
+      expect { subject.subscribed? }.to happen.in_under(1)
 
       events.each(&channel.method(:publish))
 
+      expect { published_events.size == events.size }.to happen.in_under(2)
+
       subject.stop
-      expect { !subject.subscribed? }.to happen
+
+      subscribe_thread.join(2)
+
+      expect { ! subject.subscribed? }.to happen.in_under(1)
 
       expect(subscribe_thread).to complete
 

data/spec/subscription_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Pubsubstub::Subscription do
+RSpec.describe Pubsubstub::Subscription do
   let(:event) { Pubsubstub::Event.new('hello') }
   let(:connection) { [] }
   let(:channels) { %w(foo bar).map(&Pubsubstub::Channel.method(:new)) }

data/spec/support/http_helpers.rb

@@ -6,7 +6,7 @@ module HTTPHelpers
     queue = Queue.new
     Thread.start do
       begin
-        Net::HTTP.start(uri.host, uri.port) do |http|
+        Net::HTTP.start(uri.host, uri.port, open_timeout: 10) do |http|
           request = Net::HTTP::Get.new uri.request_uri
           headers.each do |name, value|
             request.add_field(name, value)

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: pubsubstub
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Guillaume Malette
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2020-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 description: Pubsubstub can be added to a rack Application or deployed standalone.
   It uses Redis to do the Pub/Sub
 email:
@@ -74,13 +74,17 @@ files:
 - example/Gemfile
 - example/config.ru
 - example/puma_config.rb
+- gemfiles/Gemfile.rack-1.x
+- gemfiles/Gemfile.rack-1.x.lock
+- gemfiles/Gemfile.rack-2.x
+- gemfiles/Gemfile.rack-2.x.lock
 - lib/pubsubstub.rb
-- lib/pubsubstub/action.rb
 - lib/pubsubstub/application.rb
 - lib/pubsubstub/channel.rb
 - lib/pubsubstub/event.rb
 - lib/pubsubstub/logging.rb
 - lib/pubsubstub/publish_action.rb
+- lib/pubsubstub/stream.rb
 - lib/pubsubstub/stream_action.rb
 - lib/pubsubstub/subscriber.rb
 - lib/pubsubstub/subscription.rb
@@ -99,7 +103,7 @@ homepage: https://github.com/gmalette/pubsubstub
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,9 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Pubsubstub is a rack middleware to add Pub/Sub
 test_files:

data/lib/pubsubstub/action.rb

@@ -1,13 +0,0 @@
-module Pubsubstub
-  class Action < Sinatra::Base
-    configure :production, :development do
-      enable :logging
-    end
-
-    configure :test do
-      set :dump_errors, false
-      set :raise_errors, true
-      set :show_exceptions, false
-    end
-  end
-end