Project

midler

0.0
No commit activity in last 3 years
No release in over 3 years
A variadic fork of the middleware gem
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.6
~> 10.0
~> 2.8.0
~> 2.8.0
 Project Readme

Midler

Build Status

This is a fork of Middleware that allows multiple env arguments, and is fully backward compatible. Refer to the parent gem for additional documentation.

Recite: "boil, boil, toil and trouble..."

Installation

Add this line to your application's Gemfile:

gem 'midler'

And then execute:

$ bundle

Or install it yourself as:

$ gem install midler

Variadic Middleware Usage

This is where this fork of the gem really shines. We can now pass variadic arguments in place of env. For example, we can now call the stack with a request and response for this express-style webserver example.

class JsonResponse
  def initialize(app)
    @app   = app
  end

  def call(request, response)
    Logger.info { "Received #{request[:body]} from request" }
    response[:accept] = "application/json"
    @app.call(request, response)
  end
end

stack = Midler::Builder.new do
  use JsonResponse
  use Authenticate
  use Authorized
end

# Run it!
stack.call(request, response)

Singular Env Usage

Once you create a basic middleware, you can use the builder to have a nice DSL to build middleware stacks. Calling the middleware is simple, as well.

# Basic middleware that just prints the inbound and
# outbound steps.
class Trace
  def initialize(app, value)
    @app   = app
    @value = value
  end

  def call(env)
    puts "--> #{@value}"
    @app.call(env)
    puts "<-- #{@value}"
  end
end

# Build the actual middleware stack which runs a sequence
# of slightly different versions of our middleware.
stack = Midler::Builder.new do
  use Trace, "A"
  use Trace, "B"
  use Trace, "C"
end

# Run it!
stack.call(nil)

And the output:

--> A
--> B
--> C
<-- C
<-- B
<-- A

Development

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/film42/midler/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request