thetvdb_api 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a80e13185840b4ed5e40060728b17b84ff3c645
-  data.tar.gz: bebfb5dc9fd816cddf862621474217e426bb7984
+  metadata.gz: 82c9a99fb9fa13974c7f00e23f00c164433b0022
+  data.tar.gz: 8409f71bc88aea05716703d69449d90e290e8fab
 SHA512:
-  metadata.gz: 51adfb641d58aaaded7106912338cd815f9c506eec77bbbca190b71d1320396b00d066b946aaa4f7e804ba9b1dbb9e38dc527c1b5e6aa1666a29f7e420802f51
-  data.tar.gz: 2d5f32df776673a941eb72eb22fb4dc94dba7dc5cf69099a7d7cba2ed9b2c5305320735a8bf3a481f19098b94877abb53fbd2634224c8ecdb5f8b22f2110dde0
+  metadata.gz: 4cecac72881ed8dfb87e3da1a1f04caae7e9ef30e21833a0264080a67debac86fff469aa59017129c05169b402a27877f9ecec4aa323557d59aa7f74ba0deefb
+  data.tar.gz: e458d7169560328f73889af865d7731bd9c4d75308c01d6a61e09a1190fdd0c222823c53aab35881bceeca6c5b51324a96d9d0cabbfc5248178ef85e5ee87d18

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.0 (September 5, 2014)
+
+  - two way to pass attributes: hash attributes or simple multi attributes (in correct order)
+
 ## 0.2.5 (August 31, 2014)
 
   - two way access to api (by client class and by each api class)
@@ -16,7 +20,7 @@
 ## 0.2.3 (January 4, 2014)
 
   - unit tests refactor
-  - addded functional tests
+  - added functional tests
 
 ## 0.2.2 (December 26, 2013)
 

data/README.md

@@ -1,7 +1,7 @@
-[![Build Status](https://travis-ci.org/wafcio/thetvdb_api.png?branch=master)](https://travis-ci.org/wafcio/thetvdb_api)
-[![Dependency Status](https://gemnasium.com/wafcio/thetvdb_api.png)](https://gemnasium.com/wafcio/thetvdb_api)
-[![Code Climate](https://codeclimate.com/github/wafcio/thetvdb_api.png)](https://codeclimate.com/github/wafcio/thetvdb_api)
-[![Coverage Status](https://coveralls.io/repos/wafcio/thetvdb_api/badge.png)](https://coveralls.io/r/wafcio/thetvdb_api)
+[![Build Status](https://travis-ci.org/tvapi/thetvdb_api.png?branch=master)](https://travis-ci.org/tvapi/thetvdb_api)
+[![Dependency Status](https://gemnasium.com/tvapi/thetvdb_api.png)](https://gemnasium.com/tvapi/thetvdb_api)
+[![Code Climate](https://codeclimate.com/github/tvapi/thetvdb_api.png)](https://codeclimate.com/github/tvapi/thetvdb_api)
+[![Coverage Status](https://coveralls.io/repos/tvapi/thetvdb_api/badge.png)](https://coveralls.io/r/tvapi/thetvdb_api)
 [![Gem Version](https://badge.fury.io/rb/thetvdb_api.png)](http://badge.fury.io/rb/thetvdb_api)
 
 # ThetvdbApi
@@ -42,6 +42,7 @@ client.episode # => #<ThetvdbApi::Episode>
 client.search # => #<ThetvdbApi::Search>
 client.series # => #<ThetvdbApi::Series>
 client.update # => #<ThetvdbApi::Update>
+client.server # => #<ThetvdbApi::Server>
 ```
 
 * II case (direct access to api class, many entry points)
@@ -55,6 +56,7 @@ ThetvdbApi::Episode.new(api_key: '...', language: 'en')
 ThetvdbApi::Search.new(api_key: '...', language: 'en')
 ThetvdbApi::Series.new(api_key: '...', language: 'en')
 ThetvdbApi::Update.new(api_key: '...', language: 'en')
+ThetvdbApi::Server.new(api_key: '...', language: 'en')
 ```
 
 ## Methods
@@ -112,8 +114,17 @@ For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib
 * find_full
 * find_full_url
 
+
+### Server Time method
+
+For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/server.rb
+
+* time
+
 ### Update methods
 
+For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/update.rb
+
 * day
 * day_url
 * week

data/lib/thetvdb_api/actor.rb

@@ -1,35 +1,52 @@
 class ThetvdbApi::Actor < ThetvdbApi::Base
+  include Ov
+
   # Return all of the series actors.
   #
   # access: FREE
-  # param (flat params):
-  #   find(series_id)
+  # param:
   #   find(1234)
-  # param (hash params):
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:actors.xml
+  let :find, Any do |series_id|
+    find(series_id: series_id)
+  end
+
+  # Return all of the series actors.
+  #
+  # access: FREE
+  # param:
   #   find(series_id: 1234)
   # output: Faraday::Response instance with parsed XML string
   # example: http://thetvdb.com/wiki/index.php/API:actors.xml
-  def find(*options)
-    find_path_with_params(*options).get
+  let :find, Hash do |options|
+    find_path_with_params(options).get
   end
 
   # Return all of the series actors - return only url.
   #
   # access: FREE
-  # param (flat params):
-  #   find_url(series_id)
+  # param:
   #   find_url(1234)
-  # param (hash params):
+  # output: url string
+  let :find_url, Any do |series_id|
+    find_url(series_id: series_id)
+  end
+
+  # Return all of the series actors - return only url.
+  #
+  # access: FREE
+  # param:
   #   find_url(series_id: 1234)
   # output: url string
-  def find_url(*options)
-    find_path_with_params(*options).url
+  let :find_url, Hash do |options|
+    find_path_with_params(options).url
   end
 
   private
 
-  def find_path_with_params(*options)
-    path(find_path).params(api_key_options.merge(normalize_series_id_options(*options)))
+  def find_path_with_params(options)
+    path(find_path).params(api_key_options.merge(options))
   end
 
   def find_path

data/lib/thetvdb_api/attributes_mapping/search/get_episode.rb

@@ -0,0 +1,6 @@
+require 'hashie'
+
+class ThetvdbApi::AttributesMapping::Search::GetEpisode < Hashie::Trash
+  property :seriesid, from: :series_id
+  property :airdate, from: :air_date
+end

data/lib/thetvdb_api/attributes_mapping/search/get_series.rb

@@ -0,0 +1,6 @@
+require 'hashie'
+
+class ThetvdbApi::AttributesMapping::Search::GetSeries < Hashie::Trash
+  property :seriesname, from: :name
+  property :language
+end

data/lib/thetvdb_api/attributes_mapping/search/get_series_by_remote_id.rb

@@ -0,0 +1,7 @@
+require 'hashie'
+
+class ThetvdbApi::AttributesMapping::Search::GetSeriesByRemoteId < Hashie::Trash
+  property :imdbid, from: :imdb_id
+  property :zap2it, from: :zap2it_id
+  property :language
+end

data/lib/thetvdb_api/banner.rb

@@ -1,35 +1,52 @@
 class ThetvdbApi::Banner < ThetvdbApi::Base
+  include Ov
+
   # Return all of the series banners.
   #
   # access: FREE
-  # param (flat params):
-  #   find(series_id)
+  # param:
   #   find(1234)
-  # param (hash params):
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:banners.xml
+  let :find, Any do |series_id|
+    find(series_id: series_id)
+  end
+
+  # Return all of the series banners.
+  #
+  # access: FREE
+  # param:
   #   find(series_id: 1234)
   # output: Faraday::Response instance with parsed XML string
   # example: http://thetvdb.com/wiki/index.php/API:banners.xml
-  def find(*options)
-    find_path_with_params(*options).get
+  let :find, Hash do |options|
+    find_path_with_params(options).get
   end
 
   # Return all of the series banners - return only url.
   #
   # access: FREE
-  # param (flat params):
-  #   find_url(series_id)
+  # param:
   #   find_url(1234)
-  # param (hash params):
+  # output: url string
+  let :find_url, Any do |series_id|
+    find_url(series_id: series_id)
+  end
+
+  # Return all of the series banners - return only url.
+  #
+  # access: FREE
+  # param:
   #   find_url(series_id: 1234)
   # output: url string
-  def find_url(*options)
-    find_path_with_params(*options).url
+  let :find_url, Hash do |options|
+    find_path_with_params(options).url
   end
 
   private
 
-  def find_path_with_params(*options)
-    path(find_path).params(api_key_options.merge(normalize_series_id_options(*options)))
+  def find_path_with_params(options)
+    path(find_path).params(api_key_options.merge(options))
   end
 
   def find_path

data/lib/thetvdb_api/base.rb

@@ -15,30 +15,6 @@ class ThetvdbApi::Base
     api_key_options.merge(language_options)
   end
 
-  def normalize_series_id_options(*options)
-    normalize_options([:series_id], *options)
-  end
-
-  def normalize_series_id_absolute_options(*options)
-    normalize_options([:series_id, :absolute], *options)
-  end
-
-  def normalize_series_id_episode_options(*options)
-    normalize_options([:series_id, :season, :episode], *options)
-  end
-
-  def normalize_episode_id_options(*options)
-    normalize_options([:episode_id], *options)
-  end
-
-  def normalize_series_name_options(*options)
-    normalize_options({ name: :seriesname }, *options)
-  end
-
-  def normalize_series_id_air_date_options(*options)
-    normalize_options({ series_id: :seriesid, air_date: :airdate }, *options)
-  end
-
   private
 
   def uri_kind

data/lib/thetvdb_api/client.rb

@@ -19,6 +19,10 @@ class ThetvdbApi::Client
   def actor
     @actor ||= ThetvdbApi::Actor.new(config)
   end
+  
+  def server
+    @server ||= ThetvdbApi::Server.new(config)
+  end
 
   def banner
     @banner ||= ThetvdbApi::Banner.new(config)

data/lib/thetvdb_api/episode.rb

@@ -1,116 +1,268 @@
 class ThetvdbApi::Episode < ThetvdbApi::Base
+  include Ov
+
   # Find the episode data, sorts using the default ordering method.
   #
   # access: FREE
-  # param (flat params):
-  #   find_by_default_order(series_id, season, episode)
+  # param:
   #   find_by_default_order(1234, 1, 2)
-  # param (hash params):
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record
+  let :find_by_default_order, Any, Any, Any do |series_id, season, episode|
+    find_by_default_order(map_attrs(series_id, season, episode))
+  end
+
+  # Find the episode data, sorts using the default ordering method.
+  #
+  # access: FREE
+  # param:
+  #   find_by_default_order(1234, 1, 2, 'de')
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record
+  let :find_by_default_order, Any, Any, Any, String do |series_id, season, episode, language|
+    find_by_default_order(map_attrs_with_lang(series_id, season, episode, language))
+  end
+
+  # Find the episode data, sorts using the default ordering method.
+  #
+  # access: FREE
+  # param:
   #   find_by_default_order(series_id: 1234, season: 1, episode: 1)
   # output: Faraday::Response instance with parsed XML string
   # example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record
-  def find_by_default_order(*options)
-    find_by_order(normalize_series_id_episode_options(*options).merge(order: 'default'))
+  let :find_by_default_order, Hash do |options|
+    find_by_order(options.merge(order: 'default'))
   end
 
   # Find the episode data, sorts using the default ordering method - return only url.
   #
   # access: FREE
-  # param (flat params):
-  #   find_by_default_order_url(series_id, season, episode)
+  # param:
   #   find_by_default_order_url(1234, 1, 2)
-  # param (hash params):
-  #   find_by_default_order_url(series_id: 1234, season: 1, episode: 1)
   # output: url string
-  def find_by_default_order_url(*options)
-    find_by_order_url(normalize_series_id_episode_options(*options).merge(order: 'default'))
+  let :find_by_default_order_url, Any, Any, Any do |series_id, season, episode|
+    find_by_default_order_url(map_attrs(series_id, season, episode))
+  end
+
+  # Find the episode data, sorts using the default ordering method - return only url.
+  #
+  # access: FREE
+  # param:
+  #   find_by_default_order_url(1234, 1, 2, 'de')
+  # output: url string
+  let :find_by_default_order_url, Any, Any, Any, String do |series_id, season, episode, language|
+    find_by_default_order_url(map_attrs_with_lang(series_id, season, episode, language))
   end
 
+  # Find the episode data, sorts using the default ordering method - return only url.
+  #
+  # access: FREE
+  # param:
+  #   find_by_default_order_url(series_id: 1234, season: 1, episode: 1)
+  # output: url string
+  let :find_by_default_order_url, Hash do |options|
+    find_by_order_url(options.merge(order: 'default'))
+  end
+  
   # Find the episode data, sorts using the dvd ordering method.
   #
   # access: FREE
-  # param (flat params):
-  #   find_by_dvd_order(series_id, season, episode)
+  # param:
   #   find_by_dvd_order(1234, 1, 2)
-  # param (hash params):
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record
+  let :find_by_dvd_order, Any, Any, Any do |series_id, season, episode|
+    find_by_dvd_order(map_attrs(series_id, season, episode))
+  end
+
+  # Find the episode data, sorts using the dvd ordering method.
+  #
+  # access: FREE
+  # param:
+  #   find_by_dvd_order(1234, 1, 2, 'de')
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record
+  let :find_by_dvd_order, Any, Any, Any, String do |series_id, season, episode, language|
+    find_by_dvd_order(map_attrs_with_lang(series_id, season, episode, language))
+  end
+
+  # Find the episode data, sorts using the dvd ordering method.
+  #
+  # access: FREE
+  # param:
   #   find_by_dvd_order(series_id: 1234, season: 1, episode: 1)
   # output: Faraday::Response instance with parsed XML string
   # example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record
-  def find_by_dvd_order(*options)
-    find_by_order(normalize_series_id_episode_options(*options).merge(order: 'dvd'))
+  let :find_by_dvd_order, Hash do |options|
+    find_by_order(options.merge(order: 'dvd'))
   end
 
   # Find the episode data, sorts using the dvd ordering method - return only url.
   #
   # access: FREE
-  # param: options hash
-  # param (flat params):
-  #   find_by_dvd_order_url(series_id, season, episode)
+  # param:
   #   find_by_dvd_order_url(1234, 1, 2)
-  # param (hash params):
+  # output: url string
+  let :find_by_dvd_order_url, Any, Any, Any do |series_id, season, episode|
+    find_by_dvd_order_url(map_attrs(series_id, season, episode))
+  end
+
+  # Find the episode data, sorts using the dvd ordering method - return only url.
+  #
+  # access: FREE
+  # param:
+  #   find_by_dvd_order_url(1234, 1, 2, 'de')
+  # output: url string
+  let :find_by_dvd_order_url, Any, Any, Any, String do |series_id, season, episode, language|
+    find_by_dvd_order_url(map_attrs_with_lang(series_id, season, episode, language))
+  end
+
+  # Find the episode data, sorts using the dvd ordering method - return only url.
+  #
+  # access: FREE
+  # param:
   #   find_by_dvd_order_url(series_id: 1234, season: 1, episode: 1)
   # output: url string
-  def find_by_dvd_order_url(*options)
-    find_by_order_url(normalize_series_id_episode_options(*options).merge(order: 'dvd'))
+  let :find_by_dvd_order_url, Hash do |options|
+    find_by_order_url(options.merge(order: 'dvd'))
   end
 
   # Find the episode data, sorts using the absolute ordering method.
   #
   # access: FREE
-  # param (flat params):
-  #   find_by_absolute_order(series_id, absolute)
+  # param:
   #   find_by_absolute_order(1234, 1)
-  # param (hash params):
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record
+  let :find_by_absolute_order, Any, Any do |series_id, absolute|
+    find_by_absolute_order(series_id: series_id, absolute: absolute)
+  end
+
+  # Find the episode data, sorts using the absolute ordering method.
+  #
+  # access: FREE
+  # param:
+  #   find_by_absolute_order(1234, 1, 'de')
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record
+  let :find_by_absolute_order, Any, Any, String do |series_id, absolute, language|
+    find_by_absolute_order(series_id: series_id, absolute: absolute, language: language)
+  end
+
+  # Find the episode data, sorts using the absolute ordering method.
+  #
+  # access: FREE
+  # param:
   #   find_by_absolute_order(series_id: 1234, absolute: 1)
   # output: Faraday::Response instance with parsed XML string
   # example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record
-  def find_by_absolute_order(*options)
-    find_by_absolute_order_path_with_params(*options).get
+  let :find_by_absolute_order, Hash do |options|
+    find_by_absolute_order_path_with_params(options).get
   end
 
   # Find the episode data, sorts using the absolute ordering method - return only url.
   #
   # access: FREE
-  # param: options hash
-  # param (flat params):
-  #   find_by_absolute_order_url(series_id, absolute)
+  # param:
   #   find_by_absolute_order_url(1234, 1)
-  # param (hash params):
-  #   find_by_absolute_order_url(series_id: 1234, absolute: 1)
   # output: url string
-  def find_by_absolute_order_url(*options)
-    find_by_absolute_order_path_with_params(*options).url
+  let :find_by_absolute_order_url, Any, Any do |series_id, absolute|
+    find_by_absolute_order_url(series_id: series_id, absolute: absolute)
+  end
+
+  # Find the episode data, sorts using the absolute ordering method - return only url.
+  #
+  # access: FREE
+  # param:
+  #   find_by_absolute_order_url(1234, 1, 'de')
+  # output: url string
+  let :find_by_absolute_order_url, Any, Any, String do |series_id, absolute, language|
+    find_by_absolute_order_url(series_id: series_id, absolute: absolute, language: language)
   end
 
-  # Find the episode data by episode id.
+  # Find the episode data, sorts using the dvd absolute method - return only url.
+  #
+  # access: FREE
+  # param:
+  #   find_by_absolute_order_url(series_id: 1234, absolute: 1)
+  # output: url string
+  let :find_by_absolute_order_url, Hash do |options|
+    find_by_absolute_order_path_with_params(options).url
+  end
+  
+  # Find the episode data, sorts using the absolute ordering method.
   #
   # access: FREE
-  # param (flat params):
-  #   find(episode_id)
+  # param:
   #   find(1234)
-  # param (hash params):
-  #   find(episode_id: 1234)
   # output: Faraday::Response instance with parsed XML string
   # example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record
-  def find(*options)
-    find_path_with_params(*options).get
+  let :find, Any do |id|
+    find(id: id)
   end
 
-  # Find the episode data by episode id - return only url.
+  # Find the episode data, sorts using the absolute ordering method.
   #
   # access: FREE
-  # param (flat params):
-  #   find_url(episode_id)
+  # param:
+  #   find(1234, 'de')
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record
+  let :find, Any, String do |id, language|
+    find(id: id, language: language)
+  end
+
+  # Find the episode data, sorts using the absolute ordering method.
+  #
+  # access: FREE
+  # param:
+  #   find(id: 1234)
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record
+  let :find, Hash do |options|
+    find_path_with_params(options).get
+  end
+
+  # Find the episode data, sorts using the absolute ordering method - return only url.
+  #
+  # access: FREE
+  # param:
   #   find_url(1234)
-  # param (hash params):
-  #   find_url(episode_id: 1234)
   # output: url string
-  def find_url(*options)
-    find_path_with_params(*options).url
+  let :find_url, Any do |id|
+    find_url(id: id)
+  end
+
+  # Find the episode data, sorts using the absolute ordering method - return only url.
+  #
+  # access: FREE
+  # param:
+  #   find_url(1234, 'de')
+  # output: url string
+  let :find_url, Any, String do |id, language|
+    find_url(id: id, language: language)
+  end
+
+  # Find the episode data, sorts using the dvd absolute method - return only url.
+  #
+  # access: FREE
+  # param:
+  #   find_url(id: 1234)
+  # output: url string
+  let :find_url, Hash do |options|
+    find_path_with_params(options).url
   end
 
   private
 
+  def map_attrs(series_id, season, episode)
+    { series_id: series_id, season: season, episode: episode }
+  end
+
+  def map_attrs_with_lang(series_id, season, episode, language)
+    { series_id: series_id, season: season, episode: episode, language: language }
+  end
+
   def find_by_order(options)
     find_by_order_path_with_params(options).get
   end
@@ -127,19 +279,19 @@ class ThetvdbApi::Episode < ThetvdbApi::Base
     ':apikey/series/:series_id/:order/:season/:episode/:language.xml'
   end
 
-  def find_by_absolute_order_path_with_params(*options)
-    path(find_by_absolute_order_path).params(api_key_with_language_options.merge(normalize_series_id_absolute_options(*options)))
+  def find_by_absolute_order_path_with_params(options)
+    path(find_by_absolute_order_path).params(api_key_with_language_options.merge(options))
   end
 
   def find_by_absolute_order_path
     ':apikey/series/:series_id/absolute/:absolute/:language.xml'
   end
 
-  def find_path_with_params(*options)
-    path(find_path).params(api_key_with_language_options.merge(normalize_episode_id_options(*options)))
+  def find_path_with_params(options)
+    path(find_path).params(api_key_with_language_options.merge(options))
   end
 
   def find_path
-    ':apikey/episodes/:episode_id/:language.xml'
+    ':apikey/episodes/:id/:language.xml'
   end
 end