tmdby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52b4a16f72493c3a91c4c59b4f631b6317c4732d
+  data.tar.gz: 90ae3ecd556dccf5ed7562a64f53d83ad26b9b83
+SHA512:
+  metadata.gz: e29b083591ffef57db46c09768be50d5a55f0394e019f6242ce56d58b8bce0586c368bc539bf06e8e84ad7b868021114faf7d8b1da8344232ae946ddff9aad10
+  data.tar.gz: 12f29f943c0556884bae5ead3d87a1028675cc9c15bbbae15fbf5211d6e6438a767a21ce7c6451c883a29e52faad8f207debc7fe8968b022e5e22285594672ad

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "minitest"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+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,31 @@
+# Tmdby
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tmdby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tmdby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tmdby/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/tmdby/client.rb

@@ -0,0 +1,43 @@
+require "net/http"
+require 'uri'
+require_relative 'response'
+
+module Tmdby
+  class Client
+    @@netloc     = "api.themoviedb.org/3"
+
+    # Returns complete api route to call
+    def self.get_uri(api_route, params = {})
+      params["api_key"] = Tmdby::Setup.key
+
+      URI("#{Tmdby::Setup.api_scheme}://#{@@netloc}/#{api_route}?#{URI.encode_www_form(params)}")
+    end
+
+
+    def self.api_call(method_call, api_route, params = {}, post_params = {})
+      if Tmdby::Setup.key
+        uri = self.get_uri api_route, params
+        # puts "[#{method_call}] #{uri}"
+
+        case method_call
+        when "get"
+          response = Net::HTTP.get_response(uri)
+        when "post"
+          response = Net::HTTP.post_form(uri, post_params)
+        when "delete"
+          response = Net::HTTP.new(uri.host, uri.port).delete("#{uri.path}?#{uri.query}")
+        else
+          raise RuntimeError, "An error has occured : \"#{method_call}\" is unknown method_call"
+        end
+
+        if response.is_a? Net::HTTPSuccess
+          Tmdby::Response.new(response, uri, method_call, post_params)
+        else
+          raise RuntimeError, "An error has occured : #{response.body}"
+        end
+      else
+        raise RuntimeError, 'An error has occured : please specify TMDB API KEY'
+      end
+    end
+  end
+end

data/lib/tmdby/helpers/authentication.rb

@@ -0,0 +1,17 @@
+module Tmdby
+  class Authentication
+
+    # Generate a session id using TMDB credentials
+    def self.get_session_id(username, password)
+      begin
+        token = self.token_new.body["request_token"]
+        self.token_validate_with_login token, username, password
+
+        return (self.session_new token).body["session_id"]
+      rescue
+        return false
+      end
+    end
+
+  end
+end

data/lib/tmdby/response.rb

@@ -0,0 +1,17 @@
+require 'json'
+
+module Tmdby
+  class Response
+    attr_reader :code, :raw_body, :body, :headers, :uri, :http_verb, :post_params
+
+    def initialize(response, uri, http_verb, post_params)
+      @code = response.code
+      @headers = response.to_hash
+      @raw_body = response.body
+      @body = JSON.parse(response.body)
+      @uri = uri
+      @http_verb = http_verb.upcase
+      @post_params = post_params
+    end
+  end
+end

data/lib/tmdby/version.rb

@@ -0,0 +1,3 @@
+module Tmdby
+  VERSION = "1.0.0"
+end

data/lib/tmdby/wrapper.rb

@@ -0,0 +1,62 @@
+module Tmdby
+  class Wrapper
+    class << self
+      attr_accessor :root, :params, :clean_params, :post_params
+    end
+
+    # Compute api route
+    def self.route(route)
+      route = route.to_s if route.is_a? Integer
+
+      if @root and not @root.empty? and not route.empty?
+        "#{@root}/#{route}"
+      else
+        "#{@root}#{route}"
+      end
+    end
+
+    # Verify that every parameter is allowed by the api
+    def self.verify_params(authorized)
+      @params.each do |key, _|
+        raise RuntimeError, "Unknown argument : #{key}\nAuthorized arguments : #{authorized.join(', ')}" if not authorized.include? key.to_s
+      end
+    end
+
+    # Add default language to parameters if it has been setted
+    def self.add_default_language
+      default_language = Tmdby::Setup.default_language
+
+      if default_language && !@params.key?('language') && !@params.key?(:language)
+        @params['language'] = default_language
+      end
+    end
+
+    # Dispatch params in 2 hashes : one for api url parameters, another on for api post parameters
+    def self.handle_post_params(post_param_names)
+      @clean_params = {}
+      @post_params  = {}
+
+      @params.each do |k, v|
+        if post_param_names.include?k or post_param_names.include?k.to_s
+          @post_params[k.to_s] = v if v
+        else
+          @clean_params[k.to_s] = v if v
+        end
+      end
+    end
+
+    #
+    def self.fetch(route = "", *args, method: "get", post_params: [], authorized_params: [], disable_unknown_params: false, **params)
+      @params = params
+      @params.merge!(args[0]) if not args.empty?
+
+      self.add_default_language if authorized_params.include?'language'
+      self.verify_params authorized_params unless disable_unknown_params or authorized_params.include?"append_to_response"
+      self.handle_post_params post_params
+
+      Tmdby::Client.api_call method, self.route(route), @clean_params, @post_params
+    end
+
+
+  end
+end

data/lib/tmdby/wrappers/account.rb

@@ -0,0 +1,103 @@
+module Tmdby
+  class Account < Wrapper
+
+    @root = "account"
+
+    # Get the basic information for an account.
+    def self.get(session_id)
+      self.fetch "",
+                  session_id: session_id,
+                  authorized_params: ["session_id"]
+    end
+
+    # Get the lists that you have created and marked as a favorite.
+    def self.lists(id, session_id, optional_params = {})
+      self.fetch "#{id}/lists",
+                  optional_params,
+                  session_id: session_id,
+                  authorized_params: ['session_id', 'page', 'language']
+    end
+
+    # Get the list of favorite movies for an account.
+    def self.favorite_movies(id, session_id, optional_params = {})
+      self.fetch "#{id}/favorite/movies",
+                  optional_params,
+                  session_id: session_id,
+                  authorized_params: ['session_id', 'page', 'language', 'sort_by']
+    end
+
+    # Get the list of favorite TV series for an account.
+    def self.favorite_tv(id, session_id, optional_params = {})
+      self.fetch "#{id}/favorite/tv",
+                  optional_params,
+                  session_id: session_id,
+                  authorized_params: ['session_id', 'page', 'language', 'sort_by']
+    end
+
+    # Add or remove a movie to an accounts favorite list.
+    def self.favorite(id, session_id, media_type, media_id, favorite)
+      self.fetch "#{id}/favorite",
+                  method: 'post',
+                  session_id: session_id,
+                  media_type: media_type,
+                  media_id: media_id,
+                  favorite: favorite,
+                  post_params: ["media_type", "media_id", "favorite"],
+                  authorized_params: ['session_id', "media_type", "media_id", "favorite"]
+    end
+
+    # Get the list of rated movies (and associated rating) for an account.
+    def self.rated_movies(id, session_id, optional_params = {})
+      self.fetch "#{id}/rated/movies",
+                  optional_params,
+                  session_id: session_id,
+                  authorized_params: ['session_id', 'page', 'language', 'sort_by']
+    end
+
+    # Get the list of rated TV shows (and associated rating) for an account.
+    def self.rated_tv(id, session_id, optional_params = {})
+      self.fetch "#{id}/rated/tv",
+                  optional_params,
+                  session_id: session_id,
+                  authorized_params: ['session_id', 'page', 'language', 'sort_by']
+    end
+
+    # Get the list of rated tv episodes (and associated rating) for an account.
+    def self.rated_tv_episodes(id, session_id, optional_params = {})
+      self.fetch "#{id}/rated/tv/episodes",
+                  optional_params,
+                  session_id: session_id,
+                  authorized_params: ['session_id', 'page', 'language', 'sort_by']
+    end
+
+    # Get the list of movies on an accounts watchlist.
+    def self.watchlist_movies(id, session_id, optional_params = {})
+      self.fetch "#{id}/watchlist/movies",
+                  optional_params,
+                  session_id: session_id,
+                  authorized_params: ['session_id', 'page', 'language', 'sort_by']
+    end
+
+    # Get the list of TV series on an accounts watchlist.
+    def self.watchlist_tv(id, session_id, optional_params = {})
+      self.fetch "#{id}/watchlist/tv",
+                  optional_params,
+                  session_id: session_id,
+                  authorized_params: ['session_id', 'page', 'language', 'sort_by']
+    end
+
+    # Add or remove a movie to an accounts watch list.
+    def self.watchlist(id, session_id, media_type, media_id, watchlist)
+      self.fetch "#{id}/watchlist",
+                  method: 'post',
+                  session_id: session_id,
+                  media_type: media_type,
+                  media_id: media_id,
+                  watchlist: watchlist,
+                  post_params: ["media_type", "media_id", "watchlist"],
+                  authorized_params: ['session_id', "media_type", "media_id", "watchlist"]
+    end
+
+
+  end
+end

data/lib/tmdby/wrappers/authentication.rb

@@ -0,0 +1,32 @@
+module Tmdby
+  class Authentication < Wrapper
+
+    @root = "authentication"
+
+    # This method is used to generate a valid request token for user based authentication.
+    def self.token_new
+      self.fetch "token/new"
+    end
+
+    # Once you have a valid request token you can use this method to authenticate a user with a TMDb username and password.
+    def self.token_validate_with_login(request_token, username, password)
+      self.fetch "token/validate_with_login",
+                  request_token: request_token,
+                  username: username,
+                  password: password,
+                  authorized_params: ["request_token", "username", "password"]
+    end
+
+    # This method is used to generate a session id for user based authentication.
+    def self.session_new(request_token)
+      self.fetch "session/new",
+                  request_token: request_token,
+                  authorized_params: ["request_token"]
+    end
+
+    # This method is used to generate a guest session id.
+    def self.guest_session_new
+      self.fetch "guest_session/new"
+    end
+  end
+end

data/lib/tmdby/wrappers/certifications.rb

@@ -0,0 +1,15 @@
+module Tmdby
+  class Certifications < Wrapper
+    @root = 'certification'
+
+    # Get the list of supported certifications for movies
+    def self.movie_list
+      self.fetch "movie/list"
+    end
+
+    # Get the list of supported certifications for tv shows
+    def self.tv_list
+      self.fetch "tv/list"
+    end
+  end
+end

data/lib/tmdby/wrappers/changes.rb

@@ -0,0 +1,31 @@
+module Tmdby
+  class Changes < Wrapper
+
+    # Get a list of movie ids that have been edited
+    # Authorized params : page | start_date | end_date
+    # Example : Tmdby::Changes.movie_changes page:2
+    def self.movie(optional_params = {})
+      self.fetch "movie/changes",
+                  optional_params,
+                  authorized_params: ['page', 'start_date', 'end_date']
+    end
+
+    # Get a list of people ids that have been edited
+    # Authorized params : page | start_date | end_date
+    # Example : Tmdby::Changes.person_changes page:2
+    def self.person(optional_params = {})
+      self.fetch "person/changes",
+                  optional_params,
+                  authorized_params: ['page', 'start_date', 'end_date']
+    end
+
+    # Get a list of TV show ids that have been edited
+    # Authorized params : page | start_date | end_date
+    # Example : Tmdby::Changes.tv_changes page:2
+    def self.tv(optional_params = {})
+      self.fetch "tv/changes",
+                  optional_params,
+                  authorized_params: ['page', 'start_date', 'end_date']
+    end
+  end
+end

data/lib/tmdby/wrappers/collections.rb

@@ -0,0 +1,20 @@
+module Tmdby
+  class Collections < Wrapper
+
+    @root = "collection"
+
+    # Get the basic collection information for a specific collection id.
+    def self.get(id, optional_params = {})
+      self.fetch id,
+                  optional_params,
+                  authorized_params: ["language", "append_to_response"]
+    end
+
+    # Get all of the images for a particular collection by collection id.
+    def self.images(id, optional_params = {})
+      self.fetch "#{id}/images",
+                  optional_params,
+                  authorized_params: ["language","append_to_response", "include_image_language"]
+    end
+  end
+end

data/lib/tmdby/wrappers/companies.rb

@@ -0,0 +1,19 @@
+module Tmdby
+  class Companies < Wrapper
+
+    @root = "company"
+
+    # This method is used to retrieve all of the basic information about a company.
+    def self.get(id, optional_params = {})
+      self.fetch id,
+                  optional_params,
+                  authorized_params: ["append_to_response"]
+    end
+
+    def self.movies(id, optional_params = {})
+      self.fetch "#{id}/movies",
+                  optional_params,
+                  authorized_params: ["page", "language", "append_to_response"]
+    end
+  end
+end

data/lib/tmdby/wrappers/configuration.rb

@@ -0,0 +1,11 @@
+module Tmdby
+  class Configuration < Wrapper
+    @root = 'configuration'
+
+    # Get the system wide configuration information
+    # API reference : Updated on Dec. 13, 2013
+    def self.get()
+      self.fetch
+    end
+  end
+end

data/lib/tmdby/wrappers/credits.rb

@@ -0,0 +1,13 @@
+module Tmdby
+  class Credits < Wrapper
+
+    @root = 'credit'
+
+    # Get the detailed information about a particular credit record
+    def self.get(credit_id, optional_params = {})
+      self.fetch credit_id,
+                  optional_params,
+                  authorized_params: ["language"]
+    end
+  end
+end

data/lib/tmdby/wrappers/discover.rb

@@ -0,0 +1,27 @@
+module Tmdby
+  class Discover < Wrapper
+
+    @root = "discover"
+
+    # Discover movies by different types of data like average rating, number of votes, genres and certifications.
+    def self.movie(optional_params = {})
+      self.fetch "movie",
+                  optional_params,
+                  authorized_params: [  "certification_country", "certification", "certification.lte", "include_adult", "include_video",
+                                        "language", "page", "primary_release_year", "primary_release_date.gte", "primary_release_date.lte",
+                                        "release_date.gte", "release_date.lte", "sort_by", "vote_count.gte", "vote_count.lte",
+                                        "vote_average.gte", "vote_average.lte", "with_cast", "with_crew", "with_companies",
+                                        "with_genres", "with_keywords", "with_people", "year"
+                                      ]
+    end
+
+    # Discover TV shows by different types of data like average rating, number of votes, genres, the network they aired on and air dates.
+    def self.tv(optional_params = {})
+      self.fetch "tv",
+                  optional_params,
+                  authorized_params: [  "page", "language", "sort_by", "first_air_date_year", "vote_count.gte",
+                                        "vote_average.gte", "with_genres", "with_networks", "first_air_date.gte", "first_air_date.lte"
+                                      ]
+    end
+  end
+end

data/lib/tmdby/wrappers/find.rb

@@ -0,0 +1,21 @@
+module Tmdby
+  class Find < Wrapper
+
+    @root = 'find'
+
+    # The find method makes it easy to search for objects in our database by an external id
+    #
+    # The supported external sources for each object are as follows:
+    #     Movies: imdb_id
+    #     People: imdb_id, freebase_mid, freebase_id, tvrage_id
+    #     TVSeries: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_id
+    #     TVSeasons: freebase_mid, freebase_id, tvdb_id, tvrage_id
+    #     TVEpisodes: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_id
+    def self.get(id, external_source, optional_params = {})
+      self.fetch id,
+                  optional_params,
+                  external_source: external_source,
+                  authorized_params: ["external_source", "language"]
+    end
+  end
+end

data/lib/tmdby/wrappers/genres.rb

@@ -0,0 +1,27 @@
+module Tmdby
+  class Genres < Wrapper
+
+    @root = "genre"
+
+    # Get the list of movie genres.
+    def self.movie_list(optional_params = {})
+      self.fetch 'movie/list',
+                  optional_params,
+                  authorized_params: ["language"]
+    end
+
+    # Get the list of TV genres.
+    def self.tv_list(optional_params = {})
+      self.fetch 'tv/list',
+                  optional_params,
+                  authorized_params: ["language"]
+    end
+
+    # Get the list of movies for a particular genre by id. By default, only movies with 10 or more votes are included.
+    def self.movies(id, optional_params = {})
+      self.fetch "#{id}/movies",
+                  optional_params,
+                  authorized_params: ["page", "language", "include_all_movies", "include_adult"]
+    end
+  end
+end

data/lib/tmdby/wrappers/guest_sessions.rb

@@ -0,0 +1,13 @@
+module Tmdby
+  class GuestSessions < Wrapper
+
+    @root = "guest_session"
+
+    # Get a list of rated movies for a specific guest session id.
+    def self.rated_movies(guest_session_id, optional_params = {})
+      self.fetch "#{guest_session_id}/rated_movies",
+                  optional_params,
+                  authorized_params: ["page", "language", "sort_by", "sort_order"]
+    end
+  end
+end

data/lib/tmdby/wrappers/jobs.rb

@@ -0,0 +1,11 @@
+module Tmdby
+  class Jobs < Wrapper
+
+    @root = 'job'
+
+    # Get a list of valid jobs
+    def self.list
+      self.fetch "list"
+    end
+  end
+end

data/lib/tmdby/wrappers/keywords.rb

@@ -0,0 +1,18 @@
+module Tmdby
+  class Keywords < Wrapper
+
+    @root = "keyword"
+
+    # Get the basic information for a specific keyword id.
+    def self.get(id)
+      self.fetch id
+    end
+
+    # Get the list of movies for a particular keyword by id.
+    def self.movies(id, optional_params = {})
+      self.fetch "#{id}/movies",
+                  optional_params,
+                  authorized_params: ["page", "language"]
+    end
+  end
+end