Rack::Joint

Rack::Joint is a Rack middleware which helps to redirect with Ruby DSL.

Requirements

Rack::Joint requires Ruby 2.4+.

Installation

Add this line to your application's Gemfile:

gem 'rack-joint'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rack-joint

Usage

Write settings in config.ru. This is a sample:

# config.ru
require 'rack/joint'

use Rack::Joint do
  host 'example.com' do
    # If you access `http://example.com/dogs/bark.html`,
    # redirect to `http://example.org/bowwow.html` with 301.
    redirect '/dogs/bark.html' do
      new_host 'example.org'
      to '/bowwow.html'
      status 301
    end

    # If you access `http://example.com/cats.html`,
    # redirect to `https://example.org/meow/mew` with 302.
    redirect '/cats.html' do
      new_host 'example.org'
      ssl true
      to '/meow/mew'
      status 302
    end
  end

  host 'example.net' do
    # If you access `http://example.net/frog.html`,
    # redirect to `http://example.net/croak` with 301.
    redirect '/frog.html' do
      to '/croak'
    end

    # If you access `http://example.net/quack`,
    # redirect to `http://example.org/quack` with 301.
    redirect '/quack' do
      new_host 'example.org'
    end
  end

  # Following description allows you to redirect to URL you set with only host replaced.
  #
  # e.g. When accessing 'http://example.io/foo/bar/baz',
  #      redirect to `http://example.org/foob/bar/baz` with 301.
  host 'example.io' do
    redirect do
      new_host 'example.org'
    end
  end
end

run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['Hello World!']] }

You can use following resources with block.

Resource	Type	Description
host	string	Required. Host name.
redirect	string	Path name. If you give nothing with this option, Rack::Joint will replace only host name.
ssl	boolean	Whether to enable SSL. If the option isn't set, the scheme of Location header is determined in response to GET request.
new_host	string	A new host name redirects to.
to	string	A new path name redirects to.
status	integer	Status when redirecting. You can use 301, 302, 303, 307, 308; which is 301 to default.

Supplement

This library's test case will be actual samples.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

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, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/akito19/rack-joint.

License

The gem is available as open source under the terms of the MIT License.