RubyGems - garufa - Versions diffs - 1.1.0.rc.1 → 1.1.0.rc.2 - Mend

garufa 1.1.0.rc.1 → 1.1.0.rc.2

Files changed (17) hide show

data/README.md +9 -201
data/bin/garufa.pid +1 -1
data/garufa.gemspec +2 -0
data/lib/garufa/api/channel_filter.rb +13 -0
data/lib/garufa/api/channels.rb +31 -7
data/lib/garufa/api/event_handler.rb +1 -1
data/lib/garufa/{api.rb → api/server.rb} +0 -0
data/lib/garufa/api/settings_setter.rb +15 -0
data/lib/garufa/connection.rb +29 -3
data/lib/garufa/garufa_app.rb +4 -3
data/lib/garufa/message.rb +2 -2
data/lib/garufa/subscription.rb +5 -1
data/lib/garufa/subscriptions.rb +40 -4
data/lib/garufa/version.rb +1 -1
data/test/connection.rb +4 -4
data/test/subscriptions.rb +4 -4
metadata +37 -3

data/README.md CHANGED Viewed

@@ -13,207 +13,15 @@ Garufa is a Ruby websocket server which implements the Pusher protocol. It is
 built on top of [Goliath][goliath], a high performance non-blocking web server,
 and inspired by [Slanger][slanger], another server compatible with Pusher.
-Install
--------
-Be sure you have a ruby version >= 1.9.2
-``` console
-$ gem install garufa
-$ garufa --help
-```
-Usage
--------
-Start garufa server:
-``` console
-$ garufa -sv --app_id app-id --app_key app-key --secret app-secret
-```
-This will start Garufa, logging to stdout in verbose mode. If you want Garufa
-to run in background (daemonized) add `-d` flag.
-Now say you want to send events to your browser. Create an .html file which
-requires the *pusher.js* library and binds to some events, then point your
-browser to that file (for testing purpose, you can simply open it with your
-browser).
-Maybe you would like to open your JavaScript console to see JavaScript debug
-messages.
-``` html
-<html>
-  <script src="http://js.pusher.com/2.1/pusher.min.js"></script>
-  <script>
-    Pusher.log = function(message) { console.log(message) };
-    Pusher.host = 'localhost';
-    Pusher.ws_port = 8080;
-    var appKey = 'app-key';
-    var pusher = new Pusher(appKey);
-    var channel = pusher.subscribe('my-channel');
-    channel.bind('my-event', function(data) { alert(data.message) });
-  </script>
-</html>
-```
-Now trigger *my-event* from Ruby code. Be sure you have already installed
-the *pusher* gem (*gem install pusher*). Open a Ruby console and paste this:
-``` ruby
-require 'pusher'
-Pusher.host = 'localhost'
-Pusher.port = 8080
-Pusher.app_id = 'app-id'
-Pusher.key = 'app-key'
-Pusher.secret = 'app-secret'
-Pusher.trigger('my-channel', 'my-event', { message: 'hello world' })
-```
-Check your browser to see the event have just arrived.
-SSL support
------------
-``` console
-$ garufa -sv --app_key app-key --secret app-secret --ssl --ssl-cert /path/to/cert.pem --ssl-key /path/to/cert.key
-```
-**NOTE**: At the moment, Garufa uses the same port for API messages and websocket
-connections. This means that if you start the server with SSL enabled, you will
-have to enable SSL in the client library as well as in the api client.
-An alternative is to setup Garufa behind a reverse proxy such as Nginx and let the
-proxy take care of SSL. See below for more info.
-Using Nginx as reverse proxy
-----------------------
-You can set Garufa behind Nginx if you want: http://nginx.org/en/docs/http/websocket.html
-Take into account that you will need to set *proxy_read_timeout* to a value a little
-higher than Pusher *ACTIVITY_TIMEOUT*, otherwise Nginx will close the connection.
-In addition, you can let Ngnix take care of SSL and start Garufa without SSL enabled.
-You could use something like this in your Nginx configuration.
-```
-upstream garufa {
-    server 127.0.0.1:8000;
-}
-map $http_upgrade $connection_upgrade {
-    default upgrade;
-    ''      close;
-}
-server {
-    listen       8080;
-    server_name  garufa.example.com;
-    ; Set this a little higher than Pusher ACTIVITY_TIMEOUT
-    proxy_read_timeout  150;
-    ssl                  on;
-    ssl_certificate      /path/to/cert.pem;
-    ssl_certificate_key  /path/to/cert.key;
-    location / {
-        proxy_pass          http://garufa;
-        proxy_http_version  1.1;
-        proxy_set_header    Upgrade $http_upgrade;
-        proxy_set_header    Connection $connection_upgrade;
-    }
-}
-```
-Setting up Garufa on Heroku
----------------------------
-Create a repo for your app:
-```
-$ mkdir garufa-heroku
-$ cd garufa-heroku
-$ git init .
-```
-Create Gemfile and Procfile files:
-``` ruby
-# Gemfile
-source 'http://rubygems.org'
-ruby '2.1.2'
-gem 'garufa'
-# Procfile
-web: garufa -v --app_key $GARUFA_APP_KEY --secret $GARUFA_SECRET -p $PORT
-```
-Generate Gemfile.lock and commit your changes:
-```
-$ bundle install
-$ git add .
-$ git commit -m 'Initial commit'
-```
-Create your app, set environment variables and deploy:
-```
-$ heroku create
-$ heroku config:set GARUFA_APP_KEY=app-key
-$ heroku config:set GARUFA_SECRET=app-secret
-$ git push heroku master
-```
-At this point you should have Garufa up and listening on port 80.
-Set `Pusher.port` and `Pusher.ws_port` in the example above to port 80, and
-`Pusher.host` to the name of your app provided by Heroku (something like
-`random-name-2323.herokuapp.com`).
-Checking number of current connections
---------------------------------------
-A simple way to check the number of current connections is using `lsof`. Be sure to
-set the right path to garufa.pid file.
-``` console
-while :; do echo "$(date '+%H:%M:%S') $(sudo lsof -p `cat /path/to/garufa.pid` | grep ESTABLISHED | wc -l)"; sleep 1; done;
-```
-Testing and Contributing
-------------------------
-It's up to you how you install Garufa dependencies for development and testing,
-just be sure you have installed dependencies listed in the .gemspec. If you want
-to let *bundler* handle this, you can generate a Gemfile from the .gemspec and
-then run *bundle install*.
-``` console
-$ bundle init --gemspec=garufa.gemspec
-$ bundle install
-```
-Once you have dependencies installed, run *rake test* (or just *rake*).
-``` console
-$ rake
-```
-Pull requests are welcome!
+Documentation
+-------------
+* [Installation and usage] (/doc/install.md)
+* [SSL Support] (/doc/ssl.md)
+* [Deploy to Heroku] (/doc/heroku.md)
+* [Using Nginx as reverse proxy] (/doc/nginx.md)
+* [Cheking number of current connections] (/doc/connections.md)
+* [Testing and contributing] (/doc/testing.md)
 Pusher
 ------

