muck-auth 3.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2010 Tatemae.com
+
+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.rdoc

@@ -0,0 +1,5 @@
+= muck-auth
+This gem wraps the omniauth gem to make it simple to authenticate with multiple services.
+
+
+Copyright (c) 2009-2010 Tatemae.com. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,72 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["--color", "-c", "-f progress", "-r test/spec/spec_helper.rb"]
+  t.pattern = 'test/spec/**/*_spec.rb'  
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "muck-auth"
+    gem.summary = %Q{OAuth for muck}
+    gem.description = %Q{A simple wrapper for the omniauth gem so that it is faster to include oauth in muck based applications.}
+    gem.email = "justin@tatemae.com"
+    gem.homepage = "http://github.com/tatemae/muck-auth"
+    gem.authors = ["Justin Ball"]
+    gem.add_dependency "omniauth"
+    gem.add_dependency "overlord"
+    gem.add_dependency "muck-engine"
+    gem.add_dependency "muck-users"
+    gem.add_development_dependency "babelphish"
+    gem.files.exclude 'test/**'
+    gem.test_files.exclude 'test/**' # exclude test directory
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    #t.libs << 'lib'
+    t.libs << 'test/lib'
+    t.pattern = 'test/test/**/*_spec.rb'
+    t.verbose = true
+    t.output_dir = 'coverage'
+    t.rcov_opts << '--exclude "gems/*"'
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+require 'rake/rdoctask'
+desc 'Generate documentation for the muck-auth gem.'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "muck_auth #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Translate this gem'
+task :translate do
+  file = File.join(File.dirname(__FILE__), 'config', 'locales', 'en.yml')
+  system("babelphish -o -y #{file}")
+end

data/VERSION

@@ -0,0 +1 @@
+3.1.0

data/app/controllers/muck/authentications_controller.rb

@@ -0,0 +1,55 @@
+class Muck::AuthenticationsController < ApplicationController
+  def index
+    @current_authentications = current_user.authentications if current_user
+    if @current_authentications
+      @unused_authentications = Authentication.unused_services(@current_authentications)
+    else
+      @unused_authentications = Authentication.all_services 
+    end
+    respond_to do |format|
+      format.html { render :template => 'authentications/index' }
+    end
+  end
+  
+  def create
+    @omniauth = request.env["omniauth.auth"]
+    # Associated the account with the user
+    if current_user
+      current_user.authentications.create!(:provider => @omniauth['provider'], :uid => @omniauth['uid'], :raw_auth => @omniauth.to_json)
+      flash[:notice] = t('muck.auth.authentication_success')
+      redirect_to authentications_url
+    # Try to log the user in via the service
+    elsif authentication = Authentication.find_by_provider_and_uid(@omniauth['provider'], @omniauth['uid'])
+      flash[:notice] = t('muck.users.login_success')
+      UserSession.create(authentication.user)
+    # Could not find any information. Create a new account.
+    else
+      @user = User.new
+      @user.apply_omniauth(@omniauth)
+      @user.generate_password
+      if @user.save
+        UserSession.create(@user)
+        flash[:notice] = t('muck.users.thanks_sign_up')
+        signup_complete_path(@user)
+      else
+        # Have to build a new user to get rid of the password
+        @user = User.new
+        @user.apply_omniauth(@omniauth)
+        render :template => 'authentications/signup'
+      end
+    end
+  end
+  
+  def failure
+    respond_to do |format|
+      format.html { render :template => 'authentications/failure' }
+    end
+  end
+  
+  def destroy
+    @authentication = current_user.authentications.find(params[:id])
+    @authentication.destroy
+    flash[:notice] = t('muck.auth.removed_authentication')
+    redirect_to authentications_url
+  end
+end

data/app/helpers/muck_auth_helper.rb

@@ -0,0 +1,10 @@
+module MuckAuthHelper
+  
+  # add code to help generate links like this:
+  # /auth/twitter
+  
+  def auth_service_name(service)
+    service.titleize
+  end
+  
+end

data/app/views/authentications/_available_services.html.erb

@@ -0,0 +1,12 @@
+<div id="auth_available_services" class="auth-services">
+  <% unless authentications.empty? %>
+    <h3><%=translate('muck.auth.you_can_connect_to_the_following_services') %></h3>
+    <ul <%='class="icon-list"' if include_icons%>>
+      <% authentications.each do |authentication| -%>
+        <li class="<%=authentication.to_s.parameterize%> auth_service service-link" <%= service_icon_background(authentication) if include_icons%> title="<%=translate('muck.auth.connect_to_account_title', :service => authentication.to_s.humanize) %>">
+          <%= link_to auth_service_name(authentication), "/auth/#{authentication}" %>
+        </li>
+      <% end -%>
+    </ul>
+  <% end %>
+</div>

data/app/views/authentications/_current_services.html.erb

