removed auto-generated comments

to support both querystring and header signatures

README.textile

@@ -1,5 +1,3 @@
-!http://img411.imageshack.us/img411/2851/scribelogo.png!
-
 h2. Welcome to the home of Scribe, the simple OAuth Java lib!
 
 h1. Why use Scribe?

changelog.txt

@@ -35,3 +35,12 @@
 [1.1.2]
 
   * FIX: Fixed ugly bug that made 1.1.1 practically unusable (thanks Stubbs)
+
+[1.1.3]
+
+  * FEATURE: Added rawResponse to Token, for extracting additional parameters (thanks Dirk McCormick)
+  * FEATURE: Added Dropbox Api
+  * FIX: Token responses now work despite of the token/secret order
+  * FEATURE: Added Foursquare OAuth 2.0 Api (thanks Tom Tasche)
+  * FEATURE: Added support for OAuth1.0a signatures via querystring parameters
+  * FEATURE: Added ConstantContact Api (thanks Matthew Laudato)

src/main/java/org/scribe/builder/ServiceBuilder.java

@@ -20,6 +20,7 @@ public class ServiceBuilder
   private String callback;
   private Api api;
   private String scope;
+  private SignatureType signatureType;
   
   /**
    * Default constructor
@@ -122,6 +123,19 @@ public class ServiceBuilder
     this.scope = scope;
     return this;
   }
+
+  /**
+   * Configures the signature type, choose between header, querystring, etc. Defaults to Header
+   *
+   * @param scope The OAuth scope
+   * @return the {@link ServiceBuilder} instance for method chaining
+   */
+  public ServiceBuilder signatureType(SignatureType type)
+  {
+    Preconditions.checkNotNull(type, "Signature type can't be null");
+    this.signatureType = type;
+    return this;
+  }
   
   /**
    * Returns the fully configured {@link OAuthService}
@@ -133,6 +147,6 @@ public class ServiceBuilder
     Preconditions.checkNotNull(api, "You must specify a valid api through the provider() method");
     Preconditions.checkEmptyString(apiKey, "You must provide an api key");
     Preconditions.checkEmptyString(apiSecret, "You must provide an api secret");
-    return api.createService(new OAuthConfig(apiKey, apiSecret, callback), scope);
+    return api.createService(new OAuthConfig(apiKey, apiSecret, callback, signatureType), scope);
   }
 }

src/main/java/org/scribe/builder/api/ConstantContactApi.java

@@ -0,0 +1,26 @@
+package org.scribe.builder.api;
+
+import org.scribe.model.*;
+
+public class ConstantContactApi extends DefaultApi10a
+{
+  private static final String AUTHORIZE_URL = "https://oauth.constantcontact.com/ws/oauth/confirm_access?oauth_token=%s";
+
+  @Override
+  public String getAccessTokenEndpoint()
+  {
+    return "https://oauth.constantcontact.com/ws/oauth/access_token";
+  }
+
+  @Override
+  public String getAuthorizationUrl(Token requestToken)
+  {
+    return String.format(AUTHORIZE_URL, requestToken.getToken());
+  }
+
+  @Override
+  public String getRequestTokenEndpoint()
+  {
+    return "https://oauth.constantcontact.com/ws/oauth/request_token";
+  }
+}

src/main/java/org/scribe/builder/api/DropBoxApi.java

@@ -0,0 +1,25 @@
+package org.scribe.builder.api;
+
+import org.scribe.model.*;
+
+public class DropBoxApi extends DefaultApi10a
+{
+  @Override
+  public String getAccessTokenEndpoint()
+  {
+    return "https://api.dropbox.com/0/oauth/access_token";
+  }
+
+  @Override
+  public String getAuthorizationUrl(Token requestToken)
+  {
+    return "https://www.dropbox.com/0/oauth/authorize?oauth_token="+requestToken.getToken();
+  }
+
+  @Override
+  public String getRequestTokenEndpoint()
+  {
+    return "https://api.dropbox.com/0/oauth/request_token";
+  }
+
+}

src/main/java/org/scribe/builder/api/Foursquare2Api.java

@@ -0,0 +1,29 @@
+package org.scribe.builder.api;
+
+import org.scribe.extractors.*;
+import org.scribe.model.*;
+import org.scribe.utils.*;
+
+public class Foursquare2Api extends DefaultApi20
+{
+  private static final String AUTHORIZATION_URL = "https://foursquare.com/oauth2/authenticate?client_id=%s&response_type=code&redirect_uri=%s";
+
+  @Override
+  public String getAccessTokenEndpoint()
+  {
+    return "https://foursquare.com/oauth2/access_token?grant_type=authorization_code";
+  }
+
+  @Override
+  public String getAuthorizationUrl(OAuthConfig config)
+  {
+    Preconditions.checkValidUrl(config.getCallback(), "Must provide a valid url as callback. Foursquare2 does not support OOB");
+    return String.format(AUTHORIZATION_URL, config.getApiKey(), URLUtils.formURLEncode(config.getCallback()));
+  }
+
+  @Override
+  public AccessTokenExtractor getAccessTokenExtractor()
+  {
+    return new JsonTokenExtractor();
+  }
+}

src/main/java/org/scribe/builder/api/LoveFilmApi.java

@@ -0,0 +1,28 @@
+package org.scribe.builder.api;
+
+import org.scribe.model.Token;
+
+public class LoveFilmApi extends DefaultApi10a
+{
+  private static final String REQUEST_TOKEN_URL = "http://openapi.lovefilm.com/oauth/request_token";
+  private static final String ACCESS_TOKEN_URL = "http://openapi.lovefilm.com/oauth/access_token";
+  private static final String AUTHORIZE_URL = "https://www.lovefilm.com/activate?oauth_token=%s";
+
+  @Override
+  public String getRequestTokenEndpoint()
+  {
+    return REQUEST_TOKEN_URL;
+  }
+
+  @Override
+  public String getAccessTokenEndpoint()
+  {
+    return ACCESS_TOKEN_URL;
+  }
+
+  @Override
+  public String getAuthorizationUrl(Token requestToken)
+  {
+    return String.format(AUTHORIZE_URL, requestToken.getToken());
+  }
+}

src/main/java/org/scribe/extractors/JsonTokenExtractor.java

@@ -0,0 +1,28 @@
+package org.scribe.extractors;
+
+import java.util.regex.*;
+
+import org.scribe.exceptions.*;
+import org.scribe.model.*;
+import org.scribe.utils.*;
+
+public class JsonTokenExtractor implements AccessTokenExtractor
+{
+  private Pattern accessTokenPattern = Pattern.compile("\"access_token\":\"(\\S*)\"");
+
+  @Override
+  public Token extract(String response)
+  {
+    Preconditions.checkEmptyString(response, "Cannot extract a token from a null or empty String");
+    Matcher matcher = accessTokenPattern.matcher(response);
+    if(matcher.find())
+    {
+      return new Token(matcher.group(1), "");
+    }
+    else
+    {
+      throw new OAuthException("Cannot extract an acces token. Response was: "+response);
+    }
+  }
+
+}

src/main/java/org/scribe/extractors/TokenExtractor20Impl.java

@@ -26,7 +26,7 @@ public class TokenExtractor20Impl implements AccessTokenExtractor
     if (matcher.matches())
     {
       String token = URLUtils.formURLDecode(matcher.group(1));
-      return new Token(token, EMPTY_SECRET);
+      return new Token(token, EMPTY_SECRET, response);
     } 
     else
     {

src/main/java/org/scribe/extractors/TokenExtractorImpl.java

@@ -15,7 +15,8 @@ import org.scribe.utils.*;
  */
 public class TokenExtractorImpl implements RequestTokenExtractor, AccessTokenExtractor
 {
-  private static final String TOKEN_REGEX = "oauth_token=(\\S*)&oauth_token_secret=(\\S*?)(&(.*))?";
+  private static final Pattern TOKEN_REGEX = Pattern.compile("oauth_token=([^&]+)");
+  private static final Pattern SECRET_REGEX = Pattern.compile("oauth_token_secret=([^&]+)");
 
   /**
    * {@inheritDoc} 
@@ -23,17 +24,21 @@ public class TokenExtractorImpl implements RequestTokenExtractor, AccessTokenExt
   public Token extract(String response)
   {
     Preconditions.checkEmptyString(response, "Response body is incorrect. Can't extract a token from an empty string");
+    String token = extract(response, TOKEN_REGEX);
+    String secret = extract(response, SECRET_REGEX);
+    return new Token(token, secret, response);
+  }
 
-    Matcher matcher = Pattern.compile(TOKEN_REGEX).matcher(response);
+  private String extract(String response, Pattern p)
-    if (matcher.matches())
+  {
+    Matcher matcher = p.matcher(response);
+    if (matcher.find() && matcher.groupCount() >= 1)
     {
-      String token = URLUtils.formURLDecode(matcher.group(1));
+      return URLUtils.formURLDecode(matcher.group(1));
-      String secret = URLUtils.formURLDecode(matcher.group(2));
-      return new Token(token, secret);
     }
     else
     {
-      throw new OAuthException("Response body is incorrect. Can't extract a token from this: '" + response + "'", null);
+      throw new OAuthException("Response body is incorrect. Can't extract token and secret from this: '" + response + "'", null);
     }
   }
 }

src/main/java/org/scribe/model/OAuthConfig.java

@@ -10,17 +10,25 @@ public class OAuthConfig
   private String apiKey;
   private String apiSecret;
   private String callback;
+  private SignatureType signatureType;
   
   public OAuthConfig(String key, String secret)
   {
     this(key,secret,null);
   }
-  
+
+  //Kept for backwards compatibility
   public OAuthConfig(String key, String secret, String callback)
+  {
+    this(key,secret,callback,null);
+  }
+
+  public OAuthConfig(String key, String secret, String callback, SignatureType type)
   {
     this.apiKey = key;
     this.apiSecret = secret;
     this.callback = callback;
+    this.signatureType = type;
   }
 
   public String getApiKey()
@@ -52,4 +60,14 @@ public class OAuthConfig
   {
     this.callback = callback;
   }
+
+  public SignatureType getSignatureType()
+  {
+    return signatureType != null ? signatureType : SignatureType.Header;
+  }
+
+  public void setSignatureType(SignatureType type)
+  {
+    this.signatureType = type;
+  }
 }

src/main/java/org/scribe/model/Request.java

@@ -64,6 +64,7 @@ class Request
     String effectiveUrl = URLUtils.appendParametersToQueryString(url, querystringParams);
     if (connection == null)
     {
+      System.setProperty("http.keepAlive", "false");
       connection = (HttpURLConnection) new URL(effectiveUrl).openConnection();
     }
   }

src/main/java/org/scribe/model/SignatureType.java

@@ -0,0 +1,7 @@
+package org.scribe.model;
+
+public enum SignatureType
+{
+  Header,
+  QueryString
+}

src/main/java/org/scribe/model/Token.java

@@ -13,6 +13,7 @@ public class Token implements Serializable
 	
   private final String token;
   private final String secret;
+  private final String rawResponse;
 
   /**
    * Default constructor
@@ -21,9 +22,15 @@ public class Token implements Serializable
    * @param secret token secret
    */
   public Token(String token, String secret)
+  {
+    this(token, secret, null);
+  }
+
+  public Token(String token, String secret, String rawResponse)
   {
     this.token = token;
     this.secret = secret;
+    this.rawResponse = rawResponse;
   }
 
   public String getToken()
@@ -36,6 +43,15 @@ public class Token implements Serializable
     return secret;
   }
 
