thetvdb_party 0.0.10.pre → 0.0.11.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b470ca3188d5901fc1f2a1624f1821dabc239ea6
-  data.tar.gz: b916a69a52ac4c41a7f8397bb9aa62b3b30b3dca
+  metadata.gz: caaeef9e167cb8951dd7d04ce0ba6bfc23d56df1
+  data.tar.gz: 33c2b4c2cec606d65479e648e1816f6046b7b245
 SHA512:
-  metadata.gz: aa03ad7d095c9d53fb808a1cecb1c854e024170b3f2056f2cea5712b939e40b1f0bb16cd0f434f826f2c78e0e5992e316af2936afd774764d911f83e996d30ab
-  data.tar.gz: 9ae6fee16491b918866da142a8deaf5b04911020abec32403a9ba606b778c85225e34d40cd3b4c7364dc066b4f8dd309afa74f030469fe63a4ad7c7662790d2d
+  metadata.gz: b355f88c52e93986891f815a49a8bc0e6ce0124d9c78eb4ddfebda08a44e2e58aa6ccec3257a7735c67bac79f7ac881ba69a54b56385a365e8f7e02c6843cf18
+  data.tar.gz: 454d5ef95c960f476f0c1ce577620b72e8217bfbe4a3ccc600aa2a44c153ad5d5599956a8014d64453d7ed6c32f875b9a71bb651ab78ca8d190506fc54cb6717

data/.gitattributes

@@ -1,63 +1,63 @@
-###############################################################################
-# Set default behavior to automatically normalize line endings.
-###############################################################################
-* text=auto
-
-###############################################################################
-# Set default behavior for command prompt diff.
-#
-# This is need for earlier builds of msysgit that does not have it on by
-# default for csharp files.
-# Note: This is only used by command line
-###############################################################################
-#*.cs     diff=csharp
-
-###############################################################################
-# Set the merge driver for project and solution files
-#
-# Merging from the command prompt will add diff markers to the files if there
-# are conflicts (Merging from VS is not affected by the settings below, in VS
-# the diff markers are never inserted). Diff markers may cause the following 
-# file extensions to fail to load in VS. An alternative would be to treat
-# these files as binary and thus will always conflict and require user
-# intervention with every merge. To do so, just uncomment the entries below
-###############################################################################
-#*.sln       merge=binary
-#*.csproj    merge=binary
-#*.vbproj    merge=binary
-#*.vcxproj   merge=binary
-#*.vcproj    merge=binary
-#*.dbproj    merge=binary
-#*.fsproj    merge=binary
-#*.lsproj    merge=binary
-#*.wixproj   merge=binary
-#*.modelproj merge=binary
-#*.sqlproj   merge=binary
-#*.wwaproj   merge=binary
-
-###############################################################################
-# behavior for image files
-#
-# image files are treated as binary by default.
-###############################################################################
-#*.jpg   binary
-#*.png   binary
-#*.gif   binary
-
-###############################################################################
-# diff behavior for common document formats
-# 
-# Convert binary document formats to text before diffing them. This feature
-# is only available from the command line. Turn it on by uncommenting the 
-# entries below.
-###############################################################################
-#*.doc   diff=astextplain
-#*.DOC   diff=astextplain
-#*.docx  diff=astextplain
-#*.DOCX  diff=astextplain
-#*.dot   diff=astextplain
-#*.DOT   diff=astextplain
-#*.pdf   diff=astextplain
-#*.PDF   diff=astextplain
-#*.rtf   diff=astextplain
-#*.RTF   diff=astextplain
+###############################################################################
+# Set default behavior to automatically normalize line endings.
+###############################################################################
+* text=auto
+
+###############################################################################
+# Set default behavior for command prompt diff.
+#
+# This is need for earlier builds of msysgit that does not have it on by
+# default for csharp files.
+# Note: This is only used by command line
+###############################################################################
+#*.cs     diff=csharp
+
+###############################################################################
+# Set the merge driver for project and solution files
+#
+# Merging from the command prompt will add diff markers to the files if there
+# are conflicts (Merging from VS is not affected by the settings below, in VS
+# the diff markers are never inserted). Diff markers may cause the following 
+# file extensions to fail to load in VS. An alternative would be to treat
+# these files as binary and thus will always conflict and require user
+# intervention with every merge. To do so, just uncomment the entries below
+###############################################################################
+#*.sln       merge=binary
+#*.csproj    merge=binary
+#*.vbproj    merge=binary
+#*.vcxproj   merge=binary
+#*.vcproj    merge=binary
+#*.dbproj    merge=binary
+#*.fsproj    merge=binary
+#*.lsproj    merge=binary
+#*.wixproj   merge=binary
+#*.modelproj merge=binary
+#*.sqlproj   merge=binary
+#*.wwaproj   merge=binary
+
+###############################################################################
+# behavior for image files
+#
+# image files are treated as binary by default.
+###############################################################################
+#*.jpg   binary
+#*.png   binary
+#*.gif   binary
+
+###############################################################################
+# diff behavior for common document formats
+# 
+# Convert binary document formats to text before diffing them. This feature
+# is only available from the command line. Turn it on by uncommenting the 
+# entries below.
+###############################################################################
+#*.doc   diff=astextplain
+#*.DOC   diff=astextplain
+#*.docx  diff=astextplain
+#*.DOCX  diff=astextplain
+#*.dot   diff=astextplain
+#*.DOT   diff=astextplain
+#*.pdf   diff=astextplain
+#*.PDF   diff=astextplain
+#*.rtf   diff=astextplain
+#*.RTF   diff=astextplain

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in thetvdb_party.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in thetvdb_party.gemspec
+gemspec

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2015 Fredrik Høisæther Rasch, Tim Alexander Teige, Peter Munch-Ellingsen, Tore Skog Pettersen, Alexander Trondsen Norvik
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2015 Fredrik Høisæther Rasch, Tim Alexander Teige, Peter Munch-Ellingsen, Tore Skog Pettersen, Alexander Trondsen Norvik
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,9 +1,14 @@
-require 'bundler/gem_tasks'
-require 'rdoc/task'
-
-RDoc::Task.new do |rdoc|
-  rdoc.main = "README.md"
-  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
-  rdoc.rdoc_dir = "doc"
-  rdoc.options << "--line-numbers"
-end
+require 'bundler/gem_tasks'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
+  rdoc.rdoc_dir = "doc"
+  rdoc.options << "--line-numbers"
+end
+
+RSpec::Core::RakeTask.new do |rspec|
+  rspec.pattern = 'spec/**/*_spec.rb'
+end

