Release/1.0.2 (#7)

- Release SDK for gift card service 🚀
- Add support for geographical recharge plan in Airtime SDK
- Bug fixes
- Documentation clean-up & code improvements/optimizations

Author: epiard13

GENERAL-CONTRIBUTING.md

@@ -59,7 +59,7 @@ an Issue to discuss your proposal first. This is not required but can save time
 
 In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr)
 
-1. Fork the repository to your own Github account
+1. Fork the repository to your own GitHub account
 2. Clone the project to your machine
 3. Create a branch locally with a succinct but descriptive name
 4. Commit changes to the branch

README.md

@@ -1,3 +1,5 @@
+<img src="icon.png" width="100" height="105" align="right" alt="reloadly-java-icon"/>
+
 <!--
   Title: Reloadly SDK for Java
   Description: Reloadly Java SDK for sending Airtime Topups to over 4 billion mobile phones.
@@ -7,15 +9,15 @@
 # Reloadly SDK for Java
 
 [![CircleCI][circle-ci-badge]][circle-ci-url]
-[![MIT][mit-badge]][mit-url]
 [![codecov][codecov-badge]][codecov-url]
-<!--[![Maven][maven-badge]][maven-url]-->
+[![MIT][mit-badge]][mit-url]
+[![Maven Central][maven-badge]][maven-url]
 
 The **Reloadly SDK for Java** enables Java developers to easily work with [Reloadly Services][reloadly-main-site]
-and build scalable solutions. For example, you can start sending **Airtime topups** in minutes instead of days by using the **Reloadly SDK for Java**. 
-You can get started by using Maven or any build system that supports MavenCentral as an artifact source.
+and build scalable solutions. You can get started in minutes using Maven or any build system that supports MavenCentral
+as an artifact source.
 
-* [SDK Homepage][sdk-website] (Coming soon)
+* [SDK Homepage][sdk-website]
 * [Sample Code][sample-code]
 * [API Docs][docs-api]
 * [Issues][sdk-issues]
@@ -26,7 +28,7 @@ You can get started by using Maven or any build system that supports MavenCentra
 
 #### Sign up for Reloadly ####
 
-Before you begin, you need a Reloadly account. Please see the [Sign Up for Reloadly][reloadly-signup-help] section of
+Before you begin, you need a Reloadly account. Please see the [Sign-Up for Reloadly][reloadly-signup-help] section of
 the knowledge-base for information about how to create a Reloadly account and retrieve
 your [Reloadly APIs credentials][api-credentials-help].
 
@@ -36,7 +38,7 @@ To run the SDK you will need **Java 1.8+**
 
 ## Using the SDK Modules
 
-The SDK is made up of several modules such as **Authentication, Airtime, etc...**, you can alternatively add
+The SDK is made up of several modules such as **Authentication, Airtime, Giftcard etc...**, you can alternatively add
 dependencies for the specific services you use only. For example : Authentication & Airtime
 ***(currently all modules have the same version, but this may not always be the case)***
 
@@ -45,13 +47,19 @@ dependencies for the specific services you use only. For example : Authenticatio
 Add specific dependencies to your project's build file:
 
 ```groovy
-implementation "software.reloadly:java-sdk-authentication:1.0.0"
+implementation "software.reloadly:java-sdk-authentication:1.0.2"
 ```
 
 **OR**
 
 ```groovy
-implementation "software.reloadly:java-sdk-airtime:1.0.0"
+implementation "software.reloadly:java-sdk-airtime:1.0.2"
+```
+
+**OR**
+
+```groovy
+implementation "software.reloadly:java-sdk-giftcard:1.0.2"
 ```
 
 ### Maven users
@@ -63,7 +71,7 @@ Add specific dependencies to your project's POM:
 <dependency>
     <groupId>software.reloadly</groupId>
     <artifactId>java-sdk-authentication</artifactId>
-    <version>1.0.0</version>
+    <version>1.0.2</version>
 </dependency>
 ```
 
@@ -74,7 +82,18 @@ Add specific dependencies to your project's POM:
 <dependency>
     <groupId>software.reloadly</groupId>
     <artifactId>java-sdk-airtime</artifactId>
-    <version>1.0.0</version>
+    <version>1.0.2</version>
+</dependency>
+```
+
+**OR**
+
+```xml
+
+<dependency>
+    <groupId>software.reloadly</groupId>
+    <artifactId>java-sdk-giftcard</artifactId>
+    <version>1.0.2</version>
 </dependency>
 ```
 
