thetvdb_party 0.0.12.pre → 0.0.13.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fa2e06a9e0a3b23ca038ed937b7ff0a838f8361
-  data.tar.gz: fd44b41771d89e6599a234718e5352fbfac3f927
+  metadata.gz: ce7a724e350ab2d80b5e574e8a796e804d878bf7
+  data.tar.gz: 5a4c17f77cd912885baca62f0af0a1350a3848c4
 SHA512:
-  metadata.gz: 5a8a9f704ea9fca9286719ebf7a2903e364533f23fa32925160c0f4e53e2aebc9dde33da2c96c2bb13a4050c52f6f40b0700e2480362695c73a8000adb724f31
-  data.tar.gz: e239e79646c9a7627d4b16d961b7c57a2a3e0d19e74abf7ed794cb71f1b861682911c5b38c271c166becaaad8a9bdf85a16b14db386f7ff1659e4e90e51986d4
+  metadata.gz: f9aa0d56803fd445b98eeb30d9ff4dff8694203bfcaea746cf36411727ac05d67fbdd3b21c67a5b39ff27cc39cb93bca2610d5a0b74db06d143f247bc1347f27
+  data.tar.gz: d0effd5dc336ac05356c698f156b4d82e7b8c584fd42db41f31a9c2494a40b4d6d3b904b6b3ffbac1bcf546613e225963016b21d0b63ddad22ce035923f2c8c4

data/README.md

@@ -1,4 +1,4 @@
-# TheTvDbParty
+# TheTvDbParty [![Gem Version](https://badge.fury.io/rb/thetvdb_party.svg)](http://badge.fury.io/rb/thetvdb_party)
 
 The thetvdb_party gem accesses the TheTvDB programmers API as it is described on http://thetvdb.com/wiki/index.php/Programmers_API
 
@@ -22,7 +22,45 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Creating a TheTvDb API client
+
+To create a new client without an api key:
+
+```ruby
+client = TheTvDbParty::Client.new
+```
+
+Or with an api key:
+
+```ruby
+client = TheTvDbParty::Client.new "<your api key>"
+```
+
+It is recommended to use an `.env` file or environment variable to store the API key.
+For example like this:
+
+Contents of `.env`
+
+    TVDB_API_KEY=<YOUR API KEY>
+
+### Performing searches
+
+Once you have a client instance, you can perform searches against the TheTvDb API.
+The following example searches for `The Mentalist` on TheTvDb.
+
+```ruby
+results = client.search "The Mentalist"
+```
+
+The `#search` method of the client returns an array containing the search results. Iterate over this array to get
+the **Base Series Record** of the search results.
+
+```ruby
+results.each do |search_result_record|
+  base_series_record = search_result_record.get_base_series_record
+end
+```
+
 
 ## Contributing
 

data/lib/thetvdb_party/actor.rb

@@ -2,16 +2,18 @@ module TheTvDbParty
   # Actors holds information about actors
   # See also:: http://thetvdb.com/wiki/index.php/API:actors.xml
   class Actor
+    # The client that was used to get this actor
+    attr_reader :client
     # Useless field, will eventually be used to link actors between series but currently isn't in use and may actually change once it gets fully implemented so don't bother storing it at all.
     attr_reader :id
     # Can be appended to <mirrorpath>/banners/ to determine the actual location of the artwork.
-    attr_reader :image
+    attr_reader :image_path_relative
     # The actors real name.
     attr_reader :name
     # The name of the actors character in the series.
     attr_reader :role
     # An integer from 0-3. 1 being the most important actor on the show and 3 being the third most important actor. 0 means they have no special sort order. Duplicates of 1-3 aren't suppose to be allowed but currently are so the field isn't perfect but can still be used for basic sorting.
-    attr_reader :sortOrder
+    attr_reader :sort_order
 
     # Initializes a new Actor as it was retrieved from a given client.
     # Parameters::
@@ -24,13 +26,21 @@ module TheTvDbParty
       read_hash_values
     end
 
