ttvdb 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f175e7222b5c8c526e4594e50438168996e2402
-  data.tar.gz: ba8694c7d81d5b004b694bc967ef21b6cac185dc
+  metadata.gz: 64f19e256a1cc6ee78fb68e18b8058f9cc452f8a
+  data.tar.gz: 002b47931f2199e77320ed238e997a68126b60fa
 SHA512:
-  metadata.gz: 444a34b040bb8b3fe64c87c48ae307497cc39034e2dfdc893c1e1901b0b8fe3fc400690be2ef5196f527e7d77893150d56350c44cd44ff4512efe49e2ed49320
-  data.tar.gz: 7c0de0ccc8d84595c9665699d2d7b5db0efaa4ca02437a7dd31076efb4e64fca08fc7bd6e69a7630e50a6aace62356261e52c5dbe8140c5379cc80ab18f0c2df
+  metadata.gz: 1abc5a4db7d907c1b1cc84827c1da232121d594001a742ade3519a8fafc9cb1b71d5dc707fd30b782d16e0bb6826d8377fc0b8442625be76852441fc2f7886af
+  data.tar.gz: e3a4ead1586d3e21ede28cc75aedeb99f8f8dadf612e31847d9e9d664e2b7998283e5cc017deb261df85f21a698297d8497ee8ce0379e7c9c2c58e1fc6dd7e64

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+    - 1.9.3
+    - 2.0.0
+    - 2.1.0

data/README.md

