thetvdb_api 0.2.5 → 0.3.0

data/lib/thetvdb_api/search.rb

@@ -2,21 +2,28 @@ 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
+  # param (flat params):
+  #   get_series(series name)
+  #   get_series('Buffy')
+  # param (hash params):
+  #   get_series(name: 'Buffy')
+  # output: Faraday::Response instance with parsed 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
+  # param (flat params):
+  #   get_series_url(series name)
+  #   get_series_url('Buffy')
+  # param (hash params):
+  #   get_series_url(name: 'Buffy')
   # output: url string
-  def get_series_url(options = {})
-    get_series_path_with_params(options).url
+  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.
@@ -25,7 +32,8 @@ class ThetvdbApi::Search < ThetvdbApi::Base
   # 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)
+  # output: Faraday::Response instance with parsed 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
@@ -34,43 +42,92 @@ class ThetvdbApi::Search < ThetvdbApi::Base
   #
   # access: FREE
   # param: options hash
-  #   seriesid: IMDb ID (don't use with zap2itid)
+  #   imdbid: 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 series data by unique IMDB ID
+  #
+  # access: FREE
+  # param (flat params):
+  #   get_series_by_imdb_id(imdb_id)
+  #   get_series_by_imdb_id('tt01234')
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:GetSeriesByRemoteID
+  def get_series_by_imdb_id(imdb_id)
+    get_series_by_remote_id_path_with_params({ imdbid: imdb_id }).get
+  end
+
+  # Find the series data by unique IMDB ID - return only url.
+  #
+  # access: FREE
+  # param (flat params):
+  #   get_series_by_imdb_id_url(imdb_id)
+  #   get_series_by_imdb_id_url('tt01234')
+  # output: url string
+  def get_series_by_imdb_id_url(imdb_id)
+    get_series_by_remote_id_path_with_params({ imdbid: imdb_id }).url
+  end
 
-  # Find the episode data by episode air date.
+  # Find the series data by unique zap2it ID
+  #
+  # access: FREE
+  # param (flat params):
+  #   get_series_by_zap2it_id(zap2it_id)
+  #   get_series_by_zap2it_id('SH01234')
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:GetSeriesByRemoteID
+  def get_series_by_zap2it_id(zap2it_id)
+    get_series_by_remote_id_path_with_params({ zap2itid: zap2it_id }).get
+  end
+
+  # Find the series data by unique zap2it ID - 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: XML string (example: http://thetvdb.com/wiki/index.php/API:GetEpisodeByAirDate)
-  def get_episode(options = {})
-    get_episode_path_with_params(options).get
+  #   get_series_by_zap2it_id_url(zap2it_id)
+  #   get_series_by_zap2it_id_url('SH01234')
+  # output: url string
+  def get_series_by_zap2it_id_url(zap2it_id)
+    get_series_by_remote_id_path_with_params({ zap2itid: zap2it_id }).url
+  end
+
+
+  # Find the episode data by episode air date.
+  #
+  # access: FREE
+  # param (flat params):
+  #   get_episode(series_id, air date)
+  #   get_episode(1234, '2000-01-01')
+  # param (hash params):
+  #   get_episode(series_id: 1234, air_date: '2000-01-01')
+  # output: Faraday::Response instance with parsed 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
+  # param (flat params):
+  #   get_episode_url(series_id, air date)
+  #   get_episode_url(1234, '2000-01-01')
+  # param (hash params):
+  #   get_episode_url(series_id: 1234, air_date: '2000-01-01')
   # output: url string
-  def get_episode_url(options = {})
-    get_episode_path_with_params(options).url
+  def get_episode_url(*options)
+    get_episode_path_with_params(*options).url
   end
 
   private
 
-  def get_series_path_with_params(options)
-    path(get_series_path).params(language_options.merge(options))
+  def get_series_path_with_params(*options)
+    path(get_series_path).params(language_options.merge(normalize_series_name_options(*options)))
   end
 
   def get_series_path
@@ -85,8 +142,8 @@ class ThetvdbApi::Search < ThetvdbApi::Base
     'GetSeriesByRemoteID.php'
   end
 
-  def get_episode_path_with_params(options)
-    path(get_episode_path).params(api_key_with_language_options.merge(options))
+  def get_episode_path_with_params(*options)
+    path(get_episode_path).params(api_key_with_language_options.merge(normalize_series_id_air_date_options(*options)))
   end
 
   def get_episode_path

data/lib/thetvdb_api/series.rb

@@ -2,55 +2,69 @@ 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
+  # 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: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
+  # 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
 
   # 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
+  # param (flat params):
+  #   find_full(series_id)
+  #   find_full(1234)
+  # param (hash params):
+  #   find_full(series_id: 1234)
+  # output: Faraday::Response instance with parsed 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
+  # param (flat params):
+  #   find_full_url(series_id)
+  #   find_full_url(1234)
+  # param (hash params):
+  #   find_full_url(series_id: 1234)
   # output: url string
-  def find_full_url(options = {})
-    find_full_path_with_params(options).url
+  def find_full_url(*options)
+    find_full_path_with_params(*options).url
   end
 
   private
 
-  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_series_id_options(*options)))
   end
 
   def find_path
     ':apikey/series/:series_id/:language.xml'
   end
 
-  def find_full_path_with_params(options)
-    path(find_full_path).params(api_key_with_language_options.merge(options))
+  def find_full_path_with_params(*options)
+    path(find_full_path).params(api_key_with_language_options.merge(normalize_series_id_options(*options)))
   end
 
   def find_full_path

data/lib/thetvdb_api/update.rb

@@ -2,7 +2,8 @@ class ThetvdbApi::Update < ThetvdbApi::Base
   # Find update data.
   #
   # access: FREE
-  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:Update_Records)
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:Update_Records
   def day
     day_path_with_params.get
   end
@@ -18,7 +19,8 @@ class ThetvdbApi::Update < ThetvdbApi::Base
   # Find update data.
   #
   # access: FREE
-  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:Update_Records)
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:Update_Records
   def week
     week_path_with_params.get
   end
@@ -34,7 +36,8 @@ class ThetvdbApi::Update < ThetvdbApi::Base
   # Find update data.
   #
   # access: FREE
-  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:Update_Records)
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:Update_Records
   def month
     month_path_with_params.get
   end
@@ -50,7 +53,8 @@ class ThetvdbApi::Update < ThetvdbApi::Base
   # Find update data.
   #
   # access: FREE
-  # output: XML string (example: http://thetvdb.com/wiki/index.php/API:Update_Records)
+  # output: Faraday::Response instance with parsed XML string
+  # example: http://thetvdb.com/wiki/index.php/API:Update_Records
   def all
     all_path_with_params.get
   end

data/lib/thetvdb_api/version.rb

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

data/spec/functionals/actor_spec.rb

@@ -13,18 +13,38 @@ describe ThetvdbApi::Actor do
   end
 
   describe '.find' do
-    it 'should return Faraday::Response class' do
-      model.find(series_id: 1234).class.should == Faraday::Response
+    context 'hash attributes' do
+      it 'should return Faraday::Response class' do
+        expect(model.find(series_id: 1234)).to be_a(Faraday::Response)
+      end
+
+      it 'should return Hash class for body reponse' do
+        expect(model.find(series_id: 1234).body).to be_a(Hash)
+      end
     end
 
-    it 'should return Hash class for body reponse' do
-      model.find(series_id: 1234).body == Hash
+    context 'normal attributes' do
+      it 'should return Faraday::Response class' do
+        expect(model.find(1234)).to be_a(Faraday::Response)
+      end
+
+      it 'should return Hash class for body reponse' do
+        expect(model.find(1234).body).to be_a(Hash)
+      end
     end
   end
 
   describe '.find_url' do
-    it 'should return correct url' do
-      model.find_url(series_id: 1234).should == 'http://thetvdb.com/api/123456789/series/1234/actors.xml'
+    context 'hash attributes' do
+      it 'should return correct url' do
+        expect(model.find_url(series_id: 1234)).to eq('http://thetvdb.com/api/123456789/series/1234/actors.xml')
+      end
+    end
+
+    context 'normal attributes' do
+      it 'should return correct url' do
+        expect(model.find_url(1234)).to eq('http://thetvdb.com/api/123456789/series/1234/actors.xml')
+      end
     end
   end
 end

data/spec/functionals/banner_spec.rb

@@ -13,18 +13,38 @@ describe ThetvdbApi::Banner do
   end
   
   describe '.find' do
-    it 'should return Faraday::Response class' do
-      model.find(series_id: 1234).class.should == Faraday::Response
+    context 'hash attributes' do
+      it 'should return Faraday::Response class' do
+        expect(model.find(series_id: 1234)).to be_a(Faraday::Response)
+      end
+
+      it 'should return Hash class for body reponse' do
+        expect(model.find(series_id: 1234).body).to be_a(Hash)
+      end
     end
 
-    it 'should return Hash class for body reponse' do
-      model.find(series_id: 1234).body == Hash
+    context 'normal attributes' do
+      it 'should return Faraday::Response class' do
+        expect(model.find(1234)).to be_a(Faraday::Response)
+      end
+
+      it 'should return Hash class for body reponse' do
+        expect(model.find(1234).body).to be_a(Hash)
+      end
     end
   end
 
   describe '.find_url' do
-    it 'should return correct url' do
-      model.find_url(series_id: 1234).should == 'http://thetvdb.com/api/123456789/series/1234/banners.xml'
+    context 'hash attributes' do
+      it 'should return correct url' do
+        expect(model.find_url(series_id: 1234)).to eq('http://thetvdb.com/api/123456789/series/1234/banners.xml')
+      end
+    end
+
+    context 'normal attributes' do
+      it 'should return correct url' do
+        expect(model.find_url(1234)).to eq('http://thetvdb.com/api/123456789/series/1234/banners.xml')
+      end
     end
   end
 end

data/spec/functionals/base_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+class SampleClass < ThetvdbApi::Base; end
+
+describe ThetvdbApi::Base do
+  let(:model) { SampleClass.new({}) }
+
+  describe '.normalize_series_id_options' do
+    it 'return correct hash with normal attributes' do
+      expect(model.normalize_series_id_options(1234)).
+        to eq({ series_id: 1234 })
+    end
+
+    it 'return correct hash with hash attributes' do
+      expect(model.normalize_series_id_options(series_id: 1234)).
+        to eq({ series_id: 1234 })
+    end
+  end
+
+  describe '.normalize_series_id_absolute_options' do
+    it 'return correct hash with normal attributes' do
+      expect(model.normalize_series_id_absolute_options(1234, 1)).
+        to eq({ series_id: 1234, absolute: 1 })
+    end
+
+    it 'return correct hash with hash attributes' do
+      expect(model.normalize_series_id_absolute_options(series_id: 1234, absolute: 1)).
+        to eq({ series_id: 1234, absolute: 1 })
+    end
+  end
+
+  describe '.normalize_series_id_episode_options' do
+    it 'normalize_series_id_episode_options' do
+      expect(model.normalize_series_id_episode_options(1234, 1, 2)).
+        to eq({ series_id: 1234, season: 1, episode: 2 })
+    end
+
+    it 'return correct hash with hash attributes' do
+      expect(model.normalize_series_id_episode_options(series_id: 1234, season: 1, episode: 2)).
+        to eq({ series_id: 1234, season: 1, episode: 2 })
+    end
+  end
+
+  describe '.normalize_episode_id_options' do
+    it 'return correct hash with normal attributes' do
+      expect(model.normalize_episode_id_options(1234)).
+        to eq({ episode_id: 1234 })
+    end
+
+    it 'return correct hash with hash attributes' do
+      expect(model.normalize_episode_id_options(episode_id: 1234)).
+        to eq({ episode_id: 1234 })
+    end
+  end
+
+  describe '.normalize_series_name_options' do
+    it 'return correct hash with normal attributes' do
+      expect(model.normalize_series_name_options('Buffy')).
+        to eq({ seriesname: 'Buffy' })
+    end
+
+    it 'return correct hash with hash attributes' do
+      expect(model.normalize_series_name_options(name: 'Buffy')).
+        to eq({ seriesname: 'Buffy' })
+    end
+  end
+
+  describe '.normalize_series_id_air_date_options' do
+    it 'return correct hash with normal attributes' do
+      expect(model.normalize_series_id_air_date_options('1234', '2000-01-01')).
+        to eq({ seriesid: '1234', airdate: '2000-01-01' })
+    end
+
+    it 'return correct hash with hash attributes' do
+      expect(model.normalize_series_id_air_date_options(series_id: '1234', air_date: '2000-01-01')).
+        to eq({ seriesid: '1234', airdate: '2000-01-01' })
+    end
+  end
+end

