Changed version number for release

Renamed method to keep consistency

README.textile

@@ -32,6 +32,12 @@ h3. Supports all major OAuth APIs out-of-the-box
 
 * Foursquare
 
+* Evernote
+
+* Vimeo
+
+* Yammer
+
 * and many more! check the "examples folder":http://github.com/fernandezpablo85/scribe-java/tree/master/src/test/java/org/scribe/examples
 
 h3. Small and modular

changelog.txt

@@ -13,3 +13,14 @@
  * FIX: Fixed Evernote Api (uses GET for request and access tokens)
  * REFACTOR: URLEncoding stuff. LinkedIn specific decoder is no longer needed
  * FEATURE: Added Google example
+
+[1.0.9]
+
+ * FEATURE: Token made Serializable
+ * FIX: Google Api encoding issues (thanks @roger and @klakegg)
+
+[1.1.0]
+
+  * FEATURE: OAuth 2.0 Support and Facebook support out of the box (thanks Diego Silveira)
+  * REFACTOR: Api creation and OAuthService refactors
+  * REFACTOR: Connections are created lazily (just before sending the request)

pom.xml

@@ -4,7 +4,7 @@
   <groupId>org.scribe</groupId>
   <artifactId>scribe</artifactId>
   <packaging>jar</packaging>
-  <version>1.0.8</version>
+  <version>1.1.0</version>
   <name>Scribe OAuth Library</name>
   <description>The best OAuth library out there</description>
   <url>http://github.com/fernandezpablo85/scribe-java</url>
@@ -22,6 +22,12 @@
       <email>fernandezpablo85@gmail.com</email>
       <timezone>-3</timezone>
     </developer>
+    <developer>
+      <id>diegossilveira</id>
+      <name>Diego Silveira</name>
+      <email>diegossilveira@gmail.com</email>
+      <timezone>-3</timezone>
+    </developer>
   </developers>
 
   <licenses>

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

@@ -2,7 +2,6 @@ package org.scribe.builder;
 
 import org.scribe.builder.api.*;
 import org.scribe.exceptions.*;
-
 import org.scribe.model.*;
 import org.scribe.oauth.*;
 import org.scribe.utils.*;
@@ -119,6 +118,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(apiKey, apiSecret, callback, scope);
+    return api.createService(new OAuthConfig(apiKey, apiSecret, callback), scope);
   }
 }

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

@@ -1,5 +1,6 @@
 package org.scribe.builder.api;
 
+import org.scribe.model.*;
 import org.scribe.oauth.*;
 
 /**
@@ -20,5 +21,5 @@ public interface Api
    * 
    * @return fully configured {@link OAuthService}
    */
-  OAuthService createService(String apiKey, String apiSecret, String callback, String scope);
+  OAuthService createService(OAuthConfig config, String scope);
 }

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

@@ -8,52 +8,97 @@ import org.scribe.services.*;
 /**
  * Default implementation of the OAuth protocol, version 1.0a
  * 
- * This class is meant to be extended by concrete implementations of the API.
+ * This class is meant to be extended by concrete implementations of the API,
+ * providing the endpoints and endpoint-http-verbs.
+ * 
  * If your Api adheres to the 1.0a protocol correctly, you just need to extend 
  * this class and define the getters for your endpoints.
  * 
+ * If your Api does something a bit different, you can override the different 
+ * extractors or services, in order to fine-tune the process. Please read the 
+ * javadocs of the interfaces to get an idea of what to do.
+ * 
  * @author Pablo Fernandez
  *
  */
 public abstract class DefaultApi10a implements Api
 {
-  
-  protected AccessTokenExtractor getAccessTokenExtractor()
+  /**
+   * Returns the access token extractor.
+   * 
+   * @return access token extractor
+   */
+  public AccessTokenExtractor getAccessTokenExtractor()
   {
     return new TokenExtractorImpl();
   }
 
-  protected BaseStringExtractor getBaseStringExtractor()
+  /**
+   * Returns the base string extractor.
+   * 
+   * @return base string extractor
+   */
+  public BaseStringExtractor getBaseStringExtractor()
   {
     return new BaseStringExtractorImpl();
   }
 
-  protected HeaderExtractor getHeaderExtractor()
+  /**
+   * Returns the header extractor.
+   * 
+   * @return header extractor
+   */
+  public HeaderExtractor getHeaderExtractor()
   {
     return new HeaderExtractorImpl();
   }
 
-  protected RequestTokenExtractor getRequestTokenExtractor()
+  /**
+   * Returns the request token extractor.
+   * 
+   * @return request token extractor
+   */
+  public RequestTokenExtractor getRequestTokenExtractor()
   {
     return new TokenExtractorImpl();
   }
 
-  protected SignatureService getSignatureService()
+  /**
+   * Returns the signature service.
+   * 
+   * @return signature service
+   */
+  public SignatureService getSignatureService()
   {
     return new HMACSha1SignatureService(); 
   }
 
-  protected TimestampService getTimestampService()
+  /**
+   * Returns the timestamp service.
+   * 
+   * @return timestamp service
+   */
+  public TimestampService getTimestampService()
   {
     return new TimestampServiceImpl();
   }
   
-  protected Verb getAccessTokenVerb()
+  /**
+   * Returns the verb for the access token endpoint (defaults to POST)
+   * 
+   * @return access token endpoint verb
+   */
+  public Verb getAccessTokenVerb()
   {
     return Verb.POST;
   }
   
-  protected Verb getRequestTokenVerb()
+  /**
+   * Returns the verb for the request token endpoint (defaults to POST)
+   * 
+   * @return request token endpoint verb
+   */
+  public Verb getRequestTokenVerb()
   {
     return Verb.POST;
   }
@@ -63,14 +108,23 @@ public abstract class DefaultApi10a implements Api
    * 
    * @return request token URL
    */
-  protected abstract String getRequestTokenEndpoint();
+  public abstract String getRequestTokenEndpoint();
   
   /**
    * Returns the URL that receives the access token requests.
    * 
    * @return access token URL
    */
-  protected abstract String getAccessTokenEndpoint();
+  public abstract String getAccessTokenEndpoint();
+  
+  /**
+   * Returns the URL where you should redirect your users to authenticate
+   * your application.
+   * 
+   * @param requestToken the request token you need to authorize
+   * @return the URL where you should redirect your users
+   */
+  public abstract String getAuthorizationUrl(Token requestToken);
   
   /**
    * Returns the {@link OAuthService} for this Api
@@ -80,35 +134,15 @@ public abstract class DefaultApi10a implements Api
    * @param callback OAuth callback (either URL or 'oob')
    * @param scope OAuth scope (optional) 
    */
-  public OAuthService createService(String apiKey, String apiSecret, String callback, String scope)
+  public OAuthService createService(OAuthConfig config, String scope)
   {
-    OAuthService service = createService(apiKey, apiSecret, callback);
+    OAuthService service = doCreateService(config);
     service.addScope(scope);
     return service;
   }
   
-  private OAuthService createService(String apiKey, String apiSecret, String callback)
+  private OAuthService doCreateService(OAuthConfig config)
   {
-    return new OAuth10aServiceImpl( getSignatureService(), 
-                                    getTimestampService(), 
-                                    getBaseStringExtractor(), 
-                                    getHeaderExtractor(), 
-                                    getRequestTokenExtractor(), 
-                                    getAccessTokenExtractor(), 
-                                    createConfig(apiKey, apiSecret, callback));
+    return new OAuth10aServiceImpl(this, config);
   }
-  
-  private OAuthConfig createConfig(String apiKey, String apiSecret, String callback)
-  {
-    OAuthConfig config = new OAuthConfig();
-    config.setRequestTokenVerb(getRequestTokenVerb());
-    config.setRequestTokenEndpoint(getRequestTokenEndpoint());
-    config.setAccessTokenVerb(getAccessTokenVerb());
-    config.setAccessTokenEndpoint(getAccessTokenEndpoint());
-    config.setApiKey(apiKey);
-    config.setApiSecret(apiSecret);
-    config.setCallback(callback);
-    return config;
-  }
-
 }

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

