bounced version numbers for release

README.textile

@@ -61,7 +61,7 @@ You can pull scribe from a maven repository, just add this to your __pom.xml__ f
 @<dependency>@
   @<groupId>org.scribe</groupId>@
   @<artifactId>scribe</artifactId>@
-  @<version>1.1.2</version>@
+  @<version>1.2.0</version>@
 @</dependency>@
 
 h1. Getting started in less than 2 minutes

changelog.txt

@@ -44,3 +44,9 @@
   * 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)
+
+[1.2]
+  * REFACTOR: Moved scope inside OAuthConfig (breaks backwards compatibility)
+  * FEATURE: Added scopes to Facebook 2.0 Api
+  * FEATURE: Added Plaintext signature for Yammer
+  * FEATURE: Added Twitter SSL endpoints (use TwitterApi.SSL.class)

pom.xml

@@ -4,7 +4,7 @@
   <groupId>org.scribe</groupId>
   <artifactId>scribe</artifactId>
   <packaging>jar</packaging>
-  <version>1.1.2</version>
+  <version>1.2.0</version>
   <name>Scribe OAuth Library</name>
   <description>The best OAuth library out there</description>
   <url>http://github.com/fernandezpablo85/scribe-java</url>

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

@@ -147,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, signatureType), scope);
+    return api.createService(new OAuthConfig(apiKey, apiSecret, callback, signatureType, scope));
   }
 }

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

@@ -21,5 +21,5 @@ public interface Api
    * 
    * @return fully configured {@link OAuthService}
    */
-  OAuthService createService(OAuthConfig config, String scope);
+  OAuthService createService(OAuthConfig config);
 }

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

@@ -134,14 +134,7 @@ public abstract class DefaultApi10a implements Api
    * @param callback OAuth callback (either URL or 'oob')
    * @param scope OAuth scope (optional) 
    */
-  public OAuthService createService(OAuthConfig config, String scope)
-  {
-    OAuthService service = doCreateService(config);
-    service.addScope(scope);
-    return service;
-  }
-  
-  private OAuthService doCreateService(OAuthConfig config)
+  public OAuthService createService(OAuthConfig config)
   {
     return new OAuth10aServiceImpl(this, config);
   }

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

@@ -62,7 +62,7 @@ public abstract class DefaultApi20 implements Api
   /**
    * {@inheritDoc}
    */
-  public OAuthService createService(OAuthConfig config, String scope)
+  public OAuthService createService(OAuthConfig config)
   {
     return new OAuth20ServiceImpl(this, config);
   }

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

@@ -1,22 +1,34 @@
 package org.scribe.builder.api;
 
 import org.scribe.model.*;
+
 import org.scribe.utils.*;
+import static org.scribe.utils.URLUtils.*;
 
 public class FacebookApi extends DefaultApi20
 {
   private static final String AUTHORIZE_URL = "https://www.facebook.com/dialog/oauth?client_id=%s&redirect_uri=%s";
+  private static final String SCOPED_AUTHORIZE_URL = AUTHORIZE_URL + "&scope=%s";
 
   @Override
   public String getAccessTokenEndpoint()
   {
     return "https://graph.facebook.com/oauth/access_token";
   }
-  
+
   @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.formURLEncode(config.getCallback()));
+
+    // Append scope if present
+    if(config.hasScope())
+    {
+     return String.format(SCOPED_AUTHORIZE_URL, config.getApiKey(), formURLEncode(config.getCallback()), formURLEncode(config.getScope())); 
+    }
+    else
+    {
+      return String.format(AUTHORIZE_URL, config.getApiKey(), formURLEncode(config.getCallback()));
+    }
   }
 }

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

@@ -5,22 +5,39 @@ 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";
+  private static final String REQUEST_TOKEN_RESOURCE = "api.twitter.com/oauth/request_token";
+  private static final String ACCESS_TOKEN_RESOURCE = "api.twitter.com/oauth/access_token";
   
   @Override
   public String getAccessTokenEndpoint()
   {
-    return "http://api.twitter.com/oauth/access_token";
+    return "http://" + ACCESS_TOKEN_RESOURCE;
   }
 
   @Override
   public String getRequestTokenEndpoint()
   {
-    return "http://api.twitter.com/oauth/request_token";
+    return "http://" + REQUEST_TOKEN_RESOURCE;
   }
-  
+
   @Override
   public String getAuthorizationUrl(Token requestToken)
   {
     return String.format(AUTHORIZE_URL, requestToken.getToken());
   }
+
+  public static class SSL extends TwitterApi
+  {
+    @Override
+    public String getAccessTokenEndpoint()
+    {
+      return "https://" + ACCESS_TOKEN_RESOURCE;
+    }
+
+    @Override
+    public String getRequestTokenEndpoint()
+    {
+      return "https://" + REQUEST_TOKEN_RESOURCE;
+    }
+  }
 }

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

@@ -1,26 +1,33 @@
 package org.scribe.builder.api;
 
-import org.scribe.model.Token;
+import org.scribe.model.*;
+import org.scribe.services.*;
 
 public class YammerApi extends DefaultApi10a
 {
   private static final String AUTHORIZATION_URL = "'https://www.yammer.com/oauth/authorize?oauth_token=%s'";
 
-	@Override
-	public String getRequestTokenEndpoint()
+  @Override
+  public String getRequestTokenEndpoint()
   {
-		return "https://www.yammer.com/oauth/request_token";
-	}
+    return "https://www.yammer.com/oauth/request_token";
+  }
 
-	@Override
-	public String getAccessTokenEndpoint()
+  @Override
+  public String getAccessTokenEndpoint()
   {
-		return "https://www.yammer.com/oauth/access_token";
-	}
-	
-	@Override
-	public String getAuthorizationUrl(Token requestToken)
-	{
-	  return String.format(AUTHORIZATION_URL, requestToken.getToken());
-	}
+    return "https://www.yammer.com/oauth/access_token";
+  }
+
+  @Override
+  public String getAuthorizationUrl(Token requestToken)
+  {
+    return String.format(AUTHORIZATION_URL, requestToken.getToken());
+  }
+
+  @Override
+  public SignatureService getSignatureService()
+  {
+    return new PlaintextSignatureService();
+  }
 }

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

@@ -7,28 +7,24 @@ package org.scribe.model;
  */
 public class OAuthConfig
 {
-  private String apiKey;
-  private String apiSecret;
-  private String callback;
-  private SignatureType signatureType;
+  private final String apiKey;
+  private final String apiSecret;
+  private final String callback;
+  private final SignatureType signatureType;
+  private final String scope;
   
   public OAuthConfig(String key, String secret)
   {
-    this(key,secret,null);
+    this(key, secret, null, null, 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)
+  public OAuthConfig(String key, String secret, String callback, SignatureType type, String scope)
   {
     this.apiKey = key;
     this.apiSecret = secret;
-    this.callback = callback;
-    this.signatureType = type;
+    this.callback = callback != null ? callback : OAuthConstants.OUT_OF_BAND;
+    this.signatureType = (type != null) ? type : SignatureType.Header;
+    this.scope = scope;
   }
 
   public String getApiKey()
@@ -36,38 +32,28 @@ public class OAuthConfig
     return apiKey;
   }
 
-  public void setApiKey(String apiKey)
-  {
-    this.apiKey = apiKey;
-  }
-
   public String getApiSecret()
   {
     return apiSecret;
   }
 
-  public void setApiSecret(String apiSecret)
-  {
-    this.apiSecret = apiSecret;
-  }
-
   public String getCallback()
   {
-    return callback != null ? callback : OAuthConstants.OUT_OF_BAND;
-  }
-
-  public void setCallback(String callback)
-  {
-    this.callback = callback;
+    return callback;
   }
 
   public SignatureType getSignatureType()
   {
-    return signatureType != null ? signatureType : SignatureType.Header;
+    return signatureType;
   }
 
-  public void setSignatureType(SignatureType type)
+  public String getScope()
   {
-    this.signatureType = type;
+    return scope;
+  }
+
+  public boolean hasScope()
+  {
+    return scope != null;
   }
 }

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

@@ -12,12 +12,10 @@ import org.scribe.model.*;
  */
 public class OAuth10aServiceImpl implements OAuthService
 {
-  private static final String NO_SCOPE = null;
   private static final String VERSION = "1.0";
 
   private OAuthConfig config;
   private DefaultApi10a api;
-  private String scope;
 
   /**
    * Default constructor
@@ -29,7 +27,6 @@ public class OAuth10aServiceImpl implements OAuthService
   {
     this.api = api;
     this.config = config;
-    this.scope = NO_SCOPE;
   }
 
   /**
@@ -52,7 +49,7 @@ public class OAuth10aServiceImpl implements OAuthService
     request.addOAuthParameter(OAuthConstants.CONSUMER_KEY, config.getApiKey());
     request.addOAuthParameter(OAuthConstants.SIGN_METHOD, api.getSignatureService().getSignatureMethod());
     request.addOAuthParameter(OAuthConstants.VERSION, getVersion());
-    if(scope != NO_SCOPE) request.addOAuthParameter(OAuthConstants.SCOPE, scope);
+    if(config.hasScope()) request.addOAuthParameter(OAuthConstants.SCOPE, config.getScope());
     request.addOAuthParameter(OAuthConstants.SIGNATURE, getSignature(request, token));
   }
 
@@ -88,14 +85,6 @@ public class OAuth10aServiceImpl implements OAuthService
     return VERSION;
   }
 
-  /**
-   * {@inheritDoc}
-   */
-  public void addScope(String scope)
-  {
-    this.scope = scope;
-  }
-
   /**
    * {@inheritDoc}
    */

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

@@ -22,14 +22,6 @@ public class OAuth20ServiceImpl implements OAuthService
     this.config = config;
   }
 
-  /**
-   * {@inheritDoc}
-   */
-  public void addScope(String scope)
-  {
-    throw new UnsupportedOperationException("OAuth 2 does not use scopes");
-  }
-
   /**
    * {@inheritDoc}
    */
@@ -40,6 +32,7 @@ public class OAuth20ServiceImpl implements OAuthService
     request.addQuerystringParameter(OAuthConstants.CLIENT_SECRET, config.getApiSecret());
     request.addQuerystringParameter(OAuthConstants.CODE, verifier.getValue());
     request.addQuerystringParameter(OAuthConstants.REDIRECT_URI, config.getCallback());
+    if(config.hasScope()) request.addQuerystringParameter(OAuthConstants.SCOPE, config.getScope());
     Response response = request.send();
     return api.getAccessTokenExtractor().extract(response.getBody());
   }

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

@@ -41,13 +41,6 @@ public interface OAuthService
    * @return oauth version as string
    */
   public String getVersion();
-
-  /**
-   * Adds the 'scope' parameter. This is **not** a default OAuth parameter and the setting is optional.
-   * 
-   * @param scope OAuth Api scope (optional)
-   */
-  public void addScope(String scope);
   
   /**
    * Returns the URL where you should redirect your users to authenticate

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

@@ -0,0 +1,40 @@
+package org.scribe.services;
+
+import org.scribe.exceptions.*;
+import org.scribe.utils.*;
+
+/**
+ * plaintext implementation of {@SignatureService}
+ *
+ * @author Pablo Fernandez
+ *
+ */
+public class PlaintextSignatureService implements SignatureService
+{
+  private static final String METHOD = "plaintext";
+
+  /**
+   * {@inheritDoc}
+   */
+  public String getSignature(String baseString, String apiSecret, String tokenSecret)
+  {
+    try
+    {
+      Preconditions.checkEmptyString(apiSecret, "Api secret cant be null or empty string");
+      return URLUtils.percentEncode(apiSecret) + '&' + URLUtils.percentEncode(tokenSecret);
+    }
+    catch (Exception e)
+    {
+      throw new OAuthSignatureException(baseString, e);
+    }
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public String getSignatureMethod()
+  {
+    return METHOD;
+  }
+}
+

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

@@ -57,19 +57,17 @@ public class ServiceBuilderTest
     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");
+    assertEquals(ApiMock.config.getScope(), "rss-api");
   }
 
   public static class ApiMock implements Api
   {
     public static OAuthConfig config;
-    public static String scope;
     
     @Override
-    public OAuthService createService(OAuthConfig config, String scope)
+    public OAuthService createService(OAuthConfig config)
     {
       ApiMock.config = config;
-      ApiMock.scope = scope;
       return null;
     }
   }

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

@@ -12,12 +12,14 @@ public class OAuthConfigTest
   {
     OAuthConfig config = new OAuthConfig("key", "secret");
     assertEquals(OAuthConstants.OUT_OF_BAND, config.getCallback());
+    assertEquals(SignatureType.Header, config.getSignatureType());
+    assertFalse(config.hasScope());
   }
 
   @Test
   public void shouldOverrideDefaultsIfSet()
   {
-    OAuthConfig config = new OAuthConfig("key", "secret", "http://callback");
+    OAuthConfig config = new OAuthConfig("key", "secret", "http://callback", SignatureType.Header, "scope");
     assertEquals("http://callback", config.getCallback());
     assertEquals("key", config.getApiKey());
     assertEquals("secret", config.getApiSecret());