omdbapi 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f96546e47313f62cae59711b67ad3c44e97a627e
-  data.tar.gz: a6d69f0a189d0a57c8c9e46334bbb23fdaa973bd
+  metadata.gz: 40dd8088ca9737b6860e5fc19e7107459be09dc3
+  data.tar.gz: 4d45a4457544555a7105bed0a11c8b0e12853f9d
 SHA512:
-  metadata.gz: c9d2645b01291cf785e4e9e810abaa60a09c48c68ec932edbe613564dc49fe4e77bbe66dd9e04cf59f7113288298ca5e7d8d6eca0ac3da35a299783f151cc2ab
-  data.tar.gz: 599596e06bfe191982051c8a423bb242ef9f72934a225deaf834d4ba0d5bbfe475c8c0a16dcf5e0adf8d8cf3b6bf048b18f6a4aee2b8e8d12366fcc5dc70039e
+  metadata.gz: 3daf4e22024a8d57e23da703dde0a28f7157c788541ed66bc844a5bcc2cc62e10bdd40d0676f7e870d0a91a88c5039d53b0415b84a33a56bb3039b835f562e8a
+  data.tar.gz: d67b7e3a2e8bcbfb401e49b981e9c0cbb0b95c71a7a148709963aa55f6cd912af318fc9ba7272f10520284cf997d817e81f905f880724d35f3099bbb120afd37

data/lib/omdbapi/client.rb

@@ -16,27 +16,31 @@ module OMDB
     # @option options [String] :plot 'short' (default), 'full'
     # @option options [Integer] :season The season to retrieve.
     # @option options [Integer] :episode The episode to retrieve. Requires the season parameter.
+    # @option options [Boolean] :tomatoes Include Rotten Tomatoes ratings.
     # @return [Hash]
     # @example
     #   OMDB.title('Game of Thrones')
-    def title(title, options={})
+    def title(title, options = {})
       params = { t: title }
       params[:y] = options[:year] if options[:year]
       params[:plot] = options[:plot] if options[:plot]
       params[:season] = options[:season] if options[:season]
       params[:episode] = options[:episode] if options[:episode]
+      params[:tomatoes] = options[:tomatoes] if options[:tomatoes]
       get '/', params
     end
 
-
     # Retrieves a movie or show based on its IMDb ID.
     #
     # @param imdb_id [String] The IMDb ID of the movie or show.
+    # @option options [Boolean] :tomatoes Include Rotten Tomatoes ratings.
     # @return [Hash]
     # @example
     #   OMDB.id('tt0944947')
-    def id(imdb_id) 
-      get '/', { i: imdb_id }
+    def id(imdb_id, options = {})
+      params = { i: imdb_id }
+      params[:tomatoes] = options[:tomatoes] if options[:tomatoes]
+      get '/', params
     end
 
     # Search for a movie by its title.
@@ -82,7 +86,6 @@ module OMDB
       # @return [Hash]
       def build_params(title, options)
         params = { t: title }
-        
         params[:y] = options[:year] if options[:year]
         params
       end
@@ -99,4 +102,4 @@ module OMDB
         convert_hash_keys(request.parsed_response)
       end
   end
-end
+end

data/lib/omdbapi/version.rb

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

data/omdbapi.gemspec

@@ -19,7 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_dependency 'httparty', '>= 0.13'
+  spec.add_development_dependency "rake", "~> 11.1"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.24"
+  spec.add_dependency 'httparty', '~> 0.13'
 end

data/spec/omdbapi/client_spec.rb

@@ -1,172 +1,220 @@
 require 'spec_helper'
 
 describe OMDB::Client do
-
   it 'should include HTTParty' do
-    OMDB::Client.should include(HTTParty)
+    expect(OMDB::Client).to include(HTTParty)
   end
 
   it 'should have the correct API endpoint' do
-    OMDB::Client.base_uri.should eq(OMDB::Default::API_ENDPOINT)
+    expect(OMDB::Client.base_uri).to eq(OMDB::Default::API_ENDPOINT)
   end
 
   describe 'methods' do
