warden-github-rails-thinknear-fork 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmMzZWMzODZlYjE3OTJkNjJjZmY2NTlhMTg3OWM2YzNiZWQ5NzNhZg==
+  data.tar.gz: !binary |-
+    NTk3OTQ2ZWNkZWQ4YzFhZTg3ZDdjZmEwZGMzMTk2MDQzMTIyZWFmMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MWRmMzM2ZTUwNTc0OGI2YWMxODQwMTJhZGQ3MzJlNjUzZWMyYThlNTQ3YTBj
+    MDAxOGJhMTZlN2FiYzY1ZjRhMTE5MWRhZGM0Mzc0ZjQ4NmQyYmZkMjJhMjhh
+    ZDM0MWIzMzNjYjM5OTMxNjI0ODZmZDlkOGU1NDUxY2Q3YTNkYTA=
+  data.tar.gz: !binary |-
+    NmEyYTc0YmE2NjdlNGJiMDE5MjljM2Y2MzU1NjY3YzRiMTFkYzBjNjZkYWRi
+    MzUxNzdlNDgwZGQzOWJkN2JlZTIwNDdmYThkNGMxMjkyMmY5MjQ4ZWZlNDI5
+    MWU2MmEwZThmNGE1ZDBmNGM3OGYxOGYwMDNjMzZjMGJkNTdiZjE=

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,39 @@
+language: ruby
+script: "bundle exec rspec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+env:
+  - "RAILS_VERSION=3.1.0"
+  - "RAILS_VERSION=3.2.0"
+  - "RAILS_VERSION=4.0.0.pre"
+  - "RAILS_VERSION=master"
+matrix:
+  allow_failures:
+    - env: "RAILS_VERSION=master"
+    - rvm: ruby-head
+  exclude:
+    - rvm: 1.8.7
+      env: "RAILS_VERSION=4.0.0.pre"
+    - rvm: 1.9.2
+      env: "RAILS_VERSION=4.0.0.pre"
+    - rvm: jruby-18mode
+      env: "RAILS_VERSION=4.0.0.pre"
+    - rvm: rbx-18mode
+      env: "RAILS_VERSION=4.0.0.pre"
+    - rvm: 1.8.7
+      env: "RAILS_VERSION=master"
+    - rvm: 1.9.2
+      env: "RAILS_VERSION=master"
+    - rvm: jruby-18mode
+      env: "RAILS_VERSION=master"
+    - rvm: rbx-18mode
+      env: "RAILS_VERSION=master"
+

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## v1.1.0
+
+- Upgrade to octokit.rb version 2
+- Require ruby 1.9 or higher
+
+## v1.0.1
+
+- Fully test on Rails 4
+- Improve mock user membership stubbing
+- Add testing instructions to README
+
+## v1.0.0
+
+- Add Devise compatibility
+
+## v0.0.1
+
+- Initial release

data/Gemfile

@@ -0,0 +1,27 @@
+source 'https://rubygems.org'
+
+gemspec
+
+if ENV['EDGE']
+  gem 'warden-github', :github => 'atmos/warden-github'
+end
+
+rails_version = ENV['RAILS_VERSION']
+
+rails_opts = case rails_version
+             when 'master'
+               { :github => 'rails/rails' }
+             when nil
+               {}
+             else
+               "~> #{rails_version}"
+             end
+
+gem "rails", rails_opts
+
+group :development do
+  unless ENV['CI']
+    gem 'debugger',   :platforms => :ruby_19, :require => false
+    gem 'ruby-debug', :platforms => :ruby_18, :require => false
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Philipe Fatio
+
+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,250 @@
+# warden-github-rails
+
+[![Build Status](https://travis-ci.org/fphilipe/warden-github-rails.png)](https://travis-ci.org/fphilipe/warden-github-rails)
+[![Gem Version](https://badge.fury.io/rb/warden-github-rails.png)](http://badge.fury.io/rb/warden-github-rails)
+[![Dependency Status](https://gemnasium.com/fphilipe/warden-github-rails.png)](https://gemnasium.com/fphilipe/warden-github-rails)
+[![Code Climate](https://codeclimate.com/github/fphilipe/warden-github-rails.png)](https://codeclimate.com/github/fphilipe/warden-github-rails)
+
+A gem for rails that provides easy GitHub OAuth integration.
+It is built on top of [warden-github](https://github.com/atmos/warden-github), which gives you an easy to use [warden](https://github.com/hassox/warden) strategy to authenticate GitHub users.
+
+## Motivation
+
+**Wouldn't it be nice to**
+
+- use your organization and its teams for user access control?
+- add a new employee to your GitHub organization or team in order to grant them access to your app's admin area?
+
+The motivation for this gem was to provide a very easy authorization (not authentication) mechanism to existing rails apps for admins, especially in combination with organization and team memberships.
+The provided routing helpers do exactly that.
+They allow you to restrict access to members of your organization or a certain team.
+
+This is how your rails `routes.rb` could look like:
+
+```ruby
+constraints(:subdomain => 'admin') do
+  github_authenticate(:org => 'my_company_inc') do
+    resources :users
+    resources :projects
+
+    github_authenticated(:team => 'sysadmins') do
+      resource :infrastructure
+    end
+  end
+end
+```
+
+Of course, this gem can also be used for user registration and authentication.
+Several helper methods are available in the controller to accomplish this:
+
+```ruby
+class UsersController < ApplicationController
+  # ...
+
+  def new
+    github_authenticate! # Performs OAuth flow when not logged in.
+    @user = User.new(:name => github_user.name, :email => github_user.email)
+  end
+
+  def create
+    attrs = params.require(:user).permit(:name, :email).merge(:github_id => github_user.id)
+    @user = User.create(attrs)
+
+    if @user
+      redirect_to :show
+    else
+      render :new
+    end
+  end
+
+  # ...
+end
+```
+
+## Installation
+
+To use this gem, add it to your `Gemfile`:
+
+```ruby
+gem 'warden-github-rails', '~> 1.0'
+```
+
+If you're using devise, make sure to use version 2.2.4 or newer.
+Previous versions are not compatible with warden-github-rails and thus will not work.
+See the note at [*Using alongside Devise and other Warden Gems*](#using-alongside-devise-and-other-warden-gems) for an explanation.
+
+## Usage
+
+### Configuration
+
+First off, you might want to configure this gem by creating an initializer such as `config/initializers/warden_github_rails.rb`.
+There you can define:
+
+- various scopes and their configs (scopes are types of users with different configs)
+- the default scope (which is `:user` by default)
+- team aliases (GitHub teams are identified by a numerical ID; defining an alias for a team makes it easier to use)
+
+Here's how such a config might look like:
+
+```ruby
+Warden::GitHub::Rails.setup do |config|
+  config.add_scope :user,  :client_id     => 'foo',
+                           :client_secret => 'bar',
+                           :scope         => 'user'
+
+  config.add_scope :admin, :client_id     => 'abc',
+                           :client_secret => 'xyz',
+                           :redirect_uri  => '/admin/login/callback',
+                           :scope         => 'repo'
+
+  config.default_scope = :admin
+
+  config.add_team :marketing, 456
+end
+```
+
+For a list of allowed config parameters to use in `#add_scope`, read the [warden-github documentation](https://github.com/atmos/warden-github#parameters).
+
+### Inside `routes.rb`
+
+The available routing helpers are defined and documented in [lib/warden/github/rails/routes.rb](lib/warden/github/rails/routes.rb).
+They all accept an optional scope that, when omitted, falls back to the default_scope configured in the initializer.
+
+Examples:
+
+```ruby
+# Performs login if not logged in already.
+github_authenticate do
+  resource :profile
+end
+
+# Does not perform login when not logged in.
+github_authenticated do
+  delete '/logout' => 'sessions#delete'
+end
+
+# Only matches when not logged in. Does not perform login.
+github_unauthenticated do
+  resource :registration
+end
+
+# Only matches when member of the organization. Initiates login if not logged in.
+github_authenticate(:org => 'my_company') do
+  resource :admin
+end
+
+# Only matches when member of the team. Does not initiate login if not logged in.
+github_authenticated(:team => 'markting') do
+  get '/dashboard' => 'dashboard#show'
+end
+
+# Using dynamic membership values:
+github_authenticate(:org => lambda { |req| r.params[:id] }) do
+  get '/orgs/:id' => 'orgs#show'
+end
+```
+
+### Inside a Controller
+
+The available controller helpers are defined and documented in [lib/warden/github/rails/controller_helpers.rb](lib/warden/github/rails/controller_helpers.rb).
+They all accept an optional scope that, when omitted, falls back to the default_scope configured in the initializer.
+
+```ruby
+class SomeController < ActionController::Base
+  def show
+    @is_admin = github_authenticated?(:admin)
+  end
+
+  def delete
+    github_logout
+    redirect_to '/'
+  end
+
+  def settings
+    github_authenticate!
+    @settings = UserSettings.find_by_github_user_id(github_user.id)
+  end
+
+  def finish_wizard
+    github_session[:wizard_completed] = true
+  end
+
+  def followers
+    @followers = github_user.api.followers
+  end
+end
+```
+
+### Communicating with the GitHub API
+
+Once a user is logged in, you'll have access to it in the controller using `github_user`. It is an instance of `Warden::GitHub::User` which is defined in the [warden-github](https://github.com/atmos/warden-github/blob/master/lib/warden/github/user.rb) gem. The instance has several methods to access user information such as `#name`, `#id`, `#email`, etc. It also features a method `#api` which returns a preconfigured [Octokit](https://github.com/pengwynn/octokit) client for that user.
+
+### Test Helpers
+
+This gems comes with a couple test helpers to make your life easier:
+
+-   A method is added to `Rack::Response` called `#github_oauth_redirect?` which
+    returns true if the response is a redirect to a url that starts with
+    `https://github.com/login/oauth/authorize`. You can use it in your request
+    tests to make sure the OAuth dance is initiated. In rspec you could verify
+    this as follows:
+
+    ```ruby
+    subject { get '/some-url-that-triggers-oauth' }
+    it { should be_github_oauth_redirect }
+    ```
+
+-   A mock user that allows you to stub team and organization memberships:
+
+    ```ruby
+    user = Warden::GitHub::Rails::TestHelpers::MockUser.new
+    user.stub_membership(team: [234, 987], org: 'some-inc')
+    user.team_member?(234) # => true
+    user.organization_member?('rails') # => false
+    ```
+
+-   A method that creates a mock user and logs it in. If desired, the scope can
+    be specified. The method returns the mock user so that you can manipulate it
+    further:
+
+    ```ruby
+    user = github_login(:admin)
+
+    get '/org/rails/admin'
+    expect(response).to be_not_found
+
+    user.stub_membership(org: 'rails')
+    get '/org/rails/admin'
+    expect(response).to be_ok
+    ```
+
+In order to use the mock user and the `#github_login` method, make sure to
+include `Warden::GitHub::Rails::TestHelpers` in your tests.
+
+## Using alongside Devise and other Warden Gems
+
+Currently this gem does not play nicely with other gems that setup a warden middleware.
+The reason is that warden simply does not have support for multiple middlewares.
+The warden middleware configures a warden instance and adds it to the rack environment.
+Any other warden middleware downstream checks for any existing warden instance in the environment and, if present, skips itself.
+I've opened an [issue](https://github.com/hassox/warden/issues/67) on the warden repository to discuss possible workarounds.
+
+Nevertheless, this gem is compatible with devise for version 2.2.4 and newer.
+devise allows you to specify a block that will be invoked when the warden middleware is configured.
+This functionality is used in this gem in order to setup the github strategy for warden instead of inserting our own middleware.
+
+## Additional Information
+
+### Dependencies
+
+- [warden-github](https://github.com/atmos/warden-github)
+    - [warden](https://github.com/hassox/warden)
+    - [octokit](https://github.com/pengwynn/octokit)
+
+### Maintainers
+
+- Philipe Fatio ([@fphilipe](https://github.com/fphilipe))
+
+### License
+
+MIT License. Copyright 2013 Philipe Fatio

data/Rakefile

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

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/lib/warden/github/rails.rb

@@ -0,0 +1,39 @@
+require 'warden/github'
+
+require 'warden/github/rails/version'
+require 'warden/github/rails/routes'
+require 'warden/github/rails/railtie'
+require 'warden/github/rails/config'
+require 'warden/github/rails/controller_helpers'
+
+require 'forwardable'
+
+module Warden
+  module GitHub
+    module Rails
+      extend SingleForwardable
+
+      def_delegators :config,
+                     :default_scope,
+                     :scopes,
+                     :team_id
+
+      @config = Config.new
+
+      def self.config
+        @config
+      end
+
+      # Use this method to setup this gem.
+      #
+      # @example
+      #
+      #   Warden::GitHub::Rails.setup do |config|
+      #     # ...
+      #   end
+      def self.setup
+        yield config
+      end
+    end
+  end
+end