faye-redis-delayed 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bba15ea8458e08d1b6418b19ee79378395f83b5
-  data.tar.gz: ba6ede85751f32d49f88e0580278e2af09a3b75d
+  metadata.gz: a969a08d29a772df03ab22d2e458b76af12c35b6
+  data.tar.gz: 96fd1c85787c631167fcc972c9e951209509eb16
 SHA512:
-  metadata.gz: 51b998743c677c9ee044f853f100f5169c7d56bbba30e7feaa32be195c5abacf4d243f5e351ac1f79ae9f6af116525ee8b3319dd6f23f470cfa92ce9727cbbf2
-  data.tar.gz: 4fc36f61365e37319acdf24337e084e45e743e2cb7c5e77e325f4c09a27192dbd84cbe9d02c5963d09d048cd6dca74630bb8eb63a178dc7aee3747dfd49798a5
+  metadata.gz: 28907519b98799fdc2519ab7f74381d5bf09d9ab2189edce37c835e7d242d3c54e39d3addd318a50789c93dc6e346e2429c929e60e2155b84d831d728c876e55
+  data.tar.gz: 5d9f0310e4c2bfecf07be6f7eb6fa4e7113dc6a9971f0e574b9e6f81c96a1dbdbe47979b05f6399be04fd220dcaff0ad76fa5f64b4e628035fd4cc113db2fd5d

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/{LICENSE → LICENSE.txt}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013 Monterail
+Copyright (c) 2013-2014 Monterail.com LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -1,36 +1,52 @@
-# Faye::RedisDelayed
+# Faye::RedisDelayed [![Gem Version](https://badge.fury.io/rb/faye-redis-delayed.png)](http://badge.fury.io/rb/faye-redis-delayed) [![Circle CI](https://circleci.com/gh/monterail/faye-redis-delayed.png?style=shield)](https://circleci.com/gh/monterail/faye-redis-delayed)
 