-
     describe 'title' do
       describe 'with a movie that exists' do
-        let(:title) { OMDB.title('Star Wars') }
+        before(:all) do
+          VCR.use_cassette('title/valid') do
+            @title = OMDB.title('Star Wars')
+          end
+        end
 
         it 'should return a hash of movie attributes' do
-          title.should be_instance_of Hash
+          expect(@title).to be_instance_of Hash
         end
 
         it 'should contain a title' do
-          title.title.should be_instance_of String
+          expect(@title.title).to be_instance_of String
         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)
+          VCR.use_cassette('title/year') do
+            title1 = OMDB.title('True Grit')
+            title2 = OMDB.title('True Grit', year: '1969')
+            expect(title1).not_to eq(title2)
+          end
         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)
+          VCR.use_cassette('title/plot') do
+            title1 = OMDB.title('Game of Thrones')
+            title2 = OMDB.title('Game of Thrones', plot: 'full')
+            expect(title1.plot).not_to eq(title2.plot)
+          end
         end
       end
 
       describe 'with the season and episode parameters' do
-        let(:title) { OMDB.title('True Detective', episode: 1, season: 1) }
-
         it 'should include season and episode in the response' do
-          title.season.should eq("1")
-          title.episode.should eq("1")
+          VCR.use_cassette('title/season_and_episode') do
+            title = OMDB.title('True Detective', episode: 1, season: 1)
+            expect(title.season).to eq('1')
+            expect(title.episode).to eq('1')
+          end
         end
       end
 
       describe 'with only the season parameter, missing the episode parameter' do
-        let(:title) { OMDB.title('True Detective', season: 1) }
-
-        it 'should not include season and episode in the response' do
-          expect { title.season }.to raise_error(NoMethodError)
-          expect { title.episode }.to raise_error(NoMethodError)
+        it 'should not include episode in the response' do
+          VCR.use_cassette('title/season') do
+            title = OMDB.title('True Detective', season: 1)
+            expect { title.episode }.to raise_error(NoMethodError)
+          end
         end
       end
 
       describe 'with only the episode parameter, missing the season parameter' do
-        let(:title) { OMDB.title('True Detective', episode: 1) }
-
         it 'should not include season and episode in the response' do
-          expect { title.season }.to raise_error(NoMethodError)
-          expect { title.episode }.to raise_error(NoMethodError)
+          VCR.use_cassette('title/episode') do
+            title = OMDB.title('True Detective', episode: 1)
+            expect { title.season }.to raise_error(NoMethodError)
+            expect { title.episode }.to raise_error(NoMethodError)
+          end
         end
       end
 
-      describe 'with a movie that doesn''t exist' do
-        let(:title) { OMDB.title('lsdfoweirjrpwef323423dsfkip') }
-        
+      describe "with a movie that doesn't exist" do
+        before(:all) do
+          VCR.use_cassette('title/nonexistent') do
+            @title = OMDB.title('lsdfoweirjrpwef323423dsfkip')
+          end
+        end
+
         it 'should return a hash' do
-          title.should be_instance_of Hash
+          expect(@title).to be_instance_of Hash
         end
 
         it 'should return a hash with a false response' do
-          title.response.should eq('False')
+          expect(@title.response).to eq('False')
         end
 
         it 'should return a hash with an error message' do
-          title.error.should be_instance_of String
+          expect(@title.error).to be_instance_of String
+        end
+      end
+
+      describe 'with the tomatoes option' do
+        before(:all) do
+          VCR.use_cassette('title/tomatoes') do
+            @title = OMDB.title('inception', :tomatoes => true)
+          end
+        end
+
+        it 'should contain tomato rating' do
+          expect(@title.tomato_rating).to be_instance_of String
+        end
+
+        it 'should contain tomato meter' do
+          expect(@title.tomato_meter).to be_instance_of String
+        end
+
+        it 'should contain tomato reviews' do
+          expect(@title.tomato_reviews).to be_instance_of String
         end
       end
     end
 
     describe 'id' do
