Skip to content

Commit 9f4e6a1

Browse files
committed
Project structure changes and additional JavaDocs
1 parent efeba5d commit 9f4e6a1

File tree

63 files changed

+173
-97
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+173
-97
lines changed

pom.xml

Lines changed: 72 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@
1010
<relativePath/> <!-- lookup parent from repository -->
1111
</parent>
1212

13-
<groupId>com.github.reactiveclown</groupId>
13+
<properties>
14+
<java.version>17</java.version>
15+
</properties>
16+
17+
<groupId>io.github.reactiveclown</groupId>
1418
<artifactId>openai-webflux-client-spring-boot-starter</artifactId>
1519
<version>0.9.0</version>
1620
<name>${project.groupId}:${project.artifactId}</name>
@@ -34,15 +38,11 @@
3438
<developer>
3539
<name>Maksym Volkov</name>
3640
<email>[email protected]</email>
37-
<organization>com.github.reactiveclown</organization>
41+
<organization>io.github.reactiveclown</organization>
3842
<organizationUrl>https://github.com/reactiveclown</organizationUrl>
3943
</developer>
4044
</developers>
4145

42-
<properties>
43-
<java.version>17</java.version>
44-
</properties>
45-
4646
<dependencies>
4747
<dependency>
4848
<groupId>org.springframework.boot</groupId>
@@ -68,4 +68,70 @@
6868
<scope>test</scope>
6969
</dependency>
7070
</dependencies>
71+
72+
<distributionManagement>
73+
<snapshotRepository>
74+
<id>ossrh</id>
75+
<url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
76+
</snapshotRepository>
77+
<repository>
78+
<id>ossrh</id>
79+
<url>https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
80+
</repository>
81+
</distributionManagement>
82+
<build>
83+
<plugins>
84+
<plugin>
85+
<groupId>org.sonatype.plugins</groupId>
86+
<artifactId>nexus-staging-maven-plugin</artifactId>
87+
<version>1.6.13</version>
88+
<extensions>true</extensions>
89+
<configuration>
90+
<serverId>ossrh</serverId>
91+
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
92+
<autoReleaseAfterClose>true</autoReleaseAfterClose>
93+
</configuration>
94+
</plugin>
95+
<plugin>
96+
<groupId>org.apache.maven.plugins</groupId>
97+
<artifactId>maven-source-plugin</artifactId>
98+
<version>3.2.1</version>
99+
<executions>
100+
<execution>
101+
<id>attach-sources</id>
102+
<goals>
103+
<goal>jar-no-fork</goal>
104+
</goals>
105+
</execution>
106+
</executions>
107+
</plugin>
108+
<plugin>
109+
<groupId>org.apache.maven.plugins</groupId>
110+
<artifactId>maven-javadoc-plugin</artifactId>
111+
<version>3.5.0</version>
112+
<executions>
113+
<execution>
114+
<id>attach-javadocs</id>
115+
<goals>
116+
<goal>jar</goal>
117+
</goals>
118+
</execution>
119+
</executions>
120+
</plugin>
121+
<plugin>
122+
<groupId>org.apache.maven.plugins</groupId>
123+
<artifactId>maven-gpg-plugin</artifactId>
124+
<version>3.0.1</version>
125+
<executions>
126+
<execution>
127+
<id>sign-artifacts</id>
128+
<phase>verify</phase>
129+
<goals>
130+
<goal>sign</goal>
131+
</goals>
132+
</execution>
133+
</executions>
134+
</plugin>
135+
</plugins>
136+
</build>
71137
</project>

