Merge pull request #26 from smsapi/v3

v3

Author: maciejlew

.github/workflows/publish-package.yml

@@ -0,0 +1,36 @@
+name: Publish package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Maven Central Repository
+      uses: actions/setup-java@v4
+      with:
+        java-version: '8'
+        distribution: 'temurin'
+        server-id: central
+        server-username: MAVEN_USERNAME
+        server-password: MAVEN_PASSWORD
+
+    - name: Build with Maven
+      run: mvn --batch-mode package --file pom.xml
+
+    - name: Publish to Maven Central Repository
+      run: mvn --batch-mode deploy
+      env:
+        MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+        MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
+        MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_CENTRAL_GPG_SECRET_KEY_PASSWORD }}
+        MAVEN_GPG_KEY: ${{ secrets.MAVEN_CENTRAL_GPG_SECRET_KEY }}

.gitignore

@@ -4,4 +4,9 @@ build.xml
 manifest.mf
 _ids_test.txt
 /.idea/
-/*.iml
+/*.iml
+/target/
+/pom.xml.releaseBackup
+/release.properties
+
+/src/test/config/config.json

CHANGELOG.md

@@ -0,0 +1,73 @@
+# Changelog
+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).
+
+## [Unreleased]
+
+## [3.0.0-RC17] - 2024-10-29
+### Changed
+- `pl.smsapi.api.action.subusers.SubuserAdd` and `pl.smsapi.api.action.subusers.SubuserEdit` actions setters, fluent interface added
+
+## [3.0.0-RC5 - 3.0.0-RC16] - 2024-09-23
+### Changed
+- build process
+
+## [3.0.0-RC4]
+### Added
+- new Sendernames API
+- new Contacts API
+- Subusers API
+- `pl.smsapi.exception.SmsapiErrorException` to handle API error responses
+- `date_sent` to SMS/MMS send action responses
+- `time_restriction` parameter for SMS send action
+- HLR action factory, `HlrFactory`
+- HLR with IDX support
+
+### Changed
+- `pl.smsapi.api.UserFactory.actionAdd` marked as deprecated, use `pl.smsapi.api.action.subusers.SubusersFactory.actionAdd` instead
+- `pl.smsapi.api.UserFactory.actionEdit` marked as deprecated, use `pl.smsapi.api.action.subusers.SubusersFactory.actionEdit` instead
+- `pl.smsapi.api.UserFactory.actionList` marked as deprecated, use `pl.smsapi.api.action.subusers.SubusersFactory.actionList` instead
+- `pl.smsapi.api.action.user.UserAdd` marked as deprecated, use `pl.smsapi.api.action.subusers.SubuserAdd` instead
+- `pl.smsapi.api.action.user.UserEdit` marked as deprecated, use `pl.smsapi.api.action.subusers.SubuserEdit` instead
+- `pl.smsapi.api.action.user.UserGet` marked as deprecated, use `pl.smsapi.api.action.subusers.SubuserGet` instead
+- `pl.smsapi.api.action.user.UserList` marked as deprecated, use `pl.smsapi.api.action.subusers.SubusersList` instead
+- `pl.smsapi.BasicAuthClient` marked as deprecated
+- non-proxy action factories marked as deprecated
+- `pl.smsapi.api.ContactsFactory` marked as deprecated, use `pl.smsapi.api.action.contacts.ContactsFactory` or `pl.smsapi.api.action.contacts.groups.GroupsFactory` instead
+- `pl.smsapi.exception.ActionException` marked as deprecated, use `pl.smsapi.exception.SmsapiLegacyErrorException` instead
+- `pl.smsapi.exception.ClientException` marked as deprecated, use `pl.smsapi.exception.SmsapiLegacyErrorException` instead
+- `pl.smsapi.exception.HostException` marked as deprecated, use `pl.smsapi.exception.SmsapiLegacyErrorException` instead
+- all client and server side errors are now being translated to `pl.smsapi.exception.SmsapiErrorException` or `pl.smsapi.exception.SmsapiLegacyErrorException`
+- `pl.smsapi.api.VmsFactory.actionSend` without parameters marked as deprecated
+- `pl.smsapi.api.VmsFactory.actionGet` without parameters marked as deprecated
+- `pl.smsapi.api.VmsFactory.actionDelete` without parameters marked as deprecated
+- `pl.smsapi.api.action.vms.VMSDelete` without parameters marked as deprecated
+- `pl.smsapi.api.action.vms.VMSGet` without parameters marked as deprecated
+- `pl.smsapi.api.action.vms.VMSSend` without parameters marked as deprecated
+- `pl.smsapi.api.SmsFactory.actionSend` without parameters marked as deprecated
+- `pl.smsapi.api.action.sms.SMSSend` without parameters marked as deprecated
+- `pl.smsapi.api.SmsFactory.actionGet` without parameters marked as deprecated
+- `pl.smsapi.api.action.sms.SMSGet` without parameters marked as deprecated
+- `pl.smsapi.api.SmsFactory.actionDelete` without parameters marked as deprecated
+- `pl.smsapi.api.action.sms.SMSDelete` without parameters marked as deprecated
+- `pl.smsapi.api.action.hlr.HLRCheckNumber` without parameters marked as deprecated
+- `pl.smsapi.api.action.sender.SenderAdd` marked as deprecated, use `pl.smsapi.api.action.sms.sendernames.SendernameAdd` instead
+- `pl.smsapi.api.action.sender.SenderDefault` marked as deprecated, use `pl.smsapi.api.action.sms.sendernames.SendernameMakeDefault` instead
+- `pl.smsapi.api.action.sender.SenderDelete` marked as deprecated, use `pl.smsapi.api.action.sms.sendernames.SendernameDelete` instead
+- `pl.smsapi.api.action.sender.SenderList` marked as deprecated, use `pl.smsapi.api.action.sms.sendernames.SendernamesList` instead
+- `pl.smsapi.api.SenderFactory` marked as deprecated, use `pl.smsapi.api.action.sms.sendernames.SendernamesFactory` instead
+
+### Removed
+- legacy `phonebook.do` contacts API support
+
+### Removed
+- deprecated `pl.smsapi.proxy.Proxy#execute` method
+
+## [3.0.0-RC2 - 3.0.0-RC3] - 2024-03-04
+### Changed
+- build process
+
+## [3.0.0-RC1] - 2024-03-01
+### Changed
+- Java 6 support dropped

LICENSE renamed to LICENSE.md

@@ -2,66 +2,20 @@
 
 ## How to install
 
-JARs, POMs and docs available are at https://labs.smsapi.com/maven.
-
-Library https://github.com/douglascrockford/JSON-java is required.
-
-### How to install using Maven
+### How to install using Maven Central Repository
 
 Add following in your project **pom.xml** file:
 
- * in `<repositories>` section add SMSAPI repository:
-
-```xml
-<repository>
-    <releases>
-        <enabled>true</enabled>
-        <updatePolicy>always</updatePolicy>
-        <checksumPolicy>fail</checksumPolicy>
-    </releases>
-    <id>smsapi</id>
-    <name>smsapi</name>
-    <url>https://labs.smsapi.com/maven/</url>
-    <layout>default</layout>
-</repository>
-```
-
  * in `<dependencies>` section add SMSAPI dependency:
 
 ```xml
 <dependency>
     <groupId>pl.smsapi</groupId>
     <artifactId>smsapi-lib</artifactId>
-    <version>2.4</version>
+    <version>3.0.0-RC15</version>
 </dependency>
 ```
 
-### How to install using Gradle
-
-Add following in your project **build.gradle** file:
-
- * in `plugins` section:
-
-```
-id 'java'
-id 'java-library'
-```
-
- * in `repositories` section:
-
-```
-mavenCentral()
-maven {
-    url 'https://labs.smsapi.com/maven/'
-}
-```
-
- * in `dependencies` section:
-
-```
-api 'pl.smsapi:smsapi-lib:2.5'
-```
-
 ## How to use
 
 To use *SMSAPI.PL* set proxy URL to **https://api.smsapi.pl/**. \
@@ -97,20 +51,15 @@ public class Example {
 
             SmsFactory smsApi = new SmsFactory(client, proxy);
 
-            SMSSend action = smsApi.actionSend()
-                    .setTo("000000000")
-                    .setText("test");
+            SMSSend action = smsApi.actionSend("000000000", "test message");
 
             StatusResponse result = action.execute();
 
-            Optional<MessageResponse> status = result.getList().stream().findFirst();
-            if (status.isEmpty()) {
-                throw new RuntimeException();
-            }
+            MessageResponse status = result.getList().get(0);
 
-            System.out.println("Phone number: " + status.get().getNumber());
-            System.out.println("Shipment id: " + status.get().getId());
-            System.out.println("Shipment status: " + status.get().getStatus());
+            System.out.println("Phone number: " + status.getNumber());
+            System.out.println("Shipment id: " + status.getId());
+            System.out.println("Shipment status: " + status.getStatus());
 
         } catch (SmsapiException e) {
             System.out.println("Exception: " + e.getMessage());
@@ -151,9 +100,7 @@ public class Example {
 
             String[] to = {"000000000", "000000001"};
 
-            SMSSend action = smsApi.actionSend()
-                    .setTo(to)
-                    .setText("test");
+            SMSSend action = smsApi.actionSend(to, "test message");
 
             StatusResponse result = action.execute();
 
@@ -203,29 +150,14 @@ public class Example2ci {
             SMSGet getAction = smsApi.actionGet(shipmentId);
 
             StatusResponse shipmentStatus = getAction.execute();
-            Optional<MessageResponse> statusAfterGet = shipmentStatus.getList().stream().findFirst();
-            if (statusAfterGet.isEmpty()) {
-                throw new RuntimeException();
-            }
+            MessageResponse statusAfterGet = shipmentStatus.getList().get(0);
 
-            System.out.println("Phone number: " + statusAfterGet.get().getNumber());
-            System.out.println("Shipment id: " + statusAfterGet.get().getId());
-            System.out.println("Shipment status: " + statusAfterGet.get().getStatus());
+            System.out.println("Phone number: " + statusAfterGet.getNumber());
+            System.out.println("Shipment id: " + statusAfterGet.getId());
+            System.out.println("Shipment status: " + statusAfterGet.getStatus());
         } catch (SmsapiException e) {
             System.out.println("Exception: " + e.getMessage());
         }
     }
 }
 ```
-
-## JAVADOC
-[2.3](http://labs.smsapi.com/docs/javadoc/pl/smsapi/smsapi-lib/2.3/)
-
-[2.2](http://labs.smsapi.com/docs/javadoc/pl/smsapi/smsapi-lib/2.2/)
-
-[2.1](http://labs.smsapi.com/docs/javadoc/pl/smsapi/smsapi-lib/2.1/)
-
-[2.0](http://labs.smsapi.com/docs/javadoc/pl/smsapi/smsapi-lib/2.0/)
-
-## LICENSE
-[Apache 2.0 License](https://github.com/smsapi/smsapi-java-client/blob/master/LICENSE)