garufa 1.0.0.rc.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f7b4a234feb8611e70d7c76e2ad254c97049ad5
-  data.tar.gz: a790c9505d6e62412d0093c91c7c261ae90622e5
+  metadata.gz: feb8e6e2251eca7ffa865791866ced7d91434c87
+  data.tar.gz: 306edcf627d01d05336297f9db7e4b8b241abfdb
 SHA512:
-  metadata.gz: 5ccd62ac3a46148dc0991687abbd5563d0095422b36f4ec071ff13c58ac4d15f67957cc0053c8f068c856c6a839abb48e59786b6adb82bd751365af50417ed62
-  data.tar.gz: d6210ef3d2868ab44275e63123165e6a8e6797c3564cfed0b611cf3564ec30358ce084fdd11c40cbfd8f8c23e1f36f264d1090c2c57e1f8a69069cb73d05e887
+  metadata.gz: 9655597ace7f0e79e59832e4b4ffa6644fa3d64409d4e82c992ddc46e1fb1088d9992346ea4ab746ca01854a6def3cc488bed4af6695a2e28e34cba545bbeb96
+  data.tar.gz: 398b5e33ff82a0b8fef3bfe06ec35e9642120733beee835ac02344bb17bb40b49b65ef3347587dcab8c2a8f3a9043a39106a83ba0d175d72337b3fcc7f2ee724

data/README.md

@@ -6,10 +6,6 @@ Garufa
 
 An open source server implementation of the [Pusher][pusher] protocol.
 
-**IMPORTANT:** Garufa is currently in beta version, which means it is not
-production ready, but you are free to use it and test it. Any feedback is
-welcome.
-
 Intro
 -----
 
@@ -23,7 +19,7 @@ Install
 Be sure you have a ruby version >= 1.9.2
 
 ``` console
-$ gem install garufa --pre
+$ gem install garufa
 
 $ garufa --help
 ```
@@ -89,13 +85,60 @@ SSL support
 -----------
 
 ``` console
-$ garufa -sv --app_key app-key --secret app-secret --ssl --ssl-cert /path/to/cert.pem --ssl-key /path/to/key.key
+$ 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.
+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;
+    ssl_session_timeout        5m;
+    ssl_ciphers                HIGH:!aNULL:!MD5;
+    ssl_prefer_server_ciphers  on;
+
+    location / {
+        proxy_pass          http://garufa;
+        proxy_http_version  1.1;
+        proxy_set_header    Upgrade $http_upgrade;
+        proxy_set_header    Connection $connection_upgrade;
+    }
+}
+```
 
 Testing and Contributing
 ------------------------
@@ -111,8 +154,7 @@ $ bundle init --gemspec=garufa.gemspec
 $ bundle install
 ```
 
-Once you have dependencies installed, just run *rake test*, or just *rake*, as
-*test* is the default task.
+Once you have dependencies installed, run *rake test* (or just *rake*).
 
 ``` console
 $ rake

data/bin/garufa.pid

@@ -1 +1 @@
-17188
+11421

data/garufa.gemspec

@@ -11,9 +11,9 @@ Gem::Specification.new do |s|
   s.authors     = ["Juan Manuel Cuello"]
   s.email       = ["juanmacuello@gmail.com"]
   s.homepage    = "http://github.com/Juanmcuello/garufa"
-  s.bindir      = 'bin'
-  s.executables << 'garufa'
-  s.required_ruby_version = '>=1.9'
+  s.bindir      = "bin"
+  s.executables << "garufa"
+  s.required_ruby_version = ">=1.9"
 
   s.files = Dir[
     "LICENSE",
@@ -25,10 +25,10 @@ Gem::Specification.new do |s|
     "test/*.*"
   ]
 
-  s.add_dependency "goliath"
-  s.add_dependency "faye-websocket", '~> 0.7.2'
-  s.add_dependency "cuba"
-  s.add_dependency "signature"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "minitest", '~> 5.3.1'
+  s.add_dependency "goliath", "1.0.3"
+  s.add_dependency "faye-websocket", "0.7.2"
+  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"
 end

data/lib/garufa/version.rb

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

data/test/connection.rb

@@ -25,13 +25,14 @@ module Garufa
 
       describe 'pusher:subscribe' do
 
-        let(:data) { { event: 'pusher:subscribe', data: { channel: 'ch1' } } }
+        let(:channel) { 'ch1' }
+        let(:data) { { event: 'pusher:subscribe', data: { channel: channel } } }
 
         it 'should add a new Subscription to Subscriptions' do
+          count = Subscriptions.all[channel].count
           @socket.expect :send, true, [String]
           @connection.handle_incomming_data data.to_json
-          Subscriptions.all['ch1'].first.class.must_equal Subscription
-          Subscriptions.all['ch1'].count.must_equal 1
+          Subscriptions.all[channel].count.must_equal count + 1
         end
 
         describe 'public channels' do

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: garufa
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Juan Manuel Cuello
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-11 00:00:00.000000000 Z
+date: 2014-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: goliath
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: cuba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: signature
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.7
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
         version: 5.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
         version: 5.3.1
 description: Garufa is a websocket server compatible with the Pusher protocol.
@@ -105,26 +105,26 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- lib/garufa/version.rb
-- lib/garufa/goliath/connection.rb
+- bin/garufa
+- bin/garufa.pid
+- garufa.gemspec
+- lib/garufa.rb
 - lib/garufa/api/api.rb
 - lib/garufa/api/handler.rb
-- lib/garufa/subscription.rb
-- lib/garufa/websocket/websocket.rb
-- lib/garufa/message.rb
 - lib/garufa/config.rb
+- lib/garufa/connection.rb
 - lib/garufa/cuba/authentication.rb
-- lib/garufa/subscriptions.rb
 - lib/garufa/garufa_app.rb
-- lib/garufa/connection.rb
-- lib/garufa.rb
-- bin/garufa.pid
-- bin/garufa
-- garufa.gemspec
+- 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
+- test/connection.rb
 - test/helper.rb
 - test/message.rb
 - test/subscriptions.rb
-- test/connection.rb
 homepage: http://github.com/Juanmcuello/garufa
 licenses: []
 metadata: {}
@@ -134,19 +134,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Websocket server compatible with Pusher.
 test_files: []
-has_rdoc: