tmdb_rexx 0.1.0

data/lib/tmdb_rexx/client/movie.rb

@@ -0,0 +1,271 @@
+module TmdbRexx
+  class Client
+    module Movie
+      RESOURCE = "movie".freeze
+
+      # Get the basic movie information for a specific movie id.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieid
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie api response
+      #   TmdbRexx::Client.movie("movie-id")
+      def movie(movie_id, options = {})
+        get([RESOURCE, movie_id].join("/"), options)
+      end
+
+      # Get the alternative titles for a specific movie id.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidalternativetitles
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie alternative titles api response
+      #   TmdbRexx::Client.movie_alternative_titles("movie-id")
+      def movie_alternative_titles(movie_id, options = {})
+        get([RESOURCE, movie_id, "alternative_titles"].join("/"), options)
+      end
+
+      # Get the cast and crew information for a specific movie id.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/moviecredits
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie credits api response
+      #   TmdbRexx::Client.movie_credits("movie-id")
+      def movie_credits(movie_id, options = {})
+        get([RESOURCE, movie_id, "credits"].join("/"), options)
+      end
+
+      # Get the images (posters and backdrops) for a specific movie id.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieimages
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie images api response
+      #   TmdbRexx::Client.movie_images("movie-id")
+      def movie_images(movie_id, options = {})
+        get([RESOURCE, movie_id, "images"].join("/"), options)
+      end
+
+      # Get the backdrops for a specific movie id.
+      # This is a convenience method base on .movie_images
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie backdrops
+      #   TmdbRexx::Client.movie_backdrops("movie-id")
+      def movie_backdrops(movie_id, options = {})
+        get([RESOURCE, movie_id, "images"].join("/"), options).backdrops
+      end
+
+      # Get the posters for a specific movie id.
+      # This is a convenience method base on .movie_images
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie posters
+      #   TmdbRexx::Client.movie_posters("movie-id")
+      def movie_posters(movie_id, options = {})
+        get([RESOURCE, movie_id, "images"].join("/"), options).posters
+      end
+
+      # Get the plot keywords for a specific movie id.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidkeywords
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie keywords
+      #   TmdbRexx::Client.movie_keywords("movie-id")
+      def movie_keywords(movie_id, options = {})
+        get([RESOURCE, movie_id, "keywords"].join("/"), options)
+      end
+
+      # Get the release date and certification information by country for a specific movie id.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidreleases
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie releases
+      #   TmdbRexx::Client.movie_releases("movie-id")
+      def movie_releases(movie_id, options = {})
+        get([RESOURCE, movie_id, "releases"].join("/"), options)
+      end
+
+      # Get the videos (trailers, teasers, clips, etc...) for a specific movie id.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidvideos
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie videos
+      #   TmdbRexx::Client.movie_videos("movie-id")
+      def movie_videos(movie_id, options = {})
+        get([RESOURCE, movie_id, "videos"].join("/"), options)
+      end
+
+      # Get the translations for a specific movie id.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidtranslations
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie translations
+      #   TmdbRexx::Client.movie_translations("movie-id")
+      def movie_translations(movie_id, options = {})
+        get([RESOURCE, movie_id, "translations"].join("/"), options)
+      end
+
+      # Get the similar movies for a specific movie id.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidsimilar
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the similar movies
+      #   TmdbRexx::Client.similar_movies("movie-id")
+      def similar_movies(movie_id, options = {})
+        get([RESOURCE, movie_id, "similar"].join("/"), options)
+      end
+
+      # Get the reviews for a particular movie id.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidreviews
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie reviews
+      #   TmdbRexx::Client.movie_reviews("movie-id")
+      def movie_reviews(movie_id, options = {})
+        get([RESOURCE, movie_id, "reviews"].join("/"), options)
+      end
+
+      # Get the lists that the movie belongs to.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidlists
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie lists
+      #   TmdbRexx::Client.movie_lists("movie-id")
+      def movie_lists(movie_id, options = {})
+        get([RESOURCE, movie_id, "lists"].join("/"), options)
+      end
+
+      # Get the changes made to the movie.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidchanges
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie changes
+      #   TmdbRexx::Client.movie_changes("movie-id")
+      def movie_changes(movie_id, options = {})
+        get([RESOURCE, movie_id, "changes"].join("/"), options)
+      end
+
+      # Get the latest movie id.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidlatest
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movie latest
+      #   TmdbRexx::Client.latest_movie("movie-id")
+      def latest_movie(movie_id, options = {})
+        get([RESOURCE, "latest"].join("/"), options)
+      end
+
+      # Get the list of movies playing that have been, or are being released this week. This list refreshes every day.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidnow_playing
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movies now_playing
+      #   TmdbRexx::Client.now_playing("movie-id")
+      def now_playing(movie_id, options = {})
+        get([RESOURCE, "now_playing"].join("/"), options)
+      end
+
+      # Get the list of popular movies on The Movie Database. This list refreshes every day.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidpopular
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movies popular_movies
+      #   TmdbRexx::Client.popular_movies("movie-id")
+      def popular_movies(movie_id, options = {})
+        get([RESOURCE, "popular"].join("/"), options)
+      end
+
+      # Get the list of top_rated movies on The Movie Database. This list refreshes every day.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidtoprated
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movies top rated
+      #   TmdbRexx::Client.top_rated_movies("movie-id")
+      def top_rated_movies(movie_id, options = {})
+        get([RESOURCE, "top_rated"].join("/"), options)
+      end
+
+      # Get the list of movies playing that have been, or are being released this week. This list refreshes every day.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/movies/movieidupcoming
+      #
+      # @param [String] id the movie id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the movies upcoming
+      #   TmdbRexx::Client.upcoming("movie-id")
+      def upcoming(movie_id, options = {})
+        get([RESOURCE, "upcoming"].join("/"), options)
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/client/network.rb

