feat(communities): Add endpoints for communities.

src/CircleSo.php

@@ -6,6 +6,7 @@
 
 use AdroSoftware\CircleSoSdk\Contracts\InteractsWithEndpoints;
 use AdroSoftware\CircleSoSdk\Endpoint\{
+    Community\Communities,
     Me\Me,
     Member\Members,
     MemberTag\MemberTag,
@@ -26,6 +27,11 @@ public function me(): Me
         return new Me($this);
     }
 
+    public function communities(): Communities
+    {
+        return new Communities($this);
+    }
+
     public function members(): Members
     {
         return new Members($this);

src/Contracts/InteractsWithEndpoints.php

@@ -5,6 +5,7 @@
 namespace AdroSoftware\CircleSoSdk\Contracts;
 
 use AdroSoftware\CircleSoSdk\Endpoint\{
+    Community\Communities,
     Me\Me,
     Member\Members,
     MemberTag\MemberTag,
@@ -15,6 +16,8 @@ interface InteractsWithEndpoints
 {
     public function me(): Me;
 
+    public function communities(): Communities;
+
     public function members(): Members;
 
     public function memberTags(): MemberTag;

src/Endpoint/Community/Communities.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AdroSoftware\CircleSoSdk\Endpoint\Community;
+
+use AdroSoftware\CircleSoSdk\Endpoint\AbstractEndpoint;
+use AdroSoftware\CircleSoSdk\Endpoint\EndpointInterface;
+
+final class Communities extends AbstractEndpoint implements EndpointInterface
+{
+    public function all(): mixed
+    {
+        return $this->factorResponse(
+            $this->circleSo->getHttpClient()->get('/communities')
+        );
+    }
+
+    public function community(string $slug, ?int $communityId = null): mixed
+    {
+        $this->ensureCommunityIdIsPresent($communityId);
+
+        return $this->factorResponse(
+            response: $this->circleSo->getHttpClient()->get('/communities'),
+            throwNotFoundException: true,
+        );
+    }
+}

tests/Endpoint/Community/CommunitiesTest.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AdroSoftware\CircleSoSdk\Tests\Endpoint\Community;
+
+use AdroSoftware\CircleSoSdk\Exception\{
+    ResourceNotFoundException,
+    UnsuccessfulResponseException,
+};
+use AdroSoftware\CircleSoSdk\Tests\TestCase;
+use GuzzleHttp\Psr7\Response;
+
+class CommunitiesTest extends TestCase
+{
+    public function test_get_communities(): void
+    {
+        $circleSo = $this->getSdkWithMockedClient([
+            new Response(200, [], json_response('communities')),
+        ]);
+
+        $communities = $circleSo->communities()->all();
+
+        $this->assertArrayHasKey('id', $communities[0]);
+
+        $this->assertSame(1, $communities[0]['id']);
+        $this->assertSame('Test community', $communities[0]['name']);
+        $this->assertSame('test-community', $communities[0]['slug']);
+    }
+
+    public function test_get_community_ok(): void
+    {
+        $circleSo = $this->getSdkWithMockedClient([
+            new Response(200, [], json_response('community')),
+        ]);
+
+        $community = $circleSo->communities()
+            ->communityId(1)
+            ->community('test-community');
+
+        $this->assertArrayHasKey('id', $community);
+
+        $this->assertSame(1, $community['id']);
+        $this->assertSame('Test community', $community['name']);
+        $this->assertSame('test-community', $community['slug']);
+    }
+
+    public function test_get_community_empty(): void
+    {
+        $this->expectException(ResourceNotFoundException::class);
+        $this->expectExceptionMessage('The resource was not found.');
+        $this->expectExceptionCode(404);
+
+        $circleSo = $this->getSdkWithMockedClient([
+            new Response(200, [], null),
+        ]);
+
+        $circleSo->communities()
+            ->communityId(1)
+            ->community('non-existent-community');
+
+    }
+}

tests/stubs/responses/communities.json

@@ -0,0 +1,45 @@
+[
+    {
+        "id": 1,
+        "name": "Test community",
+        "slug": "test-community",
+        "icon_url": "https://d2y5h3osumboay.cloudfront.net/qran10ilr2xb13ryvjhlkbm97db0",
+        "logo_url": null,
+        "dark_icon_url": null,
+        "dark_logo_url": null,
+        "owner_id": 1,
+        "is_private": true,
+        "space_ids": [
+            1,
+            2,
+            3,
+            4,
+            5
+        ],
+        "last_visited_by_current_user": true,
+        "custom_tos": "https://test.com/terms",
+        "custom_tos_enabled": true,
+        "default_existing_member_space_id": 0,
+        "root_url": "circle.test.com",
+        "display_on_switcher": false,
+        "prefs": {
+
+            "has_posts": true,
+            "has_spaces": true,
+            "brand_color": {
+                "dark": "#FFFFFF",
+                "light": "#000000"
+            },
+            "has_seen_widget": true,
+            "brand_text_color": {
+                "dark": "#FFFFFF",
+                "light": "#000000"
+            },
+            "has_topics": true,
+            "has_completed_onboarding": true,
+            "has_invited_member": true,
+            "new_community_event_fired": true
+        },
+        "white_label": true
+    }
+]

tests/stubs/responses/community.json

@@ -0,0 +1,43 @@
+{
+    "id": 1,
+    "name": "Test community",
+    "slug": "test-community",
+    "icon_url": "https://d2y5h3osumboay.cloudfront.net/qran10ilr2xb13ryvjhlkbm97db0",
+    "logo_url": null,
+    "dark_icon_url": null,
+    "dark_logo_url": null,
+    "owner_id": 1,
+    "is_private": true,
+    "space_ids": [
+        1,
+        2,
+        3,
+        4,
+        5
+    ],
+    "last_visited_by_current_user": true,
+    "custom_tos": "https://test.com/terms",
+    "custom_tos_enabled": true,
+    "default_existing_member_space_id": 0,
+    "root_url": "circle.test.com",
+    "display_on_switcher": false,
+    "prefs": {
+
+        "has_posts": true,
+        "has_spaces": true,
+        "brand_color": {
+            "dark": "#FFFFFF",
+            "light": "#000000"
+        },
+        "has_seen_widget": true,
+        "brand_text_color": {
+            "dark": "#FFFFFF",
+            "light": "#000000"
+        },
+        "has_topics": true,
+        "has_completed_onboarding": true,
+        "has_invited_member": true,
+        "new_community_event_fired": true
+    },
+    "white_label": true
+}