tv-data-api-clients 0.0.7

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in TheTvDb.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+task :default => ['test:units']
+
+Rake::TestTask.new('test:units') do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/unit/**/*_test.rb']
+  t.verbose = true
+end

data/lib/base.rb

@@ -0,0 +1,2 @@
+require 'base/api/episode'
+require 'base/api/show'

data/lib/base/api/episode.rb

@@ -0,0 +1,104 @@
+module Base
+  module Api
+    class Episode
+
+      include Helpers
+
+      attr_accessor :xml_doc
+
+      def initialize(xml_document)
+        @xml_doc = xml_document
+        self
+      end
+
+      def to_s
+        "#{self.class} #{name || ('Untitled')}"
+      end
+
+      def number;        end
+      def overview;      end
+      def network_id;    end
+      def original_name; end
+      def absolute_number; end
+
+      def usable?
+        number.present?
+      end
+
+      def name
+        if original_name_looks_like_season_or_episode_number?
+          return nil
+        elsif original_name_container_bracketed_digits?
+          return_name = original_name.gsub(/\(\d{2}\)/, '')
+        elsif original_name_looks_like_date?
+          return nil
+        elsif original_name_is_quoted_string?
+          return_name = original_name[1..-2]
+        elsif original_name_has_more_symbols_and_whitespace_than_letters?
+          return nil
+        elsif original_name_is_nonsense_edgecase?
+          return nil
+        end
+        (return_name.present? ? return_name : original_name).strip
+      end
+
+      def air_dates;   []; end
+      def network_ids; []; end
+
+      def attributes
+        {
+          :name            => name,
+          :number          => number,
+          :season_number   => season_number,
+          :absolute_number => absolute_number,
+        }
+      end
+
+      private
+
+        def xpath(path)
+          xml_doc.xpath(path).try(:first).try(:content).try(:strip)
+        end
+
+        def original_name_container_bracketed_digits?
+          original_name =~ /\(\d{2}\)/
+        end
+
+        def original_name_looks_like_season_or_episode_number?
+          on = original_name
+          # Includes both season/series and episode
+          if on =~ /(?:season|series)/i && on =~ /episode/i
+            return true
+          elsif on =~ /\A[eE]\d+\z/
+            return true
+          elsif on =~ /(?:season|series)/i || on =~ /episode/i
+            original_string_length = on.length
+            stripped_episode_name  = on.gsub(/(?:series|season|episode|\s+)/i, '')
+            return (original_string_length >= (stripped_episode_name.length * 2.5))
+          end
+          false
+        end
+
+        def original_name_looks_like_date?
+          parsable_date?(original_name)
+        end
+
+        def original_name_has_more_symbols_and_whitespace_than_letters?
+          symbols = original_name.match(/(\W+)/).to_a.join
+          letters = original_name.match(/(\w+)/).to_a.join
+          symbols.length > letters.length
+        end
+
+        def original_name_is_quoted_string?
+          ona = original_name.chars.to_a
+          ona.first == '"' && ona.last == '"'
+        end
+
+        def original_name_is_nonsense_edgecase?
+          original_name == 'no info'
+        end
+
+    end
+  end
+end
+

data/lib/base/api/show.rb

