the_tvdb 0.0.2 → 0.1.0

data/lib/the_tvdb/episode.rb

@@ -1,16 +1,31 @@
 module TheTvdb
   class Episode
     
-    attr_accessor :remote_id, :season_remote_id, :season_number, :name, :number, :aired_at, :description
+    attr_accessor :remote_id, :season_remote_id, :season_number, :name, :number, :aired_at, :description,
+      :guest_stars, :director, :writer, :updated_at, :dvd_disc, :dvd_season, :dvd_episode_number, :dvd_chapter,
+      :absolute_number, :image_url, :imdb_id, :language, :production_code
 
     def initialize(info)
       @remote_id = info['id'].to_i
       @season_remote_id = info['seasonid'].to_i
-      @season_number = info['Combined_season'].to_i
+      @season_number = info['SeasonNumber'].to_i
       @name = info['EpisodeName']
       @number = info['EpisodeNumber'].to_i
       @aired_at = info['FirstAired']
       @description = info['Overview']
+      @guest_stars = info['GuestStars']
+      @director = info['Director']
+      @writer = info['Writer']
+      @updated_at = Time.at(info['lastupdated'].to_i)
+      @dvd_disc = info['DVD_discid']
+      @dvd_season = info['DVD_season']
+      @dvd_episode_number = info['DVD_episodenumber']
+      @dvd_chapter = info['DVD_chapter']
+      @absolute_number = info['absolute_number']
+      @image_url = "#{TheTvdb.gateway.mirror}/banners/#{info['filename']}"
+      @imdb_id = info['IMDB_ID']
+      @language = info['Language']
+      @prodiction_code = info['ProductionCode']
     end
     
     def self.find(remote_id)
@@ -28,31 +43,3 @@ module TheTvdb
 
   end
 end
-
-# For reference, the episode yaml:
-#
-# id: '4245778'
-# seasonid: '473271'
-# EpisodeNumber: '9'
-# EpisodeName: Blackwater
-# FirstAired: '2012-05-28'
-# GuestStars: 
-# Director: Neil Marshall
-# Writer: George R. R. Martin
-# Overview: Tyrion and the Lannisters fight for their lives as Stannis’ fleet assaults King’s Landing.
-# ProductionCode: 
-# lastupdated: '1352849383'
-# flagged: '0'
-# DVD_discid: 
-# DVD_season: '2'
-# DVD_episodenumber: '9.0'
-# DVD_chapter: 
-# absolute_number: '19'
-# filename: episodes/121361/4245778.jpg
-# seriesid: '121361'
-# mirrorupdate: '2012-11-13 15:28:01'
-# IMDB_ID: tt2084342
-# EpImgFlag: '2'
-# Rating: '8.4'
-# SeasonNumber: '2'
-# Language: en

data/lib/the_tvdb/gateway.rb

@@ -23,11 +23,14 @@ module TheTvdb
       config.episodes_path
     end
     
+    attr_accessor :api_key, :mirror, :api_path, :last_updated
+    
     # TODO: setup a reliable env system for apikey
     def initialize(api_key = nil)
       @api_key = config.api_key
       raise 'No API key was provided. Please set one as TheTvdb::Configuration.apikey or as an environment variable (e.g.: `export TVDBKEY=1234567898765432`).' if !@api_key
       @mirror = get_mirror
+      @api_path = "#{@mirror}/api/#{@api_key}"
     end
     
     ENDPOINT = 'http://www.thetvdb.com/api/'
@@ -36,20 +39,15 @@ module TheTvdb
       ENDPOINT
     end
     
-    # def api_key
-    #   APIKEY
-    # end
-    
     def get_mirror
       hash = xml_to_hash "#{endpoint}#{@api_key}/mirrors.xml", 'Mirror'
-      "#{hash['mirrorpath']}/api/#{@api_key}"
+      hash['mirrorpath']
     end
     
     def update(time)
       hash = xml_to_hash "#{endpoint}/Updates.php?time=#{time || last_updated}", 'Items'
     end
     
-    attr_accessor :last_updated
     def time
       @last_updated = xml_to_hash "#{endpoint}/Updates.php?type=none", 'Time'
     end
@@ -64,14 +62,13 @@ module TheTvdb
     def get_series_package(seriesid, language = 'en')
       begin
         open("#{zip_path}/#{seriesid}.zip", 'wb') do |file|
-          file << open("#{@mirror}/series/#{seriesid}/all/#{language}.zip").read
+          file << open("#{@api_path}/series/#{seriesid}/all/#{language}.zip").read
         end
         unzip_file("#{zip_path}/#{seriesid}.zip", "#{data_path}/xml/#{seriesid}")
         xml_to_hash "#{data_path}/xml/#{seriesid}/#{language}.xml", 'Data'
       rescue Exception => e
-        p e
-        #puts e.backtrace
-        puts "#{@mirror}/series/#{seriesid}/all/#{language}.zip"
+        puts "Could not retrieve series package"
+        puts "#{@api_path}/series/#{seriesid}/all/#{language}.zip"
         nil
       end
     end
@@ -79,7 +76,7 @@ module TheTvdb
     def get_episode_details(episodeid, language = 'en')
       file_path = "#{episodes_path}/#{episodeid}.xml"
       open(file_path, 'wb') do |file|
-        file << open("#{@mirror}/episodes/#{episodeid}/#{language}.xml").read
+        file << open("#{@api_path}/episodes/#{episodeid}/#{language}.xml").read
       end
       xml_to_hash(file_path, 'Episode')
     end

data/lib/the_tvdb/show.rb

@@ -1,7 +1,8 @@
 module TheTvdb
   class Show
     
-    attr_accessor :remote_id, :name, :banner, :description, :episodes, :seasons#, :aired_at
+    attr_accessor :remote_id, :name, :banner, :description, :episodes, :seasons,
+      :first_aired, :imdb_id, :zap2it_id, :language
     
     def self.search(name)
       shows = TheTvdb.gateway.get_series(name)
@@ -18,9 +19,12 @@ module TheTvdb
     def initialize(info)
       @remote_id = info['id'].to_i
       @name = info['SeriesName']
-      @banner = info['banner']
+      @banner = "#{TheTvdb.gateway.mirror}/banners/#{info['banner']}"
       @description = info['Overview']
-      #@aired_at = info['FirstAired']
+      @imdb_id = info['IMDB_ID']
+      @zap2it_id = info['zap2it_id']
+      @first_aired = info['FirstAired']
+      @language = info['language']
     end
     
     def to_hash

data/lib/the_tvdb/version.rb

@@ -1,3 +1,3 @@
 module TheTvdb
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/the_tvdb.rb

@@ -21,10 +21,10 @@ module TheTvdb
   # Starting from the last update recorded on the gateway, a hash with the new
   # update time and the updated shows are returned
   #
-  # @param [Integer] timestamp the last update timestamp (if not provided the last_updated attribute of the gateway is used instead)
+  # @param [Integer] timestamp the last update timestamp (if not provided the last_updated attribute of Gateway is used instead)
   # @return [Hash] the new last_updated time and the Shows that have been updated
-  def self.update(time = nil)
-    update_hash = gateway.update(time)
+  def self.update(timestamp = nil)
+    update_hash = gateway.update(timestamp)
     result = { time: update_hash['Time'].to_i }
     result[:shows] = update_hash['Series'].map {|show_remote_id| Show.find(show_remote_id) }
     gateway.last_updated = result[:time]

data/spec/fixtures/tvdb_cassettes/shows.yml

@@ -787,4 +787,50 @@ http_interactions:
         YWN0b3JzLnhtbFVUBQADIyHUUFV4AABQSwUGAAAAAAMAAwDMAAAAoi8AAAAA
     http_version: 
   recorded_at: Fri, 21 Dec 2012 09:07:11 GMT
+- request:
+    method: get
+    uri: http://www.thetvdb.com/api/1234567898765432/mirrors.xml
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Mon, 24 Dec 2012 15:05:53 GMT
+      Content-Type:
+      - text/xml
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Last-Modified:
+      - Mon, 24 Dec 2012 15:00:04 GMT
+      Vary:
+      - Accept-Encoding
+      Expires:
+      - Mon, 24 Dec 2012 15:20:53 GMT
+      Cache-Control:
+      - max-age=900
+      Set-Cookie:
+      - __cfduid=ded407954e27e753fec08053c0413972b1356361553; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.thetvdb.com
+      Cf-Ray:
+      - 25eaf5b6b12048b
+    body:
+      encoding: US-ASCII
+      string: ! "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>\n<Mirrors>\n  <Mirror>\n
+        \   <id>1</id>\n    <mirrorpath>http://thetvdb.com</mirrorpath>\n    <typemask>7</typemask>\n
+        \ </Mirror>\n</Mirrors>\n"
+    http_version: 
+  recorded_at: Mon, 24 Dec 2012 15:05:53 GMT
 recorded_with: VCR 2.3.0

data/spec/lib/the_tvdb/episode_spec.rb

@@ -21,8 +21,24 @@ describe TheTvdb::Episode do
     it "should return all the info of the episode" do
       episode.name.should == 'Blackwater'
       episode.number.should == 9
+      episode.season_number.should == 2
       episode.aired_at.should == '2012-05-28'
       episode.description.should == "Tyrion and the Lannisters fight for their lives as Stannis’ fleet assaults King’s Landing."
+      episode.season_remote_id.should == 473271
+      episode.guest_stars.should be_nil
+      episode.director.should == 'Neil Marshall'
+      episode.writer.should == 'George R. R. Martin'
+      episode.updated_at.should == Time.at(1352849383)
+      # episode.flagged.should == '0'
+      episode.dvd_disc.should be_nil
+      episode.dvd_season.should == '2'
+      episode.dvd_episode_number.should == '9.0'
+      episode.dvd_chapter.should be_nil
+      episode.absolute_number.should == '19'
+      episode.image_url.should == 'http://thetvdb.com/banners/episodes/121361/4245778.jpg'
+      episode.imdb_id.should == 'tt2084342'
+      episode.language.should == 'en'
+      episode.production_code.should be_nil
     end
     
   end

data/spec/lib/the_tvdb/show_spec.rb

@@ -23,6 +23,11 @@ describe TheTvdb::Show do
       show.remote_id.should == 121361
       description = 'Based on the fantasy novel series "A Song of Ice and Fire," Game of Thrones explores the story of an epic battle among seven kingdoms and two ruling families in the only game that matters - the Game of Thrones. All seek control of the Iron Throne, the possession of which ensures survival through the 40-year winter to come.'
       show.description.should == description
+      show.imdb_id.should == 'tt0944947'
+      show.zap2it_id.should == 'SH01389809'
+      show.first_aired.should == '2011-04-17'
+      show.banner.should == 'http://thetvdb.com/banners/graphical/121361-g26.jpg'
+      show.language.should == 'en'
     end
     
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_tvdb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-21 00:00:00.000000000 Z
+date: 2012-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri