thetvdb_api 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97791a043434b43dfd16cf2edc9e37a67315cb79
-  data.tar.gz: 3a7bb165e31c4bbc6d0ae4c97ef948bfc2f84282
+  metadata.gz: 4a80e13185840b4ed5e40060728b17b84ff3c645
+  data.tar.gz: bebfb5dc9fd816cddf862621474217e426bb7984
 SHA512:
-  metadata.gz: 78dfd626d8f116d3bbc52b64d4100e6fec6ff844a7ce408271625fef346bdb7f20856d3e041a3eada81e9d64d6f224b6372f66204a539c5c97f3f00c7e2aa949
-  data.tar.gz: 7980189c25c89468d433e8d885c45c566c6dcb3f57c07723bf2731699181c5030f732f1884026c4a254687e57725185f6a6fa681a230aee163abe69ec5ddfa6f
+  metadata.gz: 51adfb641d58aaaded7106912338cd815f9c506eec77bbbca190b71d1320396b00d066b946aaa4f7e804ba9b1dbb9e38dc527c1b5e6aa1666a29f7e420802f51
+  data.tar.gz: 2d5f32df776673a941eb72eb22fb4dc94dba7dc5cf69099a7d7cba2ed9b2c5305320735a8bf3a481f19098b94877abb53fbd2634224c8ecdb5f8b22f2110dde0

data/.gitignore

@@ -1,19 +1,5 @@
 *.gem
-*.rbc
-.bundle
-.config
-.yardoc
 Gemfile.lock
-InstalledFiles
-_yardoc
 coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
 
-spec/integrations/support/configuration.rb
+spec/support/api_key.rb

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+## 0.2.5 (August 31, 2014)
+
+  - two way access to api (by client class and by each api class)
+
+## 0.2.4 (June 23, 2014)
+
+  - removed unit tests
+  - use service_api gem for common parts
+  - use option hash attribute in every method instead of many String attributes
+  - added tests
+
+## 0.2.3.1 (February 2, 2014)
+
+  - update Faraday
+  
+## 0.2.3 (January 4, 2014)
+
+  - unit tests refactor
+  - addded functional tests
+
+## 0.2.2 (December 26, 2013)
+
+  - removed mappers
+  - use multi_xml to parse XML response
+  - wrapped Faraday response by own class
+  - added methods which return url instead call to API
+
+## 0.2.1 (December 21, 2013)
+
+  - hotfix
+
+## 0.2.0 (December 21, 2013)
+
+  - replaced HTTParty by Faraday
+  - refactored Mapper classes
+
+## 0.1.2 (December 17, 2013)
+
+  - used uri_template for better way to format uri and map variables
+
+## 0.1.1 (December 14, 2013)
+
+  - refactored
+
+## 0.1.0 (December 11, 2013)
+
+  - removed monkey patches for Ruby Core Date Types
+  - removed mapping response to objects
+  - little performance improvement
+
+## 0.0.1 (December 4, 2013)
+
+First release with HTTParty

data/README.md

@@ -8,143 +8,120 @@
 
 thetvdb_api is a simple ruby client for accessing TV shows information from the thetvdb.com API.
 
-## Getting started
+## Installation
 
-You can add it to your Gemfile with:
+With Bundler:
 
 ```ruby
 gem 'thetvdb_api'
 ```
 
-Run the bundle command to install it.
+```ruby
+$ bundle install
+```
+
+Otherwhise:
+
+```ruby
+gem install thetvdb_api
+```
 
 ## How to use
 
 You have two way for access to api:
 
-* I way (create client class, one entry point)
-
-* II way (direct access to api class, many entry points)
+* I case (create client class, one entry point)
 