@@ -0,0 +1,132 @@
+require 'nokogiri'
+
+module Base
+  module Api
+
+    UnprocessableXMLError        = Class.new(RuntimeError)
+    RemoteDocumentRetrievalError = Class.new(RuntimeError)
+
+    class Show
+
+      extend Helpers
+      include Helpers
+
+      attr_accessor :xml_doc, :network
+
+      def initialize(xml_document)
+        @xml_doc = xml_document
+        self
+      end
+
+      def to_s
+        "#{self.class} #{name}"
+      end
+
+      #
+      # Returns a list of attribute hashes, from the Show
+      # calls internal lookup methods, always a hash
+      #
+      def attributes
+        {
+          name:     name,
+          country:  country,
+          started:  started,
+          overview: overview,
+          status:   status
+        }
+      end
+
+      def ==(other)
+        attributes == other.attributes
+      end
+
+      def name
+        if original_name_contains_bracketed_year?
+          original_name.gsub(/\(\d{4}\)/, '').strip
+        elsif original_name_contains_bracketed_country?
+          original_name.gsub(/\([A-Z]{2,3}\)/, '').strip
+        else
+          original_name
+        end
+      end
+
+      def actors;         []; end
+      def air_dates;      []; end
+      def aliases;        []; end
+      def genres;         []; end
+      def remote_ids;     []; end
+      def status;         []; end
+
+      def classification; nil; end
+      def country;        nil; end
+      def language;       nil; end
+      def network;        nil; end
+      def original_name;  nil; end
+      def overview;       nil; end
+      def runtime;        nil; end
+      def started;        nil; end
+
+      def network_id;     raise NotImplementedErorr; end
+
+      private
+
+        def xpath(path)
+          xml_doc.xpath(path).try(:first).try(:content).try(:strip)
+        end
+
+        def original_name_contains_bracketed_year?
+          original_name =~ /\((\d{4})\)/
+        end
+
+        def original_name_contains_bracketed_country?
+          original_name =~ /\([A-Z]{2,3}\)/
+        end
+
+      class << self
+
+        def find(name_or_id)
+          if name_or_id.is_a?(String)
+            find_by_name(name_or_id)
+          elsif name_or_id.is_a?(Integer)
+            find_by_id(name_or_id)
+          end
+        end
+
+        def xml_string(series_id)
+          get_remote_file_as_string(url_for(series_id))
+        end
+
+        def search_xml_string(series_name)
+          get_remote_file_as_string(search_url_for(series_name))
+        end
+
+        def xml_document(series_id)
+          if string = xml_string(series_id)
+            document = Nokogiri::XML(string, 'UTF-8')
+            if not document.root.nil?
+              document
+            else
+              raise UnprocessableXMLError
+            end
+          else
+           raise RemoteDocumentRetrievalError
+          end
+        end
+
+        def search_xml_document(series_name)
+          if string = search_xml_string(series_name)
+            document = Nokogiri::XML(string, 'UTF-8')
+            if not document.root.nil?  
+              document
+            else
+              raise UnprocessableXMLError
+            end
+          else
+            raise RemoteDocumentRetrivalError
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/core_ext/object.rb

@@ -0,0 +1,15 @@
+class Object
+
+  def try(method, *args)
+    send(method, *args) if respond_to? method
+  end
+
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+
+  def present?
+    !blank?
+  end
+
+end

data/lib/helpers.rb

@@ -0,0 +1,22 @@
+require 'open-uri'
+
+module Helpers
+
+  def parsable_date?(date = nil)
+    return false unless date
+    !Date._parse(date).empty?
+  end
+
+  def safely_parse_date(date)
+    begin
+      return Date.parse(date)
+    rescue TypeError, ArgumentError
+      return nil
+    end
+  end
+
+  def get_remote_file_as_string(url)
+    Kernel.open(url)
+  end
+
+end

data/lib/the_tv_db.rb

@@ -0,0 +1,23 @@
+require 'the_tv_db/configuration'
+
+require 'the_tv_db/api/episode'
+require 'the_tv_db/api/episode_list'
+require 'the_tv_db/api/image'
+require 'the_tv_db/api/image_list'
+require 'the_tv_db/api/image_list_helpers'
+require 'the_tv_db/api/mirror'
+require 'the_tv_db/api/mirrors'
+require 'the_tv_db/api/show'
+
+module TheTvDb
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+end

data/lib/the_tv_db/api/episode.rb

@@ -0,0 +1,56 @@
+module TheTvDb
+  module Api
+    class Episode < Base::Api::Episode
+
+      def network_id
+        xpath('.//id').try(:to_i)
+      end
+
+      def season_number
+        sn = xpath('.//SeasonNumber').try(:to_i)
+        (sn.nil? || sn == 0) ? nil : sn
+      end
+
+      def number
+        xpath('.//EpisodeNumber').try(:to_i)
+      end
+
+      def overview
+        xpath('.//Overview')
+      end
+
+      def original_name
+        xpath('.//EpisodeName')
+      end
+
+      def rating
+        r = xpath('.//Rating')
+        if r.to_f > 0
+          return (r.to_f * 10).to_i
+        end
+      end
+
+      def number_of_ratings
+        xpath('.//RatingCount').try(:to_i)
+      end
+
+      def air_dates
+        [ Date.parse(xpath('.//FirstAired'))] rescue []
+      end
+
+      def banner_path
+        # See footnotes
+        # http://thetvdb.com/wiki/index.php?title=Programmers_API#Episode_Image_Notes
+        if (e = xpath('.//EpImgFlag').try(:to_i)) && e <= 2 && i = xpath('.//filename')
+          return "#{TheTvDb::Api::Mirrors.all.first}/banners/#{i}" unless i.blank?
+        end
+      end
+
+      def absolute_number
+        an = xpath('.//absolute_number')
+        an.blank? ? nil : an
+      end
+
+    end
+  end
+end