@@ -0,0 +1,42 @@
+package org.scribe.builder.api;
+
+import org.scribe.model.*;
+import org.scribe.oauth.*;
+
+/**
+ * Default implementation of the OAuth protocol, version 2.0 (draft 11)
+ *
+ * This class is meant to be extended by concrete implementations of the API,
+ * providing the endpoints and endpoint-http-verbs.
+ *
+ * If your Api adheres to the 2.0 (draft 11) protocol correctly, you just need to extend
+ * this class and define the getters for your endpoints.
+ *
+ * If your Api does something a bit different, you can override the different
+ * extractors or services, in order to fine-tune the process. Please read the
+ * javadocs of the interfaces to get an idea of what to do.
+ *
+ * @author Diego Silveira
+ *
+ */
+public abstract class DefaultApi20 implements Api
+{
+
+  /**
+   * Returns the URL where you should redirect your users to authenticate
+   * your application.
+   *
+   * @param config OAuth 2.0 configuration param object
+   * @return the URL where you should redirect your users
+   */
+  public abstract String getAuthorizationUrl(OAuthConfig config);
+
+  /**
+   * {@inheritDoc}
+   */
+  public OAuthService createService(OAuthConfig config, String scope)
+  {
+    return new OAuth20ServiceImpl(this, config);
+  }
+
+}

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

@@ -1,11 +1,14 @@
 package org.scribe.builder.api;
 
+import org.scribe.model.Token;
 import org.scribe.model.Verb;
 
 public class EvernoteApi extends DefaultApi10a
 {
+  private static final String AUTHORIZATION_URL = "https://www.evernote.com/OAuth.action?oauth_token=%s";
+  
   @Override
-  protected Verb getRequestTokenVerb()
+  public Verb getRequestTokenVerb()
   {
     return Verb.GET;
   }
@@ -17,7 +20,7 @@ public class EvernoteApi extends DefaultApi10a
 	}
 
 	@Override
-	protected Verb getAccessTokenVerb()
+	public Verb getAccessTokenVerb()
 	{
 	  return Verb.GET;
 	}
@@ -27,4 +30,33 @@ public class EvernoteApi extends DefaultApi10a
 	{
 		return "https://www.evernote.com/oauth";
 	}
+	
+	@Override
+	public String getAuthorizationUrl(Token requestToken)
+	{
+	  return String.format(AUTHORIZATION_URL, requestToken.getToken());
+	}
+
+	public static class Sandbox extends EvernoteApi
+	{
+	  private static final String SANDBOX_URL = "https://sandbox.evernote.com/oauth";
+
+	  @Override
+	  public String getRequestTokenEndpoint()
+	  {
+	    return SANDBOX_URL;
+	  }
+
+	  @Override
+	  public String getAccessTokenEndpoint()
+	  {
+	    return SANDBOX_URL;
+	  }
+
+	  @Override
+	  public String getAuthorizationUrl(Token requestToken)
+	  {
+	    return String.format(SANDBOX_URL + "?oauth_token=%s", requestToken.getToken());
+	  }
+	}
 }

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

