enceladus 0.0.2

data/lib/enceladus/models/movie.rb

@@ -0,0 +1,162 @@
+class Enceladus::Movie < Enceladus::ApiResource
+  RESOURCE_ATTRIBUTES = [ :adult, :backdrop_path, :id, :original_title, :release_date, :poster_path, :youtube_trailers,
+    :popularity, :title, :vote_average, :vote_count, :belongs_to_collection, :budget, :homepage, :imdb_id, :releases,
+    :overview, :revenue, :runtime, :status, :tagline, :genres, :production_companies, :production_countries, :spoken_languages,
+    :rating, :cast ].map(&:freeze).freeze
+
+  attr_accessor *RESOURCE_ATTRIBUTES
+
+  # Find a movie by TMDb ID or imdb_id.
+  # Examples:
+  #   Enceladus::Movie.find(550)
+  #   Enceladus::Movie.find("tt0137523")
+  #
+  def self.find(id)
+    build_single_resource(Enceladus::Requester.get("movie/#{id}", default_params))
+  end
+
+  # Find movies by title.
+  # Example:
+  #   Enceladus::Movie.find_by_title("emmanuelle")
+  #
+  def self.find_by_title(title)
+    Enceladus::MovieCollection.new("search/movie", { query: title })
+  end
+
+  # Returns a paginated collection of upcoming movies.
+  # Resources are paginates and respond to methods such as: next_page, all, previous_page, etc...
+  # Examples:
+  #
+  #   collection = Enceladus::Movie.upcoming
+  #   collection.all
+  #   => [Movie, Movie, ...]
+  #   collection.current_page
+  #   => 1
+  #   collection.next_page
+  #   => [Movie, Movie, ...]
+  #   collection.current_page
+  #   => 2
+  #
+  def self.upcoming
+    Enceladus::MovieCollection.new("movie/upcoming")
+  end
+
+  # Returns a paginated collection of movies playing in theatres.
+  def self.now_playing
+    Enceladus::MovieCollection.new("movie/now_playing")
+  end
+
+  # Returns a paginated collection of popular movies.
+  def self.popular
+    Enceladus::MovieCollection.new("movie/popular")
+  end
+
+  # Returns a paginated collection of top rated movies.
+  def self.top_rated
+    Enceladus::MovieCollection.new("movie/top_rated")
+  end
+
+  # Given a movie, this method returns a paginated collection of similar movies.
+  def similar
+    Enceladus::MovieCollection.new("movie/#{id}/similar", Enceladus::Movie.default_params)
+  end
+
+  # Fetchs details of movie information on TMDb API.
+  def reload
+    rebuild_single_resource(Enceladus::Requester.get("movie/#{id}"))
+  end
+
+  # Rate a movie.
+  # The argument account can be Enceladus::Account or Enceladus::GuestAccount.
+  # The argument rating must be an numeric value between 0 and 10.
+  # Examples:
+  #   movie = Enceladus::Movie.find(550)
+  #   guest_account = Enceladus::GuestAccount.new
+  #   movie.rate!(guest_account, 7.5)
+  #
+  #   account = Enceladus::Account.new("username", "password")
+  #   movie.rate!(account, 8.3)
+  #
+  # TMDb expects the rating value to be divisors of 0.5, this method rounds the value properly before making the request.
+  #
+  def rate!(account, rating)
+    params = {}
+    if account.kind_of?(Enceladus::Account)
+      params[:session_id] = account.session_id
+    elsif account.kind_of?(Enceladus::GuestAccount)
+      params[:guest_session_id] = account.session_id
+    else
+      raise Enceladus::Exception::ArgumentError.new("account must be one of Enceladus::Account or Enceladus::GuestAccount")
+    end
+
+    form_data = { value: (rating * 2).round / 2.0 }
+    Enceladus::Requester.post("movie/#{id}/rating", params, form_data)
+  end
+
+  # Method used by Enceladus::ApiResource to save genres fetched by TMDb API.
+  def genres=(genres_from_response)
+    @genres = Enceladus::Genre.build_collection(genres_from_response)
+  end
+
+  # Method used by Enceladus::ApiResource to save production companies fetched by TMDb API.
+  def production_companies=(production_companies_from_response)
+    @production_companies = Enceladus::ProductionCompany.build_collection(production_companies_from_response)
+  end
+
+  # Method used by Enceladus::ApiResource to save production countries fetched by TMDb API.
+  def production_countries=(production_countries_from_response)
+    @production_countries = Enceladus::ProductionCountry.build_collection(production_countries_from_response)
+  end
+
+  # Method used by Enceladus::ApiResource to save spoken languages fetched by TMDb API.
+  def spoken_languages=(spoken_languages_from_response)
+    @spoken_languages = Enceladus::SpokenLanguage.build_collection(spoken_languages_from_response)
+  end
+
+  # Method used by Enceladus::ApiResource to save releases fetched by TMDb API.
+  def releases=(releases_from_response)
+    if !releases_from_response.nil? && !releases_from_response.countries?
+      @releases = Enceladus::Release.build_collection(releases_from_response.countries)
+    end
+  end
+
+  # Method used by Enceladus::ApiResource to save trailers fetched by TMDb API.
+  def youtube_trailers=(trailers_from_response)
+    if !trailers_from_response.nil? && !trailers_from_response.youtube.nil?
+      @youtube_trailers = Enceladus::YouTubeTrailer.build_collection(trailers_from_response.youtube)
+    end
+  end
+
+  # Returns an array of Cast for the movie.
+  def cast
+    @cast ||= Enceladus::Cast.build_collection(Enceladus::Requester.get("movie/#{id}/credits").cast)
+  end
+
+  # Returns an array containing URL's (as string) for the movie background picture.
+  def backdrop_urls
+    Enceladus::Configuration::Image.instance.url_for("backdrop", backdrop_path)
+  end
+
+  # Returns an array containing URL's (as string) for the movie poster picture.
+  def poster_urls
+    Enceladus::Configuration::Image.instance.url_for("poster", poster_path)
+  end
+
+private
+  def self.build_single_resource(resource_from_response)
+    super(resource_from_response).tap do |resource|
+      resource.youtube_trailers=(resource_from_response.trailers)
+    end
+  end
+
+  def rebuild_single_resource(resource_from_response)
+    super(resource_from_response).tap do |resource|
+      self.youtube_trailers=(resource_from_response.trailers)
+    end
+  end
+
+  def self.default_params
+    include_image_language = Enceladus::Configuration::Image.instance.include_image_language
+    { append_to_response: "releases,trailers", include_image_language: include_image_language }
+  end
+end