data/lib/the_tv_db/api/episode_list.rb

@@ -0,0 +1,28 @@
+require 'nokogiri'
+
+module TheTvDb
+  module Api
+    class EpisodeList
+      extend Helpers
+      class << self
+        def get_for(series_id)
+          return [] if series_id.nil?
+          episode_list_xml_document(series_id).xpath('//Episode').collect do |node|
+            TheTvDb::Api::Episode.new(node.unlink)
+          end
+        end
+        private
+          def episode_list_xml_document(series_id)
+            @cached_document_objects ||= Hash.new
+            @cached_document_objects[series_id] = Nokogiri::XML(episode_list_xml_string(series_id), 'UTF-8')
+          end
+          def episode_list_xml_string(series_id)
+            get_remote_file_as_string(episode_list_url(series_id))
+          end
+          def episode_list_url(series_id)
+            "#{Mirrors.all.first}/api/#{TheTvDb.configuration.api_key}/series/#{series_id}/all/en.xml"
+          end
+      end
+    end
+  end
+end

data/lib/the_tv_db/api/image.rb

@@ -0,0 +1,114 @@
+require 'open-uri'
+require 'fastimage'
+
+module TheTvDb
+  module Api
+    class Image
+
+      attr_accessor :xml_node
+
+      def initialize(input_xml_node)
+        @xml_node = input_xml_node
+        self
+      end
+
+      def rating
+        xpath('.//Rating').try(:to_f).try(:round, 1)
+      end
+
+      def type
+        xpath('.//BannerType').try(:to_sym)
+      end
+
+      def language
+        xpath('.//Language').try(:to_sym)
+      end
+
+      def sub_type
+        xpath('.//BannerType2').try(:to_sym) unless subtype_looks_like_dimensions?
+      end
+
+      def path
+        "#{TheTvDb::Api::Mirrors.all.first}/banners/#{xpath('.//BannerPath')}"
+      end
+
+      def network_id
+        xpath('.//id').to_i
+      end
+
+      def widescreen?
+        aspect && (aspect[0].to_f / aspect[1] >= (16.to_f / 9 ))
+      end
+
+      def pixels
+        (width * height).to_i rescue 0
+      end
+
+      def width
+        if subtype_looks_like_dimensions?
+          width_from_subtype
+        elsif can_read_image_file?
+          image_geometry[:width]
+        end
+      end
+
+      def height
+        if subtype_looks_like_dimensions? 
+          height_from_subtype 
+        elsif can_read_image_file?
+          image_geometry[:height]
+        end
+      end
+
+      def aspect
+        if height and width
+          gcd = height.gcd(width)
+          [(width / gcd), (height / gcd)]
+        end
+      end
+
+      private
+
+        def image_geometry
+          unless @image_geometry
+            img = FastImage.size(path)
+            return @image_geometry = {:width => img[0], :height => img[1]}
+          end
+          @image_geometry
+        end
+
+        def can_read_image_file?
+          #
+          # File.readable doesn't exist?
+          #
+          File.readable?(path)
+        end
+
+        def subtype_looks_like_dimensions?
+          xpath('.//BannerType2').match /\A(\d+)x(\d+)\z/
+        end
+
+        def width_from_subtype
+          if xpath('.//BannerType2').match /\A(\d+)x\d+\z/
+            $1.to_i
+          end
+        end
+
+        def height_from_subtype
+          if xpath('.//BannerType2').match /\A\d+x(\d+)\z/
+            $1.to_i
+          end
+        end
+
+        def xpath(xpath_query)
+          pah = xml_node.xpath(xpath_query)
+          if pah.length == 1 
+            pah.try(:first).try(:content).try(:strip)
+          else
+            raise RuntimeError, "Unexpected Number of XML Entities (got #{pah.length}, expected 1)"
+          end
+        end
+
+    end
+  end
+end