@@ -0,0 +1,16 @@
+package org.scribe.builder.api;
+
+import org.scribe.model.*;
+import org.scribe.utils.*;
+
+public class FacebookApi extends DefaultApi20
+{
+  private static final String AUTHORIZE_URL = "https://graph.facebook.com/oauth/authorize?response_type=token&client_id=%s&redirect_uri=%s";
+
+  @Override
+  public String getAuthorizationUrl(OAuthConfig config)
+  {
+    Preconditions.checkValidUrl(config.getCallback(), "Must provide a valid url as callback. Facebook does not support OOB");
+    return String.format(AUTHORIZE_URL, config.getApiKey(), URLUtils.percentEncode(config.getCallback()));
+  }
+}

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

@@ -1,16 +1,26 @@
 package org.scribe.builder.api;
 
+import org.scribe.model.Token;
+
 public class FoursquareApi extends DefaultApi10a
 {
+  private static final String AUTHORIZATION_URL = "http://foursquare.com/oauth/authorize?oauth_token=%s";
+  
   @Override
-  protected String getAccessTokenEndpoint()
+  public String getAccessTokenEndpoint()
   {
     return "http://foursquare.com/oauth/access_token";
   }
 
   @Override
-  protected String getRequestTokenEndpoint()
+  public String getRequestTokenEndpoint()
   {
     return "http://foursquare.com/oauth/request_token";
   }
+  
+  @Override
+  public String getAuthorizationUrl(Token requestToken)
+  {
+    return String.format(AUTHORIZATION_URL, requestToken.getToken());
+  }
 }

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

@@ -1,16 +1,38 @@
 package org.scribe.builder.api;
 
+import org.scribe.model.*;
+
 public class GoogleApi extends DefaultApi10a
 {
+  private static final String AUTHORIZATION_URL = "https://www.google.com/accounts/OAuthAuthorizeToken?oauth_token=%s";
+  
   @Override
-  protected String getAccessTokenEndpoint()
+  public String getAccessTokenEndpoint()
   {
     return "https://www.google.com/accounts/OAuthGetAccessToken"; 
   }
 
   @Override
-  protected String getRequestTokenEndpoint()
+  public String getRequestTokenEndpoint()
   {
     return "https://www.google.com/accounts/OAuthGetRequestToken";
   }
+
+  @Override
+  public Verb getAccessTokenVerb()
+  {
+    return Verb.GET;
+  }
+
+  @Override
+  public Verb getRequestTokenVerb()
+  {
+    return Verb.GET;
+  }
+  
+  @Override
+  public String getAuthorizationUrl(Token requestToken)
+  {
+    return String.format(AUTHORIZATION_URL, requestToken.getToken());
+  }
 }

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

@@ -1,16 +1,27 @@
 package org.scribe.builder.api;
 
+import org.scribe.model.*;
+
 public class LinkedInApi extends DefaultApi10a
 {
+  private static final String AUTHORIZE_URL = "https://api.linkedin.com/uas/oauth/authorize?oauth_token=%s";
+
   @Override
-  protected String getAccessTokenEndpoint()
+  public String getAccessTokenEndpoint()
   {
     return "https://api.linkedin.com/uas/oauth/accessToken";
   }
 
   @Override
-  protected String getRequestTokenEndpoint()
+  public String getRequestTokenEndpoint()
   {
     return "https://api.linkedin.com/uas/oauth/requestToken";
   }
+  
+  @Override
+  public String getAuthorizationUrl(Token requestToken)
+  {
+    return String.format(AUTHORIZE_URL, requestToken.getToken());
+  }
+  
 }

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

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

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

@@ -1,16 +1,26 @@
 package org.scribe.builder.api;
 
+import org.scribe.model.Token;
+
 public class VimeoApi extends DefaultApi10a
 {
+  private static final String AUTHORIZATION_URL = "http://vimeo.com/oauth/authorize?oauth_token=%s";
+  
   @Override
-  protected String getAccessTokenEndpoint()
+  public String getAccessTokenEndpoint()
   {
     return "http://vimeo.com/oauth/access_token";
   }
 
   @Override
-  protected String getRequestTokenEndpoint()
+  public String getRequestTokenEndpoint()
   {
     return "http://vimeo.com/oauth/request_token";
   }
+  
+  @Override
+  public String getAuthorizationUrl(Token requestToken)
+  {
+    return String.format(AUTHORIZATION_URL, requestToken.getToken());
+  }
 }

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

@@ -1,16 +1,26 @@
 package org.scribe.builder.api;
 
+import org.scribe.model.Token;
+
 public class YahooApi extends DefaultApi10a
 {
+  private static final String AUTHORIZE_URL = "https://api.login.yahoo.com/oauth/v2/request_auth?oauth_token=%s";
+  
   @Override
-  protected String getAccessTokenEndpoint()
+  public String getAccessTokenEndpoint()
   {
     return "https://api.login.yahoo.com/oauth/v2/get_token";
   }
 
   @Override
-  protected String getRequestTokenEndpoint()
+  public String getRequestTokenEndpoint()
   {
     return "https://api.login.yahoo.com/oauth/v2/get_request_token";
   }
+  
+  @Override
+  public String getAuthorizationUrl(Token requestToken)
+  {
+    return String.format(AUTHORIZE_URL, requestToken.getToken());
+  }
 }

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

@@ -1,7 +1,10 @@
 package org.scribe.builder.api;
 
+import org.scribe.model.Token;
+
 public class YammerApi extends DefaultApi10a
 {
+  private static final String AUTHORIZATION_URL = "'https://www.yammer.com/oauth/authorize?oauth_token=%s'";
 
 	@Override
 	public String getRequestTokenEndpoint()
@@ -15,4 +18,9 @@ public class YammerApi extends DefaultApi10a
 		return "https://www.yammer.com/oauth/access_token";
 	}
 	
