rotten_tomatoes 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae29de64c08ecb7561820f761106f36b99ef903a
-  data.tar.gz: 53dc49a42a33695021e048f28330063a663e4ae0
+  metadata.gz: 1c39b412f038bae213e01616f01829c8e04d9ea0
+  data.tar.gz: be5dfb7fd5aaef132f784184a27e32cc1520bff9
 SHA512:
-  metadata.gz: 0dd28d8c41cd574cbb1f340e522d6eb7369c8252513e776673e40fc9c2ac5c0effb59c5c536a6d1e2e5455c94300106d22229071c625e795fb84bbbe266952f4
-  data.tar.gz: 0b8b6feadeb9c143e313b34f5d95a1efd307f4fe9cdfa8a274da50cfc7f25c4643b8309beae3668ab5aac471c1ccf2a1651e226d20bd9b1c0205aabe401cedbe
+  metadata.gz: 1616224a2ba22e31b50458748fee11c1a06953061973160db9030dd83b62f91ae4c42cc46fdaef0f4a118abb2e6bfa93ddc7b3a5c1e1eb2545b8660cebc9f2ad
+  data.tar.gz: 0ecab2045cded2b253d4f126b15de8423eb9d3df95065fe01e04fa4d3b3f19a100b2be425db76c85b89ba582a2fb90875d79c152b452cc8373438503fb37a333

data/README.md

@@ -2,9 +2,7 @@
 
 # Rotten Tomatoes
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rotten_tomatoes`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Welcome to the Rotten Tomatoes Gem, your unofficial wrapper for the complete Rotten Tomatoes v1.0 JSON API. Here, I work to provide developers with a full featured library letting them focus on the important part, their idea.
 
 ## Installation
 

data/lib/rotten_tomatoes/client.rb

@@ -7,11 +7,43 @@ module RottenTomatoes
     attr_accessor :client
     attr_reader :api_key
 
+    # == Client
+    # RottenTomatoes::Client class is used to interact with the v1.0 JSON API for Rotten Tomatoes.
+    #
+    # == Parameters
+    #
+    # +api_key+ - String
+    #
+    # == Returns
+    #
+    # +self+ - Object
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
     def initialize(api_key)
       @api_key = api_key
       @client = Hurley::Client.new 'http://api.rottentomatoes.com/api/public/v1.0'
+      self
     end
 
+    # == Argument Hash
+    # The argument_hash method is used to generate the hash which will be URL encoded when making the next request with the Rotten Tomatoes API.
+    #
+    # == Parameters
+    #
+    # +args+ - Hash - The original hash which was sent to the calling method.
+    # +symbols - Array - An array of symbols which you would like to send to the API.
+    #
+    # == Returns
+    #
+    # Void
+    #
+    # == Example
+    #
+    #    def method(args ={})
+    #      client.get(url, argument_hash(args, [:query, :page]))
+    #    end
     def argument_hash(args = {}, symbols = [])
       {}.tap do |hash|
         hash[:apikey] = @api_key
@@ -21,6 +53,22 @@ module RottenTomatoes
       end
     end
 
+    # == Request
+    # The request method is used to send the get request to the API
+    # and then will return the parsed body as a hash.
+    #
+    # == Parameters
+    #
+    # +args+ - Hash - The hash may, as all parameters except :url are optional, contain :url containing the API endpoint which will be contacted, :args which represent the arguments of the calling method, and :symbols which are the symbols which may be sent with the request. Examples include :page, :limit, :query.
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    client.request url: 'movies.json', args: args, symbols: [:q, :page_limit, :page]
     def request(args = {})
       response = @client.get(args[:url],
                              argument_hash(args[:args] || {},
@@ -28,80 +76,400 @@ module RottenTomatoes
       JSON.parse(response.body)
     end
 
+    # == Movies Search
+    # The movies_search method is used to do plain text searches allowing you to find your favorite movies.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Movies_Search
+    #
+    # == Parameters
+    #
+    # +args+ - Hash - May contain the following keys:
+    #   * :q - The plain text search query to search for a movie. Default value is nil.
+    #   * :page_limit - The amount of movie search results to show per page. Default value is 30.
+    #   * :page - The selected page of movie search results. Default value is 1.
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response1 = client.movies_search q: 'Fight Club', page_limit: 100, page: 1
+    #    response2 = client.movies_search
+    #    response3 = client.movies_search q: 'Along Came Polly'
     def movies_search(args = {})
       request url: 'movies.json', args: args, symbols: [:q, :page_limit, :page]
     end
 
+    # == Lists Directory
+    # The lists_directory method is used to retrieve the top level lists available in the API.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Lists_Directory
+    #
+    # == Parameters
+    #
+    # None
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash with the following example response:
+    #
+    # links: {
+    #   movies: 'http://api.rottentomatoes.com/api/public/v1.0/lists/movies.json',
+    #   dvds: 'http://api.rottentomatoes.com/api/public/v1.0/lists/dvds.json'
+    # }
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response = client.lists_directory
     def lists_directory
       request url: 'lists.json'
     end
 
+    # == Movie Lists Directory
+    # The movie_lists_directory method is used to retrieve the movie lists available.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Lists_Directory
+    #
+    # == Parameters
+    #
+    # None
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response = client.movie_lists_directory
     def movie_lists_directory
       request url: 'lists/movies.json'
     end
 
+    # == DVD Lists Directory
+    # The dvd_lists_directory method is used to retrieve the dvd lists available.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/DVD_Lists_Directory
+    #
+    # == Parameters
+    #
+    # None
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response = client.dvd_lists_directory
     def dvd_lists_directory
       request url: 'lists/dvds.json'
     end
 
+    # == Box Office Movies
+    # Displays Top Box Office Earning Movies, Sorted by Most Recent Gross Ticket Sales
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Box_Office_Movies
+    #
+    # == Parameters
+    #
+    # +args+ - Hash - May contain the following keys:
+    #   * :limit - Limits the number of box office movies returned. Default value is 10.
+    #   * :country - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response1 = client.box_office_movies limit: 50, country: 'us'
+    #    response2 = client.box_office_movies
     def box_office_movies(args = {})
       request url: 'lists/movies/box_office.json',
               args: args, symbols: [:limit, :country]
     end
 
+    # == In Theater Movies
+    # Retrieves movies currently in theaters.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/In_Theaters_Movies
+    #
+    # == Parameters
+    #
+    # +args+ - Hash - May contain the following keys:
+    #   * :page_limit - The amount of movies in theaters to show per page. Default value is 16.
+    #   * :page - The selected page of in theaters movies. Default value is 1.
+    #   * :country - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response1 = client.in_theater_movies page_limit: 20, page: 3, country: 'us'
+    #    response2 = client.in_theater_movies
     def in_theater_movies(args = {})
       request url: 'lists/movies/in_theaters.json',
               args: args, symbols: [:page_limit, :page, :country]
     end
 
+    # == Opening Movies
+    # Retrieves movies current opening movies.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Opening_Movies
+    #
+    # == Parameters
+    #
+    # +args+ - Hash - May contain the following keys:
+    #   * :limit - Limits the number of opening movies returned. Default value is 16.
+    #   * :country - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response1 = client.opening_movies limit: 20, country: 'us'
+    #    response2 = client.opening_movies
     def opening_movies(args = {})
       request url: 'lists/movies/opening.json',
               args: args, symbols: [:limit, :country]
     end
 
+    # == Upcoming Movies
+    # Retrieves movies current opening movies.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Upcoming_Movies
+    #
+    # == Parameters
+    #
+    # +args+ - Hash - May contain the following keys:
+    #   * :page_limit - The amount of upcoming movies to show per page. Default value is 16.
+    #   * :page - The selected page of upcoming movies. Default value is 1.
+    #   * :country - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response1 = client.upcoming_movies page_limit: 20, page: 1, country: 'us'
+    #    response2 = client.upcoming_movies
     def upcoming_movies(args = {})
       request url: 'lists/movies/upcoming.json',
               args: args, symbols: [:page_limit, :page, :country]
     end
 
+    # == Top Rentals
+    # Retrieves the current top dvd rentals.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Top_Rentals
+    #
+    # == Parameters
+    #
+    # +args+ - Hash - May contain the following keys:
+    #   * :limit - Limits the number of top rentals returned. Default value is 10.
+    #   * :country - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response1 = client.top_rentals limit: 20, country: 'us'
+    #    response2 = client.top_rentals
     def top_rentals(args = {})
       request url: 'lists/dvds/top_rentals.json',
               args: args, symbols: [:limit, :country]
     end
 
+    # == Current Release DVDs
+    # Retrieves current release dvds. Results are paginated if they go past the specified page limit.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Current_Release_DVDs
+    #
+    # == Parameters
+    #
+    # +args+ - Hash - May contain the following keys:
+    #   * :page_limit - The amount of new release dvds to show per page. Default value is 16.
+    #   * :page - The selected page of current DVD releases. Default value is 1.
+    #   * :country - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response1 = client.current_dvd_releases page_limit: 20, page: 3, country: 'us'
+    #    response2 = client.current_dvd_releases
     def current_dvd_releases(args = {})
       request url: 'lists/dvds/current_releases.json',
               args: args, symbols: [:page_limit, :page, :country]
     end
 
+    # == New Release DVDs
+    # Retrieves new release dvds. Results are paginated if they go past the specified page limit.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/New_Release_DVDs
+    #
+    # == Parameters
+    #
+    # +args+ - Hash - May contain the following keys:
+    #   * :page_limit - The amount of new release dvds to show per page. Default value is 16.
+    #   * :page - The selected page of new release DVDs. Default value is 1.
+    #   * :country - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response1 = client.new_dvd_releases page_limit: 20, page: 3, country: 'us'
+    #    response2 = client.new_dvd_releases
     def new_dvd_releases(args = {})
       request url: 'lists/dvds/new_releases.json',
               args: args, symbols: [:page_limit, :page, :country]
     end
 
+    # == Upcoming DVDs
+    # Retrieves upcoming dvds. Results are paginated if they go past the specified page limit.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Upcoming_DVDs
+    #
+    # == Parameters
+    #
+    # +args+ - Hash - May contain the following keys:
+    #   * :page_limit - The amount of new release dvds to show per page. Default value is 16.
+    #   * :page - The selected page of new release DVDs. Default value is 1.
+    #   * :country - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response1 = client.upcoming_dvds page_limit: 20, page: 3, country: 'us'
+    #    response2 = client.upcoming_dvds
     def upcoming_dvds(args = {})
       request url: 'lists/dvds/upcoming.json',
               args: args, symbols: [:page_limit, :page, :country]
     end
 
+    # == Movie Info
+    # Detailed information on a specific movie specified by ID. You can use the movies_search method or peruse the lists of movies/dvds to get the urls to movies.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Info
+    #
+    # == Parameters
+    #
+    # +movie_id+ - Int / String - Example: 770672122
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response = client.movie_info 770672122
     def movie_info(movie_id, args = {})
       request url: "movies/#{movie_id}.json", args: args
     end
 
+    # == Movie Cast
+    # Pulls the complete movie cast for a movie.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Cast
+    #
+    # == Parameters
+    #
+    # +movie_id+ - Int / String - Example: 770672122
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response = client.movie_cast 770672122
     def movie_cast(movie_id, args = {})
       request url: "movies/#{movie_id}/cast.json", args: args
     end
 
+    # == Movie Reviews
+    # Retrieves the reviews for a movie. Results are paginated if they go past the specified page limit.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Reviews
+    #
+    # == Parameters
+    #
+    # +movie_id+ - Int / String - Example: 770672122
+    # +args+ - Hash - May contain the following keys:
+    #   * :review_type - 3 different review types are possible: "all", "top_critic", and "dvd". "top_critic" shows all the Rotten Tomatoes designated top critics. "dvd" pulls the reviews given on the DVD of the movie. "all" as the name implies retrieves all reviews. Default value is "top_critic".
+    #   * :page_limit - The number of reviews to show per page. Default value is 20.
+    #   * :page - The selected page of reviews. Default value is 1.
+    #   * :country - Provides localized data for the selected country (ISO 3166-1 alpha-2) if available. Otherwise, returns US data. Default value is 'us'
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response = client.movie_reviews 770672122, { review_type: 'all', page_limit: 20, page: 1, country: 'us' }
     def movie_reviews(movie_id, args = {})
       request url: "movies/#{movie_id}/reviews.json",
               args: args, symbols: [:review_type, :page_limit, :page, :country]
     end
 
+    # == Movie Similar
+    # Shows similar movies for a movie.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Similar
+    #
+    # == Parameters
+    #
+    # +movie_id+ - Int / String - Example: 770672122
+    # +args+ - Hash - May contain the following keys:
+    #   * :limit - Limit the number of similar movies to show.
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response = client.similar_movies 770672122, limit: 5
     def similar_movies(movie_id, args = {})
       request url: "movies/#{movie_id}/similar.json",
               args: args, symbols: [:limit]
     end
 
+    # == Movie Alias
+    # Provides a movie lookup by an ID from a different vendor. Only supports imdb lookup at this time. WARNING: This feature is Beta quality. Accuracy of the lookup is not promised. If you see inaccuracies, please report them in the Rotten Tomatoes forums.
+    # http://developer.rottentomatoes.com/docs/read/json/v10/Movie_Alias
+    #
+    # == Parameters
+    #
+    # +args+ - Hash - May contain the following keys:
+    #   * :type - alias type you want to look up - only imdb is supported at this time.
+    #   * :id - The ID you want to look up
+    #
+    # == Returns
+    #
+    # Hash - Response body after being parsed from JSON will be returned as a Hash.
+    #
+    # == Example
+    #
+    #    client = RottenTomatoes::Client.new 'myAPIkey'
+    #    response = client.movie_alias id: 770672122, type: 'imdb'
     def movie_alias(args = {})
       request url: 'movie_alias.json', args: args, symbols: [:type, :id]
     end

data/lib/rotten_tomatoes/version.rb

@@ -1,3 +1,3 @@
 module RottenTomatoes
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rotten_tomatoes
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin Kirsche
@@ -14,70 +14,70 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.6'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
   name: hurley
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
 description: Unofficial wrapper for the complete Rotten Tomatoes v1.0 JSON API. Here,
@@ -89,8 +89,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -110,19 +110,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Unofficial Rotten Tomatoes v1 API Wrapper.
 test_files: []
-has_rdoc: