thetvdb_api 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3908d0d6811769c9845cbef26aee2de5adb3059e
-  data.tar.gz: 29b3329554f2171c9e2c98fdc0c3b731cc7f3728
+  metadata.gz: 1dcc91a8222745749a555d5d963c6eaad2d2acad
+  data.tar.gz: 5eec6981bd50bac65fa2c0e2e6d051b4e0187249
 SHA512:
-  metadata.gz: dfea95ba9b1391d05a56e5ed61a7ecc8a1f0eb0d8f3dac102a89b52cb7e95b89b1c528d303562b7bea59f823990a0439cb039cbc4195099f9843fc0fa1e56e83
-  data.tar.gz: 5ef3fa81e626b31cf682a52396271a1640bf5b361d7b4463a1e2e5a5501e26d792e49864a8b93102c095fa27d247c5600eac370c7e24e29d3b8e48cb7a3683c6
+  metadata.gz: a3916560f299474f0964c79bde37783883793db4c7f8476510ef31e1515f00d1fd232e67b33ef807c6c4d337b6634d6a869b708f45b5a3d63c0f4596c49b9e08
+  data.tar.gz: 6594ba567f59510b6cb138fa7db45549c5261c5c892134aa10206730aa997c2e450faae0bddcdd0c85749d8a54176f11c14e2f41e05319ad7cbf7c5832bb62a9

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
-script: 'bundle exec rspec spec/thetvdb_api'
+script: 'bundle exec rspec spec/units'
 rvm:
   - 2.0.0

data/README.md

@@ -38,124 +38,79 @@ Search series by name
 
 ```ruby
 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('123', air_date)
+client.search.get_series('buffy', options = {})
+client.search.get_series_url('buffy', options = {}) # return only full url
+client.search.get_series_by_imdb_id(id, options = {})
+client.search.get_series_by_imdb_id_url(id, options = {}) # return only full url
+client.search.get_series_by_zap2it_id(id)
+client.search.get_series_by_zap2it_id_url(id, options = {}) # return only full url
+client.search.get_episode('123', air_date, options = {})
+client.search.get_episode_url('123', air_date, options = {}) # return only full url
 ```
 
 Search series by id
 
 ```ruby
 client = ThetvdbApi::Client.new
-client.series.find('123')
-client.series.find_full('123')
+client.series.find('123', options = {})
+client.series.find_url('123', options = {}) # return only full url
+client.series.find_full('123', options = {})
+client.series.find_full_url('123', options = {}) # return only full url
 ```
 
 Return series actors
 
 ```ruby
 client = ThetvdbApi::Client.new
-client.actor.all(series_id)
+client.actor.all(series_id, options = {})
+client.actor.all_url(series_id, options = {}) # return only full url
 ```
 
 Return series banners
 
 ```ruby
 client = ThetvdbApi::Client.new
-client.banner.all(series_id)
+client.banner.all(series_id, options = {})
+client.banner.all_url(series_id, options = {}) # return only full url
 ```
 
 Return series episode
 
 ```ruby
 client = ThetvdbApi::Client.new
-client.episode.find_by_default_order(series_id, season, episode)
-client.episode.find_by_dvd_order(series_id, season, episode)
-client.episode.find_by_absolute_order(series_id, absolute)
-client.episode.find(episode_id)
+client.episode.find_by_default_order(series_id, season, episode, options = {})
+client.episode.find_by_default_order_url(series_id, season, episode, options = {}) # return only full url
+client.episode.find_by_dvd_order(series_id, season, episode, options = {})
+client.episode.find_by_dvd_order_url(series_id, season, episode, options = {}) # return only full url
+client.episode.find_by_absolute_order(series_id, absolute, options = {})
+client.episode.find_by_absolute_order_url(series_id, absolute, options = {}) # return only full url
+client.episode.find(episode_id, options = {})
+client.episode.find_url(episode_id, options = {}) # return only full url
 ```
 
 Get updates
 
 ```ruby
 client = ThetvdbApi::Client.new
-client.update.day
-client.update.week
-client.update.month
-client.update.all
+client.update.day(options = {})
+client.update.day_url(options = {}) # return only full url
+client.update.week(options = {})
+client.update.week_url(options = {}) # return only full url
+client.update.month(options = {})
+client.update.month_url(options = {}) # return only full url
+client.update.all(options = {})
+client.update.all_url(options = {}) # return only full url
 ```
 
