omdbapi 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fbc5708989f9d4a0c3238cba60519c45c660db3
-  data.tar.gz: 5ff47e43fe3546e7cc99861ae6596ffcf78c3a2b
+  metadata.gz: c26bd37809d517fee3add5282bd1c0010e28cf66
+  data.tar.gz: a060eb969c24d18b1ea70884d8d9fa83e67be255
 SHA512:
-  metadata.gz: 817dcd802df11328e12d0970d74424fc19b33bb8f1a10d61b2927eb79b70253035568a81e23cbe8450d4aef54eecde63efbc2be8d899009aabc36e79a3f663d8
-  data.tar.gz: 6568db143c86f0e038a5209882060063d49e151eb4c78e3f6e4a69cc44fc9b7cd7d72345e2e0942c6aad821682db5f4efa5568d7f6f579bce4dbcf16f17e8fe8
+  metadata.gz: 876544a128f6edb7170d7e141dffff71a500ae2b108ec4376cbf0108827b883cf773fcab3aad69f3cad5d1716c60420c4f7d4fb8915aa442bfc182aea4e28269
+  data.tar.gz: db4110cbb81529cc03214376bc11039861b98016f33c6efbd1bbfd2c74588f9eb4b984fa62b7d8a38db05a72f09b503ca3146534f085f60962171a7185dd9814

data/lib/omdbapi.rb

@@ -4,10 +4,14 @@ require 'omdbapi/version'
 require 'omdbapi/default'
 require 'omdbapi/client'
 
+# Ruby wrapper for omdbapi.com API.
 module OMDB
 
   class << self
 
+    # API client for making calls to the omdbapi API.
+    #
+    # return [OMDB::Client] API Wrapper
     def client
       @client = Client.new unless @client
       @client
@@ -15,9 +19,9 @@ module OMDB
 
     private
 
-    def method_missing(name, *args, &block)
-      client.send(name, *args, &block)
-    end
+      def method_missing(name, *args, &block)
+        client.send(name, *args, &block)
+      end
 
   end
 end

data/lib/omdbapi/client.rb

@@ -1,17 +1,40 @@
 module OMDB
+
+  # Client for handling requests to the omdbapi.com API.
+  #
+  # @see http://omdbapi.com
   class Client
 
     include HTTParty
     base_uri OMDB::Default::API_ENDPOINT
 
+    # Retrieves a movie or show based on its title.
+    #
+    # @param title [String] The title of the movie or show.
+    # @return [Hash]
+    # @example
+    #   OMDB.title('Game of Thrones')
     def title(title, year=nil)
       get '/', { t: title }
     end
 
+
+    # Retrieves a movie or show based on its IMDb ID.
+    #
+    # @param imdb_id [String] The IMDb ID of the movie or show.
+    # @return [Hash]
+    # @example
+    #   OMDB.id('tt0944947')
     def id(imdb_id) 
       return get '/', { i: imdb_id }
     end
 
+    # Find a movie by its title.
+    #
+    # @param title [String] The title of the movie or show to find.
+    # @return [Array, Hash]
+    # @example
+    #   OMDB.find('Star Wars')
     def find(title)
       results = get '/', { s: title }
       results[:search] ? results[:search] : results
@@ -19,6 +42,10 @@ module OMDB
 
     private
 
+      # Performs a method on all hash keys.
+      #
+      # @param value [Array, Hash, Object]
+      # @return [Array, Hash, Object]
       def convert_hash_keys(value)
         case value
         when Array
@@ -30,6 +57,13 @@ module OMDB
         end
       end
 
+      # Performs a get request.
+      #
+      # @param url [String] The url to perform the get request to.
+      # @param params [Hash] The parameters to pass in the query string.
+      # @return [Hash] The response from the get request.
+      # @example
+      #   get '/users', { username: 'caseyscarborough' }
       def get(url, params={})
         request = self.class.get '/', query: params
         convert_hash_keys(JSON.parse(request.parsed_response))

data/lib/omdbapi/default.rb

@@ -1,15 +1,21 @@
 module OMDB
+
+  # Default configuration options for OMDB.
   module Default
 
+    # Default API endpoint
     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
+# Reopen the Hash class to add method.
 class ::Hash
+
+  # Allow accessing hashes via dot notation.
+  #
+  # @param name [String] The method name.
+  # @return [Object]
   def method_missing(name)
     return self[name] if key? name
     self.each { |k,v| return v if k.to_s.to_sym == name }
@@ -17,10 +23,14 @@ class ::Hash
   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"
+# Reopen the String class to add to_snake_case method.
 class String
+
+  # Convert string to snake case from camel case.
+  #
+  # @return [String]
+  # @example
+  #   "CamelCasedString".to_snake_case # => "camel_cased_string"
   def to_snake_case
     self.gsub(/::/, '/').
     gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').

data/lib/omdbapi/version.rb

@@ -1,3 +1,6 @@
 module OMDB
-  VERSION = "0.1.1"
+  # OMDB current version
+  #
+  # @return [String]
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omdbapi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Casey Scarborough