rack-alice_in_external 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5f472777dfd1626cd1c5bdf129acf580c850d75
+  data.tar.gz: 0198a1bacee53b5d7a2205d94482bfefe3b38171
+SHA512:
+  metadata.gz: 4c674d5972cac42b7b620aa189e32fa61cf96db3b92a74af166a1a2e70d24c60ffcd7d6b17fa433f01da1c111c4cac9ee6edb273f2afeb6a5b6c6cad927ced1f
+  data.tar.gz: 230fe6d1414e4d94027bfb3e9bfd3878af631f53751e3010a3bbf9c8d0d1bb489cb1b1ca064c1a5481880e873f7c4c509c6cdc9818cdb98fc114536c4c6e0eea

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.1

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright 2016 Hirofumi Wakasugi
+
+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,107 @@
+# Rack::AliceInExternal
+
+Rack::AliceInExternal is a Rack middleware which provides rough and dirty stubbing for authentication via [Sorcery](https://github.com/NoamB/sorcery) external (GitHub OAuth only for the moment).
+
+Assumes that you have built the `OauthsController` following to https://github.com/NoamB/sorcery/wiki/External :
+
+```ruby
+class OauthsController < ApplicationController
+
+  ...
+
+  def oauth
+
+    ...
+
+  end
+
+  def callback
+
+    ...
+
+  end
+
+  ...
+
+end
+```
+
+Rack::AliceInExternal hooks requests for `/oauth/[provider]` and returns the stubbed response which redirects you to `/oauth/callback?provider=[provider]`.
+
+Then `callback` action tries to acquire the access token for authentication from the provider, Rack::AliceInExternal stubs those requests via [WebMock](https://github.com/bblimke/webmock) and returns the response of the access token and the user data that can be appropriately handled by Sorcery.
+
+This helps you to write feature tests in more user-story-friendly ways, like:
+
+```ruby
+visit root_url
+click_link 'Login with GitHub'
+...
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-alice_in_external'
+```
+
+## Usage
+
+Rack::AliceInExternal tries to find the user who has an association with `uid: 42` in `authentications` table, so you have to create that user and the authentication associated to her (and you cannot change `uid` other than `42`) .
+
+Fixture examples:
+
+__users.yml__
+
+```yaml
+alice:
+  name: Alice
+```
+
+__authentications.yml__
+
+
+```yaml
+alice_auth:
+  uid: 42
+  provider: github
+  user: alice
+```
+
+Add the middleware you want to use for stubbing in `config/environments/test.rb` (add it in `development.rb` as well if necessary):
+
+```ruby
+Rails.application.configure do
+
+  ...
+
+
+  # Stubbing OAuth authentication via Sorcery's GitHub external
+  config.middleware.use Rack::AliceInExternal::GithubMock
+
+  ...
+
+end
+```
+
+Then just write feature tests like the below, it tries to login as the user with `uid: 42`:
+
+```ruby
+visit root_url
+click_link 'Login with GitHub' # <= the link to /oauth/[provider]
+
+...
+
+```
+
+## 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 tags, 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/5t111111/rack-alice_in_external.
+

data/Rakefile

@@ -0,0 +1,10 @@
+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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/alice_in_external"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack/alice_in_external/github_mock.rb

@@ -0,0 +1,16 @@
+module Rack
+  module AliceInExternal
+    class GithubMock
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if env['PATH_INFO'] =~ %r{\A.*/oauth/github/?\z}
+          return [301, { 'Location' => '/oauth/callback?provider=github' }, []]
+        end
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/rack/alice_in_external/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module AliceInExternal
+    VERSION = '0.1.0'
+  end
+end

data/lib/rack/alice_in_external/webmock_stubs.rb

@@ -0,0 +1,15 @@
+require 'webmock'
+
+include WebMock::API
+
+# Stubbing external request for GitHub OAuth via WebMock
+stub_request(:post, 'https://github.com/login/oauth/access_token')
+  .to_return(body: 'access_token=charleslutwidgedodgson&scope=user%2Cgist&token_type=bearer',
+             headers: { 'content-type' => 'application/x-www-form-urlencoded' })
+
+stub_request(:get, 'https://api.github.com/user')
+  .to_return(body:'{"id":42,"email":"alice@example.com"}',
+             headers: { 'content-type' => 'application/json' })
+
+WebMock.enable!
+WebMock.allow_net_connect!

data/lib/rack/alice_in_external.rb

@@ -0,0 +1,10 @@
+# Stubbing authentication via Sorcery external
+#
+# Assume you have built the controller following to the below post:
+# https://github.com/NoamB/sorcery/wiki/External
+#
+# Requires a user has an associtation with authentications(uid: 42)
+
+require 'rack/alice_in_external/version'
+require 'rack/alice_in_external/webmock_stubs'
+require 'rack/alice_in_external/github_mock'

data/rack-alice_in_external.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/alice_in_external/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-alice_in_external"
+  spec.version       = Rack::AliceInExternal::VERSION
+  spec.authors       = ["Hirofumi Wakasugi"]
+  spec.email         = ["baenej@gmail.com"]
+
+  spec.summary       = %q{Rough and dirty stubbing for authentication via Sorcery external}
+  spec.description   = %q{Rough and dirty stubbing for authentication via Sorcery external (GitHub only for the moment)}
+  spec.homepage      = "https://github.com/5t111111/rack-alice_in_external"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "webmock", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rack-alice_in_external
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hirofumi Wakasugi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Rough and dirty stubbing for authentication via Sorcery external (GitHub
+  only for the moment)
+email:
+- baenej@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/alice_in_external.rb
+- lib/rack/alice_in_external/github_mock.rb
+- lib/rack/alice_in_external/version.rb
+- lib/rack/alice_in_external/webmock_stubs.rb
+- rack-alice_in_external.gemspec
+homepage: https://github.com/5t111111/rack-alice_in_external
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rough and dirty stubbing for authentication via Sorcery external
+test_files: []