justwatch_client 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbb06db4709d3bd4f3daec9ca5713657f72faecce2439fe5c83cecf4875eb437
-  data.tar.gz: af20dd04cf13a70e6a3efb7a9dd4b475f2dd03f31c660f8808c60dbb53c004f2
+  metadata.gz: 934c78534a6360e729b7fb12a2e308b22c1ca18fcecbf8de2f4ce41d7e78671d
+  data.tar.gz: d24e44e8f24fd081aff16bf901e6741ad40060e3ba0b077c0c43f42a2cd68659
 SHA512:
-  metadata.gz: 54fd59e941499fb630d73960f9a3936104090f3f8dcc72b8872abe9ef519cc50daa9ee8077129a767deb36b21d69a809c421140aecf124e452783666f264eb85
-  data.tar.gz: 8b4c816c82bb9350bb6d18cd644aa6627d62619d32983ddb2ee4876c16a382cca79f193aa5fc3548255ced7c9f091935ce62d6adebe13f0056abe7a4e9cc840a
+  metadata.gz: adc769c12fb41be5e86d8019db486bc9ccca128a64388ab9f6aaa67989f3f729c3d4c083836f81bc610e19ff06e0b8e84c467d19667d8b5b0e7a739f562526d1
+  data.tar.gz: 0bc7080912a836b3f9674484aede00ccf28aaa2694c26d1f45e6ada381fcc8f5c977065342482a0b0440fcafab0c206536e7e93c4c1372a18a418dfecf56f4b8

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.3.0]
+
+### Changed
+
+- **Breaking:** Ruby 3.3 is now the minimum supported version (was 2.7).
+- **Breaking:** Faraday is now required at `~> 2.0` (was `>= 1, < 3`). Faraday 1 is
+  end-of-life, and the JSON middleware this gem relies on only reached Faraday core
+  in 1.10, so the old constraint advertised support that never worked in practice.
+- `JustWatch::Api.request` no longer mutates the `params` hash it is given; the API
+  token is merged into a copy.
+- Development dependencies updated: RuboCop `~> 1.90`, WebMock `~> 3.26`,
+  debug `~> 1.11`. Added Rake `~> 13.4` and a `Rakefile` with a default
+  `spec` + `rubocop` task.
+- CI now tests against Ruby 3.3, 3.4 and 4.0; the end-of-life 3.1 and 3.2 entries
+  were removed.
+- The gemspec builds its file list from a `Dir` glob instead of shelling out to
+  `git ls-files`, and now declares `rubygems_mfa_required` along with the usual
+  source, changelog and bug tracker metadata.
+
+### Internal
+
+- The private `COUNTRY_PATH`, `GENRE_PATH` and `PROVIDER_PATH` constants (which were
+  defined on the singleton class and therefore unreachable as
+  `JustWatch::Genre::GENRE_PATH`) are now private class methods, matching the path
+  helpers already used by `JustWatch::Content`.
+
+## [0.2.0]
+
+- Initial documented release.

data/README.md

@@ -1,2 +1,163 @@
-# justwatch
+# Justwatch client
+
 Ruby Client for JustWatch API
+
+Requires Ruby >= 3.3.
+
+## Installation
+
+Add it to your `Gemfile`:
+
+```ruby
+gem 'justwatch_client'
+```
+
+Then run `bundle install`. Or install it directly:
+
+```
+gem install justwatch_client
+```
+
+## How to configure
+
+If you are using Rails, the better way is to define an initializer in `config/initializers`, defining the default locale and the token (we encourage to not push the token to the repo).
+
+```
+# config/initializers/justwatch.rb
+
+JustWatch::Api.locale = 'es_ES'
+JustWatch::Api.token = ENV.fetch('JUSTWATCH_API_TOKEN', nil)
+```
+
+The locale defined here is the **default**, you can override it in the different calls.
+
+## General Provider Info
+
+We can fetch the data for providers with the following call:
+
+```
+JustWatch::Provider.list(locale:)
+```
+
+| Parameter | Explanation | Example values |
+| --- | --- | --- |
+| `locale` (optional) | Locale you are searching for | `es_ES`, `en_US` |
+
+
+## Genres list
+
+We can fetch the genre list with the following call:
+
+```
+JustWatch::Genre.list(locale:)
+```
+
+| Parameter | Explanation | Example values |
+| --- | --- | --- |
+| `locale` (optional) | Locale you are searching for | `es_ES`, `en_US` |
+
+
+## Country list
+
+We can fetch the country list with the following call:
+
+```
+JustWatch::Country.list(locale:)
+```
+
+| Parameter | Explanation | Example values |
+| --- | --- | --- |
+| `locale` (optional) | Locale you are searching for | `es_ES`, `en_US` |
+
+
+## Movie offers by ID
+
+We can fetch the data for a movie using a service ID with the following call:
+
+```
+JustWatch::Movie.offers_by_id(id:, service_id_type:, locale:)
+```
+
+| Parameter | Explanation | Example values |
+| --- | --- | --- |
+| `id` | TMDB, IMDB or Justwatch ID | `12345`, `tt0125439`, `39130` |
+| `service_id_type` | Service for which the ID has been provided | `tmdb`, `imdb` or `justwatch` |
+| `locale` (optional) | Locale you are searching for | `es_ES`, `en_US` |
+
+
+## Movie offers by title and year
+
+We can fetch the data for a movie using title and year with the following call:
+
+```
+JustWatch::Movie.offers_by_title_and_year(title:, year:, locale: Api.locale)
+```
+
+| Parameter | Explanation | Example values |
+| --- | --- | --- |
+| `title` | Movie title | `12 monkeys`, `The Shining` |
+| `year` | Movie release year | `1999`, `2021` |
+| `locale` (optional) | Locale you are searching for | `es_ES`, `en_US` |
+
+## TvShow offers by ID
+
+We can fetch the data for a tv show using a service ID with the following call: 
+
+```
+JustWatch::TvShow.offers_by_id(id:, service_id_type:, locale:)
+```
+
+| Parameter | Explanation | Example values |
+| --- | --- | --- |
+| `id` | TMDB, IMDB or Justwatch ID | `12345`, `tt0125439`, `39130` |
+| `service_id_type` | Service for which the ID has been provided | `tmdb`, `imdb` or `justwatch` |
+| `locale` (optional) | Locale you are searching for | `es_ES`, `en_US` |
+
+## TvShow offers by title and year
+
+We can fetch the data for a tv show using the tv show title and the year with the following call: 
+
+```
+JustWatch::TvShow.offers_by_title_and_year(title:, year:, locale:)
+```
+
+| Parameter | Explanation | Example values |
+| --- | --- | --- |
+| `title` | Tv show title | `House`, `Lost` |
+| `year` | Tv show release year | `2004`, `2021` |
+| `locale` (optional) | Locale you are searching for | `es_ES`, `en_US` |
+
+## Season offers by id and season number
+
+We can fetch the data for a season using the tv show ID and the season number with the following call:
+
+```
+JustWatch::Season.offers_by_id_and_season_number(id:, service_id_type:, season_number:, locale:)
+```
+
+| Parameter | Explanation | Example values |
+| --- | --- | --- |
+| `id` | TMDB, IMDB or Justwatch **tv show** ID | `12345`, `tt0125439`, `39130` |
+| `service_id_type` | Service for which the ID has been provided | `tmdb`, `imdb` or `justwatch` |
+| `locale` (optional) | Locale you are searching for | `es_ES`, `en_US` |
+
+## Season offers by title, year and season number
+
+We can fetch the data for a season using the tv show tv show title, year and season number with the following call:
+
+```
+JustWatch::Season::offers_by_title_year_and_season_number(title:, year:, season_number:, locale:)
+```
+
+| Parameter | Explanation | Example values |
+| --- | --- | --- |
+| `title` | Tv show title | `House`, `Lost` |
+| `year` | Tv show release year | `2004`, `2021` |
+| `season_number` | Tv show season number | `1`, `2` |
+| `locale` (optional) | Locale you are searching for | `es_ES`, `en_US` |
+
+## Troubleshoot
+
+### Locale
+
+Your JustWatch account is restricted to a bunch of locales. If you are getting Unauthorized errors this could be the reason. 

data/lib/just_watch/api.rb

@@ -15,7 +15,7 @@ module JustWatch
       end
 
       def request(path, params = {})
-        connection.get([API_VERSION_URL, path].join, params.merge!(token: token)).body
+        connection.get([API_VERSION_URL, path].join, params.merge(token: token)).body
       rescue Faraday::ResourceNotFound
         raise JustWatch::NotFoundError
       rescue Faraday::UnauthorizedError

data/lib/just_watch/country.rb

@@ -3,15 +3,19 @@
 module JustWatch
   Country = Struct.new(:url_part, :full_locale, :status, :country, :currency, keyword_init: true) do
     class << self
-      COUNTRY_PATH = '/countries'
-
       def list
-        countries = Api.request(COUNTRY_PATH)
+        countries = Api.request(countries_path)
 
         countries.map do |country|
           new(country.slice(*members))
         end
       end
+
+      private
+
+      def countries_path
+        '/countries'
+      end
     end
   end
 end

data/lib/just_watch/genre.rb

@@ -3,15 +3,19 @@
 module JustWatch
   Genre = Struct.new(:id, :translation, :short_name, :technical_name, keyword_init: true) do
     class << self
-      GENRE_PATH = '/genres/all/locale'
-
       def list(locale: Api.locale)
-        genres = Api.request([GENRE_PATH, locale].join('/'))
+        genres = Api.request(genres_path(locale))
 
         genres.map do |genre|
           new(genre.slice(*members))
         end
       end
+
+      private
+
+      def genres_path(locale)
+        "/genres/all/locale/#{locale}"
+      end
     end
   end
 end

data/lib/just_watch/provider.rb

@@ -4,15 +4,19 @@ module JustWatch
   Provider = Struct.new(:id, :technical_name, :short_name, :clear_name, :monetization_types, :icon_url, :slug,
                         keyword_init: true) do
     class << self
-      PROVIDER_PATH = '/providers/all/locale'
-
       def list(locale: Api.locale)
-        providers = Api.request([PROVIDER_PATH, locale].join('/'))
+        providers = Api.request(providers_path(locale))
 
         providers.map do |provider|
           new(provider.slice(*members))
         end
       end
+
+      private
+
+      def providers_path(locale)
+        "/providers/all/locale/#{locale}"
+      end
     end
   end
 end

data/lib/just_watch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JustWatch
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: justwatch_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alejandro Perea
 - Josep Casanovas
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -17,70 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.11'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.36'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.36'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.18'
+        version: '2.0'
 description: Ruby API Client for JustWatch.
 email:
 - alejandro.perea.fdez@gmail.com
@@ -89,6 +32,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/just_watch.rb
@@ -107,8 +51,12 @@ files:
 homepage: https://github.com/cineol-gems/justwatch-client
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/cineol-gems/justwatch-client
+  source_code_uri: https://github.com/cineol-gems/justwatch-client
+  changelog_uri: https://github.com/cineol-gems/justwatch-client/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/cineol-gems/justwatch-client/issues
+  rubygems_mfa_required: 'true'
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -117,15 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby API Client for JustWatch
 test_files: []