Merge pull request #241 from neildaniels/watch-providers

Add support for watch providers

lib/Tmdb/Api/Movies.php

@@ -296,6 +296,19 @@ public function getVideos($movie_id, array $parameters = [], array $headers = []
         return $this->get('movie/' . $movie_id . '/videos', $parameters, $headers);
     }
 
+    /**
+     * Get the watch providers (by region) for a specific movie id.
+     *
+     * @param $movie_id
+     * @param array $parameters
+     * @param array $headers
+     * @return mixed
+     */
+    public function getWatchProviders($movie_id, array $parameters = [], array $headers = [])
+    {
+        return $this->get('movie/' . $movie_id . '/watch/providers', $parameters, $headers);
+    }
+
     /**
      * Get the external ids that we have stored for a movie.
      *

lib/Tmdb/Api/Tv.php

@@ -169,6 +169,19 @@ public function getVideos($tvshow_id, array $parameters = [], array $headers = [
         return $this->get('tv/' . $tvshow_id . '/videos', $parameters, $headers);
     }
 
+    /**
+     * Get the watch providers (by region) for a specific movie id.
+     *
+     * @param $movie_id
+     * @param array $parameters
+     * @param array $headers
+     * @return mixed
+     */
+    public function getWatchProviders($tvshow_id, array $parameters = [], array $headers = [])
+    {
+        return $this->get('tv/' . $tvshow_id . '/watch/providers', $parameters, $headers);
+    }
+
     /**
      * Get the changes for a specific TV show id.
      *

lib/Tmdb/Factory/MovieFactory.php

@@ -28,6 +28,7 @@
 use Tmdb\Model\Common\Translation;
 use Tmdb\Model\Company;
 use Tmdb\Model\Movie;
+use Tmdb\Model\Watch;
 
 /**
  * Class MovieFactory
@@ -206,6 +207,33 @@ public function create(array $data = []): ?AbstractModel
             $movie->setReleaseDates($release_dates);
         }
 
+        if (array_key_exists('watch/providers', $data) && array_key_exists('results', $data['watch/providers'])) {
+            $watchProviders = new GenericCollection();
+            foreach ($data['watch/providers']['results'] as $iso31661 => $countryWatchData) {
+                $countryWatchData['iso_3166_1'] = $iso31661;
+
+                foreach (['flatrate', 'rent', 'buy'] as $providerType) {
+                    $typeProviders = new GenericCollection();
+                    foreach ($countryWatchData[$providerType] ?? [] as $providerData) {
+                        if (isset($providerData['provider_id'])) {
+                            $providerData['id'] = $providerData['provider_id'];
+                        }
+                        if (isset($providerData['provider_name'])) {
+                            $providerData['name'] = $providerData['provider_name'];
+                        }
+
+                        $providerData['iso_3166_1'] = $iso31661;
+                        $providerData['type'] = $providerType;
+                        $typeProviders->add(null, $this->hydrate(new Watch\Provider(), $providerData));
+                    }
+                    $countryWatchData[$providerType] = $typeProviders;
+                }
+
+                $watchProviders->add($iso31661, $this->hydrate(new Watch\Providers(), $countryWatchData));
+            }
+            $movie->setWatchProviders($watchProviders);
+        }
+
         if (array_key_exists('videos', $data)) {
             $movie->setVideos($this->getVideoFactory()->createCollection($data['videos']));
         }

lib/Tmdb/Factory/TvFactory.php

@@ -29,6 +29,7 @@
 use Tmdb\Model\Person\CastMember;
 use Tmdb\Model\Person\CrewMember;
 use Tmdb\Model\Tv;
+use Tmdb\Model\Watch;
 
 /**
  * Class TvFactory
@@ -244,6 +245,33 @@ public function create(array $data = []): ?AbstractModel
             $tvShow->setNetworks($this->getNetworkFactory()->createCollection($data['networks']));
         }
 
+        if (array_key_exists('watch/providers', $data) && array_key_exists('results', $data['watch/providers'])) {
+            $watchProviders = new GenericCollection();
+            foreach ($data['watch/providers']['results'] as $iso31661 => $countryWatchData) {
+                $countryWatchData['iso_3166_1'] = $iso31661;
+
+                foreach (['flatrate', 'rent', 'buy'] as $providerType) {
+                    $typeProviders = new GenericCollection();
+                    foreach ($countryWatchData[$providerType] ?? [] as $providerData) {
+                        if (isset($providerData['provider_id'])) {
+                            $providerData['id'] = $providerData['provider_id'];
+                        }
+                        if (isset($providerData['provider_name'])) {
+                            $providerData['name'] = $providerData['provider_name'];
+                        }
+
+                        $providerData['iso_3166_1'] = $iso31661;
+                        $providerData['type'] = $providerType;
+                        $typeProviders->add(null, $this->hydrate(new Watch\Provider(), $providerData));
+                    }
+                    $countryWatchData[$providerType] = $typeProviders;
+                }
+
+                $watchProviders->add($iso31661, $this->hydrate(new Watch\Providers(), $countryWatchData));
+            }
+            $tvShow->setWatchProviders($watchProviders);
+        }
+
         if (array_key_exists('videos', $data) && $data['videos'] !== null) {
             $tvShow->setVideos($this->getVideoFactory()->createCollection($data['videos']));
         }

lib/Tmdb/Model/Movie.php

@@ -230,6 +230,10 @@ class Movie extends AbstractModel
      * @var int
      */
     private $voteCount;
+    /**
+     * @var GenericCollection
+     */
+    private $watchProviders;
 
     /**
      * Constructor
@@ -255,6 +259,7 @@ public function __construct()
         $this->recommendations = new GenericCollection();
         $this->translations = new GenericCollection();
         $this->videos = new Videos();
+        $this->watchProviders = new GenericCollection();
     }
 
     /**
@@ -1032,4 +1037,23 @@ public function setVideos($videos)
 
         return $this;
     }
+
+    /**
+     * @return GenericCollection
+     */
+    public function getWatchProviders(): GenericCollection
+    {
+        return $this->watchProviders;
+    }
+
+    /**
+     * @param GenericCollection $watchProviders
+     * @return $this
+     */
+    public function setWatchProviders($watchProviders)
+    {
+        $this->watchProviders = $watchProviders;
+
+        return $this;
+    }
 }

lib/Tmdb/Model/Movie/QueryParameter/AppendToResponse.php

@@ -40,4 +40,5 @@ final class AppendToResponse extends BaseAppendToResponse
     public const LISTS = 'lists';
     public const CHANGES = 'changes';
     public const VIDEOS = 'videos';
+    public const WATCH_PROVIDERS = 'watch/providers';
 }

lib/Tmdb/Model/Query/Discover/DiscoverMoviesQuery.php

@@ -120,6 +120,49 @@ public function language($language)
         return $this;
     }
 
