movie_searcher 0.1.4 → 0.1.6

data/README.md

@@ -1,12 +1,14 @@
-# MovieSearcher - *the almighty movie search gem*
-
-## What is MovieSearcher
+# MovieSearcher
 
 MovieSearcher makes it possible to get information about a movie.
 It uses IMDB's API that their iPhone applications rely on.
 
 It's build on top of [maddox's](https://github.com/maddox) [imdb-party](https://github.com/maddox/imdb-party) but adds some extra functionality and bugs fixes.
 
+Follow me on [Twitter](http://twitter.com/linusoleander) for more info and updates.
+
+Take a look at [this](https://github.com/oleander/Movies) gem if you want to use [IMDbAPI.com](http://imdbapi.com) instead of [IMDb.com](http://imdb.com/) as source.
+ 
 ## What makes this gem so awesome?
 
 MovieSearcher has a really cool feature (*method*) called `find_by_release_name` that makes it possible to search for a movie based on the release name.
@@ -14,82 +16,79 @@ You can for example specify ***Heartbreaker 2010 LIMITED DVDRip XviD-SUBMERGE***
 
 ## So how do I use it?
 
-### Start by installing the gem
-
-    sudo gem install movie_searcher
-Start `irb` and include the gem, `require 'movie_searcher'`
-
-### Search for a movie by title
-
-    $ MovieSearcher.find_by_title("The Dark Knight")
-    => [#<ImdbParty::Movie:0x1012a5858 @imdb_id="tt0468569", @year="2008", @title="The Dark Knight" ... >, ...]
-
 ### Get a movie by its imdb id
 
-    $ movie = MovieSearcher.find_movie_by_id("tt0468569")
-    $ movie.title 
-    => "The Dark Knight"
-    $ movie.rating 
-    => 8.9
-    $ movie.certification 
-    => "PG-13"
-    
+```` ruby
+movie = MovieSearcher.find_movie_by_id("tt0468569")
+movie.title 
+# => "The Dark Knight"
+movie.rating 
+# => 8.9
+movie.certification 
+# => "PG-13"
+````
+
 ### Find a movie based on the release name
     
-    $ MovieSearcher.find_by_release_name("Heartbreaker 2010 LIMITED DVDRip XviD-SUBMERGE").imdb_id 
-    => tt1465487
-    
+```` ruby
+MovieSearcher.find_by_release_name("Heartbreaker 2010 LIMITED DVDRip XviD-SUBMERGE").imdb_id 
+# => tt1465487
+````
+  
 ### Find a movie based on a folder
-    
-    $ MovieSearcher.find_by_folder('~/Downloads/Its.Kind.of.a.Funny.Story.2010.DVDRip.XviD-AMIABLE')
-    => #<ImdbParty::Movie:0x10198a060 ... >
-    
+
+```` ruby  
+MovieSearcher.find_by_folder('~/Downloads/Its.Kind.of.a.Funny.Story.2010.DVDRip.XviD-AMIABLE')
+# => #<ImdbParty::Movie:0x10198a060 ... >
+````
+
 ### Find a movie based on a file containing and imdb link
   
-  This method does not take any folder that starts with tilde **~** sign.
+This method does not take any folder that starts with tilde **~** sign.
   
-    $ MovieSearcher.find_by_file('/Users/linus/Downloads/Its.Kind.of.a.Funny.Story.2010.DVDRip.XviD-AMIABLE/its.kind.of.a.funny.story.2010.dvdrip.xvid-amiable.nfo')
-    => #<ImdbParty::Movie:0x10198a060 ... >
-    
+```` ruby
+MovieSearcher.find_by_file('/Users/linus/Downloads/Its.Kind.of.a.Funny.Story.2010.DVDRip.XviD-AMIABLE/its.kind.of.a.funny.story.2010.dvdrip.xvid-amiable.nfo')
+# => #<ImdbParty::Movie:0x10198a060 ... >
+````
+
 ### Find a movie based on a downloaded thingy (folder or file)
 
 This method takes anything that you have download and tries to figure out what movie you're talking about.
 If a folder is passed it will list all text files in the folder and try to find an imdb link.
 If no link or no files are found, it will fall back on the name of the folder.
-    
-    $ MovieSearcher.find_by_download('/Users/linus/Downloads/some_thing_unknown')
-    => #<ImdbParty::Movie:0x10198a060 ... >
+
+```` ruby    
+MovieSearcher.find_by_download('/Users/linus/Downloads/some_thing_unknown')
+# => #<ImdbParty::Movie:0x10198a060 ... >
+````
 
 ### Find the top 250 movies of all time
 
-    $ MovieSearcher.top_250 
-    => [#<ImdbParty::Movie:0x10178ef68 @imdb_id="tt0111161", @poster_url="http://ia.media-imdb.com/images/M/MV5BMTM2NjEyNzk2OF5BMl5BanBnXkFtZTcwNjcxNjUyMQ@@._V1_.jpg" ... >, ...]
+```` ruby
+MovieSearcher.top_250 
+# => [#<ImdbParty::Movie:0x10178ef68 @imdb_id="tt0111161", @poster_url="http://ia.media-imdb.com/images/M/MV5BMTM2NjEyNzk2OF5BMl5BanBnXkFtZTcwNjcxNjUyMQ@@._V1_.jpg" ... >, ...]
+````
 
 ### Get the currently popular tv shows
 
-    $ MovieSearcher.popular_shows 
-    => [#<ImdbParty::Movie:0x101ff2858 @imdb_id="tt1327801", @poster_url="http://ia.media-imdb.com/images/M/MV5BMTYxMjYxNjQxNl5BMl5BanBnXkFtZTcwNTU5Nzk4Mw@@._V1_.jpg", @year="2009", @title="Glee">, ... ]
-    
+```` ruby
+MovieSearcher.popular_shows 
+# => [#<ImdbParty::Movie:0x101ff2858 @imdb_id="tt1327801", @poster_url="http://ia.media-imdb.com/images/M/MV5BMTYxMjYxNjQxNl5BMl5BanBnXkFtZTcwNTU5Nzk4Mw@@._V1_.jpg", @year="2009", @title="Glee">, ... ]
+````
+
 ### Some configure alternatives
 
 You can pass some options to the `find_by_release_name` method to specify how it should behave.
 
 Here is an example.
 
-    $ MovieSearcher.find_by_release_name("Heartbreaker 2010 LIMITED DVDRip XviD-SUBMERGE", :options => {:limit => 0.1, :details => true}) 
-
-- ** :limit ** (Float) It defines how sensitive the parsing algorithm should be. Where 0.0 is super sensitive and 1.0 is don't care. The default value is 0.4 and workes in most cases. If you dont get any hits at all, try a large value.
-- ** :details ** (Boolean) By default, the `find_by_release_name` only returns the most basic information about a movie, like *imdb_id*, *title* and *year*. If you set this to true, it will do another request to IMDB and get the casts, actors, rating and so on.
-
-** The option param can't be passed to `find_by_title` **
-
-** `find_movie_by_id` don't require that you pass the `:details` option to get all data **
+```` ruby
+MovieSearcher.find_by_release_name("Heartbreaker 2010 LIMITED DVDRip XviD-SUBMERGE")
+````
 
 ## What is being returned?
 
-The `find_by_title` method returns an `Array` of `ImdbParty::Movie` objects.
-
-These are the accessors of `ImdbParty::Movie`
+These are the accessors of `ImdbParty::Movie`, the object being returned from `find_by_release_name` for example.
 
 - **imdb_id** (String) The imdb id of the movie.
 - **title** (String) The title of the movie.
@@ -121,4 +120,4 @@ The `actors`, `writers` and `directors` accessors returns an `ImdbParty::Person`
 
 ## Requirements
 
-The gem is tested in OS X 10.6.6 using Ruby 1.8.7 and 1.9.2
+*MovieSearcher* is tested in OS X 10.6.6, 10.6.7 using Ruby 1.8.7 and 1.9.2

data/Rakefile

@@ -1,56 +1,2 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "imdb_party"
-    gem.summary = %Q{IMDB client using the IMDB API that their iPhone app uses}
-    gem.description = %Q{IMDB client using the IMDB API that their iPhone app uses}
-    gem.email = "jon@mustacheinc.com"
-    gem.homepage = "http://github.com/maddox/imdb_party"
-    gem.authors = ["Jon Maddox"]
-    gem.add_development_dependency "shoulda"
-    gem.add_dependency "httparty"
-  end
-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 :test => :check_dependencies
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "imdb_party #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/imdb_party.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'httparty'
 
 directory = File.expand_path(File.dirname(__FILE__))
@@ -5,4 +6,3 @@ require File.join(directory, 'imdb_party', 'httparty_icebox')
 require File.join(directory, 'imdb_party', 'imdb')
 require File.join(directory, 'imdb_party', 'movie')
 require File.join(directory, 'imdb_party', 'person')
-

data/lib/imdb_party/imdb.rb

@@ -5,18 +5,39 @@ module ImdbParty
     cache :store => 'file', :timeout => 120, :location => Dir.tmpdir
     
     base_uri 'app.imdb.com'
-    default_params = {"api" => "v1", "appid" => "iphone1", "locale" => "en_US", "timestamp" => Time.now.to_i, "sig" => "heres my signature"}
 
+    def initialize(options={})
+      self.class.base_uri 'anonymouse.org/cgi-bin/anon-www.cgi/http://app.imdb.com' if options[:anonymize]
+    end
+    
+    def build_url(path, params={})
+      default_params = {"api" => "v1", "appid" => "iphone1_1", "apiPolicy" => "app1_1", "apiKey" => "2wex6aeu6a8q9e49k7sfvufd6rhh0n", "locale" => "en_US", "timestamp" => Time.now.to_i}
+
+      query_params = default_params.merge(params)
+      query_param_array = []
+      
+      host = self.class.base_uri.gsub('http://', '').to_s
+
+      query_params.each_pair{|key, value| query_param_array << "#{key}=#{URI.escape(value.to_s)}" }
+      uri = URI::HTTP.build(:scheme => 'https', :host => host, :path => path, :query => query_param_array.join("&"))
+
+      query_param_array << "sig=app1-#{OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha1'), default_params["apiKey"], uri.to_s)}"
+
+      uri = URI::HTTP.build(:scheme => 'https', :host => host, :path => path, :query => query_param_array.join("&"))
+      uri.to_s
+    end
     
     def find_by_title(title)
       movie_results = []
-      results = self.class.get('/find', :query => {:q => title}).parsed_response
+      url = build_url('/find', :q => title)
+      
+      results = self.class.get(url).parsed_response
       
       if results["data"] && results["data"]["results"]
         results["data"]["results"].each do |result_section|
           result_section["list"].each do |r|
             next unless r["tconst"] && r["title"]
-            h = {:title => r["title"], :year => r["year"], :imdb_id => r["tconst"]}
+            h = {:title => r["title"], :year => r["year"], :imdb_id => r["tconst"], :kind => r["type"]}
             h.merge!(:poster_url => r["image"]["url"]) if r["image"] && r["image"]["url"]
             movie_results << h
           end
@@ -27,17 +48,23 @@ module ImdbParty
     end
 
     def find_movie_by_id(imdb_id)
-      result = self.class.get('/title/maindetails', :query => {:tconst => imdb_id}).parsed_response
-      Movie.new(result["data"]) unless result["data"].nil?
+      url = build_url('/title/maindetails', :tconst => imdb_id)
+      
+      result = self.class.get(url).parsed_response
+      Movie.new(result["data"]) if result["data"]
     end
     
     def top_250
-      results = self.class.get('/chart/top').parsed_response
+      url = build_url('/chart/top')
+
+      results = self.class.get(url).parsed_response
       results["data"]["list"]["list"].map { |r| {:title => r["title"], :imdb_id => r["tconst"], :year => r["year"], :poster_url => (r["image"] ? r["image"]["url"] : nil)} }
     end
 
     def popular_shows
-      results = self.class.get('/chart/tv').parsed_response
+      url = build_url('/chart/tv')
+
+      results = self.class.get(url).parsed_response
       results["data"]["list"].map { |r| {:title => r["title"], :imdb_id => r["tconst"], :year => r["year"], :poster_url => (r["image"] ? r["image"]["url"] : nil)} }
     end
     

data/lib/imdb_party/movie.rb

@@ -2,7 +2,7 @@ module ImdbParty
   class Movie
     attr_accessor :imdb_id, :title, :directors, :writers, :tagline, :company, :plot, :runtime, :rating, :poster_url, :release_date, :certification, :genres, :actors, :trailers, :year
 
-    def initialize(options={})
+    def initialize(options={})      
       if not options.nil? and options.keys.first.class == Symbol
         options.keys.each { |name| instance_variable_set "@" + name.to_s, options[name] }; return
       end

data/lib/movie_searcher.rb

@@ -1,6 +1,9 @@
 require "imdb_party"
 require 'levenshteinish'
-require 'mimer_plus'
+require "mimer_plus"
+require "rest-client"
+require "spot"
+
 class MovieSearcher
   attr_accessor :options, :cleaners
   
@@ -21,14 +24,11 @@ class MovieSearcher
   
   # Finds the movie based on the release name of the movie
   def self.find_by_release_name(search_value, options = {})
+    return if search_value.nil? or search_value.length.zero?
     this = MovieSearcher.new(options.merge(:search_value => search_value.to_s))
     return if this.to_long?
     
-    movie = this.find_the_movie!
-    return if movie.nil?
-    
-    # If the user wants for information about the movie, the {options[:details]} option should be true
-    this.options[:details] ? self.find_movie_by_id(movie.imdb_id) : movie
+    this.find_the_movie!
   end
   
   # Finds the movie based on the nfo file (or similar file)
@@ -86,28 +86,24 @@ class MovieSearcher
   end
   
   def find_the_movie!
-    current =  @split.length
-    
-    until current <= 0 do
-      title = @split.take(current).join(' ')      
-      movies = @options[:imdb].find_by_title(title)
-      break if movies.any? and movies.reject{ |movie| self.shortest(movie, title).nil? }.any?
-      current -= 1 
-    end
-    
-    return if movies.nil? or not movies.any?
+    search = Spot.new.clean!(cleaner(@search_value)).gsub(/\s+/, "_")
 
-    movie = movies.map do |movie| 
-      [movie, self.shortest(movie, title)]
-    end.reject do |value|
-      value.last.nil?
-    end.sort_by do |_,value|
-      value
-    end.first
-    
-    return if movie.nil?
-    
-    ImdbParty::Movie.new(movie.first)
+    run = true
+    count = 0
+    while run
+      run = false
+      begin
+        data = RestClient.get "http://sg.media-imdb.com/suggests/#{search[0]}/#{search[0..(search.length - count)]}.json"
+      rescue RestClient::Exception
+        run = true
+        count += 1
+      end
+      
+      if not run or count >= search.length
+        iid = data.match(/(tt\d+)/).to_a[1]
+      end
+    end
+    MovieSearcher.find_movie_by_id(iid) if iid
   end
   
   def self.method_missing(method, *args, &block)  

data/movie_searcher.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "movie_searcher"
-  s.version     = "0.1.4"
+  s.version     = "0.1.6"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Linus Oleander", "Jon Maddox"]
   s.email       = ["linus@oleander.nu", "jon@mustacheinc.com"]
@@ -16,12 +16,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_dependency('httparty')
-  s.add_dependency('levenshteinish')
-  s.add_dependency('mimer_plus')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('autotest-standalone')
-  s.add_development_dependency('autotest')
-  s.add_development_dependency('autotest-growl')
-  s.add_development_dependency('autotest-fsevent')
+  s.add_dependency("httparty")
+  s.add_dependency("levenshteinish")
+  s.add_dependency("mimer_plus")
+  s.add_dependency("spot")
+  s.add_dependency("rest-client")
+  
+  s.add_development_dependency("rspec")
 end

data/spec/movie_searcher_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 
 describe MovieSearcher do
   it "should only contain should instances of {ImdbParty::Movie}" do
-    MovieSearcher.find_by_title("The Dark Knight").each{|movie| movie.should be_instance_of(ImdbParty::Movie)}
+    MovieSearcher.find_by_title("The Dark Knight").each {|m| m.should be_instance_of(ImdbParty::Movie) }
   end
   
   it "should only contain one instance of {ImdbParty::Movie}" do
@@ -46,10 +46,6 @@ describe MovieSearcher do
     MovieSearcher.find_by_release_name(nil).should be_nil
   end
   
-  it "should not have a rating if the details option isn't being passed" do
-    MovieSearcher.find_by_release_name('Paranormal Activity 2 2010 UNRATED DVDRip XviD-Larceny').rating.should be_nil
-  end
-  
   it "should return a rating if the detail option is being passed" do
     MovieSearcher.find_by_release_name('Paranormal Activity 2 2010 UNRATED DVDRip XviD-Larceny', :options => {:details => true}).rating.should_not be_nil
   end
@@ -98,7 +94,7 @@ describe MovieSearcher, "should work as before" do
 
   it "have trailers" do
     @movie.trailers.should be_instance_of(Hash)
-    @movie.should have(4).trailers
+    @movie.should have(1).trailers
     @movie.trailers[@movie.trailers.keys.first].should eq("http://www.totaleclips.com/Player/Bounce.aspx?eclipid=e27826&bitrateid=461&vendorid=102&type=.mp4")
   end
 
@@ -136,18 +132,6 @@ describe MovieSearcher, "should work as before" do
 end
 
 describe MovieSearcher, "should also work as before" do
-  it "should have at least 15 results" do
-    MovieSearcher.find_by_title("ratatouille").count.should >= 15
-  end
-
-  it "search for title with spaces in the name" do
-    MovieSearcher.find_by_title("the truman show").count.should >= 1
-  end
-
-  it "search for bad title with no results" do
-    MovieSearcher.find_by_title("sdkljlkkl123j4lk23kl3").count.should eq(0)
-  end
-
   it "find movie by id" do
     MovieSearcher.find_movie_by_id("tt0382932").should be_instance_of(ImdbParty::Movie)
   end

metadata

@@ -2,7 +2,7 @@
 name: movie_searcher
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors: 
 - Linus Oleander
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-14 00:00:00 +01:00
+date: 2011-05-03 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,7 +48,7 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: spot
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -56,10 +56,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: autotest-standalone
+  name: rest-client
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -67,10 +67,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: autotest
+  name: rspec
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -80,28 +80,6 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: autotest-growl
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: autotest-fsevent
-  prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :development
-  version_requirements: *id008
 description: IMDB client using the IMDB API that their iPhone app uses. It can also figure out what movie you are looking for just by looking at the release name of the movie
 email: 
 - linus@oleander.nu
@@ -177,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: IMDB client using the IMDB API that their iPhone app uses