Class: Tvdbr::Client

Inherits:
Object
  • Object
show all
Includes:
HTTParty
Defined in:
lib/tvdbr/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key) ⇒ Client

Creates an instance of the TVDB interface Tvdb.new(‘some_key’)



13
14
15
16
 
# File 'lib/tvdbr/client.rb', line 13

def initialize(api_key)
  @api_key = api_key
  check_api_key!
end

Instance Attribute Details

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



9
10
11
 
# File 'lib/tvdbr/client.rb', line 9

def api_key
  @api_key
end

Instance Method Details

Returns a list of image locations for the series



123
124
125
 
# File 'lib/tvdbr/client.rb', line 123

def banner_urls(series_id)
  self.get_with_key("/series/#{series_id}/banners.xml")['Banners']['Banner']
end

#each_updated_episode(options = {}, &block) ⇒ Object

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 }



43
44
45
46
47
48
49
 
# File 'lib/tvdbr/client.rb', line 43

def each_updated_episode(options={}, &block)
  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
  end if updates[:episodes].respond_to?(:each)
end

#each_updated_series(options = {}, &block) ⇒ Object

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 }



32
33
34
35
36
37
38
 
# File 'lib/tvdbr/client.rb', line 32

def each_updated_series(options={}, &block)
  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
  end if updates[:series].respond_to?(:each)
end

#fetch_series_from_data(options = {}) ⇒ Object

Fetches a series object based on the given attributes hash tvdb.fetch_series_from_data(:title => “Dexter”, :kind => “TvShow”, :starring => “xxxx, xxxx”)

> { “SeriesName” => “Dexter”, … } or nil



22
23
24
25
26
27
 
# File 'lib/tvdbr/client.rb', line 22

def fetch_series_from_data(options={})
  return self.find_series_by_title(options[:title]) if options[:starring].nil?
  series_results = self.find_all_series_by_title(options[:title])
  expected_actors = options[:starring].split(",")
  series_results.compact.find { |series| series.actor_match?(expected_actors) }
end

#find_all_series_by_title(title) ⇒ Object

Returns all series matching the given title tvdb.find_all_series_by_title(“Dexter”)

> [{ “SeriesName” => “Dexter”, … }, …]



54
55
56
57
58
59
60
61
62
 
# File 'lib/tvdbr/client.rb', line 54

def find_all_series_by_title(title)
  result = self.class.get("/GetSeries.php", :query => { :seriesname => title, :language => "en" })['Data']
  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 MultiXml::ParseError => e
  puts "Result for title '#{title}' could not be parsed!"
  return []
end

#find_episode_by_airdate(series_id, airdate) ⇒ Object

Returns an Episode data by airdate tvdb.find_episode_by_airdate(80348, ‘2007-09-24’)



99
100
101
102
103
104
105
 
# File 'lib/tvdbr/client.rb', line 99

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

#find_episode_by_id(episode_id, options = {}) ⇒ Object

Returns Episode data for a given episode id tvdb.find_episode_by_id(12345) tvdb.find_episode_by_id(12345, :raw => true)



89
90
91
92
93
94
95
 
# File 'lib/tvdbr/client.rb', line 89

def find_episode_by_id(episode_id, options={})
  episode_url = "/episodes/#{episode_id}"
  result = self.get_with_key(episode_url)['Data']
  return nil unless result && result['Episode']
  return result["Episode"] if options[:raw]
  Episode.new(self, result["Episode"])
end

#find_series_by_id(series_id, options = {}) ⇒ Object

Returns series data for a given series_id tvdb.find_series_by_id(1234, :all => true) tvdb.find_series_by_id(1234, :raw => true)



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/tvdbr/client.rb', line 75

def find_series_by_id(series_id, options={})
  series_url = "/series/#{series_id}"
  series_url << "/all" if options[:all]
  series_url << "/en.xml"
  result = self.get_with_key(series_url)['Data']
  return nil unless result && result['Series']
  return result if options[:all]
  return result["Series"] if options[:raw]
  Series.new(self, result["Series"])
end

#find_series_by_remote_id(remote_id, remote_source = "imdbid") ⇒ Object

Returns series data for a given series by specified remote id tvdb.find_series_by_remote_id(‘tt0290978’, ‘imdbid’)



109
110
111
112
113
114
 
# File 'lib/tvdbr/client.rb', line 109

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

#find_series_by_title(title) ⇒ Object

Returns the first series returned for a title tvdb.find_series_by_title(“Dexter”)

> { “SeriesName” => “Dexter”, … }



68
69
70
 
# File 'lib/tvdbr/client.rb', line 68

def find_series_by_title(title)
  self.find_all_series_by_title(title).first
end

#find_static_updates(period) ⇒ Object

Returns static updates for the given period find_static_updates(:day) # :week or :month { :series => [1,2,3], :episodes => [1,2,3], :time => ‘<stamp>’ }



141
142
143
144
145
146
147
 
# File 'lib/tvdbr/client.rb', line 141

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

#find_updates_since(time) ⇒ Object

Returns a list of series and episode updates since given time tvdb.find_updates_since(1.day.ago)

> { :series => [1,2,3], :episodes => [1,2,3], :time => ‘<stamp>’ }



130
131
132
133
134
135
136
 
# File 'lib/tvdbr/client.rb', line 130

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'] }
end

#mirror_urls ⇒ Object

Returns the list of TVDB mirror_urls

> [“thetvdb.com”, …]



118
119
120
 
# File 'lib/tvdbr/client.rb', line 118

def mirror_urls
  Array(self.get_with_key('/mirrors.xml')['Mirrors']['Mirror']['mirrorpath'])
end