data/bin/garufa.pid CHANGED Viewed

	@@ -1 +1 @@
1	- ~~4987~~
1	+ 4311

data/garufa.gemspec CHANGED Viewed

@@ -29,6 +29,8 @@ Gem::Specification.new do |s|
   s.add_dependency "faye-websocket", "0.7.4"
   s.add_dependency "cuba", "3.1.1"
   s.add_dependency "signature", "0.1.7"
+  s.add_dependency "tilt", "2.0.1"
+  s.add_dependency "yajl-ruby", "1.2.1"
   s.add_development_dependency "rake", "10.3.2"
   s.add_development_dependency "minitest", "5.4.0"
 end

data/lib/garufa/api/channel_filter.rb ADDED Viewed

@@ -0,0 +1,13 @@
+module Garufa
+  module API
+    module ChannelFilter
+      def channel_filter(params)
+        {
+          info: params['info'].to_s.split(/\s*,\s*/),
+          prefix: params['filter_by_prefix']
+        }
+      end
+    end
+  end
+end

data/lib/garufa/api/channels.rb CHANGED Viewed

@@ -1,19 +1,43 @@
+require 'cuba'
+require 'cuba/render'
+require 'yajl'
+require 'yajl/json_gem'
+require 'tilt/yajl'
+require 'garufa/api/channel_filter'
+require 'garufa/api/settings_setter'
 module Garufa
   module API
-    class Channels < Cuba; end
+    class Channels < Cuba
+      plugin Cuba::Render
+      plugin ChannelFilter
+      plugin SettingsSetter
+      set :render, template_engine: 'yajl', views: File.expand_path("views", File.dirname(__FILE__))
+    end
-    # TODO: Implement channels requests
     Channels.define do
-      # Channels
-      on get, "channels" do
+      on get, "channels/:channel/users" do |channel|
+        stats = Subscriptions.channel_stats(channel)
+        res.write partial('users', stats: stats)
       end
-      on get, "channels/:channel" do
+      on get, "channels/:channel" do |channel|
+        filter = channel_filter(req.params)
+        stats = Subscriptions.channel_stats(channel)
+        res.write partial('channel', stats: stats, filter: filter)
       end
-      # Users
-      on get, "channels/:channel/users" do
+      on get, "channels" do
+        filter = channel_filter(req.params)
+        stats = Subscriptions.all.each_with_object({}) do |(channel, sub), obj|
+          obj[channel] = Subscriptions.channel_stats(channel)
+        end
+        res.write partial('channels', stats: stats, filter: filter)
       end
     end
   end

