google_authentication 0.1.0

data/lib/generators/google_authentication/google_authentication_generator.rb

@@ -0,0 +1,46 @@
+require 'rails/generators/active_record'
+require 'generators/devise/orm_helpers'
+
+module GoogleAuthentication
+  module Generators # :nodoc:
+    class GoogleAuthenticationGenerator < ActiveRecord::Generators::Base # :nodoc:
+      namespace "google_authentication"
+      source_root File.expand_path("../../templates", __FILE__)
+
+      # include some helpers from devise
+      include Devise::Generators::OrmHelpers
+
+      # accept same arguments as devise generator with google tuned defaults
+      argument :attributes, :type => :array, :default => ['first_name:string', 'last_name:string'], :banner => "field:type field:type"
+
+      desc "Generates a model with the given NAME with google_authentication " <<
+           "configuration plus a migration file which create it."
+
+      # Generate the model without a migration file using the active_record generator
+      def generate_model
+        invoke "active_record:model", [name], :migration => false unless model_exists? && behavior == :invoke
+      end
+
+      # Build the migration files for the given model
+      def copy_devise_migration
+        migration_template "migration.rb", "db/migrate/devise_create_#{table_name}"
+      end
+
+      # Insert gem activation code into the selected class
+      def inject_google_authentication_content
+        inject_into_class(model_path, class_name) do
+          return nil unless model_exists?
+          "  # You can add other devise modules here as arguments, as in devise calls. :omniauthable module is always added\n" <<
+          "  # and forbidden devise modules are automatically removed (see GoogleAuthentication::ActsAsGoogleUser::FORBIDDEN_MODULES)\n" <<
+          "  # if you change this line, remember to edit the generated migration\n" <<
+          "  acts_as_google_user\n"
+        end
+      end
+
+      # Show a readme file with further instructions after installation
+      def show_readme
+        readme "MODEL.warning" if behavior == :invoke && class_name != 'User'
+      end
+    end
+  end
+end

data/lib/generators/google_authentication/install_generator.rb

@@ -0,0 +1,27 @@
+
+module GoogleAuthentication
+  module Generators # :nodoc:
+    class InstallGenerator < Rails::Generators::Base # :nodoc:
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Create an initializer for GoogleAuthentication gem and install devise (replace devise:install)"
+
+      class_option :domain, :desc => 'Google(Apps) domain used for authentication', :default => 'gmail.com', :type => :string
+
+      # Copy the initializer template in the config/initializer directory
+      def copy_initializer
+        template "google_authentication.rb", "config/initializers/google_authentication.rb"
+      end
+
+      # Run devise:install generator
+      def install_devise
+        invoke "devise:install"
+      end
+
+      # Show the readme file with further instructions after installation
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/MODEL.warning

@@ -0,0 +1,10 @@
+
+===============================================================================
+
+*** ATTENTION!!! You have specified a model different than User ***
+
+  You should edit the google_authentication initializer to change the following
+
+    config.model_name = :your-model-name
+
+===============================================================================

data/lib/generators/templates/README

@@ -0,0 +1,11 @@
+
+What to do next?
+
+  1. Edit initializer (config/initializer/google_authentication.rb) and fill:
+     - your desired domain for authentication (default gmail.com)
+     - your model used as google user
+
+  2.a Run rails g google_authentication MODEL in order to create a default model
+  2.b (or) add acts_as_google_user to the model used for authentication
+
+===============================================================================

data/lib/generators/templates/google_authentication.rb

@@ -0,0 +1,14 @@
+# Use this hook to configure GoogleAuthentication, values in the comments are defaults
+GoogleAuthentication.setup do |config|
+
+  # ==> Domain configuration
+  # Configure here the domain used for the authentication
+  config.domain = '<%= options[:domain] %>'
+
+  # ==> Model configuration
+  # Configure here the model name, it should be the model you've generated
+  # using the provided generator. Don't change after first generation
+  # unless you know what you're doing
+  # config.model_name = :user
+
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,27 @@
+class DeviseCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    create_table(:<%= table_name %>) do |t|
+      t.string :email, :null => :false
+      t.string :omniauth_uid, :null => false
+
+      # t.rememberable
+      # t.trackable
+      # t.confirmable
+      # t.token_authenticatable
+
+<% for attribute in attributes -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      t.timestamps
+    end
+
+    add_index :<%= table_name %>, :email,                :unique => true
+    add_index :<%= table_name %>, :omniauth_uid,         :unique => true
+    # add_index :<%= table_name %>, :authentication_token, :unique => true
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/lib/google_authentication.rb

