garufa 1.0.0 → 1.0.1.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feb8e6e2251eca7ffa865791866ced7d91434c87
-  data.tar.gz: 306edcf627d01d05336297f9db7e4b8b241abfdb
+  metadata.gz: 51982c470639a14bcfaa9c7cdbcd139984b78d16
+  data.tar.gz: fb7cadeb7651dd64c4fdaf6f4eb2916a7a65f629
 SHA512:
-  metadata.gz: 9655597ace7f0e79e59832e4b4ffa6644fa3d64409d4e82c992ddc46e1fb1088d9992346ea4ab746ca01854a6def3cc488bed4af6695a2e28e34cba545bbeb96
-  data.tar.gz: 398b5e33ff82a0b8fef3bfe06ec35e9642120733beee835ac02344bb17bb40b49b65ef3347587dcab8c2a8f3a9043a39106a83ba0d175d72337b3fcc7f2ee724
+  metadata.gz: e6f57e7381827e211bb40cb05617fd5168a99a8b0ce29d76cb729f9273ad5fa6d8c7e07770e82c4765334fdd6b49fe50fb504e04e6da0a2ef99a4c2be1c9ef56
+  data.tar.gz: ce0e6afef6b42108ffb4336c519f5117cef23a0cf978a244976e98f0411f55ae014f17c924435ef08dee5a35b6850d98ef6d1580d7d2c89dc161914c4f2e9e7c

data/README.md

