go_to_param 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f0ecdb8725a6803349e51b90dc85872681c6162
+  data.tar.gz: 09c706a18e0cfb180d606472bf9a8f459fa9c8f7
+SHA512:
+  metadata.gz: 56b20be331349761df60822bf4232c19baaa3a4b20a8364fb78a650a09bbb6f928210cc265b436c2f4ade9cebb110d78ca33da96aa9173265e114f7c66ae941a
+  data.tar.gz: 0dcb8ece149ed00d4f82c66f3b4f9de940337377006b7fbc7716011b6a050f384ba59354c7091d80a7c5b77f6ac319031ab83f374a8e4ff61d054286d221bbf7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in go_to_param.gemspec
+gemspec

data/README.md

@@ -0,0 +1,119 @@
+# GoToParam
+
+Small set of Rails "go_to" redirection parameter utilities, e.g. to catch a desired path and redirect to it after logging in.
+
+## Usage
+
+Include in some suitable base controller:
+
+``` ruby
+class ApplicationController < ActionController::Base
+  include GoToParameter
+end
+```
+
+Now your controllers and views get some methods.
+
+### get_go_to_param
+
+Put the current/requested path in a `?go_to=` parameter.
+
+``` ruby
+class ApplicationController < ActionController::Base
+  include GoToParam
+
+  before_filter :ensure_authenticated
+
+  private
+
+  def ensure_authenticated
+    unless authenticated?
+      redirect_to login_path(get_go_to_param)
+    end
+  end
+end
+```
+
+Only picks up the requested path if it's a GET, since we can't redirect back to a non-GET later.
+
+### hidden_go_to_tag
+
+Pass the `go_to` parameter along with a form.
+
+``` erb
+<h1>Log in</h1>
+
+<form>
+  <%= hidden_go_to_tag %>
+  …
+</form>
+```
+
+### go_to_param
+
+Pass the `go_to` parameter along with a link.
+
+``` erb
+<%= link_to("Reset password", password_reset_path(go_to_param)) %>
+```
+
+You can pass in additional parameters for the given path:
+
+``` erb
+<%= link_to("Reset password", password_reset_path(go_to_param(email: @email))) %>
+```
+
+### go_to_path_or
+
+Finally use the `go_to` parameter.
+
+You must pass in a fallback path.
+
+``` ruby
+class SessionsController < ActionController::Base
+  def create
+    if logged_in?
+      redirect_to go_to_path_or(root_path)
+    end
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'go_to_param'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install go_to_param
+
+## License
+
+Copyright (c) 2013 Henrik Nyh
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/go_to_param.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'go_to_param/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "go_to_param"
+  spec.version       = GoToParam::VERSION
+  spec.authors       = ["Henrik N"]
+  spec.email         = ["henrik@nyh.se"]
+  spec.summary       = %q{Rails "go_to" redirection param utilities.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/go_to_param.rb

@@ -0,0 +1,38 @@
+require "go_to_param/version"
+
+module GoToParam
+  def self.included(klass)
+    klass.helper_method :hidden_go_to_tag, :go_to_param
+  end
+
+  def hidden_go_to_tag
+    view_context.hidden_field_tag :go_to, go_to_value
+  end
+
+  def go_to_param(other_params = {})
+    { go_to: go_to_value }.merge(other_params)
+  end
+
+  def get_go_to_param
+    if request.get?
+      { go_to: request.fullpath }
+    else
+      {}
+    end
+  end
+
+  def go_to_path_or(path)
+    # Avoid phishing redirects.
+    if go_to_value.to_s.start_with?("/")
+      go_to_value
+    else
+      path
+    end
+  end
+
+  private
+
+  def go_to_value
+    params[:go_to]
+  end
+end

data/lib/go_to_param/version.rb

@@ -0,0 +1,3 @@
+module GoToParam
+  VERSION = "0.0.1"
+end

data/spec/go_to_spec.rb

@@ -0,0 +1,83 @@
+require_relative "../lib/go_to_param"
+
+class FakeController
+  attr_accessor :params, :view_context, :request
+
+  def self.helper_method(*methods)
+    @helper_methods = methods
+  end
+
+  def self.helper_methods
+    @helper_methods
+  end
+
+  include GoToParam
+end
+
+describe GoToParam do
+  let(:controller) { FakeController.new }
+
+  describe "#hidden_go_to_tag" do
+    it "makes it a helper method" do
+      FakeController.helper_methods.should include :hidden_go_to_tag
+    end
+
+    it "adds a hidden field tag" do
+      controller.params = { go_to: "/example", id: "1" }
+      view = double
+      controller.view_context = view
+
+      view.should_receive(:hidden_field_tag).
+        with(:go_to, "/example")
+      controller.hidden_go_to_tag
+    end
+  end
+
+  describe "#go_to_param" do
+    it "makes it a helper method" do
+      FakeController.helper_methods.should include :go_to_param
+    end
+
+    it "includes the go_to parameter" do
+      controller.params = { go_to: "/example", id: "1" }
+
+      controller.go_to_param.should == { go_to: "/example" }
+    end
+
+    it "accepts additional parameters" do
+      controller.params = { go_to: "/example", id: "1" }
+
+      controller.go_to_param(a: "b").should == { go_to: "/example", a: "b" }
+    end
+  end
+
+  describe "#get_go_to_param" do
+    it "gets the request path as the go_to parameter" do
+      controller.request = double(get?: true, fullpath: "/example")
+      controller.get_go_to_param.should == { go_to: "/example" }
+    end
+
+    it "returns an empty hash for a non-GET request" do
+      controller.request = double(get?: false, fullpath: "/example")
+      controller.get_go_to_param.should == {}
+    end
+  end
+
+  describe "#go_to_path_or" do
+    it "is the go_to parameter value" do
+      controller.params = { go_to: "/example", id: "1" }
+      controller.go_to_path_or("/default").should == "/example"
+    end
+
+    it "falls back to the passed-in value without a parameter value" do
+      controller = FakeController.new
+      controller.params = { id: "1" }
+      controller.go_to_path_or("/default").should == "/default"
+    end
+
+    it "only allows relative paths" do
+      controller.params = { go_to: "http://evil.com", id: "1" }
+      controller.go_to_path_or("/default").should == "/default"
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: go_to_param
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Henrik N
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
+email:
+- henrik@nyh.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- go_to_param.gemspec
+- lib/go_to_param.rb
+- lib/go_to_param/version.rb
+- spec/go_to_spec.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Rails "go_to" redirection param utilities.
+test_files:
+- spec/go_to_spec.rb
+has_rdoc: