warden-googleapps-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00e45fe8577aa2c29df7ddd01ba91f327dbf0385
+  data.tar.gz: 73092eb605ffbb9808f1c28d7271c04e21f2700b
+SHA512:
+  metadata.gz: 538f7956687bd0311e456ac664ff3f6de97ed357850ef9fba7c145603778c8989c9aeeee76b87832f1dbee60c6417cedf4960c9cba1374bec722c66d06365381
+  data.tar.gz: c1c7f9aef664021bae1b874d723722e2e83a25cf08ba6109ebde2799fbe2533c2a9236b46ba6307e3db5a26384978abde59c837c4782000552c10fb90ab201a7

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 warden-googleapps-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Richard Lee
+
+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,91 @@
+# warden-googleapps-rails
+
+A simple Rails integration using Google Apps OAuth.
+
+It's built on [warden-googleapps](https://github.com/atoms/warden-googleapps), and heavily inspired by [warden-github-rails](https://github.com/fphilipe/warden-github-rails).
+
+## Usage
+
+`warden-googleapps-rails` provides both controller-based and router-based authentication methods for Rails apps.
+
+First of all, you need to configure this gem by creating an initializer like `config/initializers/warden_googleapps_rails.rb`, and include:
+
+```ruby
+Warden::GoogleApps::Rails.setup do |config|
+  # Required
+  config.google_apps_domain = "example.org"
+  
+  # Optional
+  # config.google_apps_endpoint = "http://www.google.com/accounts/o8/id" # this is gmail
+  # config.google_apps_redirect_url =  "http://example.org/verify_url" # endpoint where google apps redirects to after successful authentication
+end
+```
+
+### Controller Helpers
+
+There're several authentication methods for controllers.
+
+```ruby
+# Redirect user to Google Apps OAuth if user not log in
+googleapps_authenticate!
+
+# Return whether user has logged in
+googleapps_authenticate? 
+
+# Get user object
+googleapps_user
+
+# Log out
+googleapps_logout
+```
+
+Thus you could write something like:
+
+```ruby
+class PostsController < ApplicationController
+  # Ask user log in for all actions
+  before_filter :googleapps_authenticate! 
+  
+  def new
+  	@user = googleapps_user
+  	# …
+  end
+  # …
+end
+```
+
+### Router Constraints
+
+In your `routes.rb` you could simply wrap your resources:
+
+```ruby
+MyApp::Application.routes.draw do
+  # …
+
+  namespace :admin do do    
+    # Initialize Google Apps authentication flow if user not log in
+    googleapps_authenticate do
+      resources :posts
+    end
+    
+    # Require user log in but will not redirect to OAuth flow
+    googleapps_authenticated do
+      resources :users
+    end
+  # …
+  end
+
+end
+```
+
+## Contact
+
+Richard Lee
+
+- http://github.com/dlackty
+- http://twitter.com/dlackty
+- dlackty@gmail.com
+
+## License
+
+`warden-googleapps-rails` is available under the MIT license. See the `LICENSE.txt` file for more info.

data/Rakefile

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

data/lib/warden-googleapps-rails.rb

@@ -0,0 +1,5 @@
+require "warden-googleapps"
+
+require "warden/googleapps/rails"
+require "warden/googleapps/rails/version"
+

data/lib/warden/googleapps/rails.rb

@@ -0,0 +1,33 @@
+require 'forwardable'
+
+require "warden/googleapps/rails/config"
+require "warden/googleapps/rails/controller_helpers"
+require "warden/googleapps/rails/railtie"
+require "warden/googleapps/rails/routes"
+
+module Warden
+  module GoogleApps
+    module Rails
+      extend SingleForwardable
+
+      def_delegators :config,
+                     :google_apps_domain,
+                     :google_apps_endpoint, 
+                     :google_apps_redirect_url
+
+      @config = Config.new
+
+      def self.google_apps_domain
+        self.config.google_apps_domain
+      end
+
+      def self.config
+        @config
+      end
+
+      def self.setup
+        yield config
+      end
+    end
+  end
+end

data/lib/warden/googleapps/rails/config.rb

@@ -0,0 +1,12 @@
+module Warden
+  module GoogleApps
+    module Rails
+      class Config
+        attr_accessor :google_apps_domain,
+                      :google_apps_endpoint, 
+                      :google_apps_redirect_url
+      end
+    end
+  end
+end
+

data/lib/warden/googleapps/rails/controller_helpers.rb

@@ -0,0 +1,31 @@
+module Warden
+  module GoogleApps
+    module Rails
+      module ControllerHelpers
+        def self.included(klass)
+          klass.helper_method(:googleapps_authenticated?, :googleapps_user)
+        end
+
+        def googleapps_authenticate!
+          request.env['warden'].authenticate!
+        end
+
+        def googleapps_logout
+          request.env['warden'].logout
+        end
+
+        def googleapps_authenticated?
+          request.env['warden'].authenticated?
+        end
+
+        def googleapps_user
+          request.env['warden'].user
+        end
+
+        def googleapps_session
+          request.env['warden'].session if googleapps_authenticated?
+        end
+      end
+    end
+  end
+end

data/lib/warden/googleapps/rails/railtie.rb

@@ -0,0 +1,34 @@
+module Warden
+  module GoogleApps
+    module Rails
+      class Railtie < ::Rails::Railtie
+        initializer 'warden-googleapps-rails.warden' do |app|
+          app.config.middleware.use Warden::Manager do |config|
+            setup_default_strategies(config)
+            setup_failure_app(config)
+          end
+        end
+
+        initializer 'warden-googleapps-rails.helpers' do
+          ActiveSupport.on_load(:action_controller) do
+            include ControllerHelpers
+          end
+        end
+
+        def setup_default_strategies(config)
+          config.default_strategies :google_apps
+          fail StandardError, "No Google Apps domain specified." if Rails.google_apps_domain.nil?
+          config[:google_apps_domain] = Rails.google_apps_domain
+          config[:google_apps_endpoint] = Rails.google_apps_endpoint
+          config[:google_apps_redirect_url] = Rails.google_apps_redirect_url
+        end
+
+        def setup_failure_app(config)
+          config.failure_app = lambda do |env|
+            [403, {}, [env['warden'].message]]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/warden/googleapps/rails/routes.rb

@@ -0,0 +1,38 @@
+module Warden
+  module GoogleApps
+    module Rails
+      module Routes
+        def googleapps_authenticate(&routes_block)
+          googleapps_constraint(routes_block) do |warden|
+            warden.authenticate!
+          end
+        end
+
+        def googleapps_authenticated(&routes_block)
+          googleapps_constraint(routes_block) do |warden|
+            warden.authenticate?
+          end
+        end
+
+        def googleapps_unauthenticated(&routes_block)
+          googleapps_constraint(routes_block) do |warden|
+            not warden.authenticated?
+          end
+        end
+
+        private
+
+        def googleapps_constraint(routes_block, &block)
+          constraint = lambda do |request|
+            warden = request.env['warden']
+            block.call(warden)
+          end
+
+          constraints(constraint, &routes_block)
+        end
+      end
+    end
+  end
+end
+
+ActionDispatch::Routing::Mapper.send(:include, Warden::GoogleApps::Rails::Routes)

data/lib/warden/googleapps/rails/version.rb

@@ -0,0 +1,7 @@
+module Warden
+  module GoogleApps
+    module Rails
+      VERSION = "0.1.0"
+    end
+  end
+end

data/warden-googleapps-rails.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'warden/googleapps/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "warden-googleapps-rails"
+  spec.version       = Warden::GoogleApps::Rails::VERSION
+  spec.authors       = ["Richard Lee"]
+  spec.email         = ["dlackty@gmail.com"]
+  spec.summary       = %q{Simple integration for Rails to use Google Apps authentication.}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/dlackty/warden-googleapps-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'rspec', '~> 2.12'
+
+  spec.add_dependency 'warden-googleapps', '~> 0.1.4'
+  spec.add_dependency 'railties', '>= 3.1'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: warden-googleapps-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: warden-googleapps
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Simple integration for Rails to use Google Apps authentication.
+email:
+- dlackty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/warden-googleapps-rails.rb
+- lib/warden/googleapps/rails.rb
+- lib/warden/googleapps/rails/config.rb
+- lib/warden/googleapps/rails/controller_helpers.rb
+- lib/warden/googleapps/rails/railtie.rb
+- lib/warden/googleapps/rails/routes.rb
+- lib/warden/googleapps/rails/version.rb
+- warden-googleapps-rails.gemspec
+homepage: https://github.com/dlackty/warden-googleapps-rails
+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: Simple integration for Rails to use Google Apps authentication.
+test_files: []