@@ -0,0 +1,43 @@
+require 'google_authentication/acts_as_google_user'
+
+# Main module for the gem
+module GoogleAuthentication
+
+  # domain configuration
+  mattr_accessor :domain
+  # default value for google domain used for authentication
+  @@domain = "gmail.com"
+
+  # model name configuration
+  mattr_accessor :model_name
+  # default model used (singular name)
+  @@model_name = :user
+
+  # Allows config in initializer
+  # @yield [self] Allows config in initializer using the same syntax as Devise
+  # @yieldparam [GoogleAuthentication] config the module itself
+  # @example Changing the authentication setup
+  #   GoogleAuthentication.setup do |config|
+  #     config.domain = 'your-google-apps-domain.com'
+  #     config.model_name = :account
+  #   end
+  def self.setup
+    yield self
+  end
+
+  # Used in the routes file to decide wheter to add routes
+  # to the application
+  # @return [bool] true iff the GoogleAuthentication model is already defined
+  def self.define_routes?
+    Object.const_defined?(model_name.to_s.camelize)
+  end
+
+  # Return a symbol which is used to build devise routes
+  # @return [Symbol] a symbol representing the table name used by devise
+  def self.devise_table
+    model_name.to_s.pluralize.to_sym
+  end
+
+  # require the engine if rails is defined
+  require 'google_authentication/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+end

data/lib/google_authentication/acts_as_google_user.rb

@@ -0,0 +1,77 @@
+module GoogleAuthentication
+
+  # enclose AR methods used to give a model the ability to authenticate as a Google User
+  # using devise + omniauth combo
+  module ActsAsGoogleUser
+
+    # Devise module to include in included classes
+    mattr_accessor :devise_modules_to_include
+    # default devise modules
+    @@devise_modules_to_include = [:omniauthable]
+
+    # Devise forbidden modules, useless in this context
+    FORBIDDEN_MODULES = [:database_authenticable, :recoverable, :registrable, :encryptable, :lockable, :validatable, :confirmable]
+
+    # Devise allowed modules
+    ALLOWED_MODULES = [:omniauthable, :token_authenticable, :trackable, :timeoutable, :rememberable]
+
+    # Configure a model to be used with devise and google authentication
+    # @param [Array] modules a list of symbols used with a devise call
+    def acts_as_google_user *modules
+      # assign devise modules to module variable
+      if modules.empty?
+        self.devise_modules_to_include = [:omniauthable]
+      else
+        # restrict modules given to devise
+        self.devise_modules_to_include = (modules + [:omniauthable] - FORBIDDEN_MODULES) & ALLOWED_MODULES
+      end
+      # include model methods
+      include ActsAsGoogleUser::Model
+    end
+
+    # Models method added to an AR class which calls acts_as_google_user
+    module Model
+
+      extend ActiveSupport::Concern
+
+      # send devise methods and attr_accessible to the base class
+      included do
+        # include devise modules
+        devise *(ActsAsGoogleUser.devise_modules_to_include)
+        # Setup accessible (or protected) attributes for your model
+        attr_accessible :email
+      end
+
+      module ClassMethods # :nodoc:
+        # Find omniauth given user or create it
+        # @param [Hash] omniauth_data omniauth returned hash
+        def find_or_create_by_omniauth_impl omniauth_data
+          # use custom implementation if given by the user
+          respond_to?(:find_or_create_by_omniauth) ?
+              send(:find_or_create_by_omniauth, omniauth_data) :
+              find_or_create_by_omniauth_default_impl(omniauth_data)
+        end
+
+        private
+
+        # default implementation of find_or_create_by_omniauth_uid
+        # find the user with the given omniauth_uid or create it
+        # assign all properties found in user_info hash to instance
+        # and return it
+        # @param [Hash] omniauth_data omniauth returned hash
+        # @return [ActiveRecord::Base] an instance of the base class
+        def find_or_create_by_omniauth_default_impl omniauth_data
+          find_or_initialize_by_omniauth_uid(omniauth_data['uid']).tap do |user|
+            omniauth_data['user_info'].each do |k, v|
+              user.send "#{k}=", v if user.respond_to? "#{k}="
+            end
+            user.save!
+          end
+        end
+      end
+    end
+  end
+end
+
+# make AR extend the module ActsAsGoogleUser
+ActiveRecord::Base.send :extend, GoogleAuthentication::ActsAsGoogleUser

data/lib/google_authentication/engine.rb

@@ -0,0 +1,19 @@
+require 'google_authentication'
+
+require 'rails'
+require 'action_controller'
+
+require 'omniauth'
+require 'devise'
+
+module GoogleAuthentication
+  # rails engine to add controllers, routes and configuration needed to the gem
+  class Engine < Rails::Engine
+
+    # Initialize devise configuration for omniauth
+    initializer "google_authentication.domain", :before => "devise.omniauth" do
+      require 'openid/store/filesystem'
+      Devise.omniauth :google_apps, OpenID::Store::Filesystem.new('/tmp'), :domain => GoogleAuthentication.domain
+    end
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/controllers/posts_controller.rb

@@ -0,0 +1,83 @@
+class PostsController < ApplicationController
+  # GET /posts
+  # GET /posts.xml
+  def index
+    @posts = Post.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @posts }
+    end
+  end
+
+  # GET /posts/1
+  # GET /posts/1.xml
+  def show
+    @post = Post.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @post }
+    end
+  end
+
+  # GET /posts/new
+  # GET /posts/new.xml
+  def new
+    @post = Post.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @post }
+    end
+  end
+
+  # GET /posts/1/edit
+  def edit
+    @post = Post.find(params[:id])
+  end
+
+  # POST /posts
+  # POST /posts.xml
+  def create
+    @post = Post.new(params[:post])
+
+    respond_to do |format|
+      if @post.save
+        format.html { redirect_to(@post, :notice => 'Post was successfully created.') }
+        format.xml  { render :xml => @post, :status => :created, :location => @post }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @post.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /posts/1
+  # PUT /posts/1.xml
+  def update
+    @post = Post.find(params[:id])
+
+    respond_to do |format|
+      if @post.update_attributes(params[:post])
+        format.html { redirect_to(@post, :notice => 'Post was successfully updated.') }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @post.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /posts/1
+  # DELETE /posts/1.xml
+  def destroy
+    @post = Post.find(params[:id])
+    @post.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(posts_url) }
+      format.xml  { head :ok }
+    end
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/helpers/posts_helper.rb

@@ -0,0 +1,2 @@
+module PostsHelper
+end

data/spec/dummy/app/models/post.rb

@@ -0,0 +1,2 @@
+class Post < ActiveRecord::Base
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+  # provides finder methods for retrieving users by the given omniauth
+  acts_as_google_user
+
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<% if current_user %>
+    <p>Currently logged in as <strong><%= current_user.email %></strong></p>
+<% else %>
+    <p>You're not logged in, <%= link_to 'Login', user_omniauth_authorize_path(:google_apps) %></p>
+<% end %>
+
+<p class="notice"><%= notice %></p>
+<p class="alert"><%= alert %></p>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/posts/_form.html.erb

@@ -0,0 +1,25 @@
+<%= form_for(@post) do |f| %>
+  <% if @post.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@post.errors.count, "error") %> prohibited this post from being saved:</h2>
+
+      <ul>
+      <% @post.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :title %><br />
+    <%= f.text_field :title %>
+  </div>
+  <div class="field">
+    <%= f.label :content %><br />
+    <%= f.text_area :content %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>