+    def image_path_full
+      if @image_path_relative
+        return (URI::join(BASE_URL, "banners/", @image_path_relative))
+      end
+    end
+
     private
     def read_hash_values
-      @id = default @hashValues["id"], -1
-      @image = @hashValues["Image"]
+      @id = @hashValues["id"]
+      @image_path_relative = @hashValues["Image"]
       @name = @hashValues["Name"]
       @role = @hashValues["Role"]
-      @sortOrder = default @hashValues["SortOrder"], 0
+      sort_order = (default @hashValues["SortOrder"], 0).to_i
+      sort_order = sort_order>=0 && sort_order <=3 ? sort_order : 0
+      @sort_order = sort_order
 
       nil
     end

data/lib/thetvdb_party/banner.rb

@@ -2,18 +2,20 @@ module TheTvDbParty
   # Banner holds information about banners associated with series and seasons.
   # See Also::  http://thetvdb.com/wiki/index.php/API:banners.xml
   class Banner
+    # The client that was used to get this banner
+    attr_reader :client
   	# Unique ID for this banner
   	attr_reader :id
     # Can be appended to <mirrorpath>/banners/ to determine the actual location of the artwork.
-    attr_reader :bannerPath
+    attr_reader :banner_path_relative
     # Used exactly the same way as BannerPath, only shows if BannerType is fanart.
-    attr_reader :thumbnailPath
-    attr_reader :vignettePath
+    attr_reader :thumbnail_path_relative
+    attr_reader :vignette_path_relative
     # This can be poster, fanart, series or season.
-    attr_reader :bannerType
+    attr_reader :banner_type
     # For series banners it can be text, graphical, or blank. For season banners it can be season or seasonwide. For fanart it can be 1280x720 or 1920x1080. For poster it will always be 680x1000.
     # Blank banners will leave the title and show logo off the banner. Text banners will show the series name as plain text in an Arial font. Graphical banners will show the series name in the show's official font or will display the actual logo for the show. Season banners are the standard DVD cover format while wide season banners will be the same dimensions as the series banners.
-    attr_reader :bannerType2
+    attr_reader :banner_type_2
     # Some banners list the series name in a foreign language. The language abbreviation will be listed here.
     attr_reader :language
     # If the banner is for a specific season.
@@ -21,11 +23,15 @@ module TheTvDbParty
     # Either nil or a decimal with four decimal places. The rating the banner currently has on the site.
     attr_reader :rating
     # Always returns an unsigned integer. Number of people who have rated the image.
-    attr_reader :ratingCount
+    attr_reader :rating_count
     # This can be true or false. Only shows if BannerType is fanart. Indicates if the seriesname is included in the image or not.
-    attr_reader :seriesName
-    # Returns either nil or an array of three RGB colors. These are colors the artist picked that go well with the image. In order they are Light Accent Color, Dark Accent Color and Neutral Midtone Color. It's meant to be used if you want to write something over the image, it gives you a good idea of what colors may work and show up well. Only shows if BannerType is fanart.
-    attr_reader :colors
+    attr_reader :series_name
+    # Returns either nil or a RGB color. These are colors the artist picked that go well with the image. It's meant to be used if you want to write something over the image, it gives you a good idea of what colors may work and show up well. Only shows if BannerType is fanart.
+    attr_reader :light_accent_color
+    # Returns either nil or a RGB color. These are colors the artist picked that go well with the image. It's meant to be used if you want to write something over the image, it gives you a good idea of what colors may work and show up well. Only shows if BannerType is fanart.
+    attr_reader :dark_accent_color
+    # Returns either nil or a RGB color. These are colors the artist picked that go well with the image. It's meant to be used if you want to write something over the image, it gives you a good idea of what colors may work and show up well. Only shows if BannerType is fanart.
+    attr_reader :neutral_midtone_color
 
     # Initializes a new Banner as it was retrieved from a given client.
     # Parameters::
@@ -38,21 +44,92 @@ module TheTvDbParty
       read_hash_values
     end
 
+    def banner_path_full
+      if @banner_path_relative
+        return (URI::join(BASE_URL, "banners/", @banner_path_relative))
+      end
+    end
+
+    def thumbnail_path_full
+      if @thumbnail_path_relative
+        return (URI::join(BASE_URL, "banners/", @thumbnail_path_relative))
+      end
+    end
+
+    def vignette_path_full
+      if @vignette_path_relative
+        return (URI::join(BASE_URL, "banners/", @vignette_path_relative))
+      end
+    end
+
     private
     def read_hash_values
-      @id = default @hashValues["id"], -1
-    	@bannerPath = @hashValues["BannerPath"]
-	    @thumbnailPath = @hashValues["ThumbnailPath"]
-	    @vignettePath = @hashValues["VignettePath"]
-	    @bannerType = @hashValues["BannerType"]
-	    @bannerType2 = @hashValues["BannerType2"]
+      @id = @hashValues["id"]
+    	@banner_path_relative = @hashValues["BannerPath"]
+	    @thumbnail_path_relative = @hashValues["ThumbnailPath"]
+	    @vignette_path_relative = @hashValues["VignettePath"]
+      banner_type = @hashValues["BannerType"] ? (@hashValues["BannerType"].downcase) : nil
+      if ["poster", "fanart", "series", "season"].include? banner_type
+        @banner_type = banner_type
+        banner_type_2 = @hashValues["BannerType2"] ? (@hashValues["BannerType2"].downcase) : nil
+        case banner_type
+        when "series"
+          validValues = ["text", "graphical", "blank"]
+        when "season"
+          validValues = ["season", "seasonwide"]
+        when "fanart"
+          validValues = ["1280x720", "1920x1080"]
+        when "poster"
+          validValues = ["680x1000"]
+        else
+          validValues = []
+        end
+        if validValues.include? banner_type_2
+          @banner_type_2 = banner_type_2
+        else
+          @banner_type_2 = nil
+        end
+      else
+        @banner_type = nil
+        @banner_type_2 = nil
+      end
 	    @language = @hashValues["Language"]
-	    @season = @hashValues["Season"]
-	    @rating = @hashValues["Rating"]
-	    @ratingCount = default @hashValues["RatingCount"], 0
-	    @seriesName = default @hashValues["SeriesName"], false
-	    @colors = @hashValues["Colors"]
-
+	    @season = @hashValues["Season"] ? @hashValues["Season"].to_i : nil
+	    @rating = @hashValues["Rating"] ? @hashValues["Rating"].to_f : 0.to_f
+	    @rating_count = @hashValues["RatingCount"] ? @hashValues["RatingCount"].to_i : 0
+      if banner_type == "fanart"
+	      @series_name = @hashValues["SeriesName"] ? (@hashValues["SeriesName"]=="true" ? true : false) : false
+      else
+        @series_name = false
+      end
+      if @hashValues["Colors"] && banner_type == "fanart"
+        colors = (@hashValues["Colors"].split "|")[1..3]
+        if colors.length==3
+          @light_accent_color = (colors[0].split ",").collect{|x| x.to_i}
+          for value in @light_accent_color
+            if value == nil || value <0 || value >255
+              @light_accent_color = nil
+            end
+          end
+          @dark_accent_color = (colors[1].split ",").collect{|x| x.to_i}
+          for value in @dark_accent_color
+            if value == nil || value <0 || value >255
+              @dark_accent_color = nil
+            end
+          end
+          @neutral_midtone_color = (colors[2].split ",").collect{|x| x.to_i}
+          for value in @neutral_midtone_color
+            if value == nil || value <0 || value >255
+              @neutral_midtone_color = nil
+            end
+          end
+          if @light_accent_color.length!=3 || @dark_accent_color.length!=3 || @neutral_midtone_color.length!=3
+            @light_accent_color = nil
+            @dark_accent_color = nil
+            @neutral_midtone_color = nil
+          end
+        end
+      end
       nil
     end
 

data/lib/thetvdb_party/baseepisoderecord.rb

@@ -139,18 +139,53 @@ module TheTvDbParty
 
     private
     def read_hash_values
