filmbuff 0.1.6 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0835d52418eba19073d416952ffa7a71319f22b9
+  data.tar.gz: 60bec3177b930f361f2748b6f34c78d4a6b74fa2
+SHA512:
+  metadata.gz: 6d7acb437fa288d558443c67427a379c7aab193d92e1ed30b948dd49e6ed68106d07d2f8b8c9a6072cef7accb3ed94bf19b1aac69b2f03cc586009f5ffe8f1be
+  data.tar.gz: b24b15228ee313ee8bce26f111305796b459563030c9a4494fc1181a91069641d3084916c747271e495645f67640b873a582b190ff9e45db509fda08b3c483c3

data/.gitignore

@@ -3,6 +3,7 @@
 Gemfile.lock
 pkg/*
 .DS_Store
-.rvmrc
-.rspec
 vendor
+.yardoc
+doc
+coverage

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+script: rake test
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - ruby-head
+  - jruby-9.0.0.0
+  - jruby-head
+  - rbx-2.5.8

data/{History → CHANGES}

@@ -1,3 +1,21 @@
+=== 1.0.0 / 2015-08-25
+
+* 1 major enhancement
+
+  * Incompatible with older versions of Film Buff!
+  * Now requires Ruby 2.0.0 or newer because of the use of keyword arguments.
+  * Film Buff is no longer a module, but a class. Use it by creating an
+    instance with `imdb = FilmBuff.new`
+  * `find_by_id` is now called `look_up_id`
+  * `find_by_title` is now called `search_for_title`
+  * `search_for_title` now returns an array with results.
+
+* 1 minor enhancement
+
+  * http.rb has replaced HTTParty
+  * Implemented YARD documentation. It can be found at
+    http://rubydoc.info/gems/filmbuff/frames
+
 === 0.1.6 / 2012-07-24
 
 * 1 minor enhancement

data/Gemfile

@@ -1,3 +1,8 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
+
+group :development do
+  gem 'guard'
+  gem 'guard-minitest'
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb})      { 'test' }
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Kristoffer Sachse
+Copyright (c) 2015 Kristoffer Sachse
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,26 +1,35 @@
 # Film Buff - A Ruby wrapper for IMDb's JSON API
 
+[![Gem Version](https://img.shields.io/gem/v/filmbuff.svg)](https://rubygems.org/gems/filmbuff)
+[![Build Status](https://img.shields.io/travis/sachse/filmbuff.svg)](https://travis-ci.org/sachse/filmbuff)
+[![Dependency Status](https://img.shields.io/gemnasium/sachse/filmbuff.svg)](https://gemnasium.com/sachse/filmbuff)
+[![Coverage Status](https://img.shields.io/coveralls/sachse/filmbuff/master.svg)](https://coveralls.io/r/sachse/filmbuff)
+[![Inline docs](https://inch-ci.org/github/sachse/filmbuff.svg?branch=master)](https://inch-ci.org/github/sachse/filmbuff/)
+
 ## Description
 
 Film Buff provides a Ruby wrapper for IMDb's JSON API, which is the fastest and easiest way to get information from IMDb.
 
-## Installation
+Film Buff supports IMDb's different locales, so information can be retrieved in different languages. See [Locales](#locales) for more information.
 
-### RubyGems
+## Usage
 
-You can install the latest Film Buff gem using RubyGems
+Film Buff 1.0.x provides two ways to return information on a movie or TV show. First, set up an IMDb instance:
 
-    gem install filmbuff
+    require 'filmbuff'
+    imdb = FilmBuff.new
 
-### GitHub
+### look_up_id
 
-Alternatively you can check out the latest code directly from Github
+If you know the movie or TV show's IMDb ID you can return an object with the IMDb information:
 
-    git clone http://github.com/sachse/filmbuff.git
+    movie = imdb.look_up_id('tt0032138')
 
-## Usage
+    movie.title => "The Wizard of Oz"
+    movie.rating => 8.2
+    movie.genres => ["Adventure", Family", "Fantasy", "Musical"]
 
-Accessible title information is:
+Accessible information for an object returned by `look_up_id` is:
 
 - Title
 - Tagline
@@ -33,37 +42,100 @@ Accessible title information is:
 - Release date
 - IMDb ID
 
-### Examples
+### search_for_title
 
-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:
+You can also search for a movie or TV show by its title. This will return an array with results from IMDb's search feature:
 
-    require 'filmbuff'
-    imdb = FilmBuff::IMDb.new
+    results = imdb.search_for_title('The Wizard of Oz')
 
-You can then find a movie by its title. This will return the first result from IMDb's search feature:
+    results =>  [
+                    {
+                        :type => "title_popular",
+                        :imdb_id => "tt0032138",
+                        :title => "The Wizard of Oz",
+                        :release_year => "1939"
+                    },
 
-    movie = imdb.find_by_title("The Wizard of Oz")
-    
-    movie.title => "The Wizard of Oz"
-    movie.rating => 8.3
-    movie.genres => ["Adventure", "Comedy", "Family", "Fantasy", "Musical"]
+                    {
+                        :type => "title_exact",
+                        :imdb_id => "tt0016544",
+                        :title => "The Wizard of Oz",
+                        :release_year => "1925"
+                    },
 
-If you know the movie's IMDb ID you can get the information as well:
+                    {
+                        :type=>"title_exact",
+                        :imdb_id=>"tt0001463",
+                        :title=>"The Wonderful Wizard of Oz",
+                        :release_year=>"1910"
+                    },
 
-    movie = imdb.find_by_id("tt0032138")
-    
-    movie.title => "The Wizard of Oz"
-    movie.rating => 8.3
-    movie.genres => ["Adventure", "Comedy", "Family", "Fantasy", "Musical"]
+                    etc.
+
+                ]
+
+### Configuration
+
+When initializing a new `FilmBuff` instance keyword arguments can passed to change default behaviours:
+
+- SSL is used by default when communicating with IMDb but it can be turned off by setting `ssl` to false.
+- Locale defaults to `en_US` but this behaviour can be changed by passing `locale` with a different value. Locale can also be changed as necessary during runtime. See [Locales](#locales) for more information.
+
+`search_for_title` also takes keyword arguments that can be used to change the default behaviours on a per search basis.
+
+- `limit` limits the amount of results returned.
+- `types` decides the types of titles IMDb will search. Valid settings are:
+    - title_popular
+    - title_exact
+    - title_approx
+    - title_substring
 
-To retrieve information in a different language, set the instance variable locale to your wanted locale:
+#### Examples
 
-    imdb.locale = "de_DE"
-    movie = imdb.find_by_id("tt0032138")
-    
-    movie.title => "Das zauberhafte Land"
-    movie.rating => 8.3
-    movie.genres => ["Abenteuer", "Komödie", "Familie", "Fantasy", "Musical"]
+Return only 2 results:
+
+    results = imdb.search_for_title('The Wizard of Oz', limit: 2)
+
+    results =>  [
+                    {
+                        :type => "title_popular",
+                        :imdb_id => "tt0032138",
+                        :title => "The Wizard of Oz",
+                        :release_year => "1939"
+                    },
+
+                    {
+                        :type => "title_exact",
+                        :imdb_id => "tt0016544",
+                        :title => "The Wizard of Oz",
+                        :release_year => "1925"
+                    }
+                ]
+
+
+Only return popular results related to the title provided:
+
+    result = imdb.search_for_title('The Wizard of Oz', types: %w(title_popular))
+
+    result =>   [
+                    {
+                        :type => "title_popular",
+                        :imdb_id => "tt0032138",
+                        :title => "The Wizard of Oz",
+                        :release_year => "1939"
+                    }
+                ]
+
+#### Locales
+
+To retrieve information in a different language, either pass locale as as keyword argument when setting up an instance of `imdb` or set the instance variable `locale` to your wanted locale once the instance has already been created:
+
+    imdb.locale = 'fr_FR'
+    movie = imdb.look_up_id('tt0032138')
+
+    movie.title => "Le magicien d'Oz"
+    movie.rating => 8.2
+    movie.genres => ["Aventure", "Famille", "Fantasy", "Musical"]
 
 Supported locales are
 
@@ -74,14 +146,20 @@ Supported locales are
 - it_IT (Italian)
 - pt_PT (Portuguese)
 
+## Links
+
+- [Public git repository](https://github.com/sachse/filmbuff)
+- [Online documentation](http://rubydoc.info/gems/filmbuff/frames)
+- [Issue tracker](https://github.com/sachse/filmbuff/issues)
+- [Film Buff on RubyGems](https://rubygems.org/gems/filmbuff)
+
 ## Authors
 
-* [Kristoffer Sachse](https://github.com/sachse)
+- [Kristoffer Sachse](https://github.com/sachse)
 
 ## Contribute
 
-Fork the project, implement your changes in it's own branch, and send
-a pull request to me. I'll gladly consider any help or ideas.
+You can contribute either with code by forking the project, implementing your changes in its own branch, and sending a pull request, or you can report issues and ideas for changes [on the issues page](https://github.com/sachse/filmbuff/issues).
 
 ### Contributors
-- Jon Maddox (https://github.com/maddox) inspired the 0.1.0 rewrite through the imdb_party gem.
+- [Jon Maddox](https://github.com/maddox) inspired the 0.1.0 rewrite through his imdb_party gem.

data/Rakefile

@@ -1,2 +1,12 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs = ['test', 'fixtures']
+  t.test_files = ['test/test_filmbuff.rb',
+                  'test/filmbuff/test_filmbuff_title.rb'
+                 ]
+end

data/filmbuff.gemspec

@@ -1,24 +1,31 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "filmbuff/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'filmbuff/version'
 
 Gem::Specification.new do |s|
-  s.name        = "filmbuff"
-  s.version     = Filmbuff::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Kristoffer Sachse"]
-  s.email       = ["kristoffer@sachse.nu"]
-  s.homepage    = "https://github.com/sachse/filmbuff"
-  s.summary     = %q{A Ruby wrapper for IMDb's JSON API}
-  s.description = %q{Film Buff provides a Ruby wrapper for IMDb's JSON API, which is the fastest and easiest way to get information from IMDb.}
+  s.name        = 'filmbuff'
+  s.version     = FilmBuff::VERSION
+  s.authors     = ['Kristoffer Sachse']
+  s.email       = ['hello@kristoffer.is']
+  s.homepage    = 'https://github.com/sachse/filmbuff'
+  s.summary     = 'A Ruby wrapper for IMDb\'s JSON API'
+  s.description = 'Film Buff provides a Ruby wrapper for IMDb\'s JSON API, ' <<
+                  'which is the fastest and easiest way to get information ' <<
+                  'from IMDb.'
+  s.license     = 'MIT'
 
-  s.rubyforge_project = "filmbuff"
+  s.required_ruby_version = '>= 2.0.0'
 
-  s.add_dependency("httparty", "~> 0.8.3")
-  s.add_dependency("httparty-icebox", "~> 0.0.4")
-  s.add_development_dependency("rspec", ">= 2.5.0")
+  s.add_dependency('http', '~> 0.9.3')
+
+  s.add_development_dependency('minitest', '>= 1.4.0')
+  s.add_development_dependency('vcr', '>= 2.4')
+  s.add_development_dependency('webmock')
+  s.add_development_dependency('yard', '>= 0.8.5.2')
+  s.add_development_dependency('kramdown')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('coveralls')
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  s.require_paths = ["lib"]
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.require_paths = ['lib']
 end

data/lib/filmbuff.rb

@@ -1,6 +1,109 @@
-require 'httparty'
-require 'httparty-icebox'
+require 'filmbuff/title'
 
-dir = File.expand_path(File.dirname(__FILE__))
-require File.join(dir, 'filmbuff', 'imdb')
-require File.join(dir, 'filmbuff', 'title')
+require 'http'
+require 'json'
+
+# Interacts with IMDb and is used to look up titles
+class FilmBuff
+  class NotFound < StandardError; end
+
+  # @return [String] The locale currently used by the IMDb instance
+  attr_accessor :locale
+
+  # Create a new FilmBuff instance
+  #
+  # @param [String] locale
+  #   The locale to search with. The FilmBuff instance will also return
+  #   results in the language matching the given locale. Defaults to `en_US`
+  #
+  # @param [Boolean] ssl
+  #   Whether or not to use SSL when searching by IMDb ID (IMDb does not
+  #   currently support SSL when searching by title). Defaults to `true`
+  def initialize(locale = 'en_US', ssl: true)
+    @locale = locale
+    @protocol = ssl ? 'https' : 'http'
+  end
+
+  private
+
+  def build_hash(type, value)
+    {
+      type: type,
+      imdb_id: value['id'],
+      title: value['title'],
+      release_year: value['description'][/\A\d{4}/]
+    }
+  end
+
+  public
+
+  # Looks up the title with the IMDb ID imdb_id and returns a
+  # FilmBuff::Title object with information on that title
+  #
+  # @param [String] imdb_id
+  #   The IMDb ID for the title to look up
+  #
+  # @return [Title]
+  #   The FilmBuff::Title object containing information on the title
+  #
+  # @example Basic usage
+  #   movie = imdb_instance.look_up_id('tt0032138')
+  def look_up_id(imdb_id)
+    response = HTTP.get("#{@protocol}://app.imdb.com/title/maindetails", params: {
+      tconst: imdb_id, locale: @locale
+    })
+
+    if response.status != 200
+      fail NotFound
+    else
+      Title.new(response.parse['data'])
+    end
+  end
+
+  # Searches IMDb for the title provided and returns an array with results
+  #
+  # @param [String] title The title to search for
+  #
+  # @param [Integer] limit The maximum number of results to return
+  #
+  # @param [Array] types The types of matches to search for.
+  #   These types will be searched in the provided order. Can be
+  #   `title_popular`, `title_exact`, `title_approx`, and `title_substring`
+  #
+  # @return [Array<Hash>] An array of hashes, each representing a search result
+  #
+  # @example Basic usage
+  #   movie = imdb_instance.search_for_title('The Wizard of Oz')
+  #
+  # @example Return only 2 results
+  #   movie = imdb_instance.search_for_title('The Wizard of Oz', limit: 2)
+  #
+  # @example Only return results containing the exact title provided
+  #   movie = imdb_instance.search_for_title('The Wizard of Oz',
+  #                                          types: %w(title_exact))
+  def search_for_title(title, limit: nil, types: %w(title_popular
+                                                 title_exact
+                                                 title_approx
+                                                 title_substring))
+    response = JSON.parse(HTTP.get('http://www.imdb.com/xml/find', params: {
+      q: title,
+      json: '1'
+    }).to_s)
+
+    output = []
+    results = response.select { |type| types.include? type }
+
+    results.each_key do |type|
+      response[type].each do |hash|
+        break unless output.size < limit if limit
+        next unless hash['id'] && hash['title'] && hash['description']
+
+        output << build_hash(type, hash)
+      end
+    end
+
+    fail NotFound if output.empty?
+
+    output
+  end
+end

data/lib/filmbuff/title.rb

@@ -1,20 +1,63 @@
-module FilmBuff
+require 'date'
+
+class FilmBuff
+  # Represents a single title from IMDb and contains all available data on it
   class Title
-    attr_reader :imdb_id, :title, :tagline, :plot, :runtime, :rating, :votes,
-      :poster_url, :genres, :release_date
-
-    def initialize(options = {})
-      @imdb_id = options["tconst"]
-      @title = options["title"]
-      @tagline = options["tagline"]
-      @plot = options["plot"]["outline"] if options["plot"]
-      @runtime = options["runtime"]["time"] if options["runtime"]
-      @rating = options["rating"]
-      @votes = options["num_votes"]
-      @poster_url = options["image"]["url"] if options["image"]
-      @genres = options["genres"] || []
-      @release_date = Date.strptime(options["release_date"]["normal"]) if
-        options["release_date"]
+    # @return [String] The IMDb ID of Title
+    attr_reader :imdb_id
+
+    # @return [String] The title of Title
+    attr_reader :title
+
+    # @return [String] The tagline of Title
+    attr_reader :tagline
+
+    # @return [String] The plot summary of Title
+    attr_reader :plot
+
+    # @return [Integer] The runtime of Title in seconds
+    attr_reader :runtime
+
+    # @return [Float] The IMDb rating of Title
+    attr_reader :rating
+
+    # @return [Integer] The amount of votes that have been used to determine
+    #   the rating of Title
+    attr_reader :votes
+
+    # @return [String] The URL for the poster of Title
+    attr_reader :poster_url
+
+    # @return [Array<String>] The genres of Title
+    attr_reader :genres
+
+    # @return [Date, String] The release date of Title. Returns a Date when
+    #   possible, otherwise a String
+    attr_reader :release_date
+
+    # Create a new Title instance from an IMDb hash
+    #
+    # @param [Hash] imdb_hash
+    #   The hash with IMDb information to create a Title instance from
+    def initialize(imdb_hash)
+      @imdb_id = imdb_hash['tconst']
+      @title = imdb_hash['title']
+      @tagline = imdb_hash['tagline'] if imdb_hash['tagline']
+      @plot = imdb_hash['plot']['outline'] if imdb_hash['plot']
+      @runtime = imdb_hash['runtime']['time'] if imdb_hash['runtime']
+      @rating = imdb_hash['rating']
+      @votes = imdb_hash['num_votes']
+      @poster_url = imdb_hash['image']['url'] if imdb_hash['image']
+      @genres = imdb_hash['genres'] || []
+
+      if imdb_hash['release_date']
+        begin
+          @release_date = Date.strptime(imdb_hash['release_date']['normal'],
+                                        '%Y-%m-%d')
+        rescue
+          @release_date = imdb_hash['release_date']['normal']
+        end
+      end
     end
   end
 end

data/lib/filmbuff/version.rb

@@ -1,3 +1,4 @@
-module Filmbuff
-  VERSION = "0.1.6"
+class FilmBuff
+  # Version number of the latest gem release of Film Buff
+  VERSION = '1.0.0'
 end

data/test/filmbuff/test_filmbuff_title.rb

@@ -0,0 +1,65 @@
+require_relative '../test_helper'
+
+describe FilmBuff::Title do
+  before do
+    @imdb = FilmBuff.new
+
+    VCR.use_cassette('The Wizard of Oz by ID') do
+      @title = @imdb.look_up_id('tt0032138')
+    end
+  end
+
+  it 'has an IMDb ID' do
+    assert_equal 'tt0032138', @title.imdb_id
+  end
+
+  it 'has a title' do
+    assert_equal 'The Wizard of Oz', @title.title
+  end
+
+  it 'has a tagline' do
+    assert_equal 'Mighty Miracle Show Of 1000 Delights !', @title.tagline
+  end
+
+  it 'has a plot' do
+    assert_equal '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.', @title.plot
+  end
+
+  it 'has a runtime' do
+    assert_equal 6120, @title.runtime
+  end
+
+  it 'has a rating' do
+    assert_instance_of Float, @title.rating
+  end
+
+  it 'has an amount of votes' do
+    assert_instance_of Fixnum, @title.votes
+  end
+
+  it 'has a poster URL' do
+    assert_match %r{\Ahttp://ia.media-imdb.com/images/.*/}, @title.poster_url
+  end
+
+  it 'has genres' do
+    assert_equal %w(Adventure Family Fantasy Musical), @title.genres
+  end
+
+  it 'has a release date' do
+    assert_equal Date.strptime('1939-08-25', '%Y-%m-%d'), @title.release_date
+  end
+
+  describe 'when looking up titles without a specific release date' do
+    before do
+      VCR.use_cassette('Rear Window by ID') do
+        @title = @imdb.look_up_id('tt0047396')
+      end
+    end
+
+    it 'falls back to the IMDb provided date' do
+      assert_equal '1954', @title.release_date
+    end
+  end
+end

