feat: major refactor with breaking changes (#92)

BREAKING CHANGE:
The library received many changes in v1.0 to make it easier to use and more maintanable in the future.
The main change is that both [`Channel`](https://github.com/GetStream/stream-chat-net/blob/0.26.0/src/stream-chat-net/Channel.cs) and [`Client`](https://github.com/GetStream/stream-chat-net/blob/0.26.0/src/stream-chat-net/Client.cs) classes have been separated into small modules that we call clients. (This resambles the [structure of our Java library](https://github.com/GetStream/stream-chat-java/tree/1.5.0/src/main/java/io/getstream/chat/java/services) as well.)
Main changes:
- `Channel` and `Client` classes are gone, and have been organized into smaller clients in `StreamChat.Clients` namespace.
- These clients do not maintain state as `Channel` used to did earlier where [it kept the `channelType` and `channelId` in the memory](https://github.com/GetStream/stream-chat-net/blob/0.26.0/src/stream-chat-net/Channel.cs#L34-#L35). So this means that you'll need to pass in `channelType` and `channelId` to a lot of method calls in `IChannelClient`.
- Async method names have `Async` suffix now.
- All public methods and classes have documentation.
- Identifiers has been renamed from `ID` to `Id` to follow [Microsoft's naming guide](https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/capitalization-conventions). Such as `userID` -> `userId`.
- A lot of data classes have been renamed to make more sense. Such as `ChannelObject` -> `Channel`.
- Data classes have been moved to `StreamChat.Models` namespace.
- Changed all `DateTime` -> `DateTimeOffset` as it's more suitable for us.
- Full feature parity: all backend APIs are available.
- Returned values are type of `ApiResponse` and expose rate limit informaiton with `GetRateLimit()` method.
- The folder structure of the project has been reorganized to follow [Microsoft's recommendation](https://gist.github.com/davidfowl/ed7564297c61fe9ab814).
- Unit tests have been improved. They are smaller, more focused and have cleanup methods.
- Added .NET 6.0 to the target frameworks.

Author: peterdeme

.github/workflows/ci.yaml

@@ -8,41 +8,35 @@ concurrency:
 
 jobs:
   basic:
-    name: Run tests on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
+    name: 🧪 Run tests
+    runs-on: ubuntu-latest
     env:
       DOTNET_CLI_TELEMETRY_OPTOUT: "true"
-    strategy:
-      max-parallel: 1
-      matrix:
-        os: [macos-latest, ubuntu-latest, windows-latest]
-      fail-fast: false
     steps:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0
 
       - uses: wagoid/commitlint-github-action@v4
-        if: ${{ matrix.os == 'ubuntu-latest' }}
 
       - name: Setup dotnet
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: 5.0.x
+          dotnet-version: 6.0.x
 
       - name: Dependency cache
         uses: actions/cache@v2
         id: cache
         with:
           path: ~/.nuget/packages
-          key: ${{ runner.os }}-nuget-${{ hashFiles('src/**/*.csproj') }}
+          key: ${{ runner.os }}-nuget-${{ hashFiles('./**/*.csproj') }}
 
       - name: Install dependencies
         if: steps.cache.outputs.cache-hit != 'true'
-        run: dotnet restore ./src
+        run: dotnet restore
 
       - name: Run tests
-        run: dotnet test ./src/stream-chat-net-test
+        run: dotnet test
         env:
-          STREAM_API_SECRET: ${{ secrets.STREAM_API_SECRET }}
-          STREAM_API_KEY: ${{ secrets.STREAM_API_KEY }}
+          STREAM_SECRET: ${{ secrets.STREAM_API_SECRET }}
+          STREAM_KEY: ${{ secrets.STREAM_API_KEY }}

.github/workflows/initiate_release.yml

@@ -9,14 +9,23 @@ on:
 
 jobs:
   init_release:
+    name: 🚀 Create release PR
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0 # gives the changelog generator access to all previous commits
 
       - name: Create release branch
-        run: scripts/create_release_branch.sh "${{ github.event.inputs.version }}"
+        env:
+          VERSION: ${{ github.event.inputs.version }}
+        run: |
+          npx --yes standard-version@9.3.2 --release-as "$VERSION" --skip.tag --skip.commit --tag-prefix=
+          git config --global user.name 'github-actions' 
+          git config --global user.email 'release@getstream.io'
+          git checkout -q -b "release-$VERSION"
+          git commit -am "chore(release): $VERSION"
+          git push -q -u origin "release-$VERSION"
 
       - name: Get changelog diff
         uses: actions/github-script@v5

.github/workflows/release.yaml

@@ -8,6 +8,7 @@ on:
 
 jobs:
   Release:
+    name: 🚀 Release
     if: github.event.pull_request.merged && startsWith(github.head_ref, 'release-')
     runs-on: ubuntu-latest
     env:
@@ -31,13 +32,13 @@ jobs:
       - name: Setup dotnet
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: "5.0.x"
+          dotnet-version: "6.0.x"
 
       - name: Create the package
         run: dotnet pack --configuration Release ./src
 
       - name: Publish the package
-        run: dotnet nuget push "./src/stream-chat-net/bin/Release/*.nupkg"  -s https://api.nuget.org/v3/index.json -k ${{ secrets.NUGET_API_KEY }}
+        run: dotnet nuget push "./src/bin/Release/*.nupkg" -s https://api.nuget.org/v3/index.json -k ${{ secrets.NUGET_API_KEY }}
 
       - name: Create release on GitHub
         uses: ncipollo/release-action@v1

.github/workflows/reviewdog.yml

@@ -1,4 +1,4 @@
-name: reviewdog
+name: Reviewdog
 on:
   pull_request:
 
@@ -8,22 +8,21 @@ concurrency:
 
 jobs:
   reviewdog:
+    name: 🐶 Reviewdog
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
 
       - uses: reviewdog/action-setup@v1
-        with:
-          reviewdog_version: latest
 
       - name: Setup dotnet
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: 5.0.x
+          dotnet-version: 6.0.x
 
       - name: Reviewdog
         env:
           REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          dotnet build -clp:NoSummary -p:GenerateFullPaths=true --no-incremental --nologo -f net5.0 -v q src \
+          dotnet build -clp:NoSummary -p:GenerateFullPaths=true --no-incremental --nologo -f net6.0 -v q \
           | reviewdog -f=dotnet -name=dotnet -reporter=github-pr-review

.stylecop.ruleset

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="utf-8"?>
+<RuleSet Name="Rules for stream-chat-net" Description="Code analysis rules for stream-chat-net.csproj." ToolsVersion="14.0">
+  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers.SpecialRules">
+    <Rule Id="SA0001" Action="None" />    <!-- XML comment analysis is disabled due to project configuration -->
+  </Rules>
+  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers.ReadabilityRules">
+    <Rule Id="SA1101" Action="None" />    <!-- Prefix local calls with this -->
+    <Rule Id="SA1116" Action="None" />    <!-- The parameters should begin on the line after the declaration -->
+    <Rule Id="SA1117" Action="None" />    <!-- The parameters should all be placed on the same line -->
+    <Rule Id="SA1127" Action="None" />    <!-- Generic type constraints should be on their own line -->
+    <Rule Id="SA1128" Action="None" />    <!-- Put constructor initializers on their own line -->
+  </Rules>
+  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers.OrderingRules">
+    <Rule Id="SA1200" Action="None" />    <!-- Using directive should appear within a namespace declaration -->
+    <Rule Id="SA1201" Action="None" />    <!-- A enum should not follow a class -->
+    <Rule Id="SA1202" Action="None" />    <!-- 'public' members should come before 'internal' members -->
+    <Rule Id="SA1204" Action="None" />    <!-- Static members should appear before non-static members -->
+  </Rules>
+  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers.NamingRules">
+    <Rule Id="SA1309" Action="None" />    <!-- Should not begin with an underscore -->
+  </Rules>
+  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers.MaintainabilityRules">
+    <Rule Id="SA1402" Action="None" />    <!-- File may only contain a single type -->
+  </Rules>
+  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers.LayoutRules">
+    <Rule Id="SA1503" Action="None" />    <!-- Braces should not be omitted -->
+    <Rule Id="SA1516" Action="None" />    <!-- Elements should be separated by blank line -->
+    <Rule Id="CS1591" Action="None" />    <!--  Missing XML comment for publicly visible type or member -->
+  </Rules>
+   <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers.DocumentationRules">
+    <Rule Id="SA1600" Action="None" />    <!-- Elements should be documented -->
+    <Rule Id="SA1601" Action="None" />    <!-- Partial elements should be documented -->
+    <Rule Id="SA1602" Action="None" />    <!-- Enumeration items should be documented -->
+    <Rule Id="SA1611" Action="None" />    <!-- FThe documentation for parameter is missing -->
+    <Rule Id="SA1615" Action="None" />    <!-- Element return value should be documented -->
+    <Rule Id="SA1618" Action="None" />    <!-- TThe documentation for type parameter is missing -->
+    <Rule Id="SA1623" Action="None" />    <!-- The property's documentation summary text should begin with: 'Gets or sets' -->
+    <Rule Id="SA1629" Action="None" />    <!-- Documentation text should end with a period -->
+    <Rule Id="SA1633" Action="None" />    <!-- The file header is missing or not located at the top of the file -->
+    <Rule Id="SA1649" Action="None" />    <!-- File name should match first type name -->
+  </Rules>
+</RuleSet>

.versionrc.js

@@ -0,0 +1,16 @@
+const csprojUpdater = {
+    VERSION_REGEX: /<Version>(.+)<\/Version>/,
+
+    readVersion: function (contents) {
+        const version = this.VERSION_REGEX.exec(contents)[1];
+        return version;
+    },
+
+    writeVersion: function (contents, version) {
+        return contents.replace(this.VERSION_REGEX.exec(contents)[0], `<Version>${version}</Version>`);
+    }
+}
+
+module.exports = {
+    bumpFiles: [{ filename: './src/stream-chat-net.csproj', updater: csprojUpdater }],
+}

CONTRIBUTING.md

@@ -9,18 +9,18 @@ We welcome code changes that improve this library or fix a problem, please make
 Most IDEs automatically prompt you to restore the dependencies but if not, use this command:
 
 ```shell
-$ dotnet restore ./src
+$ dotnet restore
 ```
 
 Building:
 
 ```shell
-$ dotnet build ./src
+$ dotnet build
 ```
 
 ### Run tests
 
-The tests we have are full fledged integration tests, meaning they will actually reach out to a Stream app. Hence the tests require at least two environment variables: `STREAM_API_KEY` and `STREAM_API_SECRET`.
+The tests we have are full fledged integration tests, meaning they will actually reach out to a Stream app. Hence the tests require at least two environment variables: `STREAM_KEY` and `STREAM_SECRET`.
 
 To have these env vars available for the test running, you need to set up a `.runsettings` file in the root of the project (don't worry, it's gitignored).
 
@@ -33,16 +33,16 @@ It needs to look like this:
 <RunSettings>
   <RunConfiguration>
     <EnvironmentVariables>
-      <STREAM_API_KEY>api_key_here</STREAM_API_KEY>
-      <STREAM_API_SECRET>secret_key_here</STREAM_API_SECRET>
+      <STREAM_KEY>api_key_here</STREAM_KEY>
+      <STREAM_SECRET>secret_key_here</STREAM_SECRET>
     </EnvironmentVariables>
   </RunConfiguration>
 </RunSettings>
 ```
 
 In CLI:
 ```shell
-$ dotnet test -s .runsettings ./src/stream-chat-net-test
+$ dotnet test -s .runsettings
 ```
 
 Go to the next section to see how to use it in IDEs.
@@ -58,8 +58,7 @@ For VS Code, the recommended extensions are:
 Recommended settings (`.vscode/settings.json`):
 ```json
 {
-    "omnisharp.testRunSettings": ".runsettings",
-    "dotnet-test-explorer.testProjectPath": "./src/stream-chat-net-test",
+    "omnisharp.testRunSettings": ".runsettings"
 }
 ```