data/lib/garufa/api/event_handler.rb CHANGED Viewed

@@ -11,7 +11,7 @@ module Garufa
         # Some old api clients send channel and event in the url, while only data is
         # in the body. New clients send everything in the body. We have to check where
-        # data is coming to build the final params.
+        # data is coming in to build the final params.
         params.merge!(body_params['data'] ? body_params : { data: body_params })
         message = Garufa::Message.new(params)

data/lib/garufa/{api.rb → api/server.rb} RENAMED Viewed

File without changes

data/lib/garufa/api/settings_setter.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module Garufa
+  module API
+    module SettingsSetter
+      module ClassMethods
+        def set(key, value)
+          if value.is_a? Hash
+            settings[key].merge! value
+          else
+            settings[key] = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/garufa/connection.rb CHANGED Viewed

@@ -54,7 +54,7 @@ module Garufa
     end
     def cleanup
-      @subscriptions.values.each(&:unsubscribe)
+      @subscriptions.each { |_, subscription| unsubscribe(subscription) }
       @subscriptions.clear
     end
@@ -84,11 +84,16 @@ module Garufa
     def pusher_subscribe(data)
       subscription = Subscription.new(data, self)
+      subscribe(subscription)
+    end
+    def subscribe(subscription)
       subscription.subscribe
       if subscription.success?
         @subscriptions[subscription.channel] = subscription
         send_subscription_succeeded(subscription)
+        notify_member(:member_added, subscription) if subscription.presence_channel?
       else
         error(subscription.error.code, subscription.error.message)
       end
@@ -96,7 +101,12 @@ module Garufa
     def pusher_unsubscribe(data)
       subscription = @subscriptions.delete data["channel"]
-      subscription.unsubscribe if subscription
+      unsubscribe(subscription) if subscription
+    end
+    def unsubscribe(subscription)
+      notify_member(:member_removed, subscription) if subscription.presence_channel?
+      subscription.unsubscribe
     end
     def valid_app_key?
@@ -108,7 +118,23 @@ module Garufa
     end
     def send_subscription_succeeded(subscription)
-      send_message Message.subscription_succeeded(subscription.channel)
+      channel = subscription.channel
+      data = {}
+      if subscription.presence_channel?
+        data[:presence] = Subscriptions.channels_data(channel)
+        data[:presence][:count] = Subscriptions.channel_size(channel)
+      end
+      send_message Message.subscription_succeeded(channel, data)
+    end
+    def notify_member(event, subscription)
+      options = {
+        data: subscription.channel_data,
+        socket_id: subscription.socket_id
+      }
+      Subscriptions.notify [subscription.channel], "pusher_internal:#{event}", options
     end
   end
 end

data/lib/garufa/garufa_app.rb CHANGED Viewed

@@ -1,9 +1,10 @@
 require 'goliath/api'
 require 'goliath/connection'
 require 'faye/websocket'
 require 'garufa/config'
 require 'garufa/websocket'
-require 'garufa/api'
+require 'garufa/api/server'
 require 'garufa/version'
 module Garufa
@@ -20,6 +21,8 @@ module Garufa
       options[:port] = DEFAULT_PORT
+      opts.on('-V', '--version', 'Display version and exit') { puts "Garufa version #{Garufa::VERSION}"; exit }
       opts.separator ""
       opts.separator "Pusher options:"
@@ -32,8 +35,6 @@ module Garufa
         opts.on(v.first, v.last) { |value| Garufa::Config[k] = value }
       end
-      opts.separator ""
-      opts.on('-V', '--version', 'Display version and exit') { puts "Garufa version #{Garufa::VERSION}"; exit }
     end
     def response(env)

data/lib/garufa/message.rb CHANGED Viewed

@@ -31,8 +31,8 @@ module Garufa
       new(event: 'pusher:connection_established', data: data)
     end
-    def self.subscription_succeeded(channel)
-      new(event: 'pusher_internal:subscription_succeeded', channel: channel, data: {})
+    def self.subscription_succeeded(channel, data = {})
+      new(event: 'pusher_internal:subscription_succeeded', channel: channel, data: data)
     end
     def self.pong

data/lib/garufa/subscription.rb CHANGED Viewed

@@ -53,6 +53,10 @@ module Garufa
       @data['channel']
     end
+    def channel_data
+      @data['channel_data']
+    end
     def channel_prefix
       channel[/^private-|presence-/].to_s[0...-1]
     end
@@ -76,7 +80,7 @@ module Garufa
     end
     def valid_signature?
-      string_to_sign = [@connection.socket_id, channel].compact.join(':')
+      string_to_sign = [@connection.socket_id, channel, channel_data].compact.join(':')
       token(string_to_sign) == signature
     end