data/test/test_filmbuff.rb

@@ -0,0 +1,179 @@
+require_relative 'test_helper'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'fixtures/vcr_cassettes'
+  config.hook_into :webmock
+end
+
+describe FilmBuff do
+  before do
+    @imdb = FilmBuff.new
+  end
+
+  describe '#look_up_id' do
+    it 'returns a Title' do
+      VCR.use_cassette('The Wizard of Oz by ID') do
+        @title = @imdb.look_up_id('tt0032138')
+      end
+
+      assert_instance_of FilmBuff::Title, @title
+    end
+
+    describe 'given a non-existent ID' do
+      it 'throws an exception' do
+        VCR.use_cassette('non-existent ID') do
+          assert_raises(FilmBuff::NotFound) do
+            @title = @imdb.look_up_id('tt9999999')
+          end
+        end
+      end
+    end
+
+    describe 'given locale' do
+      describe 'de_DE' do
+        before do
+          @imdb.locale = 'de_DE'
+
+          VCR.use_cassette('The Wizard of Oz German') do
+            @title = @imdb.look_up_id('tt0032138')
+          end
+        end
+
+        it 'returns German information' do
+          assert_equal 'Der Zauberer von Oz', @title.title
+        end
+      end
+
+      describe 'en_US' do
+        before do
+          @imdb.locale = 'en_US'
+
+          VCR.use_cassette('The Wizard of Oz by ID') do
+            @title = @imdb.look_up_id('tt0032138')
+          end
+        end
+
+        it 'returns English information' do
+          assert_equal 'The Wizard of Oz', @title.title
+        end
+      end
+
+      describe 'es_ES' do
+        before do
+          @imdb.locale = 'es_ES'
+
+          VCR.use_cassette('The Wizard of Oz Spanish') do
+            @title = @imdb.look_up_id('tt0032138')
+          end
+        end
+
+        it 'returns Spanish information' do
+          assert_equal 'El mago de Oz', @title.title
+        end
+      end
+
+      describe 'fr_FR' do
+        before do
+          @imdb.locale = 'fr_FR'
+
+          VCR.use_cassette('The Wizard of Oz French') do
+            @title = @imdb.look_up_id('tt0032138')
+          end
+        end
+
+        it 'returns French information' do
+          assert_equal 'Le magicien d\'Oz', @title.title
+        end
+      end
+
+      describe 'it_IT' do
+        before do
+          @imdb.locale = 'it_IT'
+
+          VCR.use_cassette('The Wizard of Oz Italian') do
+            @title = @imdb.look_up_id('tt0032138')
+          end
+        end
+
+        it 'returns Italian information' do
+          assert_equal 'Il mago di Oz', @title.title
+        end
+      end
+
+      describe 'pt_PT' do
+        before do
+          @imdb.locale = 'pt_PT'
+
+          VCR.use_cassette('The Wizard of Oz Portugese') do
+            @title = @imdb.look_up_id('tt0032138')
+          end
+        end
+
+        it 'returns Portugese information' do
+          assert_equal 'O Feiticeiro de Oz', @title.title
+        end
+      end
+    end
+  end
+
+  describe '#search_for_title' do
+    describe 'with default options' do
+      before do
+        VCR.use_cassette('The Wizard of Oz by title') do
+          @titles = @imdb.search_for_title('The Wizard of Oz')
+        end
+      end
+
+      it 'returns an array of titles' do
+        assert_instance_of Array, @titles
+      end
+
+      describe 'given a non-existent title' do
+        it 'throws an exception' do
+          VCR.use_cassette('non-existent title') do
+            assert_raises(FilmBuff::NotFound) do
+              @title = @imdb.search_for_title('123456789012345678901234567890')
+            end
+          end
+        end
+      end
+
+      # describe 'given a title that redirects' do
+      #   it 'follows the redirect and returns a Title object' do
+      #     skip 'this still needs a title to test against'
+
+      #     VCR.use_cassette('Redirecting title') do
+      #       @title = @imdb.search_for_title('')
+      #     end
+
+      #     assert_instance_of FilmBuff::Title, @title
+      #   end
+      # end
+    end
+
+    describe 'given a limit of 3' do
+      before do
+        VCR.use_cassette('The Wizard of Oz by title') do
+          @titles = @imdb.search_for_title('The Wizard of Oz', limit: 3)
+        end
+      end
+
+      it 'returns 3 results' do
+        assert_equal 3, @titles.size
+      end
+    end
+
+    describe 'when only returning popular titles' do
+      before do
+        VCR.use_cassette('The Wizard of Oz by title') do
+          @title = @imdb.search_for_title('The Wizard of Oz',
+                                          types: %w(title_popular))
+        end
+      end
+
+      it 'returns the 1939 version' do
+        assert_equal '1939', @title.first[:release_year]
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+
+if ENV['TRAVIS'] == 'true'
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require 'vcr'
+
+require_relative '../lib/filmbuff'

