tvrage_api 0.2.1 → 0.3.0

data/lib/tvrage_api/schedule.rb

@@ -1,43 +1,103 @@
 class TvrageApi::Schedule < TvrageApi::Base
+  include Ov
+
+  # Quick access to TV schedule
+  #
+  # access: FREE
+  # param:
+  #   quick
+  # output: Faraday::Response instance with string
+  let :quick do
+    quick({})
+  end
+
   # Quick access to TV schedule
   #
   # access: FREE
-  # param: options hash
-  #   country: two chars country abbreviation (optional)
+  # param:
+  #   quick('US')
   # output: Faraday::Response instance with string
-  def quick(options = {})
+  let :quick, String do |country|
+    quick(country: country)
+  end
+
+  # Quick access to TV schedule
+  #
+  # access: FREE
+  # param:
+  #   quick(country: 'US')
+  # output: Faraday::Response instance with string
+  let :quick, Hash do |options|
     quick_path_with_params(options).get
   end
 
   # Quick access to TV schedule - return only url
   #
   # access: FREE
-  # param: options hash
-  #   country: two chars country abbreviation (optional)
+  # param:
+  #   quick_url
+  # output: url string
+  let :quick_url do
+    quick_url({})
+  end
+
+  # Quick access to TV schedule - return only url
+  #
+  # access: FREE
+  # param:
+  #   quick_url('US')
   # output: url string
-  def quick_url(options = {})
+  let :quick_url, String do |country|
+    quick_url(country: country)
+  end
+
+  # Quick access to TV schedule - return only url
+  #
+  # access: FREE
+  # param:
+  #   quick_url(country: 'US')
+  # output: url string
+  let :quick_url, Hash do |options|
     quick_path_with_params(options).url
   end
 
   # Full Schedule
   #
   # access: FREE
-  # param: options hash
-  #   country: two chars country abbreviation (optional)
-  #   24_format: 1, time format (optional)
+  # param:
+  #   full
+  # output: Faraday::Response instance with parsed XML string
+  let :full do
+    full({})
+  end
+
+  # Full Schedule
+  #
+  # access: FREE
+  # param:
+  #   full(country: 'US', 24_format: 1)
   # output: Faraday::Response instance with parsed XML string
-  def full(options = {})
+  let :full, Hash do |options|
     full_path_with_params(options).get
   end
 
   # Full Schedule - return only url
   #
   # access: FREE
-  # param: options hash
-  #   country: two chars country abbreviation (optional)
-  #   24_format: 1, time format (optional)
+  # param:
+  #   full_url
+  # output: url string
+  let :full_url do
+    full_url({})
+  end
+
+  # Full Schedule - return only url
+  #
+  # access: FREE
+  # param:
+  #   full_url(country: 'US', 24_format: 1)
   # output: url string
-  def full_url(options = {})
+  let :full_url, Hash do |options|
     full_path_with_params(options).url
   end
 

data/lib/tvrage_api/search.rb

@@ -1,48 +1,94 @@
 class TvrageApi::Search < TvrageApi::Base
+  include Ov
+
+  # Search tv show by name
+  #
+  # access: FREE
+  # param:
+  #   by_name('buffy')
+  # output: Faraday::Response instance with string
+  let :by_name, String do |name|
+    by_name(name: name)
+  end
+
   # Search tv show by name
   #
   # access: FREE
-  # param: options hash
-  #   show: TV show name
+  # param:
+  #   by_name(name: 'buffy')
   # output: Faraday::Response instance with string
-  def by_name(options = {})
+  let :by_name, Hash do |options|
     by_name_path_with_params(options).get
   end
 
   # Search tv show by name - return only url
   #
   # access: FREE
-  # param: options hash
-  #   show: TV show name
+  # param:
+  #   by_name_url('buffy')
   # output: url string
-  def by_name_url(options = {})
+  let :by_name_url, String do |name|
+    by_name_url(name: name)
+  end
+
+  # Search tv show by name - return only url
+  #
+  # access: FREE
+  # param:
+  #   by_name_url(name: 'buffy')
+  # output: url string
+  let :by_name_url, Hash do |options|
     by_name_path_with_params(options).url
   end
 
   # Detailed Search tv show by name
   #
   # access: FREE
-  # param: options hash
-  #   show: TV show name
+  # param:
+  #   full_by_name('buffy')
   # output: Faraday::Response instance with string
-  def full_by_name(options = {})
+  let :full_by_name, String do |name|
+    full_by_name(name: name)
+  end
+
+  # Detailed Search tv show by name
+  #
+  # access: FREE
+  # param (hash params):
+  #   full_by_name(name: 'buffy')
+  # output: Faraday::Response instance with string
+  let :full_by_name, Hash do |options|
     full_by_name_path_with_params(options).get
   end
 
   # Detailed Search tv show by name - return only url
   #
   # access: FREE
-  # param: options hash
-  #   show: TV show name
+  # param:
+  #   full_by_name_url('buffy')
   # output: url string
-  def full_by_name_url(options = {})
+  let :full_by_name_url, String do |name|
+    full_by_name_url(name: name)
+  end
+
+  # Detailed Search tv show by name - return only url
+  #
+  # access: FREE
+  # param:
+  #   full_by_name_url(name: 'buffy')
+  # output: url string
+  let :full_by_name_url, Hash do |options|
     full_by_name_path_with_params(options).url
   end
 
   private
 
+  def mapped_options(options)
+    TvrageApi::AttributesMapping::Search::ByName.new(options).to_hash
+  end
+
   def by_name_path_with_params(options)
-    path(by_name_path).params(options)
+    path(by_name_path).params(mapped_options(options))
   end
 
   def by_name_path
@@ -50,7 +96,7 @@ class TvrageApi::Search < TvrageApi::Base
   end
 
   def full_by_name_path_with_params(options)
-    path(full_by_name_path).params(options)
+    path(full_by_name_path).params(mapped_options(options))
   end
 
   def full_by_name_path

data/lib/tvrage_api/show.rb

@@ -1,85 +1,163 @@
 class TvrageApi::Show < TvrageApi::Base
+  include Ov
+
+  # Show Info
+  #
+  # access: FREE
+  # param:
+  #   find(123)
+  # output: Faraday::Response instance with string
+  let :find, Any do |id|
+    find(id: id)
+  end
+
   # Show Info
   #
   # access: FREE
-  # param: options hash
-  #   sid: TV show ID
+  # param:
+  #   find(id: 123)
   # output: Faraday::Response instance with string
-  def find(options = {})
+  let :find, Hash do |options|
     find_path_with_params(options).get
   end
 
   # Show Info - return only url
   #
   # access: FREE
-  # param: options hash
-  #   sid: TV show ID
+  # param:
+  #   find_url(123)
+  # output: url string
+  let :find_url, Any do |id|
+    find_url(id: id)
+  end
+
+  # Show Info - return only url
+  #
+  # access: FREE
+  # param:
+  #   find_url(id: 123)
   # output: url string
-  def find_url(options = {})
+  let :find_url, Hash do |options|
     find_path_with_params(options).url
   end
 
   # Show Info + Episode List
   #
   # access: FREE
-  # param: options hash
-  #   sid: TV show ID
+  # param:
+  #   find_full(123)
   # output: Faraday::Response instance with string
-  def find_full(options = {})
+  let :find_full, Any do |id|
+    find_full(id: id)
+  end
+
+  # Show Info + Episode List
+  #
+  # access: FREE
+  # param:
+  #   find_full(id: 123)
+  # output: Faraday::Response instance with string
+  let :find_full, Hash do |options|
     find_full_path_with_params(options).get
   end
 
   # Show Info + Episode List - return only url
   #
   # access: FREE
-  # param: options hash
-  #   sid: TV show ID
+  # param:
+  #   find_full_url(123)
   # output: url string
-  def find_full_url(options = {})
+  let :find_full_url, Any do |id|
+    find_full_url(id: id)
+  end
+
+  # Show Info + Episode List - return only url
+  #
+  # access: FREE
+  # param:
+  #   find_full_url(id: 123)
+  # output: url string
+  let :find_full_url, Hash do |options|
     find_full_path_with_params(options).url
   end
 
   # Episode List
   #
   # access: FREE
