Fastpass Implementation

Conceptual Overview

The broad steps of FastPass can be summarized into the following:

• Using the chosen library a signed URL is created.
• The URL contain all the necessary information to sign the user into Get Satisfaction.
• Optionally private key/value pairs can be contained in the URL.
• There are several methods to communicate the URL to Get Satisfaction.

Choose your preferred library

Input Fields

RUBY

Method Signatures

Sample Call

Output:

Included files

fastpass.rb - The Ruby FastPass library.

Steps to implementing Fastpass

The following steps shows how to implement FastPass:

1. Download the library: ruby.tar.gz or ruby.zip
2. Unpack the code archive into your application's lib/ folder.
3. Add require 'fastpass' to environment.rb or some other initializer file.
4. Restart your server to load the FastPass code.

Method for passing user information

1. Using Cookies along with CNAME
   Set a cookie named "fastpass" to the URL generated by the FastPass library. Note: This is only available if your company is using the CNAME feature.
2. Using the Query String
   Include the generated URL in the param named "fastpass" in all links to Get Satisfaction.
3. Using JavaScript
   When a user is logged in, include:
   
   
   All links to Get Satisfaction must be JavaScript function calls to GSFN.goto_gsfn()



PHP

Method Signatures

Sample Call

Output:

Included files

• FastPass.php - The PHP FastPass library.
• OAuth.php - Pre-requisite library for OAuth helper functions.

Steps to implementing Fastpass

The following steps shows how to implement FastPass:

1. Download the library: ruby.tar.gz or ruby.zip
2. Unpack the code archive into your application's lib/ folder.
3. Add require 'fastpass' to environment.rb or some other initializer file.
4. Restart your server to load the FastPass code.

1. Download the library: php.tar.gz or php.zip
2. Unpack the code archive, e.g. into your PHP include path.
3. Add require_once('FastPass.php'); where necessary. (Remember to set the correct path.)

Method for passing user information

1. Using Cookies along with CNAME
   Set a cookie named "fastpass" to the URL generated by the FastPass library. Note: This is only available if your company is using the CNAME feature.
2. Using the Query String
   Include the generated URL in the param named "fastpass" in all links to Get Satisfaction.
3. Using JavaScript
   When a user is logged in, include:
   
   
   All links to Get Satisfaction must be JavaScript function calls to GSFN.goto_gsfn()



JAVA

Method Signatures

Sample Call

Output:

Included files

Download the library: java.tar.gz or java.zip

• fastpass.jar - Compiled Java FastPass Library
• FastPass.java - The Java FastPass Library
• oauth-core.jar - Pre-requisite library for OAuth helper functions
• commons-codec-1.3.jar - Pre-requisite library for hashing algorithms
• commons-lang-2.4.jar - Pre-requisite library for HTML entity encoding helpers

Method for passing user information

1. Using Cookies along with CNAME
   Set a cookie named "fastpass" to the URL generated by the FastPass library. Note: This is only available if your company is using the CNAME feature.
   cookies["fastpass"] = FastPass.url(CONSUMER_KEY, CONSUMER_SECRET, current_user.email, current_user.name, current_user.id)

   view raw snippet.rb This Gist brought to you by GitHub.
   setcookie("fastpass", FastPass::url("lmwjv4kzwi27", "fiei6iv61jnoukaq1aylwd8vcmnkafrs", "scott@getsatisfaction.com", "Scott", "nullstyle", false, array("twitter_name" => "nullstyle")), time()+60*60*24*30);

   view raw API Example - PHP Cookie - Get Satisfaction.php This Gist brought to you by GitHub.
2. Using the Query String
   Include the generated URL in the param named "fastpass" in all links to Get Satisfaction.
   <%= link_to "Our Support Community", "/mycompany?fastpass=#{CGI.escape(FastPass.url(CONSUMER_KEY, CONSUMER_SECRET, current_user.email, current_user.name, current_user.id))} %>

   view raw snippet.rhtml This Gist brought to you by GitHub.
   <a href="/mycompany?fastpass=<?php echo urlencode(FastPass::url("lmwjv4kzwi27", "fiei6iv61jnoukaq1aylwd8vcmnkafrs", "scott@getsatisfaction.com", "Scott", "nullstyle", false, array("twitter_name" => "nullstyle")), time()+60*60*24*30)) ?>">Our Support Community</a>

   view raw API Example - PHP Query String - Get Satisfaction.php This Gist brought to you by GitHub.