data/lib/garufa/subscriptions.rb CHANGED Viewed

@@ -10,31 +10,67 @@ module Garufa
     end
     def add(subscription)
-      subscriptions[subscription.channel].add subscription
+      subs = subscriptions[subscription.channel] ||= Set.new
+      subs.add subscription
     end
     def remove(subscription)
-      subscriptions[subscription.channel].delete subscription
+      channel = subscription.channel
+      subscriptions[channel].delete subscription
+      subscriptions.delete(channel) if channel_size(channel) == 0
     end
     def notify(channels, event, options = {})
       channels.each do |channel|
         subscriptions[channel].each do |sub|
           # Skip notifying if the same socket_id is provided
           next if sub.socket_id == options[:socket_id]
+          # Skip notifying the same member (probably from different tabs)
+          next if sub.presence_channel? and sub.channel_data == options[:data]
           sub.notify Message.channel_event(channel, event, options[:data])
         end
       end
     end
     def include?(subscription)
-      subscriptions[subscription.channel].include? subscription
+      subs = subscriptions[subscription.channel]
+      subs && subs.include?(subscription)
+    end
+    def channel_size(channel)
+      subs = subscriptions[channel]
+      subs ? subs.size : 0
+    end
+    def channels_data(channel)
+      response = { ids: [], hash: {} }
+      (subscriptions[channel] || []).each do |sub|
+        channel_data = JSON.parse(sub.channel_data)
+        id, info = channel_data.values_at('user_id', 'user_info')
+        next if response[:ids].include? id
+        response[:ids] << id
+        response[:hash][id] = info
+      end
+      response
+    end
+    def channel_stats(channel)
+      {
+        size: channel_size(channel),
+        presence: channels_data(channel)
+      }
     end
     private
     def subscriptions
-      @subscriptions ||= Hash.new { |h, k| h[k] = Set.new }
+      @subscriptions ||= {}
     end
   end
 end

data/lib/garufa/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Garufa
-  VERSION = '1.1.0.rc.1'
+  VERSION = '1.1.0.rc.2'
 end

data/test/connection.rb CHANGED Viewed

@@ -29,10 +29,10 @@ module Garufa
         let(:data) { { event: 'pusher:subscribe', data: { channel: channel } } }
         it 'should add a new Subscription to Subscriptions' do
-          count = Subscriptions.all[channel].count
+          count = Subscriptions.channel_size(channel)
           @socket.expect :send, true, [String]
           @connection.handle_incomming_data data.to_json
-          Subscriptions.all[channel].count.must_equal count + 1
+          Subscriptions.channel_size(channel).must_equal count + 1
         end
         describe 'public channels' do
@@ -96,9 +96,9 @@ module Garufa
         end
         it 'should remove Subscription from Subscriptions' do
-          count = Subscriptions.all[channel].count
+          count = Subscriptions.channel_size(channel)
           @connection.handle_incomming_data data_unsubscribe.to_json
-          Subscriptions.all[channel].count.must_equal count - 1
+          Subscriptions.channel_size(channel).must_equal count - 1
         end
       end

data/test/subscriptions.rb CHANGED Viewed

@@ -14,9 +14,9 @@ module Garufa
       end
       it 'should remove subscription to channel' do
-        count = Subscriptions.all[channel].count
+        count = Subscriptions.channel_size(channel)
         Subscriptions.remove @subscription
-        Subscriptions.all[channel].count.must_equal count - 1
+        Subscriptions.channel_size(channel).must_equal count - 1
       end
     end
@@ -29,9 +29,9 @@ module Garufa
       end
       it 'should add a new subscription to channel' do
-        count = Subscriptions.all[channel].count
+        count = Subscriptions.channel_size(channel)
         Subscriptions.add Subscription.new(data, @connection)
-        Subscriptions.all[channel].count.must_equal count + 1
+        Subscriptions.channel_size(channel).must_equal count + 1
       end
     end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: garufa
 version: !ruby/object:Gem::Version
-  version: 1.1.0.rc.1
+  version: 1.1.0.rc.2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2015-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: goliath
@@ -75,6 +75,38 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.1.7
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -119,11 +151,13 @@ files:
 - README.md
 - Rakefile
 - lib/garufa/version.rb
-- lib/garufa/api.rb
 - lib/garufa/api/channels.rb
 - lib/garufa/api/event_handler.rb
+- lib/garufa/api/server.rb
 - lib/garufa/api/authentication.rb
+- lib/garufa/api/channel_filter.rb
 - lib/garufa/api/events.rb
+- lib/garufa/api/settings_setter.rb
 - lib/garufa/subscription.rb
 - lib/garufa/message.rb
 - lib/garufa/config.rb