@@ -1,8 +1,13 @@ -The Integration API is an Open Source project with the goal of making -it easy to integrate an existing Rails application with any number of -off-the-shelf apps, such as Wordpress, Beast, PunBB, or Vanilla. The -focus is on enabling transparent single sign-on between the -applications. +The Integration_API enables single sign-on between an existing Rails +application and any number of instances of other web applications. +The Wordpress plugin is completed, and collaborators are wanted for +plugins for other apps such as Beast, PunBB, or Vanilla. + +The most current info about available plugin/adapters is available on +the Integration_API home page: + + http://greenfabric.com/page/integration_api_home_page + The basic idea @@ -84,6 +89,10 @@ true. INTEGRATION_API_DEBUG = false INTEGRATION_API_SESSION_USER_ID_KEY = :userid INTEGRATION_API_SESSION_ID_PARAM = :id +INTEGRATION_API_CONFIG = { + :login_url => 'http://devbox:3000/page/sign_in', + :logout_url => 'http://devbox:3000/consumer/logout' +} # For security: INTEGRATION_API_REQUIRED_PORT = 3000 # Set to nil to disable @@ -99,8 +108,8 @@ and tailoring the constants, you can test the API like this: * Getting the cookie name used by your app: -$ curl http://localhost:3000/integration_api/cookie_name -"_gf_session" +$ curl http://localhost:3000/integration_api/config_info +{"login_url":"http:\/\/devbox:3000\/page\/sign_in","logout_url":"http:\/\/devbox:3000\/consumer\/logout","cookie_name":"_gf_session"} * Getting the user info for a signed-in user, based on the session id @@ -114,16 +123,21 @@ $ curl http://localhost:3000/integration_api/user/390f55cfd1ad5a911833a7683d2c37 * Attempting to use the API from an unauthorized host (Debug mode enabled): -$ curl http://devbox:3000/integration_api/cookie_name +$ curl http://devbox:3000/integration_api/config_info Bad host: localhost is required, but got devbox * Attempting to use the API from an unauthorized host (Debug mode disabled): -$ curl http://devbox:3000/integration_api/cookie_name +$ curl http://devbox:3000/integration_api/config_info HTTP 501 -- Server error. -- Robb Shecter robb@greenfabric.com http://greenfabric.com/robb + +This document, and the entire Integration_API project has been +released under the GNU public license. + +Copyright (C) 2008, Robb Shecter, greenfabric.com \ No newline at end of file README @@ -1,5 +1,9 @@ +# +# Licensed under the Open Source GNU public license. +# Copyright (C) 2008 Robb Shecter, greenfabric.com +# class IntegrationApiController < ApplicationController - before_filter :security_check, :only => [:user, :cookie_name] + before_filter :security_check, :only => [:user, :config_info] # For security reasons, a vague error message # is given when not in debug mode. @@ -21,11 +25,13 @@ class IntegrationApiController < ApplicationController end # - # Return the name of the cookie containing the Rails session key. + # Return the configuration info for this server. # - def cookie_name - name = ActionController::Base.cached_session_options[0][:session_key] - data = {'cookie name' => name} + def config_info + # First add the cookie name to the constants. + cookie_name = ActionController::Base.cached_session_options[0][:session_key] + data = INTEGRATION_API_CONFIG.dup + data[:cookie_name] = cookie_name respond_to do |format| format.json { render :json => data.to_json } integration_api_controller.rb 82fea58b55e71bd7eb2c3fb93979a097ec0857f2 Robb Shecter robb@greenfabric.com http://github.com/Snacky/integration_api/commit/bc7eedcb46dee16606cabb6ae099634b8d80cf6b bc7eedcb46dee16606cabb6ae099634b8d80cf6b 2008-11-01T06:29:22-07:00 2008-11-01T06:29:22-07:00 Many changes to complement the completed Wordpress plugin. 630522b2130a2aa7ebcd49e8f12d521282529719 Robb Shecter robb@greenfabric.com