metadata

@@ -1,109 +1,172 @@
 --- !ruby/object:Gem::Specification
 name: filmbuff
 version: !ruby/object:Gem::Version
-  version: 0.1.6
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Kristoffer Sachse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000 Z
+date: 2015-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: http
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.9.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.9.3
 - !ruby/object:Gem::Dependency
-  name: httparty-icebox
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
-  type: :runtime
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.5.2
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '0'
 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
+- hello@kristoffer.is
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
+- CHANGES
 - Gemfile
-- History
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - filmbuff.gemspec
 - lib/filmbuff.rb
-- lib/filmbuff/imdb.rb
 - lib/filmbuff/title.rb
 - lib/filmbuff/version.rb
-- spec/filmbuff/imdb_spec.rb
-- spec/filmbuff/title_spec.rb
-- spec/filmbuff_spec.rb
-- spec/spec_helper.rb
+- test/filmbuff/test_filmbuff_title.rb
+- test/test_filmbuff.rb
+- test/test_helper.rb
 homepage: https://github.com/sachse/filmbuff
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: filmbuff
-rubygems_version: 1.8.24
+rubyforge_project: 
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby wrapper for IMDb's JSON API
 test_files: []

data/lib/filmbuff/imdb.rb

@@ -1,42 +0,0 @@
-module FilmBuff
-  class IMDb
-    attr_accessor :locale
-
-    include HTTParty
-    include HTTParty::Icebox
-    cache :store => 'memory', :timeout => 120
-
-    base_uri 'app.imdb.com'
-    format :json
-
-    def initialize
-      @locale = "en_US"
-    end
-
-    public
-    def find_by_id(imdb_id)
-      result = self.class.get('/title/maindetails', :query => {
-        :tconst => imdb_id, :locale => @locale
-      }).parsed_response
-      Title.new(result["data"])
-    end
-
-    def find_by_title(title)
-      result = self.class.get('http://www.imdb.com/xml/find', :query => {
-        :q => title,
-        :json => '1',
-        :tt => 'on'
-      }).parsed_response
-
-      %w(title_popular title_exact title_approx title_substring).each do |key|
-        if result[key]
-          result[key].each do |row|
-            next unless row['id'] && row['title'] && row['description']
-
-            return self.find_by_id(row['id'])
-          end
-        end
-      end
-    end
-  end
-end