data/spec/functionals/episode_spec.rb

@@ -16,70 +16,162 @@ describe ThetvdbApi::Episode do
   end
 
   describe '.find_by_default_order' do
-    it 'should return Faraday::Response class' do
-      model.find_by_default_order(series_id: 1234, season: 1, episode: 1).class.should == Faraday::Response
+    context 'hash attributes' do
+      it 'should return Faraday::Response class' do
+        expect(model.find_by_default_order(series_id: 1234, season: 1, episode: 1)).to be_a(Faraday::Response)
+      end
+
+      it 'should return Hash class for body reponse' do
+        expect(model.find_by_default_order(series_id: 1234, season: 1, episode: 1).body).to be_a(Hash)
+      end
     end
 
-    it 'should return Hash class for body reponse' do
-      model.find_by_default_order(series_id: 1234, season: 1, episode: 1).body == Hash
+    context 'normal attributes' do
+      it 'should return Faraday::Response class' do
+        expect(model.find_by_default_order(1234, 1, 1)).to be_a(Faraday::Response)
+      end
+
+      it 'should return Hash class for body reponse' do
+        expect(model.find_by_default_order(1234, 1, 1).body).to be_a(Hash)
+      end
     end
   end
 
   describe '.find_by_default_order_url' do
-    it 'should return correct url' do
-      model.find_by_default_order_url(series_id: 1234, season: 1, episode: 1).
-        should == 'http://thetvdb.com/api/123456789/series/1234/default/1/1/en.xml'
+    context 'hash attributes' do
+      it 'should return correct url' do
+        expect(
+          model.find_by_default_order_url(series_id: 1234, season: 1, episode: 1)
+        ).to eq('http://thetvdb.com/api/123456789/series/1234/default/1/1/en.xml')
+      end
+    end
+
+    context 'normal attributes' do
+      it 'should return correct url' do
+        expect(
+          model.find_by_default_order_url(1234, 1, 1)
+        ).to eq('http://thetvdb.com/api/123456789/series/1234/default/1/1/en.xml')
+      end
     end
   end
 
   describe '.find_by_dvd_order' do
-    it 'should return Faraday::Response class' do
-      model.find_by_dvd_order(series_id: 1234, season: 1, episode: 1).class.should == Faraday::Response
+    context 'hash attributes' do
+      it 'should return Faraday::Response class' do
+        expect(model.find_by_dvd_order(series_id: 1234, season: 1, episode: 1)).to be_a(Faraday::Response)
+      end
+
+      it 'should return Hash class for body reponse' do
+        expect(model.find_by_dvd_order(series_id: 1234, season: 1, episode: 1).body).to be_a(Hash)
+      end
     end
 
-    it 'should return Hash class for body reponse' do
-      model.find_by_dvd_order(series_id: 1234, season: 1, episode: 1).body == Hash
+    context 'normal attributes' do
+      it 'should return Faraday::Response class' do
+        expect(model.find_by_dvd_order(1234, 1, 1)).to be_a(Faraday::Response)
+      end
+
+      it 'should return Hash class for body reponse' do
+        expect(model.find_by_dvd_order(1234, 1, 1).body).to be_a(Hash)
+      end
     end
   end
 
   describe '.find_by_dvd_order_url' do
-    it 'should return correct url' do
-      model.find_by_dvd_order_url(series_id: 1234, season: 1, episode: 1).
-        should == 'http://thetvdb.com/api/123456789/series/1234/dvd/1/1/en.xml'
+    context 'hash attributes' do
+      it 'should return correct url' do
+        expect(
+          model.find_by_dvd_order_url(series_id: 1234, season: 1, episode: 1)
+        ).to eq('http://thetvdb.com/api/123456789/series/1234/dvd/1/1/en.xml')
+      end
+    end
+
+    context 'normal attributes' do
+      it 'should return correct url' do
+        expect(
+          model.find_by_dvd_order_url(1234, 1, 1)
+        ).to eq('http://thetvdb.com/api/123456789/series/1234/dvd/1/1/en.xml')
+      end
     end
   end
 
   describe '.find_by_absolute_order' do
-    it 'should return Faraday::Response class' do
-      model.find_by_absolute_order(series_id: 1234, absolute: 1).class.should == Faraday::Response
+    context 'hash attributes' do
+      it 'should return Faraday::Response class' do
+        expect(model.find_by_absolute_order(series_id: 1234, absolute: 1)).to be_a(Faraday::Response)
+      end
+
+      it 'should return Hash class for body reponse' do
+        expect(model.find_by_absolute_order(series_id: 1234, absolute: 1).body).to be_a(Hash)
+      end
     end
 
-    it 'should return Hash class for body reponse' do
-      model.find_by_absolute_order(series_id: 1234, absolute: 1).body == Hash
+    context 'normal attributes' do
+      it 'should return Faraday::Response class' do
+        expect(model.find_by_absolute_order(1234, 1)).to be_a(Faraday::Response)
+      end
+
+      it 'should return Hash class for body reponse' do
+        expect(model.find_by_absolute_order(1234, 1).body).to be_a(Hash)
+      end
     end
   end
 
   describe '.find_by_absolute_order_url' do
-    it 'should return correct url' do
-      model.find_by_absolute_order_url(series_id: 1234, absolute: 1).
-        should == 'http://thetvdb.com/api/123456789/series/1234/absolute/1/en.xml'
+    context 'hash attributes' do
+      it 'should return correct url' do
+        expect(
+          model.find_by_absolute_order_url(series_id: 1234, absolute: 1)
+        ).to eq('http://thetvdb.com/api/123456789/series/1234/absolute/1/en.xml')
+      end
+    end
+
+    context 'normal attributes' do
+      it 'should return correct url' do
+        expect(
+          model.find_by_absolute_order_url(1234, 1)
+        ).to eq('http://thetvdb.com/api/123456789/series/1234/absolute/1/en.xml')
+      end
     end
   end
 
   describe '.find' do
-    it 'should return Faraday::Response class' do
-      model.find(episode_id: 1234).class.should == Faraday::Response
+    context 'hash attributes' do
+      it 'should return Faraday::Response class' do
+        expect(model.find(episode_id: 1234)).to be_a(Faraday::Response)
+      end
+
+      it 'should return Hash class for body reponse' do
+        expect(model.find(episode_id: 1234).body).to be_a(Hash)
+      end
     end
 
-    it 'should return Hash class for body reponse' do
-      model.find(episode_id: 1234).body == Hash
+    context 'normal attributes' do
+      it 'should return Faraday::Response class' do
+        expect(model.find(1234)).to be_a(Faraday::Response)
+      end
+
+      it 'should return Hash class for body reponse' do
+        expect(model.find(1234).body).to be_a(Hash)
+      end
     end
   end
 
   describe '.find_url' do
-    it 'should return correct url' do
-      model.find_url(episode_id: 1234).
-        should == 'http://thetvdb.com/api/123456789/episodes/1234/en.xml'
+    context 'hash attributes' do
+      it 'should return correct url' do
+        expect(
+          model.find_url(episode_id: 1234)
+        ).to eq('http://thetvdb.com/api/123456789/episodes/1234/en.xml')
+      end
+    end
+
+    context 'normal attributes' do
+      it 'should return correct url' do
+        expect(
+          model.find_url(1234)
+        ).to eq('http://thetvdb.com/api/123456789/episodes/1234/en.xml')
+      end
     end
   end
 end