tmdb-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 822a6f146cbfddcbe6007e076c8cdd4be137514d
+  data.tar.gz: 1b6c94c5562335ba4d604306c61d2c0ec205ff55
+SHA512:
+  metadata.gz: 950acc07d687cf84826b5cf4f71156ecef0431912645e4e660c0daea875762070e00981b034bde80d7d7d855805888003090b878fc0027ec54619c04b3e65180
+  data.tar.gz: c597a1d67a25cfc1cf9c252a06a536cf82973a0cd95cc48ed6af6aca7b2fbe457a40ea2941c44c8a5b6f849588e493baa8b3e815d039c4c6d793ed442848d4f4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour --format doc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andriel Nuernberg
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,148 @@
+# The Movie Database API v3
+
+Ruby wrapper for the The Movie Database API.
+
+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).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tmdb-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tmdb
+
+## Usage
+
+### 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.
+
+```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" ... >
+```
+
+### Search movie
+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 can filter the serch with the following options: _page_, _language_,
+_include_adult_, and _year_.
+
+### Alternative titles
+Get the alternative titles for a specific movie ID.
+
+```ruby
+movie = TMDB::Movie.find(598)
+
+movie.alternative_titles
+# => [{"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"}]
+```
+
+### Images
+Get the images (posters and backdrops) for a specific movie ID.
+
+```ruby
+TMDb::Movie.find(598).images
+# => {"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.find(598).images(language: 'pt')
+```
+
+### Movie object
+
+```ruby
+movie = TMDb::Movie.find(27205)
+
+movie.id # => 27205
+movie.adult # => false
+movie.backdrop_path # => /s2bT29y0ngXxxu2IA8AOzzXTRhd.jpg
+movie.belongs_to_collection # => {"id"=>179836, "name"=>"Inception Collection", "poster_path"=>"/7OtEJQjBhxNug5TyY0ny4ttuKdg.jpg", "backdrop_path"=>"/73WuAqGGCv3F8Rwy5FTnYlji6IS.jpg"}
+movie.budget # => 160000000
+movie.genres # => [{"id"=>28, "name"=>"Action"}, {"id"=>12, "name"=>"Adventure"}, {"id"=>9648, "name"=>"Mystery"}, {"id"=>878, "name"=>"Science Fiction"}, {"id"=>53, "name"=>"Thriller"}]
+movie.homepage # => http://inceptionmovie.warnerbros.com/
+movie.imdb_id # => tt1375666
+movie.original_title # => Inception
+movie.overview # => Dom Cobb, a skilled thief who commits corporate espionage by infiltrating the subconscious of his targets is offered a chance to regain his old life as payment for a task considered to be impossible: "inception", the implantation of another person's idea into a target's subconscious.
+movie.popularity # => 8.908730111185815
+movie.poster_path # => /tAXARVreJnWfoANIHASmgYk4SB0.jpg
+movie.production_companies # => [{"name"=>"Warner Bros. Pictures", "id"=>174}, {"name"=>"Syncopy", "id"=>9996}]
+movie.runtime # => 148
+movie.production_countries # => [{"iso_3166_1"=>"US", "name"=>"United States of America"}]
+movie.release_date # => 2010-07-16
+movie.revenue # => 825532764
+movie.spoken_languages # => [{"iso_639_1"=>"en", "name"=>"English"}, {"iso_639_1"=>"ja", "name"=>"日本語"}, {"iso_639_1"=>"fr", "name"=>"Français"}]
+movie.status # => Released
+movie.tagline # => Your mind is the scene of the crime.
+movie.title # => Inception
+movie.vote_average # => 8.2
+movie.vote_count # => 497
+```
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/tmdb.rb

@@ -0,0 +1,18 @@
+require "httparty"
+require "json"
+
+require "tmdb/fetcher"
+require "tmdb/searchable"
+require "tmdb/movie"
+require "tmdb/changes"
+require "tmdb/version"
+
+module TMDb
+  class << self
+    # Set the API Key that will be use to fetch the data.
+    attr_accessor :api_key
+
+    # Set the default language of the fetched data.
+    attr_accessor :default_language
+  end
+end

data/lib/tmdb/changes.rb

@@ -0,0 +1,22 @@
+module TMDb
+  class 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.
+    #
+    # 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(24)
+    #
+    # TMDb::Movie.find(32123, language: 'pt')
+    #
+    def self.movies(options = {})
+      Fetcher::get('/movie/changes', options)
+    end
+  end
+end

data/lib/tmdb/fetcher.rb

@@ -0,0 +1,30 @@
+class APIKeyNotSet < StandardError; end
+
+module TMDb
+  module Fetcher
+    include HTTParty
+    base_uri 'http://api.themoviedb.org/3/'
+    headers 'Accept' => 'application/json'
+    format :json
+
+    def self.get(url, options = {})
+      verify_api!
+
+      options.merge!(api_key: TMDb.api_key)
+
+      result = super(url, query: options)
+
+      if result.success?
+        result
+      else
+        raise ArgumentError, JSON.parse(result.response.body)['status_message']
+      end
+    end
+
+    def self.verify_api!
+      if TMDb.api_key.nil? || TMDb.api_key.empty?
+        raise ArgumentError, 'TMDb.api_key must be set before using the API'
+      end
+    end
+  end
+end

data/lib/tmdb/movie.rb

@@ -0,0 +1,105 @@
+module TMDb
+  class Movie
+    extend Searchable
+
+    # Movie attributes
+    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
+
+    attr_accessor *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.
+    #
+    # id - Movie ID.
+    # options - The hash options used to filter the search (default: {}):
+    #           :language - Language of the result data (ISO 639-1 codes) (default: en).
+    #
+    # Examples
+    #
+    # TMDb::Movie.find(24)
+    #
+    # TMDb::Movie.find(32123, language: 'pt')
+    #
+    def self.find(id, options = {})
+      new Fetcher::get("/movie/#{id}", options)
+    end
+
+    # 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')
+    #
+    def self.alternative_titles(id, options = {})
+      result = Fetcher::get("/movie/#{id}/alternative_titles", options)
+      result['titles']
+    end
+
+    # 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')
+    #
+    def self.images(id, options = {})
+      Fetcher::get("/movie/#{id}/images", options)
+    end
+
+    # 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)
+    #
+    def self.keywords(id, options = {})
+      result = Fetcher::get("/movie/#{id}/keywords", options)
+      result['keywords']
+    end
+
+    # Get the release date by country for a specific movie id.
+    #
+    # Examples
+    #
+    # TMDb::Movie.releases(8711)
+    #
+    def self.releases(id)
+      result = Fetcher::get("/movie/#{id}/releases")
+      result['countries']
+    end
+
+    # 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: {}):
+    #           :page - Page.
+    #           :language - Images of a specific language (ISO 639-1 code).
+    #
+    # Examples
+    #
+    # 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) }
+    end
+  end
+end

data/lib/tmdb/searchable.rb

@@ -0,0 +1,33 @@
+require "cgi"
+
+module TMDb
+  module Searchable
+    # Search movies.
+    #
+    # 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.
+    #           :language - Language of the result data (ISO 639-1 codes) (default: en).
+    #           :include_adult - Toggle the inclusion of adult titles. Expected value is: true or false.
+    #           :year - Filter results to only include this value.
+    #
+    # Examples
+    #
+    # 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) }
+    end
+
+    # Removes the module part from the expression in the string.
+    def resource
+      name.split('::').last.downcase || ''
+    end
+  end
+end

data/lib/tmdb/version.rb

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

data/spec/fixtures/alternative_titles.json

@@ -0,0 +1,41 @@
+{
+  "id": 598,
+  "titles": [
+    {
+      "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": "無法無天"
+    }
+  ]
+}