googleapps-auth 0.0.6 → 0.1.0

data/lib/googleapps_auth.rb

@@ -1,18 +1,21 @@
-require "railtie" if defined?(::Rails::Railtie)
+require "googleapps_auth/railtie" if defined?(Rails::Railtie)
 
 require 'openid'
 require 'openid/store/memory'
 require 'openid/extensions/ax'
 
 module GoogleAppsAuth
-  ID_PREFIX = "https://www.google.com/accounts/o8/site-xrds?hd="
-  XRDS_PREFIX = "https://www.google.com/accounts/o8/user-xrds?uri="
+  ID_PREFIX = "https://www.google.com/accounts/o8/id"
+  DOMAIN_ID_PREFIX = "https://www.google.com/accounts/o8/site-xrds?hd="
+  DOMAIN_XRDS_PREFIX = "https://www.google.com/accounts/o8/user-xrds?uri="
   AX_SCHEMAS = {
     :email => "http://schema.openid.net/contact/email",
     :firstname => "http://axschema.org/namePerson/first",
     :lastname => "http://axschema.org/namePerson/last",
-    :language => "http://axschema.org/pref/language"
+    :language => "http://axschema.org/pref/language",
+    :country => "http://axschema.org/contact/country/home",
   }
+  @@default_domain = nil
 
   def self.certificate_authority_file=(path)
     OpenID.fetcher.ca_file = path
@@ -26,6 +29,14 @@ module GoogleAppsAuth
     OpenID.fetcher.ca_file
   end
 
+  def self.default_domain=(domain)
+    @@default_domain = domain
+  end
+
+  def self.default_domain
+    @@default_domain
+  end
+
   class Result
     attr_reader :error
     def initialize(status, error=nil, attrs=nil)
@@ -54,21 +65,35 @@ module GoogleAppsAuth
   class CertificateAuthorityFileError < StandardError; end
 
   protected
-  def google_apps_authenticate(appname, return_action = 'finish', get_attrs = nil)
+
+  ##
+  # return_to::
+  # return_action::
+  # domain::
+  # attrs:: zero or more of [ :email, :firstname, :lastname, :language ]
+  def google_apps_auth_begin(opts={})
     assert_certificate_authority_file_present!
 
-    get_attrs ||= []
+    opts = {
+      :return_action => 'finish',
+      :return_to => nil,
+      :domain => GoogleAppsAuth.default_domain,
+      :attrs => []
+    }.merge(opts)
+
     begin
-      oidreq = consumer.begin GoogleAppsAuth::ID_PREFIX + appname
-      return_to = url_for :action => return_action, :only_path => false
+      oidreq = consumer.begin opts[:domain] ? GoogleAppsAuth::DOMAIN_ID_PREFIX + opts[:domain] : GoogleAppsAuth::ID_PREFIX
+      return_to = opts[:return_to] || url_for(:action => opts[:return_action], :only_path => false)
       realm = request.protocol + request.host_with_port
       ax = OpenID::AX::FetchRequest.new
-      get_attrs.each { |attr|
+      opts[:attrs].each { |attr|
         ax.add OpenID::AX::AttrInfo.new(GoogleAppsAuth::AX_SCHEMAS[attr], attr.to_s, true)
       }
       oidreq.add_extension(ax)
       redirect_to oidreq.redirect_url(realm, return_to, false)
     rescue OpenID::OpenIDError => e
+      Rails.logger.error "ERROR: #{e.inspect}" if defined?(Rails)
+
       if block_given?
         yield
       else
@@ -78,8 +103,7 @@ module GoogleAppsAuth
     end
   end
 
-
-  def google_apps_handle_auth
+  def google_apps_auth_finish
     assert_certificate_authority_file_present!
 
     current_url = url_for(:action => request.symbolized_path_parameters[:action], :only_path => false)
@@ -112,21 +136,33 @@ module GoogleAppsAuth
   end
 
   def assert_certificate_authority_file_present!
-    if !GoogleAppsAuth.certificate_authority_file? || !File.exists?(GoogleAppsAuth.certificate_authority_file)
+    unless GoogleAppsAuth.certificate_authority_file?
       raise CertificateAuthorityFileError,
         "Configure a CA file through GoogleAppsAuth.certificate_authority_file="
     end
+
+    unless File.exists?(GoogleAppsAuth.certificate_authority_file)
+      raise CertificateAuthorityFileError,
+        "GoogleAppsAuth.certificate_authority_file= is a non-existent file"
+    end
   end
 end
 
 ## TemplateURI's are not followed by the openid gem - so we have to trick it
+## when we're in private domain mode.
 class OpenID::Consumer::IdResHandler
-  def verify_discovery_results
+  original_verify_discovery_results = instance_method(:verify_discovery_results)
+
+  define_method(:verify_discovery_results) do
     oldid = @message.get_arg(OpenID::OPENID_NS, 'identity', nil)
-    @message.set_arg(OpenID::OPENID_NS, 'identity', GoogleAppsAuth::XRDS_PREFIX + oldid)
-    @message.set_arg(OpenID::OPENID_NS, 'claimed_id', GoogleAppsAuth::XRDS_PREFIX + oldid)
-    verify_discovery_results_openid2
-    @message.set_arg(OpenID::OPENID_NS, 'identity', oldid)
-    @message.set_arg(OpenID::OPENID_NS, 'claimed_id', oldid)
+    if oldid =~ /google.com\/accounts/
+      original_verify_discovery_results.bind(self).call
+    else
+      @message.set_arg(OpenID::OPENID_NS, 'identity', GoogleAppsAuth::DOMAIN_XRDS_PREFIX + oldid)
+      @message.set_arg(OpenID::OPENID_NS, 'claimed_id', GoogleAppsAuth::DOMAIN_XRDS_PREFIX + oldid)
+      verify_discovery_results_openid2
+      @message.set_arg(OpenID::OPENID_NS, 'identity', oldid)
+      @message.set_arg(OpenID::OPENID_NS, 'claimed_id', oldid)
+    end
   end
 end

data/lib/googleapps_auth/railtie.rb

@@ -0,0 +1,7 @@
+module GoogleAppsAuth
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      ActionController::Base.send :include, GoogleAppsAuth
+    end
+  end
+end

data/lib/{version.rb → googleapps_auth/version.rb}

@@ -1,3 +1,3 @@
 module GoogleAppsAuth
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/spec/controllers/configuration_spec.rb

@@ -17,6 +17,11 @@ describe GoogleAppsAuth do
       OpenID.fetcher.should_receive(:ca_file=).with(ca_file)
       GoogleAppsAuth.certificate_authority_file = ca_file
     end
+
+    it "should know its value" do
+      GoogleAppsAuth.certificate_authority_file = ca_file
+      GoogleAppsAuth.certificate_authority_file.should eql(ca_file)
+    end
   end
 
   describe "when not setting the certificate_authority_file property" do
@@ -30,6 +35,11 @@ describe GoogleAppsAuth do
       OpenID.fetcher.should_receive(:ca_file=).with(nil)
       GoogleAppsAuth.certificate_authority_file = nil
     end
+
+    it "should know its value is nil" do
+      GoogleAppsAuth.certificate_authority_file = nil
+      GoogleAppsAuth.certificate_authority_file.should be_nil
+    end
   end
 
 end

data/spec/controllers/googleapps_auth_controller_spec.rb

@@ -2,7 +2,11 @@ require File.dirname(__FILE__) + "/../spec_helper"
 
 describe SessionsController, :type => :controller do
 
-  describe "when initiating an auth request" do
+  let :certfile do
+    File.dirname(__FILE__) + "/../cacert.pem"
+  end
+
+  describe "when configuring the plugin" do
 
     describe "and no certfile is configured" do
 
@@ -24,4 +28,40 @@ describe SessionsController, :type => :controller do
 
   end
 
+  describe "in the auth sequence" do
+
+    before :all do
+      GoogleAppsAuth.certificate_authority_file = certfile
+    end
+
+    describe "when beginning" do
+
+      it "should redirect away to google when given the correct google apps domain" do
+        check_id_request = double(:check_id_request, {:add_extension => nil, :redirect_url => "http://google.com/a/example.com"})
+        controller.__send__(:consumer).stub!(:begin).and_return(check_id_request)
+
+        get :start
+        response.should redirect_to("http://google.com/a/example.com")
+      end
+
+    end
+
+    describe "when completing the auth sequence from a correct google apps domain" do
+
+      it "should return a success result when " do
+        status_response = double(:status_response, {:status => OpenID::Consumer::SUCCESS})
+        controller.__send__(:consumer).stub!(:complete).and_return(status_response)
+
+        oid_response = double(:oid_response, {:data => {}})
+        OpenID::AX::FetchResponse.stub!(:from_success_response).and_return(oid_response)
+
+        get :conclude
+
+        response.should be_success
+      end
+
+    end
+
+  end
+
 end

data/spec/resources/sessions_controller.rb

@@ -1,21 +1,18 @@
 class SessionsController < ActionController::Base
   protect_from_forgery
 
-  cattr_accessor :start_result_spy
-  cattr_accessor :conclude_result_spy
-
   def start
-    self.class.start_result_spy = :success
-    google_apps_authenticate "example.com", :conclude, [:email] do
-      self.class.start_result_spy = :failure
+    ## google_apps_auth_begin :return_action => :conclude, :attrs => [:email] do
+    google_apps_auth_begin :domain => "example.com", :return_action => :conclude, :attrs => [:email] do
+      render :status => 500, :text => ""
     end
   end
 
   def conclude
-    if(the_google = google_apps_handle_auth) && the_google.succeeded?
-      self.class.conclude_result_spy = :success
+    if(the_google = google_apps_auth_finish) && the_google.succeeded?
+      render :status => 200, :text => ""
     else
-      self.class.conclude_result_spy = :failure
+      render :status => 500, :text => ""
     end
   end
 end

data/spec/spec_helper.rb

@@ -4,7 +4,9 @@ $LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib
 require "action_controller/railtie"
 
 module GoogleAppsAuth
-  class Application < ::Rails::Application; end
+  class Application < ::Rails::Application
+    config.active_support.deprecation = :log
+  end
 end
 
 GoogleAppsAuth::Application.initialize!

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: googleapps-auth
 version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
+  hash: 27
+  prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 6
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors: 
 - Brian Muller
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-03 00:00:00 -04:00
-default_executable: 
+date: 2012-05-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionpack
@@ -135,9 +134,9 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/googleapps_auth/railtie.rb
+- lib/googleapps_auth/version.rb
 - lib/googleapps_auth.rb
-- lib/railtie.rb
-- lib/version.rb
 - LICENSE
 - Gemfile
 - spec/cacert.pem
@@ -146,7 +145,6 @@ files:
 - spec/controllers/result_spec.rb
 - spec/resources/sessions_controller.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/livingsocial/rails-googleapps-auth
 licenses: []
 
@@ -176,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Google Apps Auth Provider for Rails

data/lib/railtie.rb

@@ -1,9 +0,0 @@
-module GoogleAppsAuth
-  module Rails
-    class Railtie < ::Rails::Railtie
-      config.after_initialize do
-        ActionController::Base.send :include, GoogleAppsAuth
-      end
-    end
-  end
-end