data/spec/filmbuff/imdb_spec.rb

@@ -1,27 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '../spec_helper'))
-
-describe FilmBuff::IMDb do
-  before(:all) do
-    @imdb = FilmBuff::IMDb.new
-  end
-
-  describe "#find_by_id" do
-    before(:all) do
-      @title = @imdb.find_by_id("tt0032138")
-    end
-
-    it "returns a Title" do
-      @title.instance_of?(FilmBuff::Title).should be_true
-    end
-  end
-
-  describe "#find_by_title" do
-    before(:all) do
-      @title = @imdb.find_by_title("The Wizard of Oz")
-    end
-
-    it "returns a Title" do
-      @title.instance_of?(FilmBuff::Title).should be_true
-    end
-  end
-end

data/spec/filmbuff/title_spec.rb

@@ -1,114 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path(File.join(File.dirname(__FILE__), '../spec_helper'))
-
-describe FilmBuff::Title do
-  context "given no locale" do
-    before(:all) do
-      @imdb = FilmBuff::IMDb.new
-      @title = @imdb.find_by_id("tt0032138")
-    end
-
-    it "has an IMDb ID" do
-      @title.imdb_id.should == "tt0032138"
-    end
-
-    it "has a title" do
-      @title.title.should == "The Wizard of Oz"
-    end
-
-    it "has a tagline" do
-      @title.tagline.should == "Mighty Miracle Show Of 1000 Delights !"
-    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 " <<
-      "return home."
-    end
-
-    it "has a runtime" do
-      @title.runtime.should == 6060
-    end
-
-    it "has a rating" do
-      @title.rating.should be_a(Float)
-    end
-
-    it "has an amount of votes" do
-      @title.votes.should be_a(Integer)
-    end
-
-    it "has a poster URL" do
-      @title.poster_url.should match /http:\/\/ia.media-imdb.com\/images\/.*/
-    end
-
-    it "has genres" do
-      @title.genres.should == %w[ Adventure Family Fantasy Musical ]
-    end
-
-    it "has a release date" do
-      @title.release_date.should == Date.parse("1939-08-25")
-    end
-  end
-
-  context "given locale" do
-    before(:all) do
-      @imdb = FilmBuff::IMDb.new
-    end
-
-    context "\"de_DE\"" do
-      before(:all) do
-        @imdb.locale = "de_DE"
-        @title = @imdb.find_by_id("tt0032138")
-      end
-
-      it "returns German information" do
-        @title.title.should == "Das zauberhafte Land"
-      end
-    end
-
-    context "\"es_ES\"" do
-      before(:all) do
-        @imdb.locale = "es_ES"
-        @title = @imdb.find_by_id("tt0032138")
-      end
-
-      it "returns Spanish information" do
-        @title.title.should == "El mago de Oz"
-      end
-    end
-
-    context "\"fr_FR\"" do
-      before(:all) do
-        @imdb.locale = "fr_FR"
-        @title = @imdb.find_by_id("tt0032138")
-      end
-
-      it "returns French information" do
-        @title.title.should == "Le magicien d'Oz"
-      end
-    end
-
-    context "\"it_IT\"" do
-      before(:all) do
-        @imdb.locale = "it_IT"
-        @title = @imdb.find_by_id("tt0032138")
-      end
-
-      it "returns Italian information" do
-        @title.title.should == "Il mago di Oz"
-      end
-    end
-
-    context "\"pt_PT\"" do
-      before(:all) do
-        @imdb.locale = "pt_PT"
-        @title = @imdb.find_by_id("tt0032138")
-      end
-
-      it "returns Spanish information" do
-        @title.title.should == "O Feiticeiro de Oz"
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'lib', 'filmbuff')