+  public String getRawResponse()
+  {
+    if (rawResponse == null)
+    {
+      throw new IllegalStateException("This token object was not constructed by scribe and does not have a rawResponse");
+    }
+    return rawResponse;
+  }
+
   @Override
   public String toString()
   {

src/main/java/org/scribe/oauth/OAuth10aServiceImpl.java

@@ -1,5 +1,7 @@
 package org.scribe.oauth;
 
+import java.util.*;
+
 import org.scribe.builder.api.*;
 import org.scribe.model.*;
 
@@ -38,7 +40,7 @@ public class OAuth10aServiceImpl implements OAuthService
     OAuthRequest request = new OAuthRequest(api.getRequestTokenVerb(), api.getRequestTokenEndpoint());
     request.addOAuthParameter(OAuthConstants.CALLBACK, config.getCallback());
     addOAuthParams(request, OAuthConstants.EMPTY_TOKEN);
-    addOAuthHeader(request);
+    addSignature(request);
     Response response = request.send();
     return api.getRequestTokenExtractor().extract(response.getBody());
   }
@@ -63,7 +65,7 @@ public class OAuth10aServiceImpl implements OAuthService
     request.addOAuthParameter(OAuthConstants.TOKEN, requestToken.getToken());
     request.addOAuthParameter(OAuthConstants.VERIFIER, verifier.getValue());
     addOAuthParams(request, requestToken);
