omdbapi 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c26bd37809d517fee3add5282bd1c0010e28cf66
-  data.tar.gz: a060eb969c24d18b1ea70884d8d9fa83e67be255
+  metadata.gz: 272ba0afa85cd815166b6a0b2d077f447d3b652e
+  data.tar.gz: 112b7114fc02de8a93b491c5e6cbef4f65308419
 SHA512:
-  metadata.gz: 876544a128f6edb7170d7e141dffff71a500ae2b108ec4376cbf0108827b883cf773fcab3aad69f3cad5d1716c60420c4f7d4fb8915aa442bfc182aea4e28269
-  data.tar.gz: db4110cbb81529cc03214376bc11039861b98016f33c6efbd1bbfd2c74588f9eb4b984fa62b7d8a38db05a72f09b503ca3146534f085f60962171a7185dd9814
+  metadata.gz: eb65226a4f6ce075f9ff299af4577393e20be45a363ab2cdaba50fd4ca03a05c17a0152c5e84b69212d91b9fc544f05875ef65756a98f97ba5c57d99792ca66f
+  data.tar.gz: fbbaad3014a8944a6ddd743e12872f1c3299563c1e004416ce16a166bbee40e37c821784321381b14c2f5a0970ed42ce97f0ae19053cc3bf361d3d37ef8aa1d4

data/README.md

@@ -1,6 +1,12 @@
 # omdbapi
 
