refraction2 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b9be8d806089e0ab258abdb8d39764f6b4aa9a3b0da00624e4c1a6c8807725a
+  data.tar.gz: 1e3721b59574a86f9bd4fc8571030fdbb965201d2d2cdd77358347f541a9979c
+SHA512:
+  metadata.gz: ce9d8cedf5f47c6fc7e8759552525acddef855446757d5a8451f577756350c25b0c1e58de9cc9bdeda5fc505ecc28ade10487af8f91902b95327e55cfc833e03
+  data.tar.gz: 3ed4cb5e21d061206f8fb93d25ab85ef0e63bc01a197afaba006426499b4e917fa104ba90da0630a28f7de7095c63628b0bdc4ad2448ea1108e302e438b347d0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.1] - 2022-05-30 (first release as `refraction2`)
+
+### Fixed
+
+- fixed host and port overrides for Rack 2.2+
+
+## [0.1.3] - 2010-02-01 (last release as `refraction` by Josh Susser)

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in repper.gemspec
+gemspec
+
+gem 'rack-test', '~> 1.1'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+

data/LICENSE.txt

@@ -0,0 +1,44 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Janosch Müller
+
+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.
+
+Based on refraction by Pivotal Labs, Josh Susser, Sam Pierson, Wai Lun Mang.
+
+Copyright (c) 2009-2010 Pivotal Labs
+
+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,138 @@
+# Refraction2
+
+`refraction2` is a Rack 2.2+ compatible re-release and drop-in replacement for
+[joshsusser/refraction](https://github.com/joshsusser/refraction).
+
+## Original README
+
+Refraction is a Rack middleware replacement for `mod_rewrite`. It can rewrite URLs before they are
+processed by your web application, and can redirect using 301 and 302 status codes. Refraction is
+thread-safe, so it doesn't need to be guarded by Rack::Lock.
+
+The best thing about Refraction is that rewrite rules are written in plain old Ruby code, not some
+funky web server config syntax. That means you can use Ruby regular expressions, case statements,
+conditionals, and whatever else you feel like.
+
+For example:
+
+    Refraction.configure do |req|
+      feedburner  = "http://feeds.pivotallabs.com/pivotallabs"
+
+      if req.env['HTTP_USER_AGENT'] !~ /FeedBurner|FeedValidator/ && req.host =~ /pivotallabs\.com/
+        case req.path
+        when %r{^/(talks|blabs|blog)\.(atom|rss)$}        ; req.found! "#{feedburner}/#{$1}.#{$2}"
+        when %r{^/users/(chris|edward)/blog\.(atom|rss)$} ; req.found! "#{feedburner}/#{$1}.#{$2}"
+        end
+      else
+        case req.host
+        when 'tweed.pivotallabs.com'
+          req.rewrite! "http://pivotallabs.com/tweed#{req.path}"
+        when /([-\w]+\.)?pivotallabs\.com/
+          # passthrough with no change
+        else  # wildcard domains (e.g. pivotalabs.com)
+          req.permanent! :host => "pivotallabs.com"
+        end
+      end
+    end
+
+Notice the use of regular expressions, the $1, $2, etc pseudo-variables, and string interpolation.
+This is an easy way to match URL patterns and assemble the new URL based on what was matched.
+
+## Installation (Rails)
+
+Refraction can be installed in a Rails application as a plugin.
+
+    $ script/plugin install git://github.com/pivotal/refraction.git
+
+It can also be used as a gem:
+
+    $ gem install refraction
+
+In `environments/production.rb`, add Refraction at or near the top of your middleware stack.
+
+    config.middleware.insert_before(::Rack::Lock, ::Refraction, {})
+
+You may want to occasionally turn on Refraction in the development environment for testing
+purposes, but if your rules redirect to other servers that can be a problem.
+
+Put your rules in `config/initializers/refraction_rules.rb` (see example above). The file name
+doesn't actually matter, but convention is useful.
+
+## Server Configuration
+
+If your application is serving multiple virtual hosts, it's probably easiest to configure your web
+server to handle a wildcard server name and let Refraction handle managing the virtual hosts. For
+example, in nginx, that is done with a `server_name _;` directive.
+
+## Writing Rules
+
+Set up your rewrite/redirection rules during your app initialization using `Refraction.configure`.
+The `configure` method takes a block which is run for every request to process the rules. The block
+is passed a RequestContext object that contains information about the request URL and environment.
+The request object also has a small API for effecting rewrites and redirects.
+
+> Important note: don't do a `return` from within the configuration
+> block.  That would be bad (meaning your entire application would
+> break).  That's just how blocks work in Ruby.
+
+### `RequestContext#set(options)`
+
+The `set` method takes an options hash that sets pieces of the rewritten URL or redirect location
+header.
+
+  * :scheme - Usually `http` or `https`.
+  * :host - The server name.
+  * :port - The server port.  Usually not needed, as the scheme implies a default value.
+  * :path - The path of the URL.
+  * :query - Added at the end of the URL after a question mark (?)
+
+Any URL components not explicitly set remain unchanged from the original request URL. You can use
+`set` before calls to `rewrite!`, `permanent!`, or `found!` to set common values. Subsequent
+methods will merge their component values into values from `set`.
+
+### `RequestContext#rewrite!(options)`
+
+The `rewrite!` method modifies the request URL and relevant pieces of the environment. When
+Refraction rule processing results in a `rewrite!`, the request is passed on down the Rack stack
+to the app or the next middleware component. `rewrite!` can take a single argument, either an
+options hash that uses the same options as the `set` method, or a string that sets all components
+of the URL.
+
+### `RequestContext#permanent!(options)`
+
+The `permanent!` method tells Refraction to return a response with a `301 Moved Permanently`
+status, and sets the URL for the Location header. Like `rewrite!` it can take either a string or
+hash argument to set the URL or some of its components.
+
+### `RequestContext#found!(options)`
+
+The `found!` method tells Refraction to return a response with a `302 Found` status, and sets the
+URL for the Location header. Like `#rewrite!` it can take either a string or hash argument to set
+the URL or some of its components.
+
+### `RequestContext#respond!(status, headers, content)`
+
+Use `respond!` to return an arbitrary response to the request. This is useful for responding with
+the contents of a static file. For example:
+
+    req.respond!(503, {'Content-Type' => 'text/html'}, File.read(MAINTENANCE_PATH))
+
+The args are largely the same as the contents of a standard Rack response array with the exceptions
+that you don't need to wrap the content in an array, and the Content-Length header is generated so it
+should not be supplied.
+
+### URL components
+
+The request object provides the following components of the URL for matching requests: `scheme`,
+`host`, `port`, `path`, and `query`. It also provides a full environment hash as the `env`
+attribute. For example, `req.env['HTTP_USER_AGENT']` can be used to access the request's user
+agent property.
+
+## Contributors
+
+  * Josh Susser (maintainer)
+  * Sam Pierson
+  * Wai Lun Mang
+  * Brian Morearty
+
+Copyright (c) 2009-2010 Pivotal Labs. This software is licensed under the MIT License.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/lib/refraction/version.rb

@@ -0,0 +1,3 @@
+class Refraction
+  VERSION = '0.2.1'
+end

data/lib/refraction.rb

@@ -0,0 +1,123 @@
+require 'rack'
+require_relative 'refraction/version'
+
+class Refraction
+  class Request < Rack::Request
+    attr_reader :action, :status, :message
+
+    # backward compatibility: support URI::HTTP component names
+    def method; request_method; end
+    def query;  query_string;   end
+
+    ### actions
+
+    def set(options)
+      if options.is_a?(String)
+        @re_location = options
+      else
+        @re_scheme = options[:protocol] if options[:protocol] # :protocol is alias for :scheme
+        @re_scheme = options[:scheme]   if options[:scheme]
+        @re_host   = options[:host]     if options[:host]
+        @re_port   = options[:port]     if options[:port]
+        @re_path   = options[:path]     if options[:path]
+        @re_query  = options[:query]    if options[:query]
+      end
+    end
+
+    def rewrite!(options)
+      @action = :rewrite
+      set(options)
+    end
+
+    def permanent!(options)
+      @action = :permanent
+      @status = 301
+      set(options)
+      @message = "moved to #{@uri}"
+    end
+
+    def found!(options)
+      @action = :found
+      @status = 302
+      set(options)
+      @message = "moved to #{@uri}"
+    end
+
+    def respond!(status, headers, content)
+      @action = :respond
+      @status = status
+      @headers = headers
+      @message = content
+    end
+
+    ### response
+
+    def response
+      headers = @headers || { 'Location' => location, 'Content-Type' => 'text/plain' }
+      headers['Content-Length'] = message.length.to_s
+      [status, headers, [message]]
+    end
+
+    def location
+      @re_location || url
+    end
+
+    # use original request's values when not set explicitly
+    def scheme;       @re_scheme || super; end
+    def host;         @re_host   || super; end
+    def path;         @re_path   || super; end
+    def query_string; @re_query  || super; end
+
+    # changing the scheme or host means use default port instead of port in original request
+    def port
+      @re_port || ((@re_scheme || @re_host) && DEFAULT_PORTS[scheme]) || super
+    end
+
+    def host_with_port
+      port.nil? || port == DEFAULT_PORTS[scheme] ? host : "#{host}:#{port}"
+    end
+
+    def http_host
+      port ? "#{host}:#{port}" : host
+    end
+  end ### class Request
+
+  def self.configure(&block)
+    @rules = block
+  end
+
+  def self.rules
+    @rules
+  end
+
+  def initialize(app)
+    @app = app
+  end
+
+  def rules
+    self.class.rules
+  end
+
+  def call(env)
+    return @app.call(env) unless rules
+
+    request = Request.new(env)
+    rules.call(request)
+
+    case request.action
+    when :permanent, :found, :respond
+      request.response
+    when :rewrite
+      env["rack.url_scheme"]  = request.scheme
+      env["HTTP_HOST"]        = request.http_host
+      env["SERVER_NAME"]      = request.host
+      env["HTTP_PORT"]        = request.port if request.port
+      env["PATH_INFO"]        = request.path
+      env["QUERY_STRING"]     = request.query
+      env["REQUEST_URI"]      = request.fullpath
+      @app.call(env)
+    else
+      @app.call(env)
+    end
+  end
+end

data/lib/refraction2.rb

@@ -0,0 +1,2 @@
+# make gem require-able as "refraction2"
+require_relative 'refraction'

data/refraction.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/refraction/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'refraction2'
+  spec.version = Refraction::VERSION
+  spec.authors = ['Pivotal Labs', 'Josh Susser', 'Sam Pierson', 'Wai Lun Mang', 'Janosch Müller']
+  spec.email = ['janosch84@gmail.com']
+
+  spec.summary = 'Rack middleware replacement for joshsusser/refraction'
+  spec.homepage = 'https://github.com/jaynetics/refraction2'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rack', '>= 2.2'
+end
+

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: refraction2
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Pivotal Labs
+- Josh Susser
+- Sam Pierson
+- Wai Lun Mang
+- Janosch Müller
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description:
+email:
+- janosch84@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/refraction.rb
+- lib/refraction/version.rb
+- lib/refraction2.rb
+- refraction.gemspec
+homepage: https://github.com/jaynetics/refraction2
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jaynetics/refraction2
+  source_code_uri: https://github.com/jaynetics/refraction2
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.0.dev
+signing_key:
+specification_version: 4
+summary: Rack middleware replacement for joshsusser/refraction
+test_files: []