@@ -1,5 +1,5 @@
 [![Build Status](https://travis-ci.org/Juanmcuello/garufa.png?branch=master)](https://travis-ci.org/Juanmcuello/garufa)
-[![Code Climate](https://codeclimate.com/github/Juanmcuello/garufa.png)](https://codeclimate.com/github/Juanmcuello/garufa)
+[![Code Climate](https://codeclimate.com/github/Juanmcuello/garufa/badges/gpa.svg)](https://codeclimate.com/github/Juanmcuello/garufa)
 
 Garufa
 ====
@@ -38,7 +38,7 @@ to run in background (daemonized) just add `-d` flag.
 
 Now say you want to send events to your browser. Just create an .html file
 which requires the *pusher.js* library and binds to some events, then point
-your browser to that file (for testing purpouse, you can just simple open it
+your browser to that file (for testing purpouse, you can just simply open it
 with your browser).
 
 Maybe you would like to open your JavaScript console to see JavaScript debug
@@ -124,12 +124,9 @@ server {
     ; 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;
-    ssl_session_timeout        5m;
-    ssl_ciphers                HIGH:!aNULL:!MD5;
-    ssl_prefer_server_ciphers  on;
+    ssl                  on;
+    ssl_certificate      /path/to/cert.pem;
+    ssl_certificate_key  /path/to/cert.key;
 
     location / {
         proxy_pass          http://garufa;
@@ -140,6 +137,51 @@ server {
 }
 ```
 
+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`).
+
 Testing and Contributing
 ------------------------
 

data/garufa.gemspec

@@ -25,10 +25,10 @@ Gem::Specification.new do |s|
     "test/*.*"
   ]
 
-  s.add_dependency "goliath", "1.0.3"
-  s.add_dependency "faye-websocket", "0.7.2"
+  s.add_dependency "goliath", "1.0.4"
+  s.add_dependency "faye-websocket", "0.7.4"
   s.add_dependency "cuba", "3.1.1"
   s.add_dependency "signature", "0.1.7"
-  s.add_development_dependency "rake", "10.1.0"
-  s.add_development_dependency "minitest", "5.3.1"
+  s.add_development_dependency "rake", "10.3.2"
+  s.add_development_dependency "minitest", "5.4.0"
 end

data/lib/garufa/api.rb

@@ -0,0 +1,46 @@
+require 'cuba'
+
+require 'garufa/api/authentication'
+require 'garufa/api/event_handler'
+
+module Garufa
+  module API
+    class Server < Cuba
+
+      plugin Authentication
+      plugin EventHandler
+
+      define do
+        on "apps/:app_id" do |app_id|
+
+          authenticate
+
+          # Events
+          on post, "events" do
+            handle_events(req.body.read)
+            res.status = 202
+            res.write "{}"
+          end
+
+          # Legacy events
+          on post, "channels/:channel_id/events" do |channel_id|
+            handle_events(req.body.read, req.GET.merge(channels: [channel_id]))
+            res.status = 202
+            res.write "{}"
+          end
+
+          # Channels
+          on get, "channels" do
+          end
+
+          on get, "channels/:channel" do
+          end
+
+          # Users
+          on get, "channels/:channel/users" do
+          end
+        end
+      end
+    end
+  end
+end

data/lib/garufa/api/authentication.rb

@@ -0,0 +1,16 @@
+require 'signature'
+require 'garufa/config'
+
+module Garufa
+  module API
+    module Authentication
+      def authenticate
+        request = Signature::Request.new(req.request_method, req.path, req.params)
+        request.authenticate { |key| Signature::Token.new(key, Garufa::Config[:secret]) }
+
+      rescue Signature::AuthenticationError
+        halt([401, {}, ['401 Unauthorized']])
+      end
+    end
+  end
+end

data/lib/garufa/api/event_handler.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+require 'garufa/subscriptions'
+require 'garufa/message'
+
+module Garufa
+  module API
+    module EventHandler
+      def handle_events(body, params = {})
+        body_params = JSON.parse(body)
+
+        # 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.
+        params.merge!(body_params['data'] ? body_params : { data: body_params })
+
+        message = Garufa::Message.new(params)
+        options = { data: message.data, socket_id: message.socket_id }
+
+        # Process event deferred in order to response immediately.
+        EM.defer { Garufa::Subscriptions.notify message.channels, message.name, options }
+
+      rescue JSON::ParserError => e
+        env.logger.error e.inspect
+      end
+    end
+  end
+end

data/lib/garufa/garufa_app.rb

@@ -1,10 +1,9 @@
 require 'goliath/api'
 require 'goliath/connection'
-require 'garufa/goliath/connection'
 require 'faye/websocket'
 require 'garufa/config'
-require 'garufa/websocket/websocket'
-require 'garufa/api/api'
+require 'garufa/websocket'
+require 'garufa/api'
 
 module Garufa
 
@@ -36,7 +35,7 @@ module Garufa
       if Faye::WebSocket.websocket?(env)
         WebSocket::Server.call(env)
       else
-        Api::Server.call(env)
+        API::Server.call(env)
       end
     end
   end

data/lib/garufa/subscription.rb

@@ -3,7 +3,8 @@ require 'garufa/subscriptions'
 
 module Garufa
   class Subscription
-    attr_reader :data, :connection, :error
+
+    attr_reader :error
 
     def initialize(data, connection)
       @data, @connection = data, connection
@@ -56,6 +57,14 @@ module Garufa
       channel[/^private-|presence-/].to_s[0...-1]
     end
 
+    def notify(message)
+      @connection.send_message message
+    end
+
+    def socket_id
+      @connection.socket_id
+    end
+
     private
 
     def valid_channel?

data/lib/garufa/subscriptions.rb

@@ -18,17 +18,11 @@ module Garufa
     end
 
     def notify(channels, event, options = {})
-      return unless channels.is_a?(Array) && channels.any?
-
       channels.each do |channel|
-        connections = subscriptions[channel].map { |s| s.connection }
-        next unless connections.any?
-
-        connections.each do |connection|
-          next if connection.socket_id == options[:socket_id]
-
-          message = Message.channel_event(channel, event, options[:data])
-          connection.send_message(message)
+        subscriptions[channel].each do |sub|
+          # Skip notifying if the same socket_id is provided
+          next if sub.socket_id == options[:socket_id]
+          sub.notify Message.channel_event(channel, event, options[:data])
         end
       end
     end

data/lib/garufa/version.rb

@@ -1,4 +1,4 @@
 module Garufa
-  VERSION = '1.0.0'
+  VERSION = '1.0.1.rc.1'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: garufa
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1.rc.1
 platform: ruby
 authors:
 - Juan Manuel Cuello
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-09 00:00:00.000000000 Z
+date: 2014-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: goliath
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 1.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.7.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.7.4
 - !ruby/object:Gem::Dependency
   name: cuba
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 10.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 10.3.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.3.1
+        version: 5.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.3.1
+        version: 5.4.0
 description: Garufa is a websocket server compatible with the Pusher protocol.
 email:
 - juanmacuello@gmail.com
@@ -106,21 +106,19 @@ files:
 - README.md
 - Rakefile
 - bin/garufa
-- bin/garufa.pid
 - garufa.gemspec
 - lib/garufa.rb
-- lib/garufa/api/api.rb
-- lib/garufa/api/handler.rb
+- lib/garufa/api.rb
+- lib/garufa/api/authentication.rb
+- lib/garufa/api/event_handler.rb
 - lib/garufa/config.rb
 - lib/garufa/connection.rb
-- lib/garufa/cuba/authentication.rb
 - lib/garufa/garufa_app.rb
-- lib/garufa/goliath/connection.rb
 - lib/garufa/message.rb
 - lib/garufa/subscription.rb
 - lib/garufa/subscriptions.rb
 - lib/garufa/version.rb
-- lib/garufa/websocket/websocket.rb
+- lib/garufa/websocket.rb
 - test/connection.rb
 - test/helper.rb
 - test/message.rb
@@ -139,9 +137,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2

data/bin/garufa.pid

@@ -1 +0,0 @@
-11421

data/lib/garufa/api/api.rb

@@ -1,37 +0,0 @@
-require 'cuba'
-
-require 'garufa/cuba/authentication'
-require 'garufa/api/handler'
-
-module Garufa
-  module Api
-
-    Cuba.plugin Cuba::Authentication
-
-    Server = Cuba.new do
-
-      on "apps/:app_id" do |app_id|
-
-        authenticate
-
-        # Events
-        on post, "events" do
-          # Process requests deferred in order to response immediately.
-          EM.defer proc { Handler.handle_events(req.body.read) }
-          res.write "{}"
-        end
-
-        # Channels
-        on get, "channels" do
-        end
-
-        on get, "channels/:channel" do
-        end
-
-        # Users
-        on get, "channels/:channel/users" do
-        end
-      end
-    end
-  end
-end

data/lib/garufa/api/handler.rb

@@ -1,17 +0,0 @@
-require 'json'
-
-require 'garufa/subscriptions'
-require 'garufa/message'
-
-module Garufa
-  module Api
-    module Handler
-      def self.handle_events(body)
-        message = Garufa::Message.new(JSON.parse(body))
-        options = { data: message.data, socket_id: message.socket_id }
-        Garufa::Subscriptions.notify message.channels, message.name, options
-      rescue JSON::ParserError
-      end
-    end
-  end
-end

data/lib/garufa/cuba/authentication.rb

@@ -1,14 +0,0 @@
-require 'signature'
-require 'garufa/config'
-
-class Cuba
-  module Authentication
-    def authenticate
-      request = Signature::Request.new(req.request_method, env['REQUEST_PATH'], req.params)
-      request.authenticate { |key| Signature::Token.new(key, Garufa::Config[:secret]) }
-
-    rescue Signature::AuthenticationError
-      halt([401, {}, ['401 Unauthorized']])
-    end
-  end
-end

data/lib/garufa/goliath/connection.rb

@@ -1,14 +0,0 @@
-module Goliath
-  class Connection < EM::Connection
-    alias :goliath_post_init :post_init
-
-    # Ensure GOLIATH_ENV is set on new connections
-    #
-    # See https://github.com/postrank-labs/goliath/pull/279
-    #
-    def post_init
-      Thread.current[GOLIATH_ENV] = nil
-      goliath_post_init
-    end
-  end
-end