tmdby 1.0.0

data/lib/tmdby/wrappers/lists.rb

@@ -0,0 +1,67 @@
+module Tmdby
+  class Lists < Wrapper
+
+    @root = "list"
+
+    # Get a list by id.
+    def self.get(id)
+      self.fetch id
+    end
+
+    # Delete a list by id.
+    def self.delete(id, session_id)
+      self.fetch id,
+                  method: "delete",
+                  session_id: session_id,
+                  authorized_params: ["session_id"]
+    end
+
+    # Check to see if a movie ID is already added to a list.
+    def self.item_status(id, movie_id)
+      self.fetch "#{id}/item_status",
+                  movie_id: movie_id,
+                  authorized_params: ["movie_id"]
+    end
+
+    # This method lets users create a new list.
+    def self.new(session_id, name, description, optional_params = {})
+      self.fetch "",
+                  optional_params,
+                  method: 'post',
+                  session_id: session_id,
+                  name: name,
+                  description: description,
+                  post_params: ["name", "description", "language"],
+                  authorized_params: ["session_id", "name", "description", "language"]
+    end
+
+    # This method lets users add new movies to a list that they created.
+    def self.add_item(id, session_id, media_id)
+      self.fetch "#{id}/add_item",
+                  method: 'post',
+                  media_id: media_id,
+                  session_id: session_id,
+                  post_params: ["media_id"],
+                  authorized_params: ["session_id", "media_id"]
+    end
+
+    # This method lets users delete movies from a list that they created.
+    def self.remove_item(id, session_id, media_id)
+      self.fetch "#{id}/remove_item",
+                  method: 'post',
+                  media_id: media_id,
+                  session_id: session_id,
+                  post_params: ["media_id"],
+                  authorized_params: ["session_id", "media_id"]
+    end
+
+    # Clear all of the items within a list.
+    def self.clear(id, session_id, confirm = true)
+      self.fetch "#{id}/clear",
+                  method: 'post',
+                  session_id: session_id,
+                  confirm: confirm,
+                  authorized_params: ["session_id", "confirm"]
+    end
+  end
+end

data/lib/tmdby/wrappers/movies.rb

