the_tvdb 0.1.0 → 0.1.1

data/lib/generators/templates/the_tvdb.rb

@@ -1,3 +1,3 @@
 TheTvdb.setup do |config|
-  config.api_key = 'ABC123DEF456GHI7' # Your API here, get one at http://thetvdb.com/?tab=apiregister
+  # config.api_key = 'ABC123DEF456GHI7' # Your API key here, get one at http://thetvdb.com/?tab=apiregister
 end

data/lib/the_tvdb/episode.rb

@@ -22,7 +22,7 @@ module TheTvdb
       @dvd_episode_number = info['DVD_episodenumber']
       @dvd_chapter = info['DVD_chapter']
       @absolute_number = info['absolute_number']
-      @image_url = "#{TheTvdb.gateway.mirror}/banners/#{info['filename']}"
+      @image_url = "#{TheTvdb.gateway.mirror}/banners/#{info['filename']}" unless info['filename'].nil?
       @imdb_id = info['IMDB_ID']
       @language = info['Language']
       @prodiction_code = info['ProductionCode']
@@ -35,9 +35,26 @@ module TheTvdb
     
     def to_hash
       {
-        remote_id: @remote_id, name: @name, description: @description,
-        season_remote_id: @season_remote_id, season_number: @season_number,
-        number: @number, aired_at: @aired_at
+        remote_id: @remote_id,
+        name: @name,
+        description: @description,
+        season_remote_id: @season_remote_id,
+        season_number: @season_number,
+        number: @number,
+        aired_at: @aired_at,
+        guest_stars: @guest_stars,
+        director: @director,
+        writer: @writer,
+        updated_at: @updated_at,
+        dvd_disc: @dvd_disc,
+        dvd_season: @dvd_season,
+        dvd_episode_number: @dvd_episode_number,
+        dvd_chapter: @dvd_chapter,
+        absolute_number: @absolute_number,
+        image_url: @image_url,
+        imdb_id: @imdb_id,
+        language: @language,
+        production_code: @production_code
       }
     end
 

data/lib/the_tvdb/gateway.rb

@@ -25,9 +25,8 @@ module TheTvdb
     
     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
+      @api_key = config.api_key || ENV['TVDBKEY']
       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}"
@@ -45,18 +44,22 @@ module TheTvdb
     end
     
     def update(time)
+      raise "A time reference to get updates is required. Please use set_time to fetch a first reference" unless (time || last_updated)
       hash = xml_to_hash "#{endpoint}/Updates.php?time=#{time || last_updated}", 'Items'
     end
     
     def time
-      @last_updated = xml_to_hash "#{endpoint}/Updates.php?type=none", 'Time'
+      xml_to_hash "#{endpoint}/Updates.php?type=none", 'Time'
+    end
+
+    # Useful for first time updating
+    def set_time
+      @last_updated = time
     end
     
     def get_series(name)
       doc = open_xml "#{endpoint}/GetSeries.php?seriesname=#{URI.escape(name)}"
-      result = doc.css('Series').map { |series| Hash.from_xml(series.to_s)['Series'] }
-      #puts result.to_yaml
-      result
+      doc.css('Series').map { |series| Hash.from_xml(series.to_s)['Series'] }
     end
     
     def get_series_package(seriesid, language = 'en')
@@ -67,9 +70,7 @@ module TheTvdb
         unzip_file("#{zip_path}/#{seriesid}.zip", "#{data_path}/xml/#{seriesid}")
         xml_to_hash "#{data_path}/xml/#{seriesid}/#{language}.xml", 'Data'
       rescue Exception => e
-        puts "Could not retrieve series package"
-        puts "#{@api_path}/series/#{seriesid}/all/#{language}.zip"
-        nil
+        puts "Could not retrieve series package - #{@api_path}/series/#{seriesid}/all/#{language}.zip"
       end
     end
 
@@ -88,8 +89,7 @@ module TheTvdb
           location = (xml =~ URI::regexp) ? open(xml) : File.open(xml)
           Nokogiri::XML(location)
         rescue Exception => e
-          p e
-          #puts e.backtrace
+          puts "Could not open XML file at #{xml}"
         end
       end
     
@@ -100,15 +100,6 @@ module TheTvdb
         result[selector] if selector.present?
       end
     
-      # def xmlurl_to_array(url, selector = nil)
-      #   if selector
-      #     document = open_xml(url).css(selector)
-      #   
-      #   else
-      #     Array.from_xml(open_xml(url).to_s)
-      #   end
-      # end
-
       def unzip_file (file, destination)
         Zip::ZipFile.open(file) { |zip_file|
           zip_file.each { |f|

data/lib/the_tvdb/show.rb

@@ -1,7 +1,7 @@
 module TheTvdb
   class Show
     
-    attr_accessor :remote_id, :name, :banner, :description, :episodes, :seasons,
+    attr_accessor :remote_id, :name, :banner, :description, :episodes,
       :first_aired, :imdb_id, :zap2it_id, :language
     
     def self.search(name)
@@ -12,23 +12,33 @@ module TheTvdb
     def self.find(remote_id)
       info = TheTvdb.gateway.get_series_package(remote_id)
       show = self.new(info['Series'])
-      show.episodes = info['Episode'].map {|e| TheTvdb::Episode.new(e) }
+      show.episodes = info['Episode'].blank? ? [] : [ info['Episode'] ].flatten.map {|e| TheTvdb::Episode.new(e) }
       show
     end
 
     def initialize(info)
       @remote_id = info['id'].to_i
       @name = info['SeriesName']
-      @banner = "#{TheTvdb.gateway.mirror}/banners/#{info['banner']}"
+      @banner = "#{TheTvdb.gateway.mirror}/banners/#{info['banner']}" unless info['banner'].nil?
       @description = info['Overview']
       @imdb_id = info['IMDB_ID']
       @zap2it_id = info['zap2it_id']
       @first_aired = info['FirstAired']
       @language = info['language']
+      @episodes = []
     end
     
     def to_hash
-      { remote_id: @remote_id, name: @name, banner: @banner, description: @description }
+      { 
+        remote_id: @remote_id,
+        name: @name,
+        banner: @banner,
+        description: @description,
+        first_aired: @first_aired,
+        imdb_id: @imdb_id,
+        zap2it_id: @zap2it_id,
+        language: @language
+      }
     end
 
   end

data/lib/the_tvdb/version.rb

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

data/lib/the_tvdb.rb

@@ -26,7 +26,7 @@ module TheTvdb
   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) }
+    result[:shows] = update_hash['Series'].map {|show_remote_id| Show.find(show_remote_id) } if update_hash['Series']
     gateway.last_updated = result[:time]
     result
   end

data/spec/fixtures/tvdb_cassettes/shows.yml

@@ -833,4 +833,162 @@ http_interactions:
         \ </Mirror>\n</Mirrors>\n"
     http_version: 
   recorded_at: Mon, 24 Dec 2012 15:05:53 GMT
+- request:
+    method: get
+    uri: http://www.thetvdb.com/api//GetSeries.php?seriesname=Good%20Girls%20Don't
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Fri, 28 Dec 2012 00:32:17 GMT
+      Content-Type:
+      - text/xml; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Powered-By:
+      - PHP/5.2.6-1+lenny16
+      Cache-Control:
+      - max-age=900
+      Expires:
+      - Fri, 28 Dec 2012 00:47:16 GMT
+      Vary:
+      - User-Agent,Accept-Encoding
+      Set-Cookie:
+      - __cfduid=d1e23e844cef2d1e98714d7a07e742d0c1356654736; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.thetvdb.com
+      Cf-Ray:
+      - 27aa52874da048b
+    body:
+      encoding: US-ASCII
+      string: ! '<?xml version="1.0" encoding="UTF-8" ?>
+
+        <Data>
+
+        <Series>
+
+        <seriesid>127281</seriesid>
+
+        <language>en</language>
+
+        <SeriesName>Good Girls Don''t</SeriesName>
+
+        <FirstAired>2004-06-04</FirstAired>
+
+        <IMDB_ID>tt0413572</IMDB_ID>
+
+        <id>127281</id>
+
+        </Series>
+
+        </Data>'
+    http_version: 
+  recorded_at: Fri, 28 Dec 2012 00:32:17 GMT
+- request:
+    method: get
+    uri: http://thetvdb.com/api/1234567898765432/series/77856/all/en.zip
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "U2VydmVy":
+      - !binary |-
+        Y2xvdWRmbGFyZS1uZ2lueA==
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAyOCBEZWMgMjAxMiAwMTowOTozOSBHTVQ=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vemlw
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        MTYzMQ==
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        a2VlcC1hbGl2ZQ==
+      !binary "TGFzdC1Nb2RpZmllZA==":
+      - !binary |-
+        V2VkLCAxOSBPY3QgMjAxMSAwNjo0OTozOCBHTVQ=
+      !binary "RXhwaXJlcw==":
+      - !binary |-
+        RnJpLCAyOCBEZWMgMjAxMiAwMToyNDozOCBHTVQ=
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bWF4LWFnZT05MDA=
+      !binary "QWNjZXB0LVJhbmdlcw==":
+      - !binary |-
+        Ynl0ZXM=
+      !binary "U2V0LUNvb2tpZQ==":
+      - !binary |-
+        X19jZmR1aWQ9ZGEyYjMzN2NhZDJiZTUxNDBlYzA5YTJlMzlkODI5ODZiMTM1
+        NjY1Njk3ODsgZXhwaXJlcz1Nb24sIDIzLURlYy0yMDE5IDIzOjUwOjAwIEdN
+        VDsgcGF0aD0vOyBkb21haW49LnRoZXR2ZGIuY29t
+      !binary "Q2YtUmF5":
+      - !binary |-
+        MjdhZGJlNGQyOGEwNDhi
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        UEsDBBQAAAAIADO+Uj+RQK0HqwMAAFcIAAAGABUAZW4ueG1sVVQJAAMCc55O
+        AXOeTlV4BAAAAAAAnVZLcyI3EL5Ttf+hy4fsxeblGJvK7GzZYG/Y2KxrTewj
+        pUENqJiRWEljQoofn27NA3CcQ/bATPf3dasl9WOIPv+VpfCK1imjP510mu0T
+        QD0zUunFp5M/J3dnVyfwOW5EQ+FFHD2hVejiBkCkZHx5eXXRi1okMXA988a6
+        eHedCg1jsVZod9fWI3w1S+2M3g3yNN3CdzVbCivdjmH4PU8S0khxS3hEpXF3
+        r7QUcC827HNvcuUQvqSo9e6RHlt4EtoTE7XKgCG2sm46FNtv8xfEVUzcMVDb
+        TFSGFR1kZgZGe9T+u/B0amKPdba4I3tPTijjTr/XPWv3z9qdqHUAs9UX1JZX
+        L96MjB6GN9PRkLBKYvRe6EUuFhijjlq1wswY/cbYVTy+GUStSjkgwlJ7mZlv
+        lLxXhZv4BdOZyRC8Ab9EGBr90cNApCk8IAzozlOFsMiVRBAeJs8wIesmjA04
+        YzRaUA5GZiPgGT2lWQurKJFfc0l5gIfZH2IL0oq5RwlKl0GubbYlgexImVPi
+        HCxV5jCdQ0LJXIDzdIm0OvvAIy3pmh8a8KExWaJFjqgNoFSUSJjTzy8Jckuz
+        acJoDluTw8bkqYRUrcLBEgxhS4/UmBWEhdhXohcqdc2oVV8J30+d1YN0FuLA
+        5NrH7Yop1ECTwLVxzlwpM15UP937ZbtP2a/VPTcWZPruzVfmwSI40M3kLr7V
+        EiWRhcaEkITQfot3jdxsK4wkRhOhKWsElgJjc0Fp84SVAmOpcD5fS+G5eDu9
+        80670+t3o9YhznZr43xYrxQY+1usu8pPFe9nLzeqw5B0u1bOSKxGQrfX+bV/
+        Vc+EgckS6mk5xcJM51lCS3e4x95ljpwcCqq9I+sSYrPh83BKo2RdbPpQq1ip
+        3Cxs/UCpuOOwhcm/t8JoGbIwOYxPfc8TiJlKZPx2PcoWd6ngmtvLBRPWDyXw
+        rF7xqLnYeE8fmtd3dgz8x1zqvjOXcnSeKoyGJQ2nvfIzE6rurXLvwlo6iavb
+        G4SW3NfCObXgvi8nBY2mjCkzh4FJm3Aj7ArtKQggGDZLw05ra/Lg4cT2FH75
+        kRv/W/EcfaTrShA1B6onT/cCtkgnOQ1RQ5jUODofBHukvRZOtCRtIKG5txEO
+        yDOjfQu1wOZhkDeT49Eamc94fA24wqPWG+Anp8tTKKF9Vo90NnixqqjpUggj
+        IHEmzT1O64J9i4T2V/SdFOELV4v/ZwQU1U1d0jm/vKAurvWC5Jbff/ZrvVFX
+        Jovhj8I/UEsDBBQAAAAIADO+Uj/f5lqlNQAAADwAAAALABUAYmFubmVycy54
+        bWxVVAkAAwFznk4Bc55OVXgEAAAAAACzsa/IzVEoSy0qzszPs1Uy1DNQUkjN
+        S85PycxLt1UKDXHTtVBSsLfjsnFKzMsDqgKy9GFMAFBLAwQUAAAACAAzvlI/
+        8VEb3ekAAAARBAAACgAVAGFjdG9ycy54bWxVVAkAAwFznk4Bc55OVXgEAAAA
+        AACt08FqAjEQBuD7PsWwd41F1yrEiAhVi1jR9gHiZnAD2UlJdtv69t1YSw8e
+        cmhOM/Mn8DGE8PlXbeADndeWZvlDf5ADUmmVpvMsf3t96k1ymIuML8rGOv/b
+        iAyAayWK6agYcdZ1IdjU8oyCs58akp2sUSyMJNjJd42Os2sSjg7WhLvXEuaj
+        dc2LU+jEkLO/IePsJt7Lw6jsGoRnW5G3lJZ+jNHL1pgLHHRZSad8WryI4WFl
+        WLenU2enpcdx2lewR02YFp7G4K0mJWErP5O/9SRK21Z7hJVBSkuPBzF635EX
+        OEpq/rk1u33wb1BLAQIXAxQAAAAIADO+Uj+RQK0HqwMAAFcIAAAGAA0AAAAA
+        AAEAAAD/gQAAAABlbi54bWxVVAUAAwJznk5VeAAAUEsBAhcDFAAAAAgAM75S
+        P9/mWqU1AAAAPAAAAAsADQAAAAAAAQAAAP+B5AMAAGJhbm5lcnMueG1sVVQF
+        AAMBc55OVXgAAFBLAQIXAxQAAAAIADO+Uj/xURvd6QAAABEEAAAKAA0AAAAA
+        AAEAAAD/gVcEAABhY3RvcnMueG1sVVQFAAMBc55OVXgAAFBLBQYAAAAAAwAD
+        AMwAAAB9BQAAAAA=
+    http_version: 
+  recorded_at: Fri, 28 Dec 2012 01:09:39 GMT
 recorded_with: VCR 2.3.0

data/spec/lib/the_tvdb/episode_spec.rb

@@ -43,4 +43,17 @@ describe TheTvdb::Episode do
     
   end
 
+end
+
+describe "Weird case episode" do
+
+  before do
+    VCR.insert_cassette 'weird_episode', record: :new_episodes
+  end
+    
+  after do
+    VCR.eject_cassette
+  end
+  
+
 end

data/spec/lib/the_tvdb/gateway_spec.rb

@@ -17,7 +17,6 @@ describe TheTvdb::Gateway do
   describe "#time" do
     it "should return the current server time for update purposes" do
       gateway.time.should == '1356080760'
-      gateway.last_updated.should == '1356080760'
     end
   end
   

data/spec/lib/the_tvdb/show_spec.rb

@@ -30,6 +30,11 @@ describe TheTvdb::Show do
       show.language.should == 'en'
     end
     
+    it "should return nil as a banner on no image" do
+      no_image_show = TheTvdb::Show.search("Good Girls Don't").first
+      no_image_show.banner.should be_nil
+    end
+    
   end
 
   describe ".find" do
@@ -42,6 +47,12 @@ describe TheTvdb::Show do
       episode.name.should == 'Blackwater'
     end
     
+    it "should return an array of episodes even if there is just one episode" do
+      one_episode_show = TheTvdb::Show.find(77856)
+      one_episode_show.episodes.size.should == 1
+    end
+    
+    
   end
 
 end

metadata

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