initial commit

Author: Gummibeer

.gitignore

@@ -0,0 +1,3 @@
+/vendor/
+composer.lock
+phpunit.xml

README.md

@@ -1 +1,39 @@
-# laravel-github-sponsors
+# Laravel GitHub Sponsors
+
+Retrieve the GitHub Sponsors of a given user/organization.
+
+## Installation
+
+```bash
+composer require astrotomic/laravel-github-sponsors
+```
+
+## Configuration
+
+Set `services.github.sponsors_token` config value or override service binding in your own service provider.
+The used PAT needs at least `read:org` permissions to retrieve sponsoring organizations.
+
+```php
+use Astrotomic\GithubSponsors\GithubSponsors;
+use Illuminate\Contracts\Container\Container;
+
+$this->app->bind(GithubSponsors::class, function(Container $app): GithubSponsors {
+    return new GithubSponsors(
+        $app->make('config')->get('your.own.config.key')
+    );
+});
+```
+
+## Usage
+
+```php
+use Astrotomic\GithubSponsors\Facades\GithubSponsors;
+
+GithubSponsors::fromViewer()->all(); // all sponsors for current authenticated user
+GithubSponsors::fromUser('Gummibeer')->all(); // all sponsors for given user
+GithubSponsors::fromOrganization('Astrotomic')->all(); // all sponsors for given organization
+
+GithubSponsors::fromViewer()->cursor(); // lazy collection - using less memory
+
+GithubSponsors::fromViewer()->select('login', 'name', 'avatarUrl')->all(); // select specific attributes
+```

composer.json