@@ -1,7 +1,14 @@
+[![Build Status](https://travis-ci.org/lotherk/ttvdb.png?branch=master)](https://travis-ci.org/lotherk/ttvdb)
+
 # TTVDB
 
 This is another [TheTVDB.com](http://www.thetvdb.com) API library. The others out there didn't fit my needs (if they even worked).
 
+Source code is available at [github](httsp://github.com/lotherk/ttvdb)
+
+Documentation is available at [rubydoc.info](http://rubydoc.info/github/lotherk/ttvdb)
+
+Gem is available at [rubygems.org](https://rubygems.org/gems/ttvdb)
 
 ## Installation
 
@@ -17,8 +24,19 @@ Or install it yourself as:
 
     $ gem install ttvdb
 
+From source:
+
+    $ git clone https://github.com/lotherk/ttvdb
+    $ cd ttvdb
+    $ rake build
+    $ gem install pkg/ttvdb-VERSION.gem
+
 ## Usage
 
+### Using the CLI tools
+
+
+### Writing Code
 Require the gem
 
 ```ruby
@@ -31,23 +49,17 @@ Create a ```TTVDB::Client``` instance
 client = TTVDB::Client.new(options={})
 ```
 
+Where ```options``` can be:
+
 | key | value | description
 | --- | :---: | --- |
 | ```:api_key``` | api key | Your TheTVDB API Key, *optional* |
 | ```:api_url``` | http://www.thetvdb.com/api/ | API Url, *optional* |
 | ```:language```|```en```,```de```,```fr```,... | The language code to use. Fallback is ```en```, *optional* |
 
-Fetch series by name. Returns an array of series if result count is more than 1.
-
-```ruby
-series = client.get_series "Saber Rider"
-```
-
-Results to an array of 3 ```TTVDB::Series``` instances.
-
 # Example
 
-This is an example script that fetches a series by ARGV. if ARGV is an integer, it ill fetch it by its id otherwise by its name. It will then print a little overview about the series.
+This is an example script that fetches a series by ARGV. if ARGV is an integer, it will fetch it by its id otherwise by its name. It will then print a little overview about the series.
 
 ## Usage
 ```bash
@@ -93,7 +105,7 @@ See the ```examples/``` folder for a complete list of examples. I try to make th
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/ttvdb/fork )
+1. Fork it ( http://github.com/lotherk/ttvdb/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+

data/bin/ttvdb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'ttvdb/cli'
+TTVDB::CLI.main

data/lib/ttvdb.rb

@@ -2,11 +2,24 @@ require "rest-client"
 require "logger"
 require "xmlsimple"
 require "ttvdb/version"
+require "ttvdb/match"
 require "ttvdb/client"
 
 
 module TTVDB
-  def self.logger
-    @logger ||= Logger.new(STDOUT)
+  def self.logger(output=STDOUT)
+    unless @logger
+      @logger = Logger.new(output)
+      @logger.formatter = proc { |severity, datetime, progname, msg|
+        kaller = caller[4]
+        file, ln, func  = kaller.split(":")
+        _nil, func = func.split("`")
+        func.gsub!(/[<>']/, "")
+        file = File.basename(file)
+        "#{datetime} #{severity} #{file}:#{func}:#{ln}: #{msg}\n"
+      }
+      @logger.level = Logger::WARN
+    end
+    @logger
   end
 end

data/lib/ttvdb/cli.rb

@@ -0,0 +1,7 @@
+require 'ttvdb'
+
+module TTVDB::CLI
+  def self.main
+
+  end
+end

data/lib/ttvdb/client.rb

@@ -1,8 +1,9 @@
+require 'ttvdb/parser'
 require 'ttvdb/series'
 require 'ttvdb/episode'
 
 class TTVDB::Client
-  attr_writer :language
+  attr_accessor :language
 
   def initialize(opts = {})
     @opts = {
@@ -15,47 +16,38 @@ class TTVDB::Client
   end
 
   def get_series_by_id id
-    lookup = "series/#{id}/#{@opts[:language]}.xml"
-    begin
-      hsh = XmlSimple.xml_in(client[lookup].get)
-      return TTVDB::Series.new(hsh["Series"][0], :client => self)
-    rescue Exception => e
-      raise
-    end
+    lookup = "series/#{id}/#{@language}.xml"
+    hsh = XmlSimple.xml_in(client[lookup].get)
+    serie = TTVDB::Series.new(hsh["Series"][0])
+    serie.client = self
+    return serie
   end
 
   def get_series name
     _client = RestClient::Resource.new("#{@opts[:api_url]}/GetSeries.php", :headers  => { :params => { 'seriesname' => name, 'language' => @language }})
-    begin
-      hsh = XmlSimple.xml_in(_client.get)
-      return [] unless hsh["Series"]
-      series = []
-      hsh["Series"].each do |s|
-        serie = TTVDB::Series.new(s, :client => self)
-        next if serie.language != @language
-        series << serie
-      end
-      return series
-    rescue Exception => e
-      TTVDB.logger.error { "Error while fetching series: #{e.message}" }
-      raise
+    hsh = XmlSimple.xml_in(_client.get)
+    return [] unless hsh["Series"]
+    series = []
+    hsh["Series"].each do |s|
+      serie = TTVDB::Series.new(s)
+      next if serie.language != @language
+      serie.client = self
+      series << serie
     end
+    return series
   end
 
   def get_episodes_by_series_id id
-    lookup = "series/#{id}/all/#{@opts[:language]}.xml"
-    begin
-      hsh = XmlSimple.xml_in(client[lookup].get)
-      return [] unless hsh["Episode"]
-      episodes = []
-      hsh["Episode"].each do |e|
-          episodes << TTVDB::Episode.new(e, :client => self)
-      end
-      return episodes
-    rescue Exception => e
-      TTVDB.logger.error("get_episodes_by_series_id") { "Could not create hash from result: #{e.message}" }
-      raise
+    lookup = "series/#{id}/all/#{@language}.xml"
+    hsh = XmlSimple.xml_in(client[lookup].get)
+    return [] unless hsh["Episode"]
+    episodes = []
+    hsh["Episode"].each do |e|
+      episode = TTVDB::Episode.new(e)
+      episode.client = self
+      episodes << episode
     end
+    episodes
   end
 
   private

data/lib/ttvdb/episode.rb

@@ -1,21 +1,18 @@
 class TTVDB::Episode
-  attr_reader :id, :number, :name, :overview, :season_id, :series_id,
-  :combined_number, :combined_season
+  include TTVDB::Parser
 
-  attr_writer :client, :series
+  attr_reader :id, :combined_episodenumber, :combined_season,
+  :dvd_chapter, :dvd_discid, :dvd_episodenumber, :dvd_season,
+  :director, :ep_img_flag, :episode_name, :name, :episode_number,
+  :number, :first_aired, :guest_stars, :imdb_id, :overview,
+  :last_updated, :rating, :absolute_number, :season_number,
+  :season_id, :series_id
 
-  def initialize(data, options={})
-    options.merge! data
-    @id = options["id"][0].to_i rescue nil
-    @number = options["EpisodeNumber"][0].to_i rescue nil
-    @name = options["EpisodeName"][0] rescue nil
-    @overview = options["Overview"][0] rescue nil
-    @season_id = options["seasonid"][0].to_i rescue nil
-    @series_id = options["seriesid"][0].to_i rescue nil
-    @combined_number = options["Combined_episodenumber"][0].to_i rescue nil
-    @combined_season = options["Combined_season"][0].to_i rescue nil
-    @client = options[:client] rescue nil
-    @series = options[:series] rescue nil
+  attr_accessor :client, :series
+
+  def initialize(data)
+    @data = Hash[data.map { |k, v| [k.downcase, v] }]
+    parse
   end
 
 end

data/lib/ttvdb/match.rb

@@ -0,0 +1,76 @@
+require 'similar_text'
+module TTVDB::Match
+  def match_episode filename, opts = {}
+    episode = nil
+    case opts[:filter]
+      when :sorted
+        episode = match_episode_sorted filename, opts
+      when :name
+        episode = match_episode_name filename, opts
+      when :regex
+        episode = match_episode_regex filename, opts
+      else
+        # try all
+        episode = match_episode_regex filename, opts rescue nil
+        episode ||= match_episode_name(filename, opts) rescue nil
+        episode ||= match_episode_regex(filename, opts) rescue nil
+    end
+    episode
+  end
+
+  private
+  def match_episode_sorted filename, opts = {}
+    enum = get_episode filename
+    return episodes[enum-1] rescue nil
+  end
+
+  def match_episode_name filename, opts = {}
+    results = []
+    episodes.each do |episode|
+      min = opts[:min]
+      min ||= 45
+      results << episode if episode.name.similar(filename) >= min
+    end
+    if results.count == 0
+      results = nil
+    elsif results.count == 1
+      results = results[0]
+    end
+    return results
+  end
+
+  def match_episode_regex filename, opts = {}
+    snum = get_season filename
+    enum = get_episode filename
+    seasons[snum][enum] rescue nil
+  end
+
+  def get_episode filename
+    filter_episode = [
+      /e(\d+)/i,
+      /(\d+)/i
+    ]
+    filter_episode.each do |r|
+      m = filename.match(r)
+      if m
+        return m[1].to_i rescue nil
+      end
+    end
+  end
+
+  def get_season filename
+    filter_season = [
+      /s(\d+)/i,
+      /season.*(\d+)/i,
+      /staffel.*(\d+)/i,
+      /(\d+)x/i,
+      /(\d+)-/i
+    ]
+    filter_season.each do |r|
+      m = filename.match(r)
+      if m
+        return m[1].to_i rescue nil
+      end
+    end
+  end
+end

data/lib/ttvdb/parser.rb

@@ -0,0 +1,99 @@
+module TTVDB::Parser
+  attr_reader :id
+
+  MAP = {
+    "id" => { :map => true, :cast => :integer },
+    "combined_episodenumber" => { :map => true, :cast => :float },
+    "combined_season" => { :map => true, :cast => :integer },
+    "dvd_chapter" => { :map => true, :cast => :integer },
+    "dvd_discid" => { :map => true, :cast => :integer },
+    "dvd_episodenumber" => { :map => true, :cast => :float },
+    "dvd_season" => { :map => true, :cast => :integer },
+    "director" => { :map => true },
+    "epimgflag" => { :map => true, :cast => :integer },
+    "episodename" => { :map => :name },
+    "episodenumber" => { :map => :number, :cast => :integer },
+    "firstaired" => { :map => :first_aired, :cast => :time },
+    "gueststars" => { :map => :guest_stars, :cast => :array },
+    "imdb_id" => { :map => true },
+    "language" => { :map => true },
+    "overview" => { :map => true },
+    "productioncode" => { :map => :production_code },
+    "rating" => { :map => true, :cast => :float },
+    "ratingcount" => { :map => :rating_count, :cast => :integer },
+    "seasonnumber" => { :map => :season_number, :cast => :integer },
+    "writer" => { :map => true },
+    "absolute_number" => { :map => true, :cast => :integer },
+    "filename" => { :map => true },
+    "lastupdated" => { :map => :last_updated, :cast => :time_at },
+    "seasonid" => { :map => :season_id, :cast => :integer },
+    "seriesid" => { :map => :series_id, :cast => :integer },
+    "thumb_added" => { :map => true },
+    "thumb_height" => { :map => true, :cast => :integer },
+    "thumb_width" => { :map => true, :cast => :integer },
+    "actors" => { :map => true, :cast => :array },
+    "airs_dayofweek" => { :map => true },
+    "airs_time" => { :map => true },
+    "contentrating" => { :map => :content_rating, :cast => :float },
+    "genre" => { :map => true, :cast => :array },
+    "network" => { :map => true },
+    "networkid" => { :map => :network_id },
+    "runtime" => { :map => true, :cast => :integer },
+    "seriesname" => { :map => :name },
+    "status" => { :map => true },
+    "added" => { :map => true },
+    "added_by" => { :map => true },
+    "banner" => { :map => true },
+    "fanart" => { :map => true },
+    "poster" => { :map => true },
+    "zap2it_id" => { :map => true }
+  }
+
+  def parse
+    raise "no data to parse" unless @data
+    @data.each do |k, v|
+      k = k.downcase
+      v = v[0]
+      unless MAP.include? k
+        next
+      end
+      var = nil
+      if MAP[k][:map].is_a? TrueClass
+        var = k.to_sym
+      else
+        var = MAP[k][:map].to_sym
+      end
+
+      unless respond_to? var
+        next
+      end
+      k, v = map k, v
+      instance_variable_set("@#{k}", v)
+    end
+    @data = nil
+  end
+
+  private
+  def map k, v
+    case MAP[k][:cast]
+      when :integer
+        v = v.to_i rescue v
+      when :float
+        v = v.to_f rescue v
+      when :array
+        v = v.split("|").compact rescue v
+      when :time_at
+        v = Time.at(v.to_i) rescue v
+      when :time
+        v = Time.parse(v) rescue v
+      else
+        v = v
+    end
+    if MAP[k][:map].is_a? TrueClass
+      k = k.to_sym
+    else
+      k = MAP[k][:map].to_sym
+    end
+    [k, v]
+  end
+end

data/lib/ttvdb/series.rb

@@ -1,49 +1,25 @@
 class TTVDB::Series
+  include TTVDB::Parser
+  include TTVDB::Match
+
   attr_reader :id, :actors, :airs_dayofweek, :airs_time,
   :content_rating, :first_aired, :genre, :imdb_id, :language,
   :network, :network_id, :overview, :rating, :rating_count,
   :runtime, :series_id, :series_name, :status, :added, :added_by,
-  :banner, :fanart, :last_updated, :poster, :zap2it_id, :episodes, :seasons,
+  :banner, :fanart, :last_updated, :poster, :zap2it_id, :seasons,
   :name
 
-  attr_writer :client
+  attr_accessor :client
 
-  def initialize(data, options={})
-    options.merge! data
-    @id = options["id"][0].to_i rescue nil
-    @actors = options["Actors"][0].split("|").compact rescue []
-    @airs_dayofweek = options["Airs_DayOfWeek"][0] rescue nil
-    @airs_time = options["Airs_Time"][0] rescue nil
-    @content_rating = options["ContentRating"][0].to_f rescue 0
-    @first_aired = Time.parse(options["FirstAired"][0]) rescue nil
-    @genre = options["Genre"][0].split("|").compact rescue []
-    @imdb_id = options["IMDB_ID"][0].to_i rescue nil
-    @language = options["language"][0] rescue nil
-    @language ||= options["Language"][0] rescue "en"
-    @network = options["Network"][0] rescue nil
-    @network_id = options["NetworkID"][0] rescue nil
-    @overview = options["Overview"][0] rescue nil
-    @rating = options["Rating"][0].to_f rescue 0
-    @rating_count = options["RatingCount"][0] rescue 0
-    @runtime = options["Runtime"][0].to_i rescue nil
-    @runtime ||= options["runtime"][0].to_i rescue 0
-    @series_id = options["SeriesID"][0].to_i rescue nil
-    @series_name = options["SeriesName"][0] rescue nil
-    @name = @series_name
-    @status = options["Status"][0].downcase rescue nil
-    @added = options["added"][0] rescue nil
-    @added_by = options["addedBy"][0] rescue nil
-    @banner = options["banner"][0] rescue nil
-    @fanart = options["fanart"][0] rescue nil
-    @last_updated = Time.at(options["lastupdated"][0].to_i) rescue nil
-    @poster = options["poster"][0] rescue nil
-    @zap2it_id = options["zap2it_id"][0] rescue nil
-    @client = options[:client] rescue nil
+  def initialize(data)
+    @data = Hash[data.map { |k, v| [k.downcase, v] }]
+    parse
     @seasons = {}
-    TTVDB.logger.debug { "Series language: #{@language}" }
-    fetch_episodes
   end
 
+  def episodes
+    @episodes ||= fetch_episodes
+  end
 
   private
   def fetch_episodes