thetvdb_api 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5501937cffeedf47be473a7d5c2bc4c3635236b1
-  data.tar.gz: 7f59cde79cdacb935f59c2351b85a96c2c8876a3
+  metadata.gz: 97791a043434b43dfd16cf2edc9e37a67315cb79
+  data.tar.gz: 3a7bb165e31c4bbc6d0ae4c97ef948bfc2f84282
 SHA512:
-  metadata.gz: e0aff5f795d6e47a7097b61d720b8538408f442165c507165bb410de50848367fb92e842a0ec971291458801ae4eb8a165f7b13602598567f157436331cf65d2
-  data.tar.gz: a29e4a139f4707d9cbf5b8cee2466a911a85fb5010239926ab9ccd8f6643bb06333023f4a9289f74f71f08c7c7d4cc70880fe4195b7a07673a74a43980f8f15c
+  metadata.gz: 78dfd626d8f116d3bbc52b64d4100e6fec6ff844a7ce408271625fef346bdb7f20856d3e041a3eada81e9d64d6f224b6372f66204a539c5c97f3f00c7e2aa949
+  data.tar.gz: 7980189c25c89468d433e8d885c45c566c6dcb3f57c07723bf2731699181c5030f732f1884026c4a254687e57725185f6a6fa681a230aee163abe69ec5ddfa6f

data/README.md

@@ -20,16 +20,16 @@ Run the bundle command to install it.
 
 ## How to use
 
-There is one entry point, in initialize you can past hash with api_key and language values, or leave empty:
+You have two way for access to api:
 
-```ruby
-client = ThetvdbApi::Client.new(api_key: '...', language: 'en')
-```
+* I way (create client class, one entry point)
+
+* II way (direct access to api class, many entry points)
 
-Search series by name
+Search series (by name) methods - access by search method or Search class
 
 ```ruby
-client = ThetvdbApi::Client.new
+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 = {})
@@ -38,36 +38,66 @@ client.search.get_episode(options = {})
 client.search.get_episode_url(options = {}) # return only full url
 ```
 
-Search series by id
+```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
+```
+
+Search series (by id) methods - access by series method or Series class
 
 ```ruby
-client = ThetvdbApi::Client.new
+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
 ```
 
-Return series actors
+```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
+```
+
+Return series actors - access by actor method or Actor class
 
 ```ruby
-client = ThetvdbApi::Client.new
+client = ThetvdbApi::Client.new(api_key: '...', language: 'en')
 client.actor.all(options = {})
 client.actor.all_url(options = {}) # return only full url
 ```
 
-Return series banners
+```ruby
+actor = ThetvdbApi::Actor.new(api_key: '...', language: 'en')
+actor.all(options = {})
+actor.all_url(options = {}) # return only full url
+```
+
+Return series banners - access by banner method or Banner class
 
 ```ruby
-client = ThetvdbApi::Client.new
+client = ThetvdbApi::Client.new(api_key: '...', language: 'en')
 client.banner.all(options = {})
 client.banner.all_url(options = {}) # return only full url
 ```
 
-Return series episode
+```ruby
+banner = ThetvdbApi::Banner.new(api_key: '...', language: 'en')
+banner.all(options = {})
+banner.all_url(options = {}) # return only full url
+```
+
+Return series episode - access by episode method or Episode class
 
 ```ruby
-client = ThetvdbApi::Client.new
+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 = {})
@@ -78,10 +108,22 @@ client.episode.find(options = {})
 client.episode.find_url(options = {}) # return only full url
 ```
 
-Get updates
+```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
+```
+
+Get updates - access by update method or Update class
 
 ```ruby
-client = ThetvdbApi::Client.new
+client = ThetvdbApi::Client.new(api_key: '...', language: 'en')
 client.update.day
 client.update.day_url # return only full url
 client.update.week
@@ -91,6 +133,19 @@ client.update.month_url # return only full url
 client.update.all
 client.update.all_url # return only full url
 ```
+
+```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
+```
+
 ## Contributing
 
 1. Fork it

data/lib/thetvdb_api/actor.rb

@@ -1,8 +1,20 @@
 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
   end
 
+  # Return all of the series actors - return only url.
+  #
+  # access: FREE
+  # param: options hash
+  #   series_id: TV series name
+  # output: url string
   def find_url(options = {})
     find_path_with_params(options).url
   end

