firehose 0.0.4 → 0.0.5

data/README.md

@@ -11,52 +11,46 @@
 
 Firehose is both a Rack application and JavasScript library that makes building scalable real-time web applications possible.
 
-# How is it different from socket.io?
-
-socket.io attempts to store connection state per node instance. Firehose makes no attempt to store connection state.
-
-Also, socket.io attempts to abstract a low-latency full-duplex port. Firehose assumes that its impossible to simulate this in older web browsers that don't support WebSockets. As such, Firehose focuses on low-latency server-to-client connections and encourages the use of existing HTTP transports, like POST and PUT, for client-to-server communications.
-
-Finally, Firehose attempts to solve data consistency issues and authentication by encourage the use of proxying to the web application.
-
 # Getting Started
 
 First, you'll need to install and run RabbitMQ.
 
 ```sh
-apt-get install rabbitmq    # Install on Ubuntu
-brew install rabbitmq       # Install on Mac Homebrew
+$ apt-get install rabbitmq    # Install on Ubuntu
+$ brew install rabbitmq       # Install on Mac Homebrew
 ```
 
-## The Server
+Then install the gem.
 
-The consumer is the web server that your client connects to for real-time updates. Create a config.ru file with the following:
-
-```ruby
-require 'rubygems'
-require 'firehose'
-
-run Firehose::Rack::App.new
+```sh
+$ gem install firehose
 ```
 
-Now run the config.ru file in a server that supports async Rack callbacks (like thin or rainbows)
+## The Server
+
+Now fire up the server.
 
 ```ruby
-thin -R config.ru -p 4000 start
+$ firehose start
+>> Thin web server (v1.3.1 codename Triple Espresso)
+>> Maximum connections set to 1024
+>> Listening on 127.0.0.1:7478, CTRL+C to stop
 ```
 
-## The Publisher
+In case you're wondering, the Firehose application server runs the Rack app `Firehose::Rack::App.new` inside of Thin.
+
+## Publish a message to a bunch of subscribers
 
 Lets test it out! Open two terminal windows. In one window, curl:
 
 ```sh
-curl "http://localhost:4000/hello"
+$ curl "http://localhost:7474/hello"
 ```
 
 Then run the following in the other terminal:
 
 ```sh
-curl -X PUT -d "Greetings fellow human being..." "http://localhost:4000/hello"
+$ curl -X PUT -d "Greetings fellow human being..." "http://localhost:7474/hello"
 ```
 
 and you should see the message in the other terminal.
@@ -67,7 +61,7 @@ Greetings fellow human being...
 
 ## Yeah, so?
 
-You have a dirt simple HTTP pub-sub feed. You could setup an `after_commit` hook on ActiveRecord to push JSON to an end-point. On the subscription side, you could have a Backbone.js application that picks up the changes and updates the client-side UI.
+You have a dirt simple HTTP pub-sub feed. You could setup an `after_commit` hook on ActiveRecord to push JSON to an end-point. On the other side, you could have a Backbone.js application that picks up the changes and updates the client-side UI.
 
 Holy mackerel! Its a nice, clean, RESTful way to build real-time web applications.
 
@@ -75,11 +69,13 @@ Holy mackerel! Its a nice, clean, RESTful way to build real-time web application
 
 Firehose doesn't just stop at curl; it has a full-featured JavaScript client that lets you subscribe to channels for live updates.
 
+Still have the server running? Copy and paste the code below into Firebug or the WebKit console.
+
 ```javascript
 new Firehose.Client()
   .url({
-    websocket: 'ws://localhost:5100',
-    longpoll:  'http://localhost:5100'
+    websocket: 'ws://localhost:7478/hello',
+    longpoll:  'http://localhost:7478/hello'
   })
   .params({
     cid: '024023948234'
@@ -88,13 +84,28 @@ new Firehose.Client()
     timeout: 5000
   })
   .message(function(msg){
-    console.log(msg); // Fires when a message is received from the server.
+    console.log(msg);
   })
   .connected(function(){
     console.log('Howdy friend!');
   })
   .disconnected(function(){
-    console.log('Bu bye');
+    console.log('Bu bye.');
   })
   .connect()
-```
+```
+
+Then publish another message.
+
+
+```sh
+$ curl -X PUT -d "This is almost magical" "http://localhost:7478/hello"
+```
+
+# How is it different from socket.io?
+
+socket.io attempts to store connection state per node instance. Firehose makes no attempt to store connection state.
+
+Also, socket.io attempts to abstract a low-latency full-duplex port. Firehose assumes that its impossible to simulate this in older web browsers that don't support WebSockets. As such, Firehose focuses on low-latency server-to-client connections and encourages the use of existing HTTP transports, like POST and PUT, for client-to-server communications.
+
+Finally, Firehose attempts to solve data consistency issues and authentication by encourage the use of proxying to the web application.

data/bin/firehose

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
 
+require 'rubygems'
+
 $:.unshift File.expand_path('../../lib', __FILE__)
 
-require 'rubygems'
-require 'firehose'
+require 'firehose'
+
+Firehose::CLI.start

data/firehose.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "eventmachine", ">= 1.0.0.beta"
   s.add_runtime_dependency "amqp", ">= 0.9.4"
   s.add_runtime_dependency "thin"
+  s.add_runtime_dependency "thor"
   s.add_runtime_dependency "websocket-rack"
 
   s.add_development_dependency "rspec"

data/lib/firehose.rb

@@ -7,6 +7,7 @@ module Firehose
   autoload :Publisher,    'firehose/publisher'
   autoload :Goliath,      'firehose/goliath'
   autoload :Rack,         'firehose/rack'
+  autoload :CLI,          'firehose/cli'
 
   # TODO move this into a configuration or session class.
   # Hang on to AMQP configuration settings.

data/lib/firehose/cli.rb

@@ -0,0 +1,18 @@
+require 'thor'
+
+module Firehose
+  class CLI < Thor
+    desc "start", "starts the firehose server"
+    method_option :port, :type => :numeric, :default => 7474, :required => true, :aliases => '-p'
+    method_option :host, :type => :string, :default => '127.0.0.1', :required => true, :aliases => '-h'
+    def start
+      require 'thin'
+
+      server = Thin::Server.new(options[:host], options[:port]) do
+        run Firehose::Rack::App.new
+      end
+
+      server.start!
+    end
+  end
+end

data/lib/firehose/version.rb

@@ -1,4 +1,4 @@
 module Firehose
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
   CODENAME = "Trickle"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firehose
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70267687581480 !ruby/object:Gem::Requirement
+  requirement: &70096762306280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.0.beta
   type: :runtime
   prerelease: false
-  version_requirements: *70267687581480
+  version_requirements: *70096762306280
 - !ruby/object:Gem::Dependency
   name: amqp
-  requirement: &70267687580600 !ruby/object:Gem::Requirement
+  requirement: &70096762305560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 0.9.4
   type: :runtime
   prerelease: false
-  version_requirements: *70267687580600
+  version_requirements: *70096762305560
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: &70267687580200 !ruby/object:Gem::Requirement
+  requirement: &70096762305160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70267687580200
+  version_requirements: *70096762305160
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70096762304600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70096762304600
 - !ruby/object:Gem::Dependency
   name: websocket-rack
-  requirement: &70267687579660 !ruby/object:Gem::Requirement
+  requirement: &70096762304060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +66,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70267687579660
+  version_requirements: *70096762304060
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70267687579160 !ruby/object:Gem::Requirement
+  requirement: &70096762294340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70267687579160
+  version_requirements: *70096762294340
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70267687578500 !ruby/object:Gem::Requirement
+  requirement: &70096762293700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70267687578500
+  version_requirements: *70096762293700
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70267687338120 !ruby/object:Gem::Requirement
+  requirement: &70096762292860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70267687338120
+  version_requirements: *70096762292860
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &70267687337440 !ruby/object:Gem::Requirement
+  requirement: &70096762291880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +110,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70267687337440
+  version_requirements: *70096762291880
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: &70267687336400 !ruby/object:Gem::Requirement
+  requirement: &70096762290940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +121,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70267687336400
+  version_requirements: *70096762290940
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70267687335300 !ruby/object:Gem::Requirement
+  requirement: &70096762289780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -121,10 +132,10 @@ dependencies:
         version: 0.3.0
   type: :development
   prerelease: false
-  version_requirements: *70267687335300
+  version_requirements: *70096762289780
 - !ruby/object:Gem::Dependency
   name: guard-coffeescript
-  requirement: &70267687334360 !ruby/object:Gem::Requirement
+  requirement: &70096762288920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,7 +143,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70267687334360
+  version_requirements: *70096762288920
 description: Firehose is a realtime web application toolkit for building realtime
   Ruby web applications.
 email:
@@ -163,6 +174,7 @@ files:
 - lib/assets/javascripts/firehose/transport.js.coffee
 - lib/assets/javascripts/firehose/web_socket.js.coffee
 - lib/firehose.rb
+- lib/firehose/cli.rb
 - lib/firehose/goliath.rb
 - lib/firehose/http_publisher.rb
 - lib/firehose/publisher.rb