tmdb-api 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9b8d08a9adcc408e37d3d6cfa7e47db4ec0f8ac
+  data.tar.gz: 955ccb36720d7b92811f610a6427ca986927e3cc
+SHA512:
+  metadata.gz: 91cfbbce17ba850da6cced53ef2cee5d29cb4274c97cdffae2ddc3a705b38dba141090d32ca3c1f3bf9653bdfdc5d7652de7b197379e9ae438476b240c466b83
+  data.tar.gz: dc80bd3e13f7240df1112a293ee6cdd292e152da9e4e6febe0b17c133a52b1e8c0efdc552b779b99ed4a56f9430c1bd4a3e4d7b654b79d6c5b0cbf69f85ead0d

data/README.md

@@ -1,6 +1,6 @@
 # The Movie Database API
 
-[![Build Status](https://travis-ci.org/andrielfn/tmdb-api.png)](https://travis-ci.org/andrielfn/tmdb-api)
+[![Build Status](https://travis-ci.org/andrielfn/tmdb-api.png?branch=master)](https://travis-ci.org/andrielfn/tmdb-api)
 [![Code Climate](https://codeclimate.com/github/andrielfn/tmdb-api.png)](https://codeclimate.com/github/andrielfn/tmdb-api)
 
 A simple Ruby wrapper for the The Movie Database API v3.
@@ -19,7 +19,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install tmdb
+    $ gem install tmdb-api
 
 
 ## API Key
@@ -29,6 +29,12 @@ First of all, you need set your API Key provided by TMDb.
 TMDb.api_key = '56565958363476674e5e63643c787867'
 ```
 
+Also it's possible set the API in the `TMDB_API_KEY` environment variable:
+
+```
+export TMDB_API_KEY='56565958363476674e5e63643c787867'
+```
+
 ## Usage
 
 ### Find a movie by id
@@ -82,6 +88,58 @@ movie.alternative_titles(country: 'br')
 # => [{"iso_3166_1"=>"BR", "title"=>"Cidade de Deus"}]
 ```
 
+### Cast
+Get the cast for a specific movie id.
+
+```ruby
+TMDb::Movie.cast(550)
+# => [
+#      {
+#        "id"=>819,
+#        "name"=>"Edward Norton",
+#        "character"=>"The Narrator",
+#        "order"=>0,
+#        "cast_id"=>4,
+#        "profile_path"=>"/588Hrov6wwM9WcU88nJHlw2iufN.jpg"
+#      },
+#      {
+#        "id"=>287,
+#        "name"=>"Brad Pitt",
+#        "character"=>"Tyler Durden",
+#        "order"=>1,
+#        "cast_id"=>5,
+#        "profile_path"=>"/kc3M04QQAuZ9woUvH3Ju5T7ZqG5.jpg"
+#      },
+#      {
+#        ...
+#      }
+#    ]
+
+### Crew
+Get the crew for a specific movie id.
+
+```ruby
+TMDb::Movie.crew(550)
+# => [
+#      {
+#        "id"=>7469,
+#        "name"=>"Jim Uhls",
+#        "department"=>"Writing",
+#        "job"=>"Author",
+#        "profile_path"=>nil
+#      },
+#      {
+#        "id"=>7474,
+#        "name"=>"Ross Grayson Bell",
+#        "department"=>"Production",
+#        "job"=>"Producer",
+#        "profile_path"=>nil
+#      },
+#      {
+#        ...
+#      }
+#    ]
+
 ### Images
 Get the images (posters and backdrops) for a specific movie id.
 
@@ -132,6 +190,33 @@ TMDb::Movie.keywords(68721)
 #    ]
 ```
 
+### Movie trailers
+
+Get the trailers for a specific movie id.
+
+```ruby
+TMDb::Movie.trailers(68721)
+# => {"id"=>68721, 
+#     "quicktime"=> [  
+#       {
+#         "name"=>"Teaser"
+#         "sources"=> [
+#           {"size"=>"480p","source"=>"http://trailers.apple.com/movies/marvel/ironman3/ironman3-tlr1-m4mb0_h480p.mov"},
+#           {"size"=>"720p","source"=>"http://trailers.apple.com/movies/marvel/ironman3/ironman3-tlr1-m4mb0_h720p.mov"},
+#           {"size"=>"1080p","source"=>"http://trailers.apple.com/movies/marvel/ironman3/ironman3-tlr1-m4mb0_h1080p.mov"}
+#         ]
+#       }
+#     "youtube"=> [
+#       {
+#         "name"=>"Iron Man 3 Trailer 2",
+#         "size"=>"HD",
+#         "source"=>"YLorLVa95Xo",
+#         "type"=>"Trailer"
+#       }
+#     ]
+#   }
+```
+
 ### Movie releases
 
 Get the release date by country for a specific movie id.
@@ -171,6 +256,78 @@ TMDb::Movie.upcoming
 #    ]
 ```
 
+### Find a person by ID
+
+Get the basic person information for a specific person id.
+
+```ruby
+TMDB::Person.find(138)
+# => #<TMDb::Person:0x007ff02a081278 @adult=false, @id=138, @imdb_id="nm0000233", @name="Quentin Tarantino" ... >
+```
+
+Available attributes: `id`, `name`, `adult`, `also_known_as`, `biography`
+`birthday`, `deathday`, `homepage`, `place_of_birth`, `profile_path`, `popularity`, `imdb_id`.
+
+### Search people
+Search for people by name.
+
+```ruby
+TMDb::Person.search('Paul')
+# => [#<TMDb::Person:0x007fb572c30558 @id=8167, @name="Paul Walker", ...>,
+#     #<TMDb::Person:0x007fb572c302b0 @id=5129, @name="Paul Reubens", ...>, ...]
+
+TMDb::Person.search('Paul', page: 4)
+# => [#<TMDb::Person:0x007fb572d68d80 @id=455, @name="Paul Haggis", ...>, ...]
+```
+Available options are `:page` and `:include_adult`.
+
+### Person images
+
+Gets the images for a specific person id.
+
+```ruby
+TMDb::Person.images(138)
+# => {"id" => 138,
+# 			"profiles" => [
+# 				{
+# 					"file_path" => "/iws3gBdQJ6tF7x6CIpepYfUKc58.jpg",
+# 					"width" => 1000,
+# 					"height" => 1500,
+# 					"iso_639_1" => nil,
+# 					"aspect_ratio" => 0.67
+# 				},
+# 				{
+# 					"file_path" => "/ubJ3VWz1Zr7dempsJGH8lgREkrS.jpg",
+# 					"width" => 399,
+# 					"height" => 599,
+# 					"iso_639_1" => nil,
+# 					"aspect_ratio" => 0.67
+# 			}]
+# 		}
+```
+
+### Popular people
+
+Gets a list of popular people.
+
+```ruby
+TMDb::Person.popular
+# => [
+# 	#<TMDb::Person:0x007ff0289d1550
+# 	  @adult=false,
+# 	  @id=18918,
+# 	  @name="Dwayne Johnson",
+# 	  @popularity=27.5754694040027,
+# 	  @profile_path="/gQIWcpYo2W4MHw8UhTP2cW0jojF.jpg">,
+# 	#<TMDb::Person:0x007ff0289d1208
+# 	  @adult=false,
+# 	  @id=12835,
+# 	  @name="Vin Diesel",
+# 	  @popularity=20.5472519159021,
+# 	  @profile_path="/qwyfzMKIhxJ7ols66FgEf7eGdcI.jpg">
+# 	]
+```
+
 ## Contributing
 
 1. Fork it

data/lib/tmdb-api.rb

@@ -5,6 +5,7 @@ require 'tmdb-api/httparty'
 
 require 'tmdb-api/base'
 require 'tmdb-api/searchable'
+require 'tmdb-api/inflections'
 
 require 'tmdb-api/movie'
 require 'tmdb-api/genre'
@@ -12,13 +13,19 @@ require 'tmdb-api/production_company'
 require 'tmdb-api/production_country'
 require 'tmdb-api/spoken_language'
 require 'tmdb-api/changes'
+require 'tmdb-api/person'
 
 require 'tmdb-api/version'
 
 module TMDb
   class << self
-    # Set the API Key that will be use to fetch the data.
-    attr_accessor :api_key
+    # Set the API Key that will be use to fetch the data or
+    # retrieve it from the environment variable $TMDB_API_KEY.
+    attr_writer :api_key
+
+    def api_key
+      @api_key || ENV['TMDB_API_KEY']
+    end
 
     # Set the default language of the fetched data.
     attr_accessor :default_language

data/lib/tmdb-api/base.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/string'
+require "pry"
 
 module TMDb
   class Base
@@ -38,11 +39,20 @@ module TMDb
     # Returns nothing
     def load(attributes)
       attributes.each do |key, value|
-        value = build_objects(key, value) if value.is_a?(Array)
+        value = build_objects(key, value) if candidate_to_object?(value)
         self.instance_variable_set("@#{key}", value)
       end
     end
 
+    # Internal: Verifies if the value is an array of hashs.
+    #
+    # value - value to be evaluated
+    #
+    # Returns true or false
+    def candidate_to_object?(value)
+      value.is_a?(Array) && value.all? { |h| h.is_a?(Hash) }
+    end
+
     # Internal: Builds objects for the nested resources from API.
     #
     # key    - attribute related to the object (ex: genres, spoken_languages).

data/lib/tmdb-api/inflections.rb

@@ -0,0 +1,3 @@
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.uncountable %w( also_known_as )
+end

data/lib/tmdb-api/movie.rb

@@ -40,6 +40,34 @@ module TMDb
       res.success? ? res['titles'] : bad_response(res)
     end
 
+    # Public: Get the cast 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.cast(68721, language: pt)
+
+    def self.cast(id, options = {})
+      res = get("/movie/#{id}/casts", query: options)
+      res.success? ? res['cast'] : bad_response(res)
+    end
+
+    # Public: Get the crew 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.crew(68721, language: pt)
+
+    def self.crew(id, options = {})
+      res = get("/movie/#{id}/casts", query: options)
+      res.success? ? res['crew'] : bad_response(res)
+    end
+
     # Public: Get the images (posters and backdrops) for a specific movie ID.
     #
     # options - The hash options used to filter the search (default: {}):
@@ -49,6 +77,7 @@ module TMDb
     #
     # TMDb::Movie.find(68721).images
     # TMDb::Movie.images(68721, language: 'pt')
+
     def self.images(id, options = {})
       res = get("/movie/#{id}/images", query: options)
       res.success? ? res : bad_response(res)
@@ -67,6 +96,19 @@ module TMDb
       res.success? ? res['keywords'] : bad_response(res)
     end
 
+    # Public: Get the trailers 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.trailers(68721, language: pt)
+    def self.trailers(id, options = {})
+      res = get("/movie/#{id}/trailers", query: options)
+      res.success? ? res : bad_response(res)
+    end
+
     # Public: Get the release date by country for a specific movie ID.
     #
     # Examples

data/lib/tmdb-api/person.rb

@@ -0,0 +1,56 @@
+module TMDb
+  class Person < Base
+    extend Searchable
+
+    # Person attributes
+    ATTRIBUTES = :id, :adult, :also_known_as, :biography, :birthday, :deathday,
+                 :homepage, :name, :place_of_birth, :profile_path, :popularity, :imdb_id
+
+    attr_reader *ATTRIBUTES
+
+    # Public: Gets the basic person information for a specific person ID.
+    #
+    # id      - The ID of the person.
+    # options - The hash options used to filter the search (default: {}):
+    #           More information about the options, check the api documentation
+    #
+    # Examples
+    #
+    # TMDb::Person.find(138)
+    def self.find(id, options = {})
+      res = get("/person/#{id}", query: options)
+      res.success? ? Person.new(res) : bad_response(res)
+    end
+
+    # Public: Gets the images for a specific person ID.
+    #
+    # id  - The person's ID
+    #
+    # Examples
+    #
+    # TMDb::Person.images(138)
+    def self.images(id)
+      res = get("/person/#{id}/images")
+      res.success? ? res : bad_response(res)
+    end
+
+    # Public: Gets a list of popular people.
+    #
+    # options - The hash options used to filter the search (default: {}):
+    #           :page - List's page.
+    #
+    # Examples
+    #
+    # TMDb::Person.popular
+    # TMDb::Person.popular(page: 4)
+    def self.popular(options = {})
+      res = get('/person/popular', query: options)
+
+      if res.success?
+        res['results'].map { |person| Person.new(person) }
+      else
+        bad_response(res)
+      end
+    end
+  end
+end

data/lib/tmdb-api/searchable.rb

@@ -16,6 +16,10 @@ module TMDb
     # TMDb::Movie.search('Iron Man')
     # TMDb::Movie.search('The Matrix', year: 1999)
     # TMDb::Movie.search('Forret Gump', language: 'pt', year: 1994)
+    #
+    ## For a person
+    # TMDb::Person.search('Peter Jackson')
+    # TMDb::Person.search('Paul', page: 4)
     def search(query, options = {})
       options.merge!(query: query)
       res = get("/search/#{resource}", query: options)

data/lib/tmdb-api/version.rb

@@ -1,3 +1,3 @@
 module TMDb
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/fixtures/movie/cast.json

@@ -0,0 +1,253 @@
+{
+  "cast":
+    [
+      {
+          "id": 819,
+          "name": "Edward Norton",
+          "character": "The Narrator",
+          "order": 0,
+          "cast_id": 4,
+          "profile_path": "/588Hrov6wwM9WcU88nJHlw2iufN.jpg"
+      },
+     {
+          "id": 287,
+          "name": "Brad Pitt",
+          "character": "Tyler Durden",
+          "order": 1,
+          "cast_id": 5,
+          "profile_path": "/kc3M04QQAuZ9woUvH3Ju5T7ZqG5.jpg"
+      },
+     {
+          "id": 1283,
+          "name": "Helena Bonham Carter",
+          "character": "Marla Singer",
+          "order": 2,
+          "cast_id": 6,
+          "profile_path": "/58oJPFG1wefMC0Vj7sFzHPrm67J.jpg"
+      },
+     {
+         "id": 7470,
+          "name": "Meat Loaf",
+          "character": "Robert 'Bob' Paulson",
+          "order": 3,
+          "cast_id": 7,
+          "profile_path": "/pwNyXgegO1nlZ8uWT847JM8EjGj.jpg"
+      },
+     {
+         "id": 7471,
+          "name": "Zach Grenier",
+          "character": "Richard Chesler",
+          "order": 4,
+          "cast_id": 8,
+          "profile_path": "/jghYiKdNkVehKpiVyE97AWrU9KQ.jpg"
+      },
+     {
+         "id": 7472,
+          "name": "Richmond Arquette",
+          "character": "Intern",
+          "order": 5,
+          "cast_id": 9,
+          "profile_path": null
+      },
+     {
+         "id": 7219,
+          "name": "David Andrews",
+          "character": "Thomas",
+          "order": 6,
+          "cast_id": 10,
+          "profile_path": "/pxmxn29UHW9r6uvLrd7bEwLswlQ.jpg"
+      },
+     {
+         "id": 7473,
+          "name": "Rachel Singer",
+          "character": "Chloe",
+          "order": 11,
+          "cast_id": 11,
+          "profile_path": null
+      },
+     {
+         "id": 7497,
+          "name": "Holt McCallany",
+          "character": "The Mechanic",
+          "order": 20,
+          "cast_id": 22,
+          "profile_path": "/hQBfcw9KVszdenlTZTR8AIrSpex.jpg"
+      },
+     {
+         "id": 7498,
+          "name": "Eion Bailey",
+          "character": "Ricky",
+          "order": 22,
+          "cast_id": 23,
+          "profile_path": "/4MnRgrwuiJvHsfoiJrIUL4TkfoC.jpg"
+      },
+     {
+         "id": 7499,
+          "name": "Jared Leto",
+          "character": "Angel Face",
+          "order": 23,
+          "cast_id": 24,
+          "profile_path": "/lzQSuu5o0JC9mCncYjVnncSH5lO.jpg"
+      },
+     {
+         "id": 7500,
+          "name": "Peter Iacangelo",
+          "character": "Lou",
+          "order": 24,
+          "cast_id": 25,
+          "profile_path": null
+      },
+     {
+         "id": 56112,
+          "name": "David Lee Smith",
+          "character": "Walter",
+          "order": 19,
+          "cast_id": 30,
+          "profile_path": "/xYkMA9AWtUN93KV5hWzlDkcnebB.jpg"
+      },
+     {
+         "id": 1129738,
+          "name": "George Maguire",
+          "character": "Group Leader",
+          "order": 7,
+          "cast_id": 31,
+          "profile_path": null
+      },
+     {
+         "id": 197790,
+          "name": "Eugenie Bondurant",
+          "character": "Weeping Woman",
+          "order": 8,
+          "cast_id": 32,
+          "profile_path": null
+      },
+     {
+         "id": 68277,
+          "name": "Christina Cabot",
+          "character": "Group Leader",
+          "order": 9,
+          "cast_id": 33,
+          "profile_path": "/7UBTv5lW6apPdVLnOqTTBMTJWwY.jpg"
+      },
+     {
+         "id": 202080,
+          "name": "Sydney 'Big Dawg' Colston",
+          "character": "Speaker",
+          "order": 10,
+          "cast_id": 34,
+          "profile_path": null
+      },
+     {
+         "id": 1172435,
+          "name": "Christie Cronenweth",
+          "character": "Airline Attendant",
+          "order": 12,
+          "cast_id": 35,
+          "profile_path": null
+      },
+     {
+         "id": 956719,
+          "name": "Tim De Zarn",
+          "character": "Inspector Bird",
+          "order": 13,
+          "cast_id": 36,
+          "profile_path": null
+      },
+     {
+         "id": 59285,
+          "name": "Ezra Buzzington",
+          "character": "Inspector Dent",
+          "order": 14,
+          "cast_id": 37,
+          "profile_path": "/dl0SIqpOqS05UpJHKuDQqZTwUvP.jpg"
+      },
+     {
+         "id": 1269622,
+          "name": "Dierdre Downing-Jackson",
+          "character": "Woman on Plane",
+          "order": 15,
+          "cast_id": 38,
+          "profile_path": null
+      },
+     {
+         "id": 543293,
+          "name": "Bob Stephenson",
+          "character": "Airport Security Officer (as Robert J. Stephenson)",
+          "order": 16,
+          "cast_id": 39,
+          "profile_path": "/iH86ZmoSGOCnWZ8aycavGdlu3ht.jpg"
+      },
+     {
+         "id": 62846,
+          "name": "Charlie Dell",
+          "character": "Doorman",
+          "order": 17,
+          "cast_id": 40,
+          "profile_path": "/z0JgZxazJAVlHxLYXWM8eUZlOk8.jpg"
+      },
+     {
+         "id": 530040,
+          "name": "Rob Lanza",
+          "character": "Man in Suit",
+          "order": 18,
+          "cast_id": 41,
+          "profile_path": null
+      },
+     {
+         "id": 137425,
+          "name": "Joel Bissonnette",
+          "character": "Food Court Maitre D'",
+          "order": 21,
+          "cast_id": 42,
+          "profile_path": null
+      },
+     {
+         "id": 175120,
+          "name": "Evan Mirand",
+          "character": "Steph",
+          "order": 25,
+          "cast_id": 43,
+          "profile_path": null
+      },
+     {
+         "id": 169636,
+          "name": "Robby Robinson",
+          "character": "Next Month's Opponent",
+          "order": 26,
+          "cast_id": 44,
+          "profile_path": null
+      },
+     {
+         "id": 168924,
+          "name": "Lou Beatty Jr.",
+          "character": "Cop at Marla's Building",
+          "order": 27,
+          "cast_id": 45,
+          "profile_path": null
+      },
+     {
+         "id": 1219497,
+          "name": "Thom Gossom Jr.",
+          "character": "Detective Stern",
+          "order": 28,
+          "cast_id": 46,
+          "profile_path": null
+      },
+     {
+         "id": 157938,
+          "name": "Valerie Bickford",
+          "character": "Susan, Cosmetics Dealer",
+          "order": 29,
+          "cast_id": 47,
+          "profile_path": null
+      },
+     {
+         "id": 42824,
+          "name": "Carl Ciarfalio",
+          "character": "Lou's Body Guard (as Carl N. Ciarfalio)",
+          "order": 30,
+          "cast_id": 48,
+          "profile_path": null
+      }
+    ]
+  }