-Search series (by name) methods - access by search method or Search class
+Language attribute is optional with default value 'en'
 
 ```ruby
 client = ThetvdbApi::Client.new(api_key: '...', language: 'en')
-client.search.get_series(options = {})
-client.search.get_series_url(options = {}) # return only full url
-client.search.get_series_by_remote_id(options = {})
-client.search.get_series_by_remote_id_url(options = {}) # return only full url
-client.search.get_episode(options = {})
-client.search.get_episode_url(options = {}) # return only full url
+client.actor # => #<ThetvdbApi::Actor>
+client.banner # => #<ThetvdbApi::Banner>
+client.episode # => #<ThetvdbApi::Episode>
+client.search # => #<ThetvdbApi::Search>
+client.series # => #<ThetvdbApi::Series>
+client.update # => #<ThetvdbApi::Update>
 ```
 
-```ruby
-search = ThetvdbApi::Search.new(api_key: '...', language: 'en')
-search.get_series(options = {})
-search.get_series_url(options = {}) # return only full url
-search.get_series_by_remote_id(options = {})
-search.get_series_by_remote_id_url(options = {}) # return only full url
-search.get_episode(options = {})
-search.get_episode_url(options = {}) # return only full url
-```
+* II case (direct access to api class, many entry points)
 
-Search series (by id) methods - access by series method or Series class
+Language attribute is required
 
 ```ruby
-client = ThetvdbApi::Client.new(api_key: '...', language: 'en')
-client.series.find(options = {})
-client.series.find_url(options = {}) # return only full url
-client.series.find_full(options = {})
-client.series.find_full_url(options = {}) # return only full url
+ThetvdbApi::Actor.new(api_key: '...', language: 'en')
+ThetvdbApi::Banner.new(api_key: '...', language: 'en')
+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')
 ```
 
-```ruby
-client = ThetvdbApi::Series.new(api_key: '...', language: 'en')
-series.find(options = {})
-series.find_url(options = {}) # return only full url
-series.find_full(options = {})
-series.find_full_url(options = {}) # return only full url
-```
+## Methods
 
-Return series actors - access by actor method or Actor class
+For almost all method you can pass hash attributes or multiple attributes specified in method comment (except some methods in Search class).
 
-```ruby
-client = ThetvdbApi::Client.new(api_key: '...', language: 'en')
-client.actor.all(options = {})
-client.actor.all_url(options = {}) # return only full url
-```
+### Actor methods
 
-```ruby
-actor = ThetvdbApi::Actor.new(api_key: '...', language: 'en')
-actor.all(options = {})
-actor.all_url(options = {}) # return only full url
-```
+For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/actor.rb
 
-Return series banners - access by banner method or Banner class
+* all
+* all_url
 
-```ruby
-client = ThetvdbApi::Client.new(api_key: '...', language: 'en')
-client.banner.all(options = {})
-client.banner.all_url(options = {}) # return only full url
-```
+### Banner methods
 
-```ruby
-banner = ThetvdbApi::Banner.new(api_key: '...', language: 'en')
-banner.all(options = {})
-banner.all_url(options = {}) # return only full url
-```
+For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/banner.rb
 
-Return series episode - access by episode method or Episode class
+* all
+* all_url
 
-```ruby
-client = ThetvdbApi::Client.new(api_key: '...', language: 'en')
-client.episode.find_by_default_order(options = {})
-client.episode.find_by_default_order_url(options = {}) # return only full url
-client.episode.find_by_dvd_order(options = {})
-client.episode.find_by_dvd_order_url(options = {}) # return only full url
-client.episode.find_by_absolute_order(options = {})
-client.episode.find_by_absolute_order_url(options = {}) # return only full url
-client.episode.find(options = {})
-client.episode.find_url(options = {}) # return only full url
-```
+### Episode methods
 
-```ruby
-episode = ThetvdbApi::Episode.new(api_key: '...', language: 'en')
-episode.find_by_default_order(options = {})
-episode.find_by_default_order_url(options = {}) # return only full url
-episode.find_by_dvd_order(options = {})
-episode.find_by_dvd_order_url(options = {}) # return only full url
-episode.find_by_absolute_order(options = {})
-episode.find_by_absolute_order_url(options = {}) # return only full url
-episode.find(options = {})
-episode.find_url(options = {}) # return only full url
-```
+For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/episode.rb
 