-  # param: options hash
-  #   sid: TV show ID
+  # param:
+  #   episodes(123)
+  # output: Faraday::Response instance with string
+  let :episodes, Any do |id|
+    episodes(id: id)
+  end
+
+  # Episode List
+  #
+  # access: FREE
+  # param:
+  #   episodes(id: 123)
   # output: Faraday::Response instance with string
-  def episodes(options = {})
+  let :episodes, Hash do |options|
     episodes_path_with_params(options).get
   end
 
+  # Episode List
+  #
+  # access: FREE
+  # param:
+  #   episodes_url(123)
+  # output: url string
+  let :episodes_url, Any do |id|
+    episodes_url(id: id)
+  end
 
   # Episode List
   #
   # access: FREE
-  # param: options hash
-  #   sid: TV show ID
+  # param:
+  #   episodes_url(id: 123)
   # output: url string
-  def episodes_url(options = {})
+  let :episodes_url, Hash do |options|
     episodes_path_with_params(options).url
   end
 
   # Episode Info
   #
   # access: FREE
-  # param: options hash
-  #   sid: TV show ID
-  #   ep: episode name, format [Season Number]x[Episode Number, with zero at the beginning for 1-9]
+  # param:
+  #   episode(123, '1x01')
+  # output: Faraday::Response instance with string
+  let :episode, Any, String do |show_id, episode|
+    episode(show_id: show_id, episode: episode)
+  end
+
+  # Episode Info
+  #
+  # access: FREE
+  # param:
+  #   episode(show_id: 123, episode: '1x01')
   # output: Faraday::Response instance with string
-  def episode(options = {})
+  let :episode, Hash do |options|
     episode_path_with_params(options).get
   end
 
+  # Episode Info - return only url
+  #
+  # access: FREE
+  # param:
+  #   episode_url(123, '1x01')
+  # output: url string
+  let :episode_url, Any, String do |show_id, episode|
+    episode_url(show_id: show_id, episode: episode)
+  end
 
   # Episode Info - return only url
   #
   # access: FREE
-  # param: options hash
-  #   sid: TV show ID
-  #   ep: episode name, format [Season Number]x[Episode Number, with zero at the beginning for 1-9]
+  # param:
+  #   episode_url(show_id: 123, episode: '1x01')
   # output: url string
-  def episode_url(options = {})
+  let :episode_url, Hash do |options|
     episode_path_with_params(options).url
   end
 
@@ -91,7 +169,6 @@ class TvrageApi::Show < TvrageApi::Base
     path(all_path).get
   end
 
-
   # Full Show List - return only url
   #
   # access: FREE
@@ -102,8 +179,12 @@ class TvrageApi::Show < TvrageApi::Base
 
   private
 
+  def find_mapped_options(options)
+    TvrageApi::AttributesMapping::Show::Find.new(options).to_hash
+  end
+
   def find_path_with_params(options)
-    path(find_path).params(options)
+    path(find_path).params(find_mapped_options(options))
   end
 
   def find_path
@@ -111,7 +192,7 @@ class TvrageApi::Show < TvrageApi::Base
   end
 
   def find_full_path_with_params(options)
-    path(find_full_path).params(options)
+    path(find_full_path).params(find_mapped_options(options))
   end
 
   def find_full_path
@@ -119,15 +200,19 @@ class TvrageApi::Show < TvrageApi::Base
   end
 
   def episodes_path_with_params(options)
-    path(episodes_path).params(options)
+    path(episodes_path).params(find_mapped_options(options))
   end
 
   def episodes_path
     'feeds/episode_list.php'
   end
 
+  def episode_mapped_options(options)
+    TvrageApi::AttributesMapping::Show::Episode.new(options).to_hash
+  end
+
   def episode_path_with_params(options)
-    path(episode_path).params(options)
+    path(episode_path).params(episode_mapped_options(options))
   end
 
   def episode_path