thetvdb_api 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35bc99ae409ce0fdba0ddbdd73f4ac36efbd54a2
-  data.tar.gz: 26f99748d70ae7a86306f5f795013fe14c90c11e
+  metadata.gz: 85d1ce2f2bb54573fe303c0ec2bdf4c00c3ca8b0
+  data.tar.gz: 5fd366803383b832fe7ce43733ddbd2b9e6ee593
 SHA512:
-  metadata.gz: 159ee305365dc047e9312107e81168ccb9001492cfa2097b6efb25d5b34a45359d8ea4a042197dbf54e887c75e3a731715b75e6a12df547011205e355cb223c1
-  data.tar.gz: 4a2d708ed8cc0e28f70938cf948dd1fa17481dfc7a82bf41fbd9d90f52f893e85ed49a3e87b146bcfe348c6b71b621c5219659aefea9bbb8f50298ba2d004806
+  metadata.gz: 3ad836dd05a2e2936e516742d35c9c7ca3379190058878c38dcc0614b0b426857ee494bb8cfe5d100af97f0e423f18e8ce72b1369b74a605ac6d339b3c354f6e
+  data.tar.gz: 5727390c2cc4016737ce73be4ce21b529894082334d07f8cc97ccc7058ae234d9e1991529b8275fb5c12e42e604da54a5cc660911d17925543fb0269e85a59ff

data/README.md

@@ -41,7 +41,7 @@ client = ThetvdbApi::Client.new
 client.search.get_series('buffy')
 client.search.get_series_by_imdb_id('...')
 client.search.get_series_by_zap2it_id('...')
-client.search.get_episode_by_air_date('123', air_date)
+client.search.get_episode('123', air_date)
 ```
 
 Search series by id
@@ -86,6 +86,77 @@ client.update.month
 client.update.all
 ```
 
+ThetvdbApi return response class with pure xml (in body method) string fetched by Faraday, but it can be automatically mapped to Object. I have prepared some class for it which using happymapper gem. You should pass mapper options at the end of method arguments.
+
+```ruby
+require 'thetvdb_api/mappers/update'
+client = ThetvdbApi::Client.new
+client.update.day(mapper: ThetvdbApi::Mappers::Update)
+```
+
+## Mappers for:
+
+### Search
+```ruby
+require 'thetvdb_api/mappers/search_series'
+client = ThetvdbApi::Client.new
+client.search.get_series('buffy', mapper: ThetvdbApi::Mappers::SearchSeries)
+client.search.get_series_by_imdb_id('...', mapper: ThetvdbApi::Mappers::SearchSeries)
+client.search.get_series_by_zap2it_id('...', mapper: ThetvdbApi::Mappers::SearchSeries)
+```
+
+```ruby
+require 'thetvdb_api/mappers/search_episode'
+client = ThetvdbApi::Client.new
+client.search.get_episode('123', air_date, mapper: ThetvdbApi::Mappers::SearchEpisode)
+```
+
+### Series
+```ruby
+require 'thetvdb_api/mappers/series'
+client = ThetvdbApi::Client.new
+client.series.find('123', mapper: ThetvdbApi::Mappers::Series)
+```
+
+```ruby
+require 'thetvdb_api/mappers/full_series'
+client = ThetvdbApi::Client.new
+client.series.find_full('123', mapper: ThetvdbApi::Mappers::FullSeries)
+```
+
+### Actors
+```ruby
+require 'thetvdb_api/mappers/actors'
+client = ThetvdbApi::Client.new
+client.actor.all(series_id, mapper: ThetvdbApi::Mappers::Actors)
+```
+
+### Banners
+```ruby
+require 'thetvdb_api/mappers/banners'
+client = ThetvdbApi::Client.new
+client.banner.all(series_id, mapper: ThetvdbApi::Mappers::Banners)
+```
+
+### Episodes
+```ruby
+require 'thetvdb_api/mappers/episode'
+client = ThetvdbApi::Client.new
+client.episode.find_by_default_order(series_id, season, episode, mapper: ThetvdbApi::Mappers::Episode)
+client.episode.find_by_dvd_order(series_id, season, episode, mapper: ThetvdbApi::Mappers::Episode)
+client.episode.find_by_absolute_order(series_id, absolute, mapper: ThetvdbApi::Mappers::Episode)
+client.episode.find(episode_id, mapper: ThetvdbApi::Mappers::Episode)
+```
+
+### Updates
+```ruby
+require 'thetvdb_api/mappers/update'
+client = ThetvdbApi::Client.new
+client.update.day(mapper: ThetvdbApi::Mappers::Update)
+```
+
+You can write own mappers which parse xml and convert it to hash. Remember that your class must have "parse" class method.
+
 ## Contributing
 
 1. Fork it

data/lib/thetvdb_api.rb

@@ -1,7 +1,10 @@
-module ThetvdbApi; end
+module ThetvdbApi
+  module Mappers; end
+end
 
 require 'thetvdb_api/version'
 require 'thetvdb_api/configuration'
+require 'thetvdb_api/response'
 require 'thetvdb_api/client'
 require 'thetvdb_api/base'
 require 'thetvdb_api/search'

data/lib/thetvdb_api/actor.rb

@@ -1,5 +1,5 @@
 class ThetvdbApi::Actor < ThetvdbApi::Base
-  def find(series_id)
-    get("#{series_uri}/actors.xml").params(series_id: series_id).response
+  def find(series_id, options = {})
+    get("#{series_uri}/actors.xml").params({ series_id: series_id }.merge(options)).response
   end
 end

data/lib/thetvdb_api/banner.rb

@@ -1,5 +1,5 @@
 class ThetvdbApi::Banner < ThetvdbApi::Base
-  def find(series_id)
-    get("#{series_uri}/banners.xml").params(series_id: series_id).response
+  def find(series_id, options = {})
+    get("#{series_uri}/banners.xml").params({ series_id: series_id }.merge(options)).response
   end
 end

data/lib/thetvdb_api/base.rb

@@ -1,33 +1,40 @@
-require 'httparty'
+require 'faraday'
 require 'uri_template'
 
 class ThetvdbApi::Base
-  include HTTParty
-  base_uri 'http://thetvdb.com/api/'
-
   def initialize(client)
     @client = client
     @params = {}
+    @mapper = nil
+  end
+
+  def connection
+    @connection ||= Faraday.new(url: base_url)
   end
 
   def get(uri)
     @uri_template = URITemplate.new(uri)
-
     self
   end
 
   def params(options)
-    @params = options
-
+    @mapper = options.delete(:mapper)
+    @params = { language: @client.language }.merge(options)
     self
   end
 
   def response
-    @uri_template ? self.class.get(uri, body: @options) : nil
+    assert_uri_template
+    ThetvdbApi::Response.new(connection.get(uri, @options), @mapper)
   end
 
   def prepare_uri
-    @uri_template ? @uri_template.expand(@params.merge(api_key: @client.api_key)) : nil
+    assert_uri_template
+    @uri_template.expand(@params.merge(api_key: api_key))
+  end
+
+  def url
+    "#{base_url}#{uri}"
   end
 
   def uri
@@ -49,4 +56,18 @@ class ThetvdbApi::Base
   def language
     @client.language
   end
+
+  def api_key
+    @client.api_key
+  end
+
+  private
+
+  def assert_uri_template
+    raise "Path doesn't exists, use get(path) to setup path for request" unless @uri_template
+  end
+
+  def base_url
+    'http://thetvdb.com/api/'
+  end
 end

data/lib/thetvdb_api/episode.rb

@@ -1,23 +1,23 @@
 class ThetvdbApi::Episode < ThetvdbApi::Base
-  def find_by_default_order(series_id, season, episode, language = self.language)
-    find_by_order('default', series_id, season, episode, language)
+  def find_by_default_order(series_id, season, episode, options = {})
+    find_by_order('default', series_id, season, episode, options)
   end
 
-  def find_by_dvd_order(series_id, season, episode, language = self.language)
-    find_by_order('dvd', series_id, season, episode, language)
+  def find_by_dvd_order(series_id, season, episode, options = {})
+    find_by_order('dvd', series_id, season, episode, options)
   end
 
-  def find_by_absolute_order(series_id, absolute, language = self.language)
+  def find_by_absolute_order(series_id, absolute, options = {})
     get("#{series_uri}/absolute/{absolute}/{language}.xml").
-      params(series_id: series_id, absolute: absolute, language: language).response
+      params({ series_id: series_id, absolute: absolute }.merge(options)).response
   end
 
-  def find(episode_id, language = self.language)
-    get("{api_key}/episodes/{episode_id}/{language}.xml").params(episode_id: episode_id, language: language).response
+  def find(episode_id, options = {})
+    get("{api_key}/episodes/{episode_id}/{language}.xml").params({ episode_id: episode_id }.merge(options)).response
   end
 
-  def find_by_order(order, series_id, season, episode, language)
+  def find_by_order(order, series_id, season, episode, options)
     get("#{series_uri}/{order}/{season}/{episode}/{language}.xml").
-      params(series_id: series_id, season: season, episode: episode, language: language, order: order).response
+      params({ series_id: series_id, season: season, episode: episode, order: order }.merge(options)).response
   end
 end

data/lib/thetvdb_api/mappers/actor.rb

@@ -0,0 +1,17 @@
+require 'happymapper'
+
+class ThetvdbApi::Mappers::Actor
+  include HappyMapper
+
+  tag 'Actor'
+
+  element :id, Integer
+  element :image_path, String, tag: 'Image'
+  element :name, String, tag: 'Name'
+  element :role, String, tag: 'Role'
+  element :sort_order, Integer, tag: 'SortOrder'
+
+  def image_url
+    image_path ? "http://thetvdb.com/banners/#{image_path}" : nil
+  end
+end

data/lib/thetvdb_api/mappers/actors.rb

@@ -0,0 +1,10 @@
+require 'happymapper'
+require 'thetvdb_api/mappers/actor'
+
+class ThetvdbApi::Mappers::Actors
+  include HappyMapper
+
+  tag 'Actors'
+
+  has_many :actors, ThetvdbApi::Mappers::Actor, tag: 'Actor'
+end

data/lib/thetvdb_api/mappers/banner.rb

@@ -0,0 +1,32 @@
+require 'happymapper'
+
+class ThetvdbApi::Mappers::Banner
+  include HappyMapper
+
+  tag 'Banner'
+
+  element :id, Integer
+  element :path, String, tag: 'BannerPath'
+  element :thumbnail_path, String, tag: 'ThumbnailPath'
+  element :vignette_path, String, tag: 'VignettePath'
+  element :type, String, tag: 'BannerType'
+  element :type2, String, tag: 'BannerType2'
+  element :language, String, tag: 'Language'
+  element :season, Integer, tag: 'Season'
+  element :rating, Float, tag: 'Rating'
+  element :rating_count, Integer, tag: 'RatingCount'
+  element :series_name, String, tag: 'SeriesName'
+  element :colors, String, tag: 'Colors'
+
+  def url
+    path ? "http://thetvdb.com/banners/#{path}" : nil
+  end
+
+  def thumbnail_url
+    thumbnail_path ? "http://thetvdb.com/banners/#{thumbnail_path}" : nil
+  end
+
+  def vignette_url
+    vignette_path ? "http://thetvdb.com/banners/#{vignette_path}" : nil
+  end
+end

data/lib/thetvdb_api/mappers/banners.rb

@@ -0,0 +1,10 @@
+require 'happymapper'
+require 'thetvdb_api/mappers/banner'
+
+class ThetvdbApi::Mappers::Banners
+  include HappyMapper
+
+  tag 'Banners'
+
+  has_many :banners, ThetvdbApi::Mappers::Banner, tag: 'Banner'
+end

data/lib/thetvdb_api/mappers/base.rb

@@ -0,0 +1,13 @@
+require 'happymapper'
+
+class ThetvdbApi::Mappers::Base
+  include HappyMapper
+
+  element :id, Integer
+  element :first_aired, Date, tag: 'FirstAired'
+  element :imdb_id, String, tag: 'IMDB_ID'
+  element :language, String, tag: 'Language'
+  element :overview, String, tag: 'Overview'
+  element :rating, Float, tag: 'Rating'
+  element :rating_count, Integer, tag: 'RatingCount'
+end

data/lib/thetvdb_api/mappers/episode.rb

@@ -0,0 +1,32 @@
+require 'happymapper'
+require 'base'
+
+class ThetvdbApi::Mappers::Episode < ThetvdbApi::Mappers::Base
+  tag 'Episode'
+
+  element :combined_episode_number, Integer, tag: 'Combined_episodenumber'
+  element :combined_season, Integer, tag: 'Combined_season'
+  element :dvd_chapter, String, tag: 'DVD_chapter'
+  element :dvd_discid, String, tag: 'DVD_discid'
+  element :dvd_episodenumber, String, tag: 'DVD_episodenumber'
+  element :dvd_season, String, tag: 'DVD_season'
+  element :director, String, tag: 'Director'
+  element :ep_img_flag, Integer, tag: 'EpImgFlag'
+  element :name, String, tag: 'EpisodeName'
+  element :number, String, tag: 'EpisodeNumber'
+  element :guest_stars, String, tag: 'GuestStars'
+  element :production_code, String, tag: 'ProductionCode'
+  element :season_number, Integer, tag: 'SeasonNumber'
+  element :writer, String, tag: 'Writer'
+  element :absolute_number, Integer
+  element :airs_after_season, Integer, tag: 'airsafter_season'
+  element :airs_before_episode, Integer, tag: 'airsbefore_episode'
+  element :airs_before_season, Integer, tag: 'airsbefore_season'
+  element :filename, String
+  element :last_updated_timestamp, Integer, tag: 'lastupdated'
+  element :season_id, Integer, tag: 'seasonid'
+  element :series_id, Integer, tag: 'seriesid'
+  element :thumb_added_at, Time, tag: 'thumb_added'
+  element :thumb_height, Integer
+  element :thumb_width, Integer
+end

