circuitry-middleware 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9d45fd5d5fbbb9c44fa397c0f2597aed4e3a915
-  data.tar.gz: 600f49ffdf7736ce580d25744d412b80bf083dbe
+  metadata.gz: 14617084a8222481f7bab181591ffeb2db8f3bd6
+  data.tar.gz: c625290563320713b4ec8e95d0555b29c7a51768
 SHA512:
-  metadata.gz: 53b4d05fcb215e6b5ad2b450e328fb28a2905fddb0f40058501558196dc79dc86e7bfacd097a6bf2f947e03bc24b6f6b6068c0583d8ca004dcd3d68373ef1243
-  data.tar.gz: c09774c1fefdc9d332e2a0febb07f003d9311477c331e1fc1e87778dd7b440d73941ea082dcb81a2f2e9e2817e2fbfa769f496c379c02626301bc61e3b2c79c2
+  metadata.gz: 8953dfeb827d517720043cc53a76a1d35129946af56ff276dd864a419053d5f6914c164ab88e1a5b66b7a479616fcf5b4f8b2889b3f265f42519c5cdc043ce31
+  data.tar.gz: 4dc33256286700d0c0e5a8a0dce5de5b093cafd52b89057c78ca6731671eab31eeb9c9ae4618947da381e0623e3f67b5942758c6e422da63fbab2a45baf25126

data/README.md

@@ -2,6 +2,9 @@
 
 Rails/Rack middleware for batching circuitry notifications.
 
+[![Code Climate](https://codeclimate.com/repos/559d735f6956804ff2000a9b/badges/ab8b6ef0a8e8a115041b/gpa.svg)](https://codeclimate.com/repos/559d735f6956804ff2000a9b/feed)
+[![Test Coverage](https://codeclimate.com/repos/559d735f6956804ff2000a9b/badges/ab8b6ef0a8e8a115041b/coverage.svg)](https://codeclimate.com/repos/559d735f6956804ff2000a9b/coverage)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,7 +23,7 @@ Or install it yourself as:
 
 ## Usage
 
-### Ruby on Rails
+### Ruby on Rails 4.x
 
 If using this gem in the context of a Ruby on Rails application, there's nothing
 more that you need to do beyond including the gem in your `Gemfile`.
@@ -33,6 +36,29 @@ initializer:
 require 'circuitry-middleware'
 ```
 
+### Ruby on Rails 3.x
+
+If your application *does not* use either of the `Rack::ETag` or
+`Rack::ConditionalGet` middleware components (check via `rake middleware`), then
+you can follow the Rails 4.x directions above.
+
+If your application *does* use either of these middleware components, then this
+gem must be implemented in a different manner due to an older Rack dependency
+that improperly implements these pieces of middleware.
+
+First, in your `Gemfile`:
+
+```ruby
+gem 'circuitry-middleware', require: false
+```
+
+Then in your `config/application.rb`:
+
+```ruby
+require 'circuitry/middleware/rack'
+config.middleware.insert_before Rack::ConditionalGet, Circuitry::Middleware::Rack
+```
+
 ### Rack
 
 If using this gem in the context of a Rack application, you'll need to explicitly
@@ -43,6 +69,20 @@ require 'circuitry-middleware'
 use Circuitry::Middleware
 ```
 
+### Custom Options
+
+By default, this gem utilizes batching when publishing and threading when
+subscribing.  These options can be overridden by swapping the middleware.
+
+```ruby
+config.middleware.swap Circuitry::Middleware::Rack, Circuitry::Middleware::Rack,
+    publish_async_strategy: :fork,
+    subscribe_async_strategy: :fork
+```
+
+Please refer to the [circuitry gem](https://github.com/kapost/circuitry) for
+more insight on asynchronous options.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/circuitry-middleware.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'circuitry', '>= 1.1.0'
+  spec.add_dependency 'rack', '>= 1.4.5'
 
   spec.add_development_dependency 'pry-nav'
   spec.add_development_dependency 'bundler', '~> 1.8'

data/lib/circuitry/middleware.rb

@@ -1,18 +1,3 @@
 require 'circuitry/middleware/version'
+require 'circuitry/middleware/rack'
 require 'circuitry/middleware/railtie' if defined?(Rails)
-require 'circuitry'
-
-module Circuitry
-  class Middleware
-    def initialize(app, options = {})
-      @app = app
-      Circuitry.config.publish_async_strategy = options.fetch(:publish_async_strategy, :batch)
-      Circuitry.config.subscribe_async_strategy = options.fetch(:subscribe_async_strategy, :thread)
-    end
-
-    def call(env)
-      @app.call(env)
-      Circuitry.flush
-    end
-  end
-end

data/lib/circuitry/middleware/rack.rb

@@ -0,0 +1,22 @@
+require 'circuitry'
+require 'rack/body_proxy'
+
+module Circuitry
+  module Middleware
+    class Rack
+      def initialize(app, options = {})
+        @app = app
+        Circuitry.config.publish_async_strategy = options.fetch(:publish_async_strategy, :batch)
+        Circuitry.config.subscribe_async_strategy = options.fetch(:subscribe_async_strategy, :thread)
+      end
+
+      def call(env)
+        status, headers, actual_body = @app.call(env)
+        body = ::Rack::BodyProxy.new(actual_body) do
+          Circuitry.flush
+        end
+        [status, headers, body]
+      end
+    end
+  end
+end

data/lib/circuitry/middleware/railtie.rb

@@ -1,8 +1,8 @@
 module Circuitry
-  class Middleware
+  module Middleware
     class Railtie < ::Rails::Railtie
       initializer 'circuitry.middleware' do |app|
-        app.middleware.use Middleware
+        app.middleware.use Middleware::Rack
       end
     end
   end

data/lib/circuitry/middleware/version.rb

@@ -1,5 +1,5 @@
 module Circuitry
-  class Middleware
-    VERSION = '1.0.0'
+  module Middleware
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuitry-middleware
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Matt Huggins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-08 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: circuitry
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.5
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +126,7 @@ files:
 - circle.yml
 - circuitry-middleware.gemspec
 - lib/circuitry/middleware.rb
+- lib/circuitry/middleware/rack.rb
 - lib/circuitry/middleware/railtie.rb
 - lib/circuitry/middleware/version.rb
 homepage: https://github.com/kapost/circuitry-middleware
@@ -134,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Rails/Rack middleware for batching circuitry notifications.