the_tv_db 0.0.1 → 0.0.2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -16,7 +16,39 @@ And then execute:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require "the_tv_db"
+
+api = TheTvDB.new
+
+# You can search for a series name
+api.series.search("Fringe")
+=> [#<TheTvDB::Series::Collection id: "82066", api_id: "82066", banner: "graphical/82066-g38.jpg", first_aired: "2008-08-26", imdb_id: "tt1119644", name: "Fringe", language: "en", overview: "The series follows a Federal Bureau of Investigatio...", zap2it_id: "SH01059103">]
+
+# Once you have the series ID you can use it to find its full information
+series = api.series.find("82066")
+=> #<TheTvDB::Series id: "82066", actors: "|Anna Torv|Joshua Jackson|John Noble|Jasika Nicole|...", added: nil, added_by: nil, airs_day_of_week: "Friday", airs_time: "9:00 PM", banner: "graphical/82066-g38.jpg", content_rating: "TV-14", fanart: "fanart/original/82066-78.jpg", first_aired: "2008-08-26", genre: "|Drama|Science-Fiction|", imdb_id: "tt1119644", language: "en", last_updated: "1351221356", network: "FOX", network_id: nil, overview: "The series follows a Federal Bureau of Investigatio...", rating: "8.7", rating_count: "571", runtime: "60", poster: "posters/82066-53.jpg", series_id: "75146", series_name: "Fringe", status: "Continuing", zap2it_id: "SH01059103">
+
+## ...Even with episodes
+series.episodes
+=> [#<TheTvDB::Episode id: "694851", absolute_number: nil, airs_after_season: nil, airs_before_episode: "1", airs_before_season: "1", combined_episode_number: "1", combined_season: "0", director: nil, dvd_chapter: nil, dvd_disc_id: nil, dvd_episode_number: nil, dvd_season: nil, ep_img_flag: "1", name: "Unaired Pilot", number: "1", filename: "episodes/82066/694851.jpg", first_aired: nil, guest_stars: nil, imdb_id: nil, language: "en", last_updated: "1263338464", overview: nil, production_code: nil, rating: nil, rating_count: "0", season_id: "32605", season_number: "0", series_id: "82066", ... (96 more)
+
+# Some methods require an API key,
+# For example: searching for episodes by air_date
+api.episodes.find(series_id="82066", air_date="2012-11-16")
+TheTvDB::TheTvDBError: You must have an Application Key to use this interface
+
+api = TheTvDB.new(api_key: your_api_key)
+api.episodes.find(series_id="82066", air_date="2012-11-16")
+=> [#<TheTvDB::Episode id: "4393016", absolute_number: nil, airs_after_season: nil, airs_before_episode: nil, airs_before_season: nil, combined_episode_number: "7", combined_season: "5", director: nil, dvd_chapter: nil, dvd_disc_id: nil, dvd_episode_number: nil, dvd_season: nil, ep_img_flag: nil, name: "52010", number: "7", filename: nil, first_aired: "2012-11-16", guest_stars: nil, imdb_id: nil, language: "en", last_updated: "1350927372", overview: "The team orchestrates an event of its own.", production_code: nil, rating: nil, rating_count: nil, season_id: "494897", season_number: "5", series_id: "82066", writer: nil>]
+```
+
+## Feature & Development Roadmap
+
+* Series banners
+* Season posters
+* Fan-art posters
+* List of supported languages
 
 ## Contributing
 

data/lib/the_tv_db/api.rb

@@ -0,0 +1,21 @@
+require "the_tv_db/connection"
+
+module TheTvDB
+  class API
+    extend Connection
+    
+    def initialize(options={}, &block)
+      super()
+      set_api_client
+      self
+
+      self.instance_eval(&block) if block_given?
+    end
+    
+    # Assigns current api class
+    def set_api_client
+      TheTvDB.api_client = self
+    end
+
+  end # API
+end # TheTvDB

data/lib/the_tv_db/client.rb

@@ -0,0 +1,17 @@
+require "the_tv_db/series"
+require "the_tv_db/series/collection"
+require "the_tv_db/episode"
+
+module TheTvDB
+  class Client < API
+        
+    def series
+      Series
+    end
+    
+    def episodes
+      Episode
+    end
+    
+  end # API
+end # TheTvDB

data/lib/the_tv_db/connection.rb

@@ -0,0 +1,25 @@
+require "faraday"
+require "the_tv_db/response"
+require "the_tv_db/response/xmlize"
+
+module TheTvDB
+  module Connection
+    extend self
+    
+    @connection = nil
+    
+    def connection
+      @connection ||= Faraday.new(:url => TheTvDB::ENDPOINT) do |faraday|
+        faraday.response :logger if ENV['DEBUG'] # log requests to STDOUT
+        faraday.adapter  :typhoeus # make requests with Typhoeus
+        faraday.use      TheTvDB::Response::Xmlize
+      end
+    end
+    
+    def request(path, params={})
+      response = connection.get(path, params)
+      response.body
+    end
+    
+  end # Connection
+end # TheTvDB

data/lib/the_tv_db/core_ext/string.rb

@@ -0,0 +1,12 @@
+class String  
+  # Makes an underscored, lowercase form from the expression in the string.
+  def underscore
+    word = self.dup
+    word.gsub!('::', '/')
+    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
+  end
+end

data/lib/the_tv_db/episode.rb

@@ -0,0 +1,81 @@
+module TheTvDB
+  class Episode < API
+    include Model
+    
+    class << self
+      
+      # Public: Find an episode by air date.
+      #
+      # This is useful for shows that don't contain season and episode info, 
+      # but rather have the date in the title.
+      #
+      # series_id  - The ID of the series.
+      # air_date   - The air date of the episode.
+      # lang       - The language of the episode.
+      #
+      # Examples
+      #
+      #    find("82066", "2012-11-16")
+      #    find("82066", "11/16/2012", "fr")
+      #
+      # Returns array of TheTvDB::Episode objects.
+      def find(series_id, air_date=nil, lang="en")
+        data = request("GetEpisodeByAirDate.php", { 
+          apikey:   TheTvDB.api_key,
+          seriesid: series_id,
+          airdate:  air_date,
+          language: lang
+        })["Data"]
+        
+        raise TheTvDBError, data["Error"] if data["Error"]
+        
+        episodes = data["Episode"]
+        
+        case episodes
+        when Hash
+          [ new(episodes) ]
+        when Array
+          episodes.collect { |episode| new(episode) }
+        else
+          []
+        end
+      end
+      alias :get :find
+    end
+    
+    ATTRS_MAP = {
+      :id                      => "id",
+      :absolute_number         => "absolute_number",
+      :airs_after_season       => "airsafter_season",
+      :airs_before_episode     => "airsbefore_episode",
+      :airs_before_season      => "airsbefore_season",
+      :combined_episode_number => "Combined_episodenumber",
+      :combined_season         => "Combined_season",
+      :director                => "Director",
+      :dvd_chapter             => "DVD_chapter",
+      :dvd_disc_id             => "DVD_discid",
+      :dvd_episode_number      => "DVD_episodenumber",
+      :dvd_season              => "DVD_season",
+      :ep_img_flag             => "EpImgFlag",
+      :name                    => "EpisodeName",
+      :number                  => "EpisodeNumber",
+      :filename                => "filename",
+      :first_aired             => "FirstAired",
+      :guest_stars             => "GuestStars",
+      :imdb_id                 => "IMDB_ID",
+      :language                => "Language",
+      :last_updated            => "lastupdated",
+      :overview                => "Overview",
+      :production_code         => "ProductionCode",
+      :rating                  => "Rating",
+      :rating_count            => "RatingCount",
+      :season_id               => "seasonid",
+      :season_number           => "SeasonNumber",
+      :series_id               => "seriesid",
+      :writer                  => "Writer"
+    }.freeze
+    
+    attr_accessor *ATTRS_MAP.keys
+    
+  end # Series
+end # TheTvDB

data/lib/the_tv_db/errors.rb

@@ -0,0 +1,18 @@
+module TheTvDB
+
+  # Generic TheTvDB exception class.
+  class TheTvDBError < StandardError
+  end
+
+  # Raised when a connection to the api can't be established.
+  class ConnectionNotEstablished < StandardError
+  end
+
+  # Raised when the record was not found given an id or set of ids.
+  class RecordNotFound < StandardError
+  end
+
+  # Raised when unknown attributes are supplied via mass assignment.
+  class UnknownAttributeError < NoMethodError
+  end
+end

data/lib/the_tv_db/model.rb

@@ -0,0 +1,53 @@
+module TheTvDB
+  module Model
+    
+    attr_accessor :klass
+    
+    def initialize(params=nil)
+      @klass = self.class
+      self.attributes = params
+    end
+    
+    def attributes=(params=nil)
+      params.each do |attr, value|
+        begin
+          self.public_send("#{klass::ATTRS_MAP.key(attr)}=", value)
+        rescue NoMethodError
+          raise UnknownAttributeError, "unknown attribute: #{attr}"
+        end
+      end if params
+    end
+    
+    def attributes
+      attrs = {}
+      klass::ATTRS_MAP.keys.each do |name|
+        attrs[name] = send(name)
+      end
+      attrs
+    end
+    
+    def inspect
+      inspection = unless id.nil?
+        klass::ATTRS_MAP.keys.collect { |name|
+          "#{name}: #{attribute_for_inspect(name)}"
+        }.compact.join(", ")
+       else
+         "not initialized"
+       end
+      "#<#{self.class} #{inspection}>"
+    end
+    
+    def attribute_for_inspect(attr_name)
+      value = send(attr_name)
+
+      if value.is_a?(String) && value.length > 50
+        "#{value[0..50]}...".inspect
+      elsif value.is_a?(Date) || value.is_a?(Time)
+        %("#{value.to_s(:db)}")
+      else
+        value.inspect
+      end
+    end
+    
+  end # Model
+end # TheTvDB

data/lib/the_tv_db/response/xmlize.rb

@@ -0,0 +1,26 @@
+require "multi_xml"
+
+module TheTvDB
+  class Response::Xmlize < Response
+    dependency 'multi_xml'
+    
+    define_parser do |body|
+      MultiXml.parser = :ox
+      MultiXml.parse body
+    end
+
+    def parse(body)
+      case body
+      when ''
+        nil
+      when 'true'
+        true
+      when 'false'
+        false
+      else
+        self.class.parser.call body
+      end
+    end
+    
+  end # Response::Xmlize
+end # TheTvDB

data/lib/the_tv_db/response.rb

@@ -0,0 +1,24 @@
+module TheTvDB
+  # Contains methods and attributes that act on the response returned from the 
+  # request
+  class Response < Faraday::Response::Middleware
+    CONTENT_TYPE = 'Content-Type'.freeze
+
+    class << self
+      attr_accessor :parser
+    end
+
+    def self.define_parser(&block)
+      @parser = block
+    end
+
+    def response_type(env)
+      env[:response_headers][CONTENT_TYPE].to_s
+    end
+
+    def parse_response?(env)
+      env[:body].respond_to? :to_str
+    end
+
+  end # Response
+end # TheTvDB

data/lib/the_tv_db/series/collection.rb

@@ -0,0 +1,20 @@
+module TheTvDB
+  class Series::Collection
+    include Model
+    
+    ATTRS_MAP = {
+      :id          => "seriesid",
+      :api_id      => "id",
+      :banner      => "banner",
+      :first_aired => "FirstAired",
+      :imdb_id     => "IMDB_ID",
+      :name        => "SeriesName",
+      :language    => "language",
+      :overview    => "Overview",
+      :zap2it_id   => "zap2it_id"
+    }.freeze
+
+    attr_accessor *ATTRS_MAP.keys
+
+  end # Series::Collection
+end # TheTvDB

data/lib/the_tv_db/series.rb

@@ -0,0 +1,75 @@
+module TheTvDB
+  class Series < API
+    include Model
+
+    class << self
+      def search(name, lang="en")
+        data = request("GetSeries.php", { seriesname: name, language: lang })["Data"]
+        return [] if data.nil?
+        
+        series = data["Series"]
+        
+        case series
+        when Hash
+          [ Series::Collection.new(series) ]
+        when Array
+          series.collect { |serie| Series::Collection.new(serie) }
+        else
+          []
+        end
+      end
+      
+      def find(id)
+        data = request("/data/series/#{id}/all/")["Data"]
+        record = new(data["Series"])
+        record.episodes = data["Episode"]
+        return record
+      rescue MultiXml::ParseError
+        raise RecordNotFound, "Couldn't find series with ID=#{id}"
+      end
+      alias :get :find
+    end
+    
+    ATTRS_MAP = {
+      :id               => "id",
+      :actors           => "Actors",
+      :added            => "added",
+      :added_by         => "addedBy",
+      :airs_day_of_week => "Airs_DayOfWeek",
+      :airs_time        => "Airs_Time",
+      :banner           => "banner",
+      :content_rating   => "ContentRating",
+      :fanart           => "fanart",
+      :first_aired      => "FirstAired",
+      :genre            => "Genre",
+      :imdb_id          => "IMDB_ID",
+      :language         => "Language",
+      :last_updated     => "lastupdated",
+      :network          => "Network",
+      :network_id       => "NetworkID",
+      :overview         => "Overview",
+      :rating           => "Rating",
+      :rating_count     => "RatingCount",
+      :runtime          => "Runtime",
+      :poster           => "poster",
+      :series_id        => "SeriesID",
+      :series_name      => "SeriesName",
+      :status           => "Status",
+      :zap2it_id        => "zap2it_id"
+    }.freeze
+    
+    attr_accessor *ATTRS_MAP.keys, :episodes
+    
+    def episodes=(episodes)
+      @episodes = case episodes
+      when Hash
+        [ Episode.new(episodes) ]
+      when Array
+        episodes.collect { |episode| Episode.new(episode) }
+      else
+        []
+      end
+    end
+    
+  end # Series
+end # TheTvDB

data/lib/the_tv_db/version.rb

@@ -1,3 +1,3 @@
 module TheTvDb
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/the_tv_db.rb

@@ -1,4 +1,35 @@
+require "the_tv_db/core_ext/string"
 require "the_tv_db/version"
+require "the_tv_db/errors"
+require "the_tv_db/api"
+require "the_tv_db/model"
+require "the_tv_db/client"
 
-module TheTvDb
-end
+module TheTvDB
+  
+  SITE     = "http://thetvdb.com".freeze
+  ENDPOINT = "http://thetvdb.com/api".freeze
+  
+  class << self
+        
+    # Handle for the client instance
+    attr_accessor :api_client, :api_key
+  
+    def new(options={}, &block)
+      @api_key = options.delete(:api_key)
+      @api_client = TheTvDB::Client.new(options, &block)
+    end
+    
+    # Delegate to TheTvDB::Client
+    #
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+    
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+
+  end # Self
+end # TheTvDB

data/spec/fixtures/episodes/air_date.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<Data>
+<Error>airdate is required for this interface</Error>
+<Episode/>
+</Data>

data/spec/fixtures/episodes/api_key.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<Data>
+<Error>
+You must have an Application Key to use this interface
+</Error>
+<Episode/>
+</Data>

data/spec/fixtures/episodes/result.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<Data>
+<Episode>
+<id>4393016</id>
+<Combined_episodenumber>7</Combined_episodenumber>
+<Combined_season>5</Combined_season>
+<DVD_chapter/>
+<DVD_discid/>
+<DVD_episodenumber/>
+<DVD_season/>
+<Director/>
+<EpImgFlag/>
+<EpisodeName>52010</EpisodeName>
+<EpisodeNumber>7</EpisodeNumber>
+<FirstAired>2012-11-16</FirstAired>
+<GuestStars/>
+<IMDB_ID/>
+<Language>en</Language>
+<Overview>The team orchestrates an event of its own.</Overview>
+<ProductionCode/>
+<Rating/>
+<SeasonNumber>5</SeasonNumber>
+<Writer/>
+<absolute_number/>
+<filename/>
+<lastupdated>1350927372</lastupdated>
+<seasonid>494897</seasonid>
+<seriesid>82066</seriesid>
+</Episode>
+</Data>

data/spec/fixtures/episodes/series_id.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<Data>
+<Error>No Results from SP</Error>
+<Episode/>
+</Data>

data/spec/fixtures/series/404.html

@@ -0,0 +1,39 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<html><head>
+<title>404 Not Found</title>
+<script type="text/javascript">
+//<![CDATA[
+window.__CF=window.__CF||{};window.__CF.AJS={"ga_key":{"ua":"UA-9131861-1","ga_bs":"2"}};
+//]]>
+</script>
+<script type="text/javascript">
+//<![CDATA[
+try{if (!window.CloudFlare) { var CloudFlare=[{verbose:0,p:0,byc:0,owlid:"cf",mirage:{responsive:0,lazy:0},oracle:"9a/82fd4d610b168badf482d8810933fa",paths:{cloudflare:"/cdn-cgi/nexp/aav=1870252173/"},atok:"4fa89040047d9c4e9fe703b2270c89db",zone:"thetvdb.com",rocket:"0",apps:{"ga_key":{"ua":"UA-9131861-1","ga_bs":"2"}}}];var a=document.createElement("script"),b=document.getElementsByTagName("script")[0];a.async=!0;a.src="//ajax.cloudflare.com/cdn-cgi/nexp/aav=4114775854/cloudflare.min.js";b.parentNode.insertBefore(a,b);}}catch(e){};
+//]]>
+</script>
+<script type="text/javascript">
+/* <![CDATA[ */
+var _gaq = _gaq || [];
+_gaq.push(['_setAccount', 'UA-9131861-1']);
+_gaq.push(['_trackPageview']);
+
+(function() {
+var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+})();
+
+(function(b){(function(a){"__CF"in b&&"DJS"in b.__CF?b.__CF.DJS.push(a):"addEventListener"in b?b.addEventListener("load",a,!1):b.attachEvent("onload",a)})(function(){"FB"in b&&"Event"in FB&&"subscribe"in FB.Event&&(FB.Event.subscribe("edge.create",function(a){_gaq.push(["_trackSocial","facebook","like",a])}),FB.Event.subscribe("edge.remove",function(a){_gaq.push(["_trackSocial","facebook","unlike",a])}),FB.Event.subscribe("message.send",function(a){_gaq.push(["_trackSocial","facebook","send",a])}));"twttr"in b&&"events"in twttr&&"bind"in twttr.events&&twttr.events.bind("tweet",function(a){if(a){var b;if(a.target&&a.target.nodeName=="IFRAME")a:{if(a=a.target.src){a=a.split("#")[0].match(/[^?=&]+=([^&]*)?/g);b=0;for(var c;c=a[b];++b)if(c.indexOf("url")===0){b=unescape(c.split("=")[1]);break a}}b=void 0}_gaq.push(["_trackSocial","twitter","tweet",b])}})})})(window);
+/* ]]> */
+</script>
+</head><body><script type="text/javascript">
+//<![CDATA[
+new Image().src = "/cdn-cgi/ping?cf[location]=404&cf[js]=1";
+//]]>
+</script>
+<noscript>
+<img src="/cdn-cgi/ping?cf[location]=404&cf[js]=0" alt="">
+</noscript>
+<h1>Not Found</h1>
+<p>The requested URL /data/series/-1/all/ was not found on this server.</p>
+</body></html>

data/spec/fixtures/series/empty.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<Data></Data>