Feat: Add Spring Boot AutoConfiguration with tests

Author: vitinh0z

pom.xml

@@ -113,6 +113,24 @@
     </dependencyManagement>
 
     <dependencies>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-autoconfigure</artifactId>
+            <version>2.7.18</version>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-autoconfigure-processor</artifactId>
+            <version>2.7.18</version>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-test</artifactId>
+            <version>2.7.18</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>com.google.guava</groupId>
             <artifactId>guava</artifactId>
@@ -173,7 +191,6 @@
             <artifactId>opencensus-api</artifactId>
             <version>${opencensus.version}</version>
         </dependency>
-
         <dependency>
             <groupId>io.opentelemetry</groupId>
             <artifactId>opentelemetry-api</artifactId>

src/main/java/com/spotify/github/v3/spring/GithubClientAutoConfiguration.java

@@ -0,0 +1,39 @@
+/*-
+ * -\-\-
+ * github-api
+ * --
+ * Copyright (C) 2016 - 2025 Spotify AB
+ * --
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * -/-/-
+ */
+
+package com.spotify.github.v3.spring;
+
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.context.annotation.Bean;
+
+import com.spotify.github.v3.clients.GitHubClient;
+
+@AutoConfiguration
+@ConditionalOnClass(GitHubClient.class)
+public class GithubClientAutoConfiguration {
+
+    @Bean
+    @ConditionalOnBean
+    public GitHubClient gitHubClient() {
+        return GitHubClient.create(null, null);
+    }
+}

src/test/java/com/spotify/github/v3/spring/GithubClientAutoConfigurationTest.java

@@ -0,0 +1,65 @@
+/*-
+ * -\-\-
+ * github-api
+ * --
+ * Copyright (C) 2016 - 2025 Spotify AB
+ * --
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * -/-/-
+ */
+
+package com.spotify.github.v3.spring;
+
+import org.junit.Test;
+import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import static org.assertj.core.api.Assertions.assertThat;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.spotify.github.jackson.GithubApiModule;
+
+public class GithubClientAutoConfigurationTest {
+
+
+    private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
+    .withConfiguration(AutoConfigurations.of(GithubClientAutoConfiguration.class));
+
+    @Test
+    public void testModuleIsRegistered(){
+
+        this.contextRunner
+        .withUserConfiguration(JacksonConfig.class)
+        .run((context) -> {
+            assertThat(context).hasSingleBean(GithubApiModule.class);
+        });
+    }
+
+    @Test
+    public void testModuleIsNotRegisteredIfObjectMapperMissing(){
+
+        this.contextRunner
+        .run((context) -> {
+            assertThat(context).doesNotHaveBean(GithubApiModule.class);
+        });
+    }
+
+    @Configuration
+    static class JacksonConfig {
+
+        @Bean
+        public ObjectMapper objectMapper() {
+            return new ObjectMapper();
+        }
+    }
+}

src/test/resources/META-INF/Spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -0,0 +1 @@
+com.spotify.github.v3.spring.GithubClientAutoConfiguration