-Get updates - access by update method or Update class
+* find
+* find_url
+* find_by_absolute_order
+* find_by_absolute_order_url
+* find_by_default_order
+* find_by_default_order_url
+* find_by_dvd_order
+* find_by_dvd_order_url
 
-```ruby
-client = ThetvdbApi::Client.new(api_key: '...', language: 'en')
-client.update.day
-client.update.day_url # return only full url
-client.update.week
-client.update.week_url # return only full url
-client.update.month
-client.update.month_url # return only full url
-client.update.all
-client.update.all_url # return only full url
-```
+### Search methods
 
-```ruby
-update = ThetvdbApi::Update.new(api_key: '...', language: 'en')
-update.day
-update.day_url # return only full url
-update.week
-update.week_url # return only full url
-update.month
-update.month_url # return only full url
-update.all
-update.all_url # return only full url
-```
+For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/search.rb
+
+* get_series
+* get_series_url
+* get_series_by_remote
+* get_series_by_remote_url
+* get_series_by_imdb_id
+* get_series_by_imdb_id_url
+* get_series_by_zap2it_id
+* get_series_by_zap2it_id_url
+* get_episode
+* get_episode_url
+
+### Series methods
+
+For method attributes read https://github.com/wafcio/thetvdb_api/blob/master/lib/thetvdb_api/series.rb
+
+* find
+* find_url
+* find_full
+* find_full_url
+
+### Update methods
+
+* day
+* day_url
+* week
+* week_url
+* month
+* month_url
+* all
+* all_url
 
 ## Contributing
 

data/lib/thetvdb_api/actor.rb

@@ -2,27 +2,34 @@ class ThetvdbApi::Actor < ThetvdbApi::Base
   # Return all of the series actors.
   #
   # access: FREE
-  # param: options hash
-  #   series_id: TV series name
-  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:actors.xml)
-  def find(options = {})
-    find_path_with_params(options).get
+  # param (flat params):
+  #   find(series_id)
+  #   find(1234)
+  # param (hash params):
+  #   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
   end
 
   # Return all of the series actors - return only url.
   #
   # access: FREE
-  # param: options hash
-  #   series_id: TV series name
+  # param (flat params):
+  #   find_url(series_id)
+  #   find_url(1234)
+  # param (hash params):
+  #   find_url(series_id: 1234)
   # output: url string
-  def find_url(options = {})
-    find_path_with_params(options).url
+  def find_url(*options)
+    find_path_with_params(*options).url
   end
 
   private
 
-  def find_path_with_params(options)
-    path(find_path).params(api_key_options.merge(options))
+  def find_path_with_params(*options)
+    path(find_path).params(api_key_options.merge(normalize_series_id_options(*options)))
   end
 
   def find_path

data/lib/thetvdb_api/banner.rb

@@ -2,27 +2,34 @@ class ThetvdbApi::Banner < ThetvdbApi::Base
   # Return all of the series banners.
   #
   # access: FREE
-  # param: options hash
-  #   series_id: TV series name
-  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:banners.xml)
-  def find(options = {})
-    find_path_with_params(options).get
+  # param (flat params):
+  #   find(series_id)
+  #   find(1234)
+  # param (hash params):
+  #   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
   end
 
   # Return all of the series banners - return only url.
   #
   # access: FREE
-  # param: options hash
-  #   series_id: TV series name
+  # param (flat params):
+  #   find_url(series_id)
+  #   find_url(1234)
+  # param (hash params):
+  #   find_url(series_id: 1234)
   # output: url string
-  def find_url(options = {})
-    find_path_with_params(options).url
+  def find_url(*options)
+    find_path_with_params(*options).url
   end
 
   private
 
-  def find_path_with_params(options)
-    path(find_path).params(api_key_options.merge(options))
+  def find_path_with_params(*options)
+    path(find_path).params(api_key_options.merge(normalize_series_id_options(*options)))
   end
 
   def find_path

data/lib/thetvdb_api/base.rb

@@ -15,6 +15,30 @@ 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/episode.rb

@@ -2,91 +2,111 @@ class ThetvdbApi::Episode < ThetvdbApi::Base
   # Find the episode data, sorts using the default ordering method.
   #
   # access: FREE
-  # param: options hash
-  #   series_id: TV series ID
-  #   season: season number
-  #   episode: episode number in season
-  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record)
-  def find_by_default_order(options = {})
-    find_by_order(options.merge(order: 'default'))
+  # param (flat params):
+  #   find_by_default_order(series_id, season, episode)
+  #   find_by_default_order(1234, 1, 2)
+  # param (hash params):
+  #   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'))
   end
 
   # Find the episode data, sorts using the default ordering method - return only url.
   #
   # access: FREE
-  # param: options hash
-  #   series_id: TV series ID
-  #   season: season number
-  #   episode: episode number in season
+  # param (flat params):
+  #   find_by_default_order_url(series_id, season, episode)
+  #   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(options.merge(order: 'default'))
+  def find_by_default_order_url(*options)
+    find_by_order_url(normalize_series_id_episode_options(*options).merge(order: 'default'))
   end
 
   # Find the episode data, sorts using the dvd ordering method.
   #
   # access: FREE
-  # param: options hash
-  #   series_id: TV series ID
-  #   season: season number
-  #   episode: episode number in season
-  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record)
-  def find_by_dvd_order(options = {})
-    find_by_order(options.merge(order: 'dvd'))
+  # param (flat params):
+  #   find_by_dvd_order(series_id, season, episode)
+  #   find_by_dvd_order(1234, 1, 2)
+  # param (hash params):
+  #   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'))
   end
 
   # Find the episode data, sorts using the dvd ordering method - return only url.
   #
   # access: FREE
   # param: options hash
-  #   series_id: TV series ID
-  #   season: season number
-  #   episode: episode number in season
+  # param (flat params):
+  #   find_by_dvd_order_url(series_id, season, episode)
+  #   find_by_dvd_order_url(1234, 1, 2)
+  # param (hash params):
+  #   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(options.merge(order: 'dvd'))
+  def find_by_dvd_order_url(*options)
+    find_by_order_url(normalize_series_id_episode_options(*options).merge(order: 'dvd'))
   end
 
   # Find the episode data, sorts using the absolute ordering method.
   #
   # access: FREE
-  # param: options hash
-  #   series_id: TV series ID
-  #   absolute: absolute number in series
-  # output: 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
+  # param (flat params):
+  #   find_by_absolute_order(series_id, absolute)
+  #   find_by_absolute_order(1234, 1)
+  # param (hash params):
+  #   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
   end
 
   # Find the episode data, sorts using the absolute ordering method - return only url.
   #
   # access: FREE
   # param: options hash
-  #   series_id: TV series ID
-  #   absolute: absolute number in series
+  # param (flat params):
+  #   find_by_absolute_order_url(series_id, absolute)
+  #   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
+  def find_by_absolute_order_url(*options)
+    find_by_absolute_order_path_with_params(*options).url
   end
 
   # Find the episode data by episode id.
   #
   # access: FREE
-  # param: options hash
-  #   episode_id: TV episode ID
-  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:Base_Episode_Record)
-  def find(options = {})
-    find_path_with_params(options).get
+  # param (flat params):
+  #   find(episode_id)
+  #   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
   end
 
   # Find the episode data by episode id - return only url.
   #
   # access: FREE
-  # param: options hash
-  #   episode_id: TV episode ID
+  # param (flat params):
+  #   find_url(episode_id)
+  #   find_url(1234)
+  # param (hash params):
+  #   find_url(episode_id: 1234)
   # output: url string
-  def find_url(options = {})
-    find_path_with_params(options).url
+  def find_url(*options)
+    find_path_with_params(*options).url
   end
 
   private
@@ -107,16 +127,16 @@ 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(options))
+  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)))
   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(options))
+  def find_path_with_params(*options)
+    path(find_path).params(api_key_with_language_options.merge(normalize_episode_id_options(*options)))
   end
 
   def find_path