-This gem is (will be) a simple and easy to use wrapper for the [omdbapi.com](http://omdbapi.com/) API.
+[![Gem Version](https://badge.fury.io/rb/omdbapi.png)](http://badge.fury.io/rb/omdbapi)
+
+This gem is a simple and easy to use wrapper for the [omdbapi.com](http://omdbapi.com/) API. This API allows you to pull almost any type of information about a show or movie, and uses information from IMDb. 
+
+## Documentation
+
+The complete documentation for the gem can be viewed at [rdoc.info/gems/omdbapi/frames](http://rdoc.info/gems/omdbapi/frames).
 
 ## Installation
 
@@ -53,12 +59,39 @@ This function will return a Hash with the following information about the title:
 :actors, :plot, :poster, :imdb_rating, :imdb_votes, :imdb_id, :type
 ```
 
+You can also pass in the optional parameters for year or plot. Plot defaults to 'short', so the only other option is 'full'.
+
+```ruby
+OMDB.title('True Grit')
+# => {:title=>"True Grit", :year=>"2010", :rated=>"PG-13"...
+OMDB.title('True Grit', year: '1969')
+# => {:title=>"True Grit", :year=>"1969", :rated=>"G"...
+
+# Get the title with the full plot
+OMDB.title('Breaking Bad', plot: 'full')
+
+# Get the original Italian Job with the full plot
+OMDB.title('The Italian Job', year: '1969', plot: 'full')
+```
+
+### IMDb ID
+
+You can find a title by it's IMDb ID using the id method:
+
+```ruby
+lost = OMDB.id('tt0411008')
+# => {:title=>"Lost", :year=>"2004", :rated=>"TV-14", :released=>"22 Sep 2004", :runtime=>"42 min", :genre=>"Adventure, Drama, Fantasy, Mystery, Sci-Fi, Thriller", :director=>"N/A", :writer=>"J.J. Abrams, Jeffrey Lieber", :actors=>"Matthew Fox, Jorge Garcia, Evangeline Lilly, Naveen Andrews", :plot=>"The survivors of a plane crash are forced to live with each other on a remote island, a dangerous new world that poses unique threats of its own.", :poster=>"http://ia.media-imdb.com/images/M/MV5BMjA3NzMyMzU1MV5BMl5BanBnXkFtZTcwNjc1ODUwMg@@._V1_SX300.jpg", :imdb_rating=>"8.3", :imdb_votes=>"160,182", :imdb_id=>"tt0411008", :type=>"series", :response=>"True"} 
+lost.released    # => "22 Sep 2004"
+lost.imdb_rating # => "8.3"
+# etc...
+```
+
 ### Search
 
-You can find a title by using the find method:
+You can find a title by using the search method:
 
 ```ruby
-results = OMDB.find('Star Wars')
+results = OMDB.search('Star Wars')
 # => [{:title=>"Star Wars", :year=>"1977", :imdb_id=>"tt0076759", :type=>"movie"}, {:title=>"Star Wars: Episode V - The Empire Strikes Back", :year=>"1980", :imdb_id=>"tt0080684", :type=>"movie"}, {:title=>"Star Wars: Episode VI - Return of the Jedi", :year=>"1983", :imdb_id=>"tt0086190", :type=>"movie"}, {:title=>"Star Wars: Episode I - The Phantom Menace", :year=>"1999", :imdb_id=>"tt0120915", :type=>"movie"}, {:title=>"Star Wars: Episode III - Revenge of the Sith", :year=>"2005", :imdb_id=>"tt0121766", :type=>"movie"}, {:title=>"Star Wars: Episode II - Attack of the Clones", :year=>"2002", :imdb_id=>"tt0121765", :type=>"movie"}, {:title=>"Star Wars: The Clone Wars", :year=>"2008", :imdb_id=>"tt1185834", :type=>"movie"}, {:title=>"Star Wars: Clone Wars", :year=>"2003", :imdb_id=>"tt0361243", :type=>"series"}, {:title=>"Star Wars: The Clone Wars", :year=>"2008", :imdb_id=>"tt0458290", :type=>"series"}, {:title=>"The Star Wars Holiday Special", :year=>"1978", :imdb_id=>"tt0193524", :type=>"movie"}]
 results.each { |r| puts r.title }
 # etc...
@@ -70,22 +103,23 @@ This method returns an Array of search results. Each search result is a Hash wit
 :title, :year, :imdb_id, :type
 ```
 
-### Find by IMDb ID
+If there is only a single search result, the title will be returned as a Hash with the full information, instead of the Array of shortened search results.
 
-You can find a title by it's IMDb id using the id method:
-
-```ruby
-lost = OMDB.id('tt0411008')
-# => {:title=>"Lost", :year=>"2004", :rated=>"TV-14", :released=>"22 Sep 2004", :runtime=>"42 min", :genre=>"Adventure, Drama, Fantasy, Mystery, Sci-Fi, Thriller", :director=>"N/A", :writer=>"J.J. Abrams, Jeffrey Lieber", :actors=>"Matthew Fox, Jorge Garcia, Evangeline Lilly, Naveen Andrews", :plot=>"The survivors of a plane crash are forced to live with each other on a remote island, a dangerous new world that poses unique threats of its own.", :poster=>"http://ia.media-imdb.com/images/M/MV5BMjA3NzMyMzU1MV5BMl5BanBnXkFtZTcwNjc1ODUwMg@@._V1_SX300.jpg", :imdb_rating=>"8.3", :imdb_votes=>"160,182", :imdb_id=>"tt0411008", :type=>"series", :response=>"True"} 
-lost.released    # => "22 Sep 2004"
-lost.imdb_rating # => "8.3"
-# etc...
-```
 
 This method will return a Hash of the title's properties, exactly as the title method.
 
+## Running the Tests
+
+The test suite is written using RSpec, and can be run by issuing the following command from the root of the repository:
+
+```bash
+$ rspec spec
+```
+
 ## Contributing
 
+Please feel free to contribute to the project by following the options below.
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/omdbapi/client.rb

@@ -11,11 +11,13 @@ module OMDB
     # Retrieves a movie or show based on its title.
     #
     # @param title [String] The title of the movie or show.
+    # @param options [Hash] Options for the title, plot or year.
     # @return [Hash]
     # @example
     #   OMDB.title('Game of Thrones')
-    def title(title, year=nil)
-      get '/', { t: title }
+    def title(title, options={})
+      params = build_params(title, options)
+      get '/', params
     end
 
 
@@ -29,17 +31,25 @@ module OMDB
       return get '/', { i: imdb_id }
     end
 
-    # Find a movie by its title.
+    # Search for a movie by its title.
     #
-    # @param title [String] The title of the movie or show to find.
+    # @param title [String] The title of the movie or show to search for.
     # @return [Array, Hash]
     # @example
     #   OMDB.find('Star Wars')
-    def find(title)
+    def search(title)
       results = get '/', { s: title }
-      results[:search] ? results[:search] : results
+      if results[:search]
+        # Return the title if there is only one result, otherwise return the seach results
+        search = results.search
+        search.size == 1 ? title(search[0].title) : search
+      else
+        results
+      end
     end
 
+    alias_method :find, :search
+
     private
 
       # Performs a method on all hash keys.
@@ -57,6 +67,18 @@ module OMDB
         end
       end
 
+      # Build parameters for a request.
+      #
+      # @param title [String] The title of the show.
+      # @param options [Hash] The optional parameters.
+      # @return [Hash]
+      def build_params(title, options)
+        params = { t: title }
+        params[:plot] = options[:plot] if options[:plot]
+        params[:y] = options[:year] if options[:year]
+        params
+      end
+
       # Performs a get request.
       #
       # @param url [String] The url to perform the get request to.

data/lib/omdbapi/version.rb

@@ -2,5 +2,5 @@ module OMDB
   # OMDB current version
   #
   # @return [String]
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/omdbapi.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["caseyscarborough@gmail.com"]
   spec.description   = '[In Progress] A wrapper for the omdbapi.com movie API.'
   spec.summary       = 'This gem provides easy access for information retrieval from omdbapi.com.'
-  spec.homepage      = "https://github.com/caseyscarborough/omdbapi"
+  spec.homepage      = "http://caseyscarborough.github.io/omdbapi"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/spec/omdbapi/client_spec.rb

@@ -25,6 +25,24 @@ describe OMDB::Client do
         end
       end
 
+      describe 'with the year parameter' do
+        let(:title1) { OMDB.title('True Grit') }
+        let(:title2) { OMDB.title('True Grit', year: '1969') }
+
+        it 'should not be the same title' do
+          title1.should_not eq(title2)
+        end
+      end
+
+      describe 'with the plot parameter' do
+        let(:title1) { OMDB.title('Game of Thrones') }
+        let(:title2) { OMDB.title('Game of Thrones', plot: 'full') }
+
+        it 'should have different plots' do
+          title1.plot.should_not eq(title2.plot)
+        end
+      end
+
       describe 'with a movie that doesn''t exist' do
         let(:title) { OMDB.title('lsdfoweirjrpwef323423dsfkip') }
         
@@ -73,10 +91,10 @@ describe OMDB::Client do
       end
     end
 
-    describe 'find' do
+    describe 'search' do
 
       describe 'with search results' do
-        let(:results) { OMDB.find('Star Wars') }
+        let(:results) { OMDB.search('Star Wars') }
 
         it 'should return an array' do
           results.should be_instance_of Array
@@ -87,8 +105,20 @@ describe OMDB::Client do
         end
       end
 
+      describe 'with a single search result' do
+        let(:result) { OMDB.search('The Star Wars Holiday Special') }
+
+        it 'should return a hash of the title' do
+          result.should be_instance_of Hash
+        end
+
+        it 'should have a title' do
+          result.title.should eq('The Star Wars Holiday Special')
+        end
+      end
+
       describe 'with no search results' do
-        let(:results) { OMDB.find('lsdfoweirjrpwef323423dsfkip') }
+        let(:results) { OMDB.search('lsdfoweirjrpwef323423dsfkip') }
 
         it 'should return a hash' do
           results.should be_instance_of Hash
@@ -102,6 +132,12 @@ describe OMDB::Client do
           results.error.should be_instance_of String
         end
       end
+
+      describe 'should be aliased to find' do
+        it 'should be the same method' do
+          OMDB.search('Star Wars').should eq(OMDB.find('Star Wars'))
+        end
+      end
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omdbapi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Casey Scarborough
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-12 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,7 +87,7 @@ files:
 - spec/omdbapi/client_spec.rb
 - spec/omdbapi/default_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/caseyscarborough/omdbapi
+homepage: http://caseyscarborough.github.io/omdbapi
 licenses:
 - MIT
 metadata: {}
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: This gem provides easy access for information retrieval from omdbapi.com.