tvdb2 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: baf228f33001b998ffe4e51e2f5eb125e82207a9
-  data.tar.gz: ec4b8845798bc1479584c053eb8cf6ab5974fb37
+  metadata.gz: 24469dc02a86ad88f6ea8383a9dced2cff7743d7
+  data.tar.gz: 47bd77a6f6a72891d0f4104a9c2f9b6295ae2681
 SHA512:
-  metadata.gz: 011fa05b1d23010ee94b08900a036f5ee650d36b2d0505ee05a0f38c25947d939f5be036111d740dc99bde64c164d6fb1875e133aa1e36ade391f4523a21cd47
-  data.tar.gz: bd63f54b18a16de2c6deaeabe57ab1971b13566c7b536e2b88dd58ced9ad264ab9705e4638ec5d18f9f0434d52c4cd52389a226d247d5ec7aa7f3c25d6809b5b
+  metadata.gz: 1fc56697b7e19c29835735c0ae75a2ff8a503f8d30c816bf46991d7ba3737cead0b1c96472c10fafe296a15e744122b3a2596deaa62be2c75658cb7a0e6687ff
+  data.tar.gz: cc1c1e3cd58c5dcdb8911a2fe3d833bee8445515cb383ad11eaab6618b43541aa79eb112a1cbb8f2ba87b2fc6f9a172d5a955d40ad8546ff3ca2750f9246d384

data/README.md

@@ -89,13 +89,13 @@ images = got.season_images(season: 2)
 puts images.first.url
 
 # Switch language
+ep = got['3x9']
 client.language = 'it'
-ep = got['3x9'] # retrieve the episodes with the new language
-puts ep.name
+puts ep.name           # print episode title in italian
 client.language = 'en'
+puts ep.name           # print episode title in english
 # or you can swith language only in a block
 client.with_language(:it) do
-  ep = got['3x9']
   puts ep.name
 end
 ```

data/lib/tvdb2/client.rb

@@ -39,7 +39,7 @@ module Tvdb2
     #   https://thetvdb.com/?tab=apiregister). Required.
     # @param [Symbol, String] language the language in which you want get data.
     #   You can change later. Optional. Default is `nil` that is `EN`.
-    def initialize(apikey:, language: nil)
+    def initialize(apikey:, language: 'en')
       @language = language
       response = post('/login', apikey: apikey)
       raise RequestError.new(response) if response.code != 200
@@ -60,12 +60,11 @@ module Tvdb2
     #
     # @example
     #   got = client.best_search('Game of Thrones')
+    #   ep = got['3x9']
     #   client.with_language(:it) do |c|
-    #     ep = got['1x1'] # Get episode data in italian
-    #     puts ep.name    # print the title of episode 1x1 in italian
+    #     puts ep.name # print the title of episode 3x9 in italian
     #   end
-    #   ep = got['1x1']   # Get episode data in default language
-    #   puts ep.name      # print the title of episode 1x1 in english
+    #   puts ep.name   # print the title of episode 3x9 in english
     #
     # @param [Symbol, String] locale the language in which you want get data.
     # @yield block called with the selected language.
@@ -98,12 +97,14 @@ module Tvdb2
     # :nodoc:
     # language param is required to invalidate memoist cache on different language
     def get(path, params = {}, language = @language)
+      puts ">>> GET API REQUEST to '#{path}' with language '#{language}'" if ENV['DEBUG']
       self.class.get(URI.escape(path), headers: build_headers, query: params)
     end
     memoize :get
 
     # :nodoc:
     def post(path, params = {}, language = @language)
+      puts ">>> POST API REQUEST to '#{path}' with language '#{language}'" if ENV['DEBUG']
       self.class.post(URI.escape(path), headers: build_headers, body: params.to_json)
     end
     memoize :post
@@ -147,5 +148,5 @@ module Tvdb2
   end
 end
 
-# Alias of {Client}
+# Alias of {Tvdb2::Client}
 TVDB = Tvdb2::Client

data/lib/tvdb2/episode.rb

@@ -3,60 +3,97 @@ module Tvdb2
   # This class rappresent a series episode retrieved from TVDB api.
   class Episode
 
-    # All episode fields returned from TVDB api.
-    FIELDS = [
-      :absoluteNumber, :airedEpisodeNumber, :airedSeason,
+    # Fields returned from api endpoint `GET /series/{id}/episodes`
+    INDEX_FIELDS = [
+      :absoluteNumber, :airedEpisodeNumber, :airedSeason,:dvdEpisodeNumber,
+      :dvdSeason, :episodeName, :firstAired, :id, :lastUpdated, :overview
+    ]
+
+    # Other fields with {INDEX_FIELDS} returned from api endpoint `GET
+    # /episodes/{id}`
+    SHOW_FIELDS = [
+      :airsAfterSeason, :airsBeforeEpisode, :airsBeforeSeason, :direcotor,
+      :directors, :dvdChapter, :dvdDiscid, :filename, :guestStars, :imdbId,
+      :lastUpdatedBy, :productionCode, :seriesId, :showUrl, :siteRating,
+      :siteRatingCount, :thumbAdded, :thumbAuthor, :thumbHeight, :thumbWidth,
+      :writers
+    ]
+
+    # All possible data fields returned from api for a series.
+    FIELDS = INDEX_FIELDS + SHOW_FIELDS
+
+    attr_reader :absoluteNumber, :airedEpisodeNumber, :airedSeason,
       :airsAfterSeason, :airsBeforeEpisode, :airsBeforeSeason, :direcotor,
       :directors, :dvdChapter, :dvdDiscid, :dvdEpisodeNumber, :dvdSeason,
       :episodeName, :filename, :firstAired, :guestStars, :id, :imdbId,
       :lastUpdated, :lastUpdatedBy, :overview, :productionCode, :seriesId,
       :showUrl, :siteRating, :siteRatingCount, :thumbAdded, :thumbAuthor,
