themoviedb 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 166055b6cba5ab74aa7f8959d58f0efd12f908ff
-  data.tar.gz: bb037509ef8cde00343b786f92cdf3a048669aab
+SHA256:
+  metadata.gz: dfa53da968e8f3a8677c560d6fa37b61c49ac98fa255d199cd5eb5447cb78dfc
+  data.tar.gz: bc66fd583f7bfa9ef7c6f22cd89a1a8eb3ba98f7c570ed97bcf17c3423559004
 SHA512:
-  metadata.gz: ccf100be48cedee1cc87887f05a15747302b1fdd1ea7dde14090542f7cff16521401cec4adecd0e7903ae77722021a90691ac936b79da5b3bce03fc7fefc8444
-  data.tar.gz: ba5b785ec47a6e9f026377281b2753c450ed425656a63dcdbb23e00e048250875056a6799a48ec80a7ad2f38b1781bd5fdebc5f4c7f68738159df4e8d854c4ee
+  metadata.gz: e74d886d5af9bb982d5451c3328d8fe939547eef1f9a8e479941604c44aa4907ea4f304571c24a679f5edb8a8f7356cb1e7c5a1fd9df2b3c0d11217fa2e00304
+  data.tar.gz: 9e17d6f2d762b4f9ecddce6668dceecb755770f4b3a4b1dc901fa15468c9e897ff12599d4a66de90ef5a5eebed34b241aa861ee116f662d1d7b17f2f50f370c8

data/README.md

@@ -1,10 +1,10 @@
-## Information
+# themoviedb
 