-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.
+ThetvdbApi default return response class with pure xml (in body method) string fetched by Faraday. You can pass
 
 ```ruby
-require 'thetvdb_api/mappers/update'
-client = ThetvdbApi::Client.new
-client.update.day(mapper: ThetvdbApi::Mappers::Update)
+mapping: true
 ```
 
-## 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)
-```
+options, and ThetvdbApi will return hash/array objects.
 
-You can write own mappers which parse xml and convert it to hash. Remember that your class must have "parse" class method.
+ThetvdbApi give you chance to write own mapper where mapping preformance could be better.
 
 ## Contributing
 

data/lib/thetvdb_api/actor.rb

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

data/lib/thetvdb_api/banner.rb

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

data/lib/thetvdb_api/base.rb

@@ -5,7 +5,7 @@ class ThetvdbApi::Base
   def initialize(client)
     @client = client
     @params = {}
-    @mapper = nil
+    @mapping = false
   end
 
   def connection
@@ -18,14 +18,14 @@ class ThetvdbApi::Base
   end
 
   def params(options)
-    @mapper = options.delete(:mapper)
+    @mapping = options.delete(:mapping)
     @params = { language: @client.language }.merge(options)
     self
   end
 
-  def response
+  def response(klass = ThetvdbApi::Response)
     assert_uri_template
-    ThetvdbApi::Response.new(connection.get(uri, @options), @mapper)
+    klass.new(connection.get(uri, @params), @mapping)
   end
 
   def prepare_uri

data/lib/thetvdb_api/episode.rb

@@ -3,21 +3,66 @@ class ThetvdbApi::Episode < ThetvdbApi::Base
     find_by_order('default', series_id, season, episode, options)
   end
 
+  def find_by_default_order_url(series_id, season, episode, options = {})
+    find_by_order_url('default', series_id, season, episode, options)
+  end
+
   def find_by_dvd_order(series_id, season, episode, options = {})
     find_by_order('dvd', series_id, season, episode, options)
   end
 
+  def find_by_dvd_order_url(series_id, season, episode, options = {})
+    find_by_order_url('dvd', series_id, season, episode, options)
+  end
+
   def find_by_absolute_order(series_id, absolute, options = {})
-    get("#{series_uri}/absolute/{absolute}/{language}.xml").
-      params({ series_id: series_id, absolute: absolute }.merge(options)).response
+    find_by_absolute_order_get_with_params(series_id, absolute, options).response(ThetvdbApi::Response::Episode)
+  end
+
+  def find_by_absolute_order_url(series_id, absolute, options = {})
+    find_by_absolute_order_get_with_params(series_id, absolute, options).url
+  end
+
+  def find_by_absolute_order_get_with_params(series_id, absolute, options)
+    get(find_by_absolute_order_path).params({ series_id: series_id, absolute: absolute }.merge(options))
   end
 
   def find(episode_id, options = {})
-    get("{api_key}/episodes/{episode_id}/{language}.xml").params({ episode_id: episode_id }.merge(options)).response
+    find_get_with_params(episode_id, options).response(ThetvdbApi::Response::Episode)
+  end
+
+  def find_url(episode_id, options = {})
+    find_get_with_params(episode_id, options).url
+  end
+
+  def find_get_with_params(episode_id, options)
+    get(find_path).params({ episode_id: episode_id }.merge(options))
   end
 
   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, order: order }.merge(options)).response
+    find_by_order_get_with_params(order, series_id, season, episode, options).response(ThetvdbApi::Response::Episode)
+  end
+
+  def find_by_order_url(order, series_id, season, episode, options)
+    find_by_order_get_with_params(order, series_id, season, episode, options).url
+  end
+
+  def find_by_order_get_with_params(order, series_id, season, episode, options)
+    get(find_by_order_path).
+      params({ series_id: series_id, season: season, episode: episode, order: order }.merge(options))
+  end
+
+  private
+
+  def find_by_absolute_order_path
+    "#{series_uri}/absolute/{absolute}/{language}.xml"
+  end
+
+  def find_path
+    '{api_key}/episodes/{episode_id}/{language}.xml'
+  end
+
+  def find_by_order_path
+    "#{series_uri}/{order}/{season}/{episode}/{language}.xml"
   end
 end

data/lib/thetvdb_api/response/actors.rb

@@ -0,0 +1,7 @@
+class ThetvdbApi::Response::Actors < ThetvdbApi::Response
+  include ThetvdbApi::Response::Collection
+
+  def xml_parse
+    multi_xml_parse.fetch('Actors', {}).fetch('Actor', [])
+  end
+end

data/lib/thetvdb_api/response/banners.rb

@@ -0,0 +1,7 @@
+class ThetvdbApi::Response::Banners < ThetvdbApi::Response
+  include ThetvdbApi::Response::Collection
+
+  def xml_parse
+    multi_xml_parse.fetch('Banners', {}).fetch('Banner', [])
+  end
+end

data/lib/thetvdb_api/response/collection.rb

@@ -0,0 +1,9 @@
+module ThetvdbApi::Response::Collection
+  def body
+    @body ||= if @mapping
+      parse.is_a?(Array) ? parse : [parse]
+    else
+      @faraday_response.body
+    end
+  end
+end

data/lib/thetvdb_api/response/episode.rb

@@ -0,0 +1,5 @@
+class ThetvdbApi::Response::Episode < ThetvdbApi::Response
+  def xml_parse
+    multi_xml_parse.fetch('Episode', {})
+  end
+end

data/lib/thetvdb_api/response/full_series.rb

@@ -0,0 +1,21 @@
+class ThetvdbApi::Response::FullSeries < ThetvdbApi::Response
+  def parse
+    unless @parse
+      @parse = xml_parse
+      episode_normalize
+    end
+    @parse
+  end
+
+  def xml_parse
+    multi_xml_parse.fetch('Data', {})
+  end
+
+  def episode_normalize
+    normalize('Episode')
+  end
+
+  def normalize(key)
+    @parse[key] = [@parse[key]] if @parse[key].is_a?(Hash)
+  end
+end

data/lib/thetvdb_api/response/search_multiple_episode.rb

@@ -0,0 +1,7 @@
+class ThetvdbApi::Response::SearchMultipleEpisode < ThetvdbApi::Response
+  include ThetvdbApi::Response::Collection
+
+  def xml_parse
+    multi_xml_parse.fetch('Data', {}).fetch('Episode', [])
+  end
+end

data/lib/thetvdb_api/response/search_multiple_series.rb

@@ -0,0 +1,7 @@
+class ThetvdbApi::Response::SearchMultipleSeries < ThetvdbApi::Response
+  include ThetvdbApi::Response::Collection
+
+  def xml_parse
+    multi_xml_parse.fetch('Data', {}).fetch('Series', [])
+  end
+end

data/lib/thetvdb_api/response/search_series.rb

@@ -0,0 +1,5 @@
+class ThetvdbApi::Response::SearchSeries < ThetvdbApi::Response
+  def xml_parse
+    multi_xml_parse.fetch('Data', {}).fetch('Series', {})
+  end
+end

data/lib/thetvdb_api/response/series.rb

@@ -0,0 +1,5 @@
+class ThetvdbApi::Response::Series < ThetvdbApi::Response
+  def xml_parse
+    multi_xml_parse.fetch('Series', {})
+  end
+end

data/lib/thetvdb_api/response/update.rb

@@ -0,0 +1,31 @@
+class ThetvdbApi::Response::Update < ThetvdbApi::Response
+  def parse
+    unless @parse
+      @parse = xml_parse
+      series_normalize
+      episode_normalize
+      banner_normalize
+    end
+    @parse
+  end
+
+  def xml_parse
+    multi_xml_parse.fetch('Data', {})
+  end
+
+  def series_normalize
+    normalize('Series')
+  end
+
+  def episode_normalize
+    normalize('Episode')
+  end
+
+  def banner_normalize
+    normalize('Banner')
+  end
+
+  def normalize(key)
+    @parse[key] = [@parse[key]] if @parse[key].is_a?(Hash)
+  end
+end

data/lib/thetvdb_api/response.rb

@@ -1,11 +1,9 @@
+require 'multi_xml'
+
 class ThetvdbApi::Response
-  def initialize(faraday_response, mapper = nil)
+  def initialize(faraday_response, mapping = false)
     @faraday_response = faraday_response
-    @mapper = mapper
-  end
-
-  def mapper
-    @mapper
+    @mapping = mapping
   end
 
   def env
@@ -21,10 +19,34 @@ class ThetvdbApi::Response
   end
 
   def body
-    @body ||= @mapper ? @mapper.parse(@faraday_response.body) : @faraday_response.body
+    @body ||= @mapping ? parse : @faraday_response.body
   end
 
   def inspect
-    "<ThetvdbApi::Response body=#{body.inspect}, mapper=#{mapper.inspect}>"
+    body.inspect
+  end
+
+  def [](key)
+    parse[key]
+  end
+
+  def []=(key, value)
+    parse[key] = value
+  end
+
+  def each(&block)
+    parse.each(&block)
+  end
+
+  def multi_xml_parse
+    MultiXml.parse(@faraday_response.body)
+  end
+
+  def xml_parse
+    multi_xml_parse
+  end
+
+  def parse
+    @parse ||= xml_parse
   end
 end

data/lib/thetvdb_api/search.rb

@@ -1,17 +1,63 @@
 class ThetvdbApi::Search < ThetvdbApi::Base
   def get_series(name, options = {})
-    get('GetSeries.php').params({ seriesname: name }.merge(options)).response
+    get_series_get_with_params(name, options).response(ThetvdbApi::Response::SearchMultipleSeries)
+  end
+
+  def get_series_url(name, options = {})
+    get_series_get_with_params(name, options).url
+  end
+
+  def get_series_get_with_params(name, options)
+    get(get_series_path).params({ seriesname: name }.merge(options))
   end
 
   def get_series_by_imdb_id(id, options = {})
-    get('GetSeriesByRemoteID.php').params({ imdbid: id }.merge(options)).response
+    get_series_by_imdb_id_get_with_params(id, options).response(ThetvdbApi::Response::SearchSeries)
+  end
+
+  def get_series_by_imdb_id_url(id, options = {})
+    get_series_by_imdb_id_get_with_params(id, options).url
+  end
+
+  def get_series_by_imdb_id_get_with_params(id, options)
+    get(get_series_by_remote_id_path).params({ imdbid: id }.merge(options))
   end
 
   def get_series_by_zap2it_id(id, options = {})
-    get('GetSeriesByRemoteID.php').params({ zap2it: id }.merge(options)).response
+    get_series_by_zap2it_id_get_with_params(id, options).response(ThetvdbApi::Response::SearchSeries)
+  end
+
+  def get_series_by_zap2it_id_url(id, options = {})
+    get_series_by_zap2it_id_get_with_params(id, options).url
+  end
+
+  def get_series_by_zap2it_id_get_with_params(id, options)
+    get(get_series_by_remote_id_path).params({ zap2it: id }.merge(options))
   end
 
   def get_episode(series_id, air_date, options = {})
-    get('GetEpisodeByAirDate.php').params({ seriesid: series_id, airdate: air_date }.merge(options)).response
+    get_episode_get_with_params(series_id, air_date, options).response(ThetvdbApi::Response::SearchMultipleEpisode)
+  end
+
+  def get_episode_url(series_id, air_date, options = {})
+    get_episode_get_with_params(series_id, air_date, options).url
+  end
+
+  def get_episode_get_with_params(series_id, air_date, options)
+    get(get_episode_path).params({ seriesid: series_id, airdate: air_date }.merge(options))
+  end
+
+  private
+
+  def get_series_path
+    'GetSeries.php'
+  end
+
+  def get_series_by_remote_id_path
+    'GetSeriesByRemoteID.php'
+  end
+
+  def get_episode_path
+    'GetEpisodeByAirDate.php'
   end
 end

data/lib/thetvdb_api/series.rb

@@ -1,9 +1,35 @@
 class ThetvdbApi::Series < ThetvdbApi::Base
   def find(series_id, options = {})
-    get("#{series_uri}/{language}.xml").params({ series_id: series_id }.merge(options)).response
+    find_get_with_params(series_id, options).response(ThetvdbApi::Response::Series)
+  end
+
+  def find_url(series_id, options = {})
+    find_get_with_params(series_id, options).url
+  end
+
+  def find_get_with_params(series_id, options)
+    get(find_path).params({ series_id: series_id }.merge(options))
   end
 
   def find_full(series_id, options = {})
-    get("#{series_uri}/all/{language}.xml").params({ series_id: series_id }.merge(options)).response
+    find_full_get_with_params(series_id, options).response(ThetvdbApi::Response::FullSeries)
+  end
+
+  def find_full_url(series_id, options = {})
+    find_full_get_with_params(series_id, options).url
+  end
+
+  def find_full_get_with_params(series_id, options)
+    get(find_full_path).params({ series_id: series_id }.merge(options))
+  end
+
+  private
+
+  def find_path
+    "#{series_uri}/{language}.xml"
+  end
+
+  def find_full_path
+    "#{series_uri}/all/{language}.xml"
   end
 end

data/lib/thetvdb_api/update.rb

@@ -1,34 +1,50 @@
 class ThetvdbApi::Update < ThetvdbApi::Base
   def day(options = {})
-    get(day_path).params(options).response
+    day_get_with_params(options).response(ThetvdbApi::Response::Update)
   end
 
   def day_url
-    get(day_path).url
+    day_get_with_params.url
+  end
+
+  def day_get_with_params(options = {})
+    get(day_path).params(options)
   end
 
   def week(options = {})
-    get(week_path).params(options).response
+    week_get_with_params(options).response(ThetvdbApi::Response::Update)
   end
 
   def week_url
-    get(week_path).url
+    week_get_with_params.url
+  end
+
+  def week_get_with_params(options = {})
+    get(week_path).params(options)
   end
 
   def month(options = {})
-    get(month_path).params(options).response
+    month_get_with_params(options).response(ThetvdbApi::Response::Update)
   end
 
   def month_url
-    get(month_path).url
+    month_get_with_params.url
+  end
+
+  def month_get_with_params(options = {})
+    get(month_path).params(options)
   end
 
   def all(options = {})
-    get(all_path).params(options).response
+    all_get_with_params(options).response(ThetvdbApi::Response::Update)
   end
 
   def all_url
-    get(all_path).url
+    all_get_with_params.url
+  end
+
+  def all_get_with_params(options = {})
+    get(all_path).params(options)
   end
 
   private

data/lib/thetvdb_api/version.rb

@@ -1,3 +1,3 @@
 module ThetvdbApi
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end