maksar-tmdb_party 0.4.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+apikey.txt

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 John Duff
+
+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.rdoc

@@ -0,0 +1,44 @@
+= tmdb_party
+
+Simple ruby wrapper to themoviedb.org (http://api.themoviedb.org/2.0/docs/) using HTTParty
+
+= usage:
+  sudo gem install tmdb_party -s http://gemcutter.org
+  require 'rubygems'
+  require 'tmdb_party'
+
+= example:
+
+  @tmdb = TMDBParty::Base.new('key')
+  results = @tmdb.search('transformers')
+
+  results.length
+    # => 5
+
+  transformers = results.detect{|m| m.name == "Transformers"}
+
+  transformers.popularity
+    # => 31
+  transformers.score
+    # => 1.0
+  transformers.imdb_id
+    # => 'tt0418279'
+
+  # some attributes don't come back with the search result, they are lazily loaded on demand
+  transformers.homepage
+    # => "http://www.transformersmovie.com/"
+  transformers.trailer.url
+    # => "http://www.youtube.com/watch?v=eduwcuq1Exg"
+
+  transformers.genres.collect{|cat| cat.name}.include?("Adventure")
+    # => true
+
+= what is themoviedb.org?
+It's a movie database, kind of like IMDB except it's more of a community wiki. They also have an api that they're cool with people using. More on the api here: http://api.themoviedb.org/2.0/docs/
+
+== Contributors
+Jon Maddox (http://github.com/maddox)
+
+== Copyright
+
+Copyright (c) 2009 John Duff. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "maksar-tmdb_party"
+    gem.summary = %Q{Simple ruby wrapper to themoviedb.org (http://api.themoviedb.org/2.0/docs/) using HTTParty}
+    gem.email = "Maksar.mail@gmail.com"
+    gem.homepage = "http://github.com/maksar/tmdb_party"
+    gem.authors = ["John Duff", "Jon Maddox", "Alexander Shestakov"]
+    gem.add_dependency('httparty', '>= 0.4.3')
+    
+    gem.add_development_dependency('fakeweb')
+    gem.add_development_dependency('context')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tmdb_party #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

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

data/lib/tmdb_party.rb

@@ -0,0 +1,72 @@
+# gem 'httparty'
+require 'rubygems'
+require 'httparty'
+
+current_dir=File.expand_path(File.dirname(__FILE__))
+unless $LOAD_PATH.first==(current_dir)
+  $LOAD_PATH.unshift(current_dir)
+end
+ 
+require "tmdb_party/core_extensions"
+require "tmdb_party/httparty_icebox"
+require "tmdb_party/attributes"
+require "tmdb_party/video"
+require "tmdb_party/genre"
+require "tmdb_party/person"
+require "tmdb_party/image"
+require "tmdb_party/movie"
+
+module TMDBParty
+  class Base
+    include HTTParty
+    include HTTParty::Icebox
+    cache :store => 'file', :timeout => 120, :location => Dir.tmpdir
+
+    base_uri 'http://api.themoviedb.org/2.1'
+    format :json
+
+    def readFile filename, maxlines=0
+      i=0
+      read_so_far=[]
+      f=File.open(File.expand_path(filename), 'r')
+      while (line=f.gets)
+        break if maxlines!=0 and i >= maxlines
+        read_so_far << line and i+=1
+      end
+      read_so_far
+    end
+    
+    def initialize(key=nil)
+      !key.nil? ? (@api_key = key) : (@api_key= readFile('apikey.txt').first.strip)
+    end
+    
+    def default_path_items
+      path_items = ['en']
+      path_items << 'json'
+      path_items << @api_key
+    end
+    
+    def search(query)
+      data = self.class.get("/Movie.search/" + default_path_items.join('/') + '/' + URI.escape(query))
+      if data.class != Array || data.first == "Nothing found."
+        []
+      else
+        data.collect { |movie| Movie.new(movie, self) }
+      end
+    end
+    
+    def imdb_lookup(imdb_id)
+      data = self.class.get("/Movie.imdbLookup/" + default_path_items.join('/') + '/' + imdb_id)
+      if data.class != Array || data.first == "Nothing found."
+        nil
+      else
+        Movie.new(data.first, self)
+      end
+    end
+    
+    def get_info(id)
+      data = self.class.get("/Movie.getInfo/" + default_path_items.join('/') + '/' + id.to_s)
+      Movie.new(data.first, self)
+    end
+  end
+end

data/lib/tmdb_party/attributes.rb

@@ -0,0 +1,52 @@
+module TMDBParty
+  module Attributes
+    # based on http://github.com/nullstyle/ruby-satisfaction
+    
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+        attr_reader :attributes
+      end
+    end
+
+    module ClassMethods
+      def attributes(*names)
+        options = names.extract_options!
+
+        names.each do |name|
+          attribute name, options unless name.blank?
+        end
+      end
+
+      def attribute(name, options)
+        options.replace({:type => 'nil', :lazy=>false}.merge(options))
+        raise "Name can't be empty" if name.blank?
+        lazy_load = "self.#{options[:lazy]} unless self.loaded?" if options[:lazy]
+        class_eval <<-EOS
+  def #{name}
+    #{lazy_load}
+    @#{name} ||= decode_raw_attribute(@attributes['#{name}'], #{options[:type]}) if @attributes
+  end
+  EOS
+      end
+
+    end
+
+    module InstanceMethods
+      def attributes=(value)
+        @attributes = value
+      end
+      
+      def loaded?
+        @loaded
+      end
+
+      private
+      def decode_raw_attribute(value, type)
+        return nil unless value
+        type.respond_to?(:parse) ? type.parse(value) : value
+      end
+    end
+  end
+end

data/lib/tmdb_party/category.rb

@@ -0,0 +1,22 @@
+module TMDBParty
+  class Category
+    include Attributes
+    attributes :name, :url
+    
+    def initialize(values)
+      self.attributes = values
+    end
+    
+    def self.parse(data)
+      return unless data
+      data = data["category"]
+      if data.is_a?(Array)
+        data.collect do |category|
+          Category.new(category)
+        end
+      else
+        [Category.new(data)]
+      end
+    end
+  end
+end

data/lib/tmdb_party/core_extensions.rb

@@ -0,0 +1,18 @@
+class Array
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+  
+end
+
+class Float
+  def self.parse(val)
+    Float(val)
+  end
+end
+
+class Integer
+  def self.parse(val)
+    Integer(val)
+  end
+end

data/lib/tmdb_party/genre.rb

@@ -0,0 +1,21 @@
+module TMDBParty
+  class Genre
+    include Attributes
+    attributes :name, :url
+    
+    def initialize(values)
+      self.attributes = values
+    end
+    
+    def self.parse(data)
+      return unless data
+      if data.is_a?(Array)
+        data.collect do |g|
+          Genre.new(g)
+        end
+      else
+        [Genre.new(data)]
+      end
+    end
+  end
+end

data/lib/tmdb_party/httparty_icebox.rb

@@ -0,0 +1,259 @@
+# = Icebox : Caching for HTTParty
+# 
+# Cache responses in HTTParty models [http://github.com/jnunemaker/httparty]
+# 
+# === Usage
+#
+#   class Foo
+#     include HTTParty
+#     include HTTParty::Icebox
+#     cache :store => 'file', :timeout => 600, :location => MY_APP_ROOT.join('tmp', 'cache')
+#   end
+#
+# Modeled after Martyn Loughran's APICache [http://github.com/newbamboo/api_cache]
+# and Ruby On Rails's caching [http://api.rubyonrails.org/classes/ActiveSupport/Cache.html]
+#
+# Author: Karel Minarik [www.karmi.cz]
+# 
+# === Notes
+# 
+# Thanks to Amit Chakradeo to point out objects have to be stored marhalled on FS
+# Thanks to Marlin Forbes to point out query parameters have to be include in the cache key
+# 
+# 
+
+require 'logger'
+require 'ftools'
+require 'tmpdir'
+require 'pathname'
+require 'digest/md5'
+
+module HTTParty #:nodoc:
+  module Icebox
+
+    module ClassMethods
+
+      # Enable caching and set cache options
+      # Returns memoized cache object
+      #
+      # Following options are available, default values are in []:
+      #
+      # +store+::       Storage mechanism for cached data (memory, filesystem, your own) [memory]
+      # +timeout+::     Cache expiration in seconds [60]
+      # +logger+::      Path to logfile or logger instance [STDOUT]
+      # 
+      # Any additional options are passed to the Cache constructor
+      #
+      # Usage:
+      #
+      #   # Enable caching in HTTParty, in memory, for 1 minute
+      #   cache # Use default values
+      #
+      #   # Enable caching in HTTParty, on filesystem (/tmp), for 10 minutes
+      #   cache :store => 'file', :timeout => 600, :location => '/tmp/'
+      #
+      #   # Use your own cache store (see AbstractStore class below)
+      #   cache :store => 'memcached', :timeout => 600, :server => '192.168.1.1:1001'
+      #
+      def cache(options={})
+        options[:store]   ||= 'memory'
+        options[:timeout] ||= 60
+        logger = options[:logger]
+        @cache ||= Cache.new( options.delete(:store), options )
+      end
+
+    end
+
+    # When included, extend class with +cache+ method
+    # and redefine +get+ method to use cache
+    # 
+    def self.included(receiver) #:nodoc:
+      receiver.extend ClassMethods
+      receiver.class_eval do
+
+        # Get reponse from network
+        # TODO: Why alias :new :old is not working here? Returns NoMethodError
+        # 
+        def self.get_without_caching(path, options={})
+          perform_request Net::HTTP::Get, path, options
+        end
+
+        # Get response from cache, if available
+        # 
+        def self.get_with_caching(path, options={})
+          key = path.clone
+          key << options[:query].to_s if defined? options[:query]
+          
+          if cache.exists?(key) and not cache.stale?(key)
+            Cache.logger.debug "CACHE -- GET #{path}#{options[:query]}"
+            return cache.get(key)
+          else
+            Cache.logger.debug "/!\\ NETWORK -- GET #{path}#{options[:query]}"
+            response = get_without_caching(path, options)
+            cache.set(key, response) if response.code == 200
+            return response
+          end
+        end
+
+        # Redefine original HTTParty +get+ method to use cache
+        # 
+        def self.get(path, options={})
+          self.get_with_caching(path, options)
+        end
+
+      end
+    end
+
+    # === Cache container
+    # 
+    # Pass a store name ('memory', etc) to initializer
+    # 
+    class Cache
+      attr_accessor :store
+
+      def initialize(store, options={})
+        self.class.logger = options[:logger]
+        @store = self.class.lookup_store(store).new(options)
+      end
+
+      def get(key);            @store.get encode(key) unless stale?(key);        end
+      def set(key, value);     @store.set encode(key), value;                    end
+      def exists?(key);        @store.exists? encode(key);                       end
+      def stale?(key);         @store.stale?  encode(key);                       end
+
+      def self.logger; @logger || default_logger; end
+      def self.default_logger; logger = ::Logger.new(STDERR); end
+
+      # Pass a filename (String), IO object, Logger instance or +nil+ to silence the logger
+      def self.logger=(device); @logger = device.kind_of?(::Logger) ? device : ::Logger.new(device); end
+
+      private
+
+      # Return store class based on passed name
+      def self.lookup_store(name)
+        store_name = "#{name.capitalize}Store"
+        return Store::const_get(store_name)
+      rescue NameError => e
+        raise Store::StoreNotFound, "The cache store '#{store_name}' was not found. Did you loaded any such class?"
+      end
+
+      def encode(key); Digest::MD5.hexdigest(key); end
+    end
+
+
+    # === Cache stores
+    # 
+    module Store
+
+      class StoreNotFound < StandardError; end #:nodoc:
+
+      # ==== Abstract Store
+      # Inherit your store from this class
+      # *IMPORTANT*: Do not forget to call +super+ in your +initialize+ method!
+      # 
+      class AbstractStore
+        def initialize(options={})
+          raise ArgumentError, "You need to set the :timeout parameter" unless options[:timeout]
+          @timeout = options[:timeout]
+          message =  "Cache: Using #{self.class.to_s.split('::').last}"
+          message << " in location: #{options[:location]}" if options[:location]
+          message << " with timeout #{options[:timeout]} sec"
+          Cache.logger.info message unless options[:logger].nil?
+          return self
+        end
+        %w{set get exists? stale?}.each do |method_name|
+          define_method(method_name) { raise NoMethodError, "Please implement method set in your store class" }
+        end
+      end
+
+      # ===== Store objects in memory
+      #
+      Struct.new("Response", :code, :body, :headers) { def to_s; self.body; end }
+      class MemoryStore < AbstractStore
+        def initialize(options={})
+          super; @store = {}; self
+        end
+        def set(key, value)
+          Cache.logger.info("Cache: set (#{key})")
+          @store[key] = [Time.now, value]; true
+        end
+        def get(key)
+          data = @store[key][1]
+          Cache.logger.info("Cache: #{data.nil? ? "miss" : "hit"} (#{key})")
+          data
+        end
+        def exists?(key)
+          !@store[key].nil?
+        end
+        def stale?(key)
+          return true unless exists?(key)
+          Time.now - created(key) > @timeout
+        end
+        private
+        def created(key)
+          @store[key][0]
+        end
+      end
+
+      # ===== Store objects on the filesystem
+      # 
+      class FileStore < AbstractStore
+        def initialize(options={})
+          super
+          options[:location] ||= Dir::tmpdir
+          @path = Pathname.new( options[:location] )
+          FileUtils.mkdir_p( @path )
+          self
+        end
+        def set(key, value)
+          Cache.logger.info("Cache: set (#{key})")
+          File.open( @path.join(key), 'w' ) { |file| file << Marshal.dump(value)  }
+          true
+        end
+        def get(key)
+          data = Marshal.load(File.read( @path.join(key)))
+          Cache.logger.info("Cache: #{data.nil? ? "miss" : "hit"} (#{key})")
+          data
+        end
+        def exists?(key)
+          File.exists?( @path.join(key) )
+        end
+        def stale?(key)
+          return true unless exists?(key)
+          Time.now - created(key) > @timeout
+        end
+        private
+        def created(key)
+          File.mtime( @path.join(key) )
+        end
+      end
+    end
+
+  end
+end
+
+
+# Major parts of this code are based on architecture of ApiCache.
+# Copyright (c) 2008 Martyn Loughran
+# 
+# Other parts are inspired by the ActiveSupport::Cache in Ruby On Rails.
+# Copyright (c) 2005-2009 David Heinemeier Hansson
+# 
+# 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.