tvdbr 0.1.0 → 0.2.0

data/Gemfile

@@ -1,4 +1,8 @@
 source "http://rubygems.org"
 
+gem 'i18n'
+gem 'activesupport'
+gem 'nokogiri'
+
 # Specify your gem's dependencies in tvdbr.gemspec
 gemspec

data/Gemfile.lock

@@ -1,19 +1,22 @@
 PATH
   remote: .
   specs:
-    tvdbr (0.0.1)
-      activesupport
+    tvdbr (0.1.0)
       hashie
-      httparty
+      httparty (>= 0.8.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.0.3)
-    crack (0.1.8)
-    hashie (0.4.0)
-    httparty (0.6.1)
-      crack (= 0.1.8)
+    activesupport (3.0.0)
+    hashie (1.2.0)
+    httparty (0.8.1)
+      multi_json (~> 1.0)
+      multi_xml
+    i18n (0.6.1)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    nokogiri (1.5.5)
     rake (0.8.7)
 
 PLATFORMS
@@ -21,7 +24,7 @@ PLATFORMS
 
 DEPENDENCIES
   activesupport
-  hashie
-  httparty
+  i18n
+  nokogiri
   rake
   tvdbr!

data/README.md

@@ -8,7 +8,8 @@ Yes, there are a lot of libraries out there for this. I needed a few things that
   * An easy way to get all updates since a certain time, to keep our database synced
   * Easy helpers for accessing episodes from a series and the objects conceptually mapped to our existing schema.
 
-Please reference the [TVDB APIs](http://thetvdb.com/wiki/index.php?title=Programmers_API) to become familiar with the available actions and properties.
+Please reference the [TVDB APIs](http://thetvdb.com/wiki/index.php?title=Programmers_API) to 
+become familiar with the available actions and properties.
 
 ## Installation
 
@@ -24,10 +25,18 @@ Get a series based on the id:
 
     series = tvdb.find_series_by_id('1234')
 
+Get a series based on a remote (IMDB) id:
+
+    series = tvdb.find_series_by_remote_id('tt0290978')
+
 Get an episode based on the id:
 
     episode = tvdb.find_episode_by_id('5678')
 
+Get an episode based on the seriesid and airdate:
+
+    episode = tvdb.find_episode_by_airdate(80348, '2007-09-24')
+
 Fetch a series based on the title:
 
     dexter = tvdb.fetch_series_from_data(:title => "Dexter")
@@ -48,8 +57,8 @@ Get the episodes for a series:
 Get the updated series since a given timestamp:
 
     tvdb.each_updated_series(:since => 1.day.ago) do |series|
-       puts "#{series.id} - #{series.title}"
-     end
+      puts "#{series.id} - #{series.title}"
+    end
 
 Get the updated episodes since a given timestamp:
 
@@ -57,6 +66,14 @@ Get the updated episodes since a given timestamp:
       puts "#{episode.id} - #{episode.name} - #{episode.seriesid}"
     end
 
+You can also query using the newer static updates, by providing a 'period':
+
+    tvdb.each_updated_episode(:period => :day) do |episode|
+      puts "#{episode.id} - #{episode.name} - #{episode.seriesid}"
+    end
+
+You can provide `day`, `week`, or `month` to get complete data for that range of time.
+
 ## Known Issues
 
 * None so far, but the gem is very young.

data/examples/demo.rb

@@ -2,16 +2,16 @@ require 'rubygems'
 require 'tvdbr'
 require 'active_support/all'
 
-tvdb = Tvdbr::Client.new('YOUR_API_KEY')
+tvdb = Tvdbr::Client.new('5FEC454623154441')
 
 # Fetch series based on title and starring
 series_wrong = tvdb.fetch_series_from_data(:title => "Dexter",
-  :starring => "Adewale Akinnuoye-Agbaje, Sam Anderson, Naveen Andrews, L. Scott Caldwell, Nestor Carbonell, François Chau, Henry Ian Cusick, Jeremy Davies, Emilie de Ravin, Michael Emerson, Jeff Fahey, Fionnula Flanagan, Matthew Fox, Jorge Garcia, Maggie Grace, Josh Holloway, Malcolm David Kelley, Daniel Dae Kim, Yunjin Kim, Ken Leung, Evangeline Lilly, Rebecca Mader, Elizabeth Mitchell, Dominic Monaghan, Terry O'Quinn, Harold Perrineau, Zuleikha Robinson, Michelle Rodriguez, Kiele Sanchez,Rodrigo Santoro, Ian Somerhalder, John Terry, Sonya Walger, Cynthia Watros")
+  :starring => "Adewale Akinnuoye-Agbaje, Sam Anderson, Naveen Andrews, L. Scott Caldwell, Nestor Carbonell, Francois Chau, Henry Ian Cusick, Jeremy Davies, Emilie de Ravin, Michael Emerson, Jeff Fahey, Fionnula Flanagan, Matthew Fox, Jorge Garcia, Maggie Grace, Josh Holloway, Malcolm David Kelley, Daniel Dae Kim, Yunjin Kim, Ken Leung, Evangeline Lilly, Rebecca Mader, Elizabeth Mitchell, Dominic Monaghan, Terry O'Quinn, Harold Perrineau, Zuleikha Robinson, Michelle Rodriguez, Kiele Sanchez,Rodrigo Santoro, Ian Somerhalder, John Terry, Sonya Walger, Cynthia Watros")
 puts "Wrong Match: #{series_wrong.inspect}"
 
 # Fetch series based on title and starring
 series_right = tvdb.fetch_series_from_data(:title => "Lost",
-  :starring => "Adewale Akinnuoye-Agbaje, Sam Anderson, Naveen Andrews, L. Scott Caldwell, Nestor Carbonell, François Chau, Henry Ian Cusick, Jeremy Davies, Emilie de Ravin, Michael Emerson, Jeff Fahey, Fionnula Flanagan, Matthew Fox, Jorge Garcia, Maggie Grace, Josh Holloway, Malcolm David Kelley, Daniel Dae Kim, Yunjin Kim, Ken Leung, Evangeline Lilly, Rebecca Mader, Elizabeth Mitchell, Dominic Monaghan, Terry O'Quinn, Harold Perrineau, Zuleikha Robinson, Michelle Rodriguez, Kiele Sanchez,Rodrigo Santoro, Ian Somerhalder, John Terry, Sonya Walger, Cynthia Watros")
+  :starring => "Adewale Akinnuoye-Agbaje, Sam Anderson, Naveen Andrews, L. Scott Caldwell, Nestor Carbonell, Francois Chau, Henry Ian Cusick, Jeremy Davies, Emilie de Ravin, Michael Emerson, Jeff Fahey, Fionnula Flanagan, Matthew Fox, Jorge Garcia, Maggie Grace, Josh Holloway, Malcolm David Kelley, Daniel Dae Kim, Yunjin Kim, Ken Leung, Evangeline Lilly, Rebecca Mader, Elizabeth Mitchell, Dominic Monaghan, Terry O'Quinn, Harold Perrineau, Zuleikha Robinson, Michelle Rodriguez, Kiele Sanchez,Rodrigo Santoro, Ian Somerhalder, John Terry, Sonya Walger, Cynthia Watros")
 puts "Right Match: #{series_right.inspect}"
 
 puts "\n\n"
