action_controller-stashed_redirects 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57726ac99490f85375fd07300740792ad9ce85efda8c4eb728794c4243391636
+  data.tar.gz: 2a3059590ed5e4032477d5600304668a5af6c4b4b55a51a31a3246a59be64e5e
+SHA512:
+  metadata.gz: bf260715badd07d6a091254fecbc3890ff21b69317fd0c05c8d50971a18f47be87a182da0f9ea6ffe2c4140d71b101f30003c24fe4ab28feb8671945aa260def
+  data.tar.gz: 949bf794275255b14aeb5b7e46e6f0558218cf736eb7a1b686063c02af2c545128e8dc55f2e0984a097b844bb8f0dcc7ea89575e67181b1a06793f239d40294a

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-21
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in action_controller-stashed_redirects.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "debug"
+gem "minitest", "~> 5.0"
+gem "railties"

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    action_controller-stashed_redirects (0.1.0)
+      actionpack (>= 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.2.3)
+      actionview (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    debug (1.5.0)
+      irb (>= 1.3.6)
+      reline (>= 0.2.7)
+    erubi (1.10.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    loofah (2.16.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    nokogiri (1.13.4-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.13.4-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.4-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.13.4-x86_64-linux)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  arm64-darwin-20
+  linux
+
+DEPENDENCIES
+  action_controller-stashed_redirects!
+  debug
+  minitest (~> 5.0)
+  railties
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Kasper Timm Hansen
+
+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,62 @@
+# ActionController::StashedRedirects
+
+Pass between different controller flows via stashed redirects
+
+Stash a redirect to execute a controller flow within another and return to the original flow later.
+
+## Usage
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :authenticate
+
+  private
+    def authenticate
+      redirect_to new_session_url unless Current.user
+    end
+end
+
+class SessionsController < ApplicationController
+  # Stash a redirect at the start of the session authentication flow,
+  # from either params[:redirect_url] or request.referer in that order.
+  stash_redirect_for :sign_in, on: :new
+
+  def new
+  end
+
+  def create
+    if User.authenticate_by(session_params)
+      # On success, redirect the user back to where they first tried to access before being authenticated.
+      redirect_from_stashed :sign_in
+    end
+  end
+end
+```
+
+See the internal documentation for more usage information.
+
+Only internal redirects are allowed, so attackers can't pass an external `redirect_url`.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add action_controller-stashed_redirects
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install action_controller-stashed_redirects
+
+## 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 the created tag, 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/[USERNAME]/action_controller-stashed_redirects.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+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/action_controller-stashed_redirects.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/action_controller/stashed_redirects/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "action_controller-stashed_redirects"
+  spec.version = ActionController::StashedRedirects::VERSION
+  spec.authors = ["Kasper Timm Hansen"]
+  spec.email   = ["hey@kaspth.com"]
+
+  spec.summary  = "Embed a controller flow within another by stashing the final redirect upfront and performing it after completing."
+  spec.homepage = "https://github.com/kaspth/action_controller-stashed_redirects"
+  spec.license  = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"]   = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "actionpack", ">= 7.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/action_controller/stashed_redirects/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActionController
+  module StashedRedirects
+    VERSION = "0.1.0"
+  end
+end

data/lib/action_controller/stashed_redirects.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "active_support"
+require_relative "stashed_redirects/version"
+
+# Pass between different controller flows via stashed redirects
+#
+# Stash a redirect to execute a controller flow within another and return to the original flow later.
+module ActionController::StashedRedirects
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # Adds a before_action to stash a redirect for a given `on:` action.
+    #
+    #   stash_redirect_for :sudo_authentication, on: :new
+    #   stash_redirect_for :sign_in, from: :referer, on: :new
+    #   stash_redirect_for :sign_in, from: -> { update_post_path(@post) }
+    def stash_redirect_for(purpose, on:, from: nil)
+      before_action(-> { stash_redirect_for(purpose, from: from.respond_to?(:call) ? instance_exec(&from) : from) }, only: on)
+    end
+  end
+
+  # Stashes a redirect URL in the `session` under the given +purpose+.
+  #
+  # An explicit +redirect_url+ can be passsed, otherwise the redirect URL is
+  # derived from `params[:redirect_url]` then falling back to `request.referer`.
+  #
+  #   stash_redirect_for :sign_in
+  #   stash_redirect_for :sign_in, from: url_from(params[:redirect_url]) || root_url
+  #   stash_redirect_for :sign_in, from: :param   # Only derive the redirect URL from `params[:redirect_url]`.
+  #   stash_redirect_for :sign_in, from: :referer # Only derive the redirect URL from `request.referer`.
+  def stash_redirect_for(purpose, from: nil)
+    if url = derive_stash_redirect_url_from(from)
+      session[KEY_GENERATOR.(purpose)] = url
+    else
+      raise ArgumentError, "missing a redirect_url to stash, pass one via from: or via a redirect_url URL param"
+    end
+  end
+
+  # Finds and deletes the redirect stashed in `session` under the given +purpose+, then redirects.
+  #
+  #   redirect_from_stashed :login
+  #
+  # Raises if no stashed redirect is found under the given +purpose+.
+  #
+  # Relies on +redirect_to+'s open redirect protection, see it's documentation for more.
+  def redirect_from_stashed(purpose)
+    redirect_to stashed_redirect_url_for(purpose)
+  end
+
+  # Deletes the redirect stashed in the `session` under the given +purpose+ and returns it if any.
+  #
+  #   discard_stashed_redirect_for :login # => the login redirect URL or nil.
+  def discard_stashed_redirect_for(purpose)
+    session.delete(KEY_GENERATOR.(purpose))
+  end
+
+  private
+    KEY_GENERATOR = ->(purpose) { "__url_stash_#{purpose}" }
+    private_constant :KEY_GENERATOR
+
+    def stashed_redirect_url_for(purpose)
+      raise ArgumentError, "can't extract a stashed redirect_url from session, none found" \
+        unless redirect_url = discard_stashed_redirect_for(purpose)
+
+      url_from(redirect_url)
+    end
+
+    def derive_stash_redirect_url_from(from)
+      from ||= %i[ param referer ]
+      { param: params[:redirect_url], referer: request.get? && request.referer }.values_at(*from).find(&:present?) || from
+    end
+end
+
+ActiveSupport.on_load(:action_controller) { include ActionController::StashedRedirects }

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: action_controller-stashed_redirects
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kasper Timm Hansen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description:
+email:
+- hey@kaspth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_controller-stashed_redirects.gemspec
+- lib/action_controller/stashed_redirects.rb
+- lib/action_controller/stashed_redirects/version.rb
+homepage: https://github.com/kaspth/action_controller-stashed_redirects
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kaspth/action_controller-stashed_redirects
+  source_code_uri: https://github.com/kaspth/action_controller-stashed_redirects
+  changelog_uri: https://github.com/kaspth/action_controller-stashed_redirects/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: Embed a controller flow within another by stashing the final redirect upfront
+  and performing it after completing.
+test_files: []