tmdb-api 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9b8d08a9adcc408e37d3d6cfa7e47db4ec0f8ac
-  data.tar.gz: 955ccb36720d7b92811f610a6427ca986927e3cc
+  metadata.gz: 7bd9362cdbe5d931bfd354ea7e22fd7c23d5ee68
+  data.tar.gz: 1c35adffd61d54740fb67258d9eabf3c955d4fff
 SHA512:
-  metadata.gz: 91cfbbce17ba850da6cced53ef2cee5d29cb4274c97cdffae2ddc3a705b38dba141090d32ca3c1f3bf9653bdfdc5d7652de7b197379e9ae438476b240c466b83
-  data.tar.gz: dc80bd3e13f7240df1112a293ee6cdd292e152da9e4e6febe0b17c133a52b1e8c0efdc552b779b99ed4a56f9430c1bd4a3e4d7b654b79d6c5b0cbf69f85ead0d
+  metadata.gz: d4e8791e638143afc121582290b1c1016f0020333ef74fe07bffbc7479e7ab5755f5a8e9e387a03d006a08e86bcc1572fe8c9bf8b2a8aa309f81c37a666fe095
+  data.tar.gz: 5d664181bd57667b2ffac0be8c3406b116c2b025c96ff6741f65f4b25720a337945c67c91e99ca37bb24da693aa43ac131866ad6b9f5072df0c6981fad8bc05e

data/.rspec

@@ -1 +1 @@
---colour --format doc
+--colour

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 script: bundle exec rspec spec
 rvm:
+- 2.1.0
 - 2.0.0
 - 1.9.3
 notifications:

data/README.md

@@ -31,8 +31,8 @@ TMDb.api_key = '56565958363476674e5e63643c787867'
 
 Also it's possible set the API in the `TMDB_API_KEY` environment variable:
 
-```
-export TMDB_API_KEY='56565958363476674e5e63643c787867'
+```sh
+$ export TMDB_API_KEY='56565958363476674e5e63643c787867'
 ```
 
 ## Usage
@@ -42,133 +42,82 @@ Get the basic movie information for a specific movie id.
 
 ```ruby
 TMDB::Movie.find(24)
-# => #<TMDb::Movie:0x007f99 @id=24, @title="Kill Bill: Vol. 1", @imdb_id="tt0266697" ... >
 
 TMDB::Movie.find(603, language: 'pt')
-# => #<TMDb::Movie:0x007f99 @id=603, @title="The Matrix", @imdb_id="tt0133093" ... >
 ```
 
-Available attributes: `id`, `adult`, `backdrop_path`, `belongs_to_collection`,
-`budget`, `genres`, `homepage`, `imdb_id`, `original_title`, `overview`,
-`popularity`, `poster_path`, `production_companies`, `runtime`,
-`production_countries`, `release_date`, `revenue`, `spoken_languages`, `status`,
- `tagline`, `title`, `vote_average`, `vote_count`.
+Optional parameters:
+
+- `language` - ISO 639-1 code.
+
+The available attributes are: _id_, _adult_, _backdrop_path_, _belongs_to_collection_,
+_budget_, _genres_, _homepage_, _imdb_id_, _original_title_, _overview_,
+_popularity_, _poster_path_, _production_companies_, _runtime_,
+_production_countries_, _release_date_, _revenue_, _spoken_languages_, _status_,
+ _tagline_, _title_, _vote_average_, _vote_count_.
+
 
 ### Search movies
 Search for movies by title.
 
 ```ruby
 TMDb::Movie.search('Forrest')
-# => [#<TMDb::Movie:0x007f92 @id=13, @title="Forrest Gump", ...>,
-#     #<TMDb::Movie:0x007f93 @id=711, @title="Finding Forrester", ...>,
-#     #<TMDb::Movie:0x007f94 ... >, ...]
 
 TMDb::Movie.search('wall e', year: 2003)
-# => [#<TMDb::Movie:0x007f92 @id=10681, @original_title="WALL·E", ...>]
 ```
-You also have another options that you can use to filter the search: `:page`,
-`:language`, `:include_adult` and `:year`.
+
+Optional parameters:
+
+- `page` - Minimum 1, maximum 1000.
+- `language` - ISO 639-1 code.
+- `include_adult` - Toggle the inclusion of adult titles. Expected value is:
+_true_ or _false_.
+- `year` - Filter the results release dates to matches that include this value.
+- `primary_release_year` - Filter the results so that only the primary release
+dates have this value.
+- `search_type` - By default, the search type is 'phrase'. This is almost
+guaranteed the option you will want. It's a great all purpose search type and by
+far the most tuned for every day querying. For those wanting more of an
+"autocomplete" type search, set this option to 'ngram'.
+
 
 ### Alternative titles
 Get the alternative titles for a specific movie id.
 
 ```ruby
 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"},
