Merge branch 'next' into develop

* next: (29 commits) update documentation make SDK constructor private declare value objects immutable make Key constructor private lazy load catalog artist albums use sequences instead of sets as there is no guarantee there is no duplicates due to the pagination use lazy structure for top level fetchs return empty sets instead of throwing return an empty storefront set instead of throwing return a Maybe instead of throwing an error if the user token is invalid return a Maybe instead of raising errors when an element from the catalog is not found there is always an artwork for a catalog album load the artist artwork load link to catalog artist fix values that may not exist CS CS use Maybe instead of nullable types CS remove unused exceptions ...
musiccompanion · Jul 24, 2022 · 81bdae4 · 81bdae4
2 parents d42286a + 3840ee8
commit 81bdae4
Show file tree

Hide file tree

Showing 108 changed files with 3,049 additions and 2,503 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macOS-latest]
-        php-version: ['7.4', '8.0']
+        php-version: ['8.1']
     name: 'PHPUnit'
     steps:
       - name: Checkout
@@ -20,17 +20,8 @@ jobs:
           extensions: mbstring, intl
           coverage: xdebug
           ini-values: xdebug.max_nesting_level=2048
-      - name: Get Composer Cache Directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-      - name: Cache dependencies
-        uses: actions/cache@v2
-        with:
-          path: ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
-          restore-keys: ${{ runner.os }}-composer-
-      - name: Install Dependencies
-        run: composer install --no-progress --prefer-source
+      - name: Composer
+        uses: "ramsey/composer-install@v2"
       - name: PHPUnit
         run: vendor/bin/phpunit --coverage-clover=coverage.clover
         env:
@@ -42,7 +33,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-version: ['7.4', '8.0']
+        php-version: ['8.1']
     name: 'Psalm'
     steps:
       - name: Checkout
@@ -52,24 +43,15 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           extensions: mbstring, intl
-      - name: Get Composer Cache Directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-      - name: Cache dependencies
-        uses: actions/cache@v2
-        with:
-          path: ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
-          restore-keys: ${{ runner.os }}-composer-
-      - name: Install Dependencies
-        run: composer install --no-progress
+      - name: Composer
+        uses: "ramsey/composer-install@v2"
       - name: Psalm
         run: vendor/bin/psalm --shepherd
   cs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-version: ['7.4']
+        php-version: ['8.1']
     name: 'CS'
     steps:
       - name: Checkout
@@ -79,16 +61,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-version }}
           extensions: mbstring, intl
-      - name: Get Composer Cache Directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-      - name: Cache dependencies
-        uses: actions/cache@v2
-        with:
-          path: ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-${{ matrix.php-version }}-composer-${{ hashFiles('**/composer.json') }}
-          restore-keys: ${{ runner.os }}-${{ matrix.php-version }}-composer-
-      - name: Install Dependencies
-        run: composer install --no-progress
+      - name: Composer
+        uses: "ramsey/composer-install@v2"
       - name: CS
-        run: vendor/bin/php-cs-fixer fix --diff --dry-run --diff-format udiff
+        run: vendor/bin/php-cs-fixer fix --diff --dry-run
diff --git a/.php_cs.dist → .php-cs-fixer.dist.php b/.php_cs.dist → .php-cs-fixer.dist.php
diff --git a/README.md b/README.md
@@ -20,37 +20,40 @@ use MusicCompanion\AppleMusic\{
     Key,
 };
 use Innmind\OperatingSystem\Factory;
-use Innmind\TimeContinuum\Period\Earth\Hour;
+use Innmind\TimeContinuum\Earth\Period\Hour;
 use Innmind\Url\Path;
 use Innmind\Filesystem\Name;
+use Innmind\Immutable\Set;
 
 $os = Factory::build();
 
