tmdb-api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 822a6f146cbfddcbe6007e076c8cdd4be137514d
-  data.tar.gz: 1b6c94c5562335ba4d604306c61d2c0ec205ff55
+  metadata.gz: c76aa958ad9a98caf296205a2502e1e1c2ad5fad
+  data.tar.gz: 89d617732b3e977403147bc352e085c9ca312e4d
 SHA512:
-  metadata.gz: 950acc07d687cf84826b5cf4f71156ecef0431912645e4e660c0daea875762070e00981b034bde80d7d7d855805888003090b878fc0027ec54619c04b3e65180
-  data.tar.gz: c597a1d67a25cfc1cf9c252a06a536cf82973a0cd95cc48ed6af6aca7b2fbe457a40ea2941c44c8a5b6f849588e493baa8b3e815d039c4c6d793ed442848d4f4
+  metadata.gz: cc125c9dcbf62d451fdf3299a5596da0d263ccd4e862cc81a4aefb1c66c2ee526544141ed07be182de0a1139ae5389c751f9b7a53ac24a9a73fb5d84a9f8af9d
+  data.tar.gz: ae14ee8e385273f5ac9a90854e23870867eeb060251ae8b07d2bd1caea927ee46666a8d6aa379235c2c07e5dff0955d73570f1b7208d39f0e473a3b324f53c5d

data/README.md

@@ -1,10 +1,8 @@
-# The Movie Database API v3
+# The Movie Database API
 
-Ruby wrapper for the The Movie Database API.
+A simple Ruby wrapper for the The Movie Database API v3.
 