@@ -28,16 +28,16 @@ series.episodes.each do |e|
  puts e.name + " (S#{e.season_num}E#{e.episode_num})"
 end
 
- # Fetch series updates since given timestamp
- time = 10.minutes.ago
- results = tvdb.find_updates_since(time)
- puts "\n\nUpdated series since 10 mins ago: #{results[:series].size} series\n\n"
- tvdb.each_updated_series(:since => time) do |series|
-   puts "#{series.id} - #{series.title}"
- end
+# Fetch series updates since given timestamp
+time = 10.minutes.ago
+results = tvdb.find_updates_since(time)
+puts "\n\nUpdated series since 10 mins ago: #{results[:series].size} series\n\n"
+tvdb.each_updated_series(:since => time) do |series|
+ puts "#{series.id} - #{series.title}"
+end
 
- # Fetch episode udpates since given timestamp
- puts "\nUpdated episodes since 10 mins ago: #{results[:episodes].size} episodes\n\n"
- tvdb.each_updated_episode(:since => time) do |episode|
-   puts "#{episode.id} - #{episode.name} - #{episode.seriesid}"
- end
+# Fetch episode udpates since given timestamp
+puts "\nUpdated episodes since 10 mins ago: #{results[:episodes].size} episodes\n\n"
+tvdb.each_updated_episode(:since => time) do |episode|
+ puts "#{episode.id} - #{episode.name} - #{episode.seriesid}"
+end

