crowd_client 0.0.6

data/generators/crowd_client/crowd_client_generator.rb

@@ -0,0 +1,21 @@
+class CrowdClientGenerator < Rails::Generator::Base
+  
+  def banner
+    "Usage #{$0} #{spec.name}"
+  end
+  
+  def manifest
+    record do |m|
+      # copy the session controller
+      m.directory('app/controllers')
+      m.file('sessions_controller.rb', 'app/controllers/sessions_controller.rb')
+      
+      # copy the default login (session/new) view
+      m.directory('app/views/sessions')
+      m.file('new.html.erb', 'app/views/sessions/new.html.erb')
+          
+      # copy the initializer 
+      m.file 'initializers_crowd_client.rb', 'config/initializers/crowd_client.rb'
+    end
+  end
+end

data/generators/crowd_client/templates/initializers_crowd_client.rb

@@ -0,0 +1,9 @@
+# Configuration Parameters for crowd client gem
+
+Crowd::Client::Config.service_base_url = 'https://crowd.gnoso.com/'
+Crowd::Client::Config.api_key = 'replace-with-crowd-api-key'
+Crowd::Client::Config.realm = 'replace-with-crowd-realm'
+Crowd::Client::Config.application_name = 'replace-with-crowd-application-name'
+
+# Apply the settings across the application
+Crowd::Client::Config.apply_configuration

data/generators/crowd_client/templates/new.html.erb

@@ -0,0 +1,12 @@
+
+<% form_tag sessions_resource_url do -%>
+    <%= hidden_field_tag 'realm', crowd_realm %>
+    <%= hidden_field_tag 'redirect_url', sessions_create_url %>
+  
+    <div><%= label_tag "username" %><%= text_field_tag "username" %></div>
+    <div><%= label_tag "password" %><%= password_field_tag "password" %></div>
+  
+    <div><%= check_box_tag 'save_login'%><%= label_tag 'save_login', 'Remember me.'%></div>
+  
+    <%= submit_tag "Login" %>
+<% end -%>

data/generators/crowd_client/templates/sessions_controller.rb

@@ -0,0 +1,27 @@
+#
+# This file was generated by the crowd_client gem.
+#
+# To regenerate: 
+#
+# script/generate crowd_client 
+#
+class SessionsController < ApplicationController
+  
+  skip_before_filter :must_authenticate
+
+  def create
+    if create_session(params) then 
+      flash[:message] = "Logged in."
+      redirect_to after_login_url || root_url
+    else
+      flash[:error] = "Unsuccessful login."
+      redirect_to :action => "new"
+    end
+  end
+  
+  def destroy
+    destroy_session
+    redirect_to :action => "new"
+  end
+
+end

data/lib/crowd_client.rb

@@ -0,0 +1,16 @@
+module Crowd
+  module Client
+    
+    class Config
+      
+      cattr_accessor :service_base_url  # base url of the crowd service: default => "https://crowd.gnoso.com"
+      cattr_accessor :api_key           # api-key from crowd to allow api access
+      cattr_accessor :realm             # name of the crowd realm that this site will use for authentication
+      cattr_accessor :application_name  # name of the application (used to verify API keys)
+
+      def self.apply_configuration
+        CrowdUser.apply_configuration
+      end
+    end
+  end
+end

data/lib/mixins/application_controller.rb