-Delayed Redis engine backend for Faye
+> Delayed Redis engine back-end for [Faye](http://faye.jcoglan.com/) Ruby server. Enables delivey of messages that were sent *before* a client has connected to the channel.
+
+Turn this timeline:
+
+![Regular faye](https://monterail-share.s3.amazonaws.com/public/codetunes/2013-02-11-robust-dashboard-application-with-faye/tymon-faye-timeline1.png)
+
+…into that:
+
+![RedisDelayed faye](https://monterail-share.s3.amazonaws.com/public/codetunes/2013-02-11-robust-dashboard-application-with-faye/tymon-faye-timeline2.png)
+
+You can read about the [real case scenario](http://codetunes.com/2013/robust-dashboard-application-with-faye/) for the engine.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application’s `Gemfile`:
 
-    gem 'faye-redis-delayed'
+```rb
+gem 'faye-redis-delayed'
+```
 
 ## Usage
 
-Pass in the engine and any settings you need when setting up your Faye server.
+When initializing a new Faye server, reference the engine and pass any required settings.
 
 ```rb
+# faye config.ru
 require 'faye'
-require 'faye/redis'
+require 'faye/redis_delayed'
 
-bayeux = Faye::RackAdapter.new(
+server = Faye::RackAdapter.new(
   :mount   => '/',
   :timeout => 25,
   :engine  => {
-    :type  => Faye::RedisDelayed,
-    # more options
+    :type   => Faye::RedisDelayed,  # set the engine type
+    :expire => 30                   # undelivered messages will expire in 30 seconds
+    # …                             # other Faye::Redis engine options
   }
 )
+
+run server
 ```
 
-Full list of options see [faye-redis](https://github.com/faye/faye-redis-ruby)
+Additional options provided by `Faye::DelayedRedis`:
 
-Additional options:
+* `:expire` — expire time in seconds, defaults to `60`
 
-* <b>`:expire`</b> - expire time in seconds, default 60
+See the full list of [`Faye::Redis` engine options](https://github.com/faye/faye-redis-ruby).
 
 ## Contributing
 

data/faye-redis-delayed.gemspec

@@ -3,22 +3,29 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = "faye-redis-delayed"
-  spec.version       = "0.0.1"
-  spec.authors       = ["Dariusz Gertych"]
-  spec.email         = ["dariusz.gertych@gmail.com"]
+  spec.name          = 'faye-redis-delayed'
+  spec.version       = '0.0.2'
+  spec.authors       = ['Dariusz Gertych']
+  spec.email         = ['dariusz.gertych@gmail.com']
   spec.description   = %q{Delayed Redis engine backend for Faye}
   spec.summary       = %q{Delayed Redis engine backend for Faye}
-  spec.homepage      = "https://github.com/monterail/faye-redis-delayed"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/monterail/faye-redis-delayed'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
+  spec.add_dependency 'faye'
   spec.add_dependency 'faye-redis', '>= 0.2.0'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_dependency 'multi_json', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'thin'
+  spec.add_development_dependency 'eventmachine'
 end

data/lib/faye/redis_delayed.rb

@@ -13,7 +13,7 @@ module Faye
       # fetch awaiting messages from redis and publish them
       @redis.lpop(@ns + "/channels#{channel}/awaiting_messages") do |json_message|
         if json_message
-          message = Yajl::Parser.parse(json_message)
+          message = MultiJson.load(json_message)
           publish(message, [message["channel"]], json_message)
           publish_awaiting_messages(channel)
         end

data/spec/delayed_spec.rb

@@ -0,0 +1,155 @@
+require "spec_helper"
+
+require "rack/server"
+require "net/http"
+require "eventmachine"
+
+require "faye"
+require "faye/redis_delayed"
+
+Faye::WebSocket.load_adapter('thin')
+
+class TestServer
+  def initialize
+    @host = "localhost"
+    @port = 9292
+
+    faye.bind(:subscribe) do |client_id, channel|
+      puts "SUBSCRIBE  #{client_id} #{channel}"
+    end
+
+    faye.bind(:publish) do |client_id, channel, data|
+      puts "PUBLISH    #{client_id} #{channel}"
+    end
+
+    faye.bind(:handshake) do |client_id|
+      puts "HANDSHAKE  #{client_id}"
+    end
+
+    faye.bind(:disconnect) do |client_id|
+      puts "DISCONNECT #{client_id}"
+    end
+  end
+
+  def url
+    "http://#{@host}:#{@port}/faye"
+  end
+
+  def up?
+    return false if @thread && @thread.join(0)
+
+    res = Net::HTTP.start(@host, @port) { |http| http.get('/') }
+    true
+  rescue SystemCallError
+    false
+  end
+
+  def boot
+    puts "[server] Booting faye server..."
+    @thread = Thread.new do
+      Rack::Server.start(
+        :Host => @host,
+        :Port => @port,
+        :app => faye,
+        :environment => "production"
+      )
+    end
+
+    Timeout.timeout(60) { @thread.join(0.1) until up? }
+  rescue Timeout::Error
+    raise "Rack application timed out during boot"
+  else
+    puts "[server] Faye server started"
+    self
+  end
+
+  def shutdown
+    puts "[server] Shutting down faye server"
+    @thread.kill
+    @thread.join
+  end
+
+  def faye
+    @faye ||= Faye::RackAdapter.new(
+      :mount   => '/',
+      :timeout => 25,
+      :engine  => {
+        :type   => Faye::RedisDelayed,
+        :namespace => redis_namespace,
+        :expire => 30
+      }
+    )
+  end
+
+  def redis_namespace
+    "faye-redis-delayed-test:#{rand(10000)}:"
+  end
+
+  def publish(channel, msg = {})
+    faye.get_client.publish(channel, msg)
+  end
+end
+
+class TestClient
+  attr_reader :messages
+
+  def initialize(url)
+    @url = url
+    @messages = []
+    @client = Faye::Client.new(@url)
+  end
+
+  def subscribe(channel)
+    @thread = Thread.new do
+      EM.run do
+        @client.subscribe(channel) do |message|
+          puts "RECEIVE"
+          @messages << message
+        end
+      end
+    end
+  end
+
+  def disconnect
+    @client.disconnect
+    @thread.kill
+    @thread.join
+  end
+
+end
+
+describe Faye::RedisDelayed do
+  let(:server) do
+    TestServer.new
+  end
+
+  let(:client) do
+    TestClient.new(server.url)
+  end
+
+  before do
+    server.boot
+  end
+
+  after do
+    client.disconnect
+    sleep 2
+    server.shutdown
+  end
+
+  specify "normal flow" do
+    client.subscribe("/normal")
+    sleep 2
+    server.publish("/normal", {:text => "hello"})
+    sleep 2
+    expect(client.messages.size).to eq(1)
+  end
+
+  specify "delayed flow" do
+    server.publish("/delayed", {:text => "hello delayed"})
+    sleep 2
+    client.subscribe("/delayed")
+    sleep 2
+    expect(client.messages.size).to eq(1)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# 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.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+end

metadata

@@ -1,55 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: faye-redis-delayed
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dariusz Gertych
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-30 00:00:00.000000000 Z
+date: 2014-10-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faye-redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
+  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: rack
+  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: thin
+  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: eventmachine
+  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: Delayed Redis engine backend for Faye
@@ -59,14 +143,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
 - Gemfile
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
 - faye-redis-delayed.gemspec
 - lib/faye-redis-delayed.rb
 - lib/faye/redis_delayed.rb
+- spec/delayed_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/monterail/faye-redis-delayed
 licenses:
 - MIT
@@ -77,18 +164,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Delayed Redis engine backend for Faye
-test_files: []
+test_files:
+- spec/delayed_spec.rb
+- spec/spec_helper.rb