tvdb-api 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b5585c7aa4d9e2520813b5448b202976a527d2b
+  data.tar.gz: 311ebb228e76a8dd865a75c478f957e5b9c5ee7d
+SHA512:
+  metadata.gz: c0eb82b21d9e3b4bc544a96b177d3f07b73aa205bb639268de828191f399c234a6ac679700c818d9825825670bd2310179c80f1caeb3cbab7a8866da0ba8b588
+  data.tar.gz: ac991c3ea3ad35fb5914828e7bb1ba2e2da9960748373625842dd60b4cfc62c753b00914cb2eeee7a3923e57f76b50313f065118a1569211cc26cd8d8ed50b12

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://www.rubygems.org"
+ 
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Matt Edlefsen
+
+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,41 @@
+TVDB API
+========
+
+Yet another Ruby client for the TVDB ( http://thetvdb.com ).
+
+  * Clean and fully featured API client that streamlines usage but gets out of your way when you need it to.
+  * Supports all non-deprecated aspects of the TVDB Api.
+  * Uses compression for all calls making the API very quick.
+  * All XML responses parsed into simple Ruby Hash structure.
+
+See http://thetvdb.com/wiki/index.php?title=Programmers_API for documentation of API.
+
+**This library does not do caching. Please use some form of caching when interacting with TVDB**
+
+Usage
+-----
+
+    client = TVDBApi.new API_KEY
+    # or
+    client = TVDBApi.new API_KEY, 'en'
+
+    # Dynamic Interfaces
+    client.get_series 'Futurama'
+    client.get_series_by_remote_id :imdb, 'tt0149460'
+    # etc...
+    
+    ## Files Interface
+
+    client['updates/updates_day.xml']
+    
+    # Adds .xml for you
+    client['languages'] # => languages.xml
+
+    # Automatically gets the default language if not specified
+    client['series/73871'] => series/73871/en.xml
+
+    # Allows array input for more structured calls
+    client[:series, 73871, :default, 1, 1] => 'series/73871/default/1/1/en.xml'
+
+    # Adds 'updates_' prefix to updates calls
+    client[:updates, :day] => 'updates/updates_day.xml'

data/lib/tvdb_api.rb

@@ -0,0 +1,123 @@
+require 'httparty'
+
+class TVDBApi
+  include HTTParty
+  format :xml
+  base_uri 'http://www.thetvdb.com'
+  headers 'Accept-encoding' => 'gzip'
+
+  def initialize(api_key,opts = {})
+    @lang = opts[:lang] || 'en'
+    @api_key = api_key
+    @tries = 3
+  end
+
+  def get_series(series_name, lang = @lang)
+    get 'GetSeries.php', seriesname: series_name, language: lang
+  end
+
+  def get_series_by_remote_id(type, id, lang = @lang)
+    query = {language: lang}
+    case type
+    when :imdb then query[:imdbid] = id
+    when :zap2it then query[:zap2it] = id
+    else raise "Invalid remote id type '#{type}'"
+    end
+    get 'GetSeriesByRemoteID.php', query
+  end
+
+  def get_episode_by_air_date(series_id, air_date, lang = @lang)
+    if air_date.respond_to? :to_time
+      air_date = air_date.to_time
+    end
+    if air_date.respond_to? :strftime
+      air_date = air_date.strftime('%F')
+    end
+
+    get 'GetEpisodeByAirDate.php', 
+      apikey: @api_key, language: lang,
+      seriesid: series_id, airdate: air_date
+  end
+
+  def get_retings_for_user(account_id, series_id = nil)
+    query = { apikey: @api_key, accountid: account_id }
+    query[:seriesid] = series_id if series_id
+    get 'GetRatingsForUser.php', query
+  end
+
+  def user_preferred_language(account_id)
+    get 'User_PreferredLanguage.php', accountid: account_id
+  end
+
+  def user_favorites(account_id, change = nil, series_id = nil)
+    query = {accountid: account_id}
+    if change
+      if [:add,:remove].include?(change) && series_id
+        query[:type] = change
+        query[:seriesid] = series_id
+      else
+        raise ArgumentError.new("change may only be :add or :remove and series_id must be set if change is set")
+      end
+    end
+    get 'User_Favorites.php', query
+  end
+
+  def user_rating(account_id, item_type, item_id, rating)
+    get 'User_Rating.php',
+      accountid: account_id, itemtype: item_type,
+      itemid: itemid, rating: rating
+  end
+
+  def to_full(path)
+    if path !~ /\.php$/
+      path = @api_key+'/'+path
+
+      if path =~ /\/\d+(\/all)?\/?$/
+        path += '/' + @lang + '.xml'
+      end
+
+      if path =~ /(.*\/updates\/)(?!updates_)(.*)/
+        path = $1+"updates_"+$2
+      end
+
+      if path =~ /\/[^\/\.]*$/
+        path += '.xml'
+      end
+    end
+
+    if path[0] != '/'
+      if path !~ /^?api\//
+        path = '/api/'+path
+      else
+        path = '/' + path 
+      end
+    end
+
+    path
+  end
+
+  def get(path,query=nil, options={})
+    if path.respond_to? :join
+      path = path.join("/")
+    end
+    path = to_full path
+    if query
+      options[:query] = query
+    end
+    ex = nil
+    @tries.times do
+      begin
+        res = self.class.get(path,options)
+        return res
+      rescue => e
+        ex = e
+      end
+    end
+    raise ex
+  end
+
+  def [](*args)
+    get args
+  end
+
+end

data/tvdb_api.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = 'tvdb-api'
+  s.version     = '1.0.1'
+  s.summary     = "Straightforward Ruby client for TVDB"
+  s.description = "Clean Ruby API interface to The TVDB"
+  s.authors     = ["Matt Edlefsen"]
+  s.email       = 'matt@xforty.com'
+  s.files       = `git ls-files`.split("\n")
+  s.license     = "MIT"
+  s.homepage    = 'https://github.com/medlefsen/tvdb-api'
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.extra_rdoc_files = [
+    "Readme.md"
+  ]
+  s.add_dependency('httparty', '~> 0.10.0')
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: tvdb-api
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Matt Edlefsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: Clean Ruby API interface to The TVDB
+email: matt@xforty.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- Readme.md
+files:
+- Gemfile
+- LICENSE
+- Readme.md
+- lib/tvdb_api.rb
+- tvdb_api.gemspec
+homepage: https://github.com/medlefsen/tvdb-api
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Straightforward Ruby client for TVDB
+test_files: []