rename AuthAPI methods.

Author: lbalmaceda

README.md

@@ -42,32 +42,28 @@ AuthAPI auth = new AuthAPI("{YOUR_DOMAIN}", "{YOUR_CLIENT_ID}", "{YOUR_CLIENT_SE
 
 Creates an `AuthorizeUrlBuilder` to authenticate the user with an OAuth provider. The `redirectUri` must be white-listed in the "Allowed Callback URLs" section of the Client Settings. Parameters can be added to the final url by using the builder methods. When ready, call `build()` and obtain the Url.
 
-`AuthorizeUrlBuilder authorize("{CONNECTION}", "{REDIRECT_URI}")`
+`AuthorizeUrlBuilder authorizeUrl("{REDIRECT_URI}")`
 
 Example:
 ```java
-AuthorizeUrlBuilder builder = auth.authorize("facebook", "https://me.auth0.com/callback");
-builder.withAudience("https://api.me.auth0.com/users");
-builder.withScope("openid contacts");
-builder.withState("state123");
-
-String url = builder.build();
-// https://me.auth0.com/authorize?redirect_uri=https://me.auth0.com/callback&response_type=code&client_id=iaih2D7AC56kksdkPtWAsjI3li&audience=https://api.me.auth0.com/users&scope=openid%20contacts&connection=facebook&state=state123
+String url = auth.authorizeUrl("https://me.auth0.com/callback")
+    .withConnection("facebook")
+    .withAudience("https://api.me.auth0.com/users")
+    .withScope("openid contacts")
+    .withState("state123")
+    .build();
 ```
 
 ### Logout - /v2/logout
 Creates a `LogoutUrlBuilder` to log out the user. The `returnToUrl` must be white-listed in the "Allowed Logout URLs" section of the Client Settings. Parameters can be added to the final url by using the builder methods. When ready, call `build()` and obtain the Url.
 
-`LogoutUrlBuilder logout("{RETURN_TO_URL}", "{SEND_CLIENT_ID}")`
+`LogoutUrlBuilder logoutUrl("{RETURN_TO_URL}", "{SEND_CLIENT_ID}")`
 
 Example:
 ```java
-LogoutUrlBuilder builder = auth.logout("https://me.auth0.com/home", true);
-builder.useFederated(true);
-builder.withAccessToken("aToKen");
-
-String url = builder.build();
-// https://me.auth0.com/v2/logout?returnTo=https://me.auth0.com/home&client_id=iaih2D7AC56kksdkPtWAsjI3li&access_token=aToKen&federated=
+String url = auth.logoutUrl("https://me.auth0.com/home", true)
+    .useFederated(true)
+    .withAccessToken("aToKen");
 ```
 
 ### UserInfo - /userinfo
@@ -129,15 +125,15 @@ try {
 }
 ```
 
-### Log In with Authorization Code - /oauth/token
+### Exchange the Authorization Code - /oauth/token
 
-Creates a new request to log in the user with a `code` previously obtained by calling the /authorize endpoint. The redirect uri must be the one sent in the /authorize call.
+Creates a new request to exchange the `code` previously obtained by calling the /authorize endpoint. The redirect uri must be the one sent in the /authorize call.
 
-`AuthRequest loginWithAuthorizationCode("{CODE}", "{REDIRECT_URI}")`
+`AuthRequest exchangeCode("{CODE}", "{REDIRECT_URI}")`
 
 Example:
 ```java
-AuthRequest request = loginWithAuthorizationCode("asdfgh", "https://me.auth0.com/callback");
+AuthRequest request = exchangeCode("asdfgh", "https://me.auth0.com/callback");
 request.setAudience("https://api.me.auth0.com/users");
 request.setScope("openid contacts");
 try {
@@ -154,11 +150,11 @@ try {
 
 Creates a new request to log in the user with `username` and `password`. The connection used is the one defined as "Default Directory" in the account settings.
 
-`AuthRequest loginWithPassword("{USERNAME_OR_EMAIL}", "{PASSWORD}")`
+`AuthRequest login("{USERNAME_OR_EMAIL}", "{PASSWORD}")`
 
 Example:
 ```java
-AuthRequest request = loginWithPassword("me@domain.com", "password123");
+AuthRequest request = login("me@domain.com", "password123");
 request.setAudience("https://api.me.auth0.com/users");
 request.setScope("openid contacts");
 try {
@@ -175,11 +171,11 @@ try {
 
 Creates a new request to log in the user with `username` and `password` using the Password Realm.
 
-`AuthRequest loginWithPasswordRealm("{USERNAME_OR_EMAIL}", "{PASSWORD}", "{REALM}")`
+`AuthRequest login("{USERNAME_OR_EMAIL}", "{PASSWORD}", "{REALM}")`
 
 Example:
 ```java
-AuthRequest request = loginWithPasswordRealm("me@domain.com", "password123", "Username-Password-Authentication");
+AuthRequest request = login("me@domain.com", "password123", "Username-Password-Authentication");
 request.setAudience("https://api.me.auth0.com/users");
 request.setScope("openid contacts");
 try {
@@ -192,15 +188,15 @@ try {
 }
 ```
 
-### Log In with Client Credentials - /oauth/token
+### Request Token for Audience - /oauth/token
 
-Creates a new request to log in the user using the Client Credentials.
+Creates a new request to get a Token for the given Audience.
 
-`AuthRequest loginWithClientCredentials("{AUDIENCE}")`
+`AuthRequest requestToken("{AUDIENCE}")`
 
 Example:
 ```java
-AuthRequest request = loginWithClientCredentials("https://api.me.auth0.com/users");
+AuthRequest request = requestToken("https://api.me.auth0.com/users");
 request.setScope("openid contacts");
 try {
     TokenHolder holder = request.execute();

src/main/java/com/auth0/client/auth/AuthAPI.java

@@ -91,7 +91,7 @@ private String createBaseUrl(String domain) {
      * @param redirectUri the redirect_uri value to set, white-listed in the client settings. Must be already URL Encoded.
      * @return a new instance of the {@link AuthorizeUrlBuilder} to configure.
      */
-    public AuthorizeUrlBuilder authorize(String redirectUri) {
+    public AuthorizeUrlBuilder authorizeUrl(String redirectUri) {
         Asserts.assertNotNull(redirectUri, "redirect uri");
 
         return AuthorizeUrlBuilder.newInstance(baseUrl, clientId, redirectUri);
@@ -104,15 +104,15 @@ public AuthorizeUrlBuilder authorize(String redirectUri) {
      * @param setClientId whether the client_id value must be set or not. This affects the white-list that the Auth0's Dashboard uses to validate the returnTo url.
      * @return a new instance of the {@link AuthorizeUrlBuilder} to configure.
      */
-    public LogoutUrlBuilder logout(String returnToUrl, boolean setClientId) {
+    public LogoutUrlBuilder logoutUrl(String returnToUrl, boolean setClientId) {
         Asserts.assertNotNull(returnToUrl, "return to url");
 
         return LogoutUrlBuilder.newInstance(baseUrl, clientId, returnToUrl, setClientId);
     }
 
 
     /**
-     * Request the user information related to this access token.
+     * Request the user information related to the access token.
      *
      * @param accessToken a valid access token belonging to an API signed with RS256 algorithm and containing the scope 'openid'.
      * @return a Request to execute.
@@ -201,40 +201,14 @@ public SignUpRequest signUp(String email, String password, String connection) {
         return request;
     }
 
-    /**
-     * Creates a new log in request using the 'Authorization Code' grant and the given code and redirect uri parameters.
-     *
-     * @param code        the authorization code received from the /authorize call.
-     * @param redirectUri the redirect uri sent on the /authorize call.
-     * @return a Request to configure and execute.
-     */
-    public AuthRequest loginWithAuthorizationCode(String code, String redirectUri) {
-        Asserts.assertNotNull(code, "code");
-        Asserts.assertNotNull(redirectUri, "redirect uri");
-
-        String url = HttpUrl.parse(baseUrl)
-                .newBuilder()
-                .addPathSegment(PATH_OAUTH)
-                .addPathSegment(PATH_TOKEN)
-                .build()
-                .toString();
-        TokenRequest request = new TokenRequest(client, url);
-        request.addParameter(KEY_CLIENT_ID, clientId);
-        request.addParameter(KEY_CLIENT_SECRET, clientSecret);
-        request.addParameter(KEY_GRANT_TYPE, "authorization_code");
-        request.addParameter("code", code);
-        request.addParameter("redirect_uri", redirectUri);
-        return request;
-    }
-
     /**
      * Creates a new log in request using the 'Password' grant and the given credentials.
      *
      * @param emailOrUsername the identity of the user.
      * @param password        the password of the user.
      * @return a Request to configure and execute.
      */
-    public AuthRequest loginWithPassword(String emailOrUsername, String password) {
+    public AuthRequest login(String emailOrUsername, String password) {
         Asserts.assertNotNull(emailOrUsername, "email or username");
         Asserts.assertNotNull(password, "password");
 
@@ -261,7 +235,7 @@ public AuthRequest loginWithPassword(String emailOrUsername, String password) {
      * @param password        the password of the user.
      * @return a Request to configure and execute.
      */
-    public AuthRequest loginWithPasswordRealm(String emailOrUsername, String password, String realm) {
+    public AuthRequest login(String emailOrUsername, String password, String realm) {
         Asserts.assertNotNull(emailOrUsername, "email or username");
         Asserts.assertNotNull(password, "password");
         Asserts.assertNotNull(realm, "realm");
@@ -283,13 +257,13 @@ public AuthRequest loginWithPasswordRealm(String emailOrUsername, String passwor
     }
 
     /**
-     * Creates a new log in request using the 'Client Credentials' grant for the given audience.
+     * Creates a new request using the 'Client Credentials' grant to get a Token for the given audience.
      * Default used realm and audience are defined in the "API Authorization Settings" in the account's advanced settings in the Auth0 Dashboard.
      *
      * @param audience the audience of the API to request access to.
      * @return a Request to configure and execute.
      */
-    public AuthRequest loginWithClientCredentials(String audience) {
+    public AuthRequest requestToken(String audience) {
         Asserts.assertNotNull(audience, "audience");
 
         String url = HttpUrl.parse(baseUrl)
@@ -305,4 +279,30 @@ public AuthRequest loginWithClientCredentials(String audience) {
         request.addParameter(KEY_AUDIENCE, audience);
         return request;
     }
+
+    /**
+     * Creates a new request using the 'Authorization Code' grant to exchange the code obtained in the /authorize call.
+     *
+     * @param code        the authorization code received from the /authorize call.
+     * @param redirectUri the redirect uri sent on the /authorize call.
+     * @return a Request to configure and execute.
+     */
+    public AuthRequest exchangeCode(String code, String redirectUri) {
+        Asserts.assertNotNull(code, "code");
+        Asserts.assertNotNull(redirectUri, "redirect uri");
+
+        String url = HttpUrl.parse(baseUrl)
+                .newBuilder()
+                .addPathSegment(PATH_OAUTH)
+                .addPathSegment(PATH_TOKEN)
+                .build()
+                .toString();
+        TokenRequest request = new TokenRequest(client, url);
+        request.addParameter(KEY_CLIENT_ID, clientId);
+        request.addParameter(KEY_CLIENT_SECRET, clientSecret);
+        request.addParameter(KEY_GRANT_TYPE, "authorization_code");
+        request.addParameter("code", code);
+        request.addParameter("redirect_uri", redirectUri);
+        return request;
+    }
 }