data/lib/enceladus/models/movie_collection.rb

@@ -0,0 +1,3 @@
+class Enceladus::MovieCollection < Enceladus::ApiPaginatedCollection
+  RESOURCE_CLASS = Enceladus::Movie
+end

data/lib/enceladus/models/production_company.rb

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

data/lib/enceladus/models/production_country.rb

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

data/lib/enceladus/models/release.rb

@@ -0,0 +1,4 @@
+class Enceladus::Release < Enceladus::ApiResource
+  RESOURCE_ATTRIBUTES = [:iso_3166_1, :certification, :release_date].map(&:freeze).freeze
+  attr_accessor *RESOURCE_ATTRIBUTES
+end

data/lib/enceladus/models/spoken_language.rb

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

data/lib/enceladus/models/you_tube_trailer.rb

@@ -0,0 +1,9 @@
+class Enceladus::YouTubeTrailer < Enceladus::ApiResource
+  RESOURCE_ATTRIBUTES = [:name, :size, :source, :type].map(&:freeze).freeze
+  attr_accessor *RESOURCE_ATTRIBUTES
+
+  # Returns a YouTube link to the movie trailer.
+  def link
+    URI("https://www.youtube.com/watch?v=#{source}")
+  end
+end

data/lib/enceladus/requester.rb