@@ -0,0 +1,52 @@
+{
+    "name": "astrotomic/laravel-github-sponsors",
+    "description": "",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Tom Witkowski",
+            "email": "gummibeer@astrotomic.info",
+            "homepage": "https://astrotomic.info",
+            "role": "Developer"
+        }
+    ],
+    "require": {
+        "php": "^7.4 || ^8.0",
+        "ext-json": "*",
+        "astrotomic/graphql-query-builder": "^0.1.0",
+        "guzzlehttp/guzzle": "^6.5.5 || ^7.0.1",
+        "illuminate/http": "^8.0",
+        "illuminate/support": "^8.0"
+    },
+    "require-dev": {
+        "orchestra/testbench": "^5.0 || ^6.0",
+        "pestphp/pest": "^v1.15.0",
+        "pestphp/pest-plugin-laravel": "^1.1"
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "composer-normalize": {
+            "indent-size": 4,
+            "indent-style": "space"
+        },
+        "laravel": {
+            "providers": [
+                "Astrotomic\\GithubSponsors\\GithubSponsorsServiceProvider"
+            ]
+        }
+    },
+    "autoload": {
+        "psr-4": {
+            "Astrotomic\\GithubSponsors\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
+}

phpunit.xml.dist

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </coverage>
+</phpunit>

src/Facades/GithubSponsors.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Astrotomic\GithubSponsors\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+/**
+ * @method static \Astrotomic\GithubSponsors\GithubSponsors fromViewer()
+ * @method static \Astrotomic\GithubSponsors\GithubSponsors fromUser(string $login)
+ * @method static \Astrotomic\GithubSponsors\GithubSponsors fromOrganization(string $login)
+ *
+ * @see \Astrotomic\GithubSponsors\GithubSponsors
+ */
+class GithubSponsors extends Facade
+{
+    protected static function getFacadeAccessor(): string
+    {
+        return \Astrotomic\GithubSponsors\GithubSponsors::class;
+    }
+}

src/GithubSponsors.php

@@ -0,0 +1,123 @@
+<?php
+
+namespace Astrotomic\GithubSponsors;
+
+use Astrotomic\GraphqlQueryBuilder\Graph;
+use Astrotomic\GraphqlQueryBuilder\Query;
+use Exception;
+use Generator;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Http;
+use Illuminate\Support\Fluent;
+use Illuminate\Support\LazyCollection;
+
+class GithubSponsors
+{
+    protected string $fromName;
+    protected array $fromArguments = [];
+    protected array $select = [
+        'login'
+    ];
+    protected string $token;
+
+    public function __construct(string $token)
+    {
+        $this->token = $token;
+    }
+
+    public function fromViewer(): self
+    {
+        $this->fromName = 'viewer';
+        $this->fromArguments = [];
+
+        return $this;
+    }
+
+    public function fromUser(string $login): self
+    {
+        $this->fromName = 'user';
+        $this->fromArguments = [
+            'login' => $login,
+        ];
+
+        return $this;
+    }
+
+    public function fromOrganization(string $login): self
+    {
+        $this->fromName = 'organization';
+        $this->fromArguments = [
+            'login' => $login,
+        ];
+
+        return $this;
+    }
+
+    public function select(string ...$fields): self
+    {
+        $this->select = $fields;
+
+        return $this;
+    }
+
+    public function all(): Collection
+    {
+        return $this->cursor()->collect();
+    }
+
+    public function cursor(): LazyCollection
+    {
+        return LazyCollection::make(function (): Generator {
+            $cursor = null;
+
+            do {
+                $data = $this->request($this->query($cursor));
+                $cursor = $data['pageInfo']['endCursor'];
+
+                foreach (data_get($data, 'nodes.*.sponsorEntity') as $sponsor) {
+                    yield new Fluent($sponsor);
+                }
+            } while ($data['pageInfo']['hasNextPage'] ?? false);
+        });
+    }
+
+    protected function query(?string $after = null): string
+    {
+        return (string) Graph::query(
+            Query::from($this->fromName)
+                ->with($this->fromArguments)
+                ->select(
+                    Query::from('sponsorshipsAsMaintainer')
+                        ->with(array_filter(['first' => 100, 'after' => $after]))
+                        ->select(
+                            Query::from('pageInfo')->select('hasNextPage', 'endCursor'),
+                            Query::from('nodes')->select(
+                                Query::from('sponsorEntity')->select(
+                                    '__typename',
+                                    Query::for('User')->select(...$this->select),
+                                    Query::for('Organization')->select(...$this->select),
+                                )
+                            )
+                        )
+                )
+        );
+    }
+
+    protected function request(string $query): array
+    {
+        $response = Http::baseUrl('https://api.github.com')
+            ->accept('application/vnd.github.v3+json')
+            ->withUserAgent('astrotomic/laravel-github-sponsors')
+            ->withOptions(['http_errors' => true])
+            ->withToken($this->token)
+            ->post('/graphql', ['query' => $query])
+            ->json();
+
+        if (array_key_exists('errors', $response)) {
+            throw new Exception(Arr::first($response['errors'])['message']);
+        }
+
+        return data_get($response, "data.{$this->fromName}.sponsorshipsAsMaintainer");
+    }
+}

src/GithubSponsorsServiceProvider.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Astrotomic\GithubSponsors;
+
+use Illuminate\Contracts\Container\Container;
+use Illuminate\Support\ServiceProvider;
+
+class GithubSponsorsServiceProvider extends ServiceProvider
+{
+    public function register(): void
+    {
+        $this->app->bind(GithubSponsors::class, function(Container $app): GithubSponsors {
+            return new GithubSponsors(
+                $app->make('config')->get('services.github.sponsors_token')
+            );
+        });
+    }
+}

tests/Feature/GithubSponsorsTest.php

@@ -0,0 +1,63 @@
+<?php
+
+use Astrotomic\GithubSponsors\Facades\GithubSponsors;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Fluent;
+use Illuminate\Support\LazyCollection;
+use Pest\Expectation;
+
+it('retrieves sponsors for authenticated user')
+    ->expect(fn() => GithubSponsors::fromViewer()->all())
+    ->toBeInstanceOf(Collection::class)
+    ->not->toBeEmpty()
+    ->each(static function(Expectation $value): void {
+        $value
+            ->toBeInstanceOf(Fluent::class)
+            ->__typename->toBeString()->toBeIn(['User', 'Organization'])
+            ->login->toBeString();
+    });
+
+it('retrieves sponsors for given user')
+    ->expect(fn() => GithubSponsors::fromUser('Gummibeer')->all())
+    ->toBeInstanceOf(Collection::class)
+    ->not->toBeEmpty()
+    ->each(static function(Expectation $value): void {
+        $value
+            ->toBeInstanceOf(Fluent::class)
+            ->__typename->toBeString()->toBeIn(['User', 'Organization'])
+            ->login->toBeString();
+    });
+
+it('retrieves sponsors for given organization')
+    ->expect(fn() => GithubSponsors::fromOrganization('larabelles')->all())
+    ->toBeInstanceOf(Collection::class)
+    ->not->toBeEmpty()
+    ->each(static function(Expectation $value): void {
+        $value
+            ->toBeInstanceOf(Fluent::class)
+            ->__typename->toBeString()->toBeIn(['User', 'Organization'])
+            ->login->toBeString();
+    });
+
+it('retrieves sponsors with custom fields')
+    ->expect(fn() => GithubSponsors::fromViewer()->select('login', 'databaseId')->all())
+    ->toBeInstanceOf(Collection::class)
+    ->not->toBeEmpty()
+    ->each(static function(Expectation $value): void {
+        $value
+            ->toBeInstanceOf(Fluent::class)
+            ->__typename->toBeString()->toBeIn(['User', 'Organization'])
+            ->login->toBeString()
+            ->databaseId->toBeInt()->toBeGreaterThan(0);
+    });
+
+it('retrieves sponsors lazyly')
+    ->expect(fn() => GithubSponsors::fromViewer()->cursor())
+    ->toBeInstanceOf(LazyCollection::class)
+    ->not->toBeEmpty()
+    ->each(static function(Expectation $value): void {
+        $value
+            ->toBeInstanceOf(Fluent::class)
+            ->__typename->toBeString()->toBeIn(['User', 'Organization'])
+            ->login->toBeString();
+    });

tests/Pest.php

@@ -0,0 +1,12 @@
+<?php
+
+use Astrotomic\GithubSponsors\GithubSponsorsServiceProvider;
+use Orchestra\Testbench\TestCase;
+
+uses(TestCase::class)->in('Feature');
+
+uses()->beforeEach(function(): void {
+    $this->app->register(GithubSponsorsServiceProvider::class);
+
+    config()->set('services.github.sponsors_token', env('GITHUB_SPONSORS_TOKEN'));
+})->in('Feature');