data/lib/thetvdb_api/banner.rb

@@ -1,8 +1,20 @@
 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
   end
 
+  # Return all of the series banners - return only url.
+  #
+  # access: FREE
+  # param: options hash
+  #   series_id: TV series name
+  # output: url string
   def find_url(options = {})
     find_path_with_params(options).url
   end

data/lib/thetvdb_api/base.rb

@@ -1,16 +1,14 @@
-require 'faraday'
-require 'uri_template'
 require 'service_api'
 
 class ThetvdbApi::Base
   include ServiceApi::BaseFaraday
 
   def api_key_options
-    { apikey: @client.options[:api_key] }
+    { apikey: @config[:api_key] }
   end
 
   def language_options
-    { language: @client.options[:language] }
+    { language: @config[:language] }
   end
 
   def api_key_with_language_options

data/lib/thetvdb_api/client.rb

@@ -1,34 +1,34 @@
 class ThetvdbApi::Client
-  attr_reader :options
+  attr_reader :config
 
-  def initialize(options = {})
-    @options = options
+  def initialize(config = {})
+    @config = config
 
-    @options[:adapter] ||= :net_http
-    @options[:language] ||= 'en'
+    @config[:adapter] ||= :net_http
+    @config[:language] ||= 'en'
   end
 
   def search
-    @search ||= ThetvdbApi::Search.new(self)
+    @search ||= ThetvdbApi::Search.new(config)
   end
 
   def series
-    @series ||= ThetvdbApi::Series.new(self)
+    @series ||= ThetvdbApi::Series.new(config)
   end
 
   def actor
-    @actor ||= ThetvdbApi::Actor.new(self)
+    @actor ||= ThetvdbApi::Actor.new(config)
   end
 
   def banner
-    @banner ||= ThetvdbApi::Banner.new(self)
+    @banner ||= ThetvdbApi::Banner.new(config)
   end
 
   def episode
-    @episode ||= ThetvdbApi::Episode.new(self)
+    @episode ||= ThetvdbApi::Episode.new(config)
   end
 
   def update
-    @update ||= ThetvdbApi::Update.new(self)
+    @update ||= ThetvdbApi::Update.new(config)
   end
 end

data/lib/thetvdb_api/episode.rb

@@ -1,32 +1,90 @@
 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'))
   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
+  # output: url string
   def find_by_default_order_url(options = {})
     find_by_order_url(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'))
   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
+  # output: url string
   def find_by_dvd_order_url(options = {})
     find_by_order_url(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
   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
+  # output: url string
   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
   end
 
+  # Find the episode data by episode id - return only url.
+  #
+  # access: FREE
+  # param: options hash
+  #   episode_id: TV episode ID
+  # output: url string
   def find_url(options = {})
     find_path_with_params(options).url
   end

data/lib/thetvdb_api/search.rb

@@ -1,24 +1,68 @@
 class ThetvdbApi::Search < ThetvdbApi::Base
+  # Find the series data based on its name.
+  #
+  # access: FREE
+  # param: options hash
+  #   seriesname: TV series name
+  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:GetSeries)
   def get_series(options = {})
     get_series_path_with_params(options).get
   end
 
+  # Find the series data based on its name - return only url.
+  #
+  # access: FREE
+  # param: options hash
+  #   seriesname: TV series name
+  # output: url string
   def get_series_url(options = {})
     get_series_path_with_params(options).url
   end
 
+  # Find the series data by unique ID's used on other sites.
+  #
+  # access: FREE
+  # param: options hash
+  #   imdbid: IMDb ID (don't use with zap2itid)
+  #   zap2itid: Zap2it ID (don't use with imdbid)
+  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:GetSeriesByRemoteID)
   def get_series_by_remote_id(options = {})
     get_series_by_remote_id_path_with_params(options).get
   end
 
+  # Find the series data by unique ID's used on other sites - return only url.
+  #
+  # access: FREE
+  # param: options hash
+  #   seriesid: IMDb ID (don't use with zap2itid)
+  #   zap2itid: Zap2it ID (don't use with imdbid)
+  # output: url string
   def get_series_by_remote_id_url(options = {})
     get_series_by_remote_id_path_with_params(options).url
   end
 
+
+  # Find the episode data by episode air date.
+  #
+  # access: FREE
+  # param: options hash
+  #   seriesid: This is the seriesid for the series you want to use for finding episodes.
+  #   airdate: This is the date the episode aired on you are trying to lookup. This can be supplied in any valid date
+  #            type. Example: 2008-01-01, 2008-1-1, January 1, 2008, 1/1/2008, etc
+  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:GetEpisodeByAirDate)
   def get_episode(options = {})
     get_episode_path_with_params(options).get
   end
 
+
+  # Find the episode data by episode air date - return only url.
+  #
+  # access: FREE
+  # param: options hash
+  #   seriesid: This is the seriesid for the series you want to use for finding episodes.
+  #   airdate: This is the date the episode aired on you are trying to lookup. This can be supplied in any valid date
+  #            type. Example: 2008-01-01, 2008-1-1, January 1, 2008, 1/1/2008, etc
+  # output: url string
   def get_episode_url(options = {})
     get_episode_path_with_params(options).url
   end

data/lib/thetvdb_api/series.rb

@@ -1,16 +1,40 @@
 class ThetvdbApi::Series < ThetvdbApi::Base
+  # Find the series data by series id.
+  #
+  # access: FREE
+  # param: options hash
+  #   series_id: TV series ID
+  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:Base_Series_Record)
   def find(options = {})
     find_path_with_params(options).get
   end
 
+  # Find the series data by series id - return only url.
+  #
+  # access: FREE
+  # param: options hash
+  #   series_id: TV series ID
+  # output: url string
   def find_url(options = {})
     find_path_with_params(options).url
   end
 
+  # Find the full series data by series id.
+  #
+  # access: FREE
+  # param: options hash
+  #   series_id: TV series ID
+  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:Full_Series_Record)
   def find_full(options = {})
     find_full_path_with_params(options).get
   end
 
+  # Find the full series data by series id - return only url.
+  #
+  # access: FREE
+  # param: options hash
+  #   series_id: TV series ID
+  # output: url string
   def find_full_url(options = {})
     find_full_path_with_params(options).url
   end

data/lib/thetvdb_api/update.rb

@@ -1,32 +1,64 @@
 class ThetvdbApi::Update < ThetvdbApi::Base
+  # Find update data.
+  #
+  # access: FREE
+  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:Update_Records)
   def day
     day_path_with_params.get
   end
 
+  # Find update data - url string.
+  #
+  # access: FREE
+  # output: url string
   def day_url
     day_path_with_params.url
   end
 
+  # Find update data.
+  #
+  # access: FREE
+  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:Update_Records)
   def week
     week_path_with_params.get
   end
 
+  # Find update data - url string.
+  #
+  # access: FREE
+  # output: url string
   def week_url
     week_path_with_params.url
   end
 
+  # Find update data.
+  #
+  # access: FREE
+  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:Update_Records)
   def month
     month_path_with_params.get
   end
 
+  # Find update data - url string.
+  #
+  # access: FREE
+  # output: url string
   def month_url
     month_path_with_params.url
   end
 
+  # Find update data.
+  #
+  # access: FREE
+  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:Update_Records)
   def all
     all_path_with_params.get
   end
 
+  # Find update data - url string.
+  #
+  # access: FREE
+  # output: url string
   def all_url
     all_path_with_params.url
   end

data/lib/thetvdb_api/version.rb

@@ -1,3 +1,3 @@
 module ThetvdbApi
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
 end

data/thetvdb_api.gemspec

@@ -18,10 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'faraday', '~> 0.9.0'
-  spec.add_runtime_dependency 'uri_template', '~> 0.7.0'
-  spec.add_runtime_dependency 'multi_xml', '~> 0.5.5'
-  spec.add_runtime_dependency 'service_api', '~> 0.0.4'
+  spec.add_runtime_dependency 'service_api', '~> 0.0.5'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

metadata

@@ -1,71 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: thetvdb_api
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Krzysztof Wawer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-23 00:00:00.000000000 Z
+date: 2014-08-31 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-- !ruby/object:Gem::Dependency
-  name: uri_template
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-- !ruby/object:Gem::Dependency
-  name: multi_xml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.5.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.5.5
 - !ruby/object:Gem::Dependency
   name: service_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement