omdbapi 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6704063f0d91a05cca9a0f56da3a18314f039d35
-  data.tar.gz: 35b8b17829998315a22fac3a9cb1c9018725cc15
+  metadata.gz: b2de7faaa8d9ad133af6f5dfc803173dd742bfe5
+  data.tar.gz: cb36660f877d024b1c94860af7938ed4ebbde38a
 SHA512:
-  metadata.gz: dda2963edf61d203d74f2db52e63f7f9d8cac15b8175a5c38947355a05fcb6b4db853ec69f9b8d3b2c2fafbb81e4da6c5379a18d13b5495d2b241594d039bb59
-  data.tar.gz: db67b89dd8794ca4d193cac1045f3306d19a6073261cbc4600e4789397a18c2610521f9ffd2c12baf6e9ce2dd701bc139b8727a68883f58562cbde67171afcd5
+  metadata.gz: 288e3a4d6ba500124e1ae7d1ed056d7a93ef7df41365298b2579d184344479840223a41208f96a7a0677b668801c1e3e4a1e7d66592b1eb7f0670d66e78bceaf
+  data.tar.gz: 21509ad0bfee941208fd4acdbdff12a246a0d4f811076e9f4e90a7a387c66eeb8fa3456521c50d24f13d36fd49ce06f78837871a258651e315a588f4f7562c0f

data/README.md

@@ -1,24 +1,69 @@
-# Omdbapi
+# omdbapi
 
-TODO: Write a gem description
+This gem is (will be) a simple and easy to use wrapper for the [omdbapi.com](http://omdbapi.com/) API.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+You can install the gem by adding it your application's Gemfile:
 
-    gem 'omdbapi'
+```ruby
+gem 'omdbapi'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
-Or install it yourself as:
+Or you can install it manually by issuing the following command:
 
-    $ gem install omdbapi
+```bash
+$ gem install omdbapi
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'omdbapi'
+```
+### Title
+
+You can get a movie or TV show's information in a Hash by using the title method, shown below:
+
+```ruby
+game_of_thrones = OMDB.title('Game of Thrones')
+# => {:title=>"Game of Thrones", :year=>"2011", :rated=>"TV-MA", :released=>"17 Apr 2011", :runtime=>"1 h", :genre=>"Adventure, Drama, Fantasy", :director=>"N/A", :writer=>"David Benioff, D.B. Weiss", :actors=>"Peter Dinklage, Lena Headey, Maisie Williams, Emilia Clarke", :plot=>"Seven noble families fight for control of the mythical land of Westeros.", :poster=>"http://ia.media-imdb.com/images/M/MV5BNTY2MzAxNzM0Ml5BMl5BanBnXkFtZTcwNDA0MDkxOQ@@._V1_SX300.jpg", :imdb_rating=>"9.4", :imdb_votes=>"382,638", :imdb_id=>"tt0944947", :type=>"series", :response=>"True"} 
+game_of_thrones.title # => "Game of Thrones"
+game_of_thrones.year  # => "2011"
+game_of_thrones.rated # => "TV-MA"
+# etc...
+```
+
+This function will return a Hash with the following information about the title:
+
+```ruby
+:title, :year, :rated, :released, :runtime, :genre, :director, :writer, 
+:actors, :plot, :poster, :imdb_rating, :imdb_votes, :imdb_id, :type
+```
+
+### Search
+
+You can search for a title by using the search method:
+
+```ruby
+search = 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"}]
+search.each { |result| puts result.title }
+# etc...
+```
+
+This method returns an Array of search results. Each search result is a Hash with the following information about the result:
+
+```ruby
+:title, :year, :imdb_id, :type
+```
+
 
 ## Contributing
 

data/lib/omdbapi/client.rb

@@ -0,0 +1,33 @@
+module OMDB
+  class Client
+
+    include HTTParty
+    base_uri OMDB::Default::API_ENDPOINT
+
+    def title(title)
+      get '/', { t: title }
+    end
+
+    def search(query)
+      (get '/', { s: query }).search
+    end
+
+    private
+
+      def convert_hash_keys(value)
+        case value
+        when Array
+          value.map { |v| convert_hash_keys(v) }
+        when Hash
+          Hash[value.map { |k, v| [k.to_snake_case.to_sym, convert_hash_keys(v)] }]
+        else
+          value
+        end
+      end
+
+      def get(url, params={})
+        request = self.class.get '/', query: params
+        convert_hash_keys(JSON.parse(request.parsed_response))
+      end
+  end
+end

data/lib/omdbapi/default.rb

@@ -0,0 +1,31 @@
+module OMDB
+  module Default
+
+    API_ENDPOINT = 'http://omdbapi.com'
+
+  end
+end
+
+# Monkey patch the Hash class to allow accessing hashes using
+# dot notation.
+# For instance: hash['key'] => hash.key
+class ::Hash
+  def method_missing(name)
+    return self[name] if key? name
+    self.each { |k,v| return v if k.to_s.to_sym == name }
+    super.method_missing name
+  end
+end
+
+# Monkey patch the string class to convert strings from
+# camel case to snake case. Is this too much monkey patching?
+# For instance: "CamelCasedString".to_snake_case => "camel_cased_string"
+class String
+  def to_snake_case
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end

data/lib/omdbapi/version.rb

@@ -1,3 +1,3 @@
 module OMDB
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/omdbapi.rb

@@ -1,5 +1,23 @@
-require "omdbapi/version"
+require 'httparty'
+require 'json'
+require 'omdbapi/version'
+require 'omdbapi/default'
+require 'omdbapi/client'
 
 module OMDB
-  # Your code goes here...
+
+  class << self
+
+    def client
+      @client = Client.new unless @client
+      @client
+    end
+
+    private
+
+    def method_missing(name, *args, &block)
+      client.send(name, *args, &block)
+    end
+
+  end
 end

data/omdbapi.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Casey Scarborough"]
   spec.email         = ["caseyscarborough@gmail.com"]
   spec.description   = '[In Progress] A wrapper for the omdbapi.com movie API.'
-  spec.summary       = ''
+  spec.summary       = 'This gem provides easy access for information retrieval from omdbapi.com.'
   spec.homepage      = "https://github.com/caseyscarborough/omdb"
   spec.license       = "MIT"
 
@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_dependency 'httparty', '0.11.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omdbapi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Casey Scarborough
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 description: '[In Progress] A wrapper for the omdbapi.com movie API.'
 email:
 - caseyscarborough@gmail.com
@@ -51,6 +65,8 @@ files:
 - README.md
 - Rakefile
 - lib/omdbapi.rb
+- lib/omdbapi/client.rb
+- lib/omdbapi/default.rb
 - lib/omdbapi/version.rb
 - omdbapi.gemspec
 homepage: https://github.com/caseyscarborough/omdb
@@ -76,5 +92,5 @@ rubyforge_project:
 rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
-summary: ''
+summary: This gem provides easy access for information retrieval from omdbapi.com.
 test_files: []