Deprecate basic auth

CHANGELOG.md

@@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [3.0.0-RC3-SNAPSHOT]
+### Changed
+- `pl.smsapi.BasicAuthClient` marked as deprecated
+
+### Removed
+- deprecated `pl.smsapi.proxy.Proxy#execute` method
+
 ## [3.0.0-RC2] - 2024-03-04
 ### Changed
 - build process

src/main/java/pl/smsapi/BasicAuthClient.java

@@ -6,24 +6,32 @@
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
 
+/**
+ * @deprecated use {@link OAuthClient} instead
+ */
+@Deprecated
 public class BasicAuthClient implements Client {
     private final String username;
     private final String password;
 
-    public BasicAuthClient(String username, String password) throws ClientException {
+    public BasicAuthClient(String username, String password) {
         assert username != null && !username.isEmpty() : "Username is empty";
         assert password != null && !password.isEmpty() : "Password is empty";
         this.username = username;
         this.password = password;
     }
 
+    public String getUsername() {
+        return username;
+    }
+
     public static String MD5Digest(String str) throws ClientException {
         try {
             MessageDigest md = MessageDigest.getInstance("MD5");
 
             md.update(str.getBytes());
 
-            byte byteData[] = md.digest();
+            byte[] byteData = md.digest();
 
             StringBuilder sb = new StringBuilder();
             for (byte b : byteData) {
@@ -41,10 +49,6 @@ public static BasicAuthClient createFromRawPassword(String username, String pass
         return new BasicAuthClient(username, MD5Digest(password));
     }
 
-    public String getUsername() {
-        return username;
-    }
-
     @Override
     public BasicAuthenticationStrategy getAuthenticationStrategy() {
         return new BasicAuthenticationStrategy(username, password);

src/main/java/pl/smsapi/api/authenticationStrategy/BasicAuthenticationStrategy.java

@@ -2,6 +2,7 @@
 
 import org.apache.commons.codec.binary.Base64;
 
+@Deprecated
 public class BasicAuthenticationStrategy implements AuthenticationStrategy {
     private String username;
     private String password;

src/main/java/pl/smsapi/proxy/Proxy.java

@@ -7,6 +7,5 @@
 
 public interface Proxy {
 
-    public String execute(String endpoint, Map<String, String> data, Map<String, InputStream> files) throws Exception;
-    public String execute(String endpoint, Map<String, String> data, Map<String, InputStream> files, String httpMethod, AuthenticationStrategy authenticationStrategy) throws Exception;
+    String execute(String endpoint, Map<String, String> data, Map<String, InputStream> files, String httpMethod, AuthenticationStrategy authenticationStrategy) throws Exception;
 }

src/main/java/pl/smsapi/proxy/ProxyNative.java

@@ -1,7 +1,6 @@
 package pl.smsapi.proxy;
 
 import pl.smsapi.api.authenticationStrategy.AuthenticationStrategy;
-import pl.smsapi.api.authenticationStrategy.BasicAuthenticationStrategy;
 
 import java.io.*;
 import java.net.HttpURLConnection;
@@ -20,21 +19,6 @@ public ProxyNative(String url) {
         this.baseUrl = url;
     }
 
-    /**
-     * @deprecated
-     */
-    public String execute(String endpoint, Map<String, String> data, Map<String, InputStream> files) throws Exception {
-        String username = data.get("username");
-        data.remove("username");
-
-        String password = data.get("password");
-        data.remove("password");
-
-        AuthenticationStrategy authenticationStrategy = new BasicAuthenticationStrategy(username, password);
-
-        return execute(endpoint, data, files, "POST", authenticationStrategy);
-    }
-
     /**
      * Execute
      * <p/>

src/test/java/pl/smsapi/test/TestSmsapi.java

@@ -1,7 +1,8 @@
 package pl.smsapi.test;
 
 import org.junit.Ignore;
-import pl.smsapi.BasicAuthClient;
+import pl.smsapi.Client;
+import pl.smsapi.OAuthClient;
 import pl.smsapi.api.response.MessageResponse;
 import pl.smsapi.exception.ClientException;
 import pl.smsapi.proxy.Proxy;
@@ -13,19 +14,8 @@
 public class TestSmsapi {
     protected String fileToIds = "_ids_test.txt";
 
-    protected BasicAuthClient getAuthorizationClient() {
-
-        try {
-            return BasicAuthClient.createFromRawPassword("<username>", "<password>");
-        } catch (ClientException ex) {
-            /*
-             * 101 Niepoprawne lub brak danych autoryzacji. 102 Nieprawidłowy login lub hasło 103 Brak punków dla tego
-             * użytkownika 105 Błędny adres IP 110 Usługa nie jest dostępna na danym koncie 1000 Akcja dostępna tylko
-             * dla użytkownika głównego 1001 Nieprawidłowa akcja
-             */
-            System.out.println(ex.getMessage());
-        }
-        return null;
+    protected Client getAuthorizationClient() throws ClientException {
+        return new OAuthClient("<token>");
     }
 
     protected String[] readIds() {

src/test/java/pl/smsapi/test/doubles/ProxyMock.java

@@ -9,11 +9,6 @@
 public class ProxyMock implements Proxy {
     public AuthenticationStrategy lastUsedAuthenticationStrategy;
 
-    @Override
-    public String execute(String endpoint, Map<String, String> data, Map<String, InputStream> files) throws Exception {
-        return null;
-    }
-
     @Override
     public String execute(String endpoint, Map<String, String> data, Map<String, InputStream> files, String httpMethod, AuthenticationStrategy authenticationStrategy) throws Exception {
         lastUsedAuthenticationStrategy = authenticationStrategy;

src/test/java/pl/smsapi/test/integration/AbstractActionTest.java

@@ -14,7 +14,7 @@
 public class AbstractActionTest {
     @Test
     public void testItShouldAuthenticateUsingBasicStrategyWhenUsingBasicAuthClient() throws SmsapiException {
-        BasicAuthClient client = BasicAuthClient.createFromRawPassword("<username>", "<password>");
+        BasicAuthClient client = new BasicAuthClient("<username>", "<password>");
         ProxyMock proxy = new ProxyMock();
 
         ActionMock action = new ActionMock();

src/test/java/pl/smsapi/test/run/MmsTest.java

@@ -10,6 +10,7 @@
 import pl.smsapi.api.response.CountableResponse;
 import pl.smsapi.api.response.MessageResponse;
 import pl.smsapi.api.response.StatusResponse;
+import pl.smsapi.exception.ClientException;
 import pl.smsapi.exception.SmsapiException;
 import pl.smsapi.test.TestSmsapi;
 
@@ -23,7 +24,7 @@ public class MmsTest extends TestSmsapi {
     MmsFactory apiFactory;
 
     @Before
-    public void setUp() {
+    public void setUp() throws ClientException {
         apiFactory = new MmsFactory(getAuthorizationClient(), getProxy());
     }
 

src/test/java/pl/smsapi/test/run/PhonebookTest.java

@@ -6,6 +6,7 @@
 import pl.smsapi.api.PhonebookFactory;
 import pl.smsapi.api.action.phonebook.*;
 import pl.smsapi.api.response.*;
+import pl.smsapi.exception.ClientException;
 import pl.smsapi.exception.SmsapiException;
 import pl.smsapi.test.TestSmsapi;
 
@@ -21,7 +22,7 @@ public class PhonebookTest extends TestSmsapi {
     PhonebookFactory apiFactory;
 
     @Before
-    public void setUp() {
+    public void setUp() throws ClientException {
         apiFactory = new PhonebookFactory(getAuthorizationClient(), getProxy());
     }
 

src/test/java/pl/smsapi/test/run/SenderTest.java

@@ -7,6 +7,7 @@
 import pl.smsapi.api.response.CountableResponse;
 import pl.smsapi.api.response.SenderResponse;
 import pl.smsapi.api.response.SendersResponse;
+import pl.smsapi.exception.ClientException;
 import pl.smsapi.exception.SmsapiException;
 import pl.smsapi.test.TestSmsapi;
 
@@ -17,7 +18,7 @@ public class SenderTest extends TestSmsapi {
     SenderFactory apiFactory;
 
     @Before
-    public void setUp() {
+    public void setUp() throws ClientException {
         apiFactory = new SenderFactory(getAuthorizationClient(), getProxy());
     }
 

src/test/java/pl/smsapi/test/run/SmsTest.java

@@ -11,6 +11,7 @@
 import pl.smsapi.api.response.MessageResponse;
 import pl.smsapi.api.response.SendStatusResponse;
 import pl.smsapi.api.response.StatusResponse;
+import pl.smsapi.exception.ClientException;
 import pl.smsapi.exception.SmsapiException;
 import pl.smsapi.test.TestSmsapi;
 
@@ -25,7 +26,7 @@ public class SmsTest extends TestSmsapi {
     private String[] ids;
 
     @Before
-    public void setUp() {
+    public void setUp() throws ClientException {
         apiFactory = new SmsFactory(getAuthorizationClient(), getProxy());
     }
 

src/test/java/pl/smsapi/test/run/UserTest.java

@@ -9,6 +9,7 @@
 import pl.smsapi.api.response.PointsResponse;
 import pl.smsapi.api.response.UserResponse;
 import pl.smsapi.api.response.UsersResponse;
+import pl.smsapi.exception.ClientException;
 import pl.smsapi.exception.SmsapiException;
 import pl.smsapi.test.TestSmsapi;
 
@@ -21,7 +22,7 @@ public class UserTest extends TestSmsapi {
     UserFactory apiFactory;
 
     @Before
-    public void setUp() {
+    public void setUp() throws ClientException {
         apiFactory = new UserFactory(getAuthorizationClient(), getProxy());
     }
 

src/test/java/pl/smsapi/test/run/VmsTest.java

@@ -10,6 +10,7 @@
 import pl.smsapi.api.response.CountableResponse;
 import pl.smsapi.api.response.MessageResponse;
 import pl.smsapi.api.response.StatusResponse;
+import pl.smsapi.exception.ClientException;
 import pl.smsapi.exception.SmsapiException;
 import pl.smsapi.test.TestSmsapi;
 
@@ -25,7 +26,7 @@ public class VmsTest extends TestSmsapi {
     VmsFactory apiFactory;
 
     @Before
-    public void setUp() {
+    public void setUp() throws ClientException {
         apiFactory = new VmsFactory(getAuthorizationClient(), getProxy());
     }