data/lib/thetvdb_api/mappers/full_series.rb

@@ -0,0 +1,12 @@
+require 'happymapper'
+require 'thetvdb_api/mappers/episode'
+require 'thetvdb_api/mappers/series'
+
+class ThetvdbApi::Mappers::FullSeries
+  include HappyMapper
+
+  tag 'Data'
+
+  element :series, ThetvdbApi::Mappers::Series, tag: 'Series'
+  has_many :episodes, ThetvdbApi::Mappers::Episode, tag: 'Episodes'
+end

data/lib/thetvdb_api/mappers/search_episode.rb

@@ -0,0 +1,10 @@
+require 'happymapper'
+require 'episode'
+
+class ThetvdbApi::Mappers::SearchEpisode
+  include HappyMapper
+
+  tag 'Data'
+
+  has_many :series, ThetvdbApi::Mappers::Episode, tag: 'Episode'
+end

data/lib/thetvdb_api/mappers/search_series.rb

@@ -0,0 +1,10 @@
+require 'happymapper'
+require 'search_series/series'
+
+class ThetvdbApi::Mappers::SearchSeries
+  include HappyMapper
+
+  tag 'Data'
+
+  has_many :series, ThetvdbApi::Mappers::SearchSeries::Series, tag: 'Series'
+end

data/lib/thetvdb_api/mappers/search_series/series.rb

@@ -0,0 +1,25 @@
+require 'happymapper'
+
+class ThetvdbApi::Mappers::SearchSeries
+  class Series
+    include HappyMapper
+
+    tag 'Series'
+
+    element :id, Integer
+    element :series_id, Integer, tag: 'seriesid'
+    element :language, String
+    element :name, String, tag: 'SeriesName'
+    element :aliases, String, tag: 'AliasNames'
+    element :banner_path, String, tag: 'banner'
+    element :overview, String, tag: 'Overview'
+    element :first_aired, Date
+    element :imdb_id, String, tag: 'IMDB_ID'
+    element :zap2it_id, String
+    element :network, String, tag: 'Network'
+
+    def banner_url
+      banner_path ? "http://thetvdb.com/banners/#{banner_path}" : nil
+    end
+  end
+end

data/lib/thetvdb_api/mappers/series.rb

@@ -0,0 +1,37 @@
+require 'happymapper'
+require 'base'
+
+class ThetvdbApi::Mappers::Series < ThetvdbApi::Mappers::Base
+  tag 'Series'
+
+  element :actors, String, tag: 'Actors'
+  element :airs_day_of_week, String, tag: 'Airs_DayOfWeek'
+  element :airs_time, String, tag: 'Airs_Time'
+  element :content_rating, String, tag: 'ContentRating'
+  element :genres, String, tag: 'Genre'
+  element :network, String, targ: 'Network'
+  element :network_id, Integer, targ: 'NetworkID'
+  element :runtime, Integer, tag: 'Runtime'
+  element :series_id, Integer, tag: 'SeriesID'
+  element :name, String, tag: 'SeriesName'
+  element :status, String, tag: 'Status'
+  element :added_at, Time, tag: 'added'
+  element :added_by, Integer, tag: 'adddedBy'
+  element :banner_path, String, tag: 'banner'
+  element :fanart_path, String, tag: 'fanart'
+  element :last_updated_timestamp, Integer, tag: 'lastupdated'
+  element :poster_path, String, tag: 'posters'
+  element :zap2it_id, String
+
+  def banner_url
+    banner_path ? "http://thetvdb.com/banners/#{banner_path}" : nil
+  end
+
+  def fanart_url
+    fanart_path ? "http://thetvdb.com/banners/#{fanart_path}" : nil
+  end
+
+  def poster_url
+    poster_path ? "http://thetvdb.com/banners/#{poster_path}" : nil
+  end
+end