-$sdk = new SDK\SDK(
+$sdk = SDK::of(
     $os->clock(),
     $os->remote()->http(),
-    new Key( // @see https://help.apple.com/developer-account/#/devce5522674 to understand howto generate the key
+    Key::of( // @see https://help.apple.com/developer-account/#/devce5522674 to understand howto generate the key
         'KEY_ID',
         'TEAM_ID',
         $os
             ->filesystem()
             ->mount(Path::of('config_dir/'))
             ->get(new Name('AuthKey_TEAM_ID.p8'))
-            ->content(),
+            ->match(
+                static fn($file) => $file->content(),
+                static fn() => throw new \RuntimeException('Key file not found'),
+            ),
     ),
     new Hour(1) // expire the generated token after an hour
 );
 
-$sdk->storefronts()->all(); // set<SDK\Storefront>
+$sdk->storefronts()->all(); // Set<SDK\Storefront>
 $catalog = $sdk->catalog(new SDK\Storefront\Id('fr'));
 $result = $catalog->search('Pendulum Live at Brixton');
-$albums = [];
-
-foreach ($result->albums() as $id) {
-    $albums[] = $catalog->album($id);
-}
+$albums = $result->albums()->map($catalog->album(...));
 
 // @see https://developer.apple.com/documentation/applemusicapi/getting_keys_and_creating_tokens
 // to retrieve the user token
-$sdk->library($userToken)->artists(); // set<SDK\Library\Artist>
+$sdk->library($userToken)->match(
+    static fn($libray) => $libray->artists(), // Set<SDK\Library\Artist>
+    static fn() => throw new \RuntimeException('Invalid user token'),
+);
 ```
diff --git a/composer.json b/composer.json
@@ -8,18 +8,18 @@
     "authors": [
         {
             "name": "Baptiste Langlade",
-            "email": "langlade.baptiste@gmail.com"
+            "email": "baptiste.langlade@hey.com"
         }
     ],
     "support": {
         "issues": "http://github.com/MusicCompanion/AppleMusic/issues"
     },
     "require": {
-        "php": "~7.4|~8.0",
-        "innmind/immutable": "~3.5",
-        "innmind/url": "~3.3",
-        "innmind/colour": "~3.1",
-        "innmind/operating-system": "~2.0",
+        "php": "~8.1",
+        "innmind/immutable": "~4.4",
+        "innmind/url": "~4.1",
+        "innmind/colour": "~4.0",
+        "innmind/operating-system": "~3.1",
         "innmind/json": "^1.1",
         "lcobucci/jwt": "~4.0"
     },
@@ -38,6 +38,6 @@
         "phpunit/phpunit": "~9.0",
         "innmind/black-box": "~4.9",
         "vimeo/psalm": "~4.4",
-        "innmind/coding-standard": "^1.1"
+        "innmind/coding-standard": "~2.0"
     }
 }
diff --git a/fixtures/SDK/Catalog/Album/Id.php b/fixtures/SDK/Catalog/Album/Id.php
@@ -14,9 +14,7 @@ final class Id
     public static function any(): Set
     {
         return Set\Decorate::immutable(
-            static function(int $number): Model {
-                return new Model($number);
-            },
+            Model::of(...),
             Set\NaturalNumbers::any(),
         );
     }

diff --git a/fixtures/SDK/Catalog/Artist/Id.php b/fixtures/SDK/Catalog/Artist/Id.php
@@ -14,9 +14,7 @@ final class Id
     public static function any(): Set
     {
         return Set\Decorate::immutable(
-            static function(int $number): Model {
-                return new Model($number);
-            },
+            Model::of(...),
             Set\NaturalNumbers::any(),
         );
     }

diff --git a/fixtures/SDK/Catalog/Artwork.php b/fixtures/SDK/Catalog/Artwork.php
@@ -4,6 +4,7 @@
 namespace Fixtures\MusicCompanion\AppleMusic\SDK\Catalog;
 
 use MusicCompanion\AppleMusic\SDK\Catalog\Artwork as Model;
+use Innmind\Immutable\Maybe;
 use Innmind\BlackBox\Set;
 use Fixtures\Innmind\Colour\Colour;
 use Fixtures\Innmind\Url\Url;
@@ -17,7 +18,16 @@ public static function any(): Set
     {
         return Set\Composite::immutable(
             static function($width, $height, $url, $background, $text1, $text2, $text3, $text4): Model {
-                return new Model($width, $height, $url, $background, $text1, $text2, $text3, $text4);
+                return new Model(
+                    $width,
+                    $height,
+                    $url,
+                    Maybe::of($background),
+                    Maybe::of($text1),
+                    Maybe::of($text2),
+                    Maybe::of($text3),
+                    Maybe::of($text4),
+                );
             },
             Artwork\Width::any(),
             Artwork\Height::any(),

diff --git a/fixtures/SDK/Catalog/Genre.php b/fixtures/SDK/Catalog/Genre.php
@@ -14,9 +14,7 @@ final class Genre
     public static function any(): Set
     {
         return Set\Decorate::immutable(
-            static function(string $string): Model {
-                return new Model($string);
-            },
+            Model::of(...),
             Set\Strings::any(),
         );
     }

diff --git a/fixtures/SDK/Catalog/Song/DiscNumber.php b/fixtures/SDK/Catalog/Song/DiscNumber.php
@@ -14,9 +14,7 @@ final class DiscNumber
     public static function any(): Set
     {
         return Set\Decorate::immutable(
-            static function(int $number): Model {
-                return new Model($number);
-            },
+            Model::of(...),
             Set\NaturalNumbersExceptZero::any(),
         );
     }

diff --git a/fixtures/SDK/Catalog/Song/ISRC.php b/fixtures/SDK/Catalog/Song/ISRC.php
@@ -20,7 +20,7 @@ public static function any(): Set
 
         return Set\Composite::immutable(
             static function(...$bits): Model {
-                return new Model(\implode('', $bits));
+                return Model::of(\implode('', $bits));
             },
             $c,
             $c,

diff --git a/fixtures/SDK/Catalog/Song/Id.php b/fixtures/SDK/Catalog/Song/Id.php
@@ -14,9 +14,7 @@ final class Id
     public static function any(): Set
     {
         return Set\Decorate::immutable(
-            static function(int $number): Model {
-                return new Model($number);
-            },
+            Model::of(...),
             Set\NaturalNumbers::any(),
         );
     }

diff --git a/fixtures/SDK/Catalog/Song/TrackNumber.php b/fixtures/SDK/Catalog/Song/TrackNumber.php
@@ -14,9 +14,7 @@ final class TrackNumber
     public static function any(): Set
     {
         return Set\Decorate::immutable(
-            static function(int $number): Model {
-                return new Model($number);
-            },
+            Model::of(...),
             Set\NaturalNumbersExceptZero::any(),
         );
     }

diff --git a/fixtures/SDK/Library/Album/Artwork.php b/fixtures/SDK/Library/Album/Artwork.php
@@ -4,6 +4,7 @@
 namespace Fixtures\MusicCompanion\AppleMusic\SDK\Library\Album;
 
 use MusicCompanion\AppleMusic\SDK\Library\Album\Artwork as Model;
+use Innmind\Immutable\Maybe;
 use Innmind\BlackBox\Set;
 use Fixtures\Innmind\Url\Url;
 
@@ -16,7 +17,7 @@ public static function any(): Set
     {
         return Set\Composite::immutable(
             static function($width, $height, $url): Model {
-                return new Model($width, $height, $url);
+                return new Model(Maybe::of($width), Maybe::of($height), $url);
             },
             new Set\Either(
                 Artwork\Width::any(),

diff --git a/fixtures/SDK/Library/Album/Id.php b/fixtures/SDK/Library/Album/Id.php
@@ -30,7 +30,7 @@ public static function any(): Set
 
         return Set\Decorate::immutable(
             static function(string $chars): Model {
-                return new Model('l.'.$chars);
+                return Model::of('l.'.$chars);
             },
             $chars,
         )->take(100);

diff --git a/fixtures/SDK/Library/Artist/Id.php b/fixtures/SDK/Library/Artist/Id.php
@@ -30,7 +30,7 @@ public static function any(): Set
 
         return Set\Decorate::immutable(
             static function(string $chars): Model {
-                return new Model('r.'.$chars);
+                return Model::of('r.'.$chars);
             },
             $chars,
         )->take(100);

diff --git a/fixtures/SDK/Library/Song/Genre.php b/fixtures/SDK/Library/Song/Genre.php
@@ -14,9 +14,7 @@ final class Genre
     public static function any(): Set
     {
         return Set\Decorate::immutable(
-            static function(string $string): Model {
-                return new Model($string);
-            },
+            Model::of(...),
             Set\Strings::any(),
         );
     }

diff --git a/fixtures/SDK/Library/Song/TrackNumber.php b/fixtures/SDK/Library/Song/TrackNumber.php
@@ -14,9 +14,7 @@ final class TrackNumber
     public static function any(): Set
     {
         return Set\Decorate::immutable(
-            static function(int $number): Model {
-                return new Model($number);
-            },
+            Model::of(...),
             Set\NaturalNumbersExceptZero::any(),
         );
     }

diff --git a/fixtures/SDK/Storefront.php b/fixtures/SDK/Storefront.php
@@ -5,7 +5,6 @@
 
 use MusicCompanion\AppleMusic\SDK\Storefront as Model;
 use Innmind\BlackBox\Set;
-use function Innmind\Immutable\unwrap;
 use Fixtures\Innmind\Immutable\Set as ISet;
 
 final class Storefront
@@ -17,12 +16,12 @@ public static function any(): Set
     {
         return Set\Composite::immutable(
             static function($id, $name, $default, $languages): Model {
-                return new Model($id, $name, $default, ...unwrap($languages));
+                return new Model($id, $name, $default, $languages);
             },
             Storefront\Id::any(),
             Storefront\Name::any(),
             Storefront\Language::any(),
-            ISet::of(Model\Language::class, Storefront\Language::any()),
+            ISet::of(Storefront\Language::any()),
         )->take(100);
     }
 }
diff --git a/fixtures/SDK/Storefront/Language.php b/fixtures/SDK/Storefront/Language.php
@@ -18,7 +18,7 @@ public static function any(): Set
 
         return Set\Composite::immutable(
             static function(string $char1, string $char2, string $region1, string $region2): Model {
-                return new Model($char1.$char2.'-'.$region1.$region2);
+                return Model::of($char1.$char2.'-'.$region1.$region2);
             },
             $char,
             $char,

diff --git a/src/Exception/InvalidToken.php b/src/Exception/InvalidToken.php
diff --git a/src/Exception/InvalidUserToken.php b/src/Exception/InvalidUserToken.php
diff --git a/src/Exception/RuntimeException.php b/src/Exception/RuntimeException.php