@@ -0,0 +1,143 @@
+module Tmdby
+  class Movies < Wrapper
+
+    @root = "movie"
+
+    # Get the basic movie information for a specific movie id.
+    def self.get(id, optional_params = {})
+      self.fetch id,
+                  optional_params,
+                  authorized_params: ["language", "append_to_response"]
+    end
+
+    # This method lets a TMDb user account get the status of whether or not the movie has been rated or added to their favourite or movie watch list.
+    def self.account_states(id, session_id)
+      self.fetch "#{id}/account_states",
+                  session_id: session_id,
+                  authorized_params: ["session_id"]
+    end
+
+    # Get the alternative titles for a specific movie id.
+    def self.alternative_titles(id, optional_params = {})
+      self.fetch "#{id}/alternative_titles",
+                  optional_params,
+                  authorized_params: ["country", "append_to_response"]
+    end
+
+    # Get the cast and crew information for a specific movie id.
+    def self.credits(id, optional_params = {})
+      self.fetch "#{id}/credits",
+                  optional_params,
+                  authorized_params: ["append_to_response"]
+    end
+
+    # Get the images (posters and backdrops) for a specific movie id.
+    def self.images(id, optional_params = {})
+      self.fetch "#{id}/images",
+                  optional_params,
+                  authorized_params: ["language", "append_to_response", "include_image_language"]
+    end
+
+    # Get the plot keywords for a specific movie id.
+    def self.keywords(id, optional_params = {})
+      self.fetch "#{id}/keywords",
+                  optional_params,
+                  authorized_params: ["append_to_response"]
+    end
+
+    # Get the release date and certification information by country for a specific movie id.
+    def self.releases(id, optional_params = {})
+      self.fetch "#{id}/releases",
+                  optional_params,
+                  authorized_params: ["append_to_response"]
+    end
+
+    # Get the videos (trailers, teasers, clips, etc...) for a specific movie id.
+    def self.videos(id, optional_params = {})
+      self.fetch "#{id}/videos",
+                  optional_params,
+                  authorized_params: ["language", "append_to_response"]
+    end
+
+    # Get the translations for a specific movie id.
+    def self.translations(id, optional_params = {})
+      self.fetch "#{id}/translations",
+                  optional_params,
+                  authorized_params: ["append_to_response"]
+    end
+
+    # Get the similar movies for a specific movie id.
+    def self.similar(id, optional_params = {})
+      self.fetch "#{id}/similar",
+                  optional_params,
+                  authorized_params: ["page", "language", "append_to_response"]
+    end
+
+    # Get the reviews for a particular movie id.
+    def self.reviews(id, optional_params = {})
+      self.fetch "#{id}/reviews",
+                  optional_params,
+                  authorized_params: ["page", "language", "append_to_response"]
+    end
+
+    # Get the lists that the movie belongs to.
+    def self.lists(id, optional_params = {})
+      self.fetch "#{id}/lists",
+                  optional_params,
+                  authorized_params: ["page", "language", "append_to_response"]
+    end
+
+    # Get the changes for a specific movie id.
+    def self.changes(id, optional_params = {})
+      self.fetch "#{id}/changes",
+                  optional_params,
+                  authorized_params: ["start_date", "end_date"]
+    end
+
+    # This method lets users rate a movie.
+    def self.rating(id, value, session_id, guest_session_id = nil)
+      self.fetch "#{id}/rating",
+                  method: 'post',
+                  value: value,
+                  session_id: session_id,
+                  guest_session_id: guest_session_id,
+                  post_params: ["value"],
+                  authorized_params: ["session_id", "guest_session_id", "value"]
+    end
+
+    # Get the latest movie id.
+    def self.latest
+      self.fetch "latest"
+    end
+
+    # Get the list of upcoming movies by release date.
+    def self.upcoming(optional_params = {})
+      self.fetch "upcoming",
+                  optional_params,
+                  authorized_params: ["page", "language"]
+    end
+
+    # Get the list of movies playing that have been, or are being released this week.
+    def self.now_playing(optional_params = {})
+      self.fetch "now_playing",
+                  optional_params,
+                  authorized_params: ["page", "language"]
+    end
+
+    # Get the list of popular movies on The Movie Database.
+    def self.popular(optional_params = {})
+      self.fetch "popular",
+                  optional_params,
+                  authorized_params: ["page", "language"]
+    end
+
+    # Get the list of top rated movies.
+    def self.top_rated(optional_params = {})
+      self.fetch "top_rated",
+                  optional_params,
+                  authorized_params: ["page", "language"]
+    end
+
+
+  end
+end

data/lib/tmdby/wrappers/networks.rb

@@ -0,0 +1,11 @@
+module Tmdby
+  class Networks < Wrapper
+
+    @root = "network"
+
+    # This method is used to retrieve the basic information about a TV network
+    def self.get(id)
+        self.fetch id
+    end
+  end
+end

data/lib/tmdby/wrappers/people.rb

@@ -0,0 +1,71 @@
+module Tmdby
+  class People < Wrapper
+
+    @root = "person"
+
+    # Get the general person information for a specific id.
+    def self.get(id, optional_params = {})
+      self.fetch id,
+                  optional_params,
+                  authorized_params: ["append_to_response"]
+    end
+
+    # Get the movie credits for a specific person id.
+    def self.movie_credits(id, optional_params = {})
+      self.fetch "#{id}/movie_credits",
+                  optional_params,
+                  authorized_params: ["language", "append_to_response"]
+    end
+
+    # Get the TV credits for a specific person id.
+    def self.tv_credits(id, optional_params = {})
+      self.fetch "#{id}/tv_credits",
+                  optional_params,
+                  authorized_params: ["language", "append_to_response"]
+    end
+
+    # Get the combined (movie and TV) credits for a specific person id.
+    def self.combined_credits(id, optional_params = {})
+      self.fetch "#{id}/combined_credits",
+                  optional_params,
+                  authorized_params: ["language", "append_to_response"]
+    end
+
+    # Get the external ids for a specific person id.
+    def self.external_ids(id)
+      self.fetch "#{id}/external_ids"
+    end
+
+    # Get the images for a specific person id.
+    def self.images(id)
+      self.fetch "#{id}/images"
+    end
+
+    # Get the images that have been tagged with a specific person id.
+    def self.tagged_images(id, optional_params = {})
+      self.fetch "#{id}/tagged_images",
+                  optional_params,
+                  authorized_params: ["language", "page"]
+    end
+
+    # Get the changes for a specific person id.
+    def self.changes(id, optional_params = {})
+      self.fetch "#{id}/changes",
+                  optional_params,
+                  authorized_params: ["start_date", "end_date"]
+    end
+
+    # Get the list of popular people on The Movie Database.
+    def self.popular(optional_params = {})
+      self.fetch "popular",
+                  optional_params,
+                  authorized_params: ["page"]
+    end
+
+    # Get the latest person id.
+    def self.latest
+      self.fetch "latest"
+    end
+
+  end
+end

data/lib/tmdby/wrappers/reviews.rb

@@ -0,0 +1,11 @@
+module Tmdby
+  class Reviews < Wrapper
+
+    @root = "review"
+
+    # Get the full details of a review by ID
+    def self.get(id)
+      self.fetch id
+    end
+  end
+end

data/lib/tmdby/wrappers/search.rb

@@ -0,0 +1,71 @@
+module Tmdby
+  class Search < Wrapper
+
+    @root = "search"
+
+    # Search for companies by name.
+    def self.company(query, optional_params = {})
+      self.fetch "company",
+                  optional_params,
+                  query: query,
+                  authorized_params: ["query", "page"]
+    end
+
+    # Search for collections by name.
+    def self.collection(query, optional_params = {})
+      self.fetch "collection",
+                  optional_params,
+                  query: query,
+                  authorized_params: ["query", "page", "language"]
+    end
+
+    # Search for keywords by name.
+    def self.keyword(query, optional_params = {})
+      self.fetch "keyword",
+                  optional_params,
+                  query: query,
+                  authorized_params: ["query", "page"]
+    end
+
+    # Search for lists by name and description.
+    def self.list(query, optional_params = {})
+      self.fetch "list",
+                  optional_params,
+                  query: query,
+                  authorized_params: ["query", "page", "include_adult"]
+    end
+
+    # Search for movies by title.
+    def self.movie(query, optional_params = {})
+      self.fetch "movie",
+                  optional_params,
+                  query: query,
+                  authorized_params: ["query", "page", "language", "include_adult", "year", "primary_release_year", "search_type"]
+    end
+
+    # Search the movie, tv show and person collections with a single query.
+    def self.multi(query, optional_params = {})
+      self.fetch "multi",
+                  optional_params,
+                  query: query,
+                  authorized_params: ["query", "page", "language", "include_adult"]
+    end
+
+    # Search for people by name.
+    def self.person(query, optional_params = {})
+      self.fetch "person",
+                  optional_params,
+                  query: query,
+                  authorized_params: ["query", "page", "include_adult", "search_type"]
+    end
+
+    # Search for TV shows by title.
+    def self.tv(query, optional_params = {})
+      self.fetch "tv",
+                  optional_params,
+                  query: query,
+                  authorized_params: ["query", "page", "language", "first_aid_date_year", "search_type"]
+    end
+
+  end
+end

data/lib/tmdby/wrappers/timezones.rb

@@ -0,0 +1,11 @@
+module Tmdby
+  class Timezones < Wrapper
+
+    @root = "timezones"
+
+    # Get the list of supported timezones for the API methods that support them
+    def self.list
+      self.fetch "list"
+    end
+  end
+end

data/lib/tmdby/wrappers/tv.rb