-This wrapper uses the last version of TMDb API.
-
-More info about the API you can see here: [http://docs.themoviedb.apiary.io/](http://docs.themoviedb.apiary.io).
+About the TMDb API documentation and everything else you can se here: [http://docs.themoviedb.apiary.io/](http://docs.themoviedb.apiary.io).
 
 ## Installation
 
@@ -14,23 +12,24 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
     $ gem install tmdb
 
-## Usage
 
-### API Key
+## API Key
 First of all, you need set your API Key provided by TMDb.
 
 ```ruby
 TMDb.api_key = '56565958363476674e5e63643c787867'
 ```
 
-### Find a movie
-Get the basic movie information for a specific movie ID.
+## Usage
+
+### Find a movie by id
+Get the basic movie information for a specific movie id.
 
 ```ruby
 TMDB::Movie.find(24)
@@ -40,7 +39,7 @@ TMDB::Movie.find(603, language: 'pt')
 # => #<TMDb::Movie:0x007f99 @id=603, @title="The Matrix", @imdb_id="tt0133093" ... >
 ```
 
-### Search movie
+### Search movies
 Search for movies by title.
 
 ```ruby
@@ -52,16 +51,14 @@ TMDb::Movie.search('Forrest')
 TMDb::Movie.search('wall e', year: 2003)
 # => [#<TMDb::Movie:0x007f92 @id=10681, @original_title="WALL·E", ...>]
 ```
-You can filter the serch with the following options: _page_, _language_,
-_include_adult_, and _year_.
+You also have another options that you can use to filter the search: `:page`,
+`:language`, `:include_adult` and `:year`.
 
 ### Alternative titles
-Get the alternative titles for a specific movie ID.
+Get the alternative titles for a specific movie id.
 
 ```ruby
-movie = TMDB::Movie.find(598)
-
-movie.alternative_titles
+TMDB::Movie.alternative_titles(598)
 # => [{"iso_3166_1"=>"RU", "title"=>"Город бога"},
 # {"iso_3166_1"=>"IT", "title"=>"City of God - La città di Dio"},
 # {"iso_3166_1"=>"BR", "title"=>"Cidade de Deus"},
@@ -77,10 +74,10 @@ movie.alternative_titles(country: 'br')
 ```
 
 ### Images
-Get the images (posters and backdrops) for a specific movie ID.
+Get the images (posters and backdrops) for a specific movie id.
 
 ```ruby
-TMDb::Movie.find(598).images
+TMDb::Movie.images(598)
 # => {"id"=>598,
 #     "backdrops"=> [
 #       {
@@ -106,7 +103,63 @@ TMDb::Movie.find(598).images
 #       }
 #     ]}
 
-TMDb::Movie.find(598).images(language: 'pt')
+TMDb::Movie.images(598, language: 'pt')
+```
+
+### Movie keywords
+
+Get the plot keywords for a specific movie id.
+
+```ruby
+TMDb::Movie.keywords(68721)
+# => [
+#      {"id"=>2651, "name"=>"nanotechnology"},
+#      {"id"=>9715, "name"=>"superhero"},
+#      {"id"=>180547, "name"=>"marvel cinematic universe"},
+#      {"id"=>156792, "name"=>"3d"},
+#      {"id"=>156395, "name"=>"imax"},
+#      {"id"=>179430, "name"=>"aftercreditsstinger"},
+#      {"id"=>10836, "name"=>"third part"}
+#    ]
+```
+
+### Movie releases
+
+Get the release date by country for a specific movie id.
+
+```ruby
+TMDb::Movie.releases(68721)
+# => [
+#      {"iso_3166_1"=>"US", "certification"=>"PG-13", "release_date"=>"2013-05-03"},
+#      {"iso_3166_1"=>"DE", "certification"=>"12", "release_date"=>"2013-04-30"},
+#      {"iso_3166_1"=>"FR", "certification"=>"", "release_date"=>"2013-04-24"},
+#      {"iso_3166_1"=>"BG", "certification"=>"C", "release_date"=>"2013-04-26"},
+#      {"iso_3166_1"=>"NL", "certification"=>"", "release_date"=>"2013-04-24"},
+#      {"iso_3166_1"=>"NO", "certification"=>"", "release_date"=>"2013-04-26"},
+#      ...,
+#    ]
+```
+
+### Upcoming movies
+
+Get the list of upcoming movies. This list refreshes every day.
+The maximum number of items this list will include is 100.
+
+```ruby
+TMDb::Movie.upcoming
+# => [
+#      #<TMDb::Movie:0x007fefa4202a10
+#       @adult=false,
+#       @backdrop_path="/rwibG3yurWQvpjut54nbeiSGhVt.jpg",
+#       @id=157375,
+#       @original_title="The Lifeguard",
+#       @popularity=8.708121262,
+#       @poster_path="/xoX6C3mLynwSNRij2tyDT5eVmoc.jpg",
+#       @release_date="2013-08-30",
+#       @title="The Lifeguard",
+#       @vote_average=5.5,
+#       @vote_count=3>
+#    ]
 ```
 
 ### Movie object

data/lib/{tmdb.rb → tmdb-api.rb}

@@ -1,11 +1,12 @@
 require "httparty"
 require "json"
 
-require "tmdb/fetcher"
-require "tmdb/searchable"
-require "tmdb/movie"
-require "tmdb/changes"
-require "tmdb/version"
+require "tmdb-api/httparty"
+require "tmdb-api/base"
+require "tmdb-api/searchable"
+require "tmdb-api/movie"
+require "tmdb-api/changes"
+require "tmdb-api/version"
 
 module TMDb
   class << self

data/lib/tmdb-api/base.rb

@@ -0,0 +1,43 @@
+module TMDb
+  class Base
+    include HTTParty
+    base_uri 'http://api.themoviedb.org/3/'
+    headers 'Accept' => 'application/json'
+    headers 'Content-Type'  => 'application/json'
+    format :json
+
+    # Internal: Raises an exception depending on the type of
+    # the response.
+    #
+    # response - Result of a request.
+    #
+    # Raises an exception.
+    def self.bad_response(response)
+      if response.class == HTTParty::Response
+        raise ArgumentError, response['status_message']
+      end
+      raise StandardError, 'Unkown error'
+    end
+
+    # Internal: creates a new TMDb::Base object.
+    #
+    # attributes - Attributes fetched from the API.
+    def initialize(attributes = {})
+      load(attributes)
+    end
+
+    private
+
+    # Internal: Sets the attributes to the object.
+    #
+    # attributes - A hash containing the keys and values to be
+    #              set in the object.
+    #
+    # Returns nothing
+    def load(attributes)
+      attributes.each do |key, value|
+        self.instance_variable_set("@#{key}", value)
+      end
+    end
+  end
+end

data/lib/tmdb-api/changes.rb

@@ -0,0 +1,21 @@
+module TMDb
+  class Changes < Base
+    # Public: Get a list of movie ids that have been edited. By default we
+    # show the last 24 hours and only 100 items per page. The maximum number
+    # of days that can be returned in a single request is 14.
+    #
+    # options - The hash options used to filter the search (default: {}).
+    #           :page - Page.
+    #           :start_date - Start date (YYYY-MM-DD).
+    #           :end_date - End date (YYYY-MM-DD).
+    #
+    # Examples
+    #
+    # TMDb::Movie.find(68721)
+    # TMDb::Movie.find(68721, language: 'pt')
+    def self.movies(options = {})
+      res = get('/movie/changes', query: options)
+      res.success? ? res : bad_response(res)
+    end
+  end
+end

data/lib/tmdb-api/httparty.rb

@@ -0,0 +1,10 @@
+module HTTParty
+  class Request
+    alias_method :original_query_string, :query_string
+
+    def query_string(uri)
+      options[:default_params].merge!(api_key: TMDb.api_key)
+      original_query_string(uri)
+    end
+  end
+end

data/lib/{tmdb → tmdb-api}/movie.rb

@@ -1,5 +1,5 @@
 module TMDb
-  class Movie
+  class Movie < Base
     extend Searchable
 
     # Movie attributes
@@ -9,83 +9,75 @@ module TMDb
                  :production_countries, :release_date, :revenue, :spoken_languages,
                  :status, :tagline, :title, :vote_average, :vote_count
 
-    attr_accessor *ATTRIBUTES
+    attr_reader *ATTRIBUTES
 
-    def initialize(attrs)
-      ATTRIBUTES.each { |attr| instance_variable_set("@#{attr}", attrs[attr.to_s]) }
-    end
-
-    # Get the basic movie information for a specific movie ID.
+    # Public: Get the basic movie information for a specific movie ID.
     #
-    # id - Movie ID.
+    # id      - The ID of the movie.
     # options - The hash options used to filter the search (default: {}):
-    #           :language - Language of the result data (ISO 639-1 codes) (default: en).
+    #           :language - Language of the result data (ISO 639-1 codes)
+    #                       (default: en).
     #
     # Examples
     #
-    # TMDb::Movie.find(24)
-    #
-    # TMDb::Movie.find(32123, language: 'pt')
-    #
+    # TMDb::Movie.find(68721)
+    # TMDb::Movie.find(68721, language: 'pt')
     def self.find(id, options = {})
-      new Fetcher::get("/movie/#{id}", options)
+      res = get("/movie/#{id}", query: options)
+      res.success? ? Movie.new(res) : bad_response(res)
     end
 
-    # Get the alternative titles for a specific movie ID.
+    # Public: Get the alternative titles for a specific movie ID.
     #
     # options - The hash options used to filter the search (default: {}):
     #           :country - Titles for a specific country (ISO 3166-1 code).
     #
     # Examples
     #
-    # TMDb::Movie.alternative_titles(598, country: 'br')
-    #
+    # TMDb::Movie.alternative_titles(68721, country: 'br')
     def self.alternative_titles(id, options = {})
-      result = Fetcher::get("/movie/#{id}/alternative_titles", options)
-      result['titles']
+      res = get("/movie/#{id}/alternative_titles", query: options)
+      res.success? ? res['titles'] : bad_response(res)
     end
 
-    # Get the images (posters and backdrops) for a specific movie id.
+    # Public: Get the images (posters and backdrops) for a specific movie ID.
     #
     # options - The hash options used to filter the search (default: {}):
     #           :language - Images of a specific language (ISO 639-1 code).
     #
     # Examples
     #
-    # TMDb::Movie.find(598).images
-    #
-    # movie = TMDb::Movie.images(598, language: 'pt')
-    #
+    # TMDb::Movie.find(68721).images
+    # TMDb::Movie.images(68721, language: 'pt')
     def self.images(id, options = {})
-      Fetcher::get("/movie/#{id}/images", options)
+      res = get("/movie/#{id}/images", query: options)
+      res.success? ? res : bad_response(res)
     end
 
-    # Get the plot keywords for a specific movie id.
+    # Public: Get the plot keywords for a specific movie ID.
     #
     # options - The hash options used to filter the search (default: {}):
     #           :language - Images of a specific language (ISO 639-1 code).
     #
     # Examples
     #
-    # TMDb::Movie.keywords(331, language: pt)
-    #
+    # TMDb::Movie.keywords(68721, language: pt)
     def self.keywords(id, options = {})
-      result = Fetcher::get("/movie/#{id}/keywords", options)
-      result['keywords']
+      res = get("/movie/#{id}/keywords", query: options)
+      res.success? ? res['keywords'] : bad_response(res)
     end
 
-    # Get the release date by country for a specific movie id.
+    # Public: Get the release date by country for a specific movie ID.
     #
     # Examples
     #
-    # TMDb::Movie.releases(8711)
-    #
+    # TMDb::Movie.releases(68721)
     def self.releases(id)
-      result = Fetcher::get("/movie/#{id}/releases")
-      result['countries']
+      res = get("/movie/#{id}/releases")
+      res.success? ? res['countries'] : bad_response(res)
     end
 
-    # Get the list of upcoming movies. This list refreshes every day.
+    # Public: Get the list of upcoming movies. This list refreshes every day.
     # The maximum number of items this list will include is 100.
     #
     # options - The hash options used to filter the search (default: {}):
@@ -96,10 +88,14 @@ module TMDb
     #
     # TMDb::Movie.upcoming
     # TMDb::Movie.upcoming(page: 3, language: 'pt')
-    #
     def self.upcoming(options = {})
-      response = Fetcher::get('/movie/upcoming', options)
-      response['results'].map { |movie| new(movie) }
+      res = get('/movie/upcoming', query: options)
+
+      if res.success?
+        res['results'].map { |movie| Movie.new(movie) }
+      else
+        bad_response(res)
+      end
     end
   end
 end

data/lib/{tmdb → tmdb-api}/searchable.rb

@@ -1,9 +1,8 @@
-require "cgi"
-
 module TMDb
   module Searchable
-    # Search movies.
+    # Public: Search resources like a movie, a person, a collection and so on.
     #
+    ## For a movie
     # query   - Query string that will be matched with the movie name.
     # options - The hash options used to filter the search (default: {}):
     #           :page - The current page of results.
@@ -13,21 +12,24 @@ module TMDb
     #
     # Examples
     #
+    ## For a movie
     # TMDb::Movie.search('Iron Man')
-    #
     # TMDb::Movie.search('The Matrix', year: 1999)
-    #
     # TMDb::Movie.search('Forret Gump', language: 'pt', year: 1994)
     def search(query, options = {})
-      # require "pry"; binding.pry
       options.merge!(query: query)
-      result = Fetcher::get("/search/#{resource}", options)
-      result['results'].map { |attributes| new(attributes) }
+      res = get("/search/#{resource}", query: options)
+      if res.success?
+        res['results'].map { |attributes| new(attributes) }
+      else
+        bad_response(res)
+      end
     end
 
-    # Removes the module part from the expression in the string.
+    private
+
     def resource
-      name.split('::').last.downcase || ''
+      name.split('::').last.downcase
     end
   end
 end

data/lib/tmdb-api/version.rb

@@ -0,0 +1,3 @@
+module TMDb
+  VERSION = "0.0.3"
+end