+	@Override
+	public String getAuthorizationUrl(Token requestToken)
+	{
+	  return String.format(AUTHORIZATION_URL, requestToken.getToken());
+	}
 }

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

@@ -10,10 +10,18 @@ public class OAuthConfig
   private String apiKey;
   private String apiSecret;
   private String callback;
-  private String requestTokenEndpoint;
-  private String accessTokenEndpoint;
-  private Verb requestTokenVerb;
-  private Verb accessTokenVerb;
+  
+  public OAuthConfig(String key, String secret)
+  {
+    this(key,secret,null);
+  }
+  
+  public OAuthConfig(String key, String secret, String callback)
+  {
+    this.apiKey = key;
+    this.apiSecret = secret;
+    this.callback = callback;
+  }
 
   public String getApiKey()
   {
@@ -44,45 +52,4 @@ public class OAuthConfig
   {
     this.callback = callback;
   }
-
-  public String getRequestTokenEndpoint()
-  {
-    return requestTokenEndpoint;
-  }
-
-  public void setRequestTokenEndpoint(String requestTokenEndpoint)
-  {
-    this.requestTokenEndpoint = requestTokenEndpoint;
-  }
-
-  public String getAccessTokenEndpoint()
-  {
-    return accessTokenEndpoint;
-  }
-
-  public void setAccessTokenEndpoint(String accessTokenEndpoint)
-  {
-    this.accessTokenEndpoint = accessTokenEndpoint;
-  }
-
-  public Verb getRequestTokenVerb()
-  {
-    return requestTokenVerb != null ? requestTokenVerb : Verb.GET;
-  }
-
-  public void setRequestTokenVerb(Verb requestTokenVerb)
-  {
-    this.requestTokenVerb = requestTokenVerb;
-  }
-
-  public Verb getAccessTokenVerb()
-  {
-    return accessTokenVerb != null ? accessTokenVerb : Verb.GET;
-  }
-
-  public void setAccessTokenVerb(Verb accessTokenVerb)
-  {
-    this.accessTokenVerb = accessTokenVerb;
-  }
-
 }

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

@@ -38,4 +38,7 @@ public class OAuthConstants
   public static final String HEADER = "Authorization";
   public static final Token EMPTY_TOKEN = new Token("", "");
   public static final String SCOPE = "scope";
+
+  //OAuth 2.0
+  public static final String ACCESS_TOKEN = "access_token";
 }

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

@@ -19,6 +19,7 @@ class Request
 
   private String url;
   private Verb verb;
+  private Map<String, String> querystringParams;
   private Map<String, String> bodyParams;
   private Map<String, String> headers;
   private String payload = null;
@@ -34,15 +35,9 @@ class Request
   {
     this.verb = verb;
     this.url = url;
+    this.querystringParams = new HashMap<String, String>();
     this.bodyParams = new HashMap<String, String>();
     this.headers = new HashMap<String, String>();
-    try
-    {
-      connection = (HttpURLConnection) new URL(url).openConnection();
-    } catch (IOException ioe)
-    {
-      throw new OAuthException("Could not open connection to: " + url, ioe);
-    }
   }
 
   /**
@@ -56,6 +51,7 @@ class Request
   {
     try
     {
+      createConnection();
       return doSend();
     } catch (IOException ioe)
     {
@@ -63,6 +59,15 @@ class Request
     }
   }
 
+  private void createConnection() throws IOException
+  {
+    String effectiveUrl = URLUtils.appendParametersToQueryString(url, querystringParams);
+    if (connection == null)
+    {
+      connection = (HttpURLConnection) new URL(effectiveUrl).openConnection();
+    }
+  }
+
   Response doSend() throws IOException
   {
     connection.setRequestMethod(this.verb.name());
@@ -109,6 +114,17 @@ class Request
     this.bodyParams.put(key, value);
   }
 
+  /**
+   * Add a QueryString parameter
+   *
+   * @param key the parameter name
+   * @param value the parameter value
+   */
+  public void addQuerystringParameter(String key, String value)
+  {
+    this.querystringParams.put(key, value);
+  }
+
   /**
    * Add body payload.
    * 
@@ -143,8 +159,10 @@ class Request
           params.put(pair[0], pair[1]);
         }
       }
+      params.putAll(querystringParams);
       return params;
-    } catch (MalformedURLException mue)
+    }
+    catch (MalformedURLException mue)
     {
       throw new OAuthException("Malformed URL", mue);
     }

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

@@ -1,12 +1,16 @@
 package org.scribe.model;
 
+import java.io.Serializable;
+
 /**
  * Represents an OAuth token (either request or access token) and its secret
  * 
  * @author Pablo Fernandez
  */
