tmdb_rexx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 525dcc11a067ee90bdd1133e08430ef5e3655f30
+  data.tar.gz: abab56dab01d98a7aeec76e83d1a7022acedeb47
+SHA512:
+  metadata.gz: 4095c3299d8f9c2ab8a1244495ad2ce0ac4512b2ca843a6fed1dccaaafae2dec988a7b5d2865bf41e7c3c8568c70168477310cd59196b9b36f7cc70922dff35b
+  data.tar.gz: 1805a3f11404303dcf32a8d48c9456d016f409aced82373b8e9d52d16573ffe7394700d36894de9cc4a04f3de4f824bf256a6b68e0e4398b7d572884c2f796cf

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+before_install:
+  - gem update bundler
+rvm:
+  - ruby-head
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+  - jruby-head
+addons:
+  code_climate:
+    repo_token: 0e852ef62c6a1a460825a3b6963870f323526253921c0a162a8642bb72ecca82

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in movie_rexx.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jason Truluck
+
+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,64 @@
+# TmdbRexx
+
+[![Build Status](https://travis-ci.org/FilmRexx/tmdb_rexx.svg?branch=master)](https://travis-ci.org/FilmRexx/tmdb_rexx)
+[![Code Climate](https://codeclimate.com/github/FilmRexx/tmdb_rexx/badges/gpa.svg)](https://codeclimate.com/github/FilmRexx/tmdb_rexx)
+[![Test Coverage](https://codeclimate.com/github/FilmRexx/tmdb_rexx/badges/coverage.svg)](https://codeclimate.com/github/FilmRexx/tmdb_rexx/coverage)
+
+This is TmdbRexx a simple wrapper around the TMDB API v3 written in ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tmdb_rexx'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tmdb_rexx
+
+## Documentation
+
+http://rdoc.info/github/FilmRexx/tmdb_rexx/master/index
+
+## Configuration
+
+Configuration allows for specifying TMDB api information
+
+`api_key` - *required* The api key generated by the [TMDB api](https://www.themoviedb.org/documentation/api)
+
+`base_url` - The base url used for querying against the TMDB api. Defaults to `https://api.themoviedb.org`
+
+`version` - The API version to use. Defaults to `3`
+
+`include_adult` - If you would like to include adult films and tv [Boolean]. Defaults to `false`
+
+`language` - The language you would like to have information returned in. Defaults to `en`
+
+Within an initializer `config/initializer/tmdb_rexx.rb`
+
+```ruby
+TmdbRexx.configure do |c|
+  c.api_key = "some_api_key" # Required for functionality
+  c.include_adult = true     # this includes adult films and tv
+  c.language = "fr"          # this changes the language to French where supported
+end
+```
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake` for a baseline test run.
+
+## Contributing
+
+*Make sure to write test!*
+
+1. Fork it ( https://github.com/[my-github-username]/tmdb_rexx/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,11 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "movie_rexx"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tmdb_rexx/client/certification.rb

@@ -0,0 +1,24 @@
+module TmdbRexx
+  class Client
+    module Certification
+      RESOURCE = "certification".freeze
+
+      # Get the list of supported certifications for movies. These can be used
+      # in conjunction with the certification_country and certification.lte
+      # parameters when using discover.
+      #
+      # @see
+      # http://docs.themoviedb.apiary.io/#reference/movies/certificationmovielist
+      #
+      # @param [String] type the resource type you want certifications for
+      #
+      # @return [Hashie::Mash] response
+      #
+      # @example Get the movie certifications api response
+      #   client.certifications("movies")
+      def certifications(type = "movie", options = {})
+        get([RESOURCE, type, "list"].join("/"), options).certifications
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/client/changes.rb

@@ -0,0 +1,32 @@
+module TmdbRexx
+  class Client
+    module Changes
+      RESOURCE = "changes".freeze
+      POSSIBLE_TYPES = ["movie", "person", "tv"].freeze
+
+      # 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. You can then use the movie changes API to get
+      # the actual data that has been changed.
+      #
+      # Please note: the change log system to support this was
+      # changed on October 5, 2012 and will only show movies that
+      # have been edited since.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/changes
+      #
+      # @param [String] type the type of resource to get changes
+      # for. Available options include `movie`, `person`, and `tv`
+      #
+      # @return [Hashie::Mash] changes response
+      #
+      # @example Get the movie changes api response
+      #   TmdbRexx::Client.changes("movie")
+      def changes(type = "movie", options = {})
+        raise InvalidTypeError unless POSSIBLE_TYPES.include?(type)
+        get([type, RESOURCE].join("/"), options)
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/client/collection.rb

@@ -0,0 +1,40 @@
+module TmdbRexx
+  class Client
+    module Collection
+      RESOURCE = "collection".freeze
+
+      # Get the basic collection information for a specific
+      # collection id. You can get the ID needed for this method by
+      # making a /movie/{id} request and paying attention to the
+      # belongs_to_collection hash.Movie parts are not sorted in any
+      # particular order. If you would like to sort them yourself you
+      # can use the provided release_date.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/collections
+      #
+      # @param [String] collection_id the id of the collection
+      #
+      # @return [Hashie::Mash] collections response
+      #
+      # @example Get the collections api response
+      #   TmdbRexx::Client.collection("collection-id")
+      def collection(collection_id, options = {})
+        get([RESOURCE, collection_id].join("/"), options)
+      end
+
+      # Get all of the images for a particular collection by collection id.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/collectionidimages
+      #
+      # @param [String] collection_id the id of the collection
+      #
+      # @return [Hashie::Mash] collections response
+      #
+      # @example Get the images in the collections api response
+      #   TmdbRexx::Client.collection_images("collection-id")
+      def collection_images(collection_id, options = {})
+        get([RESOURCE, collection_id, "images"].join("/"), options)
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/client/company.rb

@@ -0,0 +1,37 @@
+module TmdbRexx
+  class Client
+    module Company
+      RESOURCE = "company".freeze
+
+
+      # This method is used to retrieve all of the basic information about a company.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/companyid
+      #
+      # @param [String] company_id the id of the company
+      #
+      # @return [Hashie::Mash] companyies response
+      #
+      # @example Get the companys api response
+      #   TmdbRexx::Client.company("company-id")
+      def company(company_id, options = {})
+        get([RESOURCE, company_id].join("/"), options)
+      end
+
+
+      # Get the list of movies associated with a particular company.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/companyidmovies
+      #
+      # @param [String] company_id the id of the company
+      #
+      # @return [Hashie::Mash] companies response
+      #
+      # @example Get the movies for the company api response
+      #   TmdbRexx::Client.company_movies("company-id")
+      def company_movies(company_id, options = {})
+        get([RESOURCE, company_id, "movies"].join("/"), options)
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/client/credit.rb

@@ -0,0 +1,28 @@
+module TmdbRexx
+  class Client
+    module Credit
+      RESOURCE = "credit".freeze
+
+      # Get the detailed information about a particular credit record. This is
+      # currently only supported with the new credit model found in TV. These
+      # ids can be found from any TV credit response as well as the tv_credits
+      # and combined_credits methods for people.The episodes object returns a
+      # list of episodes and are generally going to be guest stars. The season
+      # array will return a list of season numbers. Season credits are credits
+      # that were marked with the "add to every season" option in the editing
+      # interface and are assumed to be "season regulars".#
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/credits
+      #
+      # @param [String] credit_id the id for the credits
+      #
+      # @return [Hashie::Mash] credits response
+      #
+      # @example Get the credits api response
+      #   TmdbRexx::Client.credits("movie")
+      def credits(credit_id, options = {})
+        get([RESOURCE, credit_id].join("/"), options)
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/client/discover.rb

@@ -0,0 +1,23 @@
+module TmdbRexx
+  class Client
+    module Discover
+      RESOURCE = "discover".freeze
+
+      # Discover movies and tv shows by different types of data like average
+      # rating, number of votes, genres and certifications. You can get a valid
+      # list of certifications from the /certifications method.
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/discover
+      #
+      # @param [String] type the type to discover for for the discover
+      #
+      # @return [Hashie::Mash] discover response
+      #
+      # @example Get the discover api response
+      #   TmdbRexx::Client.discover("movie", { primary_release_year: 2015 })
+      def discover(type = "movie", options = {})
+        get([RESOURCE, type].join("/"), options)
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/client/find.rb

@@ -0,0 +1,36 @@
+module TmdbRexx
+  class Client
+    module Find
+      RESOURCE = "find".freeze
+      EXTERNAL_SOURCES = ["imdb_id", "freebase_mid", "freebase_id",
+                          "tvrage_id", "tvdb_id"].freeze
+
+      # The find method makes it easy to search for objects in our database by
+      # an external id. For instance, an IMDB ID. This will search all objects
+      # (movies, TV shows and people) and return the results in a single
+      # response.The supported external sources for each object are as
+      # follows:
+      #
+      # * Movies: imdb_id
+      # * People: imdb_id, freebase_mid, freebase_id, tvrage_id
+      # * TV Series: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_id
+      # * TV Seasons: freebase_mid, freebase_id, tvdb_id, tvrage_id
+      # * TV Episodes: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_id
+      #
+      # @see http://docs.themoviedb.apiary.io/#reference/find
+      #
+      # @param [String] external_id the id in the external source
+      # @param [String] external_source the the external source to query
+      #
+      # @return [Hashie::Mash] find response
+      #
+      # @example Get the find api response
+      #   TmdbRexx::Client.find("external-id", "external-source")
+      def find(external_id, external_source = "imdb_id", options = {})
+        raise InvalidExternalSourceError unless EXTERNAL_SOURCES.include?(external_source)
+        options.merge!(external_source: external_source)
+        get([RESOURCE, external_id].join("/"), options)
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/client/genre.rb

@@ -0,0 +1,39 @@
+
+module TmdbRexx
+  class Client
+    module Genre
+      RESOURCE = "genre".freeze
+      POSSIBLE_TYPES = ["movie", "tv"].freeze
+
+      # Get the list of movie or tv genres.
+      #
+      # @see # http://docs.themoviedb.apiary.io/#reference/movies/genres
+      #
+      # @param [String] type the resource type you want genres for
+      #
+      # @return [Hashie::Mash] response
+      #
+      # @example Get the movie genres api response
+      #   client.genres("movie")
+      def genres(type = "movie", options = {})
+        raise InvalidTypeError unless POSSIBLE_TYPES.include?(type)
+        get([RESOURCE, type, "list"].join("/"), options).genres
+      end
+
+      # Get the list of movies for a particular genre by id. By default, only
+      # movies with 10 or more votes are included.
+      #
+      # @see # http://docs.themoviedb.apiary.io/#reference/movies/genremovielist
+      #
+      # @param [String] genre_id the if of the genre to get movies for
+      #
+      # @return [Hashie::Mash] response
+      #
+      # @example Get the movies for the genre api response
+      #   client.genre_movies("genre-id")
+      def genre_movies(genre_id, options = {})
+        get([RESOURCE, genre_id, "movies"].join("/"), options)
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/client/job.rb

@@ -0,0 +1,19 @@
+module TmdbRexx
+  class Client
+    module Job
+      RESOURCE = "job".freeze
+
+      # Get the list of valid jobs
+      #
+      # @see # http://docs.themoviedb.apiary.io/#reference/movies/joblist
+      #
+      # @return [Hashie::Mash] response
+      #
+      # @example Get the jobs api response
+      #   client.jobs
+      def jobs(options = {})
+        get([RESOURCE, "list"].join("/"), options).jobs
+      end
+    end
+  end
+end

data/lib/tmdb_rexx/client/keyword.rb

@@ -0,0 +1,35 @@
+module TmdbRexx
+  class Client
+    module Keyword
+      RESOURCE = "keyword".freeze
+
+      # Get the basic information for a specific keyword id.
+      #
+      # @see # http://docs.themoviedb.apiary.io/#reference/movies/keywordid
+      #
+      # @param [String] keyword_id the id of the keyword to get information about
+      #
+      # @return [Hashie::Mash] response
+      #
+      # @example Get the keyword api response
+      #   client.keyword("keyword-id")
+      def keyword(keyword_id, options = {})
+        get([RESOURCE, keyword_id].join("/"), options)
+      end
+
+      # Get the list of movies for a particular keyword by id.
+      #
+      # @see # http://docs.themoviedb.apiary.io/#reference/movies/keywordidmovies
+      #
+      # @param [String] keyword_id the id of the keyword to get information about
+      #
+      # @return [Hashie::Mash] response
+      #
+      # @example Get the movies for the keyword api response
+      #   client.keyword_movies("keyword-id")
+      def keyword_movies(keyword_id, options = {})
+        get([RESOURCE, keyword_id, "movies"].join("/"), options)
+      end
+    end
+  end
+end