thetvdb_api 0.2.3.1 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d3d44fe8db10365aae54f5d1aee7c7496699b2c
-  data.tar.gz: dc50fa8f9189685543359490fb3716963f6cb4d0
+  metadata.gz: 5501937cffeedf47be473a7d5c2bc4c3635236b1
+  data.tar.gz: 7f59cde79cdacb935f59c2351b85a96c2c8876a3
 SHA512:
-  metadata.gz: b124defe4f619cfb943ef8eaa456809c7df0421a1b424f3ffc8488e23290892ed40154be2506c554f7435639ba66b3870d126f1a080124e15afc7702fe5d8656
-  data.tar.gz: 68faa1b372bebb00aec6d064157ceec1fe2dba0b13bf4a4c065f1ebee0f6605ea16de4aca7ffac1f91d7124252c9bd5e8d82d66a0f261781a3be0d7713ffe444
+  metadata.gz: e0aff5f795d6e47a7097b61d720b8538408f442165c507165bb410de50848367fb92e842a0ec971291458801ae4eb8a165f7b13602598567f157436331cf65d2
+  data.tar.gz: a29e4a139f4707d9cbf5b8cee2466a911a85fb5010239926ab9ccd8f6643bb06333023f4a9289f74f71f08c7c7d4cc70880fe4195b7a07673a74a43980f8f15c

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
-script: 'bundle exec rspec spec/units && bundle exec rspec spec/functionals && bundle exec rspec spec/units'
+script: 'bundle exec rspec spec/functionals'
 rvm:
   - 1.9.3
   - 2.0.0

data/README.md

@@ -18,14 +18,6 @@ gem 'thetvdb_api'
 
 Run the bundle command to install it.
 
-After you install ThetvdbApi and add it to your Gemfile, you need to run the generator (if you use Ruby on Rails application):
-
-```console
-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).
-
 ## How to use
 
 There is one entry point, in initialize you can past hash with api_key and language values, or leave empty:
@@ -38,80 +30,67 @@ Search series by name
 
 ```ruby
 client = ThetvdbApi::Client.new
-client.search.get_series('buffy', options = {})
-client.search.get_series_url('buffy', options = {}) # return only full url
-client.search.get_series_by_imdb_id(id, options = {})
-client.search.get_series_by_imdb_id_url(id, options = {}) # return only full url
-client.search.get_series_by_zap2it_id(id)
-client.search.get_series_by_zap2it_id_url(id, options = {}) # return only full url
-client.search.get_episode('123', air_date, options = {})
-client.search.get_episode_url('123', air_date, options = {}) # return only full url
+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
 ```
 
 Search series by id
 
 ```ruby
 client = ThetvdbApi::Client.new
-client.series.find('123', options = {})
-client.series.find_url('123', options = {}) # return only full url
-client.series.find_full('123', options = {})
-client.series.find_full_url('123', options = {}) # return only full url
+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::Client.new
-client.actor.all(series_id, options = {})
-client.actor.all_url(series_id, options = {}) # return only full url
+client.actor.all(options = {})
+client.actor.all_url(options = {}) # return only full url
 ```
 
 Return series banners
 
 ```ruby
 client = ThetvdbApi::Client.new
-client.banner.all(series_id, options = {})
-client.banner.all_url(series_id, options = {}) # return only full url
+client.banner.all(options = {})
+client.banner.all_url(options = {}) # return only full url
 ```
 
 Return series episode
 
 ```ruby
 client = ThetvdbApi::Client.new
-client.episode.find_by_default_order(series_id, season, episode, options = {})
-client.episode.find_by_default_order_url(series_id, season, episode, options = {}) # return only full url
-client.episode.find_by_dvd_order(series_id, season, episode, options = {})
-client.episode.find_by_dvd_order_url(series_id, season, episode, options = {}) # return only full url
-client.episode.find_by_absolute_order(series_id, absolute, options = {})
-client.episode.find_by_absolute_order_url(series_id, absolute, options = {}) # return only full url
-client.episode.find(episode_id, options = {})
-client.episode.find_url(episode_id, options = {}) # return only full url
+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
 ```
 
 Get updates
 
 ```ruby
 client = ThetvdbApi::Client.new
