@ahmttyydn/java-integration 1.0.1

package/scalar-core/src/test/java/com/scalar/maven/core/config/ScalarServerTest.java

@@ -0,0 +1,118 @@
+package com.scalar.maven.core.config;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@DisplayName("ScalarServer")
+class ScalarServerTest {
+
+    @Nested
+    @DisplayName("construction")
+    class Construction {
+
+        @Test
+        @DisplayName("should create server with default constructor")
+        void shouldCreateServerWithDefaultConstructor() {
+            ScalarServer server = new ScalarServer();
+            assertThat(server).isNotNull();
+            assertThat(server.getUrl()).isNull();
+            assertThat(server.getDescription()).isNull();
+            assertThat(server.getVariables()).isNull();
+        }
+
+        @Test
+        @DisplayName("should create server with URL")
+        void shouldCreateServerWithUrl() {
+            String url = "https://api.example.com";
+            ScalarServer server = new ScalarServer(url);
+            assertThat(server.getUrl()).isEqualTo(url);
+        }
+
+        @Test
+        @DisplayName("should create server with URL and description")
+        void shouldCreateServerWithUrlAndDescription() {
+            String url = "https://api.example.com";
+            String description = "Production API";
+            ScalarServer server = new ScalarServer(url, description);
+            assertThat(server.getUrl()).isEqualTo(url);
+            assertThat(server.getDescription()).isEqualTo(description);
+        }
+    }
+
+    @Nested
+    @DisplayName("properties")
+    class Properties {
+
+        @Test
+        @DisplayName("should set and get URL")
+        void shouldSetAndGetUrl() {
+            ScalarServer server = new ScalarServer();
+            String url = "https://api.example.com";
+            server.setUrl(url);
+            assertThat(server.getUrl()).isEqualTo(url);
+        }
+
+        @Test
+        @DisplayName("should set and get description")
+        void shouldSetAndGetDescription() {
+            ScalarServer server = new ScalarServer();
+            String description = "Production API";
+            server.setDescription(description);
+            assertThat(server.getDescription()).isEqualTo(description);
+        }
+
+        @Test
+        @DisplayName("should set and get variables")
+        void shouldSetAndGetVariables() {
+            ScalarServer server = new ScalarServer();
+            Map<String, ScalarServer.ServerVariable> variables = new HashMap<>();
+            ScalarServer.ServerVariable variable = new ScalarServer.ServerVariable("default");
+            variables.put("env", variable);
+            server.setVariables(variables);
+            assertThat(server.getVariables()).isEqualTo(variables);
+            assertThat(server.getVariables().get("env")).isEqualTo(variable);
+        }
+    }
+
+    @Nested
+    @DisplayName("ServerVariable")
+    class ServerVariableTests {
+
+        @Test
+        @DisplayName("should create variable with default constructor")
+        void shouldCreateVariableWithDefaultConstructor() {
+            ScalarServer.ServerVariable variable = new ScalarServer.ServerVariable();
+            assertThat(variable).isNotNull();
+            assertThat(variable.getDefaultValue()).isNull();
+            assertThat(variable.getDescription()).isNull();
+            assertThat(variable.getEnumValues()).isNull();
+        }
+
+        @Test
+        @DisplayName("should create variable with default value")
+        void shouldCreateVariableWithDefaultValue() {
+            String defaultValue = "production";
+            ScalarServer.ServerVariable variable = new ScalarServer.ServerVariable(defaultValue);
+            assertThat(variable.getDefaultValue()).isEqualTo(defaultValue);
+        }
+
+        @Test
+        @DisplayName("should set and get properties")
+        void shouldSetAndGetProperties() {
+            ScalarServer.ServerVariable variable = new ScalarServer.ServerVariable();
+            variable.setDefaultValue("production");
+            variable.setDescription("Environment");
+            variable.setEnumValues(new String[]{"production", "staging", "development"});
+            assertThat(variable.getDefaultValue()).isEqualTo("production");
+            assertThat(variable.getDescription()).isEqualTo("Environment");
+            assertThat(variable.getEnumValues()).containsExactly("production", "staging", "development");
+        }
+    }
+}
+

package/scalar-core/src/test/java/com/scalar/maven/core/config/ScalarSourceTest.java

@@ -0,0 +1,105 @@
+package com.scalar.maven.core.config;
+
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@DisplayName("ScalarSource")
+class ScalarSourceTest {
+
+    @Nested
+    @DisplayName("construction")
+    class Construction {
+
+        @Test
+        @DisplayName("should create source with default constructor")
+        void shouldCreateSourceWithDefaultConstructor() {
+            ScalarSource source = new ScalarSource();
+            assertThat(source).isNotNull();
+            assertThat(source.getUrl()).isNull();
+            assertThat(source.getTitle()).isNull();
+            assertThat(source.getSlug()).isNull();
+            assertThat(source.isDefault()).isNull();
+        }
+
+        @Test
+        @DisplayName("should create source with all parameters")
+        void shouldCreateSourceWithAllParameters() {
+            String url = "https://api.example.com/openapi.json";
+            String title = "Example API";
+            String slug = "example-api";
+            Boolean isDefault = true;
+            ScalarSource source = new ScalarSource(url, title, slug, isDefault);
+            assertThat(source.getUrl()).isEqualTo(url);
+            assertThat(source.getTitle()).isEqualTo(title);
+            assertThat(source.getSlug()).isEqualTo(slug);
+            assertThat(source.isDefault()).isEqualTo(isDefault);
+        }
+    }
+
+    @Nested
+    @DisplayName("properties")
+    class Properties {
+
+        @Test
+        @DisplayName("should set and get URL")
+        void shouldSetAndGetUrl() {
+            ScalarSource source = new ScalarSource();
+            String url = "https://api.example.com/openapi.json";
+            source.setUrl(url);
+            assertThat(source.getUrl()).isEqualTo(url);
+        }
+
+        @Test
+        @DisplayName("should set and get title")
+        void shouldSetAndGetTitle() {
+            ScalarSource source = new ScalarSource();
+            String title = "Example API";
+            source.setTitle(title);
+            assertThat(source.getTitle()).isEqualTo(title);
+        }
+
+        @Test
+        @DisplayName("should set and get slug")
+        void shouldSetAndGetSlug() {
+            ScalarSource source = new ScalarSource();
+            String slug = "example-api";
+            source.setSlug(slug);
+            assertThat(source.getSlug()).isEqualTo(slug);
+        }
+
+        @Test
+        @DisplayName("should set and get isDefault")
+        void shouldSetAndGetIsDefault() {
+            ScalarSource source = new ScalarSource();
+            source.setDefault(true);
+            assertThat(source.isDefault()).isTrue();
+            source.setDefault(false);
+            assertThat(source.isDefault()).isFalse();
+            source.setDefault(null);
+            assertThat(source.isDefault()).isNull();
+        }
+
+        @Test
+        @DisplayName("should set and get agent")
+        void shouldSetAndGetAgent() {
+            ScalarSource source = new ScalarSource();
+            assertThat(source.getAgent()).isNull();
+
+            ScalarAgentOptions agent = new ScalarAgentOptions();
+            agent.setKey("agent-key");
+            agent.setDisabled(true);
+            source.setAgent(agent);
+
+            assertThat(source.getAgent()).isSameAs(agent);
+            assertThat(source.getAgent().getKey()).isEqualTo("agent-key");
+            assertThat(source.getAgent().getDisabled()).isTrue();
+
+            source.setAgent(null);
+            assertThat(source.getAgent()).isNull();
+        }
+    }
+}
+

package/scalar-playground-webflux/pom.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>com.scalar.maven</groupId>
+    <artifactId>scalar-parent</artifactId>
+    <version>0.0.0</version>
+  </parent>
+
+  <artifactId>scalar-playground-webflux</artifactId>
+  <packaging>jar</packaging>
+
+  <name>Scalar API Reference Playground (WebFlux)</name>
+  <description>Example Spring Boot application demonstrating Scalar API Reference usage with WebFlux</description>
+
+  <dependencies>
+    <!-- Scalar WebFlux integration -->
+    <dependency>
+      <groupId>com.scalar.maven</groupId>
+      <artifactId>scalar-webflux</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+
+    <!-- Spring Boot WebFlux -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-webflux</artifactId>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+      </plugin>
+
+      <plugin>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-maven-plugin</artifactId>
+        <configuration>
+          <mainClass>com.scalar.maven.playground.PlaygroundApplication</mainClass>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>
+

package/scalar-playground-webflux/src/main/java/com/scalar/maven/playground/CustomScalarWebFluxController.java

@@ -0,0 +1,34 @@
+package com.scalar.maven.playground;
+
+import com.scalar.maven.core.ScalarProperties;
+import com.scalar.maven.webflux.ScalarWebFluxController;
+import org.springframework.http.server.reactive.ServerHttpRequest;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * Custom Scalar WebFlux controller for the playground application.
+ *
+ * <p>
+ * This controller extends {@link ScalarWebFluxController} and overrides the
+ * {@link #configureProperties(ScalarProperties, ServerHttpRequest)} method
+ * to set a custom page title.
+ * </p>
+ */
+@RestController
+public class CustomScalarWebFluxController extends ScalarWebFluxController {
+
+    /**
+     * Configures the Scalar properties before rendering.
+     * This implementation sets a custom page title.
+     *
+     * @param properties the properties to configure
+     * @param request    the HTTP request
+     * @return the configured properties with custom page title
+     */
+    @Override
+    protected ScalarProperties configureProperties(ScalarProperties properties, ServerHttpRequest request) {
+        properties.setPageTitle("Scalar API Reference - WebFlux");
+        return properties;
+    }
+}
+

package/scalar-playground-webflux/src/main/java/com/scalar/maven/playground/PlaygroundApplication.java

@@ -0,0 +1,27 @@
+package com.scalar.maven.playground;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * Example Spring Boot application demonstrating Scalar API Reference integration.
+ *
+ * <p>
+ * Run this application with:
+ * </p>
+ * <pre>
+ * mvn spring-boot:run
+ * </pre>
+ *
+ * <p>
+ * Then visit {@code http://localhost:8080/scalar} to see the API Reference.
+ * </p>
+ */
+@SpringBootApplication
+public class PlaygroundApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(PlaygroundApplication.class, args);
+    }
+}
+

package/scalar-playground-webflux/src/main/resources/application.properties

@@ -0,0 +1,7 @@
+# Scalar API Reference Configuration
+scalar.enabled=true
+scalar.url=https://registry.scalar.com/@scalar/apis/galaxy?format=json
+scalar.path=/scalar
+# Server Configuration
+server.port=8080
+

package/scalar-playground-webmvc/pom.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>com.scalar.maven</groupId>
+    <artifactId>scalar-parent</artifactId>
+    <version>0.0.0</version>
+  </parent>
+
+  <artifactId>scalar-playground-webmvc</artifactId>
+  <packaging>jar</packaging>
+
+  <name>Scalar API Reference Playground (WebMVC)</name>
+  <description>Example Spring Boot application demonstrating Scalar API Reference usage with WebMVC</description>
+
+  <dependencies>
+    <!-- Scalar WebMVC integration -->
+    <dependency>
+      <groupId>com.scalar.maven</groupId>
+      <artifactId>scalar-webmvc</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+
+    <!-- Spring Boot Web -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-web</artifactId>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+      </plugin>
+
+      <plugin>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-maven-plugin</artifactId>
+        <configuration>
+          <mainClass>com.scalar.maven.playground.PlaygroundApplication</mainClass>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>
+

package/scalar-playground-webmvc/src/main/java/com/scalar/maven/playground/CustomScalarWebMvcController.java

