tvdb_party_v2 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f9c718ce38af6c092f521077676b680edb594856
-  data.tar.gz: 1cd8852e202b6e7ebec6afd4d13b27c6e53652d7
+SHA256:
+  metadata.gz: 7fa7d3d9796bb041f8623ddad6f372f4cfdbd46b743d1d54d1fb88e89a58c412
+  data.tar.gz: 60270c0b7c6a3e835833ceb0adf77cea4acfd7fb5cffc1d2526d96ced0233c9d
 SHA512:
-  metadata.gz: 7c568cdeeead6b1eb2349e34e1ad472e7f5b90850a9c486b58ae7902eace70628cafd46c72396ab04ea04cd5f39319c5951826b4a8d24d54c7e798908ce55b60
-  data.tar.gz: 58fea0ec4dfe93a1bf6a7e8bac944a8d89878aed0dcca29bcaac1a93f0e76e9a4afc9806622d3321b67d3b7343fbd463f3f8307919a3d63aa685a29442f01d82
+  metadata.gz: 1507bef194bedb6d6d429cf1257b65c0356aea15572ff9e08d2cd05492749608ec0d45598784b9bdd22e181dc07eee34140fb7a1325a11198cb28bdb2fe713be
+  data.tar.gz: dddeb93d3e82a740758b073fc4b239809dbc0425ba313410c0cd0623baeabf67215719f2aae0e115d23379eef6fc013e9be13410ada4dc1158dde86fb3cb0497

data/.gitignore

@@ -7,3 +7,10 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+# Markdown docs
+*.md
+!README.md
+
+# Credentials
+.env*

data/Gemfile.lock

@@ -1,26 +1,49 @@
 PATH
   remote: .
   specs:
-    tvdb_party_v2 (0.1.6)
+    tvdb_party_v2 (0.2.0)
+      httparty (~> 0.24)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    httparty (0.16.2)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    bigdecimal (4.1.3)
+    crack (1.0.1)
+      bigdecimal
+      rexml
+    csv (3.3.6)
+    drb (2.2.3)
+    hashdiff (1.2.1)
+    httparty (0.24.2)
+      csv
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    minitest (5.11.3)
+    mini_mime (1.1.2)
+    minitest (6.0.6)
+      drb (~> 2.0)
+      prism (~> 1.5)
     multi_xml (0.6.0)
-    rake (10.5.0)
+    prism (1.9.0)
+    public_suffix (7.0.5)
+    rake (13.4.2)
+    rexml (3.4.4)
+    webmock (3.26.4)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (>= 2.0)
   httparty
   minitest
-  rake (~> 10.0)
+  rake (~> 13.0)
   tvdb_party_v2!
+  webmock (~> 3.0)
 
 BUNDLED WITH
-   1.16.1
+  4.0.21

data/README.md

@@ -1,13 +1,15 @@
 # TvdbPartyV2
 
-[![Gem Version](https://badge.fury.io/rb/tvdb_party_v2.svg)](https://badge.fury.io/rb/tvdb_party_v2) [![Dependency Status](https://beta.gemnasium.com/badges/github.com/davidpan/tvdb_party_v2.svg)](https://beta.gemnasium.com/projects/github.com/davidpan/tvdb_party_v2)
+[![Gem Version](https://badge.fury.io/rb/tvdb_party_v2.svg)](https://badge.fury.io/rb/tvdb_party_v2)
 
-Simple Ruby library to talk to thetvdb.com API v2
+Simple Ruby library to talk to thetvdb.com API v4. Migrated from the deprecated v2 API (the gem name is kept for continuity). Requires Ruby >= 3.0; tested on Ruby 3.4 and 4.0.
 
 # what is thetvdb.com?
 
 This site is an open tvshow database that can be modified by anybody.
-thetvdb.com api v2.1.2 (https://api.thetvdb.com/swagger)
+thetvdb.com api v4 (https://api4.thetvdb.com/v4, docs: https://thetvdb.github.io/v4-api/)
+
+> The legacy v2 API (api.thetvdb.com) has been decommissioned. v4 requires an API key; personal keys also require an active TheTVDB subscription PIN.
 
 ## Installation
 
@@ -29,8 +31,9 @@ Or install it yourself as:
 
 
 ```ruby
-# connect api
-@thetvdb = TvdbPartyV2::Search.new(apikey,username,userkey)
+# connect api — v4 auth: apikey + optional pin (subscriber keys only)
+@thetvdb = TvdbPartyV2::Search.new(apikey)
+@thetvdb = TvdbPartyV2::Search.new(apikey, pin, 'en')
 
 # search tv show
 r = @thetvdb.search("Homeland")
@@ -41,21 +44,24 @@ puts homeland = @thetvdb.get_series_by_id(r.first["id"])
 # get episode
 puts s01e01 = homeland.episode(1,1)
 
-#get series fanart – pass in your language
-puts homeland.fanart.first.url
-=> "https://www.thetvdb.com/banners/fanart/original/247897-18.jpg"
+# get series fanart (banner URLs are built as https://www.thetvdb.com/banners/ + the artwork path)
+homeland.fanart.first.url
+
+# get series posters
+homeland.posters.first.url
+
+# get series banners
+homeland.series_banners.first.url
 
-#get series posters
-puts homeland.posters.first.url
-=> "https://www.thetvdb.com/banners/seasons/247897-1.jpg"
+# get season posters (filtered by season number)
+homeland.season_posters(2).first.url
 
-#get series banners
-puts homeland.series_banners.first.url
-=> "https://www.thetvdb.com/banners/graphical/247897-g.jpg"
+# v4 new: movies (v4-only entity)
+movies = @thetvdb.movies
+movie = @thetvdb.get_movie_by_id(12345)
 
-#get season posters
-puts homeland.season_posters(2).first.url
-=> "https://www.thetvdb.com/banners/seasons/247897-2.jpg"
+# v4 new: season detail with episodes
+season = @thetvdb.get_season_by_id(46249)
 
 ```
 
@@ -75,11 +81,11 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the TvdbPartyV2 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tvdb_party_v2/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the TvdbPartyV2 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/davidpan/tvdb_party_v2/blob/master/CODE_OF_CONDUCT.md).
 
 ## Thanks
 
 Project Derived from maddox/tvdb_party.
 
-Thanks to thetvdb.com for their awesome database allowing us to meta out to our hearts consent.
+Thanks to thetvdb.com for their awesome database allowing us to meta out to our heart's content.
 Project name graciously stolen from jduff/tmdb_party.

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require 'bundler/gem_tasks'
 
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
 end
 
 desc "Run tests"

data/lib/tvdb_party_v2/actor.rb

@@ -2,17 +2,18 @@ module TvdbPartyV2
   class Actor
     attr_accessor :id, :name, :role, :image, :sortorder
 
+    # v4 actor info comes from the series extended record's characters
     def initialize(options = {})
-      @id = options["id"]
-      @name = options["name"]
-      @role = options["role"] if options["role"]
-      @image = options["image"] if options["image"]
-      @sortorder = options["sortOrder"] if options["sortOrder"]
+      @id = options["peopleId"] || options["id"]
+      @name = options["personName"]
+      @role = options["name"] if options["name"]
+      @image = options["personImgURL"] if options["personImgURL"]
+      @sortorder = options["sort"] if options["sort"]
     end
 
     def image_url
       return nil unless @image
-      "http://www.thetvdb.com/banners/" + @image
+      @image.start_with?('http') ? @image : "https://www.thetvdb.com/banners/" + @image
     end
 
   end

data/lib/tvdb_party_v2/banner.rb

@@ -1,33 +1,39 @@
 module TvdbPartyV2
   class Banner
-    attr_accessor :banner_type, :banner_resolution, :subkey, :path, :thumbnail_path, :ratingaverage, :ratingcount
+    attr_accessor :banner_type, :banner_resolution, :subkey, :path, :thumbnail_path, :ratingaverage, :ratingcount, :season_id
 
+    # v4 artwork record: image/thumbnail are paths, type is an integer type id
     def initialize(options = {})
-      @banner_type = options["keyType"]
-      @banner_resolution = options["resolution"]
-      @subkey = options["subKey"]
-      @path = options["fileName"]
+      @banner_type = options["type"]
+      @banner_resolution = options["width"] && options["height"] ? "#{options["width"]}x#{options["height"]}" : nil
+      @path = options["image"]
+      @thumbnail_path = options["thumbnail"]
+      @season_id = options["seasonId"]
 
-      if options["ratingsInfo"]["average"] && options["ratingsInfo"]["average"] > 0
-        @ratingaverage = options["ratingsInfo"]["average"].to_f
+      if options["score"] && options["score"] > 0
+        @ratingaverage = options["score"].to_f
       else
         @ratingaverage = 0
       end
 
-      if options["ratingsInfo"]["count"] && options["ratingsInfo"]["count"] > 0
-        @ratingcount = options["ratingsInfo"]["count"]
-      else
-        @ratingcount = 0
-      end
-
+      @ratingcount = 0 # v4 no longer provides rating counts
     end
 
     def url
-      "https://www.thetvdb.com/banners/" + @path
+      banner_path_url(@path)
     end
 
     def thumb_url
-      "https://www.thetvdb.com/banners/_cache/" + @path
+      banner_path_url(@thumbnail_path, cache: true)
+    end
+
+    private
+
+    def banner_path_url(path, cache: false)
+      return nil unless path
+      return path if path.start_with?('http')
+      path = "_cache/#{path}" if cache && !path.start_with?('_cache/')
+      "https://www.thetvdb.com/banners/" + path
     end
 
   end

data/lib/tvdb_party_v2/episode.rb

@@ -7,49 +7,58 @@ module TvdbPartyV2
     def initialize(client, options = {})
       @client = client
       @id = options["id"]
-      @season_number = options["airedSeason"]
-      @number = options["airedEpisodeNumber"]
-      @name = options["episodeName"]
+      @season_number = options["seasonNumber"]
+      @number = options["number"]
+      @name = options["name"]
       @overview = options["overview"]
-      @director = options["directors"]
-      @writer = options["writers"]
       @series_id = options["seriesId"]
-      @season_id = options["airedSeasonID"]
-      @imdb_id = options["imdbId"]
-      if options["guestStars"]
-        @guest_stars = options["guestStars"]
-      else
-        @guest_stars = []
-      end
+      @season_id = season_id_from(options["seasons"])
+      @imdb_id = RemoteId.imdb_from(options["remoteIds"])
+      @guest_stars = guest_stars_from(options["characters"])
 
-      if options["filename"].nil? || options["filename"].empty?
+      if options["image"].nil? || options["image"].empty?
         @thumb = nil
       else
-        @thumb = "http://www.thetvdb.com/banners/" + options["filename"]
+        @thumb = "https://www.thetvdb.com/banners/" + options["image"]
       end
 
+      # v4 episode records no longer provide director/writer string arrays
+      @director = nil
+      @writer = nil
+
       begin
-        @air_date = Time.parse(options["firstAired"]).to_i
-      rescue
+        @air_date = Time.parse(options["aired"].to_s).to_i
+      rescue StandardError
         @air_date = 0
       end
 
-      if options["siteRating"] && options["siteRating"] > 0
-        @rating = options["siteRating"].to_f
+      if options["score"] && options["score"] > 0
+        @rating = options["score"].to_f
       else
         @rating = 0
       end
 
-      if options["siteRatingCount"] && options["siteRatingCount"] > 0
-        @ratingcount = options["siteRatingCount"]
-      else
-        @ratingcount = 0
-      end
-
+      @ratingcount = 0 # v4 no longer provides rating counts
     end
 
     def series
-      client.get_series_by_id(@series.id)
+      client.get_series_by_id(@series_id)
+    end
+
+    private
+
+    def season_id_from(seasons)
+      first = Array(seasons).first
+      first.is_a?(Hash) ? first["id"] : first
+    end
+
+    def guest_stars_from(characters)
+      Array(characters).select do |c|
+        next false unless c.is_a?(Hash)
+        type = c["peopleType"]
+        type = type["name"] if type.is_a?(Hash)
+        type.to_s =~ /guest/i
+      end.map { |c| c["personName"] }
     end
   end
 

data/lib/tvdb_party_v2/movie.rb

@@ -0,0 +1,42 @@
+module TvdbPartyV2
+
+  class Movie
+    attr_reader :client, :raw
+    attr_accessor :id, :name, :overview, :status, :runtime, :year, :genres, :image, :imdb_id, :rating, :first_release
+
+    def initialize(client, options = {})
+      @client = client
+      @raw = options || {}
+      @id = options["id"]
+      @name = options["name"]
+      @overview = options["overview"]
+      @status = status_name(options["status"])
+      @runtime = options["runtime"]
+      @year = options["year"]
+      @image = options["image"]
+      @imdb_id = RemoteId.imdb_from(options["remoteIds"])
+      @genres = Array(options["genres"]).map { |g| g.is_a?(Hash) ? g["name"] : g }
+
+      if options["score"] && options["score"] > 0
+        @rating = options["score"].to_f
+      else
+        @rating = 0
+      end
+
+      release = options["first_release"]
+      begin
+        @first_release = Time.parse(release.is_a?(Hash) ? release["date"].to_s : release.to_s).to_i
+      rescue StandardError
+        @first_release = 0
+      end
+    end
+
+    private
+
+    def status_name(status)
+      return nil unless status
+      status.is_a?(Hash) ? status["name"] : status
+    end
+  end
+
+end

data/lib/tvdb_party_v2/remote_id.rb

@@ -0,0 +1,22 @@
+module TvdbPartyV2
+  # v4 remote id helpers: imdb id <-> remote_id conversion
+  module RemoteId
+    module_function
+
+    # Extract the imdb id (e.g. "tt1796960") from a remoteIds array
+    def imdb_from(remote_ids)
+      Array(remote_ids).each do |r|
+        next unless r.is_a?(Hash)
+        return r["id"] if r["sourceName"].to_s.casecmp?("imdb") || r["id"].to_s.start_with?("tt")
+      end
+      nil
+    end
+
+    # Convert an imdb id to the v4 remote_id query format (e.g. "imdb-tt1796960")
+    def for_imdb(imdb_id)
+      id = imdb_id.to_s
+      return id if id =~ /\Aimdb-/i
+      id.start_with?('tt') ? "imdb-#{id}" : "imdb-tt#{id}"
+    end
+  end
+end

data/lib/tvdb_party_v2/search.rb

@@ -1,132 +1,170 @@
 module TvdbPartyV2
 
+  # Raised when the v4 login is rejected (bad apikey/pin or inactive key)
+  class LoginError < StandardError; end
+
   class Search
     include HTTParty
-    base_uri 'https://api.thetvdb.com'
+    base_uri 'https://api4.thetvdb.com/v4'
     headers "Content-Type" => "application/json"
     attr_accessor :token, :language
 
-    def initialize(apikey, username, userkey, language = 'en', cache_options = {})
+    # v4 auth: apikey required, subscribers may pass a pin; v2's username/userkey are gone
+    def initialize(apikey, pin = nil, language = 'en')
       @language = language
-      thetvdb = self.class.post('/login',
-                                :body => {"apikey" => apikey,
-                                          "username" => username,
-                                          "userkey" => userkey}.to_json)
-      @token = thetvdb['token']
-    end
-
-    #基于电视剧英文名称获取thetvdb的查询结果
-    def search(series_name)
-      response = self.get("/search/series?name=#{URI::encode(series_name)}")
-      return [] unless response["data"]
-      case response["data"]
-      when Array
-        response["data"]
-      when Hash
-        [response["data"]]
-      else
-        []
+      body = { "apikey" => apikey }
+      body["pin"] = pin unless pin.nil? || pin.to_s.empty?
+      response = self.class.post('/login', :body => body.to_json)
+      @token = response.dig('data', 'token')
+      if @token.nil?
+        status = response.response&.code
+        raise LoginError, "TheTVDB login failed (HTTP #{status}): #{response.parsed_response.to_s[0, 200]}"
       end
     end
 
-    #基于imdbid获取thetvdb的查询结果
+    # Search series (or movies via type: 'movie') by name
+    def search(series_name, type = 'series')
+      response = self.get("/search?query=#{URI.encode_www_form_component(series_name)}&type=#{type}")
+      normalize_results(response)
+    end
+
+    # Search series by imdb id (remote_id looks like imdb-tt1796960)
     def search_by_imdb(imdb_id)
-      response = self.get("/search/series?imdbId=#{imdb_id}")
-      return [] unless response["data"]
+      response = self.get("/search?remote_id=#{RemoteId.for_imdb(imdb_id)}&type=series")
+      normalize_results(response)
+    end
 
-      case response["data"]
-      when Array
-        response["data"]
-      when Hash
-        [response["data"]]
-      else
-        []
-      end
+    # Search movies by name
+    def search_movies(movie_name)
+      search(movie_name, 'movie')
     end
 
-    #基于电视剧id获取电视剧详细信息
+    # Get series details by series id
     def get_series_by_id(series_id, language = self.language)
-      response = self.get("/series/#{series_id.to_s}")
-      if response["data"]
-        Series.new(self, response["data"])
-      else
-        nil
-      end
+      fetch_entity("/series/#{series_id}/extended", Series)
     end
 
-    #基于电视剧集id获取每集的详细信息
+    # Get episode details by episode id
     def get_episode_by_id(episode_id, language = self.language)
-      response = self.get("/episodes/#{episode_id.to_s}")
-      if response["data"]
-        Episode.new(self, response["data"])
-      else
-        nil
-      end
+      fetch_entity("/episodes/#{episode_id}/extended", Episode)
     end
 
-    #基于季数、集数获取集的详细信息
-    def get_episode(series, season_number, episode_number = nil,  page_id = nil)
-      if episode_number
-        url = "/series/#{series.id}/episodes/query?airedSeason=#{season_number}&airedEpisode=#{episode_number}"
-      else
-        url = "/series/#{series.id}/episodes/query?airedSeason=#{season_number}"
-      end
-      url = url + "&page=#{page_id}" unless page_id.nil?
+    # Get movie details by movie id
+    def get_movie_by_id(movie_id)
+      fetch_entity("/movies/#{movie_id}/extended", Movie)
+    end
 
-      response = self.get(url)
-      return [] unless response["data"]
-      data = []
-      if response['links']['next'].nil?
-        data = response["data"]
-      else
-        response["data"].each {|x| data << x}
-        get_episode(series, season_number, episode_number, response['links']['next'])
-      end
-      data.map {|e| self.get_episode_by_id(e["id"])}
+    # Get season details (with episodes) by season id
+    def get_season_by_id(season_id)
+      fetch_entity("/seasons/#{season_id}/extended", Season)
     end
 
+    # Get episodes of a season/episode number (season_type: default/official/alternate/regional)
+    def get_episode(series, season_number, episode_number = nil, page = nil, season_type = 'default')
+      episodes = []
+      loop do
+        url = "/series/#{series.id}/episodes/#{season_type}?season=#{season_number}"
+        url = url + "&episodeNumber=#{episode_number}" if episode_number
+        url = url + "&page=#{page}" unless page.nil?
 
+        response = self.get(url)
+        data = response.dig('data', 'episodes') || []
+        episodes.concat(data)
 
-    def get_actors(series)
-      response = self.get("/series/#{series.id}/actors")
-      if response["data"]
-        response["data"].collect {|a| Actor.new(a)}
-      else
-        nil
+        next_page = response.dig('links', 'next')
+        break if next_page.nil? || next_page == false || next_page.to_s.empty? || data.empty?
+        page = next_page
       end
+      episodes.map { |e| self.get_episode_by_id(e["id"]) }
+    end
+
+    # Get actors (v4 returns them in the series extended record's characters)
+    def get_actors(series)
+      characters = series_data(series)["characters"]
+      return [] unless characters.is_a?(Array)
+      characters.collect { |c| Actor.new(c) }
     end
 
-    # 获取季数
+    # Get season numbers
     def get_seasons(series)
-      response = self.get("/series/#{series.id}/episodes/summary")
-      if response["data"] && response["data"]["airedSeasons"]
-        return response["data"]["airedSeasons"]
-      else
-        return []
-      end
+      seasons = series_data(series)["seasons"]
+      return [] unless seasons.is_a?(Array)
+      seasons.map { |s| s.is_a?(Hash) ? s["number"] : s }
     end
 
+    # Get posters/banners etc. (v4 uses /series/{id}/artworks with integer type ids)
     def get_banners(series, keyType, subKey = nil)
-      if subKey
-        url = "/series/#{series.id}/images/query?keyType=#{keyType}&subKey=#{subKey}"
-      else
-        url = "/series/#{series.id}/images/query?keyType=#{keyType}"
+      url = "/series/#{series.id}/artworks"
+      type_id = ARTWORK_TYPES[keyType.to_s.downcase]
+      url = url + "?type=#{type_id}" if type_id
+
+      response = self.get(url)
+      data = response && response["data"]
+      return [] unless data
+
+      season_numbers = {}
+      Array(data["seasons"]).each do |s|
+        season_numbers[s["id"]] = s["number"] if s.is_a?(Hash)
+      end
+
+      artworks = data["artworks"].is_a?(Array) ? data["artworks"] : []
+      banners = artworks.map { |result| Banner.new(result) }
+      banners.each do |b|
+        b.subkey = season_numbers[b.season_id].to_s if b.season_id && season_numbers.key?(b.season_id)
       end
+      banners = banners.select { |b| b.subkey == subKey.to_s } unless subKey.nil?
+      banners
+    end
+
+    # List movies (movies are a v4-only entity)
+    def movies(page = nil)
+      url = "/movies"
+      url = url + "?page=#{page}" unless page.nil?
       response = self.get(url)
-      return [] unless response["data"]
-      case response["data"]
+      data = response && response["data"]
+      return [] unless data.is_a?(Array)
+      data.map { |result| Movie.new(self, result) }
+    end
+
+    def get(url)
+      return self.class.get(url,
+                     :headers => {"Authorization" => 'Bearer ' + @token,"Accept-Language" => self.language}).parsed_response
+    end
+
+    private
+
+    # v4 classic artwork type ids (full list at /artwork/types)
+    ARTWORK_TYPES = {
+      'series' => 1,
+      'poster' => 2,
+      'fanart' => 3,
+      'season' => 6,
+      'seasonwide' => 7
+    }.freeze
+
+    def normalize_results(response)
+      data = response && response["data"]
+      return [] unless data
+      case data
       when Array
-        response["data"].map {|result| Banner.new(result)}
+        data
       when Hash
-        [Banner.new(response["data"])]
+        [data]
       else
         []
       end
     end
 
-    def get(url)
-      return self.class.get(url,
-                     :headers => {"Authorization" => 'Bearer ' + @token,"Accept-Language" => self.language}).parsed_response
+    def fetch_entity(path, klass)
+      response = self.get(path)
+      response && response["data"] ? klass.new(self, response["data"]) : nil
+    end
+
+    def series_data(series)
+      raw = series.raw if series.respond_to?(:raw)
+      return raw if raw.is_a?(Hash) && !raw.empty?
+      response = self.get("/series/#{series.id}/extended")
+      (response && response["data"]) || {}
     end
   end
 end

data/lib/tvdb_party_v2/season.rb

@@ -0,0 +1,26 @@
+module TvdbPartyV2
+
+  class Season
+    attr_reader :client, :raw
+    attr_accessor :id, :number, :name, :series_id, :image, :year
+
+    def initialize(client, options = {})
+      @client = client
+      @raw = options || {}
+      @id = options["id"]
+      @number = options["number"]
+      @name = options["name"]
+      @series_id = options["seriesId"]
+      @image = options["image"]
+      @year = options["year"]
+    end
+
+    # Episodes in this season (v4 returns them in the season extended record)
+    def episodes
+      eps = @raw["episodes"]
+      return [] unless eps.is_a?(Array)
+      eps.map { |e| Episode.new(client, e) }
+    end
+  end
+
+end

data/lib/tvdb_party_v2/series.rb

@@ -1,43 +1,36 @@
 module TvdbPartyV2
 
   class Series
-    attr_reader :client
-    attr_accessor :id, :name, :overview, :seasons, :first_aired, :genres, :network, :rating, :runtime,
-                  :actors, :banners, :air_time, :imdb_id, :ratingcount, :status, :airs_dayofweek
+    attr_reader :client, :raw
+    attr_accessor :id, :name, :overview, :first_aired, :genres, :network, :rating, :runtime,
+                  :banners, :air_time, :imdb_id, :ratingcount, :status, :airs_dayofweek
 
     def initialize(client, options = {})
       @client = client
+      @raw = options || {}
       @id = options["id"]
-      @name = options["seriesName"]
+      @name = options["name"]
       @overview = options["overview"]
-      @network = options["network"]
-      @runtime = options["runtime"]
+      @network = company_name(options["originalNetwork"])
+      @runtime = options["averageRuntime"]
       @air_time = options['airsTime'] if options['airsTime']
-      @imdb_id = options["imdbId"]
-      @status = options["status"] if options["status"]
-      @airs_dayofweek = options["airsDayOfWeek"]
+      @imdb_id = RemoteId.imdb_from(options["remoteIds"])
+      @status = status_name(options["status"])
+      @airs_dayofweek = options["airsDays"]
 
-      if options["genre"]
-        @genres = options["genre"]
-      else
-        @genres = []
-      end
+      @genres = Array(options["genres"]).map { |g| g.is_a?(Hash) ? g["name"] : g }
 
-      if options["siteRating"] && options["siteRating"] > 0
-        @rating = options["siteRating"].to_f
+      if options["score"] && options["score"] > 0
+        @rating = options["score"].to_f
       else
         @rating = 0
       end
 
-      if options["siteRatingCount"] && options["siteRatingCount"] > 0
-        @ratingcount = options["siteRatingCount"].to_f
-      else
-        @ratingcount = 0
-      end
+      @ratingcount = 0 # v4 no longer provides rating counts
 
       begin
-        @first_aired = Time.parse(options["firstAired"]).to_i
-      rescue
+        @first_aired = Time.parse(options["firstAired"].to_s).to_i
+      rescue StandardError
         @first_aired = 0
       end
     end
@@ -47,23 +40,23 @@ module TvdbPartyV2
     end
 
     def posters
-      @banners_posters ||= client.get_banners(self, 'poster')
+      client.get_banners(self, 'poster')
     end
 
     def fanart
-      @banners_fanarts ||= client.get_banners(self, 'fanart')
+      client.get_banners(self, 'fanart')
     end
 
     def series_banners
-      @banners_series ||= client.get_banners(self, 'series')
+      client.get_banners(self, 'series')
     end
 
     def season_banners
-      @banners_season ||= client.get_banners(self, 'season')
+      client.get_banners(self, 'season')
     end
 
     def seasonwide
-      @banners_seasonwide ||= client.get_banners(self, 'seasonwide')
+      client.get_banners(self, 'seasonwide')
     end
 
     def season_posters(season_number)
@@ -74,20 +67,29 @@ module TvdbPartyV2
       seasonwide.select {|b| b.subkey == season_number.to_s}
     end
 
-
     def seasons
-      @seasons ||= client.get_seasons(self)
+      client.get_seasons(self)
     end
 
-
     def actors
-      @actors ||= client.get_actors(self)
+      client.get_actors(self)
     end
 
     def season(season_number)
-      @season ||= client.get_episode(self, season_number)
+      client.get_episode(self, season_number)
     end
 
+    private
+
+    def company_name(company)
+      return nil unless company
+      company.is_a?(Hash) ? company["name"] : company
+    end
+
+    def status_name(status)
+      return nil unless status
+      status.is_a?(Hash) ? status["name"] : status
+    end
   end
 
 end

data/lib/tvdb_party_v2/version.rb

@@ -1,3 +1,3 @@
 module TvdbPartyV2
-  VERSION = "0.1.7"
+  VERSION = "0.2.0"
 end

data/lib/tvdb_party_v2.rb

@@ -1,8 +1,12 @@
 require "tvdb_party_v2/version"
 require 'rubygems'
+require 'time'
 require 'httparty'
 
 directory = File.expand_path(File.dirname(__FILE__))
+require File.join(directory, 'tvdb_party_v2', 'remote_id')
+require File.join(directory, 'tvdb_party_v2', 'movie')
+require File.join(directory, 'tvdb_party_v2', 'season')
 require File.join(directory, 'tvdb_party_v2', 'search')
 require File.join(directory, 'tvdb_party_v2', 'series')
 require File.join(directory, 'tvdb_party_v2', 'episode')

data/tvdb_party_v2.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["David Pan"]
   spec.email         = ["davidpanchina@gmail.com"]
 
-  spec.summary       = %q{Simple Ruby library to talk to thetvdb.com's v2 API.}
-  spec.description   = %q{Simple Ruby library to talk to thetvdb.com's v2 API.}
+  spec.summary       = %q{Simple Ruby library to talk to thetvdb.com's v4 API.}
+  spec.description   = %q{Simple Ruby library to talk to thetvdb.com's v4 API.}
   spec.homepage      = "https://github.com/davidpan/tvdb_party_v2"
   spec.license       = "MIT"
 
@@ -30,6 +30,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.add_runtime_dependency "httparty", "~> 0.24"
+  spec.add_development_dependency "bundler", ">= 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
 end

metadata

@@ -1,44 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: tvdb_party_v2
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - David Pan
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
 - !ruby/object:Gem::Dependency
   name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: Simple Ruby library to talk to thetvdb.com's v2 API.
+        version: '3.0'
+description: Simple Ruby library to talk to thetvdb.com's v4 API.
 email:
 - davidpanchina@gmail.com
 executables: []
@@ -59,7 +86,10 @@ files:
 - lib/tvdb_party_v2/actor.rb
 - lib/tvdb_party_v2/banner.rb
 - lib/tvdb_party_v2/episode.rb
+- lib/tvdb_party_v2/movie.rb
+- lib/tvdb_party_v2/remote_id.rb
 - lib/tvdb_party_v2/search.rb
+- lib/tvdb_party_v2/season.rb
 - lib/tvdb_party_v2/series.rb
 - lib/tvdb_party_v2/version.rb
 - tvdb_party_v2.gemspec
@@ -68,7 +98,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -76,16 +105,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
-signing_key: 
+rubygems_version: 4.0.21
 specification_version: 4
-summary: Simple Ruby library to talk to thetvdb.com's v2 API.
+summary: Simple Ruby library to talk to thetvdb.com's v4 API.
 test_files: []