royw-tmdb 0.0.1 → 0.0.2

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 1
+:patch: 2
 :major: 0
 :minor: 0

data/lib/file_extensions.rb

@@ -1,14 +1,18 @@
 # == Synopsis
 # add a mkdirs method to the File class
 class File
-  ##
-  # make directories including any missing in the path
-  #
-  # @param [String] dirspec the path to make sure exists
-  def File.mkdirs(dirspec)
-    unless File.exists?(dirspec)
-      mkdirs(File.dirname(dirspec))
-      Dir.mkdir(dirspec)
+  class << self
+    my_extension("mkdirs") do
+      ##
+      # make directories including any missing in the path
+      #
+      # @param [String] dirspec the path to make sure exists
+      def File.mkdirs(dirspec)
+        unless File.exists?(dirspec)
+          mkdirs(File.dirname(dirspec))
+          Dir.mkdir(dirspec)
+        end
+      end
     end
   end
 end

data/lib/module_extensions.rb

@@ -0,0 +1,27 @@
+######################################################################
+# my extensions to Module. (taken from rake, named changed to not clash
+# when rake is used for this rails project.
+#
+class Module
+  # Check for an existing method in the current class before extending.  IF
+  # the method already exists, then a warning is printed and the extension is
+  # not added.  Otherwise the block is yielded and any definitions in the
+  # block will take effect.
+  #
+  # Usage:
+  #
+  #   class String
+  #     rake_extension("xyz") do
+  #       def xyz
+  #         ...
+  #       end
+  #     end
+  #   end
+  #
+  def my_extension(method)
+    unless instance_methods.include?(method.to_s) || instance_methods.include?(method.to_sym)
+      yield
+    end
+  end
+end # module Module
+

data/lib/string_extensions.rb

@@ -1,16 +1,32 @@
 require 'cgi'
 require 'iconv'
 
-module ImdbStringExtensions
-  
-  def unescape_html
-    Iconv.conv("UTF-8", 'ISO-8859-1', CGI::unescapeHTML(self))
+class String
+  my_extension("unescape_html") do
+    def unescape_html
+      Iconv.conv("UTF-8", 'ISO-8859-1', CGI::unescapeHTML(self))
+    end
   end
-  
-  def strip_tags
-    gsub(/<\/?[^>]*>/, "")
+
+  my_extension("strip_tags") do
+    def strip_tags
+      gsub(/<\/?[^>]*>/, "")
+    end
+  end
+
+  my_extension("ext") do
+    # Replace the file extension with +newext+.  If there is no extenson on
+    # the string, append the new extension to the end.  If the new extension
+    # is not given, or is the empty string, remove any existing extension.
+    #
+    # +ext+ is a user added method for the String class.
+    def ext(newext='')
+      return self.dup if ['.', '..'].include? self
+      if newext != ''
+        newext = (newext =~ /^\./) ? newext : ("." + newext)
+      end
+      dup.sub!(%r(([^/\\])\.[^./\\]*$)) { $1 + newext } || self + newext
+    end
   end
-  
 end
 
-String.send :include, ImdbStringExtensions

data/lib/tmdb.rb

@@ -1,11 +1,15 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
 require 'rubygems'
 require 'open-uri'
 require 'date'
 require 'xmlsimple'
 
-require File.dirname(__FILE__) + '/tmdb/optional_logger'
-require File.dirname(__FILE__) + '/tmdb/tmdb_movie'
-require File.dirname(__FILE__) + '/tmdb/tmdb_profile'
-require File.dirname(__FILE__) + '/string_extensions'
-require File.dirname(__FILE__) + '/file_extensions'
-require File.dirname(__FILE__) + '/object_extensions'
+require 'tmdb/optional_logger'
+require 'tmdb/tmdb_movie'
+require 'tmdb/tmdb_profile'
+require 'module_extensions'
+require 'string_extensions'
+require 'file_extensions'
+require 'object_extensions'

data/lib/tmdb/tmdb_movie.rb

@@ -2,11 +2,9 @@ class TmdbMovie
 
   attr_reader :query, :document
 
-  API_KEY = '7a2f6eb9b6aa01651000f0a9324db835'
-
-  def initialize(ident)
+  def initialize(ident, key)
     @imdb_id = 'tt' + ident.gsub(/^tt/, '') unless ident.blank?
-    @query = "http://api.themoviedb.org/2.0/Movie.imdbLookup?imdb_id=#{@imdb_id}&api_key=#{API_KEY}"
+    @query = "http://api.themoviedb.org/2.0/Movie.imdbLookup?imdb_id=#{@imdb_id}&api_key=#{key}"
   end
 
   def fanarts

data/lib/tmdb/tmdb_profile.rb

@@ -14,12 +14,13 @@ class TmdbProfile
 
   # options:
   #  :imdb_id  => String (either with or without leading 'tt')
+  #  :api_key => String containing themovieDb.com's API key (required)
   #  :filespec => nil or a valid pathspec
   #  :logger   => nil or a logger instance
   def self.all(options={})
     result = []
     if has_option?(options, :imdb_id) || (has_option?(options, :filespec) && File.exist?(options[:filespec]))
-      result << TmdbProfile.new(options[:imdb_id], options[:filespec], options[:logger])
+      result << TmdbProfile.new(options[:imdb_id], options[:api_key], options[:filespec], options[:logger])
     end
     result
   end
@@ -35,8 +36,9 @@ class TmdbProfile
     options.has_key?(key) && !options[key].blank?
   end
 
