google_oauth_calendar 0.3.0

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 google_oauth_calendar.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ben Johnson
+
+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,72 @@
+# GoogleOauthCalendar
+
+This provides a generator that installs everything you need to be able to authenticate users against
+their Google identity (via oauth2), and then use the google apis to start interacting with their calendars.
+This isn't limited to Google Calendars, but it's a nice starter example to demonstrate their services.
+
+Rather than
+the individual instructions at each in each gem, and stubbing your toe a half dozen times in the process, this is
+a one-stop generator.
+
+Specifically, it
+
+* creates a User model with name & email pulled from Google, and a place to store their access and refresh token
+* initializes omniauth to use the google-oauth2 strategy for signin
+* creates a SessionsController to react to signin/signout
+* installs a basic root controller that has view showing signin/signout links,
+and queries the list of the user's calendars via the google/api_client
+
+This gem allows you to install these features after your app already exists, rather than using an application
+template such as [rails_apps_composer](https://github.com/RailsApps/rails_apps_composer). This way, it makes
+fewer assumptions about your other app preferences.
+
+## Configuring Google API
+
+You need to configure an API instance at Google for your app's use. This becomes the trust link
+between the systems. You can use a regular google identity for this, Google Apps for Business or other
+paid services are not required, assuming you can deal with their usage limits.
+
+1. Go to to the [Google API Console](https://code.google.com/apis/console/), and create a new project.
+(The name doesn't matter, but will probably match your rails project name)
+1. Go to the service tab, and enable **Calendar API**
+1. Go to the **API Access** tab, and create an OAuth 2.0 client ID
+    1. pick a project name
+    1. choose "web application" as the application type
+    1. for "your site or hostname" choose "more options" and use
+
+        http://localhost:3000/auth/google_oauth2/callback
+1. copy the client ID and secret into environment variables, for example
+
+        export GOOGLE_CLIENT_ID = "YOUR_CLIENT_ID"
+        export GOOGLE_CLIENT_SECRET = "YOUR_CLIENT_SECRET"
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'google_oauth_calendar' , :git => 'git@github.com:deafgreatdane/google_oauth_calendar.git'
+
+And then execute:
+
+    $ bundle
+    $ rails generate google_oauth_calendar:install
+    $ rake db:migrate
+    $ rails server
+
+When you click the "signin" link, you'll be redirected to google, asked to confirm your app's use of calendar
+APIs, then it direct back to your home page, signed in, and list your calendars.
+
+At this point, you can remove the gem from your gemfile, since it's only the generator
+
+## Where to go from here
+
+Now you can get to work at adding the real features using your preferred patterns. Some things you'll
+probably end up doing:
+
+* add a UserController for seeing who has connected
+* add "filter authenticate_user!" to your secure controllers
+* learn more about the [calendar or other google apis](http://code.google.com/p/google-api-ruby-client/wiki/SupportedAPIs)
+via the [google-api-client](http://code.google.com/p/google-api-ruby-client/)
+* add more "redirect URLs" to your Google API console, corresponding to your stage & production urls.
+* add error handling for chatting with Google
+
+Feedback and contributions are welcome, just file an issue or create pull request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/google_oauth_calendar.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/google_oauth_calendar/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ben Johnson"]
+  gem.email         = ["deafgreatdane@gmail.com"]
+  gem.description   = %q{a generator for adding google-based users via omniauth, and querying google calendars}
+  gem.summary       = %q{just run rails generate google_oauth_calendar:install }
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "google_oauth_calendar"
+  gem.require_paths = ["lib"]
+  gem.version       = GoogleOauthCalendar::VERSION
+end

data/lib/google_oauth_calendar.rb

@@ -0,0 +1,4 @@
+require "google_oauth_calendar/version"
+
+module GoogleOauthCalendar
+end

data/lib/google_oauth_calendar/version.rb

@@ -0,0 +1,3 @@
+module GoogleOauthCalendar
+  VERSION = "0.3.0"
+end

data/lib/rails/generators/google_oauth_calendar/install/install_generator.rb

@@ -0,0 +1,83 @@
+module GoogleOauthCalendar
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "This generator installs all the snippets for users via google oauth"
+      def self.source_root
+        @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+      end
+
+      def add_files
+        # the gems we're using
+        gem "omniauth", ">= 1.0.3"
+        gem "omniauth-google-oauth2"
+        gem 'google-api-client'
+
+        # wire up the omniauth strategy. This assumes you have environment
+        # variables GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET
+        # such as
+        # export GOOGLE_CLIENT_ID = "YOUR_CLIENT_ID"
+        # export GOOGLE_CLIENT_SECRET = "YOUR_CLIENT_SECRET"
+        template 'omniauth.rb', 'config/initializers/omniauth.rb'
+
+        # this is the controller that connects oauth to user user model
+        template 'sessions_controller.rb', 'app/controllers/sessions_controller.rb'
+        route("match '/auth/:provider/callback' => 'sessions#create'")
+        route("match '/signin' => 'sessions#new', :as => :signin")
+        route("match '/signout' => 'sessions#destroy', :as => :signout")
+        route("match '/auth/failure' => 'sessions#failure'")
+
+        # setup the user info
+        generate("model User provider:string uid:string name:string email:string token:string refresh_token:string token_expires_at:datetime")
+
+        inject_into_class "app/models/user.rb", User, <<-USER_METHODS
+  def self.create_with_omniauth(auth)
+    create! do |user|
+      user.provider = auth['provider']
+      user.uid = auth['uid']
+      if auth['info']
+         user.name = auth['info']['name'] || ""
+         user.email = auth['info']['email'] || ""
+      end
+    end
+  end
+USER_METHODS
+
+
+        inject_into_class "app/controllers/application_controller.rb", ApplicationController ,<<APP_HELPERS
+  helper_method :current_user
+  helper_method :user_signed_in?
+  helper_method :correct_user?
+
+  private
+    def current_user
+      @current_user ||= User.find(session[:user_id]) if session[:user_id]
+    end
+
+    def user_signed_in?
+      return true if current_user
+    end
+
+    def correct_user?
+      @user = User.find(params[:id])
+      unless current_user == @user
+        redirect_to root_url, :alert => "Access denied."
+      end
+    end
+
+    def authenticate_user!
+      if !current_user
+        redirect_to root_url, :alert => 'You need to sign in for access to this page.'
+      end
+    end
+APP_HELPERS
+
+        # setup the home controller
+        template 'home_controller.rb', 'app/controllers/home_controller.rb'
+        copy_file 'index.html.erb', 'app/views/home/index.html.erb'
+        copy_file 'client_builder.rb', 'lib/client_builder.rb'
+        remove_file 'public/index.html'
+        route("root :to => 'home#index'")
+      end
+    end
+  end
+end

data/lib/rails/generators/google_oauth_calendar/install/templates/client_builder.rb

@@ -0,0 +1,29 @@
+require 'google/api_client'
+
+class ClientBuilder
+
+  def self.get_client(user)
+    client = Google::APIClient.new
+    client.authorization.scope = 'https://www.googleapis.com/auth/calendar'
+    client.authorization.access_token = get_current_token(user)
+    client
+  end
+
+  def self.get_current_token(user)
+      if (user.token.nil? || (user.token_expires_at.nil? || user.token_expires_at <Time.now))
+        # fetch new value here.
+        client = OAuth2::Client.new(
+            ENV['GOOGLE_CLIENT_ID'], ENV['GOOGLE_CLIENT_SECRET'],
+                    :site => "https://accounts.google.com",
+                    :token_url => "/o/oauth2/token",
+                    :authorize_url => "/o/oauth2/auth")
+        access_token = OAuth2::AccessToken.from_hash(client,
+            {:refresh_token => user.refresh_token})
+        access_token = access_token.refresh!
+        user.token = access_token.token
+        user.token_expires_at = Time.now + access_token.expires_in
+        user.save
+      end
+      user.token
+  end
+end

data/lib/rails/generators/google_oauth_calendar/install/templates/home_controller.rb

@@ -0,0 +1,14 @@
+class HomeController < ApplicationController
+  require 'google/api_client'
+  require 'client_builder'
+  def index
+    if (user_signed_in? )
+      client = ClientBuilder.get_client(current_user)
+      service = client.discovered_api('calendar', 'v3')
+      result = client.execute(:api_method => service.calendar_list.list)
+
+      @calendars = result.data
+    end
+
+  end
+end

data/lib/rails/generators/google_oauth_calendar/install/templates/index.html.erb

@@ -0,0 +1,15 @@
+<h1>Home</h1>
+
+<p>
+    <%- if user_signed_in? %>
+        Greetings <%= current_user.name %>
+        [<%= link_to "sign out", signout_path %>]
+      <ul>
+        <% @calendars.items.each do |calendar| %>
+            <li><%= calendar["summary"] %></li>
+        <% end %>
+      </ul>
+    <% else %>
+        [<%= link_to "sign in", signin_path %>]
+    <% end %>
+</p>

data/lib/rails/generators/google_oauth_calendar/install/templates/omniauth.rb

@@ -0,0 +1,11 @@
+Rails.application.config.middleware.use OmniAuth::Builder do
+  scopes = [
+      # we need the profile scope in order to login
+      "https://www.googleapis.com/auth/userinfo.profile",
+      # this and other scopes could be added, but match them up with the
+      # features you requested in your API Console
+      "https://www.googleapis.com/auth/calendar"
+    ]
+  provider :google_oauth2, ENV['GOOGLE_CLIENT_ID'], ENV['GOOGLE_CLIENT_SECRET'],
+           {:scope =>scopes.join(" ")}
+end

data/lib/rails/generators/google_oauth_calendar/install/templates/sessions_controller.rb

@@ -0,0 +1,31 @@
+class SessionsController < ApplicationController
+
+  def new
+    redirect_to '/auth/google_oauth2'
+  end
+
+  def create
+    auth = request.env["omniauth.auth"]
+    user = User.where(:provider => auth['provider'],
+                      :uid => auth['uid']).first || User.create_with_omniauth(auth)
+    user.token = auth[:credentials][:token];
+    user.token_expires_at = Time.at(auth[:credentials][:expires_at])
+    user.refresh_token = auth[:credentials][:refresh_token]
+    user.save
+
+    session[:user_id] = user.id
+    redirect_to root_url, :notice => 'Signed in!'
+  end
+
+  def destroy
+    reset_session
+    redirect_to root_url, :notice => 'Signed out!'
+  end
+
+  def failure
+    # if you want to debug something better, this is the object you want
+    #auth = request.env["omniauth.error"]
+    redirect_to root_url, :alert => "Authentication error: #{params[:message].humanize}"
+  end
+
+end

data/lib/rails/generators/google_oauth_calendar/install/templates/user.rb

@@ -0,0 +1,17 @@
+class User < ActiveRecord::Base
+  attr_accessible :email, :name, :provider, :uid
+  attr_accessible :provider, :uid, :name, :email
+
+  def self.create_with_omniauth(auth)
+    create! do |user|
+      user.provider = auth['provider']
+      user.uid = auth['uid']
+      if auth['info']
+         user.name = auth['info']['name'] || ""
+         user.email = auth['info']['email'] || ""
+      end
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: google_oauth_calendar
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Ben Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-26 00:00:00.000000000 Z
+dependencies: []
+description: a generator for adding google-based users via omniauth, and querying
+  google calendars
+email:
+- deafgreatdane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- google_oauth_calendar.gemspec
+- lib/google_oauth_calendar.rb
+- lib/google_oauth_calendar/version.rb
+- lib/rails/generators/google_oauth_calendar/install/install_generator.rb
+- lib/rails/generators/google_oauth_calendar/install/templates/client_builder.rb
+- lib/rails/generators/google_oauth_calendar/install/templates/home_controller.rb
+- lib/rails/generators/google_oauth_calendar/install/templates/index.html.erb
+- lib/rails/generators/google_oauth_calendar/install/templates/omniauth.rb
+- lib/rails/generators/google_oauth_calendar/install/templates/sessions_controller.rb
+- lib/rails/generators/google_oauth_calendar/install/templates/user.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: just run rails generate google_oauth_calendar:install
+test_files: []