data/examples/demo2.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'tvdbr'
+require 'active_support/all'
+
+# Updated APIs circa 10/05/2012
+tvdb = Tvdbr::Client.new('5FEC454623154441')
+
+# Find episode with airdate
+episode = tvdb.find_episode_by_airdate(80348, '2007-09-24')
+puts episode.inspect
+
+# Find with remote id
+series = tvdb.find_series_by_remote_id('tt0290978')
+puts series.inspect
+
+# Fetch using static updates instead of since
+# Fetch series updates since given timestamp
+results = tvdb.find_static_updates(:day)
+puts "\n\nUpdated series today: #{results[:series].size} series\n\n"
+tvdb.each_updated_series(:period => :day) do |series|
+ puts "#{series.id} - #{series.title}"
+end
+
+# Fetch episode udpates since given timestamp
+puts "\nUpdated episodes since 10 mins ago: #{results[:episodes].size} episodes\n\n"
+tvdb.each_updated_episode(:period => :day) do |episode|
+ puts "#{episode.id} - #{episode.name} - #{episode.seriesid}"
+end

data/lib/tvdbr.rb

@@ -1,4 +1,5 @@
 module Tvdbr
+  autoload :Retryable, 'tvdbr/retryable'
   autoload :Client,    'tvdbr/client'
   autoload :DataSet,   'tvdbr/data_set'
   autoload :Series,    'tvdbr/series'

data/lib/tvdbr/client.rb

@@ -6,6 +6,8 @@ module Tvdbr
     format :xml
     base_uri "http://www.thetvdb.com/api/"
 
+    attr_reader :api_key
+
     # Creates an instance of the TVDB interface
     # Tvdb.new('some_key')
     def initialize(api_key)
@@ -26,8 +28,9 @@ module Tvdbr
 
     # Yields the block for every updated series
     # tvdb.each_updated_series(:since => 1.day.ago) { |s| Media.find_by_tvdb_id(s.id).title = s.title }
+    # tvdb.each_updated_series(:period => :day) { |s| Media.find_by_tvdb_id(s.id).title = s.title }
     def each_updated_series(options={}, &block)
-      updates = self.find_updates_since(options[:since])
+      updates = options[:since] ? find_updates_since(options[:since]) : find_static_updates(options[:period])
       updates[:series].each do |series_id|
         series = self.find_series_by_id(series_id)
         block.call(series) if series && series.title
@@ -36,8 +39,9 @@ module Tvdbr
 
     # Yields the block for every updated episode
     # tvdb.each_updated_episode(:since => 1.day.ago) { |s| Episode.find_by_tvdb_id(s.id).title = s.title }
+    # tvdb.each_updated_episode(:period => :day) { |s| Episode.find_by_tvdb_id(s.id).title = s.title }
     def each_updated_episode(options={}, &block)
-      updates = self.find_updates_since(options[:since])
+      updates = options[:since] ? find_updates_since(options[:since]) : find_static_updates(options[:period])
       updates[:episodes].each do |episode_id|
         episode = self.find_episode_by_id(episode_id)
         block.call(episode) if episode && episode.name
@@ -52,7 +56,7 @@ module Tvdbr
       return [] if result.blank? || result['Series'].blank?
       result = result['Series'].is_a?(Array) ? result['Series'] : [result['Series']]
       result.first(5).map { |s| self.find_series_by_id(s['seriesid']) }
-    rescue StandardError => e
+    rescue MultiXml::ParseError => e
       puts "Result for title '#{title}' could not be parsed!"
       return []
     end
@@ -90,6 +94,25 @@ module Tvdbr
       Episode.new(self, result["Episode"])
     end
 
+    # Returns an Episode data by airdate
+    # tvdb.find_episode_by_airdate(80348, '2007-09-24')
+    def find_episode_by_airdate(series_id, airdate)
+      base_url = "/GetEpisodeByAirDate.php"
+      query_params = { :apikey => @api_key, :seriesid => series_id, :airdate => airdate  }
+      result = self.class.get(base_url, :query => query_params)['Data']
+      return nil unless result && result['Episode']
+      Episode.new(self, result['Episode'])
+    end
+
+    # Returns series data for a given series by specified remote id
+    # tvdb.find_series_by_remote_id('tt0290978', 'imdbid')
+    def find_series_by_remote_id(remote_id, remote_source="imdbid")
+      remote_base_url = "/GetSeriesByRemoteID.php"
+      result = self.class.get(remote_base_url, :query => { remote_source => remote_id })['Data']
+      return nil unless result && result['Series']
+      Series.new(self, result['Series'])
+    end
+
     # Returns the list of TVDB mirror_urls
     # => ["http://thetvdb.com", ...]
     def mirror_urls
@@ -107,7 +130,20 @@ module Tvdbr
     def find_updates_since(time)
       stamp = time.to_i # Get timestamp
       result = self.class.get("/Updates.php?type=all&time=#{stamp}")['Items']