src/main/java/com/reactiveclown/openaiwebfluxclient/ClientAutoConfiguration.java renamed to src/main/java/io/github/reactiveclown/openaiwebfluxclient/ClientAutoConfiguration.java

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
package com.reactiveclown.openaiwebfluxclient;
2-
3-
import com.reactiveclown.openaiwebfluxclient.client.audio.AudioService;
4-
import com.reactiveclown.openaiwebfluxclient.client.audio.AudioServiceImpl;
5-
import com.reactiveclown.openaiwebfluxclient.client.chat.ChatService;
6-
import com.reactiveclown.openaiwebfluxclient.client.chat.ChatServiceImpl;
7-
import com.reactiveclown.openaiwebfluxclient.client.completions.CompletionsService;
8-
import com.reactiveclown.openaiwebfluxclient.client.completions.CompletionsServiceImpl;
9-
import com.reactiveclown.openaiwebfluxclient.client.edits.EditsService;
10-
import com.reactiveclown.openaiwebfluxclient.client.edits.EditsServiceImpl;
11-
import com.reactiveclown.openaiwebfluxclient.client.embeddings.EmbeddingsService;
12-
import com.reactiveclown.openaiwebfluxclient.client.embeddings.EmbeddingsServiceImpl;
13-
import com.reactiveclown.openaiwebfluxclient.client.files.FilesService;
14-
import com.reactiveclown.openaiwebfluxclient.client.files.FilesServiceImpl;
15-
import com.reactiveclown.openaiwebfluxclient.client.finetunes.FineTuneServiceImpl;
16-
import com.reactiveclown.openaiwebfluxclient.client.finetunes.FineTunesService;
17-
import com.reactiveclown.openaiwebfluxclient.client.images.ImageServiceImpl;
18-
import com.reactiveclown.openaiwebfluxclient.client.images.ImagesService;
19-
import com.reactiveclown.openaiwebfluxclient.client.models.ModelsService;
20-
import com.reactiveclown.openaiwebfluxclient.client.models.ModelsServiceImpl;
21-
import com.reactiveclown.openaiwebfluxclient.client.moderations.ModerationsService;
22-
import com.reactiveclown.openaiwebfluxclient.client.moderations.ModerationsServiceImpl;
23-
import com.reactiveclown.openaiwebfluxclient.exception.OpenAiException;
1+
package io.github.reactiveclown.openaiwebfluxclient;
2+
3+
import io.github.reactiveclown.openaiwebfluxclient.client.audio.AudioService;
4+
import io.github.reactiveclown.openaiwebfluxclient.client.audio.AudioServiceImpl;
5+
import io.github.reactiveclown.openaiwebfluxclient.client.chat.ChatService;
6+
import io.github.reactiveclown.openaiwebfluxclient.client.chat.ChatServiceImpl;
7+
import io.github.reactiveclown.openaiwebfluxclient.client.completions.CompletionsService;
8+
import io.github.reactiveclown.openaiwebfluxclient.client.completions.CompletionsServiceImpl;
9+
import io.github.reactiveclown.openaiwebfluxclient.client.edits.EditsService;
10+
import io.github.reactiveclown.openaiwebfluxclient.client.edits.EditsServiceImpl;
11+
import io.github.reactiveclown.openaiwebfluxclient.client.embeddings.EmbeddingsService;
12+
import io.github.reactiveclown.openaiwebfluxclient.client.embeddings.EmbeddingsServiceImpl;
13+
import io.github.reactiveclown.openaiwebfluxclient.client.files.FilesService;
14+
import io.github.reactiveclown.openaiwebfluxclient.client.files.FilesServiceImpl;
15+
import io.github.reactiveclown.openaiwebfluxclient.client.finetunes.FineTuneServiceImpl;
16+
import io.github.reactiveclown.openaiwebfluxclient.client.finetunes.FineTunesService;
17+
import io.github.reactiveclown.openaiwebfluxclient.client.images.ImageServiceImpl;
18+
import io.github.reactiveclown.openaiwebfluxclient.client.images.ImagesService;
19+
import io.github.reactiveclown.openaiwebfluxclient.client.models.ModelsService;
20+
import io.github.reactiveclown.openaiwebfluxclient.client.models.ModelsServiceImpl;
21+
import io.github.reactiveclown.openaiwebfluxclient.client.moderations.ModerationsService;
22+
import io.github.reactiveclown.openaiwebfluxclient.client.moderations.ModerationsServiceImpl;
23+
import io.github.reactiveclown.openaiwebfluxclient.exception.OpenAiException;
2424
import org.springframework.beans.factory.annotation.Qualifier;
2525
import org.springframework.boot.autoconfigure.AutoConfiguration;
2626
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;

src/main/java/com/reactiveclown/openaiwebfluxclient/ClientAutoConfigurationProperties.java renamed to src/main/java/io/github/reactiveclown/openaiwebfluxclient/ClientAutoConfigurationProperties.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.reactiveclown.openaiwebfluxclient;
1+
package io.github.reactiveclown.openaiwebfluxclient;
22

33
import org.springframework.boot.context.properties.ConfigurationProperties;
44

src/main/java/com/reactiveclown/openaiwebfluxclient/client/UsageData.java renamed to src/main/java/io/github/reactiveclown/openaiwebfluxclient/client/UsageData.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.reactiveclown.openaiwebfluxclient.client;
1+
package io.github.reactiveclown.openaiwebfluxclient.client;
22

33
import com.fasterxml.jackson.annotation.JsonProperty;
44

src/main/java/com/reactiveclown/openaiwebfluxclient/client/audio/AudioService.java renamed to src/main/java/io/github/reactiveclown/openaiwebfluxclient/client/audio/AudioService.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
package com.reactiveclown.openaiwebfluxclient.client.audio;
1+
package io.github.reactiveclown.openaiwebfluxclient.client.audio;
22

33
import reactor.core.publisher.Mono;
44

5+
/**
6+
* Service to turn audio into text.
7+
*/
58
public interface AudioService {
69

710
/**

src/main/java/com/reactiveclown/openaiwebfluxclient/client/audio/AudioServiceImpl.java renamed to src/main/java/io/github/reactiveclown/openaiwebfluxclient/client/audio/AudioServiceImpl.java

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
1-
package com.reactiveclown.openaiwebfluxclient.client.audio;
1+
package io.github.reactiveclown.openaiwebfluxclient.client.audio;
22

33
import org.springframework.core.io.PathResource;
44
import org.springframework.http.client.MultipartBodyBuilder;
55
import org.springframework.web.reactive.function.client.WebClient;
66
import reactor.core.publisher.Mono;
77

8+
/**
9+
* {@link AudioService} implementation.
10+
*/
811
public class AudioServiceImpl implements AudioService {
912

1013
private final WebClient client;
1114

15+
/**
16+
* AudioServiceImpl constructor, accepts configured {@link WebClient}
17+
* @param client configured {@link WebClient}
18+
*/
1219
public AudioServiceImpl(WebClient client) {
1320
this.client = client;
1421
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.reactiveclown.openaiwebfluxclient.client.audio;
1+
package io.github.reactiveclown.openaiwebfluxclient.client.audio;
22

33
/**
44
* CreateTranscriptionRequest.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.reactiveclown.openaiwebfluxclient.client.audio;
1+
package io.github.reactiveclown.openaiwebfluxclient.client.audio;
22

33
import com.fasterxml.jackson.annotation.JsonProperty;
44

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.reactiveclown.openaiwebfluxclient.client.audio;
1+
package io.github.reactiveclown.openaiwebfluxclient.client.audio;
22

33
/**
44
* CreateTranslationRequest.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package com.reactiveclown.openaiwebfluxclient.client.audio;
1+
package io.github.reactiveclown.openaiwebfluxclient.client.audio;
22

33
import com.fasterxml.jackson.annotation.JsonProperty;
44

0 commit comments

Comments
 (0)