-      @id = @hashValues["id"] ? @hashValues["id"].to_i : -1
-      @combined_episodenumber = @hashValues["Combined_episodenumber"] ? @hashValues["Combined_episodenumber"].to_f : -1.0
-      @combined_season = @hashValues["Combined_season"] ? @hashValues["Combined_season"].to_f : -1.0
+      # @id = @hashValues["id"] ? @hashValues["id"].to_i : -1
+      begin
+        @id = @hashValues["id"] ? Integer(@hashValues["id"], 10) : -1
+      rescue ArgumentError
+        @id = -1
+      end
+      # @combined_episodenumber = @hashValues["Combined_episodenumber"] ? @hashValues["Combined_episodenumber"].to_f : -1.0
+      begin
+        @combined_episodenumber = @hashValues["Combined_episodenumber"] ? Float(@hashValues["Combined_episodenumber"]) : -1.0
+      rescue ArgumentError
+        @combined_episodenumber = -1.0
+      end
+      # @combined_season = @hashValues["Combined_season"] ? @hashValues["Combined_season"].to_f : -1.0
+      begin
+        @combined_season = @hashValues["Combined_season"] ? Integer(@hashValues["Combined_season"]) : -1
+      rescue ArgumentError
+        @combined_season = -1
+      end
       @dvd_chapter = @hashValues["DVD_chapter"]
       @dvd_discid = @hashValues["DVD_discid"]
-      @dvd_episodenumber = @hashValues["DVD_episodenumber"] ? @hashValues["DVD_episodenumber"].to_f : -1.0
-      @dvd_season = @hashValues["DVD_season"] ? @hashValues["DVD_season"].to_i : -1
+      # @dvd_episodenumber = @hashValues["DVD_episodenumber"] ? @hashValues["DVD_episodenumber"].to_f : -1.0
+      begin
+        @dvd_episodenumber = @hashValues["DVD_episodenumber"] ? Float(@hashValues["DVD_episodenumber"]) : -1.0
+      rescue ArgumentError
+        @dvd_episodenumber = -1.0
+      end
+      # @dvd_season = @hashValues["DVD_season"] ? @hashValues["DVD_season"].to_i : -1
+      begin
+        @dvd_season = @hashValues["DVD_season"] ? Integer(@hashValues["DVD_season"]) : -1
+      rescue ArgumentError
+        @dvd_season = -1
+      end
       @director = @hashValues["Director"] ? @hashValues["Director"].split('|').reject { |a| a.nil? || a.empty? } : []
-      @epimgflag = @hashValues["EpImgFlag"] ? @hashValues["EpImgFlag"].to_i : 0
+      epimgflag = @hashValues["EpImgFlag"] ? @hashValues["EpImgFlag"].to_i : 0
+      @epimgflag = (1..6).include?(epimgflag) ? epimgflag : 0
       @episodename = @hashValues["EpisodeName"]
-      @episodenumber = @hashValues["EpisodeNumber"] ? @hashValues["EpisodeNumber"].to_i : -1
-      @firstaired = @hashValues["FirstAired"] ? Date.parse(@hashValues["FirstAired"].to_i) : nil
+      # @episodenumber = @hashValues["EpisodeNumber"] ? @hashValues["EpisodeNumber"].to_i : -1
+      begin
+        @episodenumber = @hashValues["EpisodeNumber"] ? Integer(@hashValues["EpisodeNumber"]) : -1
+      rescue ArgumentError
+        @episodenumber = -1
+      end
+      begin
+        @firstaired = @hashValues["FirstAired"] ? Date.parse(@hashValues["FirstAired"]) : nil
+      rescue ArgumentError
+        @firstaired = nil
+      end
       @gueststars = @hashValues["GuestStars"] ? @hashValues["GuestStars"].split('|').reject { |a| a.nil? || a.empty? } : []
       @imdb_id = @hashValues["IMDB_ID"]
       @language = @hashValues["Language"]
@@ -158,18 +193,54 @@ module TheTvDbParty
       @productioncode = @hashValues["ProductionCode"]
       @rating = @hashValues["Rating"] ? @hashValues["Rating"].to_f : 0.0
       @ratingcount = @hashValues["RatingCount"] ? @hashValues["RatingCount"].to_i : 0
-      @seasonnumber = @hashValues["SeasonNumber"] ? @hashValues["SeasonNumber"].to_i : -1
+      begin
+        @seasonnumber = @hashValues["SeasonNumber"] ? Integer(@hashValues["SeasonNumber"]) : -1
+      rescue ArgumentError
+        @seasonnumber = -1
+      end
       @writer = @hashValues["Writer"] ? @hashValues["Writer"].split('|').reject { |a| a.nil? || a.empty? } : []
-      @absolute_number = @hashValues["absolute_number"] ? @hashValues["absolute_number"].to_i : -1
-      @airsafter_season = @hashValues["airsafter_season"] ? @hashValues["airsafter_season"].to_i : -1
-      @airsbefore_episode = @hashValues["airsbefore_episode"] ? @hashValues["airsbefore_episode"].to_i : -1
-      @airsbefore_season = @hashValues["airsbefore_season"] ? @hashValues["airsbefore_season"].to_i : -1
+      begin
+        @absolute_number = @hashValues["absolute_number"] ? Integer(@hashValues["absolute_number"]) : -1
+      rescue ArgumentError
+        @absolute_number = -1
+      end
+      begin
+        @airsafter_season = @hashValues["airsafter_season"] ? Integer(@hashValues["airsafter_season"]) : -1
+      rescue ArgumentError
+        @airsafter_season = -1
+      end
+      begin
+        @airsbefore_episode = @hashValues["airsbefore_episode"] ? Integer(@hashValues["airsbefore_episode"]) : -1
+      rescue ArgumentError
+        @airsbefore_episode = -1
+      end
+      begin
+        @airsbefore_season = @hashValues["airsbefore_season"] ? Integer(@hashValues["airsbefore_season"]) : -1
+      rescue ArgumentError
+        @airsbefore_season = -1
+      end
       @imagepath_relative = @hashValues["filename"]
       @imagepath_full = @imagepath_relative ? URI::join(BASE_URL, 'banners/', @imagepath_relative) : nil
-      @lastupdated = @hashValues["lastupdated"] ? Time.at(@hashValues["lastupdated"].to_i).to_datetime : nil
-      @seasonid = @hashValues["seasonid"] ? @hashValues["seasonid"].to_i : -1
-      @seriesid = @hashValues["seriesid"] ? @hashValues["seriesid"].to_i : -1
-      @thumb_added = @hashValues["thumb_added"] ? Date.parse(@hashValues["thumb_added"]) : nil
+      begin
+        @lastupdated = @hashValues["lastupdated"] ? Time.at(Integer(@hashValues["lastupdated"])).to_datetime : nil
+      rescue ArgumentError
+        @lastupdated = nil
+      end
+      begin
+        @seasonid = @hashValues["seasonid"] ? Integer(@hashValues["seasonid"]) : -1
+      rescue ArgumentError
+        @seasonid = -1
+      end
+      begin
+        @seriesid = @hashValues["seriesid"] ? Integer(@hashValues["seriesid"]) : -1
+      rescue ArgumentError
+        @seriesid = -1
+      end
+      begin
+        @thumb_added = @hashValues["thumb_added"] ? Time.parse(@hashValues["thumb_added"]).to_datetime : nil
+      rescue ArgumentError
+        @thumb_added = nil
+      end
       @thumb_height = @hashValues["thumb_height"] ? @hashValues["thumb_height"].to_i : 0
       @thumb_width = @hashValues["thumb_width"] ? @hashValues["thumb_width"].to_i : 0
 

data/lib/thetvdb_party/baseseriesrecord.rb

@@ -123,31 +123,67 @@ module TheTvDbParty
 
     private
     def read_hash_values
-      @seriesid = @hashValues["id"] ? @hashValues["id"].to_i : -1
+      begin
+        @seriesid = @hashValues["id"] ? Integer(@hashValues["id"]) : -1
+      rescue ArgumentError
+        @seriesid = -1
+      end
       @actors = @hashValues["Actors"] ? @hashValues["Actors"].split('|').reject { |a| a.nil? || a.empty? } : []
       @airs_dayofweek = @hashValues["Airs_DayOfWeek"]
-      @airs_time = @hashValues["Airs_Time"] ? Time.parse(@hashValues["Airs_Time"]) : nil
+      begin
+        @airs_time = @hashValues["Airs_Time"] ? Time.parse(@hashValues["Airs_Time"]) : nil
+      rescue ArgumentError
+        @airs_time = nil
+      end
       @contentrating = @hashValues["ContentRating"]
-      @firstaired = @hashValues["FirstAired"] ? Date.parse(@hashValues["FirstAired"]) : nil
+      begin
+        @firstaired = @hashValues["FirstAired"] ? Date.parse(@hashValues["FirstAired"]) : nil
+      rescue ArgumentError
+        @firstaired = nil
+      end
       @genres = @hashValues["Genre"] ? @hashValues["Genre"].split('|').reject { |a| a.nil? || a.empty? } : []
       @imdb_id = @hashValues["IMDB_ID"]
       @language = @hashValues["Language"]
       @network = @hashValues["Network"]
-      @networkid = @hashValues["NetworkID"] ? @hashValues["NetworkID"].to_i : -1
+      begin
+        @networkid = @hashValues["NetworkID"] ? Integer(@hashValues["NetworkID"]) : nil
+      rescue ArgumentError
+        @networkid = nil
+      end
       @overview = @hashValues["Overview"]
       @rating = @hashValues["Rating"] ? @hashValues["Rating"].to_f : 0.0
       @ratingcount = @hashValues["RatingCount"] ? @hashValues["RatingCount"].to_i : 0
-      @runtime = @hashValues["Runtime"] ? @hashValues["Runtime"].to_i : -1
-      @tvcom_id = @hashValues["SeriesID"] ? @hashValues["SeriesID"].to_i : nil
+      begin
+        @runtime = @hashValues["Runtime"] ? Integer(@hashValues["Runtime"]) : -1
+      rescue ArgumentError
+        @runtime = -1
+      end
+      begin
+        @tvcom_id = @hashValues["SeriesID"] ? Integer(@hashValues["SeriesID"]) : nil
+      rescue ArgumentError
+        @tvcom_id = nil
+      end
       @seriesname = @hashValues["SeriesName"]
-      @status = @hashValues["Status"]
-      @added = @hashValues["added"] ? DateTime.parse(@hashValues["added"]) : nil
-      @addedby = @hashValues["addedBy"] ? @hashValues["addedBy"].to_i : nil
+      @status = @hashValues["Status"] && %w(Ended Continuing).include?(@hashValues["Status"]) ? @hashValues["Status"] : nil
+      begin
+        @added = @hashValues["added"] ? DateTime.parse(@hashValues["added"]) : nil
+      rescue ArgumentError
+        @added = nil
+      end
+      begin
+        @addedby = @hashValues["addedBy"] ? Integer(@hashValues["addedBy"]) : nil
+      rescue ArgumentError
+        @addedby = nil
+      end
       @bannerpath_relative = @hashValues["banner"]
       @fanartpath_relative = @hashValues["fanart"]
       @posterpath_relative = @hashValues["poster"]
       @zap2it_id = @hashValues["zap2it_id"]
-      @lastupdated = @hashValues["lastupdated"] ? Time.at(@hashValues["lastupdated"].to_i).to_datetime : nil
+      begin
+        @lastupdated = @hashValues["lastupdated"] ? Time.at(Integer(@hashValues["lastupdated"])).to_datetime : nil
+      rescue ArgumentError
+        @lastupdated = nil
+      end
       @bannerpath_full = @bannerpath_relative ? URI::join(BASE_URL, "banners/", @bannerpath_relative) : nil
       @fanartpath_full = @fanartpath_relative ? URI::join(BASE_URL, "banners/", @fanartpath_relative) : nil
       @posterpath_full = @posterpath_relative ? URI::join(BASE_URL, "banners/", @posterpath_relative) : nil