@@ -0,0 +1,68 @@
+require 'rest_client'
+require 'ostruct'
+
+class Enceladus::Requester
+  class << self
+    # Makes a get request to one of the TMDb API endpoints.
+    # Example:
+    #
+    #   Enceladus::Requester.get("account", { session_id: "43462867" })
+    #
+    # Performing this action might results in RestClient::Exception.
+    # Check out https://github.com/rest-client/rest-client#exceptions-see-wwww3orgprotocolsrfc2616rfc2616-sec10html for more details.
+    #
+    def get(action, params={})
+      url = api.url_for(action, params)
+      perform_request do
+        JSON.parse(RestClient.get(url, request_headers), object_class: OpenStruct)
+      end
+    end
+
+    # Makes a post request to TMDb API endpoints.
+    # Example:
+    #
+    #   params = { session_id: "77678687" }
+    #   form_data = { media_type: "movie", media_id: 31231, watchlist: true }
+    #   Enceladus::Requester.post("account/777/watchlist", params, form_data)
+    #
+    # Performing this action might results in RestClient::Exception.
+    # Check out https://github.com/rest-client/rest-client#exceptions-see-wwww3orgprotocolsrfc2616rfc2616-sec10html for more details.
+    #
+    def post(action, params={}, form_data={})
+      url = api.url_for(action, params)
+      perform_request do
+        JSON.parse(RestClient.post(url, form_data.to_json, request_headers), object_class: OpenStruct)
+      end
+    end
+
+  private
+    def api
+      Enceladus::Configuration::Api.instance
+    end
+
+    # Handles request calls exceptions.
+    # Performing RestClient actions might results in RestClient::Exception.
+    # Check out https://github.com/rest-client/rest-client#exceptions-see-wwww3orgprotocolsrfc2616rfc2616-sec10html for more details.
+    #
+    # So, this method is responsible for handling RestClient::Exception, parsing the error message to finally raise Enceladus::Exception::Api.
+    #
+    def perform_request(&block)
+      begin
+        block.call
+      rescue RestClient::Exception => e
+        message = ["The Movie DB API Exception:"]
+        message << "@message=\"#{e.message}\""
+
+        JSON.parse(e.response).each do |k,v|
+          message << "@#{k}=\"#{v}\""
+        end
+
+        raise Enceladus::Exception::Api.new(message.join(" "))
+      end
+    end
+
+    def request_headers
+      { accept: 'application/json', content_type: 'application/json' }
+    end
+  end
+end

data/lib/enceladus/version.rb

@@ -0,0 +1,3 @@
+module Enceladus
+  VERSION = "0.0.2"
+end

data/lib/enceladus.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + "/enceladus/version"
+require File.dirname(__FILE__) + "/enceladus/exceptions"
+require File.dirname(__FILE__) + "/enceladus/requester"
+require File.dirname(__FILE__) + "/enceladus/configuration/api"
+require File.dirname(__FILE__) + "/enceladus/configuration/image"
+require File.dirname(__FILE__) + "/enceladus/models/api_resource"
+require File.dirname(__FILE__) + "/enceladus/models/api_paginated_collection"
+require File.dirname(__FILE__) + "/enceladus/models/account"
+require File.dirname(__FILE__) + "/enceladus/models/guest_account"
+require File.dirname(__FILE__) + "/enceladus/models/genre"
+require File.dirname(__FILE__) + "/enceladus/models/movie"
+require File.dirname(__FILE__) + "/enceladus/models/cast"
+require File.dirname(__FILE__) + "/enceladus/models/movie_collection"
+require File.dirname(__FILE__) + "/enceladus/models/production_company"
+require File.dirname(__FILE__) + "/enceladus/models/production_country"
+require File.dirname(__FILE__) + "/enceladus/models/release"
+require File.dirname(__FILE__) + "/enceladus/models/spoken_language"
+require File.dirname(__FILE__) + "/enceladus/models/you_tube_trailer"
+
+module Enceladus
+
+  # Responsible for authenticating Enceladus and fetching the account configuration.
+  # This method hits the following TMDb endpoints:
+  # - https://api.themoviedb.org/3/configuration
+  #
+  # You can also provide the following optional arguments:
+  # - include_image_language: find backdrops and posters in a specific language (check out http://docs.themoviedb.apiary.io session: Image Languages)
+  # - include_adult: includes adult movies in searchers
+  #
+  # Examples:
+  #
+  #   Enceladus.connect("0f76454c7b22300e457800cc20f24ae9")
+  #   Enceladus.connect("0f76454c7b22300e457800cc20f24ae9", { include_image_language: "pt-BR" })
+  #
+  def self.connect(api_key, options={ include_image_language: "en", include_adult: false })
+    Enceladus::Configuration::Api.instance.tap do |api|
+      api.connect(api_key)
+      api.include_adult = options[:include_adult]
+    end
+
+    Enceladus::Configuration::Image.instance.include_image_language = options[:include_image_language]
+  end
+end