-client.update.day(options = {})
-client.update.day_url(options = {}) # return only full url
-client.update.week(options = {})
-client.update.week_url(options = {}) # return only full url
-client.update.month(options = {})
-client.update.month_url(options = {}) # return only full url
-client.update.all(options = {})
-client.update.all_url(options = {}) # return only full url
+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
 ```
-
-ThetvdbApi default return response class with pure xml (in body method) string fetched by Faraday. You can pass
-
-```ruby
-mapping: true
-```
-
-options, and ThetvdbApi will return hash/array objects.
-
-ThetvdbApi give you chance to write own mapper where mapping preformance could be better.
-
 ## Contributing
 
 1. Fork it

data/lib/thetvdb_api/actor.rb

@@ -1,19 +1,19 @@
 class ThetvdbApi::Actor < ThetvdbApi::Base
-  def find(series_id, options = {})
-    find_get_with_params(series_id, options).response(ThetvdbApi::Response::Actors)
+  def find(options = {})
+    find_path_with_params(options).get
   end
 
-  def find_url(series_id)
-    find_get_with_params(series_id).url
-  end
-
-  def find_get_with_params(series_id, options = {})
-    get(find_path).params({ series_id: series_id }.merge(options))
+  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))
+  end
+
   def find_path
-    "#{series_uri}/actors.xml"
+    ':apikey/series/:series_id/actors.xml'
   end
 end

data/lib/thetvdb_api/banner.rb

@@ -1,19 +1,19 @@
 class ThetvdbApi::Banner < ThetvdbApi::Base
-  def find(series_id, options = {})
-    find_get_with_params(series_id, options).response(ThetvdbApi::Response::Banners)
+  def find(options = {})
+    find_path_with_params(options).get
   end
 
-  def find_url(series_id)
-    find_get_with_params(series_id).url
-  end
-
-  def find_get_with_params(series_id, options = {})
-    get(find_path).params({ series_id: series_id }.merge(options))
+  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))
+  end
+
   def find_path
-    "#{series_uri}/banners.xml"
+    ':apikey/series/:series_id/banners.xml'
   end
 end

data/lib/thetvdb_api/base.rb

@@ -1,72 +1,26 @@
 require 'faraday'
 require 'uri_template'
+require 'service_api'
 
 class ThetvdbApi::Base
-  def initialize(client)
-    @client = client
-    @params = {}
-    @mapping = false
-  end
-
-  def connection
-    @connection ||= Faraday.new(url: base_url) do |builder|
-      builder.adapter ThetvdbApi::Configuration.adapter
-    end
-  end
-
-  def get(uri)
-    @uri_template = URITemplate.new(uri)
-    self
-  end
-
-  def params(options)
-    @mapping = options.delete(:mapping)
-    @params = { language: @client.language }.merge(options)
-    self
-  end
-
-  def response(klass = ThetvdbApi::Response)
-    assert_uri_template
-    klass.new(connection.get(uri, @params), @mapping)
-  end
-
-  def prepare_uri
-    assert_uri_template
-    @uri_template.expand(@params.merge(api_key: api_key))
-  end
-
-  def url
-    "#{base_url}#{uri}"
-  end
-
-  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
-
+  include ServiceApi::BaseFaraday
 
-  def series_uri
-    '{api_key}/series/{series_id}'
+  def api_key_options
+    { apikey: @client.options[:api_key] }
   end
 
-  def language
-    @client.language
+  def language_options
+    { language: @client.options[:language] }
   end
 
-  def api_key
-    @client.api_key
+  def api_key_with_language_options
+    api_key_options.merge(language_options)
   end
 
   private
 
-  def assert_uri_template
-    raise "Path doesn't exists, use get(path) to setup path for request" unless @uri_template
+  def uri_kind
+    :colon
   end
 
   def base_url

data/lib/thetvdb_api/client.rb

@@ -1,9 +1,11 @@
 class ThetvdbApi::Client
-  attr_reader :api_key, :language
+  attr_reader :options
 
   def initialize(options = {})
-    @api_key = options[:api_key] ? options[:api_key] : ThetvdbApi::Configuration.api_key
-    @language = options[:language] ? options[:language] : ThetvdbApi::Configuration.language
+    @options = options
+
+    @options[:adapter] ||= :net_http
+    @options[:language] ||= 'en'
   end
 
   def search
@@ -29,4 +31,4 @@ class ThetvdbApi::Client
   def update
     @update ||= ThetvdbApi::Update.new(self)
   end
-end
+end

data/lib/thetvdb_api/episode.rb

@@ -1,68 +1,67 @@
 class ThetvdbApi::Episode < ThetvdbApi::Base
-  def find_by_default_order(series_id, season, episode, options = {})
-    find_by_order('default', series_id, season, episode, options)
+  def find_by_default_order(options = {})
+    find_by_order(options.merge(order: 'default'))
   end
 
-  def find_by_default_order_url(series_id, season, episode, options = {})
-    find_by_order_url('default', series_id, season, episode, options)
+  def find_by_default_order_url(options = {})
+    find_by_order_url(options.merge(order: 'default'))
   end
 
-  def find_by_dvd_order(series_id, season, episode, options = {})
-    find_by_order('dvd', series_id, season, episode, options)
+  def find_by_dvd_order(options = {})
+    find_by_order(options.merge(order: 'dvd'))
   end
 
-  def find_by_dvd_order_url(series_id, season, episode, options = {})
-    find_by_order_url('dvd', series_id, season, episode, options)
+  def find_by_dvd_order_url(options = {})
+    find_by_order_url(options.merge(order: 'dvd'))
   end
 
-  def find_by_absolute_order(series_id, absolute, options = {})
-    find_by_absolute_order_get_with_params(series_id, absolute, options).response(ThetvdbApi::Response::Episode)
+  def find_by_absolute_order(options = {})
+    find_by_absolute_order_path_with_params(options).get
   end
 
-  def find_by_absolute_order_url(series_id, absolute, options = {})
-    find_by_absolute_order_get_with_params(series_id, absolute, options).url
+  def find_by_absolute_order_url(options = {})
+    find_by_absolute_order_path_with_params(options).url
   end
 
-  def find_by_absolute_order_get_with_params(series_id, absolute, options)
-    get(find_by_absolute_order_path).params({ series_id: series_id, absolute: absolute }.merge(options))
+  def find(options = {})
+    find_path_with_params(options).get
   end
 
-  def find(episode_id, options = {})
-    find_get_with_params(episode_id, options).response(ThetvdbApi::Response::Episode)
+  def find_url(options = {})
+    find_path_with_params(options).url
   end
 
-  def find_url(episode_id, options = {})
-    find_get_with_params(episode_id, options).url
-  end
+  private
 
-  def find_get_with_params(episode_id, options)
-    get(find_path).params({ episode_id: episode_id }.merge(options))
+  def find_by_order(options)
+    find_by_order_path_with_params(options).get
   end
 
-  def find_by_order(order, series_id, season, episode, options)
-    find_by_order_get_with_params(order, series_id, season, episode, options).response(ThetvdbApi::Response::Episode)
+  def find_by_order_url(options)
+    find_by_order_path_with_params(options).url
   end
 
-  def find_by_order_url(order, series_id, season, episode, options)
-    find_by_order_get_with_params(order, series_id, season, episode, options).url
+  def find_by_order_path_with_params(options)
+    path(find_by_order_path).params(api_key_with_language_options.merge(options))
   end
 
-  def find_by_order_get_with_params(order, series_id, season, episode, options)
-    get(find_by_order_path).
-      params({ series_id: series_id, season: season, episode: episode, order: order }.merge(options))
+  def find_by_order_path
+    ':apikey/series/:series_id/:order/:season/:episode/:language.xml'
   end
 
-  private
+  def find_by_absolute_order_path_with_params(options)
+    path(find_by_absolute_order_path).params(api_key_with_language_options.merge(options))
+  end
 
   def find_by_absolute_order_path
-    "#{series_uri}/absolute/{absolute}/{language}.xml"
+    ':apikey/series/:series_id/absolute/:absolute/:language.xml'
   end
 
-  def find_path
-    '{api_key}/episodes/{episode_id}/{language}.xml'
+  def find_path_with_params(options)
+    path(find_path).params(api_key_with_language_options.merge(options))
   end
 
-  def find_by_order_path
-    "#{series_uri}/{order}/{season}/{episode}/{language}.xml"
+  def find_path
+    ':apikey/episodes/:episode_id/:language.xml'
   end
 end

data/lib/thetvdb_api/search.rb

@@ -1,62 +1,50 @@
 class ThetvdbApi::Search < ThetvdbApi::Base
-  def get_series(name, options = {})
-    get_series_get_with_params(name, options).response(ThetvdbApi::Response::SearchMultipleSeries)
+  def get_series(options = {})
+    get_series_path_with_params(options).get
   end
 
-  def get_series_url(name, options = {})
-    get_series_get_with_params(name, options).url
+  def get_series_url(options = {})
+    get_series_path_with_params(options).url
   end
 
-  def get_series_get_with_params(name, options)
-    get(get_series_path).params({ seriesname: name }.merge(options))
+  def get_series_by_remote_id(options = {})
+    get_series_by_remote_id_path_with_params(options).get
   end
 
-  def get_series_by_imdb_id(id, options = {})
-    get_series_by_imdb_id_get_with_params(id, options).response(ThetvdbApi::Response::SearchSeries)
+  def get_series_by_remote_id_url(options = {})
+    get_series_by_remote_id_path_with_params(options).url
   end
 
-  def get_series_by_imdb_id_url(id, options = {})
-    get_series_by_imdb_id_get_with_params(id, options).url
+  def get_episode(options = {})
+    get_episode_path_with_params(options).get
   end
 
-  def get_series_by_imdb_id_get_with_params(id, options)
-    get(get_series_by_remote_id_path).params({ imdbid: id }.merge(options))
+  def get_episode_url(options = {})
+    get_episode_path_with_params(options).url
   end
 
-  def get_series_by_zap2it_id(id, options = {})
-    get_series_by_zap2it_id_get_with_params(id, options).response(ThetvdbApi::Response::SearchSeries)
-  end
-
-  def get_series_by_zap2it_id_url(id, options = {})
-    get_series_by_zap2it_id_get_with_params(id, options).url
-  end
-
-  def get_series_by_zap2it_id_get_with_params(id, options)
-    get(get_series_by_remote_id_path).params({ zap2it: id }.merge(options))
-  end
-
-  def get_episode(series_id, air_date, options = {})
-    get_episode_get_with_params(series_id, air_date, options).response(ThetvdbApi::Response::SearchMultipleEpisode)
-  end
-
-  def get_episode_url(series_id, air_date, options = {})
-    get_episode_get_with_params(series_id, air_date, options).url
-  end
+  private
 
-  def get_episode_get_with_params(series_id, air_date, options)
-    get(get_episode_path).params({ seriesid: series_id, airdate: air_date }.merge(options))
+  def get_series_path_with_params(options)
+    path(get_series_path).params(language_options.merge(options))
   end
 
-  private
-
   def get_series_path
     'GetSeries.php'
   end
 
+  def get_series_by_remote_id_path_with_params(options)
+    path(get_series_by_remote_id_path).params(language_options.merge(options))
+  end
+
   def get_series_by_remote_id_path
     'GetSeriesByRemoteID.php'
   end
 
+  def get_episode_path_with_params(options)
+    path(get_episode_path).params(api_key_with_language_options.merge(options))
+  end
+
   def get_episode_path
     'GetEpisodeByAirDate.php'
   end

data/lib/thetvdb_api/series.rb

@@ -1,35 +1,35 @@
 class ThetvdbApi::Series < ThetvdbApi::Base
-  def find(series_id, options = {})
-    find_get_with_params(series_id, options).response(ThetvdbApi::Response::Series)
+  def find(options = {})
+    find_path_with_params(options).get
   end
 
-  def find_url(series_id, options = {})
-    find_get_with_params(series_id, options).url
+  def find_url(options = {})
+    find_path_with_params(options).url
   end
 
-  def find_get_with_params(series_id, options)
-    get(find_path).params({ series_id: series_id }.merge(options))
+  def find_full(options = {})
+    find_full_path_with_params(options).get
   end
 
-  def find_full(series_id, options = {})
-    find_full_get_with_params(series_id, options).response(ThetvdbApi::Response::FullSeries)
+  def find_full_url(options = {})
+    find_full_path_with_params(options).url
   end
 
-  def find_full_url(series_id, options = {})
-    find_full_get_with_params(series_id, options).url
-  end
+  private
 
-  def find_full_get_with_params(series_id, options)
-    get(find_full_path).params({ series_id: series_id }.merge(options))
+  def find_path_with_params(options)
+    path(find_path).params(api_key_with_language_options.merge(options))
   end
 
-  private
-
   def find_path
-    "#{series_uri}/{language}.xml"
+    ':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))
   end
 
   def find_full_path
-    "#{series_uri}/all/{language}.xml"
+    ':apikey/series/:series_id/all/:language.xml'
   end
 end

data/lib/thetvdb_api/update.rb

@@ -1,67 +1,67 @@
 class ThetvdbApi::Update < ThetvdbApi::Base
-  def day(options = {})
-    day_get_with_params(options).response(ThetvdbApi::Response::Update)
+  def day
+    day_path_with_params.get
   end
 
   def day_url
-    day_get_with_params.url
+    day_path_with_params.url
   end
 
-  def day_get_with_params(options = {})
-    get(day_path).params(options)
-  end
-
-  def week(options = {})
-    week_get_with_params(options).response(ThetvdbApi::Response::Update)
+  def week
+    week_path_with_params.get
   end
 
   def week_url
-    week_get_with_params.url
-  end
-
-  def week_get_with_params(options = {})
-    get(week_path).params(options)
+    week_path_with_params.url
   end
 
-  def month(options = {})
-    month_get_with_params(options).response(ThetvdbApi::Response::Update)
+  def month
+    month_path_with_params.get
   end
 
   def month_url
-    month_get_with_params.url
+    month_path_with_params.url
   end
 
-  def month_get_with_params(options = {})
-    get(month_path).params(options)
-  end
-
-  def all(options = {})
-    all_get_with_params(options).response(ThetvdbApi::Response::Update)
+  def all
+    all_path_with_params.get
   end
 
   def all_url
-    all_get_with_params.url
-  end
-
-  def all_get_with_params(options = {})
-    get(all_path).params(options)
+    all_path_with_params.url
   end
 
   private
 
+  def day_path_with_params
+    path(day_path).params(api_key_options)
+  end
+
   def day_path
-    '{api_key}/updates/updates_day.xml'
+    ':apikey/updates/updates_day.xml'
+  end
+
+  def week_path_with_params
+    path(week_path).params(api_key_options)
   end
 
   def week_path
-    '{api_key}/updates/updates_week.xml'
+    ':apikey/updates/updates_week.xml'
+  end
+
+  def month_path_with_params
+    path(month_path).params(api_key_options)
   end
 
   def month_path
-    '{api_key}/updates/updates_month.xml'
+    ':apikey/updates/updates_month.xml'
+  end
+
+  def all_path_with_params
+    path(all_path).params(api_key_options)
   end
 
   def all_path
-    '{api_key}/updates/updates_all.xml'
+    ':apikey/updates/updates_all.xml'
   end
 end

data/lib/thetvdb_api/version.rb

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