@@ -0,0 +1,15 @@
+<div id="auth_current_services" class="auth-services">
+  <% if authentications.empty? -%>
+    <p><%=translate('muck.oauth.you_are_currently_not_connected_to_any_external_services') %></p>
+  <% else -%>
+    <p><%=translate('muck.oauth.you_are_connected_to_the_following_services') %></p>
+    <ul <%='class="icon-list"' if include_icons%>>
+      <% authentications.each do |authentication| -%>
+        <li class="<%=token.class.service_name.to_s.parameterize%> oauth_service service-link" <%= service_icon_background(token.class.service_name) if include_icons %>>
+          <%= link_to auth_service_name(authentication.provider), oauth_consumer_path(token.class.service_name), :class => 'authfancybox' %>
+          <%= link_to "X", authentication, :confirm => 'Are you sure you want to remove this authentication option?', :method => :delete, :class => "remove" %>
+        </li>
+      <% end -%>
+    </ul>
+  <% end -%>
+</div>

data/app/views/authentications/failure.html.erb

@@ -0,0 +1 @@
+<%=translate('muck.auth.auth_connect_error') %>

data/app/views/authentications/index.html.erb

@@ -0,0 +1,8 @@
+<h1><%=translate('muck.auth.services') %></h1>
+<% if @authentications %>
+  <%= render 'authentications/current_services', :authentications => @current_authentications %>
+  <p><strong>Add another service to sign in with:</strong></p>
+<% else %>
+  <p><strong>Sign in through one of these services:</strong></p>
+<% end %>
+<%= render 'authentications/available_services', :authentications => @unused_authentications, :include_icons => true %>

data/app/views/authentications/signup.html.erb

@@ -0,0 +1,41 @@
+<%= muck_form_for @user, :url => users_path, :html => {:id => "register-user-form", :name => 'register-user-form'} do |f| -%>
+
+	<%= t('muck.auth.sign_up_prompt') %>
+	
+	<% if MuckUsers.configuration.require_access_code -%>
+    <%= f.text_field :access_code_code, { :label => translate('muck.users.access_code'), 
+                                          :extra_html => translate('muck.users.access_code_help', 
+                                            :access_request_anchor => %Q{<a class="fancy-pop iframe" href="#{new_access_code_request_path}">},
+                                            :access_request_anchor_end => "</a>").html_safe } -%>
+  <% end -%>
+  
+	<%= f.text_field :login, { :label => t('muck.users.choose_member_name'), 
+	                           :extra_html => '', 
+	                           :tip => t('muck.users.username_help'),
+	                           :required_label => t('muck.users.username') } -%>
+	<%= f.text_field :email, { :label => t('muck.users.email_address'),
+	                           :tip => t('muck.users.email_help'),
+	                           :extra_html => '' } -%>
+	<%= f.password_field :password, { :label => t('muck.users.password'),
+	                                  :tip => t('muck.users.password_help')} -%>
+	<%= f.password_field :password_confirmation, { :label => t('muck.users.confirm_password'),
+                                                 :tip => t('muck.users.password_confirmation_help') } -%>
+	
+	<% if MuckUsers.configuration.validate_terms_of_service -%>
+    <div class="checklist">
+      <%= f.check_box :terms_of_service, { :label => t('muck.users.terms_and_service', :tos_link_anchor => '<a href="/terms_of_service">', :link_end => '</a>').html_safe,
+     																		   :tip => t('muck.users.terms_and_service_tip') } -%>
+    </div>
+  <% end -%>
+	
+	<%= f.fields_for :authentications do |af| -%>
+    <%= af.hidden_field :provider %>
+    <%= af.hidden_field :uid %>
+    <%= af.hidden_field :raw_auth %>
+  <% end %>
+	
+	<div class="button form-row">
+  	<%= f.submit t('muck.users.sign_up_now') %>
+  </div>
+  
+<% end -%>

data/config/locales/en.yml

@@ -0,0 +1,57 @@
+--- 
+en: 
+  muck: 
+    auth:
+      problem_creating_account: "There was a problem creating your account."
+      removed_authentication: Successfully removed authentication.
+      authentication_success: Authentication successful.
+      you_can_connect_to_the_following_services: "You can connect to the following services:"
+      auth_connect_error: An error occurred while trying to connect to the service.
+      sign_up_prompt: In order to continue please provide the information below.
+      back: Back
+      do_you_have_an_application_to_register: Do you have an application you would like to register for use with us using the %{link} standard?
+      support_url_label: Support URL
+      updated_successfully: Updated the client information successfully
+      reconnect: Reconnect
+      you_are_currently_not_connected_to_any_external_services: You are currently not connected to any external services.
+      edit: Edit
+      are_you_sure: Are you sure?
+      delete: Delete
+      issued: Issued
+      main_application_label: Main Application URL*
+      destroyed_successfully: Destroyed the client application registration
+      connect_to_account_title: Connect to your %{service} account
+      or: or
+      register_a_new_application: Register a new application
+      register: Register
+      register_your_application: Register your application
+      application_developers: Application Developers
+      name_label: Name*
+      request_allowed: You have allowed this request
+      authorize_access_question: Would you like to authorize %{name}} (%{link}) to access your account?
+      you_are_already_connected_to: You are already Connected to %{service}
+      request_token_url: Request Token URL
+      application: Application
+      back_label: Back
+      callback_label: Callback URL*
+      authorize_access_label: authorize access
+      registered_successfully: Registered the information successfully
+      wrong_id: Wrong application id
+      you_are_connected_to_the_following_services: "You are connected to the following services:"
+      authorize_url: Authorize URL
+      access_token_url: Access Token URL
+      tokens_issued: The following tokens have been issued to applications in your name
+      services: Services
+      revoke: Revoke!
+      authorize_access: Authorize access to your account
+      you_have_the_following_client_applications_registered: "You have the following client applications registered:"
+      you_must_register_your_web_application: You must register your web application before it can make OAuth requests to this service
+      show_label: Show
+      edit_label: Edit
+      edit_application: Edit your application
+      disconnect_or_reconnect: "%{disconnect}} or %{reconnect} if you experienced a problem."
+      disconnect: Disconnect
+      we_support_hmac_sha: We support hmac-sha1 (recommended) as well as plain text in ssl mode.
+      consume_secret: "Consumer Secret:"
+      request_disallowed: You have disallowed this request
+      http_result_error: "There was a problem with your request %{error}"

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  resources :authentications, :controller => 'muck/authentications'
+  match '/auth/:provider/callback' => 'muck/authentications#create', :controller => 'muck/authentications'
+  match '/auth/failure' => 'muck/authentications#failure', :controller => 'muck/authentications'
+end

data/lib/muck-auth.rb

@@ -0,0 +1,6 @@
+require 'openid/store/filesystem'
+require 'muck-auth/exceptions'
+require 'muck-auth/config'
+require 'muck-auth/models/user'
+require 'muck-auth/models/authentication'
+require 'muck-auth/engine'

data/lib/muck-auth/config.rb

@@ -0,0 +1,22 @@
+module MuckAuth
+  
+  def self.configuration
+    # In case the user doesn't setup a configure block we can always return default settings:
+    @configuration ||= Configuration.new
+  end
+  
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    
+    attr_accessor :auth_credentials
+    
+    def initialize
+      self.auth_credentials = {}
+    end
+    
+  end
+end

data/lib/muck-auth/engine.rb

@@ -0,0 +1,34 @@
+require 'rails'
+require 'omniauth/oauth'
+require 'muck-auth'
+
+module MuckProfiles
+  class Engine < ::Rails::Engine
+    
+    def muck_name
+      'muck-auth'
+    end
+    
+    initializer 'muck_auth.helpers' do |app|
+      ActiveSupport.on_load(:action_view) do
+        include MuckAuthHelper
+      end
+    end
+    
+    initializer 'muck_auth.i18n' do |app|
+      ActiveSupport.on_load(:i18n) do
+        I18n.load_path += Dir[ File.join(File.dirname(__FILE__), '..', '..', 'config', 'locales', '*.{rb,yml}') ]
+      end
+    end
+
+    initializer "muck_auth.add_middleware" do |app|
+      raise MuckAuth::Exceptions::InvalidConfiguration, "Please provide a valid configuration for Muck Auth." if MuckAuth.configuration.auth_credentials.blank?
+      MuckAuth.configuration.auth_credentials.each_key do |key|
+        app.middleware.use OmniAuth::Builder do
+          provider key, MuckAuth.configuration.auth_credentials[key]['key'], MuckAuth.configuration.auth_credentials[key]['secret']
+        end  
+      end
+    end
+       
+  end
+end

data/lib/muck-auth/exceptions.rb

@@ -0,0 +1,5 @@
+module MuckAuth
+  module Exceptions
+    class InvalidConfiguration < StandardError; end
+  end
+end

data/lib/muck-auth/models/authentication.rb

@@ -0,0 +1,25 @@
+# include MuckAuth::Models::MuckAuthentication
+module MuckAuth
+  module Models
+    module MuckAuthentication
+      extend ActiveSupport::Concern
+    
+      included do
+        belongs_to :user
+      end
+      
+      module ClassMethods
+        def all_services
+          services = []
+          MuckAuth.configuration.auth_credentials.each_key{ |s| services << s }
+          services
+        end
+        def unused_services(current_authentications)
+          all_services.find_all{ |s| !current_authentications.any?{ |c| c.provider == s } }
+        end
+      end
+    
+    end 
+  end
+end
+

data/lib/muck-auth/models/user.rb

@@ -0,0 +1,23 @@
+# include MuckAuth::Models::MuckUser
+module MuckAuth
+  module Models
+    module MuckUser
+      extend ActiveSupport::Concern
+    
+      included do
+        has_many :authentications
+        accepts_nested_attributes_for :authentications, :allow_destroy => true
+      end
+      
+      def apply_omniauth(omniauth)
+        self.email = omniauth['user_info']['email'] if email.blank?
+        authentications.build(:provider => omniauth['provider'], :uid => omniauth['uid'], :raw_auth => omniauth.to_json)
+      end
+      
+      def password_required?
+        (authentications.empty? || !password.blank?) && super
+      end
+      
+    end 
+  end
+end