-
       describe 'with a title that exists' do
-        let(:title) { OMDB.id('tt0411008') }
+        before(:all) do
+          VCR.use_cassette('id/existing') do
+            @title = OMDB.id('tt0411008')
+          end
+        end
 
         it 'should return a hash of movie attributes' do
-          title.should be_instance_of Hash
+          expect(@title).to be_instance_of Hash
         end
 
         it 'should contain a title' do
-          title.title.should be_instance_of String
+          expect(@title.title).to be_instance_of String
         end
       end
 
-      describe 'with a movie that doesn''t exist' do
-        let(:title) { OMDB.id('tt1231230123') }
-        
+      describe "with a movie that doesn't exist" do
+        before(:all) do
+          VCR.use_cassette('id/nonexistent') do
+            @title = OMDB.id('tt1231230123')
+          end
+        end
+
         it 'should return a hash' do
-          title.should be_instance_of Hash
+          expect(@title).to be_instance_of Hash
         end
 
         it 'should return a hash with a false response' do
-          title.response.should eq('False')
+          expect(@title.response).to eq('False')
         end
 
         it 'should return a hash with an error message' do
-          title.error.should be_instance_of String
+          expect(@title.error).to be_instance_of String
         end
       end
     end
 
     describe 'search' do
-
       describe 'with search results' do
-        let(:results) { OMDB.search('Star Wars') }
+        before(:all) do
+          VCR.use_cassette('search/results') do
+            @results = OMDB.search('Star Wars')
+          end
+        end
 
         it 'should return an array' do
-          results.should be_instance_of Array
+          expect(@results).to be_instance_of Array
         end
 
         it 'should return an array with hash contents' do
-          results[0].should be_instance_of Hash
+          expect(@results.first).to be_instance_of Hash
         end
       end
 
       describe 'with a single search result' do
-        let(:result) { OMDB.search('Star Wars: Episode IV - A New Hope') }
+        before(:all) do
+          VCR.use_cassette('search/result') do
+            @result = OMDB.search('Star Wars Episode IV A New Hope')
+          end
+        end
 
         it 'should return a hash of the title' do
-          result.should be_instance_of Hash
+          expect(@result).to be_instance_of Hash
         end
 
         it 'should have a title' do
-          result.title.should eq('Star Wars: Episode IV - A New Hope')
+          expect(@result.title).to eq('Star Wars: Episode IV - A New Hope')
         end
       end
 
       describe 'with no search results' do
-        let(:results) { OMDB.search('lsdfoweirjrpwef323423dsfkip') }
+        before(:all) do
+          VCR.use_cassette('search/empty') do
+            @results = OMDB.search('lsdfoweirjrpwef323423dsfkip')
+          end
+        end
 
         it 'should return a hash' do
-          results.should be_instance_of Hash
+          expect(@results).to be_instance_of Hash
         end
 
         it 'should return a hash with a false response' do
-          results.response.should eq('False')
+          expect(@results.response).to eq('False')
         end
 
         it 'should return a hash with an error message' do
-          results.error.should be_instance_of String
+          expect(@results.error).to 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'))
+          VCR.use_cassette('search/find') do
+            expect(OMDB.search('Star Wars')).to eq(OMDB.find('Star Wars'))
+          end
         end
       end
     end
-
   end
-
-end
+end

data/spec/omdbapi/default_spec.rb

@@ -1,19 +1,17 @@
 require 'spec_helper'
 
 describe OMDB::Default do
-
   describe 'Hash#method_missing' do
-    let(:hash) { { a: 'a', b: 'b', c: 'c' } } 
+    let(:hash) { { a: 'a', b: 'b', c: 'c' } }
 
     it 'should allow value access through dot notation' do
-      hash.a.should eq('a')
+      expect(hash.a).to eq('a')
     end
   end
 
   describe 'String#to_snake_case' do
     it 'should convert strings to snake case' do