-### themoviedb [![Code Climate](https://codeclimate.com/github/ahmetabdi/themoviedb/badges/gpa.svg)](https://codeclimate.com/github/ahmetabdi/themoviedb) [![Build Status](https://travis-ci.org/ahmetabdi/themoviedb.png?branch=master)](https://travis-ci.org/ahmetabdi/themoviedb) [![Gem Version](https://badge.fury.io/rb/themoviedb.png)](http://badge.fury.io/rb/themoviedb)
+[![Code Climate](https://codeclimate.com/github/ahmetabdi/themoviedb/badges/gpa.svg)](https://codeclimate.com/github/ahmetabdi/themoviedb) [![Gem Version](https://badge.fury.io/rb/themoviedb.png)](http://badge.fury.io/rb/themoviedb)
 
 A Ruby wrapper for the [The Movie Database API](http://docs.themoviedb.apiary.io/).
 
-Ruby >= 1.9.3
+`Ruby >= 3.1`
 
 Provides a simple, easy to use interface for the Movie Database API.
 
@@ -78,7 +78,7 @@ Tmdb::Genre.find("drama")
 
 ### Usage
 
-resources => person, movie, tv, collection, company
+resources => person, movie, tv, collection, company, multi
 
 ```ruby
 @search = Tmdb::Search.new
@@ -198,6 +198,11 @@ Get the cast information for a specific movie id.
 ```ruby
 Tmdb::Movie.casts(22855)
 ```
+#### Movie - Crew
+Get the crew information for a specific movie id.
+```ruby
+Tmdb::Movie.crew(22855)
+```
 #### Movie - Keywords
 Get the plot keywords for a specific movie id.
 ```ruby
@@ -442,7 +447,7 @@ Tmdb::Job.list
 
 themoviedb - A ruby wrapper for the movie database API
 
-Copyright (C) 2014  Ahmet Abdi
+Copyright (C) 2024  Ahmet Abdi
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License

data/lib/themoviedb/api.rb

@@ -1,10 +1,11 @@
 module Tmdb
+  class InvalidApiKeyError < StandardError ;  end
   class Api
     include HTTParty
-    base_uri 'api.themoviedb.org/3/'
+    base_uri "api.themoviedb.org/3/"
     format :json
-    headers 'Accept' => 'application/json'
-    headers 'Content-Type' => 'application/json'
+    headers "Accept" => "application/json"
+    headers "Content-Type" => "application/json"
 
     def self.config
       @@config ||= {}
@@ -23,7 +24,7 @@ module Tmdb
     end
 
     def self.etag(etag)
-      headers 'If-None-Match' => '"' + etag + '"'
+      headers "If-None-Match" => '"' + etag + '"'
     end
 
     def self.response
@@ -32,6 +33,8 @@ module Tmdb
 
     def self.set_response(hash)
       @@response = hash
+      # Detect 401 Unauthorized error, which indicates invalid API key
+      raise Tmdb::InvalidApiKeyError if hash["code"].to_i == 401
     end
   end
 end

data/lib/themoviedb/collection.rb

@@ -1,6 +1,6 @@
 module Tmdb
   class Collection < Resource
-    has_resource 'collection', plural: 'collections'
+    has_resource "collection", plural: "collections"
 
     # http://docs.themoviedb.apiary.io/#collections
     @@fields = [

data/lib/themoviedb/company.rb

@@ -1,6 +1,6 @@
 module Tmdb
   class Company < Resource
-    has_resource 'company', plural: 'companies'
+    has_resource "company", plural: "companies"
 
     # http://docs.themoviedb.apiary.io/#companies
     @@fields = [

data/lib/themoviedb/configuration.rb

@@ -2,7 +2,7 @@ module Tmdb
   class Configuration
     def initialize
       @params = {}
-      @resource = '/configuration'
+      @resource = "/configuration"
       self
     end
 
@@ -11,28 +11,28 @@ module Tmdb
     # Simply combine them all and you will have a fully qualified URL. Here’s an example URL:
     # http://cf2.imgobject.com/t/p/w500/8uO0gUM8aNqYLs1OsTBQiXu0fEv.jpg
     def base_url
-      images_config['base_url']
+      images_config["base_url"]
     end
 
     # HTTPS
     def secure_base_url
-      images_config['secure_base_url']
+      images_config["secure_base_url"]
     end
 
     def poster_sizes
-      images_config['poster_sizes']
+      images_config["poster_sizes"]
     end
 
     def backdrop_sizes
-      images_config['backdrop_sizes']
+      images_config["backdrop_sizes"]
     end
 
     def profile_sizes
-      images_config['profile_sizes']
+      images_config["profile_sizes"]
     end
 
     def logo_sizes
-      images_config['logo_sizes']
+      images_config["logo_sizes"]
     end
 
     def fetch_response
@@ -44,7 +44,7 @@ module Tmdb
     private
 
     def images_config
-      @images_config ||= fetch_response['images'] || {}
+      @images_config ||= fetch_response["images"] || {}
     end
   end
 end

data/lib/themoviedb/episode.rb

@@ -1,6 +1,6 @@
 module Tmdb
   class Episode < Resource
-    has_resource 'episode', plural: 'episodes'
+    has_resource "episode", plural: "episodes"
 
     # Get the primary information about a TV episode by combination of a season and episode number.
     def self.detail(id, season, episode, conditions = {})
@@ -12,13 +12,13 @@ module Tmdb
     # Get the TV episode cast credits by combination of season and episode number.
     def self.cast(id, season, episode, _conditions = {})
       search = Tmdb::Search.new("/tv/#{endpoint_id + id.to_s}/season/#{endpoint_id + season.to_s}/#{endpoints[:singular]}/#{endpoint_id + episode.to_s}/credits")
-      search.fetch_response['cast']
+      search.fetch_response["cast"]
     end
 
     # Get the TV episode crew credits by combination of season and episode number.
     def self.crew(id, season, episode, _conditions = {})
       search = Tmdb::Search.new("/tv/#{endpoint_id + id.to_s}/season/#{endpoint_id + season.to_s}/#{endpoints[:singular]}/#{endpoint_id + episode.to_s}/credits")
-      search.fetch_response['crew']
+      search.fetch_response["crew"]
     end
 
     # Get the external ids for a TV episode by comabination of a season and episode number.

data/lib/themoviedb/find.rb

@@ -1,30 +1,30 @@
 module Tmdb
   class Find < Resource
-    has_resource 'find'
+    has_resource "find"
 
     def self.imdb_id(id, _conditions = {})
       search = Tmdb::Search.new("/#{endpoints[:singular]}/#{endpoint_id + id.to_s}")
-      search.fetch_response(external_source: 'imdb_id')
+      search.fetch_response(external_source: "imdb_id")
     end
 
     def self.freebase_mid(id, _conditions = {})
       search = Tmdb::Search.new("/#{endpoints[:singular]}/#{endpoint_id + id.to_s}")
-      search.fetch_response(external_source: 'freebase_mid')
+      search.fetch_response(external_source: "freebase_mid")
     end
 
     def self.freebase_id(id, _conditions = {})
       search = Tmdb::Search.new("/#{endpoints[:singular]}/#{endpoint_id + id.to_s}")
-      search.fetch_response(external_source: 'freebase_id')
+      search.fetch_response(external_source: "freebase_id")
     end
 
     def self.tvrage_id(id, _conditions = {})
       search = Tmdb::Search.new("/#{endpoints[:singular]}/#{endpoint_id + id.to_s}")
-      search.fetch_response(external_source: 'tvrage_id')
+      search.fetch_response(external_source: "tvrage_id")
     end
 
     def self.tvdb_id(id, _conditions = {})
       search = Tmdb::Search.new("/#{endpoints[:singular]}/#{endpoint_id + id.to_s}")
-      search.fetch_response(external_source: 'tvdb_id')
+      search.fetch_response(external_source: "tvdb_id")
     end
   end
 end

data/lib/themoviedb/genre.rb

@@ -20,7 +20,7 @@ module Tmdb
     end
 
     def self.search(query)
-      detail(list['genres'].detect { |g| g['name'] == query }['id'])
+      detail(list["genres"].detect { |g| g["name"] == query }["id"])
     end
 
     class << self
@@ -28,17 +28,17 @@ module Tmdb
     end
 
     def self.list
-      search = Tmdb::Search.new('/genre/list')
+      search = Tmdb::Search.new("/genre/list")
       search.fetch_response
     end
 
     def self.detail(id, conditions = {})
       url = "/genre/#{id}/movies"
       unless conditions.empty?
-        url << '?'
+        url << "?"
         conditions.each_with_index do |(key, value), index|
           url << "#{key}=#{value}"
-          url << '&' if index != conditions.length - 1
+          url << "&" if index != conditions.length - 1
         end
       end
       search = Tmdb::Search.new(url)
@@ -46,7 +46,7 @@ module Tmdb
     end
 
     def name
-      @name ||= self.class.list['genres'].detect { |g| g['id'] == @id }['name']
+      @name ||= self.class.list["genres"].detect { |g| g["id"] == @id }["name"]
     end
 
     def get_page(page_number, conditions = {})

data/lib/themoviedb/job.rb

@@ -17,7 +17,7 @@ module Tmdb
     end
 
     def self.list
-      search = Tmdb::Search.new('/job/list')
+      search = Tmdb::Search.new("/job/list")
       search.fetch_response
     end
   end

data/lib/themoviedb/keyword.rb

@@ -0,0 +1,20 @@
+module Tmdb
+  class Keyword < Resource
+    has_resource "keyword", plural: "keywords"
+
+    # http://docs.themoviedb.apiary.io/#keywords
+    @@fields = [
+      :id,
+      :name
+    ]
+
+    @@fields.each do |field|
+      attr_accessor field
+    end
+
+    def self.movies(id, _conditions = {})
+      search = Tmdb::Search.new("/#{endpoints[:singular]}/#{endpoint_id + id.to_s}/movies")
+      search.fetch.collect { |result| Tmdb::Movie.new(result) }
+    end
+  end
+end

data/lib/themoviedb/movie.rb

@@ -1,6 +1,6 @@
 module Tmdb
   class Movie < Resource
-    has_resource 'movie', plural: 'movies'
+    has_resource "movie", plural: "movies"
 
     # http://docs.themoviedb.apiary.io/#movies
     @@fields = [
@@ -12,6 +12,7 @@ module Tmdb
       :homepage,
       :id,
       :imdb_id,
+      :original_language,
       :original_title,
       :overview,
       :popularity,
@@ -45,37 +46,37 @@ module Tmdb
 
     # Get the latest movie id. singular
     def self.latest
-      search = Tmdb::Search.new('/movie/latest')
+      search = Tmdb::Search.new("/movie/latest")
       new(search.fetch_response)
     end
 
     # Get the list of upcoming movies. This list refreshes every day. The maximum number of items this list will include is 100.
     def self.upcoming
-      search = Tmdb::Search.new('/movie/upcoming')
+      search = Tmdb::Search.new("/movie/upcoming")
       search.fetch.collect { |result| new(result) }
     end
 
     # Get the list of movies playing in theatres. This list refreshes every day. The maximum number of items this list will include is 100.
     def self.now_playing
-      search = Tmdb::Search.new('/movie/now_playing')
+      search = Tmdb::Search.new("/movie/now_playing")
       search.fetch.collect { |result| new(result) }
     end
 
     # Get the list of popular movies on The Movie Database. This list refreshes every day.
     def self.popular
-      search = Tmdb::Search.new('/movie/popular')
+      search = Tmdb::Search.new("/movie/popular")
       search.fetch.collect { |result| new(result) }
     end
 
     # Get the list of top rated movies. By default, this list will only include movies that have 10 or more votes. This list refreshes every day.
     def self.top_rated
-      search = Tmdb::Search.new('/movie/top_rated')
+      search = Tmdb::Search.new("/movie/top_rated")
       search.fetch.collect { |result| new(result) }
     end
 
     # Discover movies by different types of data like average rating, number of votes, genres and certifications.
     def self.discover(conditions = {})
-      search = Tmdb::Search.new('/discover/movie')
+      search = Tmdb::Search.new("/discover/movie")
       search.filter(conditions)
       search.fetch.collect { |result| new(result) }
     end
@@ -89,13 +90,13 @@ module Tmdb
     # Get the cast information for a specific movie id.
     def self.casts(id, _conditions = {})
       search = Tmdb::Search.new("/#{endpoints[:singular]}/#{endpoint_id + id.to_s}/casts")
-      search.fetch_response['cast']
+      search.fetch_response["cast"]
     end
 
     # Get the cast information for a specific movie id.
     def self.crew(id, _conditions = {})
       search = Tmdb::Search.new("/#{endpoints[:singular]}/#{endpoint_id + id.to_s}/casts")
-      search.fetch_response['crew']
+      search.fetch_response["crew"]
     end
 
     # Get the images (posters and backdrops) for a specific movie id.
@@ -156,5 +157,10 @@ module Tmdb
       search = Tmdb::Search.new("/#{endpoints[:singular]}/#{endpoint_id + id.to_s}/credits")
       search.fetch_response
     end
+
+    def self.videos(id, _conditions = {})
+      search = Tmdb::Search.new("/#{endpoints[:singular]}/#{endpoint_id + id.to_s}/videos")
+      search.fetch_response
+    end
   end
 end

data/lib/themoviedb/person.rb

@@ -1,6 +1,6 @@
 module Tmdb
   class Person < Resource
-    has_resource 'person', plural: 'people'
+    has_resource "person", plural: "people"
 
     # http://docs.themoviedb.apiary.io/#people
     @@fields = [
@@ -30,8 +30,8 @@ module Tmdb
     def self.popular
       search = Tmdb::Search.new("/#{endpoints[:singular]}/popular")
       search.fetch.collect do |result|
-        next unless result['known_for']
-        result['known_for'] = result['known_for'].collect { |movie| Tmdb::Movie.new(movie) }
+        next unless result["known_for"]
+        result["known_for"] = result["known_for"].collect { |movie| Tmdb::Movie.new(movie) }
         new(result)
       end
     end

data/lib/themoviedb/resource.rb

@@ -8,7 +8,7 @@ module Tmdb
         singular: singular.nil? ? name.downcase.to_s : singular,
         plural: opts[:plural].nil? ? "#{name.downcase}s" : opts[:plural]
       }
-      @@endpoint_id[name.downcase] = opts[:id].nil? ? '' : "#{opts[:id]}-"
+      @@endpoint_id[name.downcase] = opts[:id].nil? ? "" : "#{opts[:id]}-"
     end
 
     def self.endpoints

data/lib/themoviedb/search.rb

@@ -2,7 +2,7 @@ module Tmdb
   class Search
     def initialize(resource = nil)
       @params = {}
-      @resource = resource.nil? ? '/search/movie' : resource
+      @resource = resource.nil? ? "/search/movie" : resource
       self
     end
 
@@ -16,29 +16,31 @@ module Tmdb
       self
     end
 
-    def primary_realease_year(year)
+    def primary_release_year(year)
       @params[:primary_release_year] = year.to_s
       self
     end
 
     def resource(resource)
       @resource = case resource
-                  when 'movie'
-                    '/search/movie'
-                  when 'collection'
-                    '/search/collection'
-                  when 'tv'
-                    '/search/tv'
-                  when 'person'
-                    '/search/person'
-                  when 'list'
-                    '/search/list'
-                  when 'company'
-                    '/search/company'
-                  when 'keyword'
-                    '/search/keyword'
-                  when 'find'
-                    '/find'
+      when "movie"
+                    "/search/movie"
+      when "collection"
+                    "/search/collection"
+      when "tv"
+                    "/search/tv"
+      when "person"
+                    "/search/person"
+      when "list"
+                    "/search/list"
+      when "company"
+                    "/search/company"
+      when "keyword"
+                    "/search/keyword"
+      when "multi"
+        "/search/multi"
+      when "find"
+                    "/find"
       end
       self
     end
@@ -57,7 +59,7 @@ module Tmdb
 
     # Sends back main data
     def fetch
-      fetch_response['results']
+      fetch_response["results"]
     end
 
     # Send back whole response
@@ -69,10 +71,10 @@ module Tmdb
       end
       response = Api.get(@resource, query: options)
 
-      original_etag = response.headers.fetch('etag', '')
+      original_etag = response.headers.fetch("etag", "")
       etag = original_etag.delete('"')
 
-      Api.set_response('code' => response.code, 'etag' => etag)
+      Api.set_response("code" => response.code, "etag" => etag)
       response.to_hash
     end
   end

data/lib/themoviedb/season.rb

@@ -1,6 +1,6 @@
 module Tmdb
   class Season < Resource
-    has_resource 'season', plural: 'seasons'
+    has_resource "season", plural: "seasons"
 
     # Get the primary information about a TV season by its season number.
     def self.detail(id, season, conditions = {})
@@ -12,13 +12,13 @@ module Tmdb
     # Get the cast credits for a TV season by season number.
     def self.cast(id, season, _conditions = {})
       search = Tmdb::Search.new("/tv/#{endpoint_id + id.to_s}/#{endpoints[:singular]}/#{endpoint_id + season.to_s}/credits")
-      search.fetch_response['cast']
+      search.fetch_response["cast"]
     end
 
     # Get the crew credits for a TV season by season number.
     def self.crew(id, season, _conditions = {})
       search = Tmdb::Search.new("/tv/#{endpoint_id + id.to_s}/#{endpoints[:singular]}/#{endpoint_id + season.to_s}/credits")
-      search.fetch_response['crew']
+      search.fetch_response["crew"]
     end
 
     # Get the external ids that we have stored for a TV season by season number.

data/lib/themoviedb/tv.rb

@@ -1,6 +1,6 @@
 module Tmdb
   class TV < Resource
-    has_resource 'tv', plural: 'tv'
+    has_resource "tv", plural: "tv"
 
     # http://docs.themoviedb.apiary.io/#tv
     @@fields = [
@@ -37,19 +37,19 @@ module Tmdb
 
     # Get the list of popular TV shows. This list refreshes every day.
     def self.popular
-      search = Tmdb::Search.new('/tv/popular')
+      search = Tmdb::Search.new("/tv/popular")
       search.fetch.collect { |result| new(result) }
     end
 
     # Get the list of top rated TV shows. By default, this list will only include TV shows that have 2 or more votes. This list refreshes every day.
     def self.top_rated
-      search = Tmdb::Search.new('/tv/top_rated')
+      search = Tmdb::Search.new("/tv/top_rated")
       search.fetch.collect { |result| new(result) }
     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.discover(conditions = {})
-      search = Tmdb::Search.new('/discover/tv')
+      search = Tmdb::Search.new("/discover/tv")
       search.filter(conditions)
       search.fetch.collect { |result| new(result) }
     end
@@ -57,13 +57,13 @@ module Tmdb
     # Get the cast information about a TV series.
     def self.cast(id, _conditions = {})
       search = Tmdb::Search.new("/#{endpoints[:singular]}/#{endpoint_id + id.to_s}/credits")
-      search.fetch_response['cast']
+      search.fetch_response["cast"]
     end
 
     # Get the crew information about a TV series.
     def self.crew(id, _conditions = {})
       search = Tmdb::Search.new("/#{endpoints[:singular]}/#{endpoint_id + id.to_s}/credits")
-      search.fetch_response['crew']
+      search.fetch_response["crew"]
     end
 
     # Get the external ids that we have stored for a TV series.

data/lib/themoviedb/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Tmdb
-  VERSION = '1.0.0'.freeze
+  VERSION = "1.0.2".freeze
 end

data/lib/themoviedb.rb

@@ -1,10 +1,10 @@
-require 'rubygems'
-require 'httparty'
+require "rubygems"
+require "httparty"
 
-%w(api search resource configuration).each do |inc|
-  require File.join(File.dirname(__FILE__), 'themoviedb', inc)
+%w[api search resource configuration].each do |inc|
+  require File.join(File.dirname(__FILE__), "themoviedb", inc)
 end
 
-%w(movie tv season episode collection person company genre find job).each do |inc|
-  require File.join(File.dirname(__FILE__), 'themoviedb', inc)
+%w[movie tv season episode collection person company genre find job keyword].each do |inc|
+  require File.join(File.dirname(__FILE__), "themoviedb", inc)
 end