data/spec/enceladus/configuration/api_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Enceladus::Configuration::Api do
+  describe "#connect" do
+    subject { Enceladus::Configuration::Api.instance.connect(api_key) }
+    let(:api_key) { "token" }
+
+    context "when the provided api_key is not valid" do
+      before do
+        stub_request(:get, /api.themoviedb.org\/3\/configuration/).
+          to_return(status: 401, body: ErrorResponse.new(7, "Invalid API key: You must be granted a valid key.").to_json)
+      end
+
+      it "should set Enceladus::Configuration::Api api_key as nil" do
+        subject
+        expect(Enceladus::Configuration::Api.instance.api_key).to be_nil
+      end
+
+      it "should call Enceladus::Configuration::Image.instance.reset!" do
+        expect(Enceladus::Configuration::Image.instance).to receive(:reset!)
+        subject
+      end
+
+      it "should return false" do
+        should eq(false)
+      end
+    end
+
+    context "when the provided api_key is valid" do
+      before do
+        stub_request(:get, /api.themoviedb.org\/3\/configuration/).
+          to_return(status: 200, body: ConfigurationResponse.new.to_json)
+      end
+
+      it "should save Enceladus::Configuration::Api api_key" do
+        subject
+        expect(Enceladus::Configuration::Api.instance.api_key).to eq(api_key)
+      end
+
+      it "should return true" do
+        should eq(true)
+      end
+    end
+  end
+
+  describe "#url_for" do
+    subject { Enceladus::Configuration::Api.instance.url_for(action, params) }
+    let(:action) { "movies" }
+    let(:params) { { term: "Sasha Grey" } }
+
+    before do
+      expect(Enceladus::Configuration::Api.instance).to receive(:api_key).and_return("token")
+    end
+
+    it "should return the full endpoint URL based on the provided args" do
+      should eq "https://api.themoviedb.org/3/movies?term=Sasha+Grey&api_key=token"
+    end
+  end
+end

data/spec/enceladus/configuration/image_spec.rb

@@ -0,0 +1,200 @@
+require 'spec_helper'
+
+describe Enceladus::Configuration::Image do
+  let(:configuration) { ConfigurationResponse.new }
+
+  describe "#setup!" do
+    subject(:image) { Enceladus::Configuration::Image.instance.setup! }
+
+    before do
+      stub_request(:get, /api.themoviedb.org\/3\/configuration/).
+        to_return(status: 200, body: configuration.to_json)
+    end
+
+    it "should save the base_url" do
+      expect(image.base_url).to eq(configuration.base_url)
+    end
+
+    it "should save the secure_base_url" do
+      expect(image.secure_base_url).to eq(configuration.secure_base_url)
+    end
+
+    it "should save the backdrop_sizes" do
+      expect(image.backdrop_sizes).to eq(configuration.backdrop_sizes)
+    end
+
+    it "should save the logo_sizes" do
+      expect(image.logo_sizes).to eq(configuration.logo_sizes)
+    end
+
+    it "should save the poster_sizes" do
+      expect(image.poster_sizes).to eq(configuration.poster_sizes)
+    end
+
+    it "should save the profile_sizes" do
+      expect(image.profile_sizes).to eq(configuration.profile_sizes)
+    end
+
+    it "should save the still_sizes" do
+      expect(image.still_sizes).to eq(configuration.still_sizes)
+    end
+
+    it "should return Enceladus::Configuration::Image.instance" do
+      is_expected.to eq(Enceladus::Configuration::Image.instance)
+    end
+  end
+
+  describe "#reset!" do
+    subject(:image) { Enceladus::Configuration::Image.instance.reset! }
+
+    it "should nullify the base_url" do
+      expect(image.base_url).to be_nil
+    end
+
+    it "should nullify the secure_base_url" do
+      expect(image.secure_base_url).to be_nil
+    end
+
+    it "should set the backdrop_sizes as an empty array" do
+      expect(image.backdrop_sizes).to eq([])
+    end
+
+    it "should set the logo_sizes as an empty array" do
+      expect(image.logo_sizes).to eq([])
+    end
+
+    it "should set the poster_sizes as an empty array" do
+      expect(image.poster_sizes).to eq([])
+    end
+
+    it "should set the profile_sizes as an empty array" do
+      expect(image.profile_sizes).to eq([])
+    end
+
+    it "should set the still_sizes as an empty array" do
+      expect(image.still_sizes).to eq([])
+    end
+
+    it "should return Enceladus::Configuration::Image.instance" do
+      is_expected.to eq(Enceladus::Configuration::Image.instance)
+    end
+  end
+
+  describe "#url_for" do
+    subject { Enceladus::Configuration::Image.instance.url_for(type, image_path) }
+    let(:image_path) { "/asa_akira.jpeg" }
+
+    before do
+      stub_request(:get, /api.themoviedb.org\/3\/configuration/).to_return(status: 200, body: configuration.to_json)
+      Enceladus::Configuration::Image.instance.setup!
+    end
+
+    context "when type is backdrop" do
+      let(:type) { "backdrop" }
+
+      it "should return an array containing all image URL's of backdrops" do
+        is_expected.to eq(["http://test.com/w300/asa_akira.jpeg", "http://test.com/w780/asa_akira.jpeg", "http://test.com/w1280/asa_akira.jpeg", "http://test.com/original/asa_akira.jpeg"])
+      end
+    end
+
+    context "when type is logo" do
+      let(:type) { "logo" }
+
+      it "should return an array containing all image URL's of logos" do
+        is_expected.to eq(["http://test.com/w45/asa_akira.jpeg", "http://test.com/w92/asa_akira.jpeg", "http://test.com/w154/asa_akira.jpeg", "http://test.com/w185/asa_akira.jpeg", "http://test.com/w300/asa_akira.jpeg", "http://test.com/w500/asa_akira.jpeg", "http://test.com/original/asa_akira.jpeg"])
+      end
+    end
+
+    context "when type is poster" do
+      let(:type) { "poster" }
+
+      it "should return an array containing all image URL's of logos" do
+        is_expected.to eq(["http://test.com/w92/asa_akira.jpeg", "http://test.com/w154/asa_akira.jpeg", "http://test.com/w185/asa_akira.jpeg", "http://test.com/w342/asa_akira.jpeg", "http://test.com/w500/asa_akira.jpeg", "http://test.com/w780/asa_akira.jpeg", "http://test.com/original/asa_akira.jpeg"])
+      end
+    end
+
+    context "when type is profile" do
+      let(:type) { "profile" }
+
+      it "should return an array containing all image URL's of profiles" do
+        is_expected.to eq(["http://test.com/w45/asa_akira.jpeg", "http://test.com/w185/asa_akira.jpeg", "http://test.com/h632/asa_akira.jpeg", "http://test.com/original/asa_akira.jpeg"])
+      end
+    end
+
+    context "when type is invalid" do
+      let(:type) { "jenna_jamenson" }
+
+      it "should raise ArgumentError" do
+        expect{ subject }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "when image_path is nil" do
+      let(:type) { "profile" }
+      let(:image_path) { nil }
+
+      it "should return an empty array" do
+        is_expected.to eq([])
+      end
+    end
+
+    context "when Enceladus::Configuration::Image is invalid" do
+      let(:type) { "profile" }
+
+      before { Enceladus::Configuration::Image.instance.reset! }
+
+      it "should return an empty array" do
+        is_expected.to eq([])
+      end
+    end
+  end
+
+  describe "#valid?" do
+    subject { Enceladus::Configuration::Image.instance.valid? }
+    let(:image) { Enceladus::Configuration::Image.instance }
+
+    before do
+      stub_request(:get, /api.themoviedb.org\/3\/configuration/).to_return(status: 200, body: configuration.to_json)
+      image.setup!
+    end
+
+    context "when base_url is nil" do
+      before { image.send("base_url=", nil) }
+      it { is_expected.to eq(false) }
+    end
+
+    context "when secure_base_url is nil" do
+      before { image.send("secure_base_url=", nil) }
+      it { is_expected.to eq(false) }
+    end
+
+    context "when backdrop_sizes is empty" do
+      before { image.send("backdrop_sizes=", []) }
+      it { is_expected.to eq(false) }
+    end
+
+    context "when logo_sizes is empty" do
+      before { image.send("logo_sizes=", []) }
+      it { is_expected.to eq(false) }
+    end
+
+    context "when poster_sizes is empty" do
+      before { image.send("poster_sizes=", []) }
+      it { is_expected.to eq(false) }
+    end
+
+    context "when profile_sizes is empty" do
+      before { image.send("profile_sizes=", []) }
+      it { is_expected.to eq(false) }
+    end
+
+    context "when still_sizes is empty" do
+      before { image.send("still_sizes=", []) }
+      it { is_expected.to eq(false) }
+    end
+
+    context "when none of the configuration options are nil or empty" do
+      it { is_expected.to eq(true) }
+    end
+  end
+end

