the_tvdb 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # TheTvdb
 
-Ruby wrapper for TheTVDB.com
+Ruby wrapper for [TheTVDB.com](http://thetvdb.com/).
 
 ## Installation
 
@@ -18,7 +18,9 @@ Or install it yourself as:
 
 ## Usage
 
-Instructions coming soon!
+If you are using this in a Rails project, create the initializer:
+
+    rails generate the_tvdb:install
 
 ## Contributing
 
@@ -27,3 +29,7 @@ Instructions coming soon!
 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
+
+## License
+
+This gem is released under the [MIT License](http://www.opensource.org/licenses/MIT). Copyright 2012 freego. http://freegoweb.it

data/lib/generators/templates/the_tvdb.rb

@@ -0,0 +1,3 @@
+TheTvdb.setup do |config|
+  config.api_key = 'ABC123DEF456GHI7' # Your API here, get one at http://thetvdb.com/?tab=apiregister
+end

data/lib/generators/the_tvdb/install_generator.rb

@@ -0,0 +1,14 @@
+module TheTvdb
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a TheTvdb initializer and copy locale files to your application."
+
+      def copy_initializer
+        template "the_tvdb.rb", "config/initializers/the_tvdb.rb"
+      end
+
+    end
+  end
+end

data/lib/the_tvdb/configuration.rb

@@ -1,11 +1,13 @@
 module TheTvdb
-  
-  def self.config
-    @config ||= Configuration.new
-  end
-  
   class Configuration
-  
+    
+    include Singleton
+    
+    attr_accessor :api_key
+    def initialize
+      @api_key = ENV['TVDBKEY']
+    end
+      
     def dump_path
       @dump_path ||= default_path
       FileUtils.mkdir_p("#{@dump_path}/zipfiles") if !File.directory?("#{@dump_path}/zipfiles")

data/lib/the_tvdb/episode.rb

@@ -9,7 +9,7 @@ module TheTvdb
       @season_number = info['Combined_season'].to_i
       @name = info['EpisodeName']
       @number = info['EpisodeNumber'].to_i
-      @aired_at = Date.parse(info['FirstAired'])
+      @aired_at = info['FirstAired']
       @description = info['Overview']
     end
     
@@ -17,6 +17,14 @@ module TheTvdb
       info = TheTvdb.gateway.get_episode_details(remote_id)
       self.new(info)
     end
+    
+    def to_hash
+      {
+        remote_id: @remote_id, name: @name, description: @description,
+        season_remote_id: @season_remote_id, season_number: @season_number,
+        number: @number, aired_at: @aired_at
+      }
+    end
 
   end
 end

data/lib/the_tvdb/gateway.rb

@@ -5,15 +5,12 @@ require 'zip/zip'
 require 'active_support/core_ext'
 
 module TheTvdb
-  
-  def self.gateway
-    @gateway ||= Gateway.new
-  end
-  
   class Gateway
     
+    include Singleton
+    
     def config
-      TheTvdb.config
+      TheTvdb.configuration
     end
     
     def zip_path
@@ -28,8 +25,8 @@ module TheTvdb
     
     # TODO: setup a reliable env system for apikey
     def initialize(api_key = nil)
-      @api_key = api_key || ENV['TVDBKEY']
-      raise 'No API key was provided. Please set one as environment variable (e.g.: `export TVDBKEY=1234567898765432`).' if !@api_key
+      @api_key = config.api_key
+      raise 'No API key was provided. Please set one as TheTvdb::Configuration.apikey or as an environment variable (e.g.: `export TVDBKEY=1234567898765432`).' if !@api_key
       @mirror = get_mirror
     end
     
@@ -48,8 +45,13 @@ module TheTvdb
       "#{hash['mirrorpath']}/api/#{@api_key}"
     end
     
-    def get_time
-      xml_to_hash "#{endpoint}/Updates.php?type=none", 'Time'
+    def update(time)
+      hash = xml_to_hash "#{endpoint}/Updates.php?time=#{time || last_updated}", 'Items'
+    end
+    
+    attr_accessor :last_updated
+    def time
+      @last_updated = xml_to_hash "#{endpoint}/Updates.php?type=none", 'Time'
     end
     
     def get_series(name)

data/lib/the_tvdb/show.rb

@@ -8,19 +8,23 @@ module TheTvdb
       shows.map {|s| self.new(s) }
     end
 
+    def self.find(remote_id)
+      info = TheTvdb.gateway.get_series_package(remote_id)
+      show = self.new(info['Series'])
+      show.episodes = info['Episode'].map {|e| TheTvdb::Episode.new(e) }
+      show
+    end
+
     def initialize(info)
-      @remote_id = info['seriesid'].to_i
+      @remote_id = info['id'].to_i
       @name = info['SeriesName']
       @banner = info['banner']
       @description = info['Overview']
       #@aired_at = info['FirstAired']
     end
     
-    def self.find(remote_id)
-      info = TheTvdb.gateway.get_series_package(remote_id)
-      show = self.new(info['Series'])
-      show.episodes = info['Episode'].map {|e| TheTvdb::Episode.new(e) }
-      show
+    def to_hash
+      { remote_id: @remote_id, name: @name, banner: @banner, description: @description }
     end
 
   end

data/lib/the_tvdb/version.rb

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

data/lib/the_tvdb.rb

@@ -5,5 +5,30 @@ require "the_tvdb/show"
 require "the_tvdb/episode"
 
 module TheTvdb
+  
+  def self.setup
+    yield self.configuration
+  end
+  
+  def self.configuration
+    @config ||= Configuration.instance
+  end
+
+  def self.gateway
+    @gateway ||= Gateway.instance
+  end
+  
+  # Starting from the last update recorded on the gateway, a hash with the new
+  # update time and the updated shows are returned
+  #
+  # @param [Integer] timestamp the last update timestamp (if not provided the last_updated attribute of the gateway is used instead)
+  # @return [Hash] the new last_updated time and the Shows that have been updated
+  def self.update(time = nil)
+    update_hash = gateway.update(time)
+    result = { time: update_hash['Time'].to_i }
+    result[:shows] = update_hash['Series'].map {|show_remote_id| Show.find(show_remote_id) }
+    gateway.last_updated = result[:time]
+    result
+  end
 
 end

data/spec/fixtures/tvdb_cassettes/episodes.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: http://www.thetvdb.com/api/A4EF663990171DE4/mirrors.xml
+    uri: http://www.thetvdb.com/api/1234567898765432/mirrors.xml
     body:
       encoding: US-ASCII
       string: ''
@@ -48,7 +48,7 @@ http_interactions:
   recorded_at: Thu, 20 Dec 2012 10:48:57 GMT
 - request:
     method: get
-    uri: http://thetvdb.com/api/A4EF663990171DE4/episodes/4245778/en.xml
+    uri: http://thetvdb.com/api/1234567898765432/episodes/4245778/en.xml
     body:
       encoding: US-ASCII
       string: ''