contour 0.0.0 → 0.1.1

data/.gitignore

@@ -0,0 +1,7 @@
+# .gitignore lists files and file patterns that are to be ignored by GIT
+
+# Ignore compiled gems
+*.gem
+
+# OS generated files #
+.DS_Store

data/CHANGELOG.rdoc

@@ -1,3 +1,16 @@
+== 0.1.1
+
+* Bug Fix
+  * Apparently add_dependency doesn't currently work without ~> Set Omniauth dependency to increment on bug fix revision
+
+== 0.1.0
+
+* Enhancements
+  * Contour can now be used as a default template for the application layout
+  * Contour provides assets, (images, css, and javascript), to provide an easy authentication system built on top of Devise and Omniauth
+  * Contour provides CSS based on Bluetrip to provide cross-browser compatiblity
+  * Contour rails generator provides fixes to Rack and Omniauth to allow correct reverse proxy (chaining) authentication to machines behind firewalls
+
 == 0.0.0
 
 * Skeleton files to compile gem and make it available on rubygems.org

data/README.rdoc

@@ -0,0 +1,56 @@
+= Contour
+
+Basic Rails framework files and assets for layout and authentication
+
+== Installation
+
+Contour can be installed from rubygems.org using:
+
+  gem install contour
+  
+Or update your Gemfile to include:
+
+  gem 'contour'
+
+== Getting started
+
+Contour depends on a config initializer. The config initializer is used to set various default settings in the layout, and also allows the menu to be created using a ruby hash.  To install a template you can run:
+
+  rails generate contour:install
+
+Contour uses a template to generate your application layout. You can add the following in your application_controller.rb:
+
+  layout "contour/layouts/application"
+  
+Contour also provides a custom jquery-ui and BlueTrip CSS Framework.  To include these, add the following to your application.css manifest:
+
+  *= require contour
+  
+Contour provides custom JavaScript.  In order to make the application layout function properly include the following at the beginning of your application.js:
+
+  //= require contour
+
+In order to get registration working, you can use the modified Contour Authentications controller which overrides the default devise controller of the same name:
+
+  match '/auth/failure' => 'contour/authentications#failure'
+  match '/auth/:provider/callback' => 'contour/authentications#create'
+  match '/auth/:provider' => 'contour/authentications#passthru'
+
+  resources :authentications, :controller => 'contour/authentications'
+
+  devise_for :users, :controllers => {:registrations => 'contour/registrations'}, :path_names => { :sign_up => 'register', :sign_in => 'login' }
+
+== Contributing to contour
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Remo Mueller. See LICENSE for further details.
+

data/app/controllers/contour/authentications_controller.rb

@@ -0,0 +1,60 @@
+class Contour::AuthenticationsController < ApplicationController
+  def index
+    @authentications = current_user.authentications if current_user
+  end
+
+  def passthru
+    render :file => "#{Rails.root}/public/404.html", :status => 404, :layout => false
+  end
+
+  def failure
+    redirect_to new_user_session_path, :alert => params[:message].blank? ? nil : params[:message].humanize
+  end
+
+  def create
+    logger.info "request #{request.env["omniauth.auth"].inspect}"
+    omniauth = request.env["omniauth.auth"]
+    logger.info "omniauth: #{omniauth.inspect}"
+    
+    if omniauth
+    
+      omniauth['uid'] = omniauth['user_info']['email'] if omniauth['provider'] == 'google_apps' and omniauth['user_info']
+      authentication = Authentication.find_by_provider_and_uid(omniauth['provider'], omniauth['uid'])
+      logger.info "OMNI AUTH INFO: #{omniauth.inspect}"
+      omniauth['user_info']['email'] = omniauth['extra']['user_hash']['email'] if omniauth['user_info'] and omniauth['user_info']['email'].blank? and omniauth['extra'] and omniauth['extra']['user_hash']
+      if authentication
+        session["user_return_to"] = request.env["action_dispatch.request.unsigned_session_cookie"]["user_return_to"] if request.env and request.env["action_dispatch.request.unsigned_session_cookie"] and request.env["action_dispatch.request.unsigned_session_cookie"]["user_return_to"] and session["user_return_to"].blank?
+        flash[:notice] = "Signed in successfully." if authentication.user.active_for_authentication?
+        sign_in_and_redirect(:user, authentication.user)
+      elsif current_user
+        current_user.authentications.create!(:provider => omniauth['provider'], :uid => omniauth['uid'])
+        redirect_to authentications_path, :notice => "Authentication successful."
+      else
+        user = User.new(params[:user])
+        user.apply_omniauth(omniauth)
+        if user.save
+          session["user_return_to"] = request.env["action_dispatch.request.unsigned_session_cookie"]["user_return_to"] if request.env and request.env["action_dispatch.request.unsigned_session_cookie"] and request.env["action_dispatch.request.unsigned_session_cookie"]["user_return_to"] and session["user_return_to"].blank?
+          flash[:notice] = "Signed in successfully." if user.active_for_authentication?
+          sign_in_and_redirect(:user, user)
+        else
+          session[:omniauth] = omniauth.except('extra')
+          redirect_to new_user_registration_path
+        end
+      end
+
+    else
+      request.env.keys.each do |key|
+        logger.info "request.env[#{key}]: #{request.env[key]}"
+      end
+      redirect_to authentications_path, :alert => "Authentication not successful."
+    end
+    
+  end
+
+  def destroy
+    @authentication = current_user.authentications.find(params[:id])
+    @authentication.destroy
+    flash[:notice] = "Successfully destroyed authentication."
+    redirect_to authentications_path
+  end
+end

data/app/controllers/contour/registrations_controller.rb

@@ -0,0 +1,16 @@
+class Contour::RegistrationsController < Devise::RegistrationsController
+  def create
+    super
+    session[:omniauth] = nil unless @user.new_record?
+  end
+  
+  private
+  
+  def build_resource(*args)
+    super
+    if session[:omniauth]
+      @user.apply_omniauth(session[:omniauth])
+      @user.valid?
+    end
+  end
+end

data/app/controllers/contour/samples_controller.rb

@@ -0,0 +1,5 @@
+class Contour::SamplesController < ApplicationController
+  def index
+    @title = "Samples Index"
+  end
+end

data/app/controllers/contour/sessions_controller.rb

@@ -0,0 +1,3 @@
+class Contour::SessionsController < Devise::SessionsController
+  
+end

data/app/views/contour/authentications/_index.html.erb

@@ -0,0 +1,25 @@
+<table style="border-collapse:collapse;table-layout:fixed;margin:0px;padding:0px;border-width:0px"><%= ("<col width='64px'/>" * PROVIDERS.size).html_safe %>
+  <tr>
+    <% PROVIDERS.each do |provider| %>
+      <% url_params = (provider == :google_apps) ? '?domain=gmail.com' : '' %>
+      <% if provider == :open_id %>
+        <% provider_name = 'OpenID' %>
+        <% image_name = 'openid' %>
+      <% elsif provider == :linked_in %>
+        <% provider_name = 'LinkedIn' %>
+        <% image_name = 'linkedin' %>
+      <% elsif [:LDAP, :CAS].include?(provider) %>
+        <% provider_name = provider.to_s.upcase %>
+        <% image_name = provider.to_s.downcase %>
+      <% else %>
+        <% provider_name = provider.to_s.titleize %>
+        <% image_name = provider.to_s.downcase %>
+      <% end %>
+      <td style="white-space:nowrap;text-align:center;border-width:0px">
+        <a href="<%= SITE_URL %>/<%= OmniAuth.config.path_prefix.split('/').last.to_s %>/<%= provider.to_s.downcase %><%= url_params %>" class="noicon"><%= image_tag "authbuttons/#{image_name}_64.png", :align => 'absmiddle', :size => "64x64", :alt => provider_name %></a>
+        <br /><br />
+        <%= provider_name %>
+      </td>
+    <% end %>
+  </tr>
+</table>

data/app/views/contour/authentications/_menu.html.erb

@@ -0,0 +1,25 @@
+<% PROVIDERS.each do |provider| %>
+
+  <% url_params = (provider == :google_apps) ? '?domain=gmail.com' : '' %>
+  <% if provider == :open_id %>
+    <% provider_name = 'OpenID' %>
+    <% image_name = 'openid' %>
+  <% elsif provider == :linked_in %>
+    <% provider_name = 'LinkedIn' %>
+    <% image_name = 'linkedin' %>
+  <% elsif [:LDAP, :CAS].include?(provider) %>
+    <% provider_name = provider.to_s.upcase %>
+    <% image_name = provider.to_s.downcase %>
+  <% else %>
+    <% provider_name = provider.to_s.titleize %>
+    <% image_name = provider.to_s.downcase %>
+  <% end %>
+  <div style="float:right;margin-right:15px;width:32px;position:relative">&nbsp;
+      <div style="position:absolute;top:-4px">
+        <a href="<%= SITE_URL %>/<%= OmniAuth.config.path_prefix.split('/').last.to_s %>/<%= provider.to_s.downcase %><%= url_params %>" class="noicon">
+          <%= image_tag "authbuttons/#{image_name}_32.png", :align => 'absmiddle', :size => "28x28", :title => provider_name %>
+        </a>
+      </div>
+  </div>
+
+<% end %>

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

@@ -0,0 +1,27 @@
+<!-- authentications/index.html.erb -->
+<% @title = "Authentications" %>
+
+<h1><%= @title %></h1>
+
+<% if @authentications %>
+  <% unless @authentications.empty? %>
+    <p><strong>You can sign in to this account using:</strong></p>
+    <div class="authentications">
+      <% for authentication in @authentications %>
+        <div class="authentication">
+          <%= image_tag "authbuttons/#{authentication.provider}_32.png", :size => "32x32" %>
+          <div class="provider"><%= authentication.provider.titleize %></div>
+          <div class="uid"><%= authentication.uid %></div>
+          <%= link_to "X", authentication, :confirm => 'Are you sure you want to remove this authentication option?', :method => :delete, :class => "remove" %>
+        </div>
+      <% end %>
+      <div style="clear:both"></div>
+    </div>
+  <% end %>
+  <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 :partial => 'contour/authentications/index' %>

data/app/views/contour/layouts/_menu.html.erb

@@ -0,0 +1,32 @@
+<% display = ['not_signed_in', 'always'] %>
+<% if user_signed_in? -%>
+  <% display = ['signed_in', 'always'] %>
+<% end %>
+
+<% Contour.menu_items.each do |menu_item| %>
+  <% if display.include?(menu_item[:display]) %>
+    <div style="float:<%= menu_item[:position] %>">
+      <%= link_to_function (menu_item[:eval] ? eval(menu_item[:name]) : menu_item[:name]), "$('#menu_#{menu_item[:id]}').show();", :onmouseover => "$('#menu_#{menu_item[:id]}').show();" %>
+      <div style="position:relative;">
+        <div id="menu_<%= menu_item[:id] %>" class="menu_dropdown_<%= menu_item[:position_class] %>" style="display:none">
+          <% menu_item[:links].each do |link| %>
+            <% if link[:html].blank? %>
+              <div style="white-space:nowrap">
+                <%= link_to (link[:eval] ? eval(link[:name]) : link[:name]), eval(link[:path]), :class => 'noicon' %>
+              </div>
+            <% else %>
+              <%= link[:eval] ? eval(link[:html]).html_safe : link[:html].html_safe %>
+            <% end %>
+          <% end %>
+        </div>
+      </div>
+    </div>
+  <% end %>
+<% end %>
+
+<% ids = Contour.menu_items.select{|mi| display.include?(mi[:display])}.collect{|mi| mi[:id]} %>
+<%= javascript_tag "hideOnMouseOut([#{ids.collect{|id| "'#menu_#{id}'"}.join(',')}]);" %>
+
+<%= render :partial => 'contour/authentications/menu' unless user_signed_in? %>
+
+<div style="clear:both"></div>

data/app/views/contour/layouts/_message.html.erb

@@ -0,0 +1,8 @@
+<% unless notice.blank? %>
+  <div id="msg_notice" class="notice" style="display:none"><%= notice %></div>
+  <%= javascript_tag "showMessage(['#msg_notice']);" %>
+<% end %>
+<% unless alert.blank? %>
+  <div id="msg_alert" class="error" style="display:none"><%= alert %></div>
+  <%= javascript_tag "showMessage(['#msg_alert']);" %>
+<% end %>

data/app/views/contour/layouts/application.html.erb

@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= [Contour.application_name, @title].compact.join(' - ').html_safe %></title>
+  <%= favicon_link_tag %>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <%= javascript_tag "var root_url='#{SITE_URL + '/'}';var auth_token='#{form_authenticity_token}';" %>
+  <div id="header" class="container" style="background-image: url(<%= SITE_URL %>/assets/<%= Contour.header_background_image %>);">
+    <div id="version" style="position:relative;display:none">
+      <span style="position:absolute;top:-15px;left:82px;font-size:0.5em;font-variant:normal" class="quiet"><%= Contour.application_version %></span>
+    </div>
+    <%= image_tag(Contour.header_title_image, :alt => '', :style => 'vertical-align:middle') unless Contour.header_title_image.blank? %>
+    <%= link_to DEFAULT_APP_NAME, root_path, :style => 'text-decoration:none;color:#404040;', :onmouseover => "$('#version').show();", :onmouseout => "$('#version').hide();" %>
+  </div>
+
+  <div class="container" style="position:relative">
+    <div id="message">
+      <%= render :partial => 'contour/layouts/message' %>
+    </div>
+  </div>
+
+  <div style="height:29px">
+    <div id="menu" class="container">
+      <%= render :partial => 'contour/layouts/menu' %>
+    </div>
+  </div>
+
+  <div id="content" class="container">
+    <%= yield %>
+  </div>
+  
+  <div id="popup" style="overflow-y: hidden;">
+    <div id="popup_header" style="padding: 12px;">
+      <div style="float:right;margin-right:10px; margin-top:-4px"><%= image_tag(Contour.header_title_image, :alt => '') %></div>
+      <a id="popup_close">x</a>
+      <h1 id="popup_title"></h1>
+    </div>
+    <div id="popup_content"></div>
+  </div>
+  
+  <div id="background_popup"></div>
+</body>
+</html>