-public class Token
+public class Token implements Serializable
 {
+  private static final long serialVersionUID = 715000866082812683L;
+	
   private final String token;
   private final String secret;
 

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

@@ -1,5 +1,7 @@
 package org.scribe.model;
 
+import org.scribe.utils.*;
+
 /**
  * Represents an OAuth verifier code.
  * 
@@ -7,6 +9,7 @@ package org.scribe.model;
  */
 public class Verifier
 {
+
   private final String value;
 
   /**
@@ -16,7 +19,7 @@ public class Verifier
    */
   public Verifier(String value)
   {
-    this.value = value;
+    this.value = URLUtils.percentDecode(value);
   }
 
   public String getValue()

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

@@ -1,8 +1,7 @@
 package org.scribe.oauth;
 
-import org.scribe.extractors.*;
+import org.scribe.builder.api.*;
 import org.scribe.model.*;
-import org.scribe.services.*;
 
 /**
  * OAuth 1.0a implementation of {@link OAuthService}
@@ -15,34 +14,18 @@ public class OAuth10aServiceImpl implements OAuthService
   private static final String VERSION = "1.0";
 
   private OAuthConfig config;
-  private SignatureService signatureService;
-  private TimestampService timestampService;
-  private BaseStringExtractor baseStringExtractor;
-  private HeaderExtractor headerExtractor;
-  private RequestTokenExtractor rtExtractor;
-  private AccessTokenExtractor atExtractor;
+  private DefaultApi10a api;
   private String scope;
 
   /**
    * Default constructor
    * 
-   * @param signatureService OAuth 1.0a signature service
-   * @param timestampService OAuth 1.0a timestamp service
-   * @param baseStringExtractor OAuth 1.0a base string extractor
-   * @param headerExtractor OAuth 1.0a http header extractor
-   * @param rtExtractor OAuth 1.0a request token extractor
-   * @param atExtractor OAuth 1.0a access token extractor
+   * @param api OAuth1.0a api information
    * @param config OAuth 1.0a configuration param object
    */
-  public OAuth10aServiceImpl(SignatureService signatureService, TimestampService timestampService, BaseStringExtractor baseStringExtractor,
-      HeaderExtractor headerExtractor, RequestTokenExtractor rtExtractor, AccessTokenExtractor atExtractor, OAuthConfig config)
+  public OAuth10aServiceImpl(DefaultApi10a api, OAuthConfig config)
   {
-    this.signatureService = signatureService;
-    this.timestampService = timestampService;
-    this.baseStringExtractor = baseStringExtractor;
-    this.headerExtractor = headerExtractor;
-    this.rtExtractor = rtExtractor;
-    this.atExtractor = atExtractor;
+    this.api = api;
     this.config = config;
     this.scope = NO_SCOPE;
   }
@@ -52,19 +35,19 @@ public class OAuth10aServiceImpl implements OAuthService
    */
   public Token getRequestToken()
   {
-    OAuthRequest request = new OAuthRequest(config.getRequestTokenVerb(), config.getRequestTokenEndpoint());
+    OAuthRequest request = new OAuthRequest(api.getRequestTokenVerb(), api.getRequestTokenEndpoint());
     addOAuthParams(request, OAuthConstants.EMPTY_TOKEN);
     addOAuthHeader(request);
     Response response = request.send();
-    return rtExtractor.extract(response.getBody());
+    return api.getRequestTokenExtractor().extract(response.getBody());
   }
 
   private void addOAuthParams(OAuthRequest request, Token token)
   {
-    request.addOAuthParameter(OAuthConstants.TIMESTAMP, timestampService.getTimestampInSeconds());
-    request.addOAuthParameter(OAuthConstants.NONCE, timestampService.getNonce());
+    request.addOAuthParameter(OAuthConstants.TIMESTAMP, api.getTimestampService().getTimestampInSeconds());
+    request.addOAuthParameter(OAuthConstants.NONCE, api.getTimestampService().getNonce());
     request.addOAuthParameter(OAuthConstants.CONSUMER_KEY, config.getApiKey());
-    request.addOAuthParameter(OAuthConstants.SIGN_METHOD, signatureService.getSignatureMethod());
+    request.addOAuthParameter(OAuthConstants.SIGN_METHOD, api.getSignatureService().getSignatureMethod());
     request.addOAuthParameter(OAuthConstants.VERSION, getVersion());
     request.addOAuthParameter(OAuthConstants.CALLBACK, config.getCallback());
     if(scope != NO_SCOPE) request.addOAuthParameter(OAuthConstants.SCOPE, scope);
@@ -76,13 +59,13 @@ public class OAuth10aServiceImpl implements OAuthService
    */
   public Token getAccessToken(Token requestToken, Verifier verifier)
   {
-    OAuthRequest request = new OAuthRequest(config.getAccessTokenVerb(), config.getAccessTokenEndpoint());
+    OAuthRequest request = new OAuthRequest(api.getAccessTokenVerb(), api.getAccessTokenEndpoint());
     request.addOAuthParameter(OAuthConstants.TOKEN, requestToken.getToken());
     request.addOAuthParameter(OAuthConstants.VERIFIER, verifier.getValue());
     addOAuthParams(request, requestToken);
     addOAuthHeader(request);
     Response response = request.send();
-    return atExtractor.extract(response.getBody());
+    return api.getAccessTokenExtractor().extract(response.getBody());
   }
 
   /**
@@ -111,15 +94,23 @@ public class OAuth10aServiceImpl implements OAuthService
     this.scope = scope;
   }
 
+  /**
+   * {@inheritDoc}
+   */
+  public String getAuthorizationUrl(Token requestToken)
+  {
+    return api.getAuthorizationUrl(requestToken);
+  }
+  
   private String getSignature(OAuthRequest request, Token token)
   {
-    String baseString = baseStringExtractor.extract(request);
-    return signatureService.getSignature(baseString, config.getApiSecret(), token.getSecret());
+    String baseString = api.getBaseStringExtractor().extract(request);
+    return api.getSignatureService().getSignature(baseString, config.getApiSecret(), token.getSecret());
   }
 
   private void addOAuthHeader(OAuthRequest request)
   {
-    String oauthHeader = headerExtractor.extract(request);
+    String oauthHeader = api.getHeaderExtractor().extract(request);
     request.addHeader(OAuthConstants.HEADER, oauthHeader);
   }
 }

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

@@ -0,0 +1,73 @@
+package org.scribe.oauth;
+
+import org.scribe.builder.api.*;
+import org.scribe.model.*;
+
+public class OAuth20ServiceImpl implements OAuthService
+{
+  private static final String VERSION = "2.0";
+  
+  private final DefaultApi20 api;
+  private final OAuthConfig config;
+  
+  /**
+   * Default constructor
+   * 
+   * @param api OAuth2.0 api information
+   * @param config OAuth 2.0 configuration param object
+   */
+  public OAuth20ServiceImpl(DefaultApi20 api, OAuthConfig config)
+  {
+    this.api = api;
+    this.config = config;
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public void addScope(String scope)
+  {
+    throw new UnsupportedOperationException("OAuth 2 does not use scopes");
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public Token getAccessToken(Token requestToken, Verifier verifier)
+  {
+    throw new UnsupportedOperationException("Unsupported operation, please use 'getAuthorizationUrl' and redirect your users there");
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public Token getRequestToken()
+  {
+    throw new UnsupportedOperationException("Unsupported operation, please use 'getAuthorizationUrl' and redirect your users there");
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public String getVersion()
+  {
+    return VERSION;
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public void signRequest(Token accessToken, OAuthRequest request)
+  {
+    request.addQuerystringParameter(OAuthConstants.ACCESS_TOKEN, accessToken.getToken());
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public String getAuthorizationUrl(Token requestToken)
+  {
+    return api.getAuthorizationUrl(config);
+  }
+
+}

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

@@ -48,4 +48,13 @@ public interface OAuthService
    * @param scope OAuth Api scope (optional)
    */
   public void addScope(String scope);
+  
+  /**
+   * Returns the URL where you should redirect your users to authenticate
+   * your application.
+   * 
+   * @param requestToken the request token you need to authorize
+   * @return the URL where you should redirect your users
+   */
+  public String getAuthorizationUrl(Token requestToken);
 }

src/main/java/org/scribe/services/HMACSha1SignatureService.java

@@ -30,7 +30,7 @@ public class HMACSha1SignatureService implements SignatureService
     {
       Preconditions.checkEmptyString(baseString, "Base string cant be null or empty string");
       Preconditions.checkEmptyString(apiSecret, "Api secret cant be null or empty string");
-      return doSign(baseString, apiSecret + '&' + tokenSecret);
+      return doSign(baseString, URLUtils.percentEncode(apiSecret) + '&' + URLUtils.percentEncode(tokenSecret));
     } 
     catch (Exception e)
     {

src/main/java/org/scribe/utils/StreamUtils.java

@@ -36,7 +36,7 @@ public class StreamUtils
       return out.toString();
     } catch (IOException ioe)
     {
-      throw new RuntimeException("Error while reading response body", ioe);
+      throw new IllegalStateException("Error while reading response body", ioe);
     }
   }
 }

src/main/java/org/scribe/utils/URLUtils.java

@@ -4,8 +4,6 @@ import java.io.*;
 import java.net.*;
 import java.util.*;
 
-import org.scribe.exceptions.*;
-
 /**
  * Utils to deal with URL and url-encodings
  *
@@ -17,6 +15,7 @@ public class URLUtils
   private static final String UTF_8 = "UTF-8";
   private static final char PAIR_SEPARATOR = '=';
   private static final char PARAM_SEPARATOR = '&';
+  private static final char QUERY_STRING_SEPARATOR = '?';
 
   private static final String ERROR_MSG = String.format("Cannot find specified encoding: %s", UTF_8);
 
@@ -77,7 +76,7 @@ public class URLUtils
     } 
     catch (UnsupportedEncodingException uee)
     {
-      throw new OAuthException(ERROR_MSG, uee);
+      throw new IllegalStateException(ERROR_MSG, uee);
     }
   }
 
@@ -96,10 +95,29 @@ public class URLUtils
     }
     catch (UnsupportedEncodingException uee)
     {
-      throw new OAuthException(ERROR_MSG, uee);
+      throw new IllegalStateException(ERROR_MSG, uee);
     }
   }
 
+  /**
+   * Append given parameters to the query string of the url
+   *
+   * @param url the url to append parameters to
+   * @param params any map
+   * @return new url with parameters on query string
+   */
+  public static String appendParametersToQueryString(String url, Map<String, String> params)
+  {
+    Preconditions.checkNotNull(url, "Cannot append to null URL");
+    String queryString = URLUtils.formURLEncodeMap(params);
+    if (queryString.isEmpty()) return url;
+
+    // Check if there are parameters in the url already and use '&' instead of '?'
+    url += url.indexOf(QUERY_STRING_SEPARATOR) != -1 ? PARAM_SEPARATOR : QUERY_STRING_SEPARATOR;
+    url += queryString;
+    return url;
+  }
+
   private static final class EncodingRule
   {
     private final String ch;

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

@@ -0,0 +1,66 @@
+package org.scribe.builder;
+
+import static org.junit.Assert.*;
+
+import org.junit.*;
+import org.scribe.builder.api.*;
+import org.scribe.model.*;
+import org.scribe.oauth.*;
+
+public class ServiceBuilderTest
+{
+  private ServiceBuilder builder;
+
+  @Before
+  public void setup()
+  {
+    builder = new ServiceBuilder();
+  }
+
+  @Test
+  public void shouldReturnOOBasDefaultCallback()
+  {
+    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);
+  }
+
+  @Test
+  public void shouldAcceptValidCallbackUrl()
+  {
+    builder.provider(ApiMock.class).apiKey("key").apiSecret("secret").callback("http://example.com").build();
+    assertEquals(ApiMock.config.getApiKey(), "key");
+    assertEquals(ApiMock.config.getApiSecret(), "secret");
+    assertEquals(ApiMock.config.getCallback(), "http://example.com");
+  }
+
+  @Test(expected=IllegalArgumentException.class)
+  public void shouldNotAcceptAnInvalidUrlAsCallback()
+  {
+    builder.provider(ApiMock.class).apiKey("key").apiSecret("secret").callback("example.com").build(); 
+  }
+
+  @Test
+  public void shouldAcceptAnScope()
+  {
+    builder.provider(ApiMock.class).apiKey("key").apiSecret("secret").scope("rss-api").build();
+    assertEquals(ApiMock.config.getApiKey(), "key");
+    assertEquals(ApiMock.config.getApiSecret(), "secret");
+    assertEquals(ApiMock.scope, "rss-api");
+  }
+
+  public static class ApiMock implements Api
+  {
+    public static OAuthConfig config;
+    public static String scope;
+    
+    @Override
+    public OAuthService createService(OAuthConfig config, String scope)
+    {
+      ApiMock.config = config;
+      ApiMock.scope = scope;
+      return null;
+    }
+  }
+}

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

@@ -0,0 +1,58 @@
+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 FacebookExample
+{
+  private static final String NETWORK_NAME = "Facebook";
+  private static final String PROTECTED_RESOURCE_URL = "https://graph.facebook.com/me";
+  private static final String NO_SECRET_NEEDED = "";
+  private static final Token EMPTY_TOKEN = null;
+
+  public static void main(String[] args)
+  {
+    // Replace these with your own api key and secret
+    String apiKey = "your_api_key";
+    String apiSecret = "your_api_secret";
+    OAuthService service = new ServiceBuilder()
+                                  .provider(FacebookApi.class)
+                                  .apiKey(apiKey)
+                                  .apiSecret(apiSecret)
+                                  .callback("http://www.example.com/oauth_callback/")
+                                  .build();
+    Scanner in = new Scanner(System.in);
+
+    System.out.println("=== " + NETWORK_NAME + "'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 access token here");
+    System.out.print(">>");
+    Token accessToken = new Token(in.nextLine(), NO_SECRET_NEEDED);
+    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/examples/FoursquareExample.java

@@ -9,7 +9,6 @@ import org.scribe.oauth.*;
 
 public class FoursquareExample
 {
-  private static final String AUTHORIZE_URL = "http://foursquare.com/oauth/authorize?oauth_token=";
   private static final String PROTECTED_RESOURCE_URL = "http://api.foursquare.com/v1/user";
   
   public static void main(String[] args)
@@ -31,7 +30,7 @@ public class FoursquareExample
     System.out.println();
 
     System.out.println("Now go and authorize Scribe here:");
-    System.out.println(AUTHORIZE_URL + requestToken.getToken());
+    System.out.println(service.getAuthorizationUrl(requestToken));
     System.out.println("And paste the verifier here");
     System.out.print(">>");
     Verifier verifier = new Verifier(in.nextLine());

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

@@ -9,7 +9,6 @@ import org.scribe.oauth.*;
 
 public class LinkedInExample
 {
-  private static final String AUTHORIZE_URL = "https://api.linkedin.com/uas/oauth/authorize?oauth_token=";
   private static final String PROTECTED_RESOURCE_URL = "http://api.linkedin.com/v1/people/~/connections:(id,last-name)";
   
   public static void main(String[] args)
@@ -19,8 +18,8 @@ public class LinkedInExample
                                 .apiKey("CiEgwWDkA5BFpNrc0RfGyVuSlOh4tig5kOTZ9q97qcXNrFl7zqk-Ts7DqRGaKDCV")
                                 .apiSecret("dhho4dfoCmiQXrkw4yslork5XWLFnPSuMR-8gscPVjY4jqFFHPYWJKgpFl4uLTM6")
                                 .build();
-    
     Scanner in = new Scanner(System.in);
+    
     System.out.println("=== LinkedIn's OAuth Workflow ===");
     System.out.println();
 
@@ -31,7 +30,7 @@ public class LinkedInExample
     System.out.println();
 
     System.out.println("Now go and authorize Scribe here:");
-    System.out.println(AUTHORIZE_URL + requestToken.getToken());
+    System.out.println(service.getAuthorizationUrl(requestToken));
     System.out.println("And paste the verifier here");
     System.out.print(">>");
     Verifier verifier = new Verifier(in.nextLine());

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

@@ -9,7 +9,6 @@ import org.scribe.oauth.*;
 
 public class TwitterExample
 {
-  private static final String AUTHORIZE_URL = "https://api.twitter.com/oauth/authorize?oauth_token=";
   private static final String PROTECTED_RESOURCE_URL = "http://api.twitter.com/1/account/verify_credentials.xml";
   
   public static void main(String[] args)
@@ -31,7 +30,7 @@ public class TwitterExample
     System.out.println();
 
     System.out.println("Now go and authorize Scribe here:");
-    System.out.println(AUTHORIZE_URL + requestToken.getToken());
+    System.out.println(service.getAuthorizationUrl(requestToken));
     System.out.println("And paste the verifier here");
     System.out.print(">>");
     Verifier verifier = new Verifier(in.nextLine());

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

@@ -9,8 +9,6 @@ import org.scribe.oauth.*;
 
 public class YahooExample
 {
-  private static final String NETWORK_NAME = "Yahoo";
-  private static final String AUTHORIZE_URL = "https://api.login.yahoo.com/oauth/v2/request_auth?oauth_token=";
   private static final String PROTECTED_RESOURCE_URL = "http://social.yahooapis.com/v1/user/A6ROU63MXWDCW3Y5MGCYWVHDJI/profile/status?format=json";
 
   public static void main(String[] args)
@@ -22,7 +20,7 @@ public class YahooExample
                                 .build();
     Scanner in = new Scanner(System.in);
 
-    System.out.println("=== " + NETWORK_NAME + "'s OAuth Workflow ===");
+    System.out.println("=== Yahoo's OAuth Workflow ===");
     System.out.println();
 
     // Obtain the Request Token
@@ -32,7 +30,7 @@ public class YahooExample
     System.out.println();
 
     System.out.println("Now go and authorize Scribe here:");
-    System.out.println(AUTHORIZE_URL + requestToken.getToken());
+    System.out.println(service.getAuthorizationUrl(requestToken));
     System.out.println("And paste the verifier here");
     System.out.print(">>");
     Verifier verifier = new Verifier(in.nextLine());

src/test/java/org/scribe/model/OAuthConfigTest.java

@@ -10,22 +10,17 @@ public class OAuthConfigTest
   @Test
   public void shouldReturnDefaultValuesIfNotSet()
   {
-    OAuthConfig config = new OAuthConfig();
-    assertEquals(Verb.GET, config.getAccessTokenVerb());
-    assertEquals(Verb.GET, config.getRequestTokenVerb());
+    OAuthConfig config = new OAuthConfig("key", "secret");
     assertEquals(OAuthConstants.OUT_OF_BAND, config.getCallback());
   }
 
   @Test
   public void shouldOverrideDefaultsIfSet()
   {
-    OAuthConfig config = new OAuthConfig();
-    config.setCallback("http://callback");
-    config.setAccessTokenVerb(Verb.POST);
-    config.setRequestTokenVerb(Verb.POST);
+    OAuthConfig config = new OAuthConfig("key", "secret", "http://callback");
     assertEquals("http://callback", config.getCallback());
-    assertEquals(Verb.POST, config.getAccessTokenVerb());
-    assertEquals(Verb.POST, config.getRequestTokenVerb());
+    assertEquals("key", config.getApiKey());
+    assertEquals("secret", config.getApiSecret());
   }
 
 }

src/test/java/org/scribe/model/RequestTest.java

@@ -65,4 +65,13 @@ public class RequestTest
     assertTrue(connection.getHeaders().containsKey("Content-Length"));
   }
 
+  @Test
+  public void shouldAllowAddingQuerystringParametersAfterCreation()
+  {
+    Request request = new Request(Verb.GET, "http://example.com?one=val");
+    request.addQuerystringParameter("two", "other val");
+    request.addQuerystringParameter("more", "params");
+    assertEquals(3, request.getQueryStringParams().size());
+  }
+
 }

src/test/java/org/scribe/model/VerifierTest.java

@@ -0,0 +1,21 @@
+package org.scribe.model;
+
+import static org.junit.Assert.*;
+
+import org.junit.*;
+
+public class VerifierTest
+{
+  @Test
+  public void shouldParse()
+  {
+    Verifier verifier = new Verifier("p8k%2BGIjIL9PblXq%2BpH6LmT9l");
+    assertEquals(verifier.getValue(), "p8k+GIjIL9PblXq+pH6LmT9l");
+  }
+
+  @Test(expected = IllegalArgumentException.class)
+  public void shouldThrowErrorForNullString()
+  {
+    new Verifier(null);
+  }
+}

src/test/java/org/scribe/services/HMACSha1SignatureServiceTest.java

@@ -3,7 +3,7 @@ package org.scribe.services;
 import static org.junit.Assert.*;
 
 import org.junit.*;
-import org.scribe.exceptions.OAuthException;
+import org.scribe.exceptions.*;
 
 public class HMACSha1SignatureServiceTest
 {
@@ -29,7 +29,7 @@ public class HMACSha1SignatureServiceTest
     String apiSecret = "api secret";
     String tokenSecret = "token secret";
     String baseString = "base string";
-    String signature = "cyxvUDZY/5cQBcBiKulaNgnhN/w=";
+    String signature = "uGymw2KHOTWI699YEaoi5xyLT50=";
     assertEquals(signature, service.getSignature(baseString, apiSecret, tokenSecret));
   }
 

src/test/java/org/scribe/utils/URLUtilsTest.java

@@ -82,4 +82,49 @@ public class URLUtilsTest
     URLUtils.percentDecode(toDecode);
   }
 
+  @Test(expected = IllegalArgumentException.class)
+  public void shouldThrowExceptionWhenAppendingNullMapToQuerystring()
+  {
+    String url = "http://www.example.com";
+    Map<String, String> nullMap = null;
+    URLUtils.appendParametersToQueryString(url, nullMap);
+  }
+
+  @Test
+  public void shouldAppendNothingToQuerystringIfGivenEmptyMap()
+  {
+    String url = "http://www.example.com";
+    Map<String, String> emptyMap = new HashMap<String, String>();
+    String newUrl = URLUtils.appendParametersToQueryString(url, emptyMap);
+    Assert.assertEquals(url, newUrl);
+  }
+
+  @Test
+  public void shouldAppendParametersToSimpleUrl()
+  {
+    String url = "http://www.example.com";
+    String expectedUrl = "http://www.example.com?param1=value1&param2=value%20with%20spaces";
+
+    Map<String, String> params = new HashMap<String, String>();
+    params.put("param1", "value1");
+    params.put("param2", "value with spaces");
+
+    url = URLUtils.appendParametersToQueryString(url, params);
+    Assert.assertEquals(url, expectedUrl);
+  }
+
+  @Test
+  public void shouldAppendParametersToUrlWithQuerystring()
+  {
+    String url = "http://www.example.com?already=present";
+    String expectedUrl = "http://www.example.com?already=present&param1=value1&param2=value%20with%20spaces";
+
+    Map<String, String> params = new HashMap<String, String>();
+    params.put("param1", "value1");
+    params.put("param2", "value with spaces");
+
+    url = URLUtils.appendParametersToQueryString(url, params);
+    Assert.assertEquals(url, expectedUrl);
+  }
+
 }