Adopt fluent syntax for client calls

README.md

@@ -20,16 +20,22 @@ The library is PHP agnostic but provides deep integration with [Laravel](https:/
 Here's an example how you'd use it:
 
 ```php
-use GitHub\Sponsors\GitHubSponsors;
+use GitHub\Sponsors\Client;
 use Illuminate\Http\Client\Factory;
 
-$client = new GitHubSponsors(new Factory(), getenv('GH_SPONSORS_TOKEN'));
+$client = new Client(getenv('GH_SPONSORS_TOKEN'));
 
 // Check if driesvints is being sponsored by nunomaduro...
-$client->isSponsoredBy('driesvints', 'nunomaduro');
+$client->login('driesvints')->isSponsoredBy('nunomaduro');
 
-// Check if the blade-ui-kit organization is being sponsored by nunomaduro...
-$client->isSponsoredBy('blade-ui-kit', 'nunomaduro');
+// Check if the blade-ui-kit organization is sponsored by nunomaduro...
+$client->login('nunomaduro')->isSponsoring('blade-ui-kit');
+
+// Check if the authenticated user is sponsored by Gummibeer...
+$client->viewer()->isSponsoredBy('Gummibeer');
+
+// Check if the authenticated user is sponsoring by driesvints...
+$client->viewer()->isSponsoring('driesvints');
 ```
 
 ## Roadmap
@@ -91,10 +97,10 @@ All of this library's API calls are made from the core `GitHub\Sponsors\GitHubSp
 To get started, initialize the GitHub API client, authenticate using the token (preferable through an environment variable) and initialize the Sponsors client:
 
 ```php
-use GitHub\Sponsors\GitHubSponsors;
+use GitHub\Sponsors\Client;
 use Illuminate\Http\Client\Factory;
 
-$client = new GitHubSponsors(new Factory(), getenv('GH_SPONSORS_TOKEN'));
+$client = new Client(new Factory(), getenv('GH_SPONSORS_TOKEN'));
 ```
 
 This will be the client we'll use throughout the rest of these docs. We'll re-use the `$client` variable in the below examples.
@@ -104,9 +110,9 @@ This will be the client we'll use throughout the rest of these docs. We'll re-us
 If you're using Laravel, the client is already bound to the container as a singleton. Simply retrieve it from the container:
 
 ```php
-use GitHub\Sponsors\GitHubSponsors;
+use GitHub\Sponsors\Client;
 
-$client = app(GitHubSponsors::class);
+$client = app(Client::class);
 ```
 
 The client was authenticated with the env variable you've set in your `.env` file.
@@ -116,29 +122,33 @@ The client was authenticated with the env variable you've set in your `.env` fil
 At its core, this library allows you to easily check wether a specific user or organization is sponsoring another one:
 
 ```php
+/** @var \GitHub\Sponsors\Client $client */
+
 // Check if driesvints is being sponsored by nunomaduro...
-$client->isSponsoredBy('driesvints', 'nunomaduro');
+$client->login('driesvints')->isSponsoredBy('nunomaduro');
 
 // Check if the blade-ui-kit organization is being sponsored by nunomaduro...
-$client->isSponsoredBy('blade-ui-kit', 'nunomaduro');
+$client->login('blade-ui-kit')->isSponsoredBy('nunomaduro');
 ```
 
 ### Checking Sponsorships as a Viewer
 
 You can also perform these checks from the point-of-view of the user that was used to authenticate the GitHub API client. If you'll use the methods below, it would be as if you'd be browsing GitHub as the user that created the token.
 
 ```php
+/** @var \GitHub\Sponsors\Client $client */
+
 // Is the current authed user sponsoring driesvints?
-$client->isViewerSponsoring('driesvints');
+$client->viewer()->isSponsoring('driesvints');
 
 // Is the current authed user sponsoring the laravel organization?
-$client->isViewerSponsoring('laravel');
+$client->viewer()->isSponsoring('laravel');
 
 // Is the current authed user sponsored by driesvints?
-$client->isViewerSponsoredBy('driesvints');
+$client->viewer()->isSponsoredBy('driesvints');
 
 // Is the current authed user sponsored by the laravel organization?
-$client->isViewerSponsoredBy('laravel');
+$client->viewer()->isSponsoredBy('laravel');
 ```
 
 You might be wondering why we're using the "Viewer" wording here. "Viewer" is also a concept in the GraphQL API of GitHub. It represents the currently authenticated user that's performing the API requests. That's why we've decided to also use this terminology in the package's API.
@@ -148,11 +158,12 @@ You might be wondering why we're using the "Viewer" wording here. "Viewer" is al
 If you use Laravel you can also make use of the shipped `GitHubSponsors` facade:
 
 ```php
+use GitHub\Sponsors\Facades\GitHubSponsors;
 // Check if driesvints is being sponsored by nunomaduro...
-GitHubSponsors::isSponsoredBy('driesvints', 'nunomaduro');
+GitHubSponsors::login('driesvints')->isSponsoredBy('nunomaduro');
 
 // Check if the blade-ui-kit organization is being sponsored by nunomaduro...
-GitHubSponsors::isSponsoredBy('blade-ui-kit', 'nunomaduro');
+GitHubSponsors::login('blade-ui-kit')->isSponsoredBy('nunomaduro');
 ```
 
 ### Sponsorable Behavior
@@ -274,23 +285,23 @@ When providing the sponsorable with a token, it'll initialize a new GitHub clien
 
 ```php
 use GitHub\Sponsors\Concerns\Sponsorable;
-use GitHub\Sponsors\GitHubSponsors;
+use GitHub\Sponsors\Clients\Login;
 
 class User
 {
     use Sponsorable;
 
-    private GitHubSponsors $client;
+    private Login $client;
 
     private string $github;
 
-    public function __construct(GitHubSponsors $client, string $github)
+    public function __construct(Login $client, string $github)
     {
         $this->client = $client;
         $this->github = $github;
     }
 
-    protected function sponsorsClient(): GitHubSponsors
+    protected function sponsorsClient(): Login
     {
         return $this->client;
     }

composer.json

@@ -39,7 +39,7 @@
     "extra": {
         "laravel": {
             "aliases": {
-                "GitHubSponsors": "GitHub\\Sponsors\\Facades\\GitHubSponsorsFacade"
+                "GitHubSponsors": "GitHubSponsors"
             },
             "providers": [
                 "GitHub\\Sponsors\\GitHubSponsorsServiceProvider"

src/Client.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GitHub\Sponsors;
+
+use GitHub\Sponsors\Clients\Login;
+use GitHub\Sponsors\Clients\Viewer;
+use Illuminate\Http\Client\Factory;
+
+final class Client
+{
+    private GraphqlClient $graphql;
+
+    public function __construct(string $token)
+    {
+        $this->graphql = new GraphqlClient(new Factory(), $token);
+    }
+
+    public function viewer(): Viewer
+    {
+        return new Viewer($this->graphql);
+    }
+
+    public function login(string $login): Login
+    {
+        return new Login($this->graphql, $login);
+    }
+}

src/Clients/Login.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace GitHub\Sponsors\Clients;
+
+use GitHub\Sponsors\Contracts\Sponsorable;
+use GitHub\Sponsors\GraphqlClient;
+
+final class Login implements Sponsorable
+{
+    private GraphqlClient $client;
+
+    private string $login;
+
+    public function __construct(GraphqlClient $client, string $login)
+    {
+        $this->client = $client;
+        $this->login = $login;
+    }
+
+    public function isSponsoredBy(string $sponsor): bool
+    {
+        $query = <<<'QUERY'
+            query (
+                $account: String!
+                $sponsor: String!
+            ) {
+                user(login: $account) {
+                    isSponsoredBy(accountLogin: $sponsor)
+                }
+                organization(login: $account) {
+                    isSponsoredBy(accountLogin: $sponsor)
+                }
+            }
+        QUERY;
+
+        $result = $this->client->send($query, [
+            'account' => $this->login,
+            'sponsor' => $sponsor,
+        ]);
+
+        return ($result['user']['isSponsoredBy'] ?? false) ||
+            ($result['organization']['isSponsoredBy'] ?? false);
+    }
+
+    public function isSponsoring(string $account): bool
+    {
+        $query = <<<'QUERY'
+            query (
+                $account: String!
+                $sponsor: String!
+            ) {
+                user(login: $account) {
+                    isSponsoredBy(accountLogin: $sponsor)
+                }
+                organization(login: $account) {
+                    isSponsoredBy(accountLogin: $sponsor)
+                }
+            }
+        QUERY;
+
+        $result = $this->client->send($query, [
+            'account' => $account,
+            'sponsor' => $this->login,
+        ]);
+
+        return ($result['user']['isSponsoredBy'] ?? false) ||
+            ($result['organization']['isSponsoredBy'] ?? false);
+    }
+}

src/Clients/Viewer.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace GitHub\Sponsors\Clients;
+
+use GitHub\Sponsors\Contracts\Sponsorable;
+use GitHub\Sponsors\GraphqlClient;
+
+final class Viewer implements Sponsorable
+{
+    private GraphqlClient $client;
+
+    public function __construct(GraphqlClient $client)
+    {
+        $this->client = $client;
+    }
+
+    public function isSponsoredBy(string $sponsor): bool
+    {
+        $query = <<<'QUERY'
+        query (
+            $sponsor: String!
+        ) {
+            user(login: $sponsor) {
+                isSponsoringViewer
+            }
+            organization(login: $sponsor) {
+                isSponsoringViewer
+            }
+        }
+        QUERY;
+
+        $result = $this->client->send($query, compact('sponsor'));
+
+        return ($result['user']['isSponsoringViewer'] ?? false) ||
+            ($result['organization']['isSponsoringViewer'] ?? false);
+    }
+
+    public function isSponsoring(string $account): bool
+    {
+        $query = <<<'QUERY'
+            query (
+                $account: String!
+            ) {
+                user(login: $account) {
+                    viewerIsSponsoring
+                }
+                organization(login: $account) {
+                    viewerIsSponsoring
+                }
+            }
+        QUERY;
+
+        $result = $this->client->send($query, compact('account'));
+
+        return ($result['user']['viewerIsSponsoring'] ?? false) ||
+            ($result['organization']['viewerIsSponsoring'] ?? false);
+    }
+}

src/Concerns/Sponsorable.php

@@ -4,23 +4,21 @@
 
 namespace GitHub\Sponsors\Concerns;
 
-use GitHub\Sponsors\GitHubSponsors;
-use Illuminate\Http\Client\Factory;
+use GitHub\Sponsors\Client;
+use GitHub\Sponsors\Clients\Login;
 
 trait Sponsorable
 {
     public function isSponsoredBy(string $sponsor): bool
     {
-        return $this->sponsorsClient()->isSponsoredBy(
-            $this->gitHubUsername(), $sponsor
-        );
+        return $this->sponsorsClient()
+            ->isSponsoredBy($sponsor);
     }
 
     public function isSponsoring(string $account): bool
     {
-        return $this->sponsorsClient()->isSponsoredBy(
-            $account, $this->gitHubUsername()
-        );
+        return $this->sponsorsClient()
+            ->isSponsoring($account);
     }
 
     public function gitHubUsername(): string
@@ -38,12 +36,12 @@ public function hasGitHubToken(): bool
         return $this->gitHubToken() !== null;
     }
 
-    protected function sponsorsClient(): GitHubSponsors
+    protected function sponsorsClient(): Login
     {
-        if (! $this->hasGitHubToken()) {
-            return app(GitHubSponsors::class);
-        }
+        $factory = $this->hasGitHubToken()
+            ? new Client($this->gitHubToken())
+            : app(Client::class);
 
-        return new GitHubSponsors(new Factory(), $this->gitHubToken());
+        return $factory->login($this->gitHubUsername());
     }
 }

src/Contracts/Sponsorable.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace GitHub\Sponsors\Contracts;
+
+interface Sponsorable
+{
+    public function isSponsoredBy(string $sponsor): bool;
+
+    public function isSponsoring(string $account): bool;
+}

src/Facades/GitHubSponsors.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GitHub\Sponsors\Facades;
+
+use GitHub\Sponsors\Client;
+use Illuminate\Support\Facades\Facade;
+
+/**
+ * @method static \GitHub\Sponsors\Clients\Viewer viewer()
+ * @method static \GitHub\Sponsors\Clients\Login login(string $login)
+ *
+ * @see \GitHub\Sponsors\Client
+ */
+final class GitHubSponsors extends Facade
+{
+    protected static function getFacadeAccessor(): string
+    {
+        return Client::class;
+    }
+}