+    /**
+     * An ISO 3166-1 code. Combine this filter with with_watch_providers in order to filter your results by a specific watch provider in a specific region.
+     *
+     * @param string $watchRegion
+     * @return $this
+     */
+    public function watchRegion($watchRegion)
+    {
+        $this->set('watch_region', $watchRegion);
+
+        return $this;
+    }
+
+    /**
+     * Only include movies with the specified watch providers. Combine with watch_region.
+     *
+     * @param array|string $watchProviders
+     * @param int $mode
+     * @return $this
+     */
+    public function withWatchProviders($watchProviders, $mode = self::MODE_OR)
+    {
+        $this->set('with_watch_providers', $this->with($watchProviders, $mode));
+
+        return $this;
+    }
+
+    /**
+     * Only include movies with the specified monetization types. Combine with watch_region.
+     *
+     * Allowed Values: flatrate, free, ads, rent, buy
+     *
+     * @param array|string $watchProviders
+     * @param int $mode
+     * @return $this
+     */
+    public function withWatchMonetizationTypes($watchProviders, $mode = self::MODE_OR)
+    {
+        $this->set('with_watch_monetization_types', $this->with($watchProviders, $mode));
+
+        return $this;
+    }
+
     /**
      * Minimum value is 1, expected value is an integer.
      *

lib/Tmdb/Model/Query/Discover/DiscoverTvQuery.php

@@ -15,6 +15,7 @@
 namespace Tmdb\Model\Query\Discover;
 
 use DateTime;
+use Tmdb\Model\AbstractModel;
 use Tmdb\Model\Collection\QueryParametersCollection;
 
 /**
@@ -23,6 +24,12 @@
  */
 class DiscoverTvQuery extends QueryParametersCollection
 {
+    /** Transform args to an AND query */
+    public const MODE_AND = 0;
+
+    /** Transform args to an OR query */
+    public const MODE_OR = 1;
+
     /**
      * Minimum value is 1, expected value is an integer.
      *
@@ -49,6 +56,49 @@ public function language($language)
         return $this;
     }
 
+    /**
+     * An ISO 3166-1 code. Combine this filter with with_watch_providers in order to filter your results by a specific watch provider in a specific region.
+     *
+     * @param string $watchRegion
+     * @return $this
+     */
+    public function watchRegion($watchRegion)
+    {
+        $this->set('watch_region', $watchRegion);
+
+        return $this;
+    }
+
+    /**
+     * Only include movies with the specified watch providers. Combine with watch_region.
+     *
+     * @param array|string $watchProviders
+     * @param int $mode
+     * @return $this
+     */
+    public function withWatchProviders($watchProviders, $mode = self::MODE_OR)
+    {
+        $this->set('with_watch_providers', $this->with($watchProviders, $mode));
+
+        return $this;
+    }
+
+    /**
+     * Only include movies with the specified monetization types. Combine with watch_region.
+     *
+     * Allowed Values: flatrate, free, ads, rent, buy
+     *
+     * @param array|string $watchProviders
+     * @param int $mode
+     * @return $this
+     */
+    public function withWatchMonetizationTypes($watchProviders, $mode = self::MODE_OR)
+    {
+        $this->set('with_watch_monetization_types', $this->with($watchProviders, $mode));
+
+        return $this;
+    }
+
     /**
      * Available options are vote_average.desc, vote_average.asc, first_air_date.desc,
      * first_air_date.asc, popularity.desc, popularity.asc
@@ -109,6 +159,44 @@ public function voteAverageGte($average)
         return $this;
     }
 
+    /**
+     * Format the with compatible parameters.
+     *
+     * @param array|string $with
+     * @param int $mode
+     *
+     * @return null|string
+     */
+    protected function with($with = null, $mode = self::MODE_OR): ?string
+    {
+        if ($with instanceof GenericCollection) {
+            $with = $with->toArray();
+        }
+
+        if (is_array($with)) {
+            return $this->andWith((array)$with, $mode);
+        }
+
+        return $with;
+    }
+
+    /**
+     * Creates an and query to combine an AND or an OR expression.
+     *
+     * @param array $with
+     * @param int $mode
+     * @return string
+     */
+    protected function andWith(array $with, $mode)
+    {
+        return (
+        implode(
+            $mode === self::MODE_OR ? '|' : ',',
+            array_map([$this, 'normalize'], $with)
+        )
+        );
+    }
+
     /**
      * Creates an OR query for genres
      *
@@ -227,4 +315,19 @@ public function withNetworksAnd(array $networks = [])
             implode(',', $networks)
         );
     }
+
+    /**
+     * Extract object id's if an collection was passed on.
+     *
+     * @param $mixed
+     * @return mixed
+     */
+    protected function normalize($mixed)
+    {
+        if (is_object($mixed) && $mixed instanceof AbstractModel) {
+            return $mixed->getId();
+        }
+
+        return $mixed;
+    }
 }