opensesame 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,3 @@
+= OpenSesame
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,36 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OpenSesame'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  # t.pattern = "./spec/**/*_spec.rb" # default
+  # Put spec opts in a file named .rspec in root
+end
+
+desc "Run the specs"
+task :default => ["spec"]

data/app/assets/javascripts/open_sesame/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/open_sesame/application.css

@@ -0,0 +1,14 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require ./opensesame_bootstrap
+ *= require ./welcome
+*/

data/app/assets/stylesheets/open_sesame/opensesame_bootstrap.css.scss

@@ -0,0 +1,8 @@
+@import "bootstrap";
+
+.content-header {
+  border-bottom: 1px solid #ccc;
+  margin-bottom: 1em;
+
+  h1 { font-size: 24px; }
+}

data/app/assets/stylesheets/open_sesame/welcome.css.scss

@@ -0,0 +1,52 @@
+body { font: 14px/1.333 sans-serif; color: #444; background: #eee; }
+
+a { color: #980905; }
+a:hover, a:focus, a:active { text-decoration: none; }
+
+h1 { margin: 0 0 0.2em; font-size: 36px; }
+h2 { margin: 0 0 0.75em; font-size: 21px; }
+h3 { margin: 0 0 0.333em; font-size: 16px; font-weight: normal; }
+p { margin: 0 0 1.333em; }
+em { font-style: italic; }
+table { border-collapse: separate; border-spacing: 0; margin: 0; vertical-align: middle; }
+th { font-weight: bold; }
+th, td { padding: 5px 8px 5px 5px; text-align: left; vertical-align: middle; }
+pre, code { font-family: monospace, sans-serif; font-size: 1em; color:#080; }
+
+.inner-container { position:relative; overflow:hidden; width: 780px; padding: 40px 60px; border: 1px solid #ccc; margin: 40px auto 20px; background: #fff; -webkit-box-shadow: 0 0 15px rgba(0,0,0,0.1); -moz-box-shadow: 0 0 15px rgba(0,0,0,0.1); box-shadow: 0 0 15px rgba(0,0,0,0.1); }
+
+.inner-container pre,
+.inner-container .prettyprint { padding: 0; border: 0; margin: 0 0 20px; font-size: 13px; background: #fff; }
+
+.ribbon { position: absolute; top: -1px; right: -1px; opacity: 0.9; }
+.ribbon:hover, .ribbon:focus, .ribbon:active { opacity: 1; }
+.ribbon img { display: block; border: 0; }
+
+.header { padding-right:80px; }
+.header, .navigation { border-bottom: 1px solid #ccc; }
+.navigation { padding: 10px; margin: 0px; background-color: #EEE }
+
+.section { margin: 40px 0 20px; }
+
+.example { padding: 20px; border: 1px solid #ccc; margin: 10px -20px 20px; }
+
+.footer { margin: 20px 0 50px; font-size: 11px; color: #666; text-align: center; }
+.footer a { color: #666; }
+
+.field, .actions { margin: 0 0 1.333em; }
+.field_show { margin: 0 0 0.666em; }
+
+.admin_notice { color: green }
+.details { color: #CCC; padding: 5px 0 }
+
+.header_buttons { margin: -8px 0px 20px 0px }
+.footer_buttons { margin: 1em 0 0 0 }
+
+.flash_notice { margin: 0 0 1em 0; color: green; font-weight: bold }
+.flash_alert { margin: 0 0 1em 0; color: #980905; font-weight: bold }
+
+.field input { width: 300px; height: 25px; font: 14px/1.333 sans-serif; padding-left: 4px; }
+.field input { border: 1px solid #CCC; }
+
+#grant, #deny { padding: 5px 0px }
+.green { color: green }

data/app/controllers/open_sesame/application_controller.rb

@@ -0,0 +1,6 @@
+module OpenSesame
+  class ApplicationController < ActionController::Base
+    unloadable
+    include OpenSesame::ControllerHelper
+  end
+end

data/app/controllers/open_sesame/sessions_controller.rb

@@ -0,0 +1,27 @@
+module OpenSesame
+  class SessionsController < ApplicationController
+    unloadable
+
+    skip_before_filter :authenticate_opensesame!
+
+    def new
+    end
+
+    def create
+      warden.authenticate!(:scope => :opensesame)
+      flash[:success] = "Welcome!"
+      redirect_to main_app.root_url
+    end
+
+    def destroy
+      warden.logout(:opensesame)
+      flash[:notice] = "Logged out!"
+      redirect_to main_app.root_url
+    end
+
+    def failure
+      raise params.inspect
+    end
+
+  end
+end

data/app/helpers/open_sesame/application_helper.rb

@@ -0,0 +1,11 @@
+module OpenSesame
+  module ApplicationHelper
+    include OpenSesame::ViewHelper
+
+    def page_header(text)
+      content_tag(:header, class: "content-header") do
+        content_tag(:h1, text)
+      end
+    end
+  end
+end

data/app/helpers/open_sesame/sessions_helper.rb

@@ -0,0 +1,4 @@
+module OpenSesame
+  module SessionsHelper
+  end
+end

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

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>OpenSesame</title>
+  <%= stylesheet_link_tag    "open_sesame/application", :media => "all" %>
+  <%= javascript_include_tag "open_sesame/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<div class="container">
+  <div class="inner-container">
+    <% flash.each do |type, message| %>
+      <div class="alert alert-<%= type %> <%= type %>" data-role="flash-<%= type %>">
+        <%= message %>
+      </div>
+    <% end %>
+    <%= yield %>
+  </div>
+</div>
+
+</body>
+</html>

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

@@ -0,0 +1,7 @@
+<%= page_header 'Login' %>
+<p>Welcome! You have arrived at a <%= OpenSesame.organization_name.titleize %> application requiring additional credentials. To continue, please log in via:</p>
+<div class="table">
+  <div class="table-cell align-middle">
+    <%= login_image_link_to('github') %>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,8 @@
+OpenSesame::Engine.routes.draw do
+  root :to => "sessions#new"
+
+  match '/auth/:provider/callback', :to => 'sessions#create'
+  match '/auth/failure', :to => 'sessions#failure'
+  match '/login', :to => 'sessions#new', :as => :sign_in
+  match '/logout', :to => 'sessions#destroy', :as => :sign_out
+end

data/lib/open_sesame/configuration.rb

@@ -0,0 +1,59 @@
+module OpenSesame
+  class ConfigurationError < RuntimeError; end
+
+  class Configuration
+    CONFIGURABLE_ATTRIBUTES = [:organization_name, :mount_prefix, :github_client]
+    attr_accessor *CONFIGURABLE_ATTRIBUTES
+
+    def mounted_at(mount_prefix)
+      self.mount_prefix = mount_prefix
+    end
+
+    def github(client_id, client_secret)
+      self.github_client = { :id => client_id, :secret => client_secret }
+    end
+
+    def organization(organization_name)
+      self.organization_name = organization_name
+    end
+
+    def configure
+      yield self
+    end
+
+    def valid?
+      self.organization_name && self.organization_name.is_a?(String) &&
+      self.mount_prefix && self.mount_prefix.is_a?(String) &&
+      self.github_client.is_a?(Hash) &&
+      [:id, :secret].all? { |key| self.github_client.keys.include?(key) }
+    end
+
+    def validate!
+      return true if valid?
+      message = <<-MESSAGE
+
+
+      Update your OpenSesame configuration. Example:
+
+      # config/initializers/open_sesame.rb
+      OpenSesame.configure do |config|
+        config.organization 'challengepost'
+        config.mounted_at   '/welcome'
+        config.github       ENV['CAPITAN_GITHUB_KEY'], ENV['CAPITAN_GITHUB_SECRET']
+      end
+
+      When you register the app, make sure to point the callback url to
+      the engine mountpoint + /auth/github/callback. For example, if your
+      development app is on http://localhost:3000 and you're mounting
+      the OpenSesame::Engine at '/welcome', your github
+      callback url should be:
+
+      http://localhost:3000/auth/github/callback
+
+      MESSAGE
+
+      raise ConfigurationError.new(message)
+    end
+
+  end
+end

data/lib/open_sesame/controller_helper.rb

@@ -0,0 +1,18 @@
+module OpenSesame
+  module ControllerHelper
+    extend ActiveSupport::Concern
+
+    def warden
+      env['warden']
+    end
+
+    def authenticate_opensesame!
+      warden.authenticate!(:scope => :opensesame)
+    end
+
+    def current_opensesame_user
+      warden.user(:scope => :opensesame)
+    end
+
+  end
+end

data/lib/open_sesame/engine.rb

@@ -0,0 +1,33 @@
+require 'opensesame-github'
+
+module OpenSesame
+  class Engine < ::Rails::Engine
+    isolate_namespace OpenSesame
+
+    config.generators do |g|
+      g.test_framework :rspec, :view_specs => false
+    end
+
+    ActiveSupport.on_load(:action_controller) do
+      include OpenSesame::ControllerHelper
+    end
+
+    ActiveSupport.on_load(:action_view) do
+      include OpenSesame::ViewHelper
+    end
+
+    initializer "gardenwall.middleware", :after => :load_config_initializers do |app|
+      OpenSesame.configuration.validate!
+
+      OpenSesame::Github.organization_name = OpenSesame.organization_name
+
+      middleware.use OmniAuth::Strategies::GitHub, OpenSesame.github_client[:id], OpenSesame.github_client[:secret]
+
+      app.config.middleware.use Warden::Manager do |manager|
+        manager.scope_defaults :opensesame, :strategies => [:opensesame_github]
+        manager.failure_app = lambda { |env| OpenSesame::SessionsController.action(:new).call(env) }
+      end
+
+    end
+  end
+end

data/lib/open_sesame/version.rb

@@ -0,0 +1,3 @@
+module OpenSesame
+  VERSION = "0.0.1"
+end

data/lib/open_sesame/view_helper.rb

@@ -0,0 +1,15 @@
+module OpenSesame
+  module ViewHelper
+
+    def login_image_link_to(provider)
+      link_to identity_request_path(provider), class: "btn btn-large" do
+        image_tag("open_sesame/#{provider}_64.png") + "<br/><span>#{provider}</span>".html_safe
+      end
+    end
+
+    def identity_request_path(provider)
+      [OpenSesame.mount_prefix, 'auth', provider].join('/')
+    end
+
+  end
+end

data/lib/open_sesame.rb

@@ -0,0 +1,19 @@
+module OpenSesame
+  extend self
+
+  autoload :Configuration, 'open_sesame/configuration'
+  autoload :ControllerHelper, 'open_sesame/controller_helper'
+  autoload :ViewHelper, 'open_sesame/view_helper'
+
+  delegate *Configuration::CONFIGURABLE_ATTRIBUTES, :to => :configuration
+
+  mattr_accessor :configuration
+  @@configuration = Configuration.new
+
+  def configure(&block)
+    yield configuration
+    configuration
+  end
+end
+
+require "open_sesame/engine"

data/lib/opensesame.rb

@@ -0,0 +1 @@
+require "open_sesame"

data/lib/tasks/opensesame_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :opensesame do
+#   # Task goes here
+# end