initial sdk release

Author: vagruchi

.gitattributes

@@ -0,0 +1,9 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# Linux start script should use lf
+/gradlew        text eol=lf
+
+# These are Windows script files and should use crlf
+*.bat           text eol=crlf
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+# Submit a pull request
+
+## CLA
+
+- [ ] I have signed the [Stream CLA](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) (required).
+- [ ] The code changes follow best practices
+- [ ] Code changes are tested (add some information if not applicable)
+
+## Description of the pull request

.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: Build
+
+on: [pull_request]
+
+concurrency: 
+  group: ${{ github.workflow }}-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  ci:
+    name: 🧪 Test & lint
+    environment: ci
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+#      - name: Commit message lint
+#        uses: wagoid/commitlint-github-action@v4
+
+      - name: Setup JDK 17
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'corretto'
+          java-version: '17'
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Test
+        env:
+          STREAM_BASE_URL: ${{ vars.STREAM_BASE_URL }}
+          STREAM_API_KEY: ${{ vars.STREAM_API_KEY }}
+          STREAM_API_SECRET: ${{ secrets.STREAM_API_SECRET }}
+        run: |
+          ./gradlew spotlessCheck --no-daemon
+          ./gradlew build --info --no-daemon

.github/workflows/initiate_release.yml

@@ -0,0 +1,44 @@
+name: Create release PR
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "The new version number. Example: 1.40.1"
+        required: true
+        type: string
+        pattern: "^[0-9]+\\.[0-9]+\\.[0-9]+$"
+
+jobs:
+  init_release:
+    name: 🚀 Create release PR
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # gives the changelog generator access to all previous commits
+
+      - name: Update CHANGELOG.md, build.gradle and push release branch
+        env:
+          VERSION: ${{ github.event.inputs.version }}
+        run: |
+          npx --yes standard-version@9.3.2 --release-as "$VERSION" --skip.tag --skip.commit --tag-prefix=
+          echo "version=$VERSION" > gradle.properties
+          git config --global user.name 'github-actions' 
+          git config --global user.email 'release@getstream.io'
+          git checkout -q -b "release-$VERSION"
+          git add CHANGELOG.md gradle.properties
+          git commit -am "chore(release): $VERSION"
+          git push -q -u origin "release-$VERSION"
+
+      - name: Open pull request
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr create \
+            -t "Release ${{ github.event.inputs.version }}" \
+            -b "# :rocket: ${{ github.event.inputs.version }}
+            Make sure to use squash & merge when merging!
+            Once this is merged, another job will kick off automatically and publish the package.
+            # :memo: Changelog
+            $(cat CHANGELOG.md)"

.github/workflows/release.yml

@@ -0,0 +1,45 @@
+name: Release
+
+on:
+  pull_request:
+    types: [closed]
+    branches:
+      - main
+
+jobs:
+  Release:
+    name: 🚀 Release
+    if: github.event.pull_request.merged && startsWith(github.head_ref, 'release-')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+  
+      - uses: actions/github-script@v6
+        with:
+          script: |
+            // Getting the release version from the PR source branch
+            // Source branch looks like this: release-1.0.0
+            const version = context.payload.pull_request.head.ref.split('-')[1]
+            core.exportVariable('VERSION', version)
+
+      - name: Publish to MavenCentral
+        run: |
+          ./gradlew publishToSonatype --no-daemon --max-workers 1 closeAndReleaseSonatypeStagingRepository
+        env:
+          STREAM_API_KEY: ${{ vars.STREAM_API_KEY }}
+          STREAM_API_SECRET: ${{ secrets.STREAM_API_SECRET }}
+          GPG_KEY_CONTENTS: ${{ secrets.GPG_KEY_CONTENTS }}
+          OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+          OSSRH_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
+          SIGNING_KEY_ID: ${{ secrets.SIGNING_KEY_ID }}
+          SIGNING_PASSWORD: ${{ secrets.SIGNING_PASSWORD }}
+          SIGNING_SECRET_KEY_RING_FILE: ${{ secrets.SIGNING_SECRET_KEY_RING_FILE }}
+          SONATYPE_STAGING_PROFILE_ID: ${{ secrets.SONATYPE_STAGING_PROFILE_ID }}
+
+      - name: Create release on GitHub
+        uses: ncipollo/release-action@v1
+        with:
+          tag: ${{ env.VERSION }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/scheduled_test.yml

@@ -0,0 +1,35 @@
+name: Scheduled tests
+
+on:
+  workflow_dispatch:
+  schedule:
+    # Monday at 9:00 UTC
+    - cron: "0 9 * * 1"
+
+jobs:
+  test:
+    environment: ci
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run tests
+        env:
+          STREAM_BASE_URL: ${{ vars.STREAM_BASE_URL }}
+          STREAM_API_KEY: ${{ vars.STREAM_API_KEY }}
+          STREAM_API_SECRET: ${{ secrets.STREAM_API_SECRET }}
+        run: |
+          # Retry 3 times because tests can be flaky
+          for _ in 1 2 3;
+          do
+              ./gradlew test --no-daemon && break
+          done
+
+      - name: Notify Slack if failed
+        uses: voxmedia/github-action-slack-notify-build@v1
+        if: failure()
+        with:
+          channel_id: C02RPDF7T63
+          color: danger
+          status: FAILED
+        env:
+          SLACK_BOT_TOKEN: ${{ secrets.SLACK_NOTIFICATIONS_BOT_TOKEN }}

.gitignore

@@ -0,0 +1,53 @@
+## https://github.com/github/gitignore/blob/main/Java.gitignore
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+replay_pid*
+
+## https://github.com/github/gitignore/blob/main/Gradle.gitignore
+.gradle
+**/build/
+!src/**/build/
+
+# Ignore Gradle GUI config
+gradle-app.setting
+
+# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
+!gradle-wrapper.jar
+
+# Avoid ignore Gradle wrappper properties
+!gradle-wrapper.properties
+
+# Cache of project
+.gradletasknamecache
+
+# Eclipse Gradle plugin generated files
+# Eclipse Core
+.project
+# JDT-specific (Eclipse Java Development Tools)
+.classpath
+
+## project specific
+/local.properties
+
+.idea

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+
+### 0.1.5 (2025-02-12)
+
+### 0.1.4 (2025-02-12)
+
+### 0.1.3 (2025-02-12)
+
+### 0.1.2 (2025-02-12)
+
+### 0.1.1 (2025-02-12)
+
+
+## 0.1.0 (2025-02-12)

CONTRIBUTING.md

@@ -0,0 +1,122 @@
+# :recycle: Contributing <!-- omit in toc -->
+
+> [!NOTE]
+> Most of the code in this repository is **automatically generated** from the [OpenAPI specification](https://getstream.github.io/protocol/) of the Stream API. Therefore, **it does NOT make sense to try to change them manually**.
+
+Tests are written manually and more tests are always welcome.
+Some parts like `lib/src/main/java/io/getstream/services/framework` and `lib/src/main/java/io/getstream/models/framework`, serve as the base and are written manually as well.
+
+## Requirements <!-- omit in toc -->
+
+To contribute to this project, you need to have [Lombok](https://projectlombok.org/) installed in your IDE.
+You also need to use javac >= 11 to compile (ensure that your JAVA_HOME points to such a location), even if the produced library is compatible with Java 8 (for some reasons, jdk 8 compiler fails on some Lombok annotations).
+
+- [Setup the project](#setup-the-project)
+- [Architecture explanation](#architecture-explanation)
+  - [Model classes](#model-classes)
+  - [Request classes](#request-classes)
+  - [RequestData and RequestObject classes](#requestdata-and-requestobject-classes)
+  - [Response classes](#response-classes)
+  - [Service interfaces](#service-interfaces)
+  - [The StreamServiceGenerator class](#the-streamservicegenerator-class)
+  - [The StreamResponse interface and related classes](#the-streamresponse-interface-and-related-classes)
+  - [The StreamRequest and StreamServiceHandler classes](#the-streamrequest-and-streamservicehandler-classes)
+  - [Test classes](#test-classes)
+- [Code rules](#code-rules)
+- [How to](#how-to)
+  - [Enable logging](#enable-logging)
+- [Commit message convention](#commit-message-convention)
+- [Releasing a new version (for Stream developers)](#releasing-a-new-version-for-stream-developers)
+
+## Setup the project
+
+The project is a Maven project.
+
+Copy `local.properties.example` to `local.properties` and put configuration there. These properties are automatically picked up during tests execution
+
+```shell
+# Run tests
+./gradlew test
+
+# Check code style
+./gradlew spotlessCheck
+
+# Fix code style problems
+./gradlew spotlessApply
+```
+
+## Architecture explanation
+
+The code is composed of:
+
+### Model classes
+
+They are the data objects. They correspond to the formats of the objects contained in the API responses.
+
+### Request classes
+
+They are builders for API requests, and also contain methods to perform the calls.
+
+### RequestData and RequestObject classes
+
+They are data objects. They correspond to the formats of the API requests.
+
+### Response classes
+
+They are data objects. They correspond to the formats of the API responses.
+
+### Service interfaces
+
+They are the interfaces that define the API endpoints. 
+
+### The StreamServiceGenerator class
+
+This class is responsible to make the Service interfaces usable to call the API. It is used by all Request classes to define the `generateCall` method.
+It also handles authentication and logging.
+
+### The StreamResponse interface and related classes
+
+StreamResponse is the interface that correspond to an API response. Most APIs responses are StreamResponseObject (mean they contain duration and rate limit data).
+
+### The StreamRequest and StreamServiceHandler classes
+
+StreamRequest is the generic Request class, that defines the `request` and `requestAsync` methods, which call the `StreamServiceHandler`.
+The `StreamServiceHandler` class defines the synchronous and asynchronous processing. It also enriched the Response object with rate limit data when available.
+
+### Test classes
+
+They are organized by model. Each endpoint has at least one test related.
+
+## Code rules
+
+- The code should be formatted using Google formatter.
+- All attributes, parameters and return values should be annotated with either `@Nullable` or `@NotNull`
+- New implementations should follow the same principles as the existing ones (see how to section below)
+- In Models, collections of submodel should be List (other collections and arrays are not supported by RequestObjectBuilder)
+- String that only can take a given set of values should be represented as enums, with an `UNKNOWN` value marked `@JsonEnumDefaultValue` to avoid problem if the list of possible values changes
+
+## How to
+
+### Enable logging
+
+Logging is enabled by default in tests. If you want to create a main class and activate logging, you should do the following:
+
+```java
+StreamServiceGenerator.logLevel = HttpLoggingInterceptor.Level.BODY;
+```
+
+## Commit message convention
+
+This repository follows a commit message convention in order to automatically generate the [CHANGELOG](./CHANGELOG.md). Make sure you follow the rules of [conventional commits](https://www.conventionalcommits.org/) when opening a pull request.
+
+## Releasing a new version (for Stream developers)
+
+In order to release new version you need to be a maintainer of the library.
+
+- Kick off a job called `initiate_release` ([link](https://github.com/GetStream/stream-sdk-java/actions/workflows/initiate_release.yml)).
+
+The job creates a pull request with the changelog. Check if it looks good.
+
+- Merge the pull request.
+
+Once the PR is merged, it automatically kicks off another job which will upload the Gem to RubyGems.org and creates a GitHub release.