@@ -0,0 +1,34 @@
+package com.scalar.maven.playground;
+
+import com.scalar.maven.core.ScalarProperties;
+import com.scalar.maven.webmvc.ScalarWebMvcController;
+import jakarta.servlet.http.HttpServletRequest;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * Custom Scalar WebMVC controller for the playground application.
+ *
+ * <p>
+ * This controller extends {@link ScalarWebMvcController} and overrides the
+ * {@link #configureProperties(ScalarProperties, HttpServletRequest)} method
+ * to set a custom page title.
+ * </p>
+ */
+@RestController
+public class CustomScalarWebMvcController extends ScalarWebMvcController {
+
+    /**
+     * Configures the Scalar properties before rendering.
+     * This implementation sets a custom page title.
+     *
+     * @param properties the properties to configure
+     * @param request    the HTTP request
+     * @return the configured properties with custom page title
+     */
+    @Override
+    protected ScalarProperties configureProperties(ScalarProperties properties, HttpServletRequest request) {
+        properties.setPageTitle("Scalar API Reference - WebMVC");
+        return properties;
+    }
+}
+

package/scalar-playground-webmvc/src/main/java/com/scalar/maven/playground/PlaygroundApplication.java

@@ -0,0 +1,27 @@
+package com.scalar.maven.playground;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * Example Spring Boot application demonstrating Scalar API Reference integration.
+ *
+ * <p>
+ * Run this application with:
+ * </p>
+ * <pre>
+ * mvn spring-boot:run
+ * </pre>
+ *
+ * <p>
+ * Then visit {@code http://localhost:8080/scalar} to see the API Reference.
+ * </p>
+ */
+@SpringBootApplication
+public class PlaygroundApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(PlaygroundApplication.class, args);
+    }
+}
+

package/scalar-playground-webmvc/src/main/resources/application.properties

@@ -0,0 +1,7 @@
+# Scalar API Reference Configuration
+scalar.enabled=true
+scalar.url=https://registry.scalar.com/@scalar/apis/galaxy?format=json
+scalar.path=/scalar
+# Server Configuration
+server.port=8080
+

package/scalar-webflux/pom.xml

@@ -0,0 +1,110 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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>com.scalar.maven</groupId>
+    <artifactId>scalar-parent</artifactId>
+    <version>0.0.0</version>
+  </parent>
+
+  <artifactId>scalar-webflux</artifactId>
+  <packaging>jar</packaging>
+
+  <name>Scalar API Reference Spring Boot WebFlux</name>
+  <description>Spring Boot WebFlux integration for Scalar API Reference</description>
+
+  <dependencies>
+    <!-- Core module -->
+    <dependency>
+      <groupId>com.scalar.maven</groupId>
+      <artifactId>scalar-core</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+
+    <!-- Spring Boot WebFlux -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-webflux</artifactId>
+      <scope>provided</scope>
+    </dependency>
+
+    <!-- Spring Boot Auto-Configuration -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-autoconfigure</artifactId>
+      <scope>provided</scope>
+    </dependency>
+
+    <!-- Spring Boot Configuration Processor -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-configuration-processor</artifactId>
+      <optional>true</optional>
+    </dependency>
+
+    <!-- Spring Boot Actuator -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-actuator</artifactId>
+      <scope>provided</scope>
+    </dependency>
+
+    <!-- Test Dependencies -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-test</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <!-- Reactor Test -->
+    <dependency>
+      <groupId>io.projectreactor</groupId>
+      <artifactId>reactor-test</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>flatten-maven-plugin</artifactId>
+      </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+      </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+      </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-source-plugin</artifactId>
+      </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+      </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-gpg-plugin</artifactId>
+      </plugin>
+
+      <plugin>
+        <groupId>org.sonatype.central</groupId>
+        <artifactId>central-publishing-maven-plugin</artifactId>
+      </plugin>
+    </plugins>
+  </build>
+</project>
+

package/scalar-webflux/src/main/java/com/scalar/maven/webflux/ScalarWebFluxActuatorEndpoint.java

@@ -0,0 +1,103 @@
+package com.scalar.maven.webflux;
+
+import com.scalar.maven.core.ScalarHtmlRenderer;
+import com.scalar.maven.core.ScalarProperties;
+import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
+import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
+import org.springframework.boot.actuate.endpoint.web.annotation.WebEndpoint;
+import org.springframework.core.io.ByteArrayResource;
+import org.springframework.core.io.Resource;
+import org.springframework.http.MediaType;
+import org.springframework.http.server.reactive.ServerHttpRequest;
+import reactor.core.publisher.Mono;
+import reactor.core.scheduler.Schedulers;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+
+/**
+ * Actuator endpoint for serving the Scalar API Reference interface in Spring WebFlux applications.
+ *
+ * <p>
+ * This endpoint provides access to the Scalar API Reference interface through
+ * Spring Boot Actuator endpoints. It serves the same HTML content as the
+ * regular ScalarWebFluxController but is accessible at the actuator path.
+ * </p>
+ *
+ * <p>
+ * The endpoint is only enabled when {@code scalar.actuatorEnabled=true} is set
+ * in the configuration properties.
+ * </p>
+ *
+ * <p>
+ * Access the endpoint at: {@code /actuator/scalar}
+ * </p>
+ */
+@Endpoint(id = "scalar")
+@WebEndpoint(id = "scalar")
+public class ScalarWebFluxActuatorEndpoint {
+
+    @Autowired
+    private ObjectProvider<SpringBootScalarProperties> propertiesProvider;
+
+    /**
+     * Serves the Scalar API Reference interface as an actuator endpoint.
+     *
+     * <p>
+     * This method returns the same HTML content as the regular ScalarWebFluxController
+     * but is accessible through the actuator endpoint system.
+     * </p>
+     *
+     * @param request the HTTP request
+     * @return a Mono containing a Resource with the HTML content for the API Reference
+     * interface
+     */
+    @ReadOperation(produces = MediaType.TEXT_HTML_VALUE)
+    public final Mono<Resource> scalarUi(ServerHttpRequest request) {
+        return Mono.fromCallable(() -> {
+                    ScalarProperties properties = propertiesProvider.getObject();
+                    ScalarProperties configuredProperties = configureProperties(properties, request);
+                    String html = ScalarHtmlRenderer.render(configuredProperties);
+                    Resource resource = new ByteArrayResource(html.getBytes(StandardCharsets.UTF_8));
+                    return resource;
+                })
+                .subscribeOn(Schedulers.boundedElastic())
+                .onErrorMap(IOException.class, e -> new RuntimeException("Failed to render HTML", e));
+    }
+
+    /**
+     * Serves the JavaScript bundle for the Scalar API Reference.
+     *
+     * <p>
+     * This endpoint returns the JavaScript file that powers the Scalar API
+     * Reference interface. The file is served with the appropriate MIME type.
+     * </p>
+     *
+     * @return a Mono containing a Resource with the JavaScript bundle
+     */
+    @ReadOperation(produces = "application/javascript")
+    public final Mono<Resource> scalarJs() {
+        return Mono.fromCallable(() -> {
+                    byte[] jsContent = ScalarHtmlRenderer.getScalarJsContent();
+                    Resource resource = new ByteArrayResource(jsContent);
+                    return resource;
+                })
+                .subscribeOn(Schedulers.boundedElastic())
+                .onErrorMap(IOException.class, e -> new RuntimeException("Failed to load JavaScript bundle", e));
+    }
+
+    /**
+     * Hook method that allows subclasses to configure properties before rendering.
+     * Override this method to customize the ScalarProperties before they are
+     * converted to JSON and rendered.
+     *
+     * @param properties the properties to configure
+     * @param request    the HTTP request
+     * @return the configured properties
+     */
+    protected ScalarProperties configureProperties(ScalarProperties properties, ServerHttpRequest request) {
+        return properties;
+    }
+}