chore: client interface, package name ficups, etc.

Author: matoous

.github/workflows/release-pr-maintenance.yaml

@@ -35,7 +35,7 @@ jobs:
             const readmePath = 'README.md';
             const original = fs.readFileSync(readmePath, 'utf8');
 
-            const kotlinGradlePattern = /(implementation\("com\.sumup:sumup:)([^"]+)("\))/;
+            const kotlinGradlePattern = /(implementation\("com\.sumup:sumup-sdk:)([^"]+)("\))/;
             let kotlinGradleUpdated = false;
             const afterKotlinGradle = original.replace(
               kotlinGradlePattern,
@@ -49,7 +49,7 @@ jobs:
             }
 
             const groovyGradlePattern =
-              /(implementation\s+['"]com\.sumup:sumup:)([^'"]+)(['"])/;
+              /(implementation\s+['"]com\.sumup:sumup-sdk:)([^'"]+)(['"])/;
             let groovyGradleUpdated = false;
             const afterGradle = afterKotlinGradle.replace(
               groovyGradlePattern,

.github/workflows/release.yaml

@@ -62,4 +62,4 @@ jobs:
           cache: gradle
 
       - name: Publish artifacts
-        run: ./gradlew :sumup:sonatypeCentralUpload
+        run: ./gradlew :sumup-sdk:sonatypeCentralUpload

README.md

@@ -2,7 +2,7 @@
 
 # SumUp Java SDK
 
-[![Maven Central Version](https://img.shields.io/maven-central/v/com.sumup/sumup?strategy=releaseProperty)](https://mvnrepository.com/artifact/com.sumup/sumup)
+[![Maven Central Version](https://img.shields.io/maven-central/v/com.sumup/sumup-sdk?strategy=releaseProperty)](https://mvnrepository.com/artifact/com.sumup/sumup-sdk)
 [![Documentation][docs-badge]](https://developer.sumup.com)
 [![CI Status](https://github.com/sumup/sumup-java/actions/workflows/ci.yaml/badge.svg)](https://github.com/sumup/sumup-java/actions/workflows/ci.yaml)
 [![License](https://img.shields.io/github/license/sumup/sumup-java)](./LICENSE)
@@ -21,7 +21,7 @@ Add the dependency in your `build.gradle.kts` file:
 
 ```kotlin
 dependencies {
-    implementation("com.sumup:sumup:0.0.5")
+    implementation("com.sumup:sumup-sdk:0.0.5")
 }
 ```
 
@@ -31,7 +31,7 @@ Add the dependency in your `build.gradle` file:
 
 ```groovy
 dependencies {
-    implementation 'com.sumup:sumup:0.0.5'
+    implementation 'com.sumup:sumup-sdk:0.0.5'
 }
 ```
 
@@ -42,7 +42,7 @@ Add the dependency in your `pom.xml` file:
 ```xml
 <dependency>
   <groupId>com.sumup</groupId>
-  <artifactId>sumup</artifactId>
+  <artifactId>sumup-sdk</artifactId>
   <version>0.0.5</version>
 </dependency>
 ```
@@ -55,21 +55,25 @@ Authenticate with a personal access token before making calls:
 export SUMUP_API_KEY="my-token"
 ```
 
-Create synchronous and asynchronous clients using the provided builders:
+Create clients using the default constructor (reads `SUMUP_API_KEY`):
 
 ```java
-String apiKey = System.getenv("SUMUP_API_KEY");
+SumUpClient client = new SumUpClient();
+SumUpAsyncClient asyncClient = new SumUpAsyncClient();
+```
+
+Or pass the API key explicitly:
+
+```java
+SumUpClient client = new SumUpClient("api-key");
+```
+
+If you need more configuration, use the builder:
 
+```java
 SumUpClient client =
     SumUpClient.builder()
         .environment(SumUpEnvironment.PRODUCTION)
-        .accessToken(apiKey)
-        .build();
-
-SumUpAsyncClient asyncClient =
-    SumUpAsyncClient.builder()
-        .environment(SumUpEnvironment.PRODUCTION)
-        .accessToken(apiKey)
         .build();
 ```
 
@@ -86,11 +90,9 @@ import com.sumup.sdk.models.CheckoutCreateRequest;
 import com.sumup.sdk.models.Currency;
 import java.util.UUID;
 
-String apiKey = System.getenv("SUMUP_API_KEY");
 SumUpClient client =
     SumUpClient.builder()
         .environment(SumUpEnvironment.PRODUCTION)
-        .accessToken(apiKey)
         .build();
 
 String merchantCode = client.merchant().getMerchantProfile().merchantCode();
@@ -121,11 +123,9 @@ import com.sumup.sdk.models.Currency;
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
 
-String apiKey = System.getenv("SUMUP_API_KEY");
 SumUpAsyncClient client =
     SumUpAsyncClient.builder()
         .environment(SumUpEnvironment.PRODUCTION)
-        .accessToken(apiKey)
         .build();
 
 CompletableFuture<Void> checkoutFuture =
@@ -170,13 +170,11 @@ import com.sumup.sdk.models.Money;
 import java.util.Optional;
 import java.util.UUID;
 
-String apiKey = System.getenv("SUMUP_API_KEY");
 String merchantCode = System.getenv("SUMUP_MERCHANT_CODE");
 
 SumUpClient client =
     SumUpClient.builder()
         .environment(SumUpEnvironment.PRODUCTION)
-        .accessToken(apiKey)
         .build();
 
 String readerId =
@@ -215,13 +213,11 @@ import java.util.Optional;
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
 
-String apiKey = System.getenv("SUMUP_API_KEY");
 String merchantCode = System.getenv("SUMUP_MERCHANT_CODE");
 
 SumUpAsyncClient client =
     SumUpAsyncClient.builder()
         .environment(SumUpEnvironment.PRODUCTION)
-        .accessToken(apiKey)
         .build();
 
 CompletableFuture<String> readerIdFuture =

codegen/internal/generator/templates/sumup_client.tmpl

@@ -14,6 +14,30 @@ public final class {{ .ClassName }} {
     private final {{ .ClassName }} {{ .FieldName }};
 {{- end }}
 
+    /**
+     * Creates a {{ .ClassName }} using the API key from the SUMUP_API_KEY environment variable.
+     */
+    public {{ .ClassName }}() {
+        this(readApiKeyFromEnv());
+    }
+
+    /**
+     * Creates a {{ .ClassName }} using the provided API key.
+     *
+     * @param apiKey API key used to authorize requests.
+     */
+    public {{ .ClassName }}(String apiKey) {
+        this(ApiClient.builder().accessToken(Objects.requireNonNull(apiKey, "apiKey")).build());
+    }
+
+    private static String readApiKeyFromEnv() {
+        String apiKey = System.getenv("SUMUP_API_KEY");
+        if (apiKey == null || apiKey.isBlank()) {
+            throw new IllegalStateException("SUMUP_API_KEY environment variable is not set");
+        }
+        return apiKey;
+    }
+
     /**
      * Creates a {{ .ClassName }} using the provided ApiClient.
      *

examples/basic/build.gradle

@@ -8,5 +8,5 @@ application {
 }
 
 dependencies {
-    implementation project(':sumup')
+    implementation project(':sumup-sdk')
 }

examples/basic/src/main/java/com/sumup/examples/basic/BasicExample.java

@@ -1,7 +1,6 @@
 package com.sumup.examples.basic;
 
 import com.sumup.sdk.SumUpClient;
-import com.sumup.sdk.SumUpEnvironment;
 import com.sumup.sdk.core.ApiException;
 import java.util.List;
 
@@ -16,14 +15,7 @@ public final class BasicExample {
   private BasicExample() {}
 
   public static void main(String[] args) {
-    String apiKey = System.getenv("SUMUP_API_KEY");
-    if (apiKey == null || apiKey.isBlank()) {
-      System.err.println("SUMUP_API_KEY environment variable must be set.");
-      return;
-    }
-
-    SumUpClient client =
-        SumUpClient.builder().environment(SumUpEnvironment.PRODUCTION).accessToken(apiKey).build();
+    SumUpClient client = new SumUpClient();
 
     try {
       List<com.sumup.sdk.models.CheckoutSuccess> checkouts = client.checkouts().listCheckouts();

examples/card-reader-checkout/build.gradle

@@ -8,5 +8,5 @@ application {
 }
 
 dependencies {
-    implementation project(':sumup')
+    implementation project(':sumup-sdk')
 }

examples/card-reader-checkout/src/main/java/com/sumup/examples/cardreader/CardReaderCheckoutExample.java

@@ -1,7 +1,6 @@
 package com.sumup.examples.cardreader;
 
 import com.sumup.sdk.SumUpClient;
-import com.sumup.sdk.SumUpEnvironment;
 import com.sumup.sdk.core.ApiException;
 import com.sumup.sdk.models.CreateReaderCheckoutRequest;
 import com.sumup.sdk.models.Money;
@@ -14,11 +13,9 @@ public final class CardReaderCheckoutExample {
   private CardReaderCheckoutExample() {}
 
   public static void main(String[] args) {
-    String apiKey = requireEnv("SUMUP_API_KEY");
     String merchantCode = requireEnv("SUMUP_MERCHANT_CODE");
 
-    SumUpClient client =
-        SumUpClient.builder().environment(SumUpEnvironment.PRODUCTION).accessToken(apiKey).build();
+    SumUpClient client = new SumUpClient();
 
     Optional<String> readerId =
         client.readers().listReaders(merchantCode).items().stream()

settings.gradle

@@ -1,8 +1,7 @@
 rootProject.name = 'sumup-java'
 
-include(':sumup')
-project(':sumup').projectDir = file('src')
-project(':sumup').name = 'sumup-sdk'
+include(':sumup-sdk')
+project(':sumup-sdk').projectDir = file('src')
 
 include(':examples:basic')
 project(':examples:basic').projectDir = file('examples/basic')

src/main/java/com/sumup/sdk/SumUpAsyncClient.java

@@ -37,6 +37,28 @@ public final class SumUpAsyncClient {
   private final SubaccountsAsyncClient subaccounts;
   private final TransactionsAsyncClient transactions;
 
+  /** Creates a SumUpAsyncClient using the API key from the SUMUP_API_KEY environment variable. */
+  public SumUpAsyncClient() {
+    this(readApiKeyFromEnv());
+  }
+
+  /**
+   * Creates a SumUpAsyncClient using the provided API key.
+   *
+   * @param apiKey API key used to authorize requests.
+   */
+  public SumUpAsyncClient(String apiKey) {
+    this(ApiClient.builder().accessToken(Objects.requireNonNull(apiKey, "apiKey")).build());
+  }
+
+  private static String readApiKeyFromEnv() {
+    String apiKey = System.getenv("SUMUP_API_KEY");
+    if (apiKey == null || apiKey.isBlank()) {
+      throw new IllegalStateException("SUMUP_API_KEY environment variable is not set");
+    }
+    return apiKey;
+  }
+
   /**
    * Creates a SumUpAsyncClient using the provided ApiClient.
    *