ttvdb 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f175e7222b5c8c526e4594e50438168996e2402
+  data.tar.gz: ba8694c7d81d5b004b694bc967ef21b6cac185dc
+SHA512:
+  metadata.gz: 444a34b040bb8b3fe64c87c48ae307497cc39034e2dfdc893c1e1901b0b8fe3fc400690be2ef5196f527e7d77893150d56350c44cd44ff4512efe49e2ed49320
+  data.tar.gz: 7c0de0ccc8d84595c9665699d2d7b5db0efaa4ca02437a7dd31076efb4e64fca08fc7bd6e69a7630e50a6aace62356261e52c5dbe8140c5379cc80ab18f0c2df

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Konrad Lother
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# 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).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ttvdb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ttvdb
+
+## Usage
+
+Require the gem
+
+```ruby
+require 'ttvdb'
+```
+
+Create a ```TTVDB::Client``` instance
+
+```ruby
+client = TTVDB::Client.new(options={})
+```
+
+| 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.
+
+## Usage
+```bash
+$ ruby ttvdb_example.rb "Galaxy Rangers"
+# or
+$ ruby ttvdb_example.rb 77772
+```
+
+## Code
+```ruby
+#!/usr/bin/env ruby
+require "ttvdb"
+
+TTVDB.logger.level = Logger::WARN
+
+client = TTVDB::Client.new
+series = nil
+
+if ARGV[0].to_i > 0
+  series = [client.get_series_by_id(ARGV[0].to_i)]
+else
+  series = client.get_series ARGV[0]
+end
+
+series.each do |serie|
+  puts serie.name
+  puts "Overview:"
+  puts serie.overview
+
+  puts ""
+  serie.seasons.each do |season, episodes|
+    puts "Season: %02d" % season
+    episodes.each do |number, episode|
+      puts "  #%02d - %s" % [number, episode.name]
+    end
+  end
+end
+```
+
+
+See the ```examples/``` folder for a complete list of examples. I try to make them as easy to understand as possible.
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/ttvdb_example.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require "ttvdb"
+
+TTVDB.logger.level = Logger::WARN
+
+client = TTVDB::Client.new
+series = nil
+
+if ARGV[0].to_i > 0
+  series = [client.get_series_by_id(ARGV[0].to_i)]
+else
+  series = client.get_series ARGV[0]
+end
+
+series.each do |serie|
+  puts serie.name
+  puts "Overview:"
+  puts serie.overview
+
+  puts ""
+  serie.seasons.each do |season, episodes|
+    puts "Season: %02d" % season
+    episodes.each do |number, episode|
+      puts "  #%02d - %s" % [number, episode.name]
+    end
+  end
+end

data/lib/ttvdb.rb

@@ -0,0 +1,12 @@
+require "rest-client"
+require "logger"
+require "xmlsimple"
+require "ttvdb/version"
+require "ttvdb/client"
+
+
+module TTVDB
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+end

data/lib/ttvdb/client.rb

@@ -0,0 +1,66 @@
+require 'ttvdb/series'
+require 'ttvdb/episode'
+
+class TTVDB::Client
+  attr_writer :language
+
+  def initialize(opts = {})
+    @opts = {
+      :api_url => 'http://www.thetvdb.com/api/',
+      :api_key => '530293E55310DAB2',
+      :language => 'en',
+    }.merge!opts
+    @language = @opts[:language]
+    @apikey = @opts[:api_key]
+  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
+  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
+    end
+  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
+    end
+  end
+
+  private
+  def client
+    @client ||= RestClient::Resource.new("#{@opts[:api_url]}/#{@apikey}/")
+  end
+
+end

data/lib/ttvdb/episode.rb

@@ -0,0 +1,21 @@
+class TTVDB::Episode
+  attr_reader :id, :number, :name, :overview, :season_id, :series_id,
+  :combined_number, :combined_season
+
+  attr_writer :client, :series
+
+  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
+  end
+
+end

data/lib/ttvdb/season.rb

@@ -0,0 +1,12 @@
+class TTVDB::Season
+  attr_reader :episodes, :series, :number
+  def initialize series, numer
+    @episodes = {}
+    @series = series
+    @number
+  end
+
+  def add_episode episode
+    @episodes[episode.number] = episode
+  end
+end

data/lib/ttvdb/series.rb

@@ -0,0 +1,83 @@
+class TTVDB::Series
+  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,
+  :name
+
+  attr_writer :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
+    @seasons = {}
+    TTVDB.logger.debug { "Series language: #{@language}" }
+    fetch_episodes
+  end
+
+
+  private
+  def fetch_episodes
+    raise Exception, "client not configured" unless @client
+    @episodes = @client.get_episodes_by_series_id @id
+    return unless @episodes
+    @episodes.each do |episode|
+      unless @seasons[episode.combined_season]
+        @seasons[episode.combined_season] = {}
+      end
+      @seasons[episode.combined_season][episode.number] = episode
+    end
+    sort_episodes!
+  end
+
+  def sort_episodes!
+    special = []
+    sorted = {}
+    @seasons.each do |season, data|
+      data.each do |n, e|
+        if season == 0
+          special << e
+        else
+          sorted[season] ||= []
+          sorted[season] << e
+        end
+      end
+    end
+    sorted = Hash[sorted.sort_by {|k,v| k.to_i }]
+    new_episodes = []
+    sorted.each do |season, episodes|
+      new_episodes << episodes
+    end
+    new_episodes << special # specials at the end
+    @episodes = new_episodes.flatten.compact
+  end
+end

data/lib/ttvdb/version.rb

@@ -0,0 +1,3 @@
+module TTVDB
+  VERSION = "0.0.2"
+end

data/ttvdb.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ttvdb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ttvdb"
+  spec.version       = TTVDB::VERSION
+  spec.authors       = ["Konrad Lother"]
+  spec.email         = ["konrad@corpex.de"]
+  spec.summary       = %q{The TVDB API Library}
+  spec.description   = %q{The TVDB API Library - Another the tvdb api library}
+  spec.homepage      = "https://github.com/lotherk/ttvdb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "xml-simple"
+  spec.add_dependency "rest-client"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: ttvdb
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Konrad Lother
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The TVDB API Library - Another the tvdb api library
+email:
+- konrad@corpex.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/ttvdb_example.rb
+- lib/ttvdb.rb
+- lib/ttvdb/client.rb
+- lib/ttvdb/episode.rb
+- lib/ttvdb/season.rb
+- lib/ttvdb/series.rb
+- lib/ttvdb/version.rb
+- ttvdb.gemspec
+homepage: https://github.com/lotherk/ttvdb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: The TVDB API Library
+test_files: []