-      { :series => result['Series'], :episodes => result['Episode'], :time => result['Time'] }
+      { :series => result['Series'],
+        :episodes => result['Episode'],
+        :time => result['Time'] }
+    end
+
+    # Returns static updates for the given period
+    # find_static_updates(:day) # :week or :month
+    # { :series => [1,2,3], :episodes => [1,2,3], :time => '<stamp>'  }
+    def find_static_updates(period)
+      update_url = "/updates/updates_#{period}.xml"
+      result = self.get_with_key(update_url)['Data']
+      { :series => result['Series'].map { |u| u["id"] },
+        :episodes => result['Episode'].map { |u| u["id"] },
+        :time => result['time'] }
     end
 
     protected
@@ -117,8 +153,10 @@ module Tvdbr
       def get_with_key(*args)
         args[0] = "/#{@api_key}/" + args[0]
         begin
-          self.class.get(*args)
-        rescue Exception => e
+          Tvdbr::Retryable.retry(:on => MultiXml::ParseError) do
+            self.class.get(*args).parsed_response
+          end
+        rescue Tvdbr::RetryableError => e
           { 'Data' => nil }
         end
       end
@@ -126,8 +164,8 @@ module Tvdbr
       # Checks if the api key works by retrieving mirrors
       def check_api_key!
         self.mirror_urls
-      rescue
-        raise "Please check your TVDB API Key!"
+      rescue Exception => e
+        raise "Please check your TVDB API Key, '#{self.api_key}' seems invalid!"
       end
   end
 end

data/lib/tvdbr/data_set.rb

@@ -1,4 +1,4 @@
-require 'Hashie' unless defined?(Hashie)
+require 'hashie' unless defined?(Hashie)
 
 module Tvdbr
   class DataSet < Hashie::Mash

data/lib/tvdbr/retryable.rb

@@ -0,0 +1,36 @@
+module Tvdbr
+  class RetryableError < StandardError; end
+  class Retryable
+    # Code originally by Chu Yeow, see
+    # http://blog.codefront.net/2008/01/14/retrying-code-blocks-in-ruby-on-exceptions-whatever/
+    # Slightly rewritten to allow for passing of more than just type of exception.
+    # retryable(:tries => 5, :on => Timeout::Error) do
+    #   open('http://example.com/flaky_api')
+    # end
+    #
+    # Tvdbr::Retryable.retry(:on => :timeout) { open('http://someplace.com/somefile.xml') }
+    # Tvdbr::Retryable.retry(:on => MultiXml::ParseError) { parse("some/xml") }
+    #
+    def self.retry( options = {}, &block )
+      opts = { :tries => 3, :on => Exception, :ignore => RetryableError, :log => false, :reraise => true }.merge(options)
+      return nil if opts[:tries] == 0
+      retry_exception, ignore_exception, tries = [ opts[:on] ].flatten, [ opts[:ignore] ].flatten, opts[:tries]
+
+      begin
+        return yield
+      rescue *retry_exception => e
+        puts "Error occurred - #{$!.class}: #{$!.message} [#{$!}], retrying..." if opts[:log]
+        if (tries -= 1) > 0 # more tries
+          retry
+        elsif opts[:reraise] # failed too many times, raise
+          raise RetryableError.new("#{e.to_s}: #{e.message} -- #{e.inspect}")
+        end
+      rescue *ignore_exception
+        puts "Ignored occurred - #{$!.class}: #{$!.message} [#{$!}], Ignoring..." if opts[:log]
+        return nil
+      end
+
+      yield
+    end
+  end
+end

data/lib/tvdbr/version.rb

@@ -1,3 +1,3 @@
 module Tvdbr
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/tvdbr.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "hashie"
-  s.add_dependency "httparty"
+  s.add_dependency "httparty", '>= 0.8.0'
   s.add_development_dependency "rake"
 end

metadata

@@ -1,76 +1,73 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tvdbr
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Miso
 - Nathan Esquenazi
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-30 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: hashie
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: httparty
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-description: Utilize the TVDB API from Ruby to fetch shows, track updates to the tvdb and sync your media database
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Utilize the TVDB API from Ruby to fetch shows, track updates to the tvdb
+  and sync your media database
+email:
 - nesquena@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
@@ -78,47 +75,39 @@ files:
 - README.md
 - Rakefile
 - examples/demo.rb
+- examples/demo2.rb
 - lib/tvdbr.rb
 - lib/tvdbr/client.rb
 - lib/tvdbr/data_set.rb
 - lib/tvdbr/episode.rb
+- lib/tvdbr/retryable.rb
 - lib/tvdbr/series.rb
 - lib/tvdbr/version.rb
 - spec/.gitkeep
 - tvdbr.gemspec
-has_rdoc: true
 homepage: https://github.com/bazaarlabs/tvdbr
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: tvdbr
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Use the TVDB API from Ruby
-test_files: 
+test_files:
 - spec/.gitkeep