@@ -0,0 +1,131 @@
+module Tmdby
+  class Tv < Wrapper
+
+    @root = "tv"
+
+    # Get the primary information about a TV series by id.
+    def self.get(id, optional_params = {})
+      self.fetch id,
+                  optional_params,
+                  authorized_params: ["language", "append_to_response"]
+    end
+
+    # This method lets users get the status of whether or not the TV show has been rated or added to their favourite or watch lists.
+    def self.account_states(id, session_id)
+      self.fetch "#{id}/account_states",
+                  session_id: session_id,
+                  authorized_params: ["session_id"]
+    end
+
+    # Get the alternative titles for a specific show ID.
+    def self.alternative_titles(id, optional_params = {})
+      self.fetch "#{id}/alternative_titles",
+                  optional_params,
+                  authorized_params: ["country", "append_to_response"]
+    end
+
+    # Get the changes for a specific TV show id.
+    def self.changes(id, optional_params = {})
+      self.fetch "#{id}/changes",
+                  optional_params,
+                  authorized_params: ["start_date", "end_date"]
+    end
+
+    # Get the content ratings for a specific TV show id.
+    def self.content_ratings(id)
+      self.fetch "#{id}/content_ratings"
+    end
+
+    # Get the cast & crew information about a TV series.
+    def self.credits(id, optional_params = {})
+      self.fetch "#{id}/credits",
+                  optional_params,
+                  authorized_params: ["append_to_response"]
+    end
+
+    # Get the external ids that we have stored for a TV series.
+    def self.external_ids(id, optional_params = {})
+      self.fetch "#{id}/external_ids",
+                  optional_params,
+                  authorized_params: ["language"]
+    end
+
+    # Get the images (posters and backdrops) for a TV series.
+    def self.images(id, optional_params = {})
+      self.fetch "#{id}/images",
+                  optional_params,
+                  authorized_params: ["language", "include_image_language"]
+    end
+
+    # Get the plot keywords for a specific TV show id.
+    def self.keywords(id, optional_params = {})
+      self.fetch "#{id}/keywords",
+                  optional_params,
+                  authorized_params: ["append_to_response"]
+    end
+
+    # This method lets users rate a TV show.
+    def self.rating(id, value, session_id, guest_session_id = nil)
+      self.fetch "#{id}/rating",
+                  method: 'post',
+                  value: value,
+                  session_id: session_id,
+                  guest_session_id: guest_session_id,
+                  post_params: ["value"],
+                  authorized_params: ["session_id", "guest_session_id", "value"]
+    end
+
+    # Get the similar TV shows for a specific tv id.
+    def self.similar(id, optional_params = {})
+      self.fetch "#{id}/similar",
+                  optional_params,
+                  authorized_params: ["page", "language", "append_to_response"]
+    end
+
+    # Get the list of translations that exist for a TV series.
+    def self.translations(id)
+      self.fetch "#{id}/translations"
+    end
+
+    # Get the videos that have been added to a TV series (trailers, opening credits, etc...)
+    def self.videos(id, optional_params = {})
+      self.fetch "#{id}/videos",
+                  optional_params,
+                  authorized_params: ["language"]
+    end
+
+    # Get the latest TV show id.
+    def self.latest
+      self.fetch "latest"
+    end
+
+    # Get the list of TV shows that are currently on the air.
+    def self.on_the_air(optional_params = {})
+      self.fetch "on_the_air",
+                  optional_params,
+                  authorized_params: ["page", "language"]
+    end
+
+    # Get the list of TV shows that air today.
+    def self.airing_today(optional_params = {})
+      self.fetch "airing_today",
+                  optional_params,
+                  authorized_params: ["page", "language", "timezone"]
+    end
+
+    # Get the list of top rated TV shows.
+    def self.top_rated(optional_params = {})
+      self.fetch "top_rated",
+                  optional_params,
+                  authorized_params: ["page", "language"]
+    end
+
+    # Get the list of popular TV shows.
+    def self.popular(optional_params = {})
+      self.fetch "popular",
+                  optional_params,
+                  authorized_params: ["page", "language"]
+    end
+
+  end
+end

data/lib/tmdby/wrappers/tv_episodes.rb

@@ -0,0 +1,63 @@
+module Tmdby
+  class TvEpisodes < Wrapper
+
+    @root = "tv"
+
+    # Get the primary information about a TV episode by combination of a season and episode number.
+    def self.get(id, season_number, episode_number, optional_params = {})
+      self.fetch "#{id}/season/#{season_number}/episode/#{episode_number}",
+                  optional_params,
+                  authorized_params: ["language", "append_to_response"]
+    end
+
+    # Look up a TV episode's changes by episode ID.
+    def self.changes(id, optional_params = {})
+      self.fetch "episode/#{id}/changes",
+                  optional_params,
+                  authorized_params: ["start_date", "end_date"]
+    end
+
+    # This method lets users get the status of whether or not the TV episode has been rated.
+    def self.account_states(id, season_number, episode_number, session_id)
+      self.fetch "#{id}/season/#{season_number}/episode/#{episode_number}/account_states",
+                  session_id: session_id,
+                  authorized_params: ["session_id"]
+    end
+
+    # Get the TV episode credits by combination of season and episode number.
+    def self.credits(id, season_number, episode_number)
+      self.fetch "#{id}/season/#{season_number}/episode/#{episode_number}/credits"
+    end
+
+    # Get the external ids for a TV episode by comabination of a season and episode number.
+    def self.external_ids(id, season_number, episode_number, optional_params = {})
+      self.fetch "#{id}/season/#{season_number}/episode/#{episode_number}/external_ids",
+                  optional_params,
+                  authorized_params: ["language"]
+    end
+
+    # Get the images (episode stills) for a TV episode by combination of a season and episode number.
+    def self.images(id, season_number, episode_number)
+      self.fetch "#{id}/season/#{season_number}/episode/#{episode_number}/images"
+    end
+
+    # This method lets users rate a TV episode.
+    def self.rating(id, season_number, episode_number, value, session_id, guest_session_id = nil)
+      self.fetch "#{id}/season/#{season_number}/episode/#{episode_number}/rating",
+                  method: 'post',
+                  value: value,
+                  session_id: session_id,
+                  guest_session_id: guest_session_id,
+                  post_params: ["value"],
+                  authorized_params: ["session_id", "guest_session_id", "value"]
+    end
+
+    # Get the videos that have been added to a TV episode (teasers, clips, etc...)
+    def self.videos(id, season_number, episode_number, optional_params = {})
+      self.fetch "#{id}/season/#{season_number}/episode/#{episode_number}/videos",
+                  optional_params,
+                  authorized_params: ["language"]
+    end
+
+  end
+end