-  def initialize(ident, filespec, logger)
+  def initialize(ident, key, filespec, logger)
     @imdb_id = ident
+    @api_key = key
     @filespec = filespec
     @logger = OptionalLogger.new(logger)
     load
@@ -65,7 +67,7 @@ class TmdbProfile
       @movie = from_xml(open(@filespec).read)
     elsif !@imdb_id.blank?
       @logger.debug { "loading movie from tmdb.com, filespec=> #{@filespec.inspect}" }
-      @movie = TmdbMovie.new(@imdb_id.gsub(/^tt/, '')).to_hash
+      @movie = TmdbMovie.new(@imdb_id.gsub(/^tt/, ''), @api_key).to_hash
       save(@filespec) unless @filespec.blank?
     end
     unless @movie.blank?

data/spec/tmdb_movie_spec.rb

@@ -3,6 +3,8 @@ require 'spec_helper'
 # Time to add your specs!
 # http://rspec.info/
 
+TMDB_API_KEY = '7a2f6eb9b6aa01651000f0a9324db835'
+
 describe "TmdbMovie" do
 
   before(:all) do
@@ -10,7 +12,7 @@ describe "TmdbMovie" do
   end
 
   before(:each) do
-    @profile = TmdbMovie.new('tt0465234')
+    @profile = TmdbMovie.new('tt0465234', TMDB_API_KEY)
   end
 
   after(:each) do
@@ -66,7 +68,7 @@ describe "TmdbMovie" do
   end
 
   it "should handle The Sand Pebble" do
-    profile = TmdbMovie.new('tt0060934')
+    profile = TmdbMovie.new('tt0060934', TMDB_API_KEY)
     profile.idents.should be_nil
   end
 

data/spec/tmdb_profile_spec.rb

@@ -4,6 +4,8 @@ require 'tempfile'
 # Time to add your specs!
 # http://rspec.info/
 
+TMDB_API_KEY = '7a2f6eb9b6aa01651000f0a9324db835'
+
 describe "TmdbProfile" do
 
   before(:all) do
@@ -12,7 +14,7 @@ describe "TmdbProfile" do
 
   before(:each) do
     # tt0465234 => National Treasure: Book of Secrets
-    @profile = TmdbProfile.first(:imdb_id => 'tt0465234')
+    @profile = TmdbProfile.first(:imdb_id => 'tt0465234', :api_key => TMDB_API_KEY)
   end
 
   after(:each) do
@@ -25,7 +27,7 @@ describe "TmdbProfile" do
 
   it "should save the profile to a file" do
     filespec = get_temp_filename
-    profile = TmdbProfile.first(:imdb_id => 'tt0465234', :filespec => filespec)
+    profile = TmdbProfile.first(:imdb_id => 'tt0465234', :api_key => TMDB_API_KEY, :filespec => filespec)
     (File.exist?(filespec).should be_true) && (File.size(filespec).should > 0)
   end
 
@@ -94,7 +96,7 @@ describe "TmdbProfile" do
   it "should be able to convert to xml and then from xml" do
     hash = nil
     begin
-      profile = TmdbProfile.first(:imdb_id => 'tt0465234')
+      profile = TmdbProfile.first(:imdb_id => 'tt0465234', :api_key => TMDB_API_KEY)
       xml = profile.to_xml
       hash = XmlSimple.xml_in(xml)
     rescue
@@ -106,26 +108,26 @@ describe "TmdbProfile" do
   # now let's test caching the profile to/from a file
 
   it "should not create a file if a :filespec option is passed that is nil" do
-    profile = TmdbProfile.first(:imdb_id => 'tt0465234', :filespec => nil)
+    profile = TmdbProfile.first(:imdb_id => 'tt0465234', :api_key => TMDB_API_KEY, :filespec => nil)
     Dir.glob(File.join(TMPDIR, "imdb_profile_spec*")).empty?.should be_true
   end
 
   it "should create a file if a :filespec option is passed" do
     filespec = get_temp_filename
-    profile = TmdbProfile.first(:imdb_id => 'tt0465234', :filespec => filespec)
+    profile = TmdbProfile.first(:imdb_id => 'tt0465234', :api_key => TMDB_API_KEY, :filespec => filespec)
     (File.exist?(filespec) && (File.size(filespec) > 0)).should be_true
   end
 
   it "should load from a file if a :filespec option is passed and the file exists" do
     filespec = get_temp_filename
-    profile1 = TmdbProfile.first(:imdb_id => 'tt0465234', :filespec => filespec)
-    profile2 = TmdbProfile.first(:filespec => filespec)
+    profile1 = TmdbProfile.first(:imdb_id => 'tt0465234', :api_key => TMDB_API_KEY, :filespec => filespec)
+    profile2 = TmdbProfile.first(:api_key => TMDB_API_KEY, :filespec => filespec)
     profile1.imdb_id.should == profile2.imdb_id
   end
 
   it "should not load from a file if a :filespec option is passed and the file does not exists" do
     filespec = get_temp_filename
-    profile = TmdbProfile.first(:filespec => filespec)
+    profile = TmdbProfile.first(:api_key => TMDB_API_KEY, :filespec => filespec)
     profile.should be_nil
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: royw-tmdb
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Roy Wright
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-15 00:00:00 -07:00
+date: 2009-04-16 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -28,6 +28,7 @@ files:
 - Rakefile
 - VERSION.yml
 - lib/file_extensions.rb
+- lib/module_extensions.rb
 - lib/object_extensions.rb
 - lib/string_extensions.rb
 - lib/tmdb.rb