-    addOAuthHeader(request);
+    addSignature(request);
     Response response = request.send();
     return api.getAccessTokenExtractor().extract(response.getBody());
   }
@@ -75,7 +77,7 @@ public class OAuth10aServiceImpl implements OAuthService
   {
     request.addOAuthParameter(OAuthConstants.TOKEN, token.getToken());
     addOAuthParams(request, token);
-    addOAuthHeader(request);
+    addSignature(request);
   }
 
   /**
@@ -108,9 +110,20 @@ public class OAuth10aServiceImpl implements OAuthService
     return api.getSignatureService().getSignature(baseString, config.getApiSecret(), token.getSecret());
   }
 
-  private void addOAuthHeader(OAuthRequest request)
+  private void addSignature(OAuthRequest request)
   {
-    String oauthHeader = api.getHeaderExtractor().extract(request);
+    switch (config.getSignatureType())
-    request.addHeader(OAuthConstants.HEADER, oauthHeader);
+    {
+      case Header:
+        String oauthHeader = api.getHeaderExtractor().extract(request);
+        request.addHeader(OAuthConstants.HEADER, oauthHeader);
+        break;
+      case QueryString:
+        for (Map.Entry<String, String> entry : request.getOauthParameters().entrySet())
+        {
+          request.addQuerystringParameter(entry.getKey(), entry.getValue());
+        }
+        break;
+    }
   }
 }

src/test/java/org/scribe/builder/ServiceBuilderTest.java

@@ -18,12 +18,13 @@ public class ServiceBuilderTest
   }
 
   @Test
-  public void shouldReturnOOBasDefaultCallback()
+  public void shouldReturnConfigDefaultValues()
   {
     builder.provider(ApiMock.class).apiKey("key").apiSecret("secret").build();
     assertEquals(ApiMock.config.getApiKey(), "key");
     assertEquals(ApiMock.config.getApiSecret(), "secret");
     assertEquals(ApiMock.config.getCallback(), OAuthConstants.OUT_OF_BAND);
+    assertEquals(ApiMock.config.getSignatureType(), SignatureType.Header);
   }
 
   @Test
@@ -35,6 +36,15 @@ public class ServiceBuilderTest
     assertEquals(ApiMock.config.getCallback(), "http://example.com");
   }
 
+  @Test
+  public void shouldAcceptASignatureType()
+  {
+    builder.provider(ApiMock.class).apiKey("key").apiSecret("secret").signatureType(SignatureType.QueryString).build();
+    assertEquals(ApiMock.config.getApiKey(), "key");
+    assertEquals(ApiMock.config.getApiSecret(), "secret");
+    assertEquals(ApiMock.config.getSignatureType(), SignatureType.QueryString);
+  }
+
   @Test(expected=IllegalArgumentException.class)
   public void shouldNotAcceptAnInvalidUrlAsCallback()
   {

src/test/java/org/scribe/examples/Foursquare2Example.java

@@ -0,0 +1,63 @@
+package org.scribe.examples;
+
+import java.util.*;
+
+import org.scribe.builder.*;
+import org.scribe.builder.api.*;
+import org.scribe.model.*;
+import org.scribe.oauth.*;
+
+public class Foursquare2Example
+{
+  private static final String PROTECTED_RESOURCE_URL = "https://api.foursquare.com/v2/users/self/friends?oauth_token=";
+  private static final Token EMPTY_TOKEN = null;
+
+  public static void main(String[] args)
+  {
+    // Replace these with your own api key and secret
+    String apiKey = "FEGFXJUFANVVDHVSNUAMUKTTXCP1AJQD53E33XKJ44YP1S4I";
+    String apiSecret = "AYWKUL5SWPNC0CTQ202QXRUG2NLZYXMRA34ZSDW4AUYBG2RC";
+    OAuthService service = new ServiceBuilder()
+                                  .provider(Foursquare2Api.class)
+                                  .apiKey(apiKey)
+                                  .apiSecret(apiSecret)
+                                  .callback("http://localhost:9000/")
+                                  .build();
+    Scanner in = new Scanner(System.in);
+
+    System.out.println("=== Foursquare2's OAuth Workflow ===");
+    System.out.println();
+
+    // Obtain the Authorization URL
+    System.out.println("Fetching the Authorization URL...");
+    String authorizationUrl = service.getAuthorizationUrl(EMPTY_TOKEN);
+    System.out.println("Got the Authorization URL!");
+    System.out.println("Now go and authorize Scribe here:");
+    System.out.println(authorizationUrl);
+    System.out.println("And paste the authorization code here");
+    System.out.print(">>");
+    Verifier verifier = new Verifier(in.nextLine());
+    System.out.println();
+    
+    // Trade the Request Token and Verfier for the Access Token
+    System.out.println("Trading the Request Token for an Access Token...");
+    Token accessToken = service.getAccessToken(EMPTY_TOKEN, verifier);
+    System.out.println("Got the Access Token!");
+    System.out.println("(if your curious it looks like this: " + accessToken + " )");
+    System.out.println();
+
+    // Now let's go and ask for a protected resource!
+    System.out.println("Now we're going to access a protected resource...");
+    OAuthRequest request = new OAuthRequest(Verb.GET, PROTECTED_RESOURCE_URL + accessToken.getToken());
+    service.signRequest(accessToken, request);
+    Response response = request.send();
+    System.out.println("Got it! Lets see what we found...");
+    System.out.println();
+    System.out.println(response.getCode());
+    System.out.println(response.getBody());
+
+    System.out.println();
+    System.out.println("Thats it man! Go and build something awesome with Scribe! :)");
+
+  }
+}

src/test/java/org/scribe/examples/LoveFilmExample.java

@@ -0,0 +1,64 @@
+package org.scribe.examples;
+
+import java.util.*;
+
+import org.scribe.builder.*;
+import org.scribe.builder.api.*;
+import org.scribe.model.*;
+import org.scribe.oauth.*;
+
+public class LoveFilmExample
+{
+  private static final String NETWORK_NAME = "LoveFilm";
+  private static final String PROTECTED_RESOURCE_URL = "https://api.lovefilm.com/users";
+
+  public static void main(String[] args)
+  {
+    // Replace these with your own api key and secret
+    String apiKey = "your_key";
+    String apiSecret = "your_secret";
+    OAuthService service = new ServiceBuilder().provider(LoveFilmApi.class).apiKey(apiKey).apiSecret(apiSecret).build();
+    Scanner in = new Scanner(System.in);
+
+    System.out.println("=== " + NETWORK_NAME + "'s OAuth Workflow ===");
+    System.out.println();
+
+    // Grab a request token.
+    System.out.println("Fetching request token.");
+    Token requestToken = service.getRequestToken();
+    System.out.println("Got it ... ");
+    System.out.println(requestToken.getToken());
+
+    // Obtain the Authorization URL
+    System.out.println("Fetching the Authorization URL...");
+    String authorizationUrl = service.getAuthorizationUrl(requestToken);
+    System.out.println("Got the Authorization URL!");
+    System.out.println("Now go and authorize Scribe here:");
+    System.out.println(authorizationUrl);
+    System.out.println("And paste the authorization code here");
+    System.out.print(">>");
+    Verifier verifier = new Verifier(in.nextLine());
+    System.out.println();
+
+    // Trade the Request Token and Verfier for the Access Token
+    System.out.println("Trading the Request Token for an Access Token...");
+    Token accessToken = service.getAccessToken(requestToken, verifier);
+    System.out.println("Got the Access Token!");
+    System.out.println("(if your curious it looks like this: " + accessToken + " )");
+    System.out.println();
+
+    // Now let's go and ask for a protected resource!
+    System.out.println("Now we're going to access a protected resource...");
+    OAuthRequest request = new OAuthRequest(Verb.GET, PROTECTED_RESOURCE_URL);
+    service.signRequest(accessToken, request);
+    Response response = request.send();
+    System.out.println("Got it! Lets see what we found...");
+    System.out.println();
+    System.out.println(response.getCode());
+    System.out.println(response.getBody());
+
+    System.out.println();
+    System.out.println("Thats it man! Go and build something awesome with Scribe! :)");
+
+  }
+}

src/test/java/org/scribe/extractors/JsonTokenExtractorTest.java

@@ -0,0 +1,31 @@
+package org.scribe.extractors;
+
+import static org.junit.Assert.*;
+
+import org.junit.*;
+import org.scribe.model.*;
+
+public class JsonTokenExtractorTest
+{
+  private String response = "'{ \"access_token\":\"I0122HHJKLEM21F3WLPYHDKGKZULAUO4SGMV3ABKFTDT3T3X\"}'";
+  private JsonTokenExtractor extractor = new JsonTokenExtractor();
+
+  @Test
+  public void shouldParseResponse()
+  {
+    Token token = extractor.extract(response);
+    assertEquals(token.getToken(), "I0122HHJKLEM21F3WLPYHDKGKZULAUO4SGMV3ABKFTDT3T3X");
+  }
+
+  @Test(expected=IllegalArgumentException.class)
+  public void shouldThrowExceptionIfForNullParameters()
+  {
+    extractor.extract(null);
+  }
+
+  @Test(expected=IllegalArgumentException.class)
+  public void shouldThrowExceptionIfForEmptyStrings()
+  {
+    extractor.extract("");
+  }
+}

src/test/java/org/scribe/extractors/TokenExtractorTest.java

@@ -26,6 +26,15 @@ public class TokenExtractorTest
     assertEquals("hdhd0244k9j7ao03", extracted.getSecret());
   }
 
+  @Test
+  public void shouldExtractTokenFromInvertedOAuthStandardResponse()
+  {
+    String response = "oauth_token_secret=hh5s93j4hdidpola&oauth_token=hdhd0244k9j7ao03";
+    Token extracted = extractor.extract(response);
+    assertEquals("hh5s93j4hdidpola", extracted.getSecret());
+    assertEquals("hdhd0244k9j7ao03", extracted.getToken());
+  }
+
   @Test
   public void shouldExtractTokenFromResponseWithCallbackConfirmed()
   {