Merge pull request #15 from FreeClimbAPI/replaceAuthToken

Find and Replace Auth Token -> API Key

Author: kohearn-vail

CHANGELOG.md

@@ -7,6 +7,11 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ## [Unreleased]
 None
 
+<a name="4.1.0"></a>
+## [4.1.0] - 2021-05-10
+### Changed
+- Replace any language instance of auth_token or similar speech to api_key
+
 <a name="4.0.1"></a>
 ## [4.0.1] - 2021-05-03
 ### Fixed

README.md

@@ -20,12 +20,12 @@ Test the SDK is working by sending yourself a text message.
 public class Example {
 
     public static final String accountId = "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
-    public static final String authToken = "your_auth_token";
+    public static final String apiKey = "your_api_key";
     public static final String To = "your_phone_number";
     public static final String From = "a_free_climb_phone_number_in_your_account";
 
     public static void main(String[] args) throws FreeClimbException {
-        FreeClimbClient client = new FreeClimbClient(accountId, authToken);
+        FreeClimbClient client = new FreeClimbClient(accountId, apiKey);
 
         client.messages.create(From, To, "Welcome to FreeClimb!");
     }

build.gradle

@@ -9,7 +9,7 @@ group = 'com.github.FreeClimbAPI'
 
 sourceCompatibility = 1.7 // java 7
 targetCompatibility = 1.7
-version = '4.0.1'
+version = '4.1.0'
 
 repositories {
 	mavenCentral()

src/main/java/com/vailsys/freeclimb/api/APIAccountRequester.java

@@ -14,7 +14,7 @@ public class APIAccountRequester extends APIRequester {
     /** The rootPath is used by subclasses to build the path to their endpoints. */
     protected static final String rootPath = constructAbsolutePath(accountPathHead);
 
-    protected APIAccountRequester(String credAccountId, String credAuthToken) {
-        super(credAccountId, credAuthToken);
+    protected APIAccountRequester(String credAccountId, String credApiKey) {
+        super(credAccountId, credApiKey);
     }
 }

src/main/java/com/vailsys/freeclimb/api/APIRequester.java

@@ -40,20 +40,20 @@ public class APIRequester {
 	}.getType();
 
 	private String credAccountId;
-	private String credAuthToken;
+	private String credApiKey;
 	private String encodedAuth;
 	private String freeclimbUrl;
 
 	/**
 	 * Create a new APIRequester.
 	 *
 	 * @param credAccountId The accountId to use to authenticate requests.
-	 * @param credAuthToken The authToken to use to authenticate requests.
+	 * @param credApiKey The apiKey to use to authenticate requests.
 	 */
-	protected APIRequester(String credAccountId, String credAuthToken) {
+	protected APIRequester(String credAccountId, String credApiKey) {
 		this.credAccountId = credAccountId;
-		this.credAuthToken = credAuthToken;
-		this.encodedAuth = printBase64Binary((credAccountId + ":" + credAuthToken).getBytes(StandardCharsets.UTF_8));
+		this.credApiKey = credApiKey;
+		this.encodedAuth = printBase64Binary((credAccountId + ":" + credApiKey).getBytes(StandardCharsets.UTF_8));
 		this.freeclimbUrl = APIRequester.FREECLIMB_URL;
 	}
 
@@ -62,9 +62,9 @@ protected String getCredentialAccountId() {
 		return this.credAccountId;
 	}
 
-	/** @return the authToken being used for authentication */
-	protected String getCredentialAuthToken() {
-		return this.credAuthToken;
+	/** @return the apiKey being used for authentication */
+	protected String getCredentialApiKey() {
+		return this.credApiKey;
 	}
 
 	/** @return the url being used for the FreeClimb API */

src/main/java/com/vailsys/freeclimb/api/FreeClimbClient.java

@@ -19,7 +19,7 @@
  */
 public class FreeClimbClient {
 	private String credAccountId;
-	private String credAuthToken;
+	private String credApiKey;
 	private String accountId;
 
 	public AccountRequester accounts;
@@ -41,8 +41,8 @@ public class FreeClimbClient {
 	 *
 	 * @param credAccountId The Account ID to use in your credentials for the
 	 *                      FreeClimb API.
-	 * @param credAuthToken The Auth Token to use in your credentials for the
-	 *                      FreeClimb API. This should be the matching Auth Token to
+	 * @param credApiKey The API key to use in your credentials for the
+	 *                      FreeClimb API. This should be the matching API key to
 	 *                      the credAccountId parameter.
 	 * @param accountId     The Account ID of the account you want to act as. This
 	 *                      should either be the same Account ID ass credAccountId
@@ -52,42 +52,42 @@ public class FreeClimbClient {
 	 * @throws FreeClimbException when any of the requesters throws a
 	 *                            FreeClimbException.
 	 */
-	public FreeClimbClient(String credAccountId, String credAuthToken, String accountId) throws FreeClimbException {
+	public FreeClimbClient(String credAccountId, String credApiKey, String accountId) throws FreeClimbException {
 		this.credAccountId = credAccountId;
-		this.credAuthToken = credAuthToken;
+		this.credApiKey = credApiKey;
 		this.accountId = accountId;
 
-		this.accounts = new AccountRequester(credAccountId, credAuthToken, accountId);
-		this.recordings = new RecordingsRequester(credAccountId, credAuthToken, accountId);
-		this.calls = new CallsRequester(credAccountId, credAuthToken, accountId);
-		this.conferences = new ConferencesRequester(credAccountId, credAuthToken, accountId);
-		this.logs = new LogRequester(credAccountId, credAuthToken, accountId);
-		this.available = new AvailablePhoneNumberRequester(credAccountId, credAuthToken, accountId);
-		this.calling = new CallingNumberRequester(credAccountId, credAuthToken, accountId);
-		this.incoming = new IncomingPhoneNumberRequester(credAccountId, credAuthToken, accountId);
-		this.queues = new QueuesRequester(credAccountId, credAuthToken, accountId);
-		this.applications = new ApplicationsRequester(credAccountId, credAuthToken, accountId);
-		this.messages = new MessagesRequester(credAccountId, credAuthToken, accountId);
+		this.accounts = new AccountRequester(credAccountId, credApiKey, accountId);
+		this.recordings = new RecordingsRequester(credAccountId, credApiKey, accountId);
+		this.calls = new CallsRequester(credAccountId, credApiKey, accountId);
+		this.conferences = new ConferencesRequester(credAccountId, credApiKey, accountId);
+		this.logs = new LogRequester(credAccountId, credApiKey, accountId);
+		this.available = new AvailablePhoneNumberRequester(credAccountId, credApiKey, accountId);
+		this.calling = new CallingNumberRequester(credAccountId, credApiKey, accountId);
+		this.incoming = new IncomingPhoneNumberRequester(credAccountId, credApiKey, accountId);
+		this.queues = new QueuesRequester(credAccountId, credApiKey, accountId);
+		this.applications = new ApplicationsRequester(credAccountId, credApiKey, accountId);
+		this.messages = new MessagesRequester(credAccountId, credApiKey, accountId);
 	}
 
 	/**
 	 * This constructor allows one to create a FreeClimbClient that authenticates
 	 * with one set of credentials and acts as that account.
 	 *
 	 * This Constructor is a shortcut for calling
-	 * {@code FreeClimbClient(credAccountId, credAuthToken, credAccountId)}.
+	 * {@code FreeClimbClient(credAccountId, credApiKey, credAccountId)}.
 	 *
 	 * @param credAccountId The Account ID to use in your credentials for the
 	 *                      FreeClimb API.
-	 * @param credAuthToken The Auth Token to use in your credentials for the
-	 *                      FreeClimb API. This should be the matching Auth Token to
+	 * @param credApiKey The API key to use in your credentials for the
+	 *                      FreeClimb API. This should be the matching API key to
 	 *                      the credAccountId parameter.
 	 * @see #FreeClimbClient(String, String, String)
 	 * @throws FreeClimbException when any of the requesters throws a
 	 *                            FreeClimbException.
 	 */
-	public FreeClimbClient(String credAccountId, String credAuthToken) throws FreeClimbException {
-		this(credAccountId, credAuthToken, credAccountId);
+	public FreeClimbClient(String credAccountId, String credApiKey) throws FreeClimbException {
+		this(credAccountId, credApiKey, credAccountId);
 	}
 
 	/**
@@ -98,10 +98,10 @@ public String getCredAccountId() {
 	}
 
 	/**
-	 * @return the Auth Token being used to authenticate with the API
+	 * @return the API key being used to authenticate with the API
 	 */
-	public String getCredAuthToken() {
-		return credAuthToken;
+	public String getCredApiKey() {
+		return credApiKey;
 	}
 
 	/**

src/main/java/com/vailsys/freeclimb/api/FreeClimbList.java

@@ -44,7 +44,7 @@ public abstract class FreeClimbList<T> extends APIRequester {
 	 *
 	 * @param accountId The accountId to use for credentials with the FreeClimb API
 	 *                  when pulling new pages of the list.
-	 * @param authToken The authToken to use for credentials with the FreeClimb API
+	 * @param apiKey The apiKey to use for credentials with the FreeClimb API
 	 *                  when pulling new pages of the list.
 	 * @param rawPage   The JSON string representing the first page of the list.
 	 * @param listField The name of the array of resources within the raw JSON list.
@@ -53,9 +53,9 @@ public abstract class FreeClimbList<T> extends APIRequester {
 	 * @param theType   The Type of the FreeClimb Resource this list will contain.
 	 * @throws FreeClimbException when the page is not valid JSON.
 	 */
-	protected FreeClimbList(String accountId, String authToken, String rawPage, String listField, Class<T> theType)
+	protected FreeClimbList(String accountId, String apiKey, String rawPage, String listField, Class<T> theType)
 			throws FreeClimbException {
-		super(accountId, authToken);
+		super(accountId, apiKey);
 		this.list = new ArrayList<T>();
 		this.listField = listField;
 		this.theType = theType;

src/main/java/com/vailsys/freeclimb/api/account/Account.java

@@ -27,9 +27,9 @@ public class Account extends FreeClimbCommon {
      */
     private String accountId;
     /**
-     * The authToken for this account instance.
+     * The apiKey for this account instance.
      */
-    private String authToken;
+    private String apiKey;
     /**
      * The alias for this account.
      */
@@ -81,12 +81,12 @@ public String getAccountId() {
     }
 
     /**
-     * Retrieve the authToken for this account from the object.
+     * Retrieve the apiKey for this account from the object.
      *
-     * @return The authToken for this account.
+     * @return The apiKey for this account.
      */
-    public String getAuthToken() {
-        return authToken;
+    public String getApiKey() {
+        return apiKey;
     }
 
     /**
@@ -150,10 +150,10 @@ public boolean equals(Account that) {
             result = result && that.getAccountId() == null;
         }
 
-        if (this.getAuthToken() != null) {
-            result = result && that.getAuthToken().equals(this.getAuthToken());
+        if (this.getApiKey() != null) {
+            result = result && that.getApiKey().equals(this.getApiKey());
         } else {
-            result = result && that.getAuthToken() == null;
+            result = result && that.getApiKey() == null;
         }
 
         if (this.getAlias() != null) {

src/main/java/com/vailsys/freeclimb/api/account/AccountRequester.java

@@ -29,15 +29,15 @@ public class AccountRequester extends APIRequester {
      * @param credAccountId   The accountId to use as authentication credentials in
      *                        the HTTP Basic Auth header for requests made by this
      *                        requester.
-     * @param credAuthToken   The authToken to use as authentication credentials in
+     * @param credApiKey   The apiKey to use as authentication credentials in
      *                        the HTTP Basic Auth header for requests made by this
      *                        requester.
      * @param actingAccountId The accountId to as as. This can be the same as
      *                        {@code credAccountId} or the accountId of a subaccount
      *                        of the {@code credAccountId}.
      */
-    public AccountRequester(String credAccountId, String credAuthToken, String actingAccountId) {
-        super(credAccountId, credAuthToken);
+    public AccountRequester(String credAccountId, String credApiKey, String actingAccountId) {
+        super(credAccountId, credApiKey);
         this.actingAccountId = actingAccountId;
         this.path = APIRequester.constructAbsolutePath(pathHead);
     }

src/main/java/com/vailsys/freeclimb/api/application/ApplicationList.java

@@ -15,12 +15,12 @@ public class ApplicationList extends FreeClimbList<Application> {
      * Creates a new ApplicationList.
      *
      * @param accountId the accountId to use in requests for subsequent pages.
-     * @param authToken the authToken to use in requests for subsequent pages.
+     * @param apiKey the apiKey to use in requests for subsequent pages.
      * @param rawPage   the raw JSON string representing a page of an application
      *                  list from the FreeClimb API
      * @throws FreeClimbException when the JSON is invalid.
      */
-    public ApplicationList(String accountId, String authToken, String rawPage) throws FreeClimbException {
-        super(accountId, authToken, rawPage, "applications", Application.class);
+    public ApplicationList(String accountId, String apiKey, String rawPage) throws FreeClimbException {
+        super(accountId, apiKey, rawPage, "applications", Application.class);
     }
 }