@@ -0,0 +1,23 @@
+module TmdbRexx
+  class Client
+    module Network
+      RESOURCE = "network".freeze
+
+      # This method is used to retrieve the basic information about a TV
+      # network. You can use this ID to search for TV shows with the discover.
+      # At this time we don't have much but this will be fleshed out over time.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/networks
+      #
+      # @param [String] id the network id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the network api response
+      #   TmdbRexx::Client.network("network-id")
+      def network(network_id, options = {})
+        get([RESOURCE, network_id].join("/"), options)
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/client/review.rb

@@ -0,0 +1,21 @@
+module TmdbRexx
+  class Client
+    module Review
+      RESOURCE = "review".freeze
+
+      # Get the full details of a review by ID.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/reviewid
+      #
+      # @param [String] id the review id
+      #
+      # @return [Hashie::Mash] build response
+      #
+      # @example Get the review api response
+      #   TmdbRexx::Client.review("review-id")
+      def review(review_id, options = {})
+        get([RESOURCE, review_id].join("/"), options)
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/client/timezone.rb

@@ -0,0 +1,21 @@
+module TmdbRexx
+  class Client
+    module Timezone
+      RESOURCE = "timezones".freeze
+
+      # Get the list of supported timezones for the API
+      # methods that support them.
+      #
+      # @see
+      # http://docs.themoviedb.apiary.io/#reference/movies/timezones
+      #
+      # @return [Hashie::Mash] response
+      #
+      # @example Get the timezones api response
+      #   client.timezones
+      def timezones(options = {})
+        get([RESOURCE, "list"].join("/"), options)
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/client.rb

@@ -0,0 +1,55 @@
+# Core
+require 'tmdb_rexx/error'
+require 'tmdb_rexx/connection'
+require 'tmdb_rexx/default'
+require 'tmdb_rexx/request'
+# Client
+require 'tmdb_rexx/client/movie'
+require 'tmdb_rexx/client/certification'
+require 'tmdb_rexx/client/changes'
+require 'tmdb_rexx/client/collection'
+require 'tmdb_rexx/client/company'
+require 'tmdb_rexx/client/credit'
+require 'tmdb_rexx/client/discover'
+require 'tmdb_rexx/client/find'
+require 'tmdb_rexx/client/genre'
+require 'tmdb_rexx/client/job'
+require 'tmdb_rexx/client/keyword'
+require 'tmdb_rexx/client/network'
+require 'tmdb_rexx/client/review'
+require 'tmdb_rexx/client/timezone'
+
+module TmdbRexx
+  class Client
+    # Core
+    include TmdbRexx::Connection
+    include TmdbRexx::Default
+    include TmdbRexx::Request
+    # Client
+    include TmdbRexx::Client::Movie
+    include TmdbRexx::Client::Certification
+    include TmdbRexx::Client::Changes
+    include TmdbRexx::Client::Collection
+    include TmdbRexx::Client::Company
+    include TmdbRexx::Client::Credit
+    include TmdbRexx::Client::Discover
+    include TmdbRexx::Client::Find
+    include TmdbRexx::Client::Genre
+    include TmdbRexx::Client::Job
+    include TmdbRexx::Client::Keyword
+    include TmdbRexx::Client::Network
+    include TmdbRexx::Client::Review
+    include TmdbRexx::Client::Timezone
+
+    def initialize(options = {})
+      TmdbRexx::Configuration.keys.each do |key|
+        instance_variable_set(
+          :"@#{key}", options[key] ||
+          TmdbRexx.instance_variable_get(:"@#{key}")
+        )
+      end
+
+      raise TmdbRexx::MissingAPIKeyError if @api_key.nil? || @api_key.empty?
+    end
+  end
+end

data/lib/tmdb_rexx/configuration.rb

@@ -0,0 +1,38 @@
+module TmdbRexx
+  module Configuration
+    VALID_OPTION_KEYS = %i(api_key base_url version include_adult language).freeze
+
+    #attr_accessor(*VALID_OPTION_KEYS)
+    attr_accessor :api_key, :base_url, :version, :include_adult, :language
+
+    class << self
+      def keys
+        @keys ||= VALID_OPTION_KEYS
+      end
+    end
+
+    def configure
+      yield self
+    end
+
+    # Reset configuration options to default values
+    def reset!
+      TmdbRexx::Configuration.keys.each do |key|
+        instance_variable_set(:"@#{key}", TmdbRexx::Default.options[key])
+      end
+      self
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+
+    private
+
+    def options
+      Hash[TmdbRexx::Configuration.keys.map{|key|
+        [key, instance_variable_get(:"@#{key}")]
+      }]
+    end
+  end
+end

data/lib/tmdb_rexx/connection.rb

@@ -0,0 +1,15 @@
+require "json"
+require "faraday_middleware"
+
+module TmdbRexx
+  module Connection
+    def connection(options = {})
+      Faraday.new(options) do |build|
+        build.request :url_encoded
+        build.response :mashify
+        build.response :json, :content_type => /\bjson$/
+        build.adapter  Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/default.rb

@@ -0,0 +1,53 @@
+module TmdbRexx
+  # Default configuration for {Client}
+  module Default
+    BASE_URL = "https://api.themoviedb.org".freeze
+    VERSION = 3
+    INCLUDE_ADULT = false
+    LANGUAGE = "en".freeze
+
+    # Default API endpoint built from the base url and version
+    # @return [String]
+    def api_endpoint
+      "#{@base_url}/#{@version}"
+    end
+
+    class << self
+      # Configuration options
+      # @return [Hash]
+      def options
+        Hash[TmdbRexx::Configuration.keys.map{|key| [key, send(key)]}]
+      end
+
+      # Default api_key key from ENV
+      # @return [String]
+      def api_key
+        ENV['MOVIEREXX_API_KEY'] || @api_key
+      end
+
+      # Default API base_url from ENV or {API_BASE_URL}
+      # @return [String]
+      def base_url
+        ENV['MOVIEREXX_BASE_URL'] || @base_url || BASE_URL
+      end
+
+      # Default API version from ENV or {API_VERSION}
+      # @return [String]
+      def version
+        ENV['MOVIEREXX_VERSION'] || @version || VERSION
+      end
+
+      # Default include_adult from ENV or {INCLUDE_ADULT}
+      # @return [String]
+      def include_adult
+        ENV['MOVIEREXX_INCLUDE_ADULT'] || @include_adult || INCLUDE_ADULT
+      end
+
+      # Default language from ENV or {LANGUAGE}
+      # @return [String]
+      def language
+        ENV['MOVIEREXX_LANGUAGE'] || @language || LANGUAGE
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/error.rb

@@ -0,0 +1,6 @@
+module TmdbRexx
+  class InvalidAPIKeyError < StandardError; end
+  class MissingAPIKeyError < StandardError; end
+  class InvalidTypeError < StandardError; end
+  class InvalidExternalSourceError < StandardError; end
+end

data/lib/tmdb_rexx/request.rb

@@ -0,0 +1,39 @@
+module TmdbRexx
+  module Request
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+
+    def put(path, options = {})
+      request(:put, path, options)
+    end
+
+    def delete(path, options = {})
+      request(:delete, path, options)
+    end
+
+    def last_response
+      @last_response if defined? @last_response
+    end
+
+    private
+    def request(method, path, options = {})
+      url = options.delete(:api_endpoint) || api_endpoint
+
+      connection_options = {
+        :url => url
+      }
+
+      @last_response = response = connection(connection_options).send(method) do |request|
+        request.url(path, options)
+        request.params['api_key'] = @api_key
+      end
+
+      response.body
+    end
+  end
+end

data/lib/tmdb_rexx/version.rb

@@ -0,0 +1,3 @@
+module TmdbRexx
+  VERSION = "0.1.0"
+end

data/lib/tmdb_rexx.rb

@@ -0,0 +1,15 @@
+require "tmdb_rexx/version"
+require "tmdb_rexx/configuration"
+require "tmdb_rexx/client"
+
+module TmdbRexx
+  class << self
+    include TmdbRexx::Configuration
+
+    # Alias for TmdbRexx::Client.new
+    # @return [TmdbRexx::Client]
+    def new(options = {})
+      TmdbRexx::Client.new(options)
+    end
+  end
+end

data/tmdb_rexx.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tmdb_rexx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tmdb_rexx"
+  spec.version       = TmdbRexx::VERSION
+  spec.authors       = ["Jason Truluck"]
+  spec.email         = ["jason.truluck@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for TMDB API}
+  spec.description   = %q{Ruby wrapper for TMDB API}
+  spec.homepage      = "https://github.com/FilmRexx/tmdb_rexx"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware", "~> 0.10"
+  spec.add_dependency "hashie", "~> 3.4"
+  spec.add_dependency 'multi_json', "~> 1.11"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "json_spec", "~> 1.1"
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "webmock", "~> 1.21"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+end