3. Using JavaScript
   When a user is logged in, include:
   <%= FastPass.script(CONSUMER_KEY, CONSUMER_SECRET, current_user.email, current_user.name, current_user.id) %>

   view raw snippet.rhtml This Gist brought to you by GitHub.
   <?php echo FastPass::script("lmwjv4kzwi27", "fiei6iv61jnoukaq1aylwd8vcmnkafrs", "scott@getsatisfaction.com", "Scott", "nullstyle", false, array("twitter_name" => "nullstyle")), time()+60*60*24*30); ?>

   view raw aPI Example - PHP JavaScript - Get Satisfaction.php This Gist brought to you by GitHub.
   All links to Get Satisfaction must be JavaScript function calls to GSFN.goto_gsfn()



PYTHON

Method Signatures

Sample Call

Output:

Included Files

• fastpass.py - The Python FastPass Library
• oauth.py - pre-requisite library for OAuth helper functions

Steps to implement Fastpass

The following steps shows how to implement FastPass:

1. Download the library: ruby.tar.gz or ruby.zip
2. Unpack the code archive into your application's lib/ folder.
3. Add require 'fastpass' to environment.rb or some other initializer file.
4. Restart your server to load the FastPass code.

1. Download the library: php.tar.gz or php.zip
2. Unpack the code archive, e.g. into your PHP include path.
3. Add require_once('FastPass.php'); where necessary. (Remember to set the correct path.)

1. Download the library: python.tar.gz or python.zip
2. Unpack the code archive, e.g. into a folder on your Python search path.
3. Add import fastpass where necessary.

Method for passing user information

1. Using Cookies along with CNAME
   Set a cookie named "fastpass" to the URL generated by the FastPass library. Note: This is only available in your company is using the CNAME feature.
   cookies["fastpass"] = FastPass.url(CONSUMER_KEY, CONSUMER_SECRET, current_user.email, current_user.name, current_user.id)

   view raw snippet.rb This Gist brought to you by GitHub.
   setcookie("fastpass", FastPass::url("lmwjv4kzwi27", "fiei6iv61jnoukaq1aylwd8vcmnkafrs", "scott@getsatisfaction.com", "Scott", "nullstyle", false, array("twitter_name" => "nullstyle")), time()+60*60*24*30);

   view raw API Example - PHP Cookie - Get Satisfaction.php This Gist brought to you by GitHub.
2. Using the Query String
   Include the generated URL in the param named "fastpass" in all links to Get Satisfaction.
   <%= link_to "Our Support Community", "/mycompany?fastpass=#{CGI.escape(FastPass.url(CONSUMER_KEY, CONSUMER_SECRET, current_user.email, current_user.name, current_user.id))} %>

   view raw snippet.rhtml This Gist brought to you by GitHub.
   <a href="/mycompany?fastpass=<?php echo urlencode(FastPass::url("lmwjv4kzwi27", "fiei6iv61jnoukaq1aylwd8vcmnkafrs", "scott@getsatisfaction.com", "Scott", "nullstyle", false, array("twitter_name" => "nullstyle")), time()+60*60*24*30)) ?>">Our Support Community</a>

   view raw API Example - PHP Query String - Get Satisfaction.php This Gist brought to you by GitHub.
3. Using JavaScript
   When a user is logged in, include:
   <%= FastPass.script(CONSUMER_KEY, CONSUMER_SECRET, current_user.email, current_user.name, current_user.id) %>

   view raw snippet.rhtml This Gist brought to you by GitHub.
   <?php echo FastPass::script("lmwjv4kzwi27", "fiei6iv61jnoukaq1aylwd8vcmnkafrs", "scott@getsatisfaction.com", "Scott", "nullstyle", false, array("twitter_name" => "nullstyle")), time()+60*60*24*30); ?>

   view raw aPI Example - PHP JavaScript - Get Satisfaction.php This Gist brought to you by GitHub.
   All links to Get Satisfaction must be JavaScript function calls to GSFN.goto_gsfn()

