omdbapi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2de7faaa8d9ad133af6f5dfc803173dd742bfe5
-  data.tar.gz: cb36660f877d024b1c94860af7938ed4ebbde38a
+  metadata.gz: 5fbc5708989f9d4a0c3238cba60519c45c660db3
+  data.tar.gz: 5ff47e43fe3546e7cc99861ae6596ffcf78c3a2b
 SHA512:
-  metadata.gz: 288e3a4d6ba500124e1ae7d1ed056d7a93ef7df41365298b2579d184344479840223a41208f96a7a0677b668801c1e3e4a1e7d66592b1eb7f0670d66e78bceaf
-  data.tar.gz: 21509ad0bfee941208fd4acdbdff12a246a0d4f811076e9f4e90a7a387c66eeb8fa3456521c50d24f13d36fd49ce06f78837871a258651e315a588f4f7562c0f
+  metadata.gz: 817dcd802df11328e12d0970d74424fc19b33bb8f1a10d61b2927eb79b70253035568a81e23cbe8450d4aef54eecde63efbc2be8d899009aabc36e79a3f663d8
+  data.tar.gz: 6568db143c86f0e038a5209882060063d49e151eb4c78e3f6e4a69cc44fc9b7cd7d72345e2e0942c6aad821682db5f4efa5568d7f6f579bce4dbcf16f17e8fe8

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -4,6 +4,12 @@ This gem is (will be) a simple and easy to use wrapper for the [omdbapi.com](htt
 
 ## Installation
 
+### Requirements
+
+* Ruby v1.9.3 or later
+
+### Installing
+
 You can install the gem by adding it your application's Gemfile:
 
 ```ruby
@@ -49,12 +55,12 @@ This function will return a Hash with the following information about the title:
 
 ### Search
 
-You can search for a title by using the search method:
+You can find a title by using the find method:
 
 ```ruby
-search = OMDB.search('Star Wars')
+results = OMDB.find('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"}]
-search.each { |result| puts result.title }
+results.each { |r| puts r.title }
 # etc...
 ```
 
@@ -64,6 +70,19 @@ This method returns an Array of search results. Each search result is a Hash wit
 :title, :year, :imdb_id, :type
 ```
 
+### Find by 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...
+```
+
+This method will return a Hash of the title's properties, exactly as the title method.
 
 ## Contributing
 

data/lib/omdbapi/client.rb

@@ -4,12 +4,17 @@ module OMDB
     include HTTParty
     base_uri OMDB::Default::API_ENDPOINT
 
-    def title(title)
+    def title(title, year=nil)
       get '/', { t: title }
     end
 
-    def search(query)
-      (get '/', { s: query }).search
+    def id(imdb_id) 
+      return get '/', { i: imdb_id }
+    end
+
+    def find(title)
+      results = get '/', { s: title }
+      results[:search] ? results[:search] : results
     end
 
     private

data/lib/omdbapi/version.rb

@@ -1,3 +1,3 @@
 module OMDB
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 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/omdb"
+  spec.homepage      = "https://github.com/caseyscarborough/omdbapi"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -20,5 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
   spec.add_dependency 'httparty', '0.11.0'
 end

data/spec/omdbapi/client_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe OMDB::Client do
+
+  it 'should include HTTParty' do
+    OMDB::Client.should include(HTTParty)
+  end
+
+  it 'should have the correct API endpoint' do
+    OMDB::Client.base_uri.should 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') }
+
+        it 'should return a hash of movie attributes' do
+          title.should be_instance_of Hash
+        end
+
+        it 'should contain a title' do
+          title.title.should be_instance_of String
+        end
+      end
+
+      describe 'with a movie that doesn''t exist' do
+        let(:title) { OMDB.title('lsdfoweirjrpwef323423dsfkip') }
+        
+        it 'should return a hash' do
+          title.should be_instance_of Hash
+        end
+
+        it 'should return a hash with a false response' do
+          title.response.should eq('False')
+        end
+
+        it 'should return a hash with an error message' do
+          title.error.should be_instance_of String
+        end
+      end
+    end
+
+    describe 'id' do
+
+      describe 'with a title that exists' do
+        let(:title) { OMDB.id('tt0411008') }
+
+        it 'should return a hash of movie attributes' do
+          title.should be_instance_of Hash
+        end
+
+        it 'should contain a title' do
+          title.title.should be_instance_of String
+        end
+      end
+
+      describe 'with a movie that doesn''t exist' do
+        let(:title) { OMDB.id('tt1231230123') }
+        
+        it 'should return a hash' do
+          title.should be_instance_of Hash
+        end
+
+        it 'should return a hash with a false response' do
+          title.response.should eq('False')
+        end
+
+        it 'should return a hash with an error message' do
+          title.error.should be_instance_of String
+        end
+      end
+    end
+
+    describe 'find' do
+
+      describe 'with search results' do
+        let(:results) { OMDB.find('Star Wars') }
+
+        it 'should return an array' do
+          results.should be_instance_of Array
+        end
+
+        it 'should return an array with hash contents' do
+          results[0].should be_instance_of Hash
+        end
+      end
+
+      describe 'with no search results' do
+        let(:results) { OMDB.find('lsdfoweirjrpwef323423dsfkip') }
+
+        it 'should return a hash' do
+          results.should be_instance_of Hash
+        end
+
+        it 'should return a hash with a false response' do
+          results.response.should eq('False')
+        end
+
+        it 'should return a hash with an error message' do
+          results.error.should be_instance_of String
+        end
+      end
+    end
+
+  end
+
+end

data/spec/omdbapi/default_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe OMDB::Default do
+
+  describe 'Hash#method_missing' do
+    let(:hash) { { a: 'a', b: 'b', c: 'c' } } 
+
+    it 'should allow value access through dot notation' do
+      hash.a.should 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')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# 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'
+
+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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omdbapi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Casey Scarborough
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -60,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -69,7 +84,10 @@ files:
 - lib/omdbapi/default.rb
 - lib/omdbapi/version.rb
 - omdbapi.gemspec
-homepage: https://github.com/caseyscarborough/omdb
+- spec/omdbapi/client_spec.rb
+- spec/omdbapi/default_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/caseyscarborough/omdbapi
 licenses:
 - MIT
 metadata: {}
@@ -93,4 +111,7 @@ rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: This gem provides easy access for information retrieval from omdbapi.com.
-test_files: []
+test_files:
+- spec/omdbapi/client_spec.rb
+- spec/omdbapi/default_spec.rb
+- spec/spec_helper.rb