data/app/views/contour/registrations/edit.html.erb

@@ -0,0 +1,25 @@
+<h2>Edit <%= resource_name.to_s.humanize %></h2>
+
+<%= form_for(resource, :as => resource_name, :url => registration_path(resource_name), :html => { :method => :put }) do |f| %>
+  <%= devise_error_messages! %>
+
+  <p><%= f.label :email %><br />
+  <%= f.text_field :email %></p>
+
+  <p><%= f.label :password %> <i>(leave blank if you don't want to change it)</i><br />
+  <%= f.password_field :password %></p>
+
+  <p><%= f.label :password_confirmation %><br />
+  <%= f.password_field :password_confirmation %></p>
+
+  <p><%= f.label :current_password %> <i>(we need your current password to confirm your changes)</i><br />
+  <%= f.password_field :current_password %></p>
+
+  <p><%= f.submit "Update" %></p>
+<% end %>
+
+<h3>Cancel my account</h3>
+
+<p>Unhappy? <%= link_to "Cancel my account", registration_path(resource_name), :confirm => "Are you sure?", :method => :delete %>.</p>
+
+<%= link_to "Back", :back %>

data/app/views/contour/registrations/new.html.erb

@@ -0,0 +1,37 @@
+<% @title = 'Sign Up' %>
+<h2><%= @title %></h2>
+
+<%= form_for(resource, :as => resource_name, :url => registration_path(resource_name)) do |f| %>
+  <%= devise_error_messages! %>
+
+  <p><%= f.label :first_name %><br />
+  <%= f.text_field :first_name  %>
+  </p>
+  
+  <p><%= f.label :last_name %><br />
+  <%= f.text_field :last_name  %></p>
+
+  <p><%= f.label :email %><br />
+  <%= f.text_field :email %></p>
+
+<% if @user.password_required? %>
+  <p><%= f.label :password %><br />
+  <%= f.password_field :password %></p>
+
+  <p><%= f.label :password_confirmation %><br />
+  <%= f.password_field :password_confirmation %></p>
+<% end %>
+
+  <p><%= f.submit "Sign up" %></p>
+<% end %>
+
+<%= render :partial => "devise/shared/links" %>
+
+<% if false %>
+<% if @user.password_required? %>
+  <% unless PROVIDERS.blank? %>
+    <h3>Don't want to remember a new login and password? Sign up using one of your existing accounts!</h3>
+    <%= render :partial => 'contour/authentications/index' %>
+  <% end %>
+<% end %>
+<% end %>

data/app/views/contour/samples/index.html.erb

@@ -0,0 +1,27 @@
+<h1>Contour Details</h1>
+
+<p>
+  <b>Contour Version:</b>
+  <%= Contour::VERSION %>
+</p>
+
+<h2>Application Details</h2>
+
+These items can all be specified in:<br />
+<br />
+<code style="margin-left:10px">config/initializers/contour.rb</code><br />
+<br />
+If the file does not exist run:<br />
+<br />
+<code style="margin-left:10px">rails generate contour:install</code><br />
+<br />
+<% ['application_name', 'application_version', 'header_background_image', 'header_title_image'].each do |attribute| %>
+  <p>
+    <b><%= attribute.titleize %>:</b>
+    <% if Contour.send(attribute).blank? %>
+      <span class="quiet">NULL</span>
+    <% else %>
+      <%= Contour.send(attribute) %>
+    <% end %>
+  </p>
+<% end %>

data/app/views/contour/sessions/new.html.erb

@@ -0,0 +1,25 @@
+<% @title = 'Login' %>
+<h2><%= @title %></h2>
+
+<%= form_for(resource, :as => resource_name, :url => session_path(resource_name)) do |f| %>
+  <p><%= f.label :email %><br />
+  <%= f.text_field :email %></p>
+
+  <p><%= f.label :password %><br />
+  <%= f.password_field :password %></p>
+
+  <% if devise_mapping.rememberable? -%>
+    <p><%= f.check_box :remember_me %> <%= f.label :remember_me %></p>
+  <% end -%>
+
+  <p><%= f.submit "Sign in" %></p>
+<% end %>
+
+<%= render :partial => "devise/shared/links" %>
+
+<% if false %>
+<% unless PROVIDERS.blank? %>
+  <h3>Don't want to remember a new login and password? Sign in using one of your existing accounts!</h3>
+  <%= render :partial => 'contour/authentications/index' %>
+<% end %>
+<% end %>