data/spec/enceladus/enceladus_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Enceladus do
+
+  describe ".connect" do
+    subject { Enceladus.connect(api_key) }
+    let(:api_key) { "token" }
+    let(:configuration) { ConfigurationResponse.new }
+
+    before do
+      stub_request(:get, /api.themoviedb.org\/3\/configuration/).to_return(status: 200, body: configuration.to_json)
+    end
+
+    it "should start the configuration workflow" do
+      expect(Enceladus::Configuration::Api.instance).to receive(:connect).with(api_key)
+      subject
+    end
+
+    it "should set Enceladus::Configuration::Image#include_image_language as English" do
+      subject
+      expect(Enceladus::Configuration::Image.instance.include_image_language).to eq("en")
+    end
+
+    it "should set Enceladus::Configuration::Api#include_adult as false" do
+      subject
+      expect(Enceladus::Configuration::Api.instance.include_adult).to eq(false)
+    end
+
+    describe "include_image_language" do
+      context "when include_image_language is provided" do
+        subject { Enceladus.connect(api_key, { include_image_language: include_image_language } ) }
+        let(:include_image_language) { "pt-BR" }
+
+        it "should set Enceladus::Configuration::Image#include_image_language properly" do
+          subject
+          expect(Enceladus::Configuration::Image.instance.include_image_language).to eq(include_image_language)
+        end
+      end
+    end
+
+    describe "include_adult" do
+      context "when include_adult is provided" do
+        subject { Enceladus.connect(api_key, { include_adult: true }) }
+        let(:include_adult) { true }
+
+        it "should set Enceladus::Configuration::Api#include_adult properly" do
+          subject
+          expect(Enceladus::Configuration::Api.instance.include_adult).to eq(include_adult)
+        end
+      end
+    end
+  end
+end