filmbuff 0.1.2 → 0.1.5

data/History

@@ -1,3 +1,16 @@
+== 0.1.5
+
+* major enhancements
+  * Ruby 1.8.x support. Only tested with 1.8.7-p334 but it should work with
+    versions below as well. I don't intend to test with 1.8.x again, so consider
+    yourself warned.
+  * Use the new HTTParty-Icebox gem instead of vendoring the code.
+  * Changed runtime format. Now returns the length in seconds rather than 
+    minutes, allowing greater customization.
+
+* minor enhancements
+  * Removed redundant Rspec tests.
+
 == 0.1.2 2011-03-07
 
 * minor enhancements

data/README.md

@@ -20,7 +20,22 @@ Alternatively you can check out the latest code directly from Github
 
 ## Usage
 
-Film Buff 0.1.0 provides two easy ways to return an object with information on a movie or TV show. First, set up an IMDb instance:
+Accessible title information is:
+
+- Title
+- Tagline
+- Plot
+- Runtime
+- Rating
+- Amount of votes
+- Poster URL
+- Genres
+- Release date
+- IMDb ID
+
+### Examples
+
+Film Buff 0.1.x provides two easy ways to return an object with information on a movie or TV show. First, set up an IMDb instance:
 
     require 'filmbuff'
     imdb = FilmBuff::IMDb.new

data/filmbuff.gemspec

@@ -14,13 +14,11 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "filmbuff"
 
-  s.required_ruby_version = ">= 1.9.2"
-
-  s.add_dependency("httparty", "0.7.4")
-
-  s.add_development_dependency("rspec", "2.5.0")
+  s.add_dependency("httparty", "~> 0.7.4")
+  s.add_dependency("httparty-icebox", "~> 0.0.1")
+  s.add_development_dependency("rspec", "~> 2.5.0")
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
   s.require_paths = ["lib"]
 end

data/lib/filmbuff.rb

@@ -1,6 +1,6 @@
 require 'httparty'
+require 'httparty-icebox'
 
 dir = File.expand_path(File.dirname(__FILE__))
-require File.join(dir, 'filmbuff', 'httparty_icebox')
 require File.join(dir, 'filmbuff', 'imdb')
 require File.join(dir, 'filmbuff', 'title')

data/lib/filmbuff/imdb.rb

@@ -4,7 +4,7 @@ module FilmBuff
 
     include HTTParty
     include HTTParty::Icebox
-    cache :store => 'file', :timeout => 120, :location => Dir.tmpdir
+    cache :store => 'memory', :timeout => 120
 
     base_uri 'app.imdb.com'
     default_params = {
@@ -21,14 +21,14 @@ module FilmBuff
     public
     def find_by_id(imdb_id)
       result = self.class.get('/title/maindetails', :query => {
-        tconst: imdb_id, locale: @locale
+        :tconst => imdb_id, :locale => @locale
       }).parsed_response
       Title.new(result["data"])
     end
 
     def find_by_title(title)
       results = self.class.get('/find', :query => {
-        q: title, locale: @locale
+        :q => title, :locale => @locale
       }).parsed_response
       find_by_id(results["data"]["results"][0]["list"][0]["tconst"])
     end

data/lib/filmbuff/title.rb

@@ -1,6 +1,6 @@
 module FilmBuff
   class Title
-    attr_accessor :imdb_id, :title, :tagline, :plot, :runtime, :rating, :votes,
+    attr_reader :imdb_id, :title, :tagline, :plot, :runtime, :rating, :votes,
       :poster_url, :genres, :release_date
 
     def initialize(options = {})
@@ -8,8 +8,7 @@ module FilmBuff
       @title = options["title"]
       @tagline = options["tagline"]
       @plot = options["plot"]["outline"] if options["plot"]
-      @runtime = "#{(options["runtime"]["time"]/60).to_i} min" if
-        options["runtime"]
+      @runtime = options["runtime"]["time"] if options["runtime"]
       @rating = options["rating"]
       @votes = options["num_votes"]
       @poster_url = options["image"]["url"] if options["image"]

data/lib/filmbuff/version.rb

@@ -1,3 +1,3 @@
 module Filmbuff
-  VERSION = "0.1.2"
+  VERSION = "0.1.5"
 end

data/spec/filmbuff/imdb_spec.rb

@@ -5,19 +5,6 @@ describe FilmBuff::IMDb do
     @imdb = FilmBuff::IMDb.new
   end
 
-  describe "#locale" do
-    it "returns the locale" do
-      @imdb.locale.should == "en_US"
-    end
-  end
-
-  describe "#locale=" do
-    it "sets locale to the given value" do
-      @imdb.locale = "de_DE"
-      @imdb.locale.should == "de_DE"
-    end
-  end
-
   describe "#find_by_id" do
     before(:all) do
       @title = @imdb.find_by_id("tt0032138")

data/spec/filmbuff/title_spec.rb

@@ -22,13 +22,13 @@ describe FilmBuff::Title do
     end
 
     it "has a plot" do
-      @title.plot.should == "Dorothy Gale is swept away to a magical land in " <<
-      "a tornado and embarks on a quest to see the Wizard who can help her " <<
+      @title.plot.should == "Dorothy Gale is swept away to a magical land in" <<
+      " a tornado and embarks on a quest to see the Wizard who can help her " <<
       "return home."
     end
 
     it "has a runtime" do
-      @title.runtime.should == "101 min"
+      @title.runtime.should == 6060
     end
 
     it "has a rating" do
@@ -44,7 +44,7 @@ describe FilmBuff::Title do
     end
 
     it "has genres" do
-      @title.genres.should == %w[ Adventure Comedy Family Fantasy Musical]
+      @title.genres.should == %w[ Adventure Comedy Family Fantasy Musical ]
     end
 
     it "has a release date" do

metadata

@@ -2,7 +2,7 @@
 name: filmbuff
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors: 
 - Kristoffer Sachse
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 +01:00
+date: 2011-03-15 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,22 +19,33 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
         version: 0.7.4
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: httparty-icebox
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
       - !ruby/object:Gem::Version 
         version: 2.5.0
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 description: Film Buff provides a Ruby wrapper for IMDb's JSON API, which is the fastest and easiest way to get information from IMDb.
 email: 
 - kristoffer@sachse.nu
@@ -53,7 +64,6 @@ files:
 - Rakefile
 - filmbuff.gemspec
 - lib/filmbuff.rb
-- lib/filmbuff/httparty_icebox.rb
 - lib/filmbuff/imdb.rb
 - lib/filmbuff/title.rb
 - lib/filmbuff/version.rb
@@ -75,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.9.2
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
@@ -85,12 +95,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: filmbuff
-rubygems_version: 1.6.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A Ruby wrapper for IMDb's JSON API
-test_files: 
-- spec/filmbuff/imdb_spec.rb
-- spec/filmbuff/title_spec.rb
-- spec/filmbuff_spec.rb
-- spec/spec_helper.rb
+test_files: []
+

data/lib/filmbuff/httparty_icebox.rb

@@ -1,283 +0,0 @@
-# = 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 for pointing out response objects have to be stored marhalled on FS
-# Thanks to Marlin Forbes for pointing out the query parameters have to be included in the cache key
-#
-#
-
-require 'logger'
-require 'fileutils'
-require 'tmpdir'
-require 'pathname'
-require 'digest/md5'
-
-module HTTParty #:nodoc:
-  # == Caching for HTTParty
-  # See documentation in HTTParty::Icebox::ClassMethods.cache
-  #
-  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 [nil, silent]
-      # 
-      # 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.downcase # this makes a copy of path
-          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.to_s == "200" # this works for string and integer response codes
-            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 new
-    #
-    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)
-        # puts "Cache.set, key: #{key}, value: #{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 load 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 #{method_name} in your store class" }
-        end
-      end
-
-      # ==== Store objects in memory
-      # See HTTParty::Icebox::ClassMethods.cache
-      #
-      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
-      # See HTTParty::Icebox::ClassMethods.cache
-      #
-      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.