.NET

Method Signatures

public class FastPass {
  public static string url(string key, string secret, string email, string name, string uid);
  public static string url(string key, string secret, string email, string name, string uid, bool isSecure);
  public static string url(string key, string secret, string email, string name, string uid, bool isSecure, 
Dictionary<string, string> privateFields);
 
  public static string script(string key, string secret, string email, string name, string uid);
  public static string script(string key, string secret, string email, string name, string uid, bool isSecure);
  public static string script(string key, string secret, string email, string name, string uid, bool isSecure, 
Dictionary<string, string> privateFields);
}
 
                    

Sample Call

Dictionary<string, string> parms = new Dictionary<string, string>();
parms.Add("twitter_name", "nullstyle");
var result = FastPass.script("lmwjv4kzwi27", "fiei6iv61jnoukaq1aylwd8vcmnkafrs", "scott@getsatisfaction.com", 
"Scott", "nullstyle", false, parms);
 
Page.ClientScript.RegisterStartupScript(this.GetType(), "fastpass", result);
                    

Included Files

• FastPass.dll
• FastPass.cs - The .Net FastPass Library
• FastPassCLI.cs - A sample Console Application illustrating use of the FastPass dll
• OAuthBase.cs - Pre-requisite library for FastPass

Note: you may need to regenerate a dll on your own system, being sure to sign it locally. This is often true for use with .ASP

Download the .Net library.

Method for passing user information

1. Using Cookies along with CNAME
   Set a cookie named "fastpass" to the URL generated by the FastPass library. Note: This is only available in your company is using the CNAME feature.
   cookies["fastpass"] = FastPass.url(CONSUMER_KEY, CONSUMER_SECRET, current_user.email, current_user.name, current_user.id)

   view raw snippet.rb This Gist brought to you by GitHub.
   setcookie("fastpass", FastPass::url("lmwjv4kzwi27", "fiei6iv61jnoukaq1aylwd8vcmnkafrs", "scott@getsatisfaction.com", "Scott", "nullstyle", false, array("twitter_name" => "nullstyle")), time()+60*60*24*30);

   view raw API Example - PHP Cookie - Get Satisfaction.php This Gist brought to you by GitHub.
2. Using the Query String
   Include the generated URL in the param named "fastpass" in all links to Get Satisfaction.
   <%= link_to "Our Support Community", "/mycompany?fastpass=#{CGI.escape(FastPass.url(CONSUMER_KEY, CONSUMER_SECRET, current_user.email, current_user.name, current_user.id))} %>

   view raw snippet.rhtml This Gist brought to you by GitHub.
   <a href="/mycompany?fastpass=<?php echo urlencode(FastPass::url("lmwjv4kzwi27", "fiei6iv61jnoukaq1aylwd8vcmnkafrs", "scott@getsatisfaction.com", "Scott", "nullstyle", false, array("twitter_name" => "nullstyle")), time()+60*60*24*30)) ?>">Our Support Community</a>

   view raw API Example - PHP Query String - Get Satisfaction.php This Gist brought to you by GitHub.
3. Using JavaScript
   When a user is logged in, include:
   <%= FastPass.script(CONSUMER_KEY, CONSUMER_SECRET, current_user.email, current_user.name, current_user.id) %>

   view raw snippet.rhtml This Gist brought to you by GitHub.
   <?php echo FastPass::script("lmwjv4kzwi27", "fiei6iv61jnoukaq1aylwd8vcmnkafrs", "scott@getsatisfaction.com", "Scott", "nullstyle", false, array("twitter_name" => "nullstyle")), time()+60*60*24*30); ?>

   view raw aPI Example - PHP JavaScript - Get Satisfaction.php This Gist brought to you by GitHub.
   All links to Get Satisfaction must be JavaScript function calls to GSFN.goto_gsfn()