-      "CamelCasedString".to_snake_case.should eq('camel_cased_string')
+      expect('CamelCasedString'.to_snake_case).to eq('camel_cased_string')
     end
   end
-
-end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,12 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper.rb"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 require 'omdbapi'
+require 'vcr'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 end
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/vcr'
+  config.hook_into :webmock
+end

data/spec/vcr/id/existing.yml

@@ -0,0 +1,73 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://omdbapi.com/?i=tt0411008
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 16 Apr 2016 17:33:40 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d86fa77388fd45e0f6873017c9fbf61b41460828020; expires=Sun, 16-Apr-17
+        17:33:40 GMT; path=/; domain=.omdbapi.com; HttpOnly
+      Cache-Control:
+      - public, max-age=3600
+      Expires:
+      - Sat, 16 Apr 2016 18:34:06 GMT
+      Last-Modified:
+      - Sat, 16 Apr 2016 17:34:06 GMT
+      Vary:
+      - "*"
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Access-Control-Allow-Origin:
+      - "*"
+      Server:
+      - cloudflare-nginx
+      Cf-Ray:
+      - 2949623630d616be-ARN
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJUaXRsZSI6Ikxvc3QiLCJZZWFyIjoiMjAwNOKAkzIwMTAiLCJSYXRlZCI6
+        IlRWLTE0IiwiUmVsZWFzZWQiOiIyMiBTZXAgMjAwNCIsIlJ1bnRpbWUiOiI0
+        NCBtaW4iLCJHZW5yZSI6IkFkdmVudHVyZSwgRHJhbWEsIEZhbnRhc3kiLCJE
+        aXJlY3RvciI6Ik4vQSIsIldyaXRlciI6IkouSi4gQWJyYW1zLCBKZWZmcmV5
+        IExpZWJlciwgRGFtb24gTGluZGVsb2YiLCJBY3RvcnMiOiJOYXZlZW4gQW5k
+        cmV3cywgTWF0dGhldyBGb3gsIEpvcmdlIEdhcmNpYSwgSm9zaCBIb2xsb3dh
+        eSIsIlBsb3QiOiJUaGUgc3Vydml2b3JzIG9mIGEgcGxhbmUgY3Jhc2ggYXJl
+        IGZvcmNlZCB0byB3b3JrIHRvZ2V0aGVyIGluIG9yZGVyIHRvIHN1cnZpdmUg
+        b24gYSBzZWVtaW5nbHkgZGVzZXJ0ZWQgdHJvcGljYWwgaXNsYW5kLiIsIkxh
+        bmd1YWdlIjoiRW5nbGlzaCwgUG9ydHVndWVzZSwgU3BhbmlzaCwgQXJhYmlj
+        LCBGcmVuY2gsIEtvcmVhbiwgR2VybWFuLCBMYXRpbiwgUnVzc2lhbiwgSmFw
+        YW5lc2UiLCJDb3VudHJ5IjoiVVNBIiwiQXdhcmRzIjoiV29uIDEgR29sZGVu
+        IEdsb2JlLiBBbm90aGVyIDg0IHdpbnMgJiAzMzYgbm9taW5hdGlvbnMuIiwi
+        UG9zdGVyIjoiaHR0cDovL2lhLm1lZGlhLWltZGIuY29tL2ltYWdlcy9NL01W
+        NUJNakEzTnpNeU16VTFNVjVCTWw1QmFuQm5Ya0Z0WlRjd05qYzFPRFV3TWdA
+        QC5fVjFfU1gzMDAuanBnIiwiTWV0YXNjb3JlIjoiTi9BIiwiaW1kYlJhdGlu
+        ZyI6IjguNSIsImltZGJWb3RlcyI6IjM2MywwODUiLCJpbWRiSUQiOiJ0dDA0
+        MTEwMDgiLCJUeXBlIjoic2VyaWVzIiwiUmVzcG9uc2UiOiJUcnVlIn0=
+    http_version: 
+  recorded_at: Sat, 16 Apr 2016 17:33:40 GMT
+recorded_with: VCR 3.0.1