thetvdb_api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28b113c3356a7bcc604a2a0127d293423eb5f593
-  data.tar.gz: d2aeb649ef996866b9660c6950898a44f32537f2
+  metadata.gz: 35bc99ae409ce0fdba0ddbdd73f4ac36efbd54a2
+  data.tar.gz: 26f99748d70ae7a86306f5f795013fe14c90c11e
 SHA512:
-  metadata.gz: 6068cbb96817dfe5c64ab60661f365ac4fdf40d57213fc7d4971ec8452b4b79199972ea516b3f0a5f620c546e8679ccae2aa6efe6dbf664fe769899a5292f402
-  data.tar.gz: d35ed5beebcd67dce88b7a70433bf44920b36829c2ae324100a823e17f1ac5903d2360fb5f719695c5aebd07eae8e5034af47bdde3fc5b3e4e1d53b23ddebaa9
+  metadata.gz: 159ee305365dc047e9312107e81168ccb9001492cfa2097b6efb25d5b34a45359d8ea4a042197dbf54e887c75e3a731715b75e6a12df547011205e355cb223c1
+  data.tar.gz: 4a2d708ed8cc0e28f70938cf948dd1fa17481dfc7a82bf41fbd9d90f52f893e85ed49a3e87b146bcfe348c6b71b621c5219659aefea9bbb8f50298ba2d004806

data/README.md

@@ -24,14 +24,14 @@ After you install ThetvdbApi and add it to your Gemfile, you need to run the gen
 rails generate thetvdb_api:install
 ```
 
-The generator will install an initializer where you must past your api_key, and can past: language (2 letters abbrevation), api_url (base url).
+The generator will install an initializer where you must past your api_key, and can past: language (2 letters abbrevation).
 
 ## How to use
 
-There is one entry point, in initialize you can past hash with api_key, language and api_url values, or leave empty:
+There is one entry point, in initialize you can past hash with api_key and language values, or leave empty:
 
 ```ruby
-client = ThetvdbApi::Client.new(api_url: '...', api_key: '...', language: 'en')
+client = ThetvdbApi::Client.new(api_key: '...', language: 'en')
 ```
 
 Search series by name

data/lib/thetvdb_api/actor.rb

@@ -1,5 +1,5 @@
 class ThetvdbApi::Actor < ThetvdbApi::Base
   def find(series_id)
-    get("#{series_uri(series_id)}actors.xml").response
+    get("#{series_uri}/actors.xml").params(series_id: series_id).response
   end
 end

data/lib/thetvdb_api/banner.rb

@@ -1,5 +1,5 @@
 class ThetvdbApi::Banner < ThetvdbApi::Base
   def find(series_id)
-    get("#{series_uri(series_id)}banners.xml").response
+    get("#{series_uri}/banners.xml").params(series_id: series_id).response
   end
 end

data/lib/thetvdb_api/base.rb

@@ -1,35 +1,52 @@
 require 'httparty'
+require 'uri_template'
 
 class ThetvdbApi::Base
   include HTTParty
   base_uri 'http://thetvdb.com/api/'
 
-  attr_reader :client, :uri, :options
-
   def initialize(client)
     @client = client
+    @params = {}
+  end
+
+  def get(uri)
+    @uri_template = URITemplate.new(uri)
+
+    self
   end
 
-  def get(uri, options = {})
-    @uri = uri
-    @options = options
+  def params(options)
+    @params = options
 
     self
   end
 
   def response
-    self.class.get(uri, query: options)
+    @uri_template ? self.class.get(uri, body: @options) : nil
   end
 
-  def series_uri(series_id)
-    "#{api_key}/series/#{series_id}/"
+  def prepare_uri
+    @uri_template ? @uri_template.expand(@params.merge(api_key: @client.api_key)) : nil
   end
 
-  def api_key
-    client.api_key
+  def uri
+    uri = prepare_uri
+    @params.reject!{ |param| restful_param_keys(uri).include?(param.to_s) }
+
+    uri
+  end
+
+  def restful_param_keys(uri_expanded)
+    @uri_template.extract(uri_expanded).keys
+  end
+
+
+  def series_uri
+    '{api_key}/series/{series_id}'
   end
 
   def language
-    client.language
+    @client.language
   end
 end

data/lib/thetvdb_api/client.rb

@@ -2,7 +2,6 @@ class ThetvdbApi::Client
   attr_reader :api_key, :language
 
   def initialize(options = {})
-
     @api_key = options[:api_key] ? options[:api_key] : ThetvdbApi::Configuration.api_key
     @language = options[:language] ? options[:language] : ThetvdbApi::Configuration.language
   end

data/lib/thetvdb_api/episode.rb

@@ -1,21 +1,23 @@
 class ThetvdbApi::Episode < ThetvdbApi::Base
   def find_by_default_order(series_id, season, episode, language = self.language)
-    get("#{series_uri(series_id)}default#{shared_uri_suffix(season, episode, language)}").response
+    find_by_order('default', series_id, season, episode, language)
   end
 
   def find_by_dvd_order(series_id, season, episode, language = self.language)
-    get("#{series_uri(series_id)}dvd#{shared_uri_suffix(season, episode, language)}").response
+    find_by_order('dvd', series_id, season, episode, language)
   end
 
   def find_by_absolute_order(series_id, absolute, language = self.language)
-    get("#{series_uri(series_id)}absolute/#{absolute}/#{language}.xml").response
+    get("#{series_uri}/absolute/{absolute}/{language}.xml").
+      params(series_id: series_id, absolute: absolute, language: language).response
   end
 
   def find(episode_id, language = self.language)
-    get("#{api_key}/episodes/#{episode_id}/#{language}.xml").response
+    get("{api_key}/episodes/{episode_id}/{language}.xml").params(episode_id: episode_id, language: language).response
   end
 
-  def shared_uri_suffix(season, episode, language)
-    "/#{season}/#{episode}/#{language}.xml"
+  def find_by_order(order, series_id, season, episode, language)
+    get("#{series_uri}/{order}/{season}/{episode}/{language}.xml").
+      params(series_id: series_id, season: season, episode: episode, language: language, order: order).response
   end
 end

data/lib/thetvdb_api/search.rb

@@ -1,18 +1,17 @@
 class ThetvdbApi::Search < ThetvdbApi::Base
   def get_series(name, language = self.language)
-    get('GetSeries.php', seriesname: name, language: language).response
+    get('GetSeries.php').params(seriesname: name, language: language).response
   end
 
   def get_series_by_imdb_id(id, language = self.language)
-    get('GetSeriesByRemoteID.php', imdbid: id, language: language).response
+    get('GetSeriesByRemoteID.php').params(imdbid: id, language: language).response
   end
 
   def get_series_by_zap2it_id(id, language = self.language)
-    get('GetSeriesByRemoteID.php', zap2it: id, language: language).response
+    get('GetSeriesByRemoteID.php').params(zap2it: id, language: language).response
   end
 
   def get_episode_by_air_date(series_id, air_date, language = self.language)
-    get('GetEpisodeByAirDate.php', apikey: self.api_key, seriesid: series_id, airdate: air_date, language: language).
-      response
+    get('GetEpisodeByAirDate.php').params(seriesid: series_id, airdate: air_date, language: language).response
   end
 end

data/lib/thetvdb_api/series.rb

@@ -1,9 +1,9 @@
 class ThetvdbApi::Series < ThetvdbApi::Base
   def find(series_id, language = self.language)
-    get("#{series_uri(series_id)}#{language}.xml").response
+    get("#{series_uri}/{language}.xml").params(series_id: series_id, language: language).response
   end
 
   def find_full(series_id, language = self.language)
-    get("#{series_uri(series_id)}all/#{language}.xml").response
+    get("#{series_uri}/all/{language}.xml").params(series_id: series_id, language: language).response
   end
 end

data/lib/thetvdb_api/update.rb

@@ -1,17 +1,17 @@
 class ThetvdbApi::Update < ThetvdbApi::Base
   def day
-    get("#{api_key}/updates/updates_day.xml").response
+    get('{api_key}/updates/updates_day.xml').response
   end
 
   def week
-    get("#{api_key}/updates/updates_week.xml").response
+    get('{api_key}/updates/updates_week.xml').response
   end
 
   def month
-    get("#{api_key}/updates/updates_month.xml").response
+    get('{api_key}/updates/updates_month.xml').response
   end
 
   def all
-    get("#{api_key}/updates/updates_all.xml").response
+    get('{api_key}/updates/updates_all.xml').response
   end
 end

data/lib/thetvdb_api/version.rb

@@ -1,3 +1,3 @@
 module ThetvdbApi
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/spec_helper.rb

@@ -8,5 +8,22 @@ require File.join(File.dirname(__FILE__), 'support/thetvdb_api.rb')
 
 raise 'api_key missing, use ThetvdbApi::Configuration' if ThetvdbApi::Configuration.api_key.empty?
 
+class SampleModel
+  def auth
+    self
+  end
+
+  def get(uri)
+    self
+  end
+
+  def params(options = {})
+    self
+  end
+
+  def response
+  end
+end
+
 RSpec.configure do |config|
 end

data/spec/thetvdb_api/actor_spec.rb

@@ -3,10 +3,17 @@ require 'spec_helper'
 describe ThetvdbApi::Actor do
   let(:klass) { ThetvdbApi::Actor }
   let(:model) { klass.new(ThetvdbApi::Client.new(api_key: '123456789')) }
+  let(:mock_model) { SampleModel.new }
 
   describe '.find' do
-    it 'should call new with specific params' do
-      model.should_receive(:get).with('123456789/series/1234/actors.xml').and_return(double(response: true))
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('{api_key}/series/{series_id}/actors.xml').and_return(mock_model)
+
+      model.find('1234')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(series_id: '1234').and_return(mock_model)
 
       model.find('1234')
     end

data/spec/thetvdb_api/banner_spec.rb

@@ -3,10 +3,17 @@ require 'spec_helper'
 describe ThetvdbApi::Banner do
   let(:klass) { ThetvdbApi::Banner }
   let(:model) { klass.new(ThetvdbApi::Client.new(api_key: '123456789')) }
+  let(:mock_model) { SampleModel.new }
 
   describe '.find' do
-    it 'should call new with specific params' do
-      model.should_receive(:get).with('123456789/series/1234/banners.xml').and_return(double(response: true))
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('{api_key}/series/{series_id}/banners.xml').and_return(mock_model)
+
+      model.find('1234')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(series_id: '1234').and_return(mock_model)
 
       model.find('1234')
     end

data/spec/thetvdb_api/base_spec.rb

@@ -8,44 +8,67 @@ describe ThetvdbApi::Base do
   let(:model) { klass.new(ThetvdbApi::Client.new) }
 
   describe '.get' do
-    it 'should set uri' do
+    it 'should set @uri_template' do
       model.get('http://example.com')
 
-      model.uri.should == 'http://example.com'
+      model.instance_variable_get('@uri_template').class.should == URITemplate::RFC6570
     end
 
-    it 'should set options' do
-      model.get('http://example.com', sample_options: true)
+    it 'should return self' do
+      model.get('http://example.com').should == model
+    end
+  end
+
+  describe '.params' do
+    it 'should set @params' do
+      model.params(sample: 'test')
 
-      model.options.should == { sample_options: true }
+      model.instance_variable_get('@params').should == { sample: 'test' }
     end
 
     it 'should return self' do
-      model.get('http://example.com').should == model
+      model.params(sample: 'test').should == model
     end
   end
 
   describe '.response' do
     it 'should call get klass method' do
+      model.instance_variable_set('@uri_template', URITemplate.new('{api_key}/series/{id}'))
       klass.should_receive(:get)
 
       model.response
     end
   end
 
-  describe '.series_uri' do
-    it 'should use default api_key' do
-      klass.new(ThetvdbApi::Client.new(api_key: 'API_KEY')).series_uri('1234').should == 'API_KEY/series/1234/'
+  describe '.prepare_uri' do
+    it 'should receive correct uri string' do
+      model.instance_variable_set('@uri_template', URITemplate.new('{api_key}/series/{id}'))
+
+      model.prepare_uri.should == "#{ThetvdbApi::Configuration.api_key}/series/"
     end
   end
 
-  describe '.api_key' do
-    it 'should use default api_key' do
-      klass.new(ThetvdbApi::Client.new).api_key.should == ThetvdbApi::Configuration.api_key
+  describe '.uri' do
+    it 'should receive correct uri string' do
+      model.instance_variable_set('@uri_template', URITemplate.new('{api_key}/series/{id}'))
+      model.instance_variable_set('@params', id: '1234')
+
+      model.uri.should == "#{ThetvdbApi::Configuration.api_key}/series/1234"
     end
+  end
 
-    it 'should set api_key' do
-      klass.new(ThetvdbApi::Client.new(api_key: 'API_KEY')).api_key.should == 'API_KEY'
+  describe '.restful_param_keys' do
+    it 'should receive correct uri string' do
+      uri_template = URITemplate.new('{api_key}/series/{id}')
+      model.instance_variable_set('@uri_template', uri_template)
+
+      model.restful_param_keys(uri_template.expand).sort.should == ['api_key', 'id'].sort
+    end
+  end
+
+  describe '.series_uri' do
+    it 'should use default api_key' do
+      klass.new(ThetvdbApi::Client.new(api_key: 'API_KEY')).series_uri.should == '{api_key}/series/{series_id}'
     end
   end
 

data/spec/thetvdb_api/episode_spec.rb

@@ -3,42 +3,61 @@ require 'spec_helper'
 describe ThetvdbApi::Episode do
   let(:klass) { ThetvdbApi::Episode }
   let(:model) { klass.new(ThetvdbApi::Client.new(api_key: '123456789')) }
+  let(:mock_model) { SampleModel.new }
 
   describe '.find_by_default_order' do
-    it 'should call new with specific params' do
-      model.should_receive(:get).with('123456789/series/1234/default/1/1/en.xml').and_return(double(response: true))
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('{api_key}/series/{series_id}/{order}/{season}/{episode}/{language}.xml').and_return(mock_model)
+
+      model.find_by_default_order('1234', '1', '1')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(series_id: '1234', season: '1', episode: '1', language: 'en', order: 'default').and_return(mock_model)
 
       model.find_by_default_order('1234', '1', '1')
     end
   end
 
   describe '.find_by_dvd_order' do
-    it 'should call new with specific params' do
-      model.should_receive(:get).with('123456789/series/1234/dvd/1/1/en.xml').and_return(double(response: true))
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('{api_key}/series/{series_id}/{order}/{season}/{episode}/{language}.xml').and_return(mock_model)
+
+      model.find_by_dvd_order('1234', '1', '1')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(series_id: '1234', season: '1', episode: '1', language: 'en', order: 'dvd').and_return(mock_model)
 
       model.find_by_dvd_order('1234', '1', '1')
     end
   end
 
   describe '.find_by_absolute_order' do
-    it 'should call new with specific params' do
-      model.should_receive(:get).with('123456789/series/1234/absolute/1/en.xml').and_return(double(response: true))
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('{api_key}/series/{series_id}/absolute/{absolute}/{language}.xml').and_return(mock_model)
+
+      model.find_by_absolute_order('1234', '1')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(series_id: '1234', absolute: '1', language: 'en').and_return(mock_model)
 
       model.find_by_absolute_order('1234', '1')
     end
   end
 
   describe '.find' do
-    it 'should call new with specific params' do
-      model.should_receive(:get).with('123456789/episodes/1234/en.xml').and_return(double(response: true))
+    it 'should call get with specific params' do
+      model.should_receive(:get).with('{api_key}/episodes/{episode_id}/{language}.xml').and_return(mock_model)
 
       model.find('1234')
     end
-  end
 
-  describe '.shared_uri_suffix' do
-    it 'should return correct staring' do
-      model.shared_uri_suffix(1, 2, 'en').should == '/1/2/en.xml'
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(episode_id: '1234', language: 'en').and_return(mock_model)
+
+      model.find('1234')
     end
   end
 end

data/spec/thetvdb_api/search_spec.rb

@@ -3,11 +3,17 @@ require 'spec_helper'
 describe ThetvdbApi::Search do
   let(:klass) { ThetvdbApi::Search }
   let(:model) { klass.new(ThetvdbApi::Client.new(api_key: '123456789')) }
+  let(:mock_model) { SampleModel.new }
 
   describe '.get_series' do
     it 'should call get with specific params' do
-      model.should_receive(:get).with('GetSeries.php', seriesname: 'buffy', language: 'en').
-        and_return(double(response: true))
+      model.should_receive(:get).with('GetSeries.php').and_return(mock_model)
+
+      model.get_series('buffy', 'en')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(seriesname: 'buffy', language: 'en').and_return(mock_model)
 
       model.get_series('buffy', 'en')
     end
@@ -15,8 +21,13 @@ describe ThetvdbApi::Search do
 
   describe '.get_series_by_imdb_id' do
     it 'should call get with specific params' do
-      model.should_receive(:get).with('GetSeriesByRemoteID.php', imdbid: '1234', language: 'en').
-        and_return(double(response: true))
+      model.should_receive(:get).with('GetSeriesByRemoteID.php').and_return(mock_model)
+
+      model.get_series_by_imdb_id('1234', 'en')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(imdbid: '1234', language: 'en').and_return(mock_model)
 
       model.get_series_by_imdb_id('1234', 'en')
     end
@@ -24,8 +35,13 @@ describe ThetvdbApi::Search do
 
   describe '.get_series_by_zap2it_id' do
     it 'should call get with specific params' do
-      model.should_receive(:get).with('GetSeriesByRemoteID.php', zap2it: '1234', language: 'en').
-        and_return(double(response: true))
+      model.should_receive(:get).with('GetSeriesByRemoteID.php').and_return(mock_model)
+
+      model.get_series_by_zap2it_id('1234', 'en')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(zap2it: '1234', language: 'en').and_return(mock_model)
 
       model.get_series_by_zap2it_id('1234', 'en')
     end
@@ -33,8 +49,13 @@ describe ThetvdbApi::Search do
 
   describe '#get_episode_by_air_date' do
     it 'should call get with specific params' do
-      model.should_receive(:get).with('GetEpisodeByAirDate.php', apikey: '123456789', seriesid: '1234',
-        airdate: '2000-01-01', language: 'en').and_return(double(response: true))
+      model.should_receive(:get).with('GetEpisodeByAirDate.php').and_return(mock_model)
+
+      model.get_episode_by_air_date('1234', '2000-01-01', 'en')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(seriesid: '1234', airdate: '2000-01-01', language: 'en').and_return(mock_model)
 
       model.get_episode_by_air_date('1234', '2000-01-01', 'en')
     end

data/spec/thetvdb_api/series_spec.rb

@@ -3,10 +3,17 @@ require 'spec_helper'
 describe ThetvdbApi::Series do
   let(:klass) { ThetvdbApi::Series }
   let(:model) { klass.new(ThetvdbApi::Client.new(api_key: '123456789')) }
+  let(:mock_model) { SampleModel.new }
 
   describe '.find' do
     it 'should call get with specific params' do
-      model.should_receive(:get).with('123456789/series/1234/en.xml').and_return(double(response: true))
+      model.should_receive(:get).with('{api_key}/series/{series_id}/{language}.xml').and_return(mock_model)
+
+      model.find('1234', 'en')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(series_id: '1234', language: 'en').and_return(mock_model)
 
       model.find('1234', 'en')
     end
@@ -14,7 +21,13 @@ describe ThetvdbApi::Series do
 
   describe '.find_full' do
     it 'should call get with specific params' do
-      model.should_receive(:get).with('123456789/series/1234/all/en.xml').and_return(double(response: true))
+      model.should_receive(:get).with('{api_key}/series/{series_id}/all/{language}.xml').and_return(mock_model)
+
+      model.find_full('1234', 'en')
+    end
+
+    it 'should call params with specific params' do
+      model.should_receive(:params).with(series_id: '1234', language: 'en').and_return(mock_model)
 
       model.find_full('1234', 'en')
     end

data/spec/thetvdb_api/update_spec.rb

@@ -3,10 +3,11 @@ require 'spec_helper'
 describe ThetvdbApi::Update do
   let(:klass) { ThetvdbApi::Update }
   let(:model) { klass.new(ThetvdbApi::Client.new(api_key: '123456789')) }
+  let(:mock_model) { SampleModel.new }
 
   describe '.day' do
     it 'should call get with specific params' do
-      model.should_receive(:get).with('123456789/updates/updates_day.xml').and_return(double(response: true))
+      model.should_receive(:get).with('{api_key}/updates/updates_day.xml').and_return(mock_model)
 
       model.day
     end
@@ -14,7 +15,7 @@ describe ThetvdbApi::Update do
 
   describe '.week' do
     it 'should call get with specific params' do
-      model.should_receive(:get).with('123456789/updates/updates_week.xml').and_return(double(response: true))
+      model.should_receive(:get).with('{api_key}/updates/updates_week.xml').and_return(mock_model)
 
       model.week
     end
@@ -22,7 +23,7 @@ describe ThetvdbApi::Update do
 
   describe '.month' do
     it 'should call get with specific params' do
-      model.should_receive(:get).with('123456789/updates/updates_month.xml').and_return(double(response: true))
+      model.should_receive(:get).with('{api_key}/updates/updates_month.xml').and_return(mock_model)
 
       model.month
     end
@@ -30,7 +31,7 @@ describe ThetvdbApi::Update do
 
   describe '.all' do
     it 'should call get with specific params' do
-      model.should_receive(:get).with('123456789/updates/updates_all.xml').and_return(double(response: true))
+      model.should_receive(:get).with('{api_key}/updates/updates_all.xml').and_return(mock_model)
 
       model.all
     end

data/thetvdb_api.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'confiture', '~> 0.1.4'
-  spec.add_dependency 'httparty', '~> 0.12.0'
+  spec.add_runtime_dependency 'httparty', '~> 0.12.0'
+  spec.add_runtime_dependency 'uri_template', '~> 0.6.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thetvdb_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Krzysztof Wawer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-14 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: confiture
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: uri_template
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement