rack-back_door 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fa079c5c2922e21326349f5d466e6fb44d659d9
+  data.tar.gz: 3a2efb08f13cd34864635b607291ab41e5637d26
+SHA512:
+  metadata.gz: 720251a4cf23cab0b8fe96ba80acbfb0289bd0490c44eceb48198a2350ef65d0398d1100d12f2a569a8d2955b2bb06d5805a5b14184b841246305ba3787264e6
+  data.tar.gz: 9e30496cb73550dd2f469426c3227d23fc5384d56fba4741e8c964dabe589dede7ff069d1d4141a1d0273d5b554d9dce0352bb4a12ab47bd163dc8d84cba41ee

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sean Doyle
+
+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/README.md

@@ -0,0 +1,116 @@
+# Rack::BackDoor
+
+Inject a user into a session for integration and controller tests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-back_door'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install rack-back_door
+```
+
+# Usage
+
+By default, `Rack::BackDoor` will handle the following URL:
+
+```
+http://example.com?as=1
+```
+
+By injecting `1` into the `session` as `user_id`
+
+```ruby
+session[:user_id]   # => 1
+```
+
+## Setup in Rails tests
+
+Add the middleware to your stack in the `config/environments/test.rb` file
+
+```ruby
+# config/environments/test.rb
+
+MyApplication::Application.configure do |config|
+# ...
+  config.middleware.use Rack::BackDoor
+# ...
+end
+```
+
+or, in `rspec` spec helper
+
+```ruby
+# spec/spec_helper.rb
+MyApplication::Application.configure do |config|
+  config.middleware.use Rack::BackDoor
+end
+```
+
+## Setup in Sinatra Tests
+
+Add to your sinatra application:
+
+```ruby
+# app.rb
+class MySinatraApplication < Sinatra::Base
+  enable :sessions
+  use Rack::BackDoor if environment == :test
+  # ...
+end
+```
+
+If you use rspec you may prefer to inject middleware only for `rspec` tests:
+
+Put into `spec/spec_helper.rb`:
+
+```ruby
+# spec/spec_helper.rb
+MySinatraApplication.configure do
+  use Rack::BackDoor
+end
+```
+
+## Configuration
+
+You can configure the following:
+
+* `session_key` - The key used to hold the `user_id` in the session
+* `url_parameter` - The query parameter the middleware will use as the `user_id` value
+
+```ruby
+# When configured with these values and passed the following URL
+#
+#   http://example.com?login=1
+#
+# The middleware will set the session like so
+#
+#   session[:user]  # => 1
+#
+Rack::BackDoor.configure do |config|
+  config.session_key   = "user"
+  config.url_parameter = "login"
+end
+```
+
+In your `spec/spec_helper.rb`, or any other testing setup file
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rack/back_door.rb

@@ -0,0 +1,68 @@
+require 'rack/utils'
+
+# Force a User to be authenticated
+# ala http://robots.thoughtbot.com/post/37907699673/faster-tests-sign-in-through-the-back-door
+class Rack::BackDoor
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      yield configuration if block_given?
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def url_parameter
+      configuration.url_parameter
+    end
+
+    def session_key
+      configuration.session_key
+    end
+  end
+
+  class Configuration
+    attr_accessor :url_parameter, :session_key
+
+    def initialize
+      @url_parameter  = "as"
+      @session_key    = "user_id"
+    end
+  end
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    @env = env
+    sign_in_through_the_back_door
+    @app.call(@env)
+  end
+
+  private
+
+  def session_key
+    self.class.session_key.to_s
+  end
+
+  def url_parameter
+    self.class.url_parameter.to_s
+  end
+
+  def sign_in_through_the_back_door
+    if user_id = query_params[url_parameter]
+      session[session_key] = user_id.to_s
+    end
+  end
+
+  def session
+    @env['rack.session'] ||= {}
+  end
+
+  def query_params
+    Rack::Utils.parse_query(@env['QUERY_STRING'])
+  end
+end

data/rack-back_door.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-back_door"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Sean Doyle"]
+  spec.email         = ["sean.p.doyle24@gmail.com"]
+  spec.summary       = %q{Inject an authenticated user into a Rack session}
+  spec.description   = %q{For unit, controller, or integration tests, inject an authenticated user into a Rack session}
+  spec.homepage      = "https://github.com/seanpdoyle/rack-back_door"
+  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_dependency "rack"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/lib/rack/back_door_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'pry'
+
+describe Rack::BackDoor do
+  let(:app) { ->(env) { [200, env, "app"] } }
+
+  let :middleware do
+    Rack::BackDoor.new(app)
+  end
+
+  before do
+    Rack::BackDoor.configuration = nil
+  end
+
+  context "without the backdoor URL parameter" do
+    it "does nothing to the session" do
+      code, env = middleware.call env_for('http://example.com')
+
+      expect(env).not_to be_authenticated_with "user_id" => 1
+    end
+  end
+
+  context "with the backdoor URL parameter" do
+    it "stuffs the session" do
+      code, env = middleware.call env_for('http://example.com?as=1')
+
+      expect(env).to be_authenticated_with "user_id" => 1
+    end
+
+    context "when the URL parameter is configured" do
+      before do
+        Rack::BackDoor.configure do |config|
+          config.url_parameter = :login
+        end
+      end
+
+      it "stuffs the session with the default key" do
+        code, env = middleware.call env_for('http://example.com?login=1')
+
+        expect(env).to be_authenticated_with "user_id" => 1
+      end
+    end
+
+    context "when the session key is configured" do
+      before do
+        Rack::BackDoor.configure do |config|
+          config.session_key = :user
+        end
+      end
+
+      it "stuffs the session with the configured key" do
+        code, env = middleware.call env_for('http://example.com?as=1')
+
+        expect(env).to be_authenticated_with "user" => 1
+      end
+    end
+  end
+
+  def env_for(url, opts={})
+    Rack::MockRequest.env_for(url, opts)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require './lib/rack/back_door'
+
+require 'rack/mock'
+
+Dir["./spec/support/**/*.rb"].each {|f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

data/spec/support/matchers/be_authenticated_with.rb

@@ -0,0 +1,9 @@
+RSpec::Matchers.define :be_authenticated_with do |options|
+  match do |env|
+    session     = env.fetch("rack.session", {})
+    session_key = options.keys.first.to_s
+    user_id     = options.values.first.to_i
+
+    expect(session[session_key].to_i).to eq user_id.to_i
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: rack-back_door
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sean Doyle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-22 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: For unit, controller, or integration tests, inject an authenticated user
+  into a Rack session
+email:
+- sean.p.doyle24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/back_door.rb
+- rack-back_door.gemspec
+- spec/lib/rack/back_door_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/be_authenticated_with.rb
+homepage: https://github.com/seanpdoyle/rack-back_door
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Inject an authenticated user into a Rack session
+test_files:
+- spec/lib/rack/back_door_spec.rb
+- spec/spec_helper.rb
+- spec/support/matchers/be_authenticated_with.rb