firehose 0.0.14 → 0.0.15

data/firehose.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "em-http-request", "~> 1.0.0"
 
   s.add_development_dependency "rspec"
+  s.add_development_dependency "webmock"
   s.add_development_dependency "guard-rspec"
   s.add_development_dependency "guard-bundler"
   s.add_development_dependency "guard-coffeescript"

data/lib/firehose/default.rb

@@ -2,6 +2,7 @@ require 'uri'
 
 module Firehose
   module Default
+    # Default URI for the Firehose server. Consider the port "well-known" and bindable from other apps.
     URI = URI.parse("//127.0.0.1:7474").freeze
   end
 end

data/lib/firehose/producer.rb

@@ -5,7 +5,13 @@ module Firehose
   # Publish messages to Firehose via an HTTP interface.
   class Producer
 
-    # A DSL for publishing requests.
+    # Exception gets raised when a 202 is _not_ received from the server after a message is published.
+    PublishError = Class.new(RuntimeError)
+    TimeoutError = Class.new(Faraday::Error::TimeoutError)
+
+    # A DSL for publishing requests. This doesn't so much, but lets us call
+    # Firehose::Producer#publish('message').to('channel'). Slick eh? If you don't like it,
+    # just all Firehose::Producer#put('message', 'channel')
     class Builder
       def initialize(producer, message)
         @producer, @message = producer, message
@@ -17,6 +23,7 @@ module Firehose
       end
     end
 
+    # URI for the Firehose server. This URI does not include the path of the channel.
     attr_reader :uri
 
     def initialize(uri = Firehose::Default::URI)
@@ -35,11 +42,32 @@ module Firehose
         req.path = channel
         req.body = message
       end
-      response.on_complete(&block) if block
+      response.on_complete do
+        case response.status
+        when 202 # Fire off the callback if everything worked out OK.
+          block.call(response) if block
+        else
+          error_handler.call PublishError.new("Could not publish #{message.inspect} to '#{uri.to_s}/#{channel}': #{response.inspect}")
+        end
+      end
+
+      # Hide Faraday with this Timeout exception, and through the error handler.
+      rescue Faraday::Error::TimeoutError => e
+        error_handler.call TimeoutError.new(e)
+    end
+
+    # Handle errors that could happen while publishing a message.
+    def on_error(&block)
+      @error_handler = block
+    end
+
+    # Raise an exception if an error occurs when connecting to the Firehose.
+    def error_handler
+      @error_handler || Proc.new{ |e| raise e }
     end
 
     # What adapter should Firehose use to PUT the message? List of adapters is
-    # available at 
+    # available at https://github.com/technoweenie/faraday.
     def self.adapter=(adapter)
       @adapter = adapter
     end
@@ -53,8 +81,7 @@ module Firehose
     # Build out a Faraday connection 
     def conn
       @conn ||= Faraday.new(:url => uri.to_s) do |builder|
-        builder.adapter   self.class.adapter
-        builder.response  :logger
+        builder.adapter self.class.adapter
       end
     end
   end

data/lib/firehose/version.rb

@@ -1,4 +1,4 @@
 module Firehose
-  VERSION = "0.0.14"
-  CODENAME = "Chug Bug"
+  VERSION = "0.0.15"
+  CODENAME = "Error Reportin' Roberto"
 end

data/spec/integrations/thin_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
-require 'thin'
-require 'em-http'
-require 'em-websocket-client'
-
 describe Firehose::Rack do
-  before(:each) do
+  before(:all) do
     Firehose::Producer.adapter = :em_http
   end
 
+  after(:all) do
+    Firehose::Producer.adapter = nil
+  end
+
   let(:app)       { Firehose::Rack::App.new }
   let(:messages)  { (1..1000).map(&:to_s) }
   let(:channel)   { "/firehose/integration/#{Time.now.to_i}" }

data/spec/lib/producer_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Firehose::Producer do
+  let(:channel)       { "/channel-awesome" }
+  let(:url)           { "#{Firehose::Default::URI}#{channel}"}
+  let(:publish_stub)  { stub_request(:put, url) }
+  let(:message)       { "hey dude" }
+
+  before(:all) do
+    Firehose::Producer.adapter = :net_http
+  end
+
+  after(:all) do
+    Firehose::Producer.adapter = nil
+  end
+
+  it "should publish message to channel" do
+    publish_stub.to_return(:body => "", :status => 202)
+
+    Firehose::Producer.new.publish(message).to(channel)
+    WebMock.should have_requested(:put, url).with { |req| req.body == message }
+  end
+
+  describe "connection error handling" do
+    it "should raise PublishError if not 201" do
+      publish_stub.to_return(:body => "", :status => 500)
+
+      lambda{
+        Firehose::Producer.new.publish(message).to(channel)
+      }.should raise_exception(Firehose::Producer::PublishError)
+    end
+
+    it "should use .error_handler if not 201" do
+      publish_stub.to_return(:body => "", :status => 500)
+
+      producer = Firehose::Producer.new
+      producer.on_error do |e|
+        e.message.should =~ /could not publish.+to/i
+      end
+      producer.publish(message).to(channel)
+    end
+
+    it "should raise TimeoutError if timed out" do
+      publish_stub.to_timeout
+
+      lambda{
+        Firehose::Producer.new.publish(message).to(channel)
+      }.should raise_exception(Firehose::Producer::TimeoutError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,10 +1,19 @@
+require 'logger'
+require 'em-http'
+require 'em-websocket-client'
+
 require 'firehose'
+Firehose.logger = Logger.new('/dev/null')
+
+# Lets skip the verbosity of the thin for the test output.
+require 'thin'
+Thin::Logging.silent = true
+
+# We use both EM::Http and Net::Http in this test lib. When EM:Http is fired up
+# we're usually hitting thins for integrations, and when Net::Http we want to mock that up.
+require 'webmock/rspec'
+WebMock.allow_net_connect!
 
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper.rb"` to ensure that it is only
-# loaded once.
-#
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firehose
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-01 00:00:00.000000000 Z
+date: 2012-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70255960339200 !ruby/object:Gem::Requirement
+  requirement: &70353146415780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.0.beta
   type: :runtime
   prerelease: false
-  version_requirements: *70255960339200
+  version_requirements: *70353146415780
 - !ruby/object:Gem::Dependency
   name: amqp
-  requirement: &70255960386800 !ruby/object:Gem::Requirement
+  requirement: &70353146414160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 0.9.4
   type: :runtime
   prerelease: false
-  version_requirements: *70255960386800
+  version_requirements: *70353146414160
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: &70255960386300 !ruby/object:Gem::Requirement
+  requirement: &70353146412800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70255960386300
+  version_requirements: *70353146412800
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70255960385780 !ruby/object:Gem::Requirement
+  requirement: &70353146411120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70255960385780
+  version_requirements: *70353146411120
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70255960385320 !ruby/object:Gem::Requirement
+  requirement: &70353146454620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70255960385320
+  version_requirements: *70353146454620
 - !ruby/object:Gem::Dependency
   name: websocket-rack
-  requirement: &70255960384580 !ruby/object:Gem::Requirement
+  requirement: &70353146454100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70255960384580
+  version_requirements: *70353146454100
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70255960381700 !ruby/object:Gem::Requirement
+  requirement: &70353146453540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +88,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70255960381700
+  version_requirements: *70353146453540
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70255960381020 !ruby/object:Gem::Requirement
+  requirement: &70353146453060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70255960381020
+  version_requirements: *70353146453060
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70353146452280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70353146452280
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70255960380000 !ruby/object:Gem::Requirement
+  requirement: &70353146451380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +121,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70255960380000
+  version_requirements: *70353146451380
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &70255960378880 !ruby/object:Gem::Requirement
+  requirement: &70353146448880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,10 +132,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70255960378880
+  version_requirements: *70353146448880
 - !ruby/object:Gem::Dependency
   name: guard-coffeescript
-  requirement: &70255960402740 !ruby/object:Gem::Requirement
+  requirement: &70353146448120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,10 +143,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70255960402740
+  version_requirements: *70353146448120
 - !ruby/object:Gem::Dependency
   name: em-websocket-client
-  requirement: &70255960401900 !ruby/object:Gem::Requirement
+  requirement: &70353146447120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -143,7 +154,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70255960401900
+  version_requirements: *70353146447120
 description: Firehose is a realtime web application toolkit for building realtime
   Ruby web applications.
 email:
@@ -183,6 +194,7 @@ files:
 - spec/integrations/amqp_resources_spec.rb
 - spec/integrations/thin_spec.rb
 - spec/lib/default_spec.rb
+- spec/lib/producer_spec.rb
 - spec/spec_helper.rb
 homepage: http://firehose.io/
 licenses: []
@@ -212,4 +224,5 @@ test_files:
 - spec/integrations/amqp_resources_spec.rb
 - spec/integrations/thin_spec.rb
 - spec/lib/default_spec.rb
+- spec/lib/producer_spec.rb
 - spec/spec_helper.rb