data/lib/thetvdb_party/actor.rb

@@ -0,0 +1,42 @@
+module TheTvDbParty
+  # Actors holds information about actors
+  # See also:: http://thetvdb.com/wiki/index.php/API:actors.xml
+  class Actor
+    # 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
+    # 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
+
+    # Initializes a new Actor as it was retrieved from a given client.
+    # Parameters::
+    #   +client+::      The TheTvDbParty::Client instance that retrieved the record this actor belongs to.
+    #   +hashValues+::  A Hash{String => String} instance that maps the actor element names to their string values.
+    def initialize(client, hashValues)
+      @client = client
+      @hashValues = hashValues
+
+      read_hash_values
+    end
+
+    private
+    def read_hash_values
+      @id = default @hashValues["id"], -1
+      @image = @hashValues["Image"]
+      @name = @hashValues["Name"]
+      @role = @hashValues["Role"]
+      @sortOrder = default @hashValues["SortOrder"], 0
+
+      nil
+    end
+    
+    def default value, default
+      return value ? value : default
+    end
+  end
+end

data/lib/thetvdb_party/all.rb

@@ -0,0 +1,34 @@
+module TheTvDbParty
+  class AllSeriesInformation
+
+    attr_reader :actors, :banners, :series, :episodes
+    
+    def initialize(client, zip_file)
+      @client = client
+
+      unzip_file(zip_file)
+
+    end
+
+    private
+    def unzip_file(zip_file)
+      @series = BaseSeriesRectord.new(@client, zip_file.glob("Series").input_stream.read)
+      @actors = []
+      @banners = []
+      @episodes = []
+  
+      zip_file.glob("Actors").each do |actor|
+        @actors << Actor.new(@client, actor.input_stream.read)
+      end
+  
+      zip_file.glob("Banners").each do |banner|
+        @banners << Banner.new(@client, banner.input_stream.read)
+      end
+  
+      zip_file.glob("Episode").each do |episode|
+        @episodes << Episode.new(@client, episode.input_stream.read)
+      end
+  
+    end
+  end
+end

data/lib/thetvdb_party/banner.rb

@@ -0,0 +1,63 @@
+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
+  	# 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
+    # Used exactly the same way as BannerPath, only shows if BannerType is fanart.
+    attr_reader :thumbnailPath
+    attr_reader :vignettePath
+    # This can be poster, fanart, series or season.
+    attr_reader :bannerType
+    # 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
+    # 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.
+    attr_reader :season
+    # 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
+    # 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
+
+    # Initializes a new Banner as it was retrieved from a given client.
+    # Parameters::
+    #   +client+::      The TheTvDbParty::Client instance that retrieved the record this banner belongs to.
+    #   +hashValues+::  A Hash{String => String} instance that maps the banner element names to their string values.
+    def initialize(client, hashValues)
+      @client = client
+      @hashValues = hashValues
+
+      read_hash_values
+    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"]
+	    @language = @hashValues["Language"]
+	    @season = @hashValues["Season"]
+	    @rating = @hashValues["Rating"]
+	    @ratingCount = default @hashValues["RatingCount"], 0
+	    @seriesName = default @hashValues["SeriesName"], false
+	    @colors = @hashValues["Colors"]
+
+      nil
+    end
+
+    def default value, default
+      return value ? value : default
+    end
+  end
+end

data/lib/thetvdb_party/baseseriesrecord.rb

@@ -107,6 +107,20 @@ module TheTvDbParty
       @client.get_series_absolute_episode @seriesid, episode_number
     end
 
+    # Retrieves the banners for this series.
+    # Returns::   An array of TheTvDbParty::Banner instances, or +nil+ if none could be retrieved.
+    # See Also::  TheTvDbParty::Client#get_series_banners
+    def get_banners
+      @client.get_series_banners @seriesid
+    end
+
+    # Retrieves the banners for this series.
+    # Returns::   An array of TheTvDbParty::Banner instances, or +nil+ if none could be retrieved.
+    # See Also::  TheTvDbParty::Client#get_series_actors
+    def get_actors
+      @client.get_series_actors @seriesid
+    end
+
     private
     def read_hash_values
       @seriesid = @hashValues["id"] ? @hashValues["id"].to_i : -1

data/lib/thetvdb_party/client.rb

@@ -63,6 +63,7 @@ module TheTvDbParty
       end
       request_url = URI.join(BASE_URL, 'api/', request_url)
       resp = self.class.get(request_url).parsed_response
+      return nil unless resp["Data"]
       return nil unless resp["Data"]["Series"]
       BaseSeriesRecord.new(self, resp["Data"]["Series"])
     end
@@ -134,6 +135,61 @@ module TheTvDbParty
       get_base_episode_record_from_url request_url
     end
 
+    # Retrieves the banners for a given series by its series id.
+    # Parameters::
+    #   +seriesid+::  The TheTvDb assigned unique identifier for the series to access.
+    # Returns::   An array of TheTvDbParty::Banner instances or +nil+ if the banners could not be retrieved. Note: may return [] if banners are retrieved but there are none.
+    def get_series_banners(seriesid)
+      request_url = "#{@apikey}/series/#{seriesid}/banners.xml"
+      request_url = URI.join(BASE_URL, 'api/', request_url)
+      response = self.class.get(request_url).parsed_response
+      return nil unless response["Banners"]
+      return nil unless response["Banners"]["Banner"]
+      case response["Banners"]["Banner"]
+        when Array
+          response["Banners"]["Banner"].map {|s|Banner.new(self, s)}
+        when Hash
+          [Banner.new(self, response["Banners"]["Banner"])]
+        else
+          []
+      end
+    end
+
+    # Retrieves the actors for a given series by its series id.
+    # Parameters::
+    #   +seriesid+::  The TheTvDb assigned unique identifier for the series to access.
+    # Returns::   An array of TheTvDbParty::Actor instances or +nil+ if the actors could not be retrieved. Note: may return [] if actors are retrieved but there are none.
+    def get_series_actors(seriesid)
+      request_url = "#{@apikey}/series/#{seriesid}/actors.xml"
+      request_url = URI.join(BASE_URL, 'api/', request_url)
+      response = self.class.get(request_url).parsed_response
+      return nil unless response["Actors"]
+      return nil unless response["Actors"]["Actor"]
+      case response["Actors"]["Actor"]
+        when Array
+          response["Actors"]["Actor"].map {|s|Actor.new(self, s)}
+        when Hash
+          [Actor.new(self, response["Actors"]["Actor"])]
+        else
+          []
+      end
+    end
+
+    def get_series_all(seriesid)
+      unless @language
+        request_url = "#{@apikey}/series/#{seriesid}/all"
+      else
+        request_url = "#{@apikey}/series/#{seriesid}/all/#{@language}.zip"
+      end
+
+      resp = self.class.get(request_url)
+
+      return nil unless resp.body.extname == ".zip"
+
+      AllSeriesInformation.new(@client, resp.body)
+
+    end
+
     private
     def get_base_episode_record_from_url(request_url)
       resp = self.class.get(request_url).parsed_response

data/lib/thetvdb_party/version.rb

@@ -1,4 +1,4 @@
-module TheTvDbParty
-  # The current version of the *thetvdb_party* gem
-  VERSION = "0.0.10.pre"
-end
+module TheTvDbParty
+  # The current version of the *thetvdb_party* gem
+  VERSION = "0.0.11.pre"
+end

data/lib/thetvdb_party.rb

@@ -4,7 +4,11 @@ require 'thetvdb_party/baseseriesrecord'
 require 'thetvdb_party/baseepisoderecord'
 require 'thetvdb_party/client'
 require 'thetvdb_party/searchseriesrecord'
+require 'thetvdb_party/actor'
+require 'thetvdb_party/banner'
 require 'thetvdb_party/version'
+require 'thetvdb_party/banner'
+require 'thetvdb_party/actor'
 
 # thetvdb_party gem root namespace
 module TheTvDbParty

data/spec/thetvdb_party/actor_spec.rb

@@ -0,0 +1,26 @@
+require 'rspec'
+require 'thetvdb_party'
+
+describe 'Actor' do
+
+  before(:each) do
+    @valid_actor = TheTvDbParty::Actor.new(nil,
+      {
+          "id" => "0"
+      }
+    )
+    @invalid_actor = TheTvDbParty::Actor.new(nil, { })
+  end
+
+  it 'should have an id when valid' do
+    expect @valid_actor.id == 0
+  end
+
+  it 'should have a negative id when invalid' do
+    expect @invalid_actor.id < 0
+  end
+
+  it 'should not instantiate when created without hash values' do
+    expect{TheTvDbParty::Actor.new(nil, nil)}.to raise_error
+  end
+end

data/spec/thetvdb_party/banner_spec.rb

@@ -0,0 +1,26 @@
+require 'rspec'
+require 'thetvdb_party'
+
+describe 'Banner' do
+
+  before(:each) do
+    @valid_banner = TheTvDbParty::Banner.new(nil,
+      {
+          "id" => "0"
+      }
+    )
+    @invalid_banner = TheTvDbParty::Banner.new(nil, { })
+  end
+
+  it 'should have an id when valid' do
+    expect @valid_banner.id == 0
+  end
+
+  it 'should have a negative id when invalid' do
+    expect @invalid_banner.id < 0
+  end
+
+  it 'should not instantiate when created without hash values' do
+    expect{TheTvDbParty::Banner.new(nil, nil)}.to raise_error
+  end
+end

data/spec/thetvdb_party/baseseriesrecord_spec.rb

@@ -0,0 +1,21 @@
+require 'rspec'
+require 'thetvdb_party'
+
+describe 'BaseSeriesRecord' do
+  before(:each) do
+    @valid_record = TheTvDbParty::BaseSeriesRecord.new(nil,
+      {
+        "id" => "0"
+      }
+    )
+    @invalid_record = TheTvDbParty::BaseSeriesRecord.new(nil, { })
+  end
+
+  it "should have valid id if valid" do
+    expect @valid_record.seriesid == 0
+  end
+
+  it "should have negative id if series not found or invalid" do
+    expect @invalid_record.seriesid < 0
+  end
+end

data/spec/thetvdb_party_spec.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+
+describe 'TheTvDbParty' do
+  client = TheTvDbParty::Client.new(ENV["TVDB_API_KEY"])
+  let(:search_series_records) { client.search "The Mentalist" }
+
+  it 'should find search results' do
+    # client = TheTvDbParty::Client.new(ENV["TVDB_API_KEY"])
+    # let(:results) { client.search "The Mentalist" }
+    expect(search_series_records).to_not be_nil
+    expect(search_series_records).to_not be_empty
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thetvdb_party
 version: !ruby/object:Gem::Version
-  version: 0.0.10.pre
+  version: 0.0.11.pre
 platform: ruby
 authors:
 - Fredrik Høisæther Rasch
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,13 +90,20 @@ files:
 - README.md
 - Rakefile
 - lib/thetvdb_party.rb
+- lib/thetvdb_party/actor.rb
+- lib/thetvdb_party/all.rb
+- lib/thetvdb_party/banner.rb
 - lib/thetvdb_party/baseepisoderecord.rb
 - lib/thetvdb_party/baseseriesrecord.rb
 - lib/thetvdb_party/client.rb
 - lib/thetvdb_party/searchseriesrecord.rb
 - lib/thetvdb_party/version.rb
 - spec/spec_helper.rb
+- spec/thetvdb_party/actor_spec.rb
+- spec/thetvdb_party/banner_spec.rb
 - spec/thetvdb_party/baseepisoderecord_spec.rb
+- spec/thetvdb_party/baseseriesrecord_spec.rb
+- spec/thetvdb_party_spec.rb
 - thetvdb_party.gemspec
 homepage: https://github.com/couven92/thetvdb_party
 licenses:
@@ -129,5 +136,9 @@ specification_version: 4
 summary: Ruby Gem for accessing the TheTVDB programmers API
 test_files:
 - spec/spec_helper.rb
+- spec/thetvdb_party/actor_spec.rb
+- spec/thetvdb_party/banner_spec.rb
 - spec/thetvdb_party/baseepisoderecord_spec.rb
+- spec/thetvdb_party/baseseriesrecord_spec.rb
+- spec/thetvdb_party_spec.rb
 has_rdoc: