Automated commit message

Author: andreals

README.md

@@ -0,0 +1,35 @@
+
+# Basic Authentication
+
+
+
+Documentation for accessing and setting credentials for httpBasic.
+
+## Auth Credentials
+
+| Name | Type | Description | Setter | Getter |
+|  --- | --- | --- | --- | --- |
+| BasicAuthUserName | `String` | The username to use with basic authentication | `username` | `getBasicAuthUserName()` |
+| BasicAuthPassword | `String` | The password to use with basic authentication | `password` | `getBasicAuthPassword()` |
+
+
+
+**Note:** Auth credentials can be set using `basicAuthCredentials` in the client builder and accessed through `getBasicAuthCredentials` method in the client instance.
+
+## Usage Example
+
+### Client Initialization
+
+You must provide credentials in the client as shown in the following code snippet.
+
+```java
+PagarmeApiSDKClient client = new PagarmeApiSDKClient.Builder()
+    .basicAuthCredentials(new BasicAuthModel.Builder(
+            "BasicAuthUserName",
+            "BasicAuthPassword"
+        )
+        .build())
+    .build();
+```
+
+

doc/auth/basic-authentication.md

@@ -7,6 +7,7 @@ The following parameters are configurable for the API Client:
 |  --- | --- | --- |
 | `serviceRefererName` | `String` |  |
 | `httpClientConfig` | [`ReadonlyHttpClientConfiguration`](http-client-configuration.md) | Http Client Configuration instance. |
+| `basicAuthCredentials` | [`BasicAuthCredentials`]($a/basic-authentication.md) | The Credentials Setter for Basic Authentication |
 
 The API client can be initialized as follows:
 
@@ -15,6 +16,11 @@ PagarmeApiSDKClient client = new PagarmeApiSDKClient.Builder()
     .httpClientConfig(configBuilder -> configBuilder
             .timeout(0))
     .serviceRefererName("ServiceRefererName")
+    .basicAuthCredentials(new BasicAuthModel.Builder(
+            "BasicAuthUserName",
+            "BasicAuthPassword"
+        )
+        .build())
     .build();
 ```
 
@@ -48,6 +54,7 @@ The gateway for the SDK. This class acts as a factory for the Controllers and al
 | `getServiceRefererName()` | . | `String` |
 | `getHttpClient()` | The HTTP Client instance to use for making HTTP requests. | `HttpClient` |
 | `getHttpClientConfig()` | Http Client Configuration instance. | [`ReadonlyHttpClientConfiguration`](http-client-configuration.md) |
+| `getBasicAuthCredentials()` | The credentials to use with BasicAuth. | [`BasicAuthCredentials`]($a/basic-authentication.md) |
 | `getBaseUri(Server server)` | Get base URI by current environment | `String` |
 | `getBaseUri()` | Get base URI by current environment | `String` |
 

doc/client.md

@@ -16,6 +16,8 @@ TokensController tokensController = client.getTokensController();
 
 # Create Token
 
+:information_source: **Note** This endpoint does not require authentication.
+
 ```java
 GetTokenResponse createToken(
     final String publicKey,
@@ -70,6 +72,8 @@ try {
 
 Gets a token from its id
 
+:information_source: **Note** This endpoint does not require authentication.
+
 ```java
 GetTokenResponse getToken(
     final String id,

doc/controllers/tokens.md

@@ -8,7 +8,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>PagarmeApiSDKLib</groupId>
   <artifactId>pagarme-api-sdklib</artifactId>
-  <version>6.8.5</version>
+  <version>6.8.6</version>
   <packaging>jar</packaging>
   <name>PagarmeApiSDKLib</name>
   <properties>

pom.xml

@@ -0,0 +1,33 @@
+/*
+ * PagarmeApiSDKLib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+package me.pagar.api;
+
+/**
+ * Interface for defining the behavior of Basic Authentication.
+ */
+public interface BasicAuthCredentials {
+
+    /**
+     * String value for basicAuthUserName.
+     * @return basicAuthUserName
+     */
+    String getBasicAuthUserName();
+
+    /**
+     * String value for basicAuthPassword.
+     * @return basicAuthPassword
+     */
+    String getBasicAuthPassword();
+
+    /**
+     * Checks if provided credentials matched with existing ones.
+     * @param basicAuthUserName String value for credentials.
+     * @param basicAuthPassword String value for credentials.
+     * @return true if credentials matched.
+     */
+    boolean equals(String basicAuthUserName, String basicAuthPassword);
+}

src/main/java/me/pagar/api/BasicAuthCredentials.java

@@ -6,6 +6,7 @@
 
 package me.pagar.api;
 
+import me.pagar.api.authentication.BasicAuthModel;
 import me.pagar.api.http.client.ReadonlyHttpClientConfiguration;
 
 /**
@@ -37,6 +38,18 @@ public interface Configuration {
      */
     long timeout();
 
+    /**
+     * The credentials to use with BasicAuth.
+     * @return basicAuthCredentials
+     */
+    BasicAuthCredentials getBasicAuthCredentials();
+
+    /**
+     * The auth credential model for BasicAuth.
+     * @return the instance of BasicAuthModel
+     */
+    BasicAuthModel getBasicAuthModel();
+
     /**
      * Get base URI by current environment.
      * @param server Server for which to get the base URI

src/main/java/me/pagar/api/Configuration.java

@@ -7,12 +7,15 @@
 package me.pagar.api;
 
 import io.apimatic.core.GlobalConfiguration;
+import io.apimatic.coreinterfaces.authentication.Authentication;
 import io.apimatic.coreinterfaces.compatibility.CompatibilityFactory;
 import io.apimatic.coreinterfaces.http.HttpClient;
 import io.apimatic.okhttpclient.adapter.OkClient;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.function.Consumer;
+import me.pagar.api.authentication.BasicAuthManager;
+import me.pagar.api.authentication.BasicAuthModel;
 import me.pagar.api.controllers.BalanceOperationsController;
 import me.pagar.api.controllers.ChargesController;
 import me.pagar.api.controllers.CustomersController;
@@ -65,7 +68,7 @@ public final class PagarmeApiSDKClient implements PagarmeApiSDKClientInterface {
 
     private static final CompatibilityFactory compatibilityFactory = new CompatibilityFactoryImpl();
 
-    private static String userAgent = "PagarmeApiSDK - Java 6.8.5";
+    private static String userAgent = "PagarmeApiSDK - Java 6.8.6";
 
     /**
      * Current API environment.
@@ -87,15 +90,47 @@ public final class PagarmeApiSDKClient implements PagarmeApiSDKClientInterface {
      */
     private final ReadonlyHttpClientConfiguration httpClientConfig;
 
+    /**
+     * BasicAuthManager.
+     */
+    private BasicAuthManager basicAuthManager;
+
+    /**
+     * The instance of BasicAuthModel.
+     */
+    private BasicAuthModel basicAuthModel;
+
+    /**
+     * Map of authentication Managers.
+     */
+    private Map<String, Authentication> authentications;
+
     private PagarmeApiSDKClient(Environment environment, String serviceRefererName,
-            HttpClient httpClient, ReadonlyHttpClientConfiguration httpClientConfig) {
+            HttpClient httpClient, ReadonlyHttpClientConfiguration httpClientConfig,
+            BasicAuthModel basicAuthModel, Map<String, Authentication> authentications) {
         this.environment = environment;
         this.serviceRefererName = serviceRefererName;
         this.httpClient = httpClient;
         this.httpClientConfig = httpClientConfig;
+        this.authentications = 
+                (authentications == null) ? new HashMap<>() : new HashMap<>(authentications);
+        this.basicAuthModel = basicAuthModel;
+
+        if (this.authentications.containsKey("httpBasic")) {
+            this.basicAuthManager = (BasicAuthManager) this.authentications.get("httpBasic");
+        }
+
+        if (!this.authentications.containsKey("httpBasic")
+                || !getBasicAuthCredentials().equals(basicAuthModel.getUsername(),
+                        basicAuthModel.getPassword())) {
+            this.basicAuthManager = new BasicAuthManager(basicAuthModel);
+            this.authentications.put("httpBasic", basicAuthManager);
+        }
+
         GlobalConfiguration globalConfig = new GlobalConfiguration.Builder()
                 .httpClient(httpClient).baseUri(server -> getBaseUri(server))
                 .compatibilityFactory(compatibilityFactory)
+                .authentication(this.authentications)
                 .userAgent(userAgent)
                 .globalHeader("ServiceRefererName", serviceRefererName)
                 .build();
@@ -248,6 +283,21 @@ public ReadonlyHttpClientConfiguration getHttpClientConfig() {
         return httpClientConfig;
     }
 
+    /**
+     * The credentials to use with BasicAuth.
+     * @return basicAuthCredentials
+     */
+    public BasicAuthCredentials getBasicAuthCredentials() {
+        return basicAuthManager;
+    }
+
+    /**
+     * The auth credential model for BasicAuth.
+     * @return the instance of BasicAuthModel
+     */
+    public BasicAuthModel getBasicAuthModel() {
+        return basicAuthModel;
+    }
     /**
      * The timeout to use for making HTTP requests.
      * @deprecated This method will be removed in a future version. Use
@@ -311,7 +361,8 @@ private static String environmentMapper(Environment environment, Server server)
     @Override
     public String toString() {
         return "PagarmeApiSDKClient [" + "environment=" + environment + ", serviceRefererName="
-                + serviceRefererName + ", httpClientConfig=" + httpClientConfig + "]";
+                + serviceRefererName + ", httpClientConfig=" + httpClientConfig
+                + ", authentications=" + authentications + "]";
     }
 
     /**
@@ -324,6 +375,9 @@ public Builder newBuilder() {
         builder.environment = getEnvironment();
         builder.serviceRefererName = getServiceRefererName();
         builder.httpClient = getHttpClient();
+        builder.basicAuthCredentials(getBasicAuthModel()
+                .toBuilder().build());
+        builder.authentications = authentications;
         builder.httpClientConfig(configBldr -> configBldr =
                 ((HttpClientConfiguration) httpClientConfig).newBuilder());
         return builder;
@@ -337,10 +391,39 @@ public static class Builder {
         private Environment environment = Environment.PRODUCTION;
         private String serviceRefererName = "";
         private HttpClient httpClient;
+        private BasicAuthModel basicAuthModel = new BasicAuthModel.Builder("", "").build();
+        private Map<String, Authentication> authentications = null;
         private HttpClientConfiguration.Builder httpClientConfigBuilder =
                 new HttpClientConfiguration.Builder();
 
 
+        /**
+         * Credentials setter for BasicAuth.
+         * @param basicAuthUserName String value for basicAuthUserName.
+         * @param basicAuthPassword String value for basicAuthPassword.
+         * @deprecated This builder method is deprecated.
+         * Use {@link #basicAuthCredentials(BasicAuthModel) basicAuthCredentials} instead.
+         * @return The current instance of builder.
+         */
+        @Deprecated
+        public Builder basicAuthCredentials(String basicAuthUserName, String basicAuthPassword) {
+            basicAuthModel = basicAuthModel.toBuilder()
+                .username(basicAuthUserName)
+                .password(basicAuthPassword)
+                .build();
+            return this;
+        }
+
+        /**
+         * Credentials setter for BasicAuthCredentials.
+         * @param basicAuthModel The instance of BasicAuthModel.
+         * @return The current instance of builder.
+         */
+        public Builder basicAuthCredentials(BasicAuthModel basicAuthModel) {
+            this.basicAuthModel = basicAuthModel;
+            return this;
+        }
+
         /**
          * Current API environment.
          * @param environment The environment for client.
@@ -398,7 +481,7 @@ public PagarmeApiSDKClient build() {
             httpClient = new OkClient(httpClientConfig.getConfiguration(), compatibilityFactory);
 
             return new PagarmeApiSDKClient(environment, serviceRefererName, httpClient,
-                    httpClientConfig);
+                    httpClientConfig, basicAuthModel, authentications);
         }
     }
 }