data/lib/tmdby/wrappers/tv_seasons.rb

@@ -0,0 +1,54 @@
+module Tmdby
+  class TvSeasons < Wrapper
+
+    @root = "tv"
+
+    # Get the primary information about a TV season by its season number.
+    def self.get(id, season_id, optional_params = {})
+      self.fetch "#{id}/season/#{season_id}",
+                  optional_params,
+                  authorized_params: ["language", "append_to_response"]
+    end
+
+    # Look up a TV season's changes by season ID.
+    def self.changes(id, optional_params = {})
+      self.fetch "season/#{id}/changes",
+                  optional_params,
+                  authorized_params: ["start_date", "end_date"]
+    end
+
+    # This method lets users get the status of whether or not the TV episodes of a season have been rated.
+    def self.account_states(id, season_number, session_id)
+      self.fetch "#{id}/season/#{season_number}/account_states",
+                  session_id: session_id,
+                  authorized_params: ["session_id"]
+    end
+
+    # Get the cast & crew credits for a TV season by season number.
+    def self.credits(id, season_number)
+      self.fetch "#{id}/season/#{season_number}/credits"
+    end
+
+    # Get the primary information about a TV season by its season number.
+    def self.external_ids(id, season_number, optional_params = {})
+      self.fetch "#{id}/season/#{season_number}/external_ids",
+                  optional_params,
+                  authorized_params: ["external_ids"]
+    end
+
+    # Get the images (posters) that we have stored for a TV season by season number.
+    def self.images(id, season_number, optional_params = {})
+      self.fetch "#{id}/season/#{season_number}/images",
+                  optional_params,
+                  authorized_params: ["language", "include_image_language"]
+    end
+
+    # Get the videos that have been added to a TV season (trailers, teasers, etc...)
+    def self.videos(id, season_number, optional_params = {})
+      self.fetch "#{id}/season/#{season_number}/videos",
+                  optional_params,
+                  authorized_params: ["language"]
+    end
+
+  end
+end

data/lib/tmdby.rb

@@ -0,0 +1,47 @@
+require "tmdby/version"
+
+require_relative 'tmdby/wrapper'
+require_relative 'tmdby/client'
+Dir[File.join(File.dirname(__FILE__), 'tmdby', 'wrappers', '*.rb')].each {|file| require file }
+Dir[File.join(File.dirname(__FILE__), 'tmdby', 'helpers', '*.rb')].each {|file| require file }
+
+
+module Tmdby
+  class Setup
+    @@api_key     = nil
+    @@default_language = nil
+    @@api_scheme = 'http'
+
+    # Set TMDB API Key
+    def self.key=(key)
+      @@api_key = key
+    end
+
+    def self.key
+      @@api_key
+    end
+
+    # Set default language
+    def self.default_language=(language)
+      @@default_language = language
+    end
+
+    def self.default_language
+      @@default_language
+    end
+
+    def self.api_scheme
+      @@api_scheme
+    end
+
+    # Set secure mode OFF
+    def self.secure=(secure)
+      @@api_scheme =
+        if not secure
+          'http'
+        else
+          'https'
+        end
+    end
+  end
+end