-# {"iso_3166_1"=>"FR", "title"=>"La cité de Dieu"},
-# {"iso_3166_1"=>"DE", "title"=>"City of God"},
-# {"iso_3166_1"=>"CN", "title"=>"上帝之城"},
-# {"iso_3166_1"=>"HK", "title"=>"无主之城"},
-# {"iso_3166_1"=>"US", "title"=>"City of God"},
-# {"iso_3166_1"=>"TW", "title"=>"無法無天"}]
-
-movie.alternative_titles(country: 'br')
-# => [{"iso_3166_1"=>"BR", "title"=>"Cidade de Deus"}]
+
+TMDB::Movie.alternative_titles(598, country: 'br')
 ```
 
+Optional parameters:
+
+- `country` - ISO 3166-1 code.
+
 ### 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"
-#      },
-#      {
-#        ...
-#      }
-#    ]
+
+TMDb::Movie.cast(550, language: 'pt')
+```
 
 ### 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
+
+
+TMDb::Movie.crew(550, language: 'fr')
+```
+
+### Movie images
 Get the images (posters and backdrops) for a specific movie id.
 
 ```ruby
 TMDb::Movie.images(598)
-# => {"id"=>598,
-#     "backdrops"=> [
-#       {
-#         "file_path"=>"/hSaH9tt67bozo9K50sbH0s4YjEc.jpg",
-#         "width"=>1532,
-#         "height"=>862,
-#         "iso_639_1"=>nil,
-#         "aspect_ratio"=>1.78,
-#        "vote_average"=>5.4421768707483,
-#         "vote_count"=>7
-#       },
-#       {
-#         "file_path"=>"/k4BAPrE5WkNLvpsPsiMfu8W4Zyi.jpg",
-#         "width"=>1920,
-#         "height"=>1080,
-#         "iso_639_1"=>nil,
-#         "aspect_ratio"=>1.78,
-#         "vote_average"=>5.399159663865546,
-#         "vote_count"=>5
-#       },
-#       {
-#         ...
-#       }
-#     ]}
 
 TMDb::Movie.images(598, language: 'pt')
 ```
@@ -179,15 +128,6 @@ 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 trailers
@@ -196,25 +136,6 @@ 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
@@ -223,15 +144,6 @@ 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
@@ -241,45 +153,34 @@ 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>
-#    ]
 ```
 
-### Find a person by ID
+### 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`.
+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`.
+
+Optional parameters:
+
+- `page` - Minimum 1, maximum 1000.
+- `include_adult` - Toggle the inclusion of adult titles. Expected value is:
+_true_ or _false_.
 
 ### Person images
 
@@ -287,51 +188,44 @@ 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.
+Gets a list of popular people. This list refreshes every day.
 
 ```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">
-# 	]
 ```
 
+Optional parameters:
+
+- `page` - Minimum 1, maximum 1000.
+
+### Changes
+
+##### Movie changes
+
+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.
+
+```ruby
+TMDb::Changes.movies
+
+TMDb::Changes.movies(page: 1, start_date: '2013-03-22')
+```
+
+Optional parameters:
+
+- `page` - Minimum 1, maximum 1000.
+- `start_date` - YYYY-MM-DD.
+- `end_date` - YYYY-MM-DD.
+
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+1. Fork it.
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Add some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create new Pull Request.

data/lib/tmdb-api/base.rb

@@ -1,5 +1,4 @@
 require 'active_support/core_ext/string'
-require "pry"
 
 module TMDb
   class Base
@@ -26,7 +25,7 @@ module TMDb
     #
     # attributes - Attributes fetched from the API.
     def initialize(attributes = {})
-      load(attributes)
+      set_attributes(attributes)
     end
 
     private
@@ -37,7 +36,7 @@ module TMDb
     #              set in the object.
     #
     # Returns nothing
-    def load(attributes)
+    def set_attributes(attributes)
       attributes.each do |key, value|
         value = build_objects(key, value) if candidate_to_object?(value)
         self.instance_variable_set("@#{key}", value)

data/lib/tmdb-api/changes.rb

@@ -1,21 +1,46 @@
 module TMDb
   class Changes < Base
+    ATTRIBUTES = :changes, :page, :total_pages, :total_results
+
+    attr_reader *ATTRIBUTES
+
     # 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.
+    #           :page - Page. Minimum 1, maximum 1000.
     #           :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')
+    #   TMDb::Changes.movies
+    #   TMDb::Changes.movies(page: 1, start_date: '2013-03-22')
     def self.movies(options = {})
       res = get('/movie/changes', query: options)
-      res.success? ? res : bad_response(res)
+      res.success? ? Changes.new(res) : bad_response(res)
+    end
+
+    private
+
+    # Internal: sets the fetched result to the instance variables.
+    #
+    # attributes - Returned attributes from the API.
+    def set_attributes(attributes)
+      @changes = results_ids(attributes['results'])
+      @page = attributes['page']
+      @total_pages = attributes['total_pages']
+      @total_results = attributes['total_results']
+    end
+
+    # Internal: Extract only the IDs from the result.
+    #
+    # changes - The `results` key returned from the API.
+    def results_ids(changes)
+      changes.map do |item|
+        item['id']
+      end
     end
   end
 end