-      :thumbHeight, :thumbWidth, :writers, :errors
-    ]
+      :thumbHeight, :thumbWidth, :writers
 
-    attr_reader *FIELDS
+    INDEX_FIELDS.each do |field|
+      define_method field do
+        if !@completed.keys.include?(@client.language)
+          get_all_fields!
+          @completed[@client.language] = true
+        end
+        return instance_variable_get("@#{field}")
+      end
+    end
+
+    SHOW_FIELDS.each do |field|
+      define_method field do
+        if !@completed.keys.include?(@client.language) || !@completed[@client.language]
+          get_all_fields!
+          @completed[@client.language] = true
+        end
+        return instance_variable_get("@#{field}")
+      end
+    end
 
     alias_method :name, :episodeName
     alias_method :number, :airedEpisodeNumber
     alias_method :seasonNumber, :airedSeason
 
-    # @param [Client] tvdb a TVDB api client.
+    # @param [Client] client a TVDB api client.
     # @param [Hash] data the data retrieved from api.
     #
-    # @note The Episode object may not have all fields filled because it can be
-    #   initialized from not completed data like when is build from a call like
-    #   `series.episodes` (`GET /series/{id}/episodes`): in this case the api
-    #   call return a subset of all avaiable data for the episodes. To get the
-    #   complete data of a specific episode use `#episode!` method.
+    # @note The {Episode} object may not have all fields filled because it can
+    #   be initialized from not completed data like when is build from the call
+    #   {Series#episodes} (`GET /series/{id}/episodes`): in this case the api
+    #   call return a subset of all avaiable data for the episodes
+    #   ({INDEX_FIELDS}). But no warries! When you call a method to get one
+    #   {SHOW_FIELDS} the library automatically call the endpoint `GET
+    #   /episodes/{id}` to retrieve the missing fields.
     # @note You should never need to create this object manually.
-    def initialize(tvdb, data = {})
-      @tvdb = tvdb
+    def initialize(client, data = {})
+      @client = client
       FIELDS.each do |field|
         instance_variable_set("@#{field}", data[field.to_s])
       end
