RubyGems - garufa - Versions diffs - 0.0.1.beta.2 → 1.0.0.rc.1 - Mend

garufa 0.0.1.beta.2 → 1.0.0.rc.1

Files changed (15) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bbc4d733e7b71f96bdb8b0d0929daffd9042615
-  data.tar.gz: 2c3d7c91f49298af24a5f1e6f05ea9a3c4345354
+  metadata.gz: 9f7b4a234feb8611e70d7c76e2ad254c97049ad5
+  data.tar.gz: a790c9505d6e62412d0093c91c7c261ae90622e5
 SHA512:
-  metadata.gz: 5a44c756812053df6672f5a123635785ad017dfa92ce5d6cf86fd6937f956f91eb9ffa451783afadea861ce41dd3ac9a5dcf9ea18d02c11c42bdc977754e21ec
-  data.tar.gz: 3e41c06d811cdb818a0282566d0817ff3ffcacbd936b1d8ef78785f6d97299ba91715d2dfedb6feb9fe5c09bd2adf767c733e0aafb0c0bbab98286bdbdbd280e
+  metadata.gz: 5ccd62ac3a46148dc0991687abbd5563d0095422b36f4ec071ff13c58ac4d15f67957cc0053c8f068c856c6a839abb48e59786b6adb82bd751365af50417ed62
+  data.tar.gz: d6210ef3d2868ab44275e63123165e6a8e6797c3564cfed0b611cf3564ec30358ce084fdd11c40cbfd8f8c23e1f36f264d1090c2c57e1f8a69069cb73d05e887

data/README.md CHANGED Viewed

@@ -1,4 +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)
+[![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)
 Garufa
 ====
@@ -12,18 +13,14 @@ welcome.
 Intro
 -----
-Garufa is a Ruby websocket server which implements the Pusher protocol. It was
+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.
-[pusher]: http://pusher.com
-[goliath]: https://github.com/postrank-labs/goliath/
-[slanger]: https://github.com/stevegraham/slanger
 Install
 -------
-Make sure you have a ruby version >= 1.9.2
+Be sure you have a ruby version >= 1.9.2
 ``` console
 $ gem install garufa --pre
@@ -31,53 +28,105 @@ $ gem install garufa --pre
 $ garufa --help
 ```
-Example
+Usage
 -------
-Create an *index.html* file:
+Start garufa server:
+``` console
+$ garufa -sv --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) 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
+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
+    Pusher.log = function(message) { console.log(message) };
+    Pusher.host = 'localhost';
+    Pusher.ws_port = 8080;
-    var appKey = 'my-application-key'
-    var pusher = new Pusher(appKey)
-    var channel = pusher.subscribe('my-channel')
+    var appKey = 'app-key';
+    var pusher = new Pusher(appKey);
+    var channel = pusher.subscribe('my-channel');
-    channel.bind('my-event', function(data) { alert(data.message) })
+    channel.bind('my-event', function(data) { alert(data.message) });
   </script>
 </html>
 ```
-For ruby, create a *server.rb* file:
+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
+code:
 ``` ruby
-# server.rb
 require 'pusher'
 Pusher.host = 'localhost'
 Pusher.port = 8080
-Pusher.app_id = 'my_app'
-Pusher.key = 'my-appication-key'
-Pusher.secret = 'my-application-secret'
+Pusher.app_id = 'my-app'
+Pusher.key = 'app-key'
+Pusher.secret = 'app-secret'
 Pusher.trigger('my-channel', 'my-event', { message: 'hello world' })
 ```
-1. Start `garufa` server:
+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/key.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.
+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 just run *bundle install*.
+``` console
+$ 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.
+``` console
+$ rake
+```
+Pull requests are welcome!
-   ``` console
-   $ garufa -sv --app_key my-application-key --secret my-application-secret
-   ```
-2. Point your browser to the `index.html` you created.
+Pusher
+------
-3. Execute the `server.rb` script:
+[Pusher][pusher] is a great service, very well documented and with excellent
+support. Consider using it on production.
-   ``` console
-   $ ruby server.rb
-   ```
+[pusher]: http://pusher.com
+[goliath]: https://github.com/postrank-labs/goliath/
+[slanger]: https://github.com/stevegraham/slanger

data/bin/garufa.pid ADDED Viewed

	@@ -0,0 +1 @@
1	+ 17188

data/garufa.gemspec CHANGED Viewed

@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/Juanmcuello/garufa"
   s.bindir      = 'bin'
   s.executables << 'garufa'
+  s.required_ruby_version = '>=1.9'
   s.files = Dir[
     "LICENSE",

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

@@ -1,4 +1,5 @@
 require 'cuba'
 require 'garufa/cuba/authentication'
 require 'garufa/api/handler'

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

@@ -1,4 +1,5 @@
 require 'json'
 require 'garufa/subscriptions'
 require 'garufa/message'

data/lib/garufa/connection.rb CHANGED Viewed

@@ -1,5 +1,9 @@
 require 'uri'
+require 'garufa/subscription'
+require 'garufa/message'
+require 'garufa/config'
 module Garufa
   class Connection

data/lib/garufa/subscription.rb ADDED Viewed

@@ -0,0 +1,94 @@
+require 'garufa/config'
+require 'garufa/subscriptions'
+module Garufa
+  class Subscription
+    attr_reader :data, :connection, :error
+    def initialize(data, connection)
+      @data, @connection = data, connection
+    end
+    def subscribe
+      case true
+      when !valid_channel?
+        set_error(nil, 'Invalid channel')
+      when !public_channel? && !valid_signature?
+        set_error(nil, 'Invalid signature')
+      when !public_channel? && !valid_app_key?
+        set_error(nil, 'Invalid key')
+      when already_subscribed?
+        set_error(nil, "Already subscribed to channel: #{channel}")
+      else
+        Subscriptions.add self
+      end
+    end
+    def unsubscribe
+      Subscriptions.remove self
+    end
+    def public_channel?
+      !(private_channel? || presence_channel?)
+    end
+    def private_channel?
+      channel_prefix == 'private'
+    end
+    def presence_channel?
+      channel_prefix == 'presence'
+    end
+    def set_error(code, message)
+      @error = SubscriptionError.new(code, message)
+    end
+    def success?
+      @error.nil?
+    end
+    def channel
+      @data['channel']
+    end
+    def channel_prefix
+      channel[/^private-|presence-/].to_s[0...-1]
+    end
+    private
+    def valid_channel?
+      channel.is_a?(String) && !channel.empty?
+    end
+    def valid_app_key?
+      app_key && app_key == Config[:app_key]
+    end
+    def valid_signature?
+      string_to_sign = [@connection.socket_id, channel].compact.join(':')
+      token(string_to_sign) == signature
+    end
+    def token(string_to_sign)
+      digest = OpenSSL::Digest::SHA256.new
+      OpenSSL::HMAC.hexdigest(digest, Config[:secret], string_to_sign)
+    end
+    def already_subscribed?
+      Subscriptions.include? self
+    end
+    def app_key
+      @data['auth'].split(':').first if @data['auth']
+    end
+    def signature
+      @data['auth'].split(':').last if @data['auth']
+    end
+  end
+  class SubscriptionError < Struct.new(:code, :message)
+  end
+end

data/lib/garufa/subscriptions.rb CHANGED Viewed

@@ -1,4 +1,5 @@
 require 'set'
+require 'garufa/message'
 module Garufa
   module Subscriptions
@@ -42,94 +43,4 @@ module Garufa
       @subscriptions ||= Hash.new { |h, k| h[k] = Set.new }
     end
   end
-  class Subscription
-    attr_reader :data, :connection, :error
-    def initialize(data, connection)
-      @data, @connection = data, connection
-    end
-    def subscribe
-      case true
-      when !valid_channel?
-        set_error(nil, 'Invalid channel')
-      when !public_channel? && !valid_signature?
-        set_error(nil, 'Invalid signature')
-      when !public_channel? && !valid_app_key?
-        set_error(nil, 'Invalid key')
-      when already_subscribed?
-        set_error(nil, "Already subscribed to channel: #{channel}")
-      else
-        Subscriptions.add self
-      end
-    end
-    def unsubscribe
-      Subscriptions.remove self
-    end
-    def public_channel?
-      !(private_channel? || presence_channel?)
-    end
-    def private_channel?
-      channel_prefix == 'private'
-    end
-    def presence_channel?
-      channel_prefix == 'presence'
-    end
-    def set_error(code, message)
-      @error = SubscriptionError.new(code, message)
-    end
-    def success?
-      @error.nil?
-    end
-    def channel
-      @data['channel']
-    end
-    def channel_prefix
-      channel[/^private-|presence-/].to_s[0...-1]
-    end
-    private
-    def valid_channel?
-      channel.is_a?(String) && !channel.empty?
-    end
-    def valid_app_key?
-      app_key && app_key == Config[:app_key]
-    end
-    def valid_signature?
-      string_to_sign = [@connection.socket_id, channel].compact.join(':')
-      token(string_to_sign) == signature
-    end
-    def token(string_to_sign)
-      digest = OpenSSL::Digest::SHA256.new
-      OpenSSL::HMAC.hexdigest(digest, Config[:secret], string_to_sign)
-    end
-    def already_subscribed?
-      Subscriptions.include? self
-    end
-    def app_key
-      @data['auth'].split(':').first if @data['auth']
-    end
-    def signature
-      @data['auth'].split(':').last if @data['auth']
-    end
-  end
-  class SubscriptionError < Struct.new(:code, :message)
-  end
 end

data/lib/garufa/version.rb CHANGED Viewed

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

data/test/connection.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-require File.expand_path("helper", File.dirname(__FILE__))
+require_relative 'helper'
 require 'logger'
 module Garufa

data/test/helper.rb CHANGED Viewed

@@ -1,9 +1,8 @@
-$:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
-require "garufa"
 require 'minitest/autorun'
 require 'minitest/mock'
+require_relative "../lib/garufa"
 Garufa::Config[:app_key] = '123123-123123'
 Garufa::Config[:secret] = '456456-456456'

data/test/message.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-require File.expand_path("helper", File.dirname(__FILE__))
+require_relative 'helper'
 module Garufa
   describe Message do

data/test/subscriptions.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-require File.expand_path("helper", File.dirname(__FILE__))
+require_relative 'helper'
 module Garufa
   describe Subscriptions do

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: garufa
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta.2
+  version: 1.0.0.rc.1
 platform: ruby
 authors:
 - Juan Manuel Cuello
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-03-22 00:00:00.000000000 Z
+date: 2014-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: goliath
@@ -109,6 +109,7 @@ files:
 - lib/garufa/goliath/connection.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
@@ -117,6 +118,7 @@ files:
 - lib/garufa/garufa_app.rb
 - lib/garufa/connection.rb
 - lib/garufa.rb
+- bin/garufa.pid
 - bin/garufa
 - garufa.gemspec
 - test/helper.rb
@@ -134,7 +136,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>'