rack-joint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5e1153300da20c9b6f0743ad1987ed7c6981fe845fc50773de47d249600bc71b
+  data.tar.gz: 4fd6e1c37560e6d03df409728216ebb2e694282fd9273103355129b626d7dea9
+SHA512:
+  metadata.gz: d61bb17986048e07e0a29450b1a2d93a2d98d6e59932b2353fb3ec21d005f2f47c30a36fe9c910ecc28edce64582978bb809019a81340d8a11ce67feac19db94
+  data.tar.gz: 7234c8b134d1f9858e32e51c747f95e3a908372f22c2659697878e77222e75dc767c70f7fc04f925a02818fecd238816bac06a193ef3cd3eeba28a09fd540463

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea
+tags
+.ruby-version
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.4
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rack-joint.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Akito Kasai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# Rack::Joint
+
+Rack::Joint is a [Rack](https://github.com/rack/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:
+
+```ruby
+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:
+
+```ruby
+# 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 `http://example.org/meow/mew` with 302.
+    redirect '/cats.html' do
+      new_host 'example.org'
+      to '/meow/mew'
+      status 302
+    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
+end
+
+run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['Hello World!']] }
+```
+
+You can use following resources with block.
+
+| Resource | Description |
+| :------- | :---------- |
+| `host`   | Host name. |
+| `redirect` | Path name. |
+| `new_host` | A new host name redirects to. Optional. |
+| `to` | A new path name redirects to. Optional. |
+| `status` | Status when redirecting. You can use `301`, `302`, `303`, `307`, `308`; which is `301` to default. |
+
+## 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](https://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](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/joint"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack/joint/context.rb

@@ -0,0 +1,19 @@
+module Rack
+  class Joint
+    class Context
+      attr_reader :responses
+      def initialize
+        @responses = []
+      end
+
+      # @param  old_host [String] Hostname set as argument in `config.ru`.
+      # @param  &block   [block] Given block with `host`.
+      # @return [Array] Return Array consisted of block under `redirect`.
+      def host(old_host, &block)
+        responses << {
+          "#{old_host}" => Redirect.new(old_host).instance_exec(&block)
+        }
+      end
+    end
+  end
+end

data/lib/rack/joint/redirect.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Rack
+  class Joint
+    class Redirect
+      attr_reader :responses
+      attr_reader :old_host
+      def initialize(old_host)
+        @responses = []
+        @old_host = old_host
+      end
+
+      # @param old_path [String] Path set as argument in `config.ru`.
+      # @param &block [block] Given block with `redirect`.
+      # @return [Array] Return Array consisted of block under `redirect`.
+      def redirect(old_path, &block)
+        responses << RedirectInterface.new(old_host, old_path, &block).apply!
+      end
+    end
+  end
+end

data/lib/rack/joint/redirect_interface.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+require 'uri'
+
+module Rack
+  class Joint
+    class BadRedirectError < StandardError; end
+
+    class RedirectInterface
+      attr_reader :old_host
+      attr_reader :old_path
+      attr_reader :old_url
+      def initialize(old_host, old_path, &block)
+        @old_host = old_host
+        @old_path = old_path
+        @old_url = build_uri(old_host, old_path)
+        instance_exec(&block)
+      end
+
+      # @return [Array] Return response given parameters in `config.ru`.
+      def apply!
+        @status ||= 301
+        @new_host ||= old_host
+        @new_path ||= old_path
+        new_location = build_uri(@new_host, @new_path)
+        if old_url == new_location
+          raise BadRedirectError.new('Redirect URL has been declared the same as current URL.')
+        end
+        [@status, { 'Location' => new_location, 'Content-Type' => 'text/html', 'Content-Language' => '0' }, ["Redirect from: #{old_url}"]]
+      end
+
+      private
+
+      # @param host [String]
+      # @param path [String]
+      # @return [URI]
+      def build_uri(host, path)
+        URI::HTTP.build({ host: host, path: path }).to_s
+      end
+
+      # @param status [Integer] `status` parameter when redirecting in `config.ru`.
+      # @return [Integer] Return status code.
+      def status(status)
+        @status =
+          case status
+          when 302
+            302
+          when 303
+            303
+          when 307
+            307
+          when 308
+            308
+          else
+            301
+          end
+      end
+
+      # @param host [String] `new_host` parameter to redirect hostname in `config.ru`.
+      # @return [String] Return hostname where redirects to.
+      def new_host(host)
+        @new_host = host
+      end
+
+      # @param path [String] `to` parameter to redirect path in `config.ru`
+      # @return [String] Return pathname where redirects to.
+      def to(path)
+        @new_path = path
+      end
+    end
+  end
+end
+

data/lib/rack/joint/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Joint
+    VERSION = "0.1.0"
+  end
+end

data/lib/rack/joint.rb

@@ -0,0 +1,56 @@
+require "rack"
+require "rack/joint/context"
+require "rack/joint/redirect"
+require "rack/joint/redirect_interface"
+require "rack/joint/version"
+
+module Rack
+  class Joint
+    attr_reader :app
+    attr_reader :mappings
+    def initialize(app, &block)
+      @app = app
+      @mappings = Context.new.instance_exec(&block) if block_given?
+    end
+
+    def call(env)
+      rack_env = Rack::Request.new(env)
+      env_host = rack_env.host
+      env_path = rack_env.fullpath
+      requests = valid_mapping(env_host)
+
+      if check_redirect?(requests, env_path)
+        redirect_info(requests, env_path)
+      else
+        app.call(env)
+      end
+    end
+
+    private
+
+    # @param host [String] Requested hostname(env)
+    # @return [Array] Return URL mapped responses.
+    def valid_mapping(host)
+      return [] unless mappings
+      mappings.select { |res| res[host] }.first.values.flatten(1)
+    end
+
+    # @param  requests [Array] Mapped redirect response information.
+    # @param  path     [String] Requested pathname(env)
+    # @return [Boolean]
+    def check_redirect?(requests, path)
+      requests.map do |req|
+        req[2].to_s.include?(path)
+      end.include?(true)
+    end
+
+    # @param  requests [Array] Mapped redirect response information.
+    # @param  path     [String] Requested pathname(env)
+    # @return [Array] Return response corresponded request.
+    def redirect_info(requests, path)
+      requests.select do |req|
+        req[2].to_s.include?(path)
+      end.to_a.flatten(1)
+    end
+  end
+end

data/lib/rack-joint.rb

@@ -0,0 +1 @@
+require 'rack/joint'

data/rack-joint.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rack/joint/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-joint"
+  spec.version       = Rack::Joint::VERSION
+  spec.authors       = ["Akito Kasai"]
+  spec.email         = ["kasai@akito19.com"]
+
+  spec.summary       = %q{A rack middleware for redirecting.}
+  spec.description   = %q{A rack middleware to help you to redirect.}
+  spec.homepage      = "https://github.com/akito19/rack-joint"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rack-test"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: rack-joint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akito Kasai
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A rack middleware to help you to redirect.
+email:
+- kasai@akito19.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack-joint.rb
+- lib/rack/joint.rb
+- lib/rack/joint/context.rb
+- lib/rack/joint/redirect.rb
+- lib/rack/joint/redirect_interface.rb
+- lib/rack/joint/version.rb
+- rack-joint.gemspec
+homepage: https://github.com/akito19/rack-joint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A rack middleware for redirecting.
+test_files: []