+      @completed = {@client.language => data.key?('seriesId')}
     end
 
-    # Get all data for this episode. Calling api endpoint `GET /episodes/{id}`.
+    # @return [String] the episode number with the "_x_" syntax:
+    #   `"#{season_number}x#{episode_number}` (3x9)".
+    def x
+      "#{self.airedSeason}x#{self.airedEpisodeNumber}"
+    end
+
+    private
+
+    # Get all data fields for this episode. Calling api endpoint `GET
+    # /episodes/{id}`.
     #
     # @return [Episode] the episode object with all fields filled from
     #   the api response.
     # @raise [RequestError]
-    def episode!
-      if self.lastUpdated.nil?
-        e = @tvdb.episode(self.id)
-        FIELDS.each do |field|
-          instance_variable_set("@#{field}", e.send(field))
-        end
+    def get_all_fields!
+      e = @client.episode(@id)
+      FIELDS.each do |field|
+        instance_variable_set("@#{field}", e.send(field))
       end
       return self
     end
-    alias_method :get_data!, :episode!
-
-    # @return [String] the episode number with the "_x_" syntax:
-    #   `"#{season_number}x#{episode_number}` (3x9)".
-    def x
-      "#{self.airedSeason}x#{self.airedEpisodeNumber}"
-    end
 
   end
 end

data/lib/tvdb2/series.rb

@@ -3,54 +3,76 @@ module Tvdb2
   # This class rappresent a series retrieved from TVDB api.
   class Series
 
-    # All series fields returned from TVDB api.
-    FIELDS = [
-      :added, :airsDayOfWeek, :airsTime, :aliases, :banner, :firstAired, :genre,
-      :id, :imdbId, :lastUpdated, :network, :networkId, :overview, :rating,
-      :runtime, :seriesId, :seriesName, :siteRating, :siteRatingCount, :status,
-      :zap2itId, :errors
+    # Fields returned from api endpoint `GET /search/series` (search)
+    INDEX_FIELDS = [
+      :aliases, :banner, :firstAired, :id, :network, :overview, :seriesName,
+      :status
     ]
 
-    attr_reader *FIELDS
+    # Other fields with {INDEX_FIELDS} returned from api endpoint `GET
+    # /series/{id}`
+    SHOW_FIELDS = [
+      :added, :airsDayOfWeek, :airsTime, :genre, :imdbId, :lastUpdated,
+      :networkId, :rating, :runtime, :seriesId, :siteRating, :siteRatingCount,
+      :zap2itId
+    ]
+
+    # All possible data fields returned from api for a series.
+    FIELDS = INDEX_FIELDS + SHOW_FIELDS
+
+    attr_reader :added, :airsDayOfWeek, :airsTime, :aliases, :banner,
+      :firstAired, :genre, :id, :imdbId, :lastUpdated, :network, :networkId,
+      :overview, :rating, :runtime, :seriesId, :seriesName, :siteRating,
+      :siteRatingCount, :status, :zap2itId
+    # FIELDS.each do |field|
+    #   attr_reader field
+    # end
+
+    INDEX_FIELDS.each do |field|
+      define_method field do
+        if !@completed.keys.include?(@client.language)
+          get_all_fields!
+          @completed[@client.language] = true
+        end
+        return instance_variable_get("@#{field}")
+      end
+    end
+
+    SHOW_FIELDS.each do |field|
+      define_method field do
+        if !@completed.keys.include?(@client.language) || !@completed[@client.language]
+          get_all_fields!
+          @completed[@client.language] = true
+        end
+        return instance_variable_get("@#{field}")
+      end
+    end
 
     alias_method :name, :seriesName
 
-    # @param [Client] tvdb a TVDB api client.
+    # @param [Client] client a TVDB api client.
     # @param [Hash] data the data retrieved from api.
     #
-    # @note The {Series} object may not have all fields filled because it
-    #   can be initialized from not completed data like when is build from a
-    #   call like {Client#search} (`GET /search/series`): in this case the api
-    #   call return a subset of all avaiable data for the series. To get the
-    #   complete data of a specific episode use {Series#series!} method.
+    # @note The {Series} object may not have all fields filled because it can
+    #   be initialized from not completed data like when is build from the call
+    #   {Client#search} (`GET /search/series`): in this case the api call return
+    #   a subset of all avaiable data for the series ({INDEX_FIELDS}). But no
+    #   warries! When you call a method to get one {SHOW_FIELDS} the library
+    #   automatically call the endpoint `GET /series/{id}` to retrieve the
+    #   missing fields.
     # @note You should never need to create this object manually.
-    def initialize(tvdb, data = {})
-      @tvdb = tvdb
+    def initialize(client, data = {})
+      @client = client
       FIELDS.each do |field|
         instance_variable_set("@#{field}", data[field.to_s])
       end
+      @completed = {@client.language => data.key?('added')}
     end
 
-    # Get all data for this series. Calling api endpoint `GET /series/{id}`.
-    #
-    # @return [Series] the {Series} object with all fields filled
-    #   from the api response.
-    # @raise [RequestError]
-    def series!
-      if self.added.nil?
-        s = @tvdb.series(self.id)
-        FIELDS.each do |field|
-          instance_variable_set("@#{field}", s.send(field))
-        end
-      end
-      return self
-    end
-    alias_method :get_data!, :series!
-
     # @return [TvdbStruct] return the summary of the series.
     # @raise [RequestError]
     def series_summary
-      @tvdb.series_summary(self.id)
+      @client.series_summary(self.id)
     end
 
     # Retrieve the episodes of the series.
@@ -60,12 +82,12 @@ module Tvdb2
     # @return [Array<Episode>]
     # @raise [RequestError]
     def episodes(params = {})
-      return @tvdb.episodes(self.id, params) if params && params.key?(:page)
+      return @client.episodes(self.id, params) if params && params.key?(:page)
       episodes = []
       page = 1
       loop do
         params.merge!(page: page)
-        result = @tvdb.episodes(self.id, params)
+        result = @client.episodes(self.id, params)
         episodes += result
         page += 1
         break if result.size < 100
@@ -76,7 +98,7 @@ module Tvdb2
     # @return [Array<TvdbStruct>] the list of actors in the series.
     # @raise [RequestError]
     def actors
-      @tvdb.actors(self.id)
+      @client.actors(self.id)
     end
 
     # Get the episode of the series identified by the index.
@@ -105,7 +127,7 @@ module Tvdb2
     # @return [Array<TvdbStruct>] the image summary of the series.
     # @raise [RequestError]
     def images_summary
-      @tvdb.images_summary(self.id)
+      @client.images_summary(self.id)
     end
 
     # Retrieve the images of the series.
@@ -119,7 +141,7 @@ module Tvdb2
     #   got = client.best_search('Game of Thrones')
     #   puts got.images(keyType: 'poster').first.fileName_url # print the url of a poster of the series
     def images(params)
-      @tvdb.images(self.id, params)
+      @client.images(self.id, params)
     end
 
     # @return [Array<TvdbStruct>] the list of fanart images.
@@ -184,5 +206,21 @@ module Tvdb2
 
     # @!endgroup
 
+    private
+
+    # Get all data fields for this series. Calling api endpoint `GET
+    # /series/{id}`.
+    #
+    # @return [Series] the {Series} object with all fields filled
+    #   from the api response.
+    # @raise [RequestError]
+    def get_all_fields!
+      s = @client.series(@id)
+      FIELDS.each do |field|
+        instance_variable_set("@#{field}", s.instance_variable_get("@#{field}"))
+      end
+      return self
+    end
+
   end
 end

data/lib/tvdb2/version.rb

@@ -1,4 +1,4 @@
 module Tvdb2
   # The library version.
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tvdb2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - pioz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler