thetvdb_api 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4dbe78e1e66f145fec0db2f40aad36ff573c0956
-  data.tar.gz: 530b460304b87029fa61bab4581518bc1f54b7f7
+  metadata.gz: 3126b9fe360eb24809166f9de6477785b90d8774
+  data.tar.gz: fb816d9de43b4d28198b5921ad34753eac59198e
 SHA512:
-  metadata.gz: b14ac566eb33f5da78352a0c5d890055066f025c86e7287bd6837063158a3d8e11b7f0ffa5ffc9e4c60e7c3fde393a141038103adebf4dbc1f0538bb118361e8
-  data.tar.gz: b9dbd2246a575db7199c1efcd82fd782628f33a18b69ecefb52ad00e86a02f2b5ea9fded43dc72667d27a2689d8f84a9fd03747f6c626b66f91aa11f61e5bbc6
+  metadata.gz: 9d192a544f0fa46dc2d91376d3912e466e76e465082e7e21954bdde486dbcb43957aa40232d96412776e48e0e80dbb8a35637e0034925d2cf6bb98088ef54d65
+  data.tar.gz: f2e07b40ad52056bc1ab1cb9027672e275b191b49812989e97c203314a8b075f2ecdcf2c06ad61577cd1c835119bf80b63a9dce400e53738a188e55558a2739a

data/README.md

@@ -2,6 +2,7 @@
 [![Dependency Status](https://gemnasium.com/wafcio/thetvdb_api.png)](https://gemnasium.com/wafcio/thetvdb_api)
 [![Code Climate](https://codeclimate.com/github/wafcio/thetvdb_api.png)](https://codeclimate.com/github/wafcio/thetvdb_api)
 [![Coverage Status](https://coveralls.io/repos/wafcio/thetvdb_api/badge.png)](https://coveralls.io/r/wafcio/thetvdb_api)
+[![Gem Version](https://badge.fury.io/rb/thetvdb_api.png)](http://badge.fury.io/rb/thetvdb_api)
 
 # ThetvdbApi
 
@@ -14,40 +15,78 @@ You can add it to your Gemfile with:
 ```ruby
 gem 'thetvdb_api'
 ```
+
 Run the bundle command to install it.
 
-After you install Devise and add it to your Gemfile, you need to run the generator:
+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.
+The generator will install an initializer where you must past your api_key, and can past: language (2 letters abbrevation), api_url (base url).
 
 ## How to use
 
-All request class return instance where result method contain object or collection.
+There is one entry point, in initialize you can past hash with api_key, language and api_url values, or leave empty:
 
-For example:
-```console
-series = ThetvdbApi::Request::Series.find('buffy')
-series.result
-=> #<ThetvdbApi::Series ...>
-```
-
-* ThetvdbApi::Request::Actor.all(series_id) - return all banners for specific series
-* ThetvdbApi::Request::Banner.all(series_id) - return all banners for specific series
-* ThetvdbApi::Request::Episode.find_by_default_order(series_id, season, episode) - return episode
-* ThetvdbApi::Request::Episode.find_by_dvd_order(series_id, season, episode) - return episode
-* ThetvdbApi::Request::Episode.find_by_absolute_order(series_id, absolute) - return episode
-* ThetvdbApi::Request::Episode.find(episode_id) - return episode
-* ThetvdbApi::Request::Series.find(series_id) - return series
-* ThetvdbApi::Request::Series.find_full(series_id) - return hash with series data and all episodes
-* ThetvdbApi::Request::Update.day - return series updates from last day
-* ThetvdbApi::Request::Update.week - return series updates from last week
-* ThetvdbApi::Request::Update.month - return series updates from last month
-* ThetvdbApi::Request::Update.all - return all series updates
+```ruby
+client = ThetvdbApi::Client.new(api_url: '...', api_key: '...', language: 'en')
+```
+
+Search series by name
+
+```ruby
+client = ThetvdbApi::Client.new
+client.search.get_series('buffy')
+client.search.get_series_by_imdb_id('...')
+client.search.get_series_by_zap2it_id('...')
+client.search.get_episode_by_air_date('123', air_date)
+```
+
+Search series by id
+
+```ruby
+client = ThetvdbApi::Client.new
+client.series.find('123')
+client.series.find_full('123')
+```
+
+Return series actors
+
+```ruby
+client = ThetvdbApi::Client.new
+client.actor.all(series_id)
+```
+
+Return series banners
+
+```ruby
+client = ThetvdbApi::Client.new
+client.banner.all(series_id)
+```
+
+Return series episode
+
+```ruby
+client = ThetvdbApi::Client.new
+client.episode.find_by_default_order(series_id, season, episode)
+client.episode.find_by_dvd_order(series_id, season, episode)
+client.episode.find_by_absolute_order(series_id, absolute)
+client.episode.find(episode_id)
+```
+
+Get updates
+
+```ruby
+client = ThetvdbApi::Client.new
+client.update.day
+client.update.week
+client.update.month
+client.update.all
+```
 
+In each response you get pure hash, without any coerce or key mapping.
 
 ## Contributing
 

data/lib/thetvdb_api/actor.rb

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

data/lib/thetvdb_api/banner.rb

@@ -1,11 +1,5 @@
 class ThetvdbApi::Banner < ThetvdbApi::Base
-  replace_key :Series, :series_id
-
-  coerce_key :id, Integer
-  coerce_key :rating, Float
-  coerce_key :rating_count, Integer
-  coerce_key :season, Integer
-  coerce_key :series_id, Integer
-  coerce_key :season_num, Integer
-  coerce_key :time, Time
+  def find(series_id)
+    get("#{series_uri(series_id)}banners.xml").response
+  end
 end

data/lib/thetvdb_api/base.rb

@@ -1,7 +1,46 @@
-require 'hashie'
+require 'httparty'
 
-class ThetvdbApi::Base < Hashie::Mash
-  include Hashie::Extensions::MethodAccess
-  include Hashie::Extensions::KeyReplace
-  include Hashie::Extensions::Coercion
+class ThetvdbApi::Base
+  include HTTParty
+
+  attr_reader :client, :uri, :options
+
+  def initialize(client)
+    @client = client
+  end
+
+  def get(uri, options = {})
+    @uri = uri
+    @options = options
+
+    self
+  end
+
+  def response
+    response = self.class.get(uri, request_options(options))
+    response.code == 200 ? response.parsed_response : nil
+  end
+
+  def request_options(options = {})
+    {
+      query: options,
+      base_uri: api_url
+    }
+  end
+
+  def series_uri(series_id)
+    "#{api_key}/series/#{series_id}/"
+  end
+
+  def api_url
+    client.api_url
+  end
+
+  def api_key
+    client.api_key
+  end
+
+  def language
+    client.language
+  end
 end

data/lib/thetvdb_api/client.rb

@@ -0,0 +1,34 @@
+class ThetvdbApi::Client
+  attr_reader :api_key, :api_url, :language
+
+  def initialize(options = {})
+
+    @api_key = options[:api_key] ? options[:api_key] : ThetvdbApi::Configuration.api_key
+    @api_url = options[:api_url] ? options[:api_url] : ThetvdbApi::Configuration.api_url
+    @language = options[:language] ? options[:language] : ThetvdbApi::Configuration.language
+  end
+
+  def search
+    @search ||= ThetvdbApi::Search.new(self)
+  end
+
+  def series
+    @series ||= ThetvdbApi::Series.new(self)
+  end
+
+  def actor
+    @actor ||= ThetvdbApi::Actor.new(self)
+  end
+
+  def banner
+    @banner ||= ThetvdbApi::Banner.new(self)
+  end
+
+  def episode
+    @episode ||= ThetvdbApi::Episode.new(self)
+  end
+
+  def update
+    @update ||= ThetvdbApi::Update.new(self)
+  end
+end

data/lib/thetvdb_api/episode.rb

@@ -1,34 +1,17 @@
 class ThetvdbApi::Episode < ThetvdbApi::Base
-  replace_key :airsafter_season, :airs_after_season
-  replace_key :airsbefore_episode, :airs_before_episode
-  replace_key :airsbefore_season, :airs_before_season
-  replace_key :Combined_episodenumber, :combined_episode_number
-  replace_key :DVD_discid, :dvd_disc_id
-  replace_key :DVD_episodenumber, :dvd_episode_number
-  replace_key :lastupdated, :last_updated_at
-  replace_key :seasonid, :season_id
-  replace_key :series, :series_id
-  replace_key :seriesid, :series_id
-  replace_key :thumb_added, :thumb_added_at
+  def find_by_default_order(series_id, season, episode, language = self.language)
+    get("#{series_uri(series_id)}default/#{season}/#{episode}/#{language}.xml").response
+  end
 
-  coerce_key :id, Integer
-  coerce_key :absolute_number, Integer
-  coerce_key :combined_episode_number, Integer
-  coerce_key :combined_season, Integer
-  coerce_key :director, Array
-  coerce_key :ep_img_flag, Integer
-  coerce_key :episode_number, Integer
-  coerce_key :first_aired, Date
-  coerce_key :guest_stars, Array
-  coerce_key :last_updated_at, Time
-  coerce_key :rating, Float
-  coerce_key :rating_count, Integer
-  coerce_key :season_id, Integer
-  coerce_key :season_number, Integer
-  coerce_key :series_id, Integer
-  coerce_key :thumb_added_at, Time
-  coerce_key :thumb_height, Integer
-  coerce_key :thumb_width, Integer
-  coerce_key :time, Time
-  coerce_key :writer, Array
+  def find_by_dvd_order(series_id, season, episode, language = self.language)
+    get("#{series_uri(series_id)}dvd/#{season}/#{episode}/#{language}.xml").response
+  end
+
+  def find_by_absolute_order(series_id, absolute, language = self.language)
+    get("#{series_uri(series_id)}absolute/#{absolute}/#{language}.xml").response
+  end
+
+  def find(episode_id, language = self.language)
+    get("#{api_key}/episodes/#{episode_id}/#{language}.xml").response
+  end
 end

data/lib/thetvdb_api/search.rb

@@ -0,0 +1,18 @@
+class ThetvdbApi::Search < ThetvdbApi::Base
+  def get_series(name, language = self.language)
+    get('GetSeries.php', seriesname: name, language: language).response
+  end
+
+  def get_series_by_imdb_id(id, language = self.language)
+    get('GetSeriesByRemoteID.php', imdbid: id, language: language).response
+  end
+
+  def get_series_by_zap2it_id(id, language = self.language)
+    get('GetSeriesByRemoteID.php', 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
+  end
+end

data/lib/thetvdb_api/series.rb

@@ -1,20 +1,9 @@
 class ThetvdbApi::Series < ThetvdbApi::Base
-  replace_key :added, :added_at
-  replace_key :lastupdated, :last_updated_at
-  replace_key :seriesid, :series_id
+  def find(series_id, language = self.language)
+    get("#{series_uri(series_id)}#{language}.xml").response
+  end
 
-  coerce_key :id, Integer
-  coerce_key :actors, Array
-  coerce_key :added_at, Time
-  coerce_key :added_by, Integer
-  coerce_key :alias_names, Array
-  coerce_key :first_aired, Date
-  coerce_key :genre, Array
-  coerce_key :last_updated_at, Time
-  coerce_key :network_id, Integer
-  coerce_key :rating, Float
-  coerce_key :rating_count, Integer
-  coerce_key :runtime, Integer
-  coerce_key :series_id, Integer
-  coerce_key :time, Time
+  def find_full(series_id, language = self.language)
+    get("#{series_uri(series_id)}all/#{language}.xml").response
+  end
 end

data/lib/thetvdb_api/update.rb

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

data/lib/thetvdb_api/version.rb

@@ -1,3 +1,3 @@
 module ThetvdbApi
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/thetvdb_api.rb

@@ -1,23 +1,12 @@
-module ThetvdbApi
-  module Request
-    module Module; end
-  end
-end
+module ThetvdbApi; end
 
 require 'thetvdb_api/version'
 require 'thetvdb_api/configuration'
-require 'thetvdb_api/utility'
+require 'thetvdb_api/client'
 require 'thetvdb_api/base'
+require 'thetvdb_api/search'
+require 'thetvdb_api/update'
+require 'thetvdb_api/series'
+require 'thetvdb_api/episode'
 require 'thetvdb_api/actor'
 require 'thetvdb_api/banner'
-require 'thetvdb_api/episode'
-require 'thetvdb_api/series'
-require 'thetvdb_api/request/base'
-require 'thetvdb_api/request/module/find'
-require 'thetvdb_api/request/module/series_uri'
-require 'thetvdb_api/request/search'
-require 'thetvdb_api/request/update'
-require 'thetvdb_api/request/series'
-require 'thetvdb_api/request/episode'
-require 'thetvdb_api/request/actor'
-require 'thetvdb_api/request/banner'

data/spec/integrations/actor_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
-describe ThetvdbApi::Request::Actor do
-  let(:klass) { ThetvdbApi::Request::Actor }
+describe ThetvdbApi::Actor do
+  let(:model) { ThetvdbApi::Actor.new(ThetvdbApi::Client.new) }
 
   describe 'real request' do
-    describe '#find' do
-      it 'should return array' do
-        klass.find('70327').result.class.should == Array
+    describe '.find' do
+      it 'should return hash' do
+        model.find('70327').class.should == Hash
       end
     end
   end

data/spec/integrations/banner_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
-describe ThetvdbApi::Request::Banner do
-  let(:klass) { ThetvdbApi::Request::Banner }
+describe ThetvdbApi::Banner do
+  let(:model) { ThetvdbApi::Banner.new(ThetvdbApi::Client.new) }
 
   describe 'real request' do
-    describe '#find' do
-      it 'should return array' do
-        klass.find('72449').result.class.should == Array
+    describe '.find' do
+      it 'should return hash' do
+        model.find('72449').class.should == Hash
       end
     end
   end

data/spec/integrations/client_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe ThetvdbApi::Client do
+  let(:client) { ThetvdbApi::Client.new }
+
+  describe 'real request' do
+    describe '.search' do
+      describe '.get_series' do
+        it 'should return hash' do
+          client.search.get_series('buffy').class.should == Hash
+        end
+      end
+
+      describe '.get_series_by_imdb_id' do
+        it 'should return hash' do
+          client.search.get_series_by_imdb_id('tt0118276').class.should == Hash
+        end
+      end
+
+      describe '.get_series_by_zap2it_id' do
+        it 'should return hash' do
+          client.search.get_series_by_zap2it_id('EP00213110').class.should == Hash
+        end
+      end
+
+      describe '.get_episode_by_air_date' do
+        it 'should return hash' do
+          client.search.get_episode_by_air_date('70327','1997-03-10').class.should == Hash
+        end
+      end
+    end
+
+    describe '.series' do
+      describe '.find' do
+        it 'should return hash' do
+          client.series.find('70327').class.should == Hash
+        end
+      end
+
+      describe '.find_full' do
+        it 'should return hash' do
+          client.series.find_full('70327').class.should == Hash
+        end
+      end
+    end
+
+    describe '.actor' do
+      describe '.find' do
+        it 'should return hash' do
+          client.actor.find('70327').class.should == Hash
+        end
+      end
+    end
+
+    describe '.banner' do
+      describe '.find' do
+        it 'should return hash' do
+          client.banner.find('70327').class.should == Hash
+        end
+      end
+    end
+
+    describe '.episode' do
+      describe '.find_by_default_order' do
+        it 'should return hash' do
+          client.episode.find_by_default_order('70327', '1', '1').class.should == Hash
+        end
+      end
+
+      describe '.find_by_dvd_order' do
+        it 'should return hash' do
+          client.episode.find_by_dvd_order('70327', '1', '1').class.should == Hash
+        end
+      end
+
+      describe '.find_by_absolute_order' do
+        it 'should return hash' do
+          client.episode.find_by_absolute_order('70327', '1').class.should == Hash
+        end
+      end
+
+      describe '.find' do
+        it 'should return hash' do
+          client.episode.find('533011').class.should == Hash
+        end
+      end
+    end
+
+    describe '.update' do
+      describe '.day' do
+        it 'should return hash' do
+          client.update.day.class.should == Hash
+        end
+      end
+
+      describe '.week' do
+        it 'should return hash' do
+          client.update.week.class.should == Hash
+        end
+      end
+
+      describe '.month' do
+        it 'should return hash' do
+          client.update.month.class.should == Hash
+        end
+      end
+    end
+  end
+end