firehose 1.2.20 → 1.3.6

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -1,16 +1,12 @@
 language: ruby
 
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
 
 services:
   - redis-server
 
-before_script:
-  - bundle exec rake travis:prepare
-
 script:
   - bundle exec rake spec
-  - xvfb-run bundle exec rake evergreen:run

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+## master
+
+- Configuration of Redis via the `Firehose::Server.redis` object.
+- Less rubygem dependencies: JSON gem removed because its included in Ruby 2.x
+- DEPRECATED: `firehose javascript` command will be removed. Those have been moved to https://github.com/firehoseio/js_client.
+
+## 1.3.6
+
+- DEPRECATION WARNING: `firehose javascript` has been removed from this project.
+- BUG: The null message bug fix in 1.3.5 introduce different behavior into the messages delivered when a client reconnects with a last_sequence. This has been corrected and 1.3.5 will be yanked.
+
+## 1.3.5
+
+- Fix bug where null messages are sent over WebSockets to client. Issue https://github.com/firehoseio/firehose/issues/51.
+- Drop support for Ruby 1.9.3. Documented official Ruby support policy in README.md

data/Dockerfile

@@ -0,0 +1,11 @@
+FROM ruby
+
+RUN apt-get update && apt-get install -y \
+  qt5-default libqt5webkit5-dev gstreamer1.0-plugins-base gstreamer1.0-tools gstreamer1.0-x
+
+WORKDIR /firehose/
+COPY . /firehose/
+RUN bundle
+
+EXPOSE 7474
+CMD bundle exec firehose server

data/Gemfile

@@ -1,4 +1,6 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
+
+gem "codeclimate-test-reporter", group: :test, require: nil
 
 # Specify your gem's dependencies in firehose.gemspec
-gemspec
+gemspec

data/Procfile.dev

@@ -1,4 +1,3 @@
 firehose: ./bin/firehose server -p $PORT
 redis: redis-server
-evergreen: rake evergreen:serve
 # guard: guard

data/README.md

@@ -1,13 +1,13 @@
-      __ _          _                    
-     / _(_)        | |                   
-    | |_ _ _ __ ___| |__   ___  ___  ___ 
+      __ _          _
+     / _(_)        | |
+    | |_ _ _ __ ___| |__   ___  ___  ___
     |  _| | '__/ _ \ '_ \ / _ \/ __|/ _ \
     | | | | | |  __/ | | | (_) \__ \  __/
     |_| |_|_|  \___|_| |_|\___/|___/\___|
-    
+
     Build realtime web applications in Ruby and JS
 
-[![Build Status](https://travis-ci.org/polleverywhere/firehose.png)](https://travis-ci.org/polleverywhere/firehose)
+[![Build Status](https://travis-ci.org/firehoseio/firehose.svg?branch=master)](https://travis-ci.org/firehoseio/firehose) [![Code Climate](https://codeclimate.com/github/firehoseio/firehose/badges/gpa.svg)](https://codeclimate.com/github/firehoseio/firehose) [![Test Coverage](https://codeclimate.com/github/firehoseio/firehose/badges/coverage.svg)](https://codeclimate.com/github/firehoseio/firehose/coverage)
 
 # What is Firehose?
 
@@ -90,6 +90,53 @@ new Firehose.Consumer({
 }).connect();
 ```
 
+There's also a Consumer that uses channel multiplexing.
+The multiplexed consumer is useful for scenarios where you want to subscribe
+to messages from many channels at once, without having to use one connection
+per channel. You can specify a list of channels to subscribe to, including a
+handler function per channel that gets called with all messages coming from that
+channel.
+
+Example:
+
+```javascript
+new Firehose.MultiplexedConsumer({
+  connected: function(){
+    console.log("Great Scotts!! We're connected!");
+  },
+  disconnected: function(){
+    console.log("Well shucks, we're not connected anymore");
+  },
+  error: function(){
+    console.log("Well then, something went horribly wrong.");
+  },
+  // Note that we don't specify a general message handler function
+  // but instead define one per channel below
+
+  // Note that we do NOT specify a protocol here because we don't
+  // know that yet. We also don't specify a specific channel name as part of
+  // the URI but instead pass in a list of subscriptions below
+  uri: '//localhost:7474/',
+
+  // List of channel subscriptions:
+  channels: {
+    "/my/channel/1": {
+      last_sequence: 10,        // defaults to 0 and can be ommitted
+      message: function(msg) {
+        console.log("got message on channel 1:");
+        console.log(msg);
+      }
+    },
+    "/my/channel/2": {
+      message: function(msg) {
+        console.log("got message on channel 2:");
+        console.log(msg);
+      }
+    }
+  }
+}).connect();
+```
+
 Then publish another message.
 
 ```sh
@@ -120,7 +167,7 @@ Firehose can be configured via environmental variables. Take a look at the [`.en
 
 ## Rack Configuration
 
-There are two rack applications that are included with Firehose: `Firehose::Rack::Producer` which a client can `PUT` HTTP request with message payloads to publish information on Firehose and the `Firehose::Rack::Consumer` application which a client connects to via HTT long polling or WebSockets to consume a message.
+There are two rack applications that are included with Firehose: `Firehose::Rack::Producer` which a client can `PUT` HTTP request with message payloads to publish information on Firehose and the `Firehose::Rack::Consumer` application which a client connects to via HTTP long polling or WebSockets to consume a message.
 
 ### Consumer Configuration
 
@@ -208,7 +255,7 @@ end
 
 # Deployment
 
-The recommended method of deploying firehose is to deploy it separately from your main app.
+The recommended method ofGdeploying firehose is to deploy it separately from your main app.
 
 1. Create a new project with a Gemfile such as
 
@@ -216,7 +263,7 @@ The recommended method of deploying firehose is to deploy it separately from you
 gem "firehose"
 gem "airbrake"
 gem "rainbows",   :require => false
-gem "rack", "~> 1.4.0" # if you're using Rainbows. See https://github.com/polleverywhere/firehose/commit/dfe55fff
+gem "rack", "~> 1.4.0" # if you're using Rainbows. See https://github.com/firehoseio/firehose/commit/dfe55fff
 gem "foreman",    :require => false
 gem "capistrano", :require => false
 ```
@@ -226,3 +273,14 @@ Of course, you could use `exceptional` instead of `airbrake` and `thin` instead
 2. Set up `config/deploy.rb` to your liking. You can follow most directions for using Capistrano and Foreman to deploy Rack apps, such as https://gist.github.com/1027117
 
 3. Set up `config/rainbows.rb` (if you are using Rainbows!). The gem includes example configurations scripts to get you started. There's also an example at https://gist.github.com/bradgessler/f2416efdbb1771e983b3.
+
+# New releases & version bump
+
+For a new release of Firehose, bump the version number in `lib/firehose/version.rb` as well as `package.json`.
+Make sure, they have the same version number.
+
+# Support
+
+## Ruby version
+
+Firehose will support the latest minor 2.x revisions of Ruby that are officially supported by the Ruby community. More details at https://www.ruby-lang.org/.

data/Rakefile

@@ -3,51 +3,62 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'coffee-script'
 
+task :default => :spec
+task :debug => ["spec:debug"]
+task :ci => ["spec:ci"]
 
-task :default => [:spec, 'evergreen:run']
+task :spec => ["spec:all"]
 
+namespace :js do
+  desc "Compile *.js.coffee.erb files"
+  task :compile_erb do
+    require 'erb'
+    require_relative "lib/firehose"
 
-desc 'run Rspec specs'
-task :spec do
-  sh 'rspec spec'
-end
+    erb_files = Dir.glob("lib/assets/javascripts/**/*.erb")
 
+    erb_files.each do |template_file|
+      output_file = template_file.split(".erb")[0]
+      puts "ERB compile #{template_file} => #{output_file}"
 
-namespace :evergreen do
-  desc 'run Evergreen specs'
-  task :run do
-    sh 'evergreen run'
+      renderer = ERB.new File.read(template_file)
+      File.open(output_file, "w+") do |f|
+       f.puts renderer.result
+      end
+    end
   end
+end
+
+namespace :spec do
+  desc "Run all specs"
+  task :all => [:ruby, "js:run"]
 
-  desc 'start an Evergreen server'
-  task :serve do
-    sh 'evergreen serve'
+  desc 'run Rspec specs'
+  task :ruby do
+    sh 'rspec spec'
   end
-end
 
+  task :js => "js:run"
 
-namespace :travis do
-  desc 'Prepares evergreen and JS files for Travis CI'
-  task :prepare do
-    # Prepare directories
-    sh "mkdir -p public/javascripts/vendor"
-    sh "mkdir -p public/javascripts/firehose"
+  # desc "Run specs with Karma runner"
+  namespace :js do
+    task :setup => "js:compile_erb" do
+      sh %[npm install]
+    end
 
-    # Precompile coffeescript
-    Dir.glob 'lib/assets/javascripts/**/*.js.coffee' do |coffee_file|
-      dest = coffee_file.gsub( 'lib/assets/', 'public/' ).gsub '.js.coffee', '.js'
+    desc "CI specs run on PhantomJS"
+    task :ci => :setup do
+      sh %[./node_modules/karma/bin/karma start karma.config.coffee --browsers PhantomJS --single-run --reporters dots,junit]
+    end
 
-      File.open dest, 'w' do |file|
-        file.write ::CoffeeScript.compile File.read coffee_file
-      end
+    desc "Run local specs in PhantomJS"
+    task :run => :setup do
+      sh %[./node_modules/karma/bin/karma start karma.config.coffee --browsers PhantomJS --single-run]
     end
 
-    # Copy JS vendor files into public
-    Dir.glob [
-      'spec/javascripts/support/*.js',
-      'lib/assets/javascripts/vendor/*.js'
-    ] do |js_file|
-      sh "cp #{js_file} public/javascripts/vendor"
+    desc "Run local specs in Chrome and leaves the window open for debugging"
+    task :debug => :setup do
+      sh %[./node_modules/karma/bin/karma start karma.config.coffee --browsers Chrome]
     end
   end
-end
+end

data/coffeelint.json

@@ -0,0 +1,129 @@
+{
+  "arrow_spacing": {
+    "level": "ignore"
+  },
+  "braces_spacing": {
+    "level": "ignore",
+    "spaces": 0,
+    "empty_object_spaces": 0
+  },
+  "camel_case_classes": {
+    "level": "error"
+  },
+  "coffeescript_error": {
+    "level": "error"
+  },
+  "colon_assignment_spacing": {
+    "level": "ignore",
+    "spacing": {
+      "left": 0,
+      "right": 0
+    }
+  },
+  "cyclomatic_complexity": {
+    "value": 10,
+    "level": "ignore"
+  },
+  "duplicate_key": {
+    "level": "error"
+  },
+  "empty_constructor_needs_parens": {
+    "level": "ignore"
+  },
+  "ensure_comprehensions": {
+    "level": "warn"
+  },
+  "eol_last": {
+    "level": "ignore"
+  },
+  "indentation": {
+    "value": 2,
+    "level": "error"
+  },
+  "line_endings": {
+    "level": "ignore",
+    "value": "unix"
+  },
+  "max_line_length": {
+    "value": 80,
+    "level": "error",
+    "limitComments": true
+  },
+  "missing_fat_arrows": {
+    "level": "ignore",
+    "is_strict": false
+  },
+  "newlines_after_classes": {
+    "value": 3,
+    "level": "ignore"
+  },
+  "no_backticks": {
+    "level": "error"
+  },
+  "no_debugger": {
+    "level": "warn",
+    "console": false
+  },
+  "no_empty_functions": {
+    "level": "ignore"
+  },
+  "no_empty_param_list": {
+    "level": "ignore"
+  },
+  "no_implicit_braces": {
+    "level": "ignore",
+    "strict": true
+  },
+  "no_implicit_parens": {
+    "strict": true,
+    "level": "ignore"
+  },
+  "no_interpolation_in_single_quotes": {
+    "level": "ignore"
+  },
+  "no_plusplus": {
+    "level": "ignore"
+  },
+  "no_stand_alone_at": {
+    "level": "ignore"
+  },
+  "no_tabs": {
+    "level": "error"
+  },
+  "no_this": {
+    "level": "ignore"
+  },
+  "no_throwing_strings": {
+    "level": "error"
+  },
+  "no_trailing_semicolons": {
+    "level": "error"
+  },
+  "no_trailing_whitespace": {
+    "level": "error",
+    "allowed_in_comments": false,
+    "allowed_in_empty_lines": true
+  },
+  "no_unnecessary_double_quotes": {
+    "level": "ignore"
+  },
+  "no_unnecessary_fat_arrows": {
+    "level": "warn"
+  },
+  "non_empty_constructor_needs_parens": {
+    "level": "ignore"
+  },
+  "prefer_english_operator": {
+    "level": "ignore",
+    "doubleNotLevel": "ignore"
+  },
+  "space_operators": {
+    "level": "ignore"
+  },
+  "spacing_after_comma": {
+    "level": "ignore"
+  },
+  "transform_messes_up_line_numbers": {
+    "level": "warn"
+  }
+}

data/docker-compose.yml

@@ -0,0 +1,17 @@
+# Isolated development and test environment.
+version: '2'
+services:
+  firehose:
+    build: .
+    depends_on:
+      - redis
+    environment:
+      REDIS_URL: redis://redis:6379/0
+    ports:
+      - 7474
+    volumes:
+      - .:/firehose/
+  redis:
+    image: redis
+    expose:
+      - 6379

data/firehose.gemspec

@@ -5,8 +5,8 @@ require "firehose/version"
 Gem::Specification.new do |s|
   s.name        = "firehose"
   s.version     = Firehose::VERSION
-  s.authors     = ["Brad Gessler", "Steel Fu", "Paul Cortens", "Zach Zolton"]
-  s.email       = ["brad@polleverywhere.com", "steel@polleverywhere.com", "paul@polleverywhere.com", "zach@polleverywhere.com"]
+  s.authors     = ["Brad Gessler", "Steel Fu", "Paul Cortens", "Zach Zolton", "Christopher Bertels"]
+  s.email       = ["brad@polleverywhere.com", "steel@polleverywhere.com", "paul@polleverywhere.com", "zach@polleverywhere.com", "christopher@polleverywhere.com"]
   s.homepage    = "http://firehose.io/"
   s.summary     = %q{Build realtime Ruby web applications}
   s.description = %q{Firehose is a realtime web application toolkit for building realtime Ruby web applications.}
@@ -23,19 +23,16 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "eventmachine", ">= 1.0.0"
   s.add_runtime_dependency "em-hiredis", ">= 0.2.0"
   s.add_runtime_dependency "thor"
-  s.add_runtime_dependency "faraday"
+  # faraday 0.9.1 causes some specs to fail
+  # need to investigate this further
+  s.add_runtime_dependency "faraday", "0.9.0"
   s.add_runtime_dependency "faye-websocket"
   s.add_runtime_dependency "em-http-request", ">= 1.0.0"
-  s.add_runtime_dependency "json"
   s.add_runtime_dependency "rack"
 
   s.add_development_dependency "rspec", "~> 2"
   s.add_development_dependency "webmock"
   s.add_development_dependency "coffee-script"
-  s.add_development_dependency "guard-rspec"
-  s.add_development_dependency "guard-bundler"
-  s.add_development_dependency "guard-coffeescript"
-  s.add_development_dependency "guard-copy"
   s.add_development_dependency "rainbows", "~> 4.4.3"
   s.add_development_dependency "thin"
   s.add_development_dependency "rack-test"
@@ -43,7 +40,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "foreman"
   s.add_development_dependency "sprockets"
   s.add_development_dependency "rake"
-  s.add_development_dependency "evergreen"
   s.add_development_dependency "capybara-webkit"
   s.add_development_dependency "therubyracer"
 end