rack-back_door 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fa079c5c2922e21326349f5d466e6fb44d659d9
-  data.tar.gz: 3a2efb08f13cd34864635b607291ab41e5637d26
+  metadata.gz: 8484b357ba7880ae4d782c8755c817b2929c46ed
+  data.tar.gz: 80ab747a444db352fb75707b7e8133ff87f95b81
 SHA512:
-  metadata.gz: 720251a4cf23cab0b8fe96ba80acbfb0289bd0490c44eceb48198a2350ef65d0398d1100d12f2a569a8d2955b2bb06d5805a5b14184b841246305ba3787264e6
-  data.tar.gz: 9e30496cb73550dd2f469426c3227d23fc5384d56fba4741e8c964dabe589dede7ff069d1d4141a1d0273d5b554d9dce0352bb4a12ab47bd163dc8d84cba41ee
+  metadata.gz: e5873ec981c95c5f7712a7fd36ea02cab60f9ce520a0c6772961aad36a017fd5f376c2ef9a33c05ddfb0c644ee4df4dce5585376ab37703d2395cba5c0e3cd76
+  data.tar.gz: 3fb7325a8437f54dd584d18a42939f1847394b4470da5f33487408667d2a21a6a15a509a68abb20372e00446c0f45ae9e40bca93020e283627468115d8776f64

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+- 2.0.0
+- 1.9.3
+- jruby-19mode
+- rbx-2

data/README.md

@@ -1,5 +1,8 @@
 # Rack::BackDoor
 
+[![Build
+Status](https://travis-ci.org/seanpdoyle/rack-back_door.svg)](https://travis-ci.org/seanpdoyle/rack-back_door)
+
 Inject a user into a session for integration and controller tests.
 
 ## Installation
@@ -50,15 +53,6 @@ MyApplication::Application.configure do |config|
 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:
@@ -90,22 +84,41 @@ 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
 
+When configured with these values and passed the following URL
+
+   http://example.com?login=1
+
+The middleware will set the session like so
+
 ```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"
+session[:user]  #=> 1
+```
+
+To configure the middleware in a `sinatra` app:
+
+```ruby
+# app.rb
+class MySinatraApplication < Sinatra::Base
+  enable :sessions
+
+  if environment == "test"
+    use Rack::BackDoor, session_key: "user", url_parameter: "login"
+  end
+
+  # ...
 end
 ```
 
-In your `spec/spec_helper.rb`, or any other testing setup file
+To configure the middleware in a `rails` app:
+
+```ruby
+# config/test.rb
+MyApplication::Application.configure do |config|
+# ...
+  config.middleware.use "Rack::BackDoor", session_key: "user", url_parameter: "login"
+# ...
+end
+```
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob("test/**/*_test.rb")
+end
+task :default => :test

data/examples/sinatra.rb

@@ -0,0 +1,14 @@
+require "sinatra"
+require "rack/back_door"
+
+enable :sessions
+
+use Rack::BackDoor, session_key: "user", url_parameter: "login"
+
+get "/" do
+  user_id = session["user"]
+
+  session.clear
+
+  user_id
+end

data/lib/rack/back_door.rb

@@ -1,56 +1,25 @@
-require 'rack/utils'
+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)
+  def initialize(app, options = {})
     @app = app
+    @url_parameter = options.fetch(:url_parameter, "as")
+    @session_key = options.fetch(:session_key, "user_id")
   end
 
   def call(env)
     @env = env
+
     sign_in_through_the_back_door
-    @app.call(@env)
+
+    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
+  attr_reader :app, :url_parameter, :session_key, :env
 
   def sign_in_through_the_back_door
     if user_id = query_params[url_parameter]
@@ -59,10 +28,10 @@ class Rack::BackDoor
   end
 
   def session
-    @env['rack.session'] ||= {}
+    env['rack.session'] ||= {}
   end
 
   def query_params
-    Rack::Utils.parse_query(@env['QUERY_STRING'])
+    Rack::Utils.parse_query(env['QUERY_STRING'])
   end
 end

data/rack-back_door.gemspec

@@ -4,7 +4,7 @@ $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.version       = "0.1.0"
   spec.authors       = ["Sean Doyle"]
   spec.email         = ["sean.p.doyle24@gmail.com"]
   spec.summary       = %q{Inject an authenticated user into a Rack session}
@@ -21,5 +21,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "sinatra"
 end

data/test/rack/back_door_test.rb

@@ -0,0 +1,60 @@
+$LOAD_PATH.unshift File.expand_path("../../../lib", __FILE__)
+
+require "minitest/autorun"
+require "rack/mock"
+require "rack/back_door"
+
+class Rack::BackDoorTest < Minitest::Test
+  def test_does_nothing_without_url_parameter
+    middleware = Rack::BackDoor.new(app)
+    request = request_for("http://example.com")
+
+    _, env = middleware.call(request)
+
+    refute env_authenticated_with?(env, "user_id" => 1)
+  end
+
+  def test_authenticates_user_from_url_parameter
+    middleware = Rack::BackDoor.new(app)
+    request = request_for("http://example.com?as=1")
+
+    _, env = middleware.call(request)
+
+    assert env_authenticated_with?(env, "user_id" => 1)
+  end
+
+  def test_url_parameter_is_configurable
+    middleware = Rack::BackDoor.new(app, url_parameter: "login")
+    request = request_for("http://example.com?login=1")
+
+    _, env = middleware.call(request)
+
+    assert env_authenticated_with?(env, "user_id" => 1)
+  end
+
+  def test_session_key_is_configurable
+    middleware = Rack::BackDoor.new(app, session_key: "user")
+    request = request_for("http://example.com?as=1")
+
+    _, env = middleware.call(request)
+
+    assert env_authenticated_with?(env, "user" => 1)
+  end
+
+  def request_for(url, **options)
+    Rack::MockRequest.env_for(url, options)
+  end
+
+  def env_authenticated_with?(env, auth_hash)
+    session     = env.fetch("rack.session", {})
+    session_key, user_id = auth_hash.first.map(&:to_s)
+
+    signed_in_user = session[session_key].to_i
+
+    user_id.to_i == signed_in_user
+  end
+
+  def app
+    ->(env) { [200, env, "success!"] }
+  end
+end

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: rack-back_door
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Sean Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-07-18 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
+  name: minitest
   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: sinatra
+  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
@@ -74,17 +88,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/sinatra.rb
 - 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
+- test/rack/back_door_test.rb
 homepage: https://github.com/seanpdoyle/rack-back_door
 licenses:
 - MIT
@@ -95,21 +109,20 @@ 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
+rubygems_version: 2.4.1
 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
+- test/rack/back_door_test.rb
+has_rdoc: 

data/spec/lib/rack/back_door_spec.rb

@@ -1,62 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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