@@ -0,0 +1,114 @@
+# Add authentication methods to the application controller
+#
+# Usually you would include this in your Application Controller Class like so
+#
+# class ApplicationController < ActionController::Base
+#   include Crowd::Client::ApplicationControllerMethods
+#
+#   .......
+#
+# end
+
+module Crowd
+  module Client
+    module ApplicationControllerMethods
+      
+      def logged_in?
+        session[:logged_in]
+      end
+
+      def logged_in_name
+        session[:name]
+      end
+      
+      def after_login_url=(url)
+        session[:after_login_url] = url
+      end
+      
+      def after_login_url
+        session[:after_login_url]
+      end
+
+      def authenticated_with_api?
+        @authenticated_with_api
+      end
+
+      def must_authenticate
+        return if authenticated_with_api?
+        crowd_realm = Crowd::Client::Config.realm
+  
+        if logged_in?
+          return true
+        elsif (token = params.delete(:c_token))
+          register_login(token)
+          redirect_to params
+        elsif !checked_with_crowd?
+          session[:checked_crowd] = true
+          redirect_to "https://crowd.gnoso.com/sessions/check?realm=#{crowd_realm}&redirect_url=#{url_for(params.merge(:only_path => false))}"
+        else
+          after_login_url = params
+          redirect_to  :controller => :sessions, :action => :new
+        end
+      end
+
+      def verify_api_key
+        key = authenticate_with_http_basic { |api_key, ignore| api_key }
+        logger.info "Key: #{key}"
+        
+        if key then
+          # check the key against the crowd server
+          client = HTTPClient.new
+          response = client.get crowd_auth_url(key)
+          logger.info "Crowd Response Status: #{response.status}"
+          logger.info "Crowd Response: #{response.body.content}"
+          
+          @authenticated_with_api = (response.status == 200)
+        end
+        
+        true # continue filter chain
+      end
+      
+      def crowd_auth_url(key)
+        crowd_application_name = Crowd::Client::Config.application_name
+        crowd_realm = Crowd::Client::Config.realm
+        URI.join( Crowd::Client::Config.service_base_url, "/api_keys/authenticate?realm=#{crowd_realm}&key=#{key}&application_name=#{crowd_application_name}")
+      end
+
+      def register_login(token)
+        session[:logged_in] = true
+        crowd_user = CrowdUser.find(token)
+        session[:name] = "#{crowd_user.first_name} #{crowd_user.last_name}"
+      end
+
+      def checked_with_crowd?
+        session[:checked_crowd]
+      end
+
+      def create_session(params)
+        status = params[:c_status]
+        access_token = params[:c_token]
+    
+        case status
+        when "SUCCESS":
+          register_login(access_token)
+          return true
+        when "INVALID_LOGIN":
+          return false
+        else
+          raise "Something is configured wrong. Invalid status for session.", :status => 500
+        end
+      end
+      
+      # handler intended to be used within the create_session block
+      def has_status(status, &block)
+        status == @session_status
+      end
+  
+      def destroy_session
+        session[:logged_in] = false
+        session[:name] = nil
+      end
+      
+    end
+  end
+end

data/lib/mixins/crowd_helpers.rb

@@ -0,0 +1,44 @@
+module Crowd
+  module Client
+    module ViewHelpers
+      
+      def logged_in?
+        controller.logged_in?
+      end
+      
+      def logged_in_name
+        controller.logged_in_name
+      end
+      
+      def crowd_realm
+        Crowd::Client::Config.realm
+      end
+
+      def crowd_application_name
+        Crowd::Client::Config.application_name
+      end
+      
+      def sessions_resource_url
+        URI.join( Crowd::Client::Config.service_base_url, 'sessions' ).to_s
+      end
+
+      def sessions_create_url
+        url_for(:controller => 'sessions', :action => 'create', :only_path => false)
+      end
+      
+      def sessions_destroy_url
+        url_for(:controller => 'sessions', :action => 'destroy', :only_path => false)
+      end
+      
+      def crowd_logout_url
+        URI.join( Crowd::Client::Config.service_base_url, "/sessions/0?realm=#{crowd_realm}&redirect_url=#{sessions_destroy_url}").to_s
+      end
+      
+      def link_to_logout(text = nil)
+        link_to text || "Log Out", crowd_logout_url, :method => "delete"
+      end
+      
+    end
+  end
+end
+

data/lib/models/crowd_user.rb

@@ -0,0 +1,11 @@
+class CrowdUser < ActiveResource::Base
+
+  # This is called after the configuraion settings are set in the initializer
+  def self.apply_configuration
+    self.site = Crowd::Client::Config.service_base_url
+    self.element_name = "user"
+    self.user = Crowd::Client::Config.api_key
+    self.password = ""
+  end
+
+end

data/rails/init.rb

@@ -0,0 +1,12 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'crowd_client')
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'mixins', 'application_controller')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'mixins', 'crowd_helpers')
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'models', 'crowd_user')
+
+#require File.join(File.dirname(__FILE__), '..', 'generators', 'crowd_client', 'crowd_client_generator')
+
+# Hook our helpers into rails
+ActionView::Base.send :include, Crowd::Client::ViewHelpers
+ActionController::Base.send :include, Crowd::Client::ApplicationControllerMethods        

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: crowd_client
+version: !ruby/object:Gem::Version 
+  version: 0.0.6
+platform: ruby
+authors: 
+- Gnoso, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-18 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Crowd is a service for authenticating and tracking user accounts. This is the client library for crowd.
+email: conversation@gnoso.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- rails/init.rb
+- generators/crowd_client/crowd_client_generator.rb
+- generators/crowd_client/templates/initializers_crowd_client.rb
+- generators/crowd_client/templates/new.html.erb
+- generators/crowd_client/templates/sessions_controller.rb
+- lib/crowd_client.rb
+- lib/mixins/application_controller.rb
+- lib/mixins/crowd_helpers.rb
+- lib/models/crowd_user.rb
+has_rdoc: true
+homepage: http://www.gnoso.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Client library for the crowd user account system.
+test_files: []
+