@@ -93,7 +112,7 @@ getting help:
 * Talk to us live on our chat tool on our [website][reloadly-main-site] (bottom right)
 * Ask a question on [StackOverflow][stack-overflow] and tag it with `reloadly-java-sdk`
 * Articulate your feature request or upvote existing ones on our [Issues][features] page
-* Take a look at our [youtube series][youtube-series] for plenty of helpful walkthroughs and tips
+* Take a look at our [YouTube series][youtube-series] for plenty of helpful walkthroughs and tips
 * Open a case via with the [Reloadly Support Center][support-center]
 * If it turns out that you may have found a bug, please open an [issue][sdk-issues]
 
@@ -112,7 +131,7 @@ We need your help in making this SDK great. Please participate in the community
 submitting issues, participating in discussion forums and submitting pull requests through the following channels:
 
 * Submit [issues][sdk-issues] - this is the preferred channel to interact with our team
-* Come join the Reloadly Java community chat on [Gitter][gitter]
+* Come join the Reloadly Java community chat on [Slack][slack]
 * Articulate your feature request or upvote existing ones on our [Issues][features] page
 * Send feedback directly to the team at oss@reloadly.com
 
@@ -122,7 +141,7 @@ This project is licensed under the MIT license. See the [LICENSE](LICENSE) file
 
 [reloadly-main-site]: https://www.reloadly.com/
 
-[sdk-website]: https://sdk.reloadly.com/java
+[sdk-website]: https://docs.reloadly.com/devtools/toolbox/libraries-and-sdks
 
 [reloadly-signup-help]: https://faq.reloadly.com/en/articles/2307724-how-do-i-register-for-my-free-account
 
@@ -132,7 +151,7 @@ This project is licensed under the MIT license. See the [LICENSE](LICENSE) file
 
 [sdk-license]: http://www.reloadly.com/software/apache2.0/
 
-[gitter]: https://gitter.im/reloadly/reloadly-sdk-java
+[slack]: https://reloadly-developers.slack.com/
 
 [sample-code]: https://github.com/reloadly/reloadly-sdk-java/blob/master/SAMPLE-CODE.md
 
@@ -152,9 +171,9 @@ This project is licensed under the MIT license. See the [LICENSE](LICENSE) file
 
 [mit-url]: https://github.com/reloadly/reloadly-sdk-java/raw/master/LICENSE
 
-[maven-badge]: https://img.shields.io/maven-central/v/software.reloadly/java-sdk-airtime.svg?label=Maven%20Central
+[maven-badge]: https://maven-badges.herokuapp.com/maven-central/software.reloadly/java-sdk/badge.svg
 
-[maven-url]: https://search.maven.org/search?q=g:software.reloadly
+[maven-url]: https://maven-badges.herokuapp.com/maven-central/software.reloadly/java-sdk
 
 [circle-ci-badge]: https://circleci.com/gh/Reloadly/reloadly-sdk-java.svg?style=svg&circle-token=f06dbc5f2511715447dd8d62ff00065cb245701e
 

icon.png

@@ -12,7 +12,7 @@ Some key things to keep in mind regarding the Airtime API :
 * The API has 2 environments, SANDBOX (for development & testing) and LIVE.
 * If neither environment is specified, the SDK defaults to SANDBOX
 * Each environment has a set of credentials (client id & secret) that are different from the other.<br />
-    * SANBOX credentials can only be used for SANDBOX environment
+    * SANDBOX credentials can only be used for SANDBOX environment
     * LIVE credentials can only be used for LIVE environment
 * If not environment is specified the SDK defaults to SANDBOX
 * You MUST supply either the credentials, or an access token in order to call the API
@@ -26,14 +26,14 @@ Set the client id & client secret; this is probably the most straight-forward or
 acquired automatically before the API call is made.
 
 ```java
-Request<AccountBalance> request = AirtimeAPI.builder()
+Request<AccountBalanceInfo> request = AirtimeAPI.builder()
         .clientId(clientId)
         .clientSecret(clientSecret)
         .environment(Environment.SANDBOX) //Airtime service has 2 environments, LIVE and SANDBOX. If not environment is specified, the SDK defaults to SANDBOX
         .build()
         .accounts().getBalance();
 
-AccountBalance accountBalance = null;
+AccountBalanceInfo accountBalance = null;
 try {
     accountBalance = request.execute();                                                       
 } catch (APIException e) {
@@ -71,15 +71,15 @@ try {
     // all others
 }
 
-Request<AccountBalance> request = AirtimeAPI.builder()
+Request<AccountBalanceInfo> request = AirtimeAPI.builder()
         .clientId(clientId)
         .clientSecret(clientSecret)
         .accessToken(tokenHolder.getAccessToken()) //Set the access token to be used by here
         .environment(Environment.SANDBOX)
         .build()
         .accounts().getBalance();
 
-AccountBalance accountBalance = null;
+AccountBalanceInfo accountBalance = null;
 try {
     accountBalance = request.execute();                                                       
 } catch (APIException e) {
@@ -139,8 +139,8 @@ AirtimeAPI airtimeAPI = AirtimeAPI.builder()
         .environment(Environment.SANDBOX)
         .build();
 
-AccountBalance balance = null;
-Request<AccountBalance> request = airtimeAPI.accounts().getBalance();
+AccountBalanceInfo balance = null;
+Request<AccountBalanceInfo> request = airtimeAPI.accounts().getBalance();
 try {
     balance = request.execute();
 } catch (APIException e) {

java-sdk-airtime/USAGE.md

@@ -2,33 +2,31 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <modelVersion>4.0.0</modelVersion>
 
     <parent>
         <groupId>software.reloadly</groupId>
         <artifactId>java-sdk</artifactId>
-        <version>1.0.0</version>
+        <version>1.0.2</version>
     </parent>
 
+    <modelVersion>4.0.0</modelVersion>
     <artifactId>java-sdk-airtime</artifactId>
-    <version>1.0.0</version>
+    <version>1.0.2</version>
     <name>Reloadly Java SDK :: Services :: Reloadly Airtime Service</name>
     <url>https://github.com/reloadly/reloadly-sdk-java</url>
 
-    <description>The Reloadly Java SDK for the Auth API. The module holds the client classes
+    <description>The Reloadly Java SDK for the Airtime API. The module holds the client classes
         that are used for communicating with Reloadly Airtime Service.
     </description>
 
     <properties>
-        <nv-i18n.version>1.27</nv-i18n.version>
-        <sdk-authentication.version>1.0.0</sdk-authentication.version>
+        <nv-i18n.version>1.29</nv-i18n.version>
     </properties>
 
     <dependencies>
         <dependency>
             <groupId>software.reloadly</groupId>
             <artifactId>java-sdk-authentication</artifactId>
-            <version>${sdk-authentication.version}</version>
             <optional>false</optional>
         </dependency>
         <dependency>

java-sdk-airtime/pom.xml

@@ -32,6 +32,7 @@ public class AirtimeAPI extends ServiceAPI {
     private final Environment environment;
 
     @Builder
+    @SuppressWarnings("unused")
     public AirtimeAPI(String clientId, String clientSecret, String accessToken,
                       Environment environment, boolean enableLogging,
                       List<String> redactHeaders, HttpOptions options, Boolean enableTelemetry) {
@@ -41,7 +42,7 @@ public AirtimeAPI(String clientId, String clientSecret, String accessToken,
 
         validateCredentials();
         this.environment = environment;
-        baseUrl = createBaseUrl();
+        baseUrl = createBaseUrl(environment);
     }
 
     public OperatorOperations operators() throws ReloadlyException {
@@ -86,10 +87,10 @@ public void refreshAccessToken(Request<?> request) throws ReloadlyException {
         customizableRequest.addHeader(HttpHeader.AUTHORIZATION, "Bearer " + newAccessToken);
     }
 
-    private HttpUrl createBaseUrl() {
+    private HttpUrl createBaseUrl(Environment environment) {
         Service service = getServiceByEnvironment(environment);
         Asserter.assertNotNull(service, "Service");
-        HttpUrl url = HttpUrl.parse(service.getUrl());
+        HttpUrl url = HttpUrl.parse(service.getServiceUrl());
         if (url == null) {
             throw new IllegalArgumentException(
                     "The airtime base url had an invalid format and couldn't be parsed as a URL."

java-sdk-airtime/src/main/java/software/reloadly/sdk/airtime/client/AirtimeAPI.java

@@ -23,6 +23,7 @@ public class EmailTopupRequest extends TopupRequest implements Serializable {
     private final String recipientEmail;
 
     @Builder
+    @SuppressWarnings("unused")
     public EmailTopupRequest(Double amount, Long operatorId, String recipientEmail,
                              Phone senderPhone, boolean useLocalAmount, String customIdentifier) {
 

java-sdk-airtime/src/main/java/software/reloadly/sdk/airtime/dto/request/EmailTopupRequest.java

@@ -23,6 +23,7 @@ public class PhoneTopupRequest extends TopupRequest implements Serializable {
     private final Phone recipientPhone;
 
     @Builder
+    @SuppressWarnings("unused")
     public PhoneTopupRequest(Double amount, Long operatorId,
                              Phone recipientPhone, boolean useLocalAmount, Phone senderPhone, String customIdentifier) {
 

java-sdk-airtime/src/main/java/software/reloadly/sdk/airtime/dto/request/PhoneTopupRequest.java

@@ -2,6 +2,7 @@
 
 import software.reloadly.sdk.airtime.dto.Phone;
 
+@SuppressWarnings("unused")
 public interface Topupable {
     Double getAmount();
     Long getOperatorId();

java-sdk-airtime/src/main/java/software/reloadly/sdk/airtime/dto/request/Topupable.java

@@ -0,0 +1,27 @@
+package software.reloadly.sdk.airtime.dto.response;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+import software.reloadly.sdk.airtime.enums.AirtimeTransactionStatus;
+
+import java.io.Serializable;
+
+@Getter
+@ToString
+@EqualsAndHashCode
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class AirtimeTransactionStatusResponse implements Serializable {
+
+    private static final long serialVersionUID = -107316033333805883L;
+    @JsonProperty("code")
+    private String errorCode;
+    @JsonProperty("message")
+    private String errorMessage;
+    private TopupTransaction transaction;
+    private AirtimeTransactionStatus status;
+}

java-sdk-airtime/src/main/java/software/reloadly/sdk/airtime/dto/response/AirtimeTransactionStatusResponse.java

@@ -0,0 +1,20 @@
+package software.reloadly.sdk.airtime.dto.response;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.ToString;
+
+import java.io.Serializable;
+
+@Getter
+@ToString
+@EqualsAndHashCode
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class AsyncAirtimeResponse implements Serializable {
+
+    private static final long serialVersionUID = -6885242699797871608L;
+    private Long transactionId;
+}

java-sdk-airtime/src/main/java/software/reloadly/sdk/airtime/dto/response/AsyncAirtimeResponse.java

@@ -9,6 +9,7 @@
 @Getter
 @ToString
 @EqualsAndHashCode
+@SuppressWarnings("unused")
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class FxRate implements Serializable {

java-sdk-airtime/src/main/java/software/reloadly/sdk/airtime/dto/response/FxRate.java

@@ -0,0 +1,30 @@
+package software.reloadly.sdk.airtime.dto.response;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import lombok.*;
+
+import java.io.Serializable;
+import java.math.BigDecimal;
+import java.util.TreeMap;
+import java.util.TreeSet;
+
+@Getter
+@Setter
+@ToString
+@NoArgsConstructor
+@AllArgsConstructor
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class GeographicalRechargePlan implements Serializable {
+
+    private static final long serialVersionUID = -5652377401301285195L;
+    private String locationCode;
+    private String locationName;
+    private TreeSet<BigDecimal> fixedAmounts;
+    private TreeSet<BigDecimal> localAmounts;
+    private TreeMap<BigDecimal, String> fixedAmountsPlanNames;
+    private TreeMap<BigDecimal, String> fixedAmountsDescriptions;
+    private TreeMap<BigDecimal, String> localFixedAmountsPlanNames;
+    private TreeMap<BigDecimal, String> localFixedAmountsDescriptions;
+}