enceladus 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b09cdfa657d7ec3ce55c576659efe6f9333a840
+  data.tar.gz: ae3a1efb9ca54af43cacc201f5f5c5a0b65131ca
+SHA512:
+  metadata.gz: 590d5b2c90c8d7d3461b8c1cf676497fc3e83d9fc102bbfe8624085522ad17739cd306ac6d327c58e0dc165f76375a3531bc8710723141509252dba32c5fd70f
+  data.tar.gz: c28b5c3bf39217ec32f3dd2dbf0d2f6884a3ce837890f2dcb025150b0355744f0a0973540a36f047cb76577a7b0227a7f0a8be3b1ec7742bc76e1567eaf48da4

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+run.rb

data/.rspec

@@ -0,0 +1 @@
+--colour --format doc --order random

data/.ruby-gemset

@@ -0,0 +1 @@
+enceladus

data/.ruby-version

@@ -0,0 +1 @@
+ruby 2.1.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+script: "bundle exec rspec"
+rvm:
+  - 2.1.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Vinicius Osiro
+
+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,36 @@
+# Enceladus
+
+[![Code Climate](https://codeclimate.com/github/osiro/enceladus/badges/gpa.svg)](https://codeclimate.com/github/osiro/enceladus)
+[![Build Status](https://travis-ci.org/osiro/enceladus.svg?branch=master)](https://travis-ci.org/osiro/enceladus)
+[![Coverage Status](https://coveralls.io/repos/osiro/enceladus/badge.png?branch=master)](https://coveralls.io/r/osiro/enceladus?branch=master)
+[![Dependency Status](https://gemnasium.com/osiro/enceladus.svg)](https://gemnasium.com/osiro/enceladus)
+
+A ruby wrapper for [TMDb](www.themoviedb.org).
+
+| [Wiki](https://github.com/osiro/enceladus/wiki) | [Documentation](http://www.rubydoc.info/github/osiro/enceladus/master/frames) |
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'enceladus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enceladus
+
+## Usage
+
+Have a look at some [usage examples](https://github.com/osiro/enceladus/wiki/Usage) and check out the [docs](http://www.rubydoc.info/github/osiro/enceladus/master/frames) too.
+
+## Contributing
+
+1. Fork it ( https://github.com/osiro/enceladus/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/enceladus.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enceladus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enceladus"
+  spec.version       = Enceladus::VERSION
+  spec.authors       = ["Vinicius Osiro"]
+  spec.email         = ["vinicius.osiro@gmail.com"]
+  spec.summary       = "Ruby wrapper for the The Movie Database API v3"
+  spec.description   = "Ruby wrapper for the The Movie Database API for all endpoints of v3"
+  spec.homepage      = "https://github.com/osiro/enceladus"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "rest-client", "~> 1.7.2", '>= 1.7.2'
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.1 "
+  spec.add_development_dependency "byebug", "~> 3.0"
+  spec.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+  spec.add_development_dependency 'webmock', '~> 1.18', '>= 1.18.0'
+  spec.add_development_dependency 'coveralls', '~> 0.7.1', '>= 0.7.0'
+end

data/lib/enceladus/configuration/api.rb

@@ -0,0 +1,60 @@
+require 'singleton'
+require 'uri'
+
+module Enceladus::Configuration
+  class Api
+    include Singleton
+
+    attr_reader :base_url, :version, :api_key
+    attr_accessor :include_adult
+
+    def initialize #:nodoc:#
+      self.base_url = "https://api.themoviedb.org".freeze
+      self.version = "3".freeze
+      self.include_adult = false
+    end
+
+    # Fetches the TMDb account configuration.
+    # This method hits the following TMDb endpoints:
+    # - https://api.themoviedb.org/3/configuration
+    #
+    # Once the request has succeeded, Enceladus will populate the following Enceladus::Configuration::Image attributes:
+    # base_url, secure_base_url, backdrop_sizes, logo_sizes, poster_sizes, profile_sizes and still_sizes.
+    #
+    # A failing request will reset/nullify all those mentioned attributes.
+    #
+    # Return a boolean indicating whether the request has succeeded or not.
+    #
+    # Examples:
+    #
+    #   Enceladus::Configuration::Api.instance.connect("cceebf51cb1f8d707d10a132d9544b76")
+    #
+    def connect(api_key)
+      begin
+        self.api_key = api_key
+        Enceladus::Configuration::Image.instance.setup!
+        true
+      rescue Enceladus::Exception::Api
+        self.api_key = nil
+        Enceladus::Configuration::Image.instance.reset!
+        false
+      end
+    end
+
+    # Returns a string with a URL for one of TMDb API endpoints.
+    # Examples:
+    #
+    #   Enceladus::Configuration::Api.instance.url_for("movies", { term: "Lola Benvenutti" })
+    #   => https://api.themoviedb.org/3/movies?term=Lola+Benvenutti&api_key=token
+    #
+    def url_for(action, params={})
+      params[:api_key] = api_key
+      url = URI.join(base_url, "/#{version}/", action)
+      url.query = URI.encode_www_form(params)
+      url.to_s
+    end
+
+  private
+    attr_writer :base_url, :version, :api_key
+  end
+end

data/lib/enceladus/configuration/image.rb

@@ -0,0 +1,83 @@
+require 'singleton'
+
+module Enceladus::Configuration
+  class Image
+    include Singleton
+
+    attr_reader :base_url, :secure_base_url, :backdrop_sizes, :logo_sizes, :poster_sizes, :profile_sizes, :still_sizes
+    attr_accessor :include_image_language
+
+    def initialize #:nodoc:#
+      reset!
+    end
+
+    # Fetches the TMDb account's configuration data.
+    # This method hits the following TMDb endpoints:
+    # - https://api.themoviedb.org/3/configuration
+    #
+    def setup!
+      configuration = Enceladus::Requester.get("configuration").images
+      self.base_url = configuration.base_url.freeze
+      self.secure_base_url = configuration.secure_base_url.freeze
+      self.backdrop_sizes = configuration.backdrop_sizes.map(&:freeze).freeze
+      self.logo_sizes = configuration.logo_sizes.map(&:freeze).freeze
+      self.poster_sizes = configuration.poster_sizes.map(&:freeze).freeze
+      self.profile_sizes = configuration.profile_sizes.map(&:freeze).freeze
+      self.still_sizes = configuration.still_sizes.map(&:freeze).freeze
+      self
+    end
+
+    # Reset or nullify all image configurations.
+    #
+    def reset!
+      self.base_url = nil
+      self.secure_base_url = nil
+      self.backdrop_sizes = []
+      self.logo_sizes = []
+      self.logo_sizes = []
+      self.poster_sizes = []
+      self.profile_sizes = []
+      self.still_sizes = []
+      self
+    end
+
+    # Returns an array of strings containing URL's for movie/person/tv assets.
+    # Be aware to setup the configuration beforehand, by running:
+    #
+    #   Enceladus::Configuration::Image.instance.setup!
+    #
+    # The following arguments are necessary:
+    # - type: the type of asset you're providing, must be one of "backdrop", "logo", "poster" or "profile".
+    # - image_path: /gWyevEz9NT5tON6kdhxsmfvdJ40.jpg
+    #
+    # Examples:
+    #
+    #   Enceladus::Configuration::Image.instance.url_for("backdrop", )
+    #   => ["http://image.tmdb.org/t/p/w300/gWyevEz9NT5tON6kdhxsmfvdJ40.jpg", "http://image.tmdb.org/t/p/w780/gWyevEz9NT5tON6kdhxsmfvdJ40.jpg", "http://image.tmdb.org/t/p/w1280/gWyevEz9NT5tON6kdhxsmfvdJ40.jpg", "http://image.tmdb.org/t/p/original/gWyevEz9NT5tON6kdhxsmfvdJ40.jpg"]
+    #
+    def url_for(type, image_path)
+      types =  ["backdrop", "logo", "poster", "profile"]
+      raise ArgumentError.new("type must be one of #{types}") unless types.include?(type)
+      return [] if image_path.nil? || image_path.empty? && valid?
+
+      send("#{type}_sizes").map do |size|
+        "#{base_url}#{size}#{image_path}"
+      end
+    end
+
+    # Returns a boolean indicating whether the Image configurations are valid or not.
+    #
+    def valid?
+      !base_url.nil? &&
+      !secure_base_url.nil? &&
+      backdrop_sizes.any? &&
+      logo_sizes.any? &&
+      poster_sizes.any? &&
+      profile_sizes.any? &&
+      still_sizes.any?
+    end
+
+  private
+    attr_writer :base_url, :secure_base_url, :backdrop_sizes, :logo_sizes, :poster_sizes, :profile_sizes, :still_sizes
+  end
+end

data/lib/enceladus/exceptions.rb

@@ -0,0 +1,5 @@
+module Enceladus::Exception
+  class Base < ::Exception; end
+  class Api < Base; end
+  class ArgumentError < Base; end
+end

data/lib/enceladus/models/account.rb

@@ -0,0 +1,143 @@
+class Enceladus::Account < Enceladus::ApiResource
+
+  RESOURCE_ATTRIBUTES = [:id, :include_adult, :iso_3166_1, :iso_639_1, :name, :username, :session_id].map(&:freeze).freeze
+  attr_accessor *RESOURCE_ATTRIBUTES
+
+  # Responsible for authenticating TMDb users.
+  # Authentication of users follows the workflow: https://www.themoviedb.org/documentation/api/sessions
+  # This method hits the following api endpoints:
+  #
+  # - http://api.themoviedb.org/3/authentication/token/new
+  # - http://api.themoviedb.org/3/authentication/token/validate_with_login
+  # - http://api.themoviedb.org/3/authentication/session/new
+  # - http://api.themoviedb.org/3/account
+  #
+  # Example:
+  #
+  #   Enceladus::Account.new("bruna_ferraz", "dajhhd")
+  #
+  def initialize(username, password)
+    self.username = username
+    self.password = password
+    start_authentication_workflow
+  end
+
+  # Adds movie to accounts favorite list.
+  # Example:
+  #
+  #   account = Enceladus::Account.new("bruna_ferraz", "dajhhd")
+  #   account.favorite_movie!(23444)
+  #
+  def favorite_movie!(movie_id)
+    toggle_favorite_movie(movie_id, true)
+  end
+
+  # Removes movie to accounts favorite list.
+  # Example:
+  #
+  #   account = Enceladus::Account.new("bruna_ferraz", "dajhhd")
+  #   account.unfavorite_movie!(23444)
+  #
+  def unfavorite_movie!(movie_id)
+    toggle_favorite_movie(movie_id, false)
+  end
+
+  # Adds movie to accounts watchlist.
+  # Example:
+  #
+  #   account = Enceladus::Account.new("bruna_ferraz", "dajhhd")
+  #   account.add_to_watchlist!(23444)
+  #
+  def add_to_watchlist!(movie_id)
+    toggle_movie_watchlist(movie_id, true)
+  end
+
+  # Removes movie to accounts watchlist.
+  # Example:
+  #
+  #   account = Enceladus::Account.new("bruna_ferraz", "dajhhd")
+  #   account.remove_from_watchlist!(23444)
+  #
+  def remove_from_watchlist!(movie_id)
+    toggle_movie_watchlist(movie_id, false)
+  end
+
+  # Return a list of account's favorite movies.
+  # The returned movies are wrapped into a Enceladus::MovieCollection.
+  # Example:
+  #
+  #   account = Enceladus::Account.new("belinha", "dajhhd")
+  #   account.favorite_movies
+  #
+  def favorite_movies
+    Enceladus::MovieCollection.new("account/#{id}/favorite/movies", { session_id: session_id }) if authenticated?
+  end
+
+  # Return a list of account's rated movies.
+  # The returned movies are wrapped into a Enceladus::MovieCollection.
+  # Example:
+  #
+  #   account = Enceladus::Account.new("belinha", "dajhhd")
+  #   account.rated_movies
+  #
+  def rated_movies
+    Enceladus::MovieCollection.new("account/#{id}/rated/movies", { session_id: session_id }) if authenticated?
+  end
+
+  # Return the account's watchlist
+  # The returned movies are wrapped into a Enceladus::MovieCollection.
+  # Example:
+  #
+  #   account = Enceladus::Account.new("belinha", "hjgsss")
+  #   account.watchlist
+  #
+  def watchlist
+    Enceladus::MovieCollection.new("account/#{id}/watchlist/movies", { session_id: session_id }) if authenticated?
+  end
+
+private
+  attr_accessor :request_token, :password
+
+  def toggle_favorite_movie(movie_id, favorite)
+     if authenticated?
+      params = { session_id: session_id }
+      form_data = { media_type: "movie", media_id: movie_id, favorite: favorite }
+      Enceladus::Requester.post("account/#{id}/favorite", params, form_data)
+    end
+  end
+
+  def toggle_movie_watchlist(movie_id, watchlist)
+     if authenticated?
+      params = { session_id: session_id }
+      form_data = { media_type: "movie", media_id: movie_id, watchlist: watchlist }
+      Enceladus::Requester.post("account/#{id}/watchlist", params, form_data)
+    end
+  end
+
+  def authenticated?
+    id && session_id
+  end
+
+  def start_authentication_workflow
+    request_authentication_token
+    authenticate
+    open_session
+    rebuild_single_resource(Enceladus::Requester.get("account", { session_id: session_id }))
+    self.password = self.request_token = nil
+  end
+
+  def request_authentication_token
+    token_info = Enceladus::Requester.get("authentication/token/new")
+    self.request_token = token_info.request_token
+  end
+
+  def authenticate
+    params = { request_token: request_token, username: username, password: password }
+    Enceladus::Requester.get("authentication/token/validate_with_login", params).success
+  end
+
+  def open_session
+    params = { request_token: request_token }
+    self.session_id = Enceladus::Requester.get("authentication/session/new", params).session_id
+  end
+end

data/lib/enceladus/models/api_paginated_collection.rb

@@ -0,0 +1,76 @@
+class Enceladus::ApiPaginatedCollection
+  # Provides the implementation to handle collection of paginated resources.
+  # The collection of resources are cached locally, after going to next pages the previous pages do not make
+  # any request to obtain the resources again.
+
+  RESOURCE_CLASS = nil
+
+  attr_reader :total_pages, :total_results, :path, :params, :results_per_page
+
+  # The argument path refers to the TMDb api path that provides paginated resources.
+  # the argument params can be used when you need to send arguments to requests when fetching new pages.
+  # Example:
+  #   Enceladus::MovieCollection.new("movie/upcoming", { blah: true })
+  def initialize(path, params={})
+    self.path = path
+    self.params = params
+    self.params[:page] = 1
+    self.results_per_page = []
+    get_results_per_page
+  end
+
+  # Returns a collection of resources for the current page
+  def all
+    get_results_per_page
+  end
+
+  # Request, fetch, cache and return the collection of resources for the next page.
+  def next_page
+    self.params[:page] += 1
+    get_results_per_page
+  end
+
+  # Request, fetch, cache and return the collection of resources for the previous page.
+  def previous_page
+    raise ArgumentError.new("current_page must be greater than 0") if self.params[:page] == 1
+    self.params[:page] -= 1
+    get_results_per_page
+  end
+
+  # Returns current page number.
+  def current_page
+    self.params[:page]
+  end
+
+  # Request, fetch, cache and return the collection of resources for a given page number.
+  def current_page=(page)
+    self.params[:page] = page
+    get_results_per_page
+  end
+
+  # Returns the first resource for of the current page.
+  def first
+    get_results_per_page.first
+  end
+
+  # Returns the last resource for of the current page.
+  def last
+    get_results_per_page.last
+  end
+
+private
+  attr_writer :total_pages, :total_results, :path, :params, :results_per_page
+
+  def fetch_colletion
+    raise NotImplementedError.new("RESOURCE_CLASS must be defined") if self.class::RESOURCE_CLASS.nil?
+
+    response = Enceladus::Requester.get(path, params)
+    self.total_pages = response.total_pages
+    self.total_results = response.total_results
+    self.class::RESOURCE_CLASS.build_collection(response.results)
+  end
+
+  def get_results_per_page
+    self.results_per_page[current_page - 1] ||= fetch_colletion
+  end
+end

data/lib/enceladus/models/api_resource.rb

@@ -0,0 +1,25 @@
+class Enceladus::ApiResource
+private
+  def rebuild_single_resource(resource_from_response)
+    self.class::RESOURCE_ATTRIBUTES.each do |resource_attr|
+      self.public_send("#{resource_attr}=", resource_from_response.public_send(resource_attr)) if resource_from_response.respond_to?(resource_attr)
+    end
+    self
+  end
+
+  def self.build_single_resource(resource_from_response)
+    resource = self.new
+    self::RESOURCE_ATTRIBUTES.each do |resource_attr|
+      resource.public_send("#{resource_attr}=", resource_from_response.public_send(resource_attr)) if resource_from_response.respond_to?(resource_attr)
+    end
+    resource
+  end
+
+  def self.build_collection(resources_from_response)
+    resources = []
+    resources_from_response.each do |resource_from_response|
+      resources << self.build_single_resource(resource_from_response)
+    end
+    resources
+  end
+end

data/lib/enceladus/models/cast.rb

@@ -0,0 +1,9 @@
+class Enceladus::Cast < Enceladus::ApiResource
+  RESOURCE_ATTRIBUTES = [:cast_id, :character, :credit_id, :id, :name, :order, :profile_path].map(&:freeze).freeze
+  attr_accessor *RESOURCE_ATTRIBUTES
+
+  # Returns an array containing URL's (as strings) for cast images.
+  def profile_urls
+    Enceladus::Configuration::Image.instance.url_for("profile", profile_path)
+  end
+end

data/lib/enceladus/models/genre.rb

@@ -0,0 +1,4 @@
+class Enceladus::Genre < Enceladus::ApiResource
+  RESOURCE_ATTRIBUTES = [:id, :name].map(&:freeze).freeze
+  attr_accessor *RESOURCE_ATTRIBUTES
+end

data/lib/enceladus/models/guest_account.rb

@@ -0,0 +1,15 @@
+class Enceladus::GuestAccount
+  attr_reader :session_id
+
+  # Initiaises a guest account.
+  # This method hits the following api endpoint:
+  # - https://api.themoviedb.org/3/authentication/guest_session/new
+  #
+  # For more information about guest accounts, check out http://docs.themoviedb.apiary.io/ SECTION: Authentication
+  def initialize
+    self.session_id = Enceladus::Requester.get("authentication/guest_session/new").guest_session_id
+  end
+
+private
+  attr_writer :session_id
+end