tmdb-movies 0.0.03

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c8aa27e851a3911fc24f7087eaf85bb71010fcc
+  data.tar.gz: 018f27ad2a2ed12151ecee724db26865ddf11daf
+SHA512:
+  metadata.gz: 33ef90c7efac7c7e58c9704b0616c8976ed51bd7dbacc0ebe2f2332816f0332044192e512d6ea35a45e2462014e2cc384f4713df8bc596797df2a6831aa8a882
+  data.tar.gz: 226abf137b7b174a43a141584da1b658e2689a9fd7d9d0698b4fb5923d865f185149cea3c28b9434ae9a55d04d03136b80d99f57a829ca63d8fbefd377ffe3fa

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.gems
+.rbenv-gemsets

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kelly Mahan
+
+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,74 @@
+# Tmdb::Movies
+
+A gem for easy access to themoviedb.org's api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tmdb-movies'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tmdb-movies
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Rate Limiter
+
+TMDB api has a hard rate limit of 40 requests every 10 seconds, going over that limit very quickly gets you you a bunch of errors about exceeding the limit. The rate limit method is so you don't have to worry about your own code exceeding that limit as long as you only have a single thread running. I set a conservative rate limit of 2.5 requests a second as a default for when i would occasionally have more than 1 thread going at a time.
+
+The rate_limit method can be overridden to better match your own application. When I started using multiple resque workers the default limiter wasn't enough. Below is my override for a multi thread limiter in rails using resque with many workers. Some jobs are completed very fast some are a little slower.
+
+```ruby
+#config/initializers/tmdb_rate_limit.rb
+
+
+require "remote_lock" # the remote lock gem is not a requiremnt of tmdb-movies. Add it to your gem file to make use of this code
+
+RemoteLock.class_eval do
+  def acquire_lock(key, options = {})
+    options = RemoteLock::DEFAULT_OPTIONS.merge(options)
+    1.upto(options[:retries]) do |attempt|
+      success = @adapter.store(key_for(key), options[:expiry])
+      return if success
+      break if attempt == options[:retries]
+      Kernel.sleep(options[:initial_wait])
+    end
+    raise RemoteLock::Error, "Couldn't acquire lock for: #{key}"
+  end
+end
+
+#this is to rate limit for multiple processes, this will be slower than the built in rate limiter for 1 process
+Tmdb::Connection.class_eval do
+  def rate_limit
+    $lock.synchronize("tmdb-movies-rate-limiter", retries: 999) do
+      last_time = Resque.redis.get("tmdb-movies-rate-limiter-last-update").to_f
+      if Time.now.to_f<last_time+Tmdb::Connection::CONNECTION_SPACING
+        sleep [last_time+Tmdb::Connection::CONNECTION_SPACING-Time.now.to_f,0].max #in case time passsed while processing
+      end
+      Resque.redis.set("tmdb-movies-rate-limiter-last-update", Time.now.to_f)
+    end
+    sleep 0.1 #if we don't sleep here the other proccesses don't get a chance to ask for a lock.
+  end
+end
+
+$lock = RemoteLock.new(RemoteLock::Adapters::Redis.new(Resque.redis))
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tmdb-movies/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/lib/tmdb.rb

@@ -0,0 +1,9 @@
+require "tmdb/version"
+require "tmdb/connection"
+require "tmdb/tmdb_base"
+require "tmdb/movie"
+require "tmdb/person"
+
+module Tmdb
+  IMAGE_PATH = "http://image.tmdb.org/t/p/original/"
+end

data/lib/tmdb/connection.rb

@@ -0,0 +1,69 @@
+require 'httparty'
+require 'tmdb/connection/movie_methods'
+require 'tmdb/connection/people_methods'
+require 'tmdb/connection/genre_methods'
+require 'tmdb/connection/search_methods'
+
+module Tmdb
+  
+  @@connection = nil
+  
+  def self.connection
+    @@connection
+  end
+  
+  def self.connection=(c)
+    @@connection = c
+  end
+  
+  def self.connect
+    @@connection ||= Tmdb::Connection.new
+  end
+  
+  class Connection
+    include HTTParty
+    include MovieMethods
+    include PeopleMethods
+    include GenreMethods
+    include SearchMethods
+    # debug_output $stdout
+    
+    attr_accessor :api_key, :response, :request, :rate_limit_time
+    
+    CONNECTIONS_PER_MINUTE = 150.0
+    CONNECTION_SPACING = 60.0/CONNECTIONS_PER_MINUTE
+    TMDB_URL = "http://api.themoviedb.org/3"
+    
+    def initialize(api_key = ENV["TMDB_API_KEY"])
+      @api_key = api_key
+      Tmdb.connection = self
+    end
+        
+    
+    def rate_limit
+      while(Time.now.to_f<@rate_limit_time.to_f+CONNECTION_SPACING)
+        sleep 0.1
+      end
+      @rate_limit_time = Time.now
+    end
+    
+    private
+    
+    def get(url, params={})
+      params.merge!({api_key: @api_key, language: params[:language]||"en"})
+      rate_limit
+      @response = self.class.get(TMDB_URL + url, query: params)
+      @request = @response.request
+      return @response
+    end
+    
+    def post(url, params={})
+      params.merge!({api_key: @api_key, language: params[:language]||"en"})
+      rate_limit
+      @response = self.class.post(TMDB_URL + url, query: params)
+      @request = @response.request
+      return @response
+    end
+    
+  end
+end

data/lib/tmdb/connection/genre_methods.rb

@@ -0,0 +1,16 @@
+module Tmdb
+  module GenreMethods
+    
+    def genre_movie_list
+      OpenStruct.new(get("/genre/movie/list"))
+    end
+    
+    def genre_tv_list
+      OpenStruct.new(get("/genre/tv/list"))
+    end
+    
+    def genre_movies(id, options={})
+      OpenStruct.new(get("/genre/#{id}/movies", options))
+    end
+  end
+end

data/lib/tmdb/connection/movie_methods.rb

@@ -0,0 +1,54 @@
+module Tmdb
+  module MovieMethods
+    
+    
+    def movie(id, options={})
+      OpenStruct.new(get("/movie/#{id}", options))
+    end
+    
+    def movie_all_changes(options={})
+      OpenStruct.new(get("/movie/changes", options))
+    end
+    
+    
+    movie_api_methods = %w(
+      latest
+      now_playing
+      upcoming
+      top_rated
+      popular
+      
+    )
+    
+    movie_api_methods.each do |m|
+      eval <<-EOF
+        def movie_#{m}(options={})
+          OpenStruct.new(get("/movie/#{m}", options))
+        end
+      EOF
+    end
+    
+    
+    movie_api_methods_id = %w(
+      alternative_titles
+      credits
+      images
+      keywords
+      releases
+      videos
+      translations
+      similar
+      reviews
+      lists
+      changes
+    )
+    
+    movie_api_methods_id.each do |m|
+      eval <<-EOF
+        def movie_#{m}(id, options={})
+          OpenStruct.new(get("/movie/\#{id}/#{m}", options))
+        end
+      EOF
+    end
+  end
+end

data/lib/tmdb/connection/people_methods.rb

@@ -0,0 +1,45 @@
+module Tmdb
+  module PeopleMethods
+    
+    
+    def person(id, options={})
+      OpenStruct.new(get("/person/#{id}", options))
+    end
+    
+    
+    def person_all_changes(options={})
+      OpenStruct.new(get("/person/changes", options))
+    end
+    
+    people_api_methods = %w(
+      popular
+      latest
+    )
+    
+    people_api_methods.each do |m|
+      eval <<-EOF
+        def person_#{m}(options={})
+          OpenStruct.new(get("/person/#{m}", options))
+        end
+      EOF
+    end
+    
+    people_api_methods_id = %w(
+      movie_credits
+      tv_credits
+      combined_credits
+      external_ids
+      images
+      tagged_images
+      changes
+    )
+    
+    people_api_methods_id.each do |m|
+      eval <<-EOF
+        def person_#{m}(id, options={})
+          OpenStruct.new(get("/person/\#{id}/#{m}", options))
+        end
+      EOF
+    end
+  end
+end

data/lib/tmdb/connection/search_methods.rb

@@ -0,0 +1,24 @@
+module Tmdb
+  module SearchMethods
+    
+    search_api_methods = %w(
+      company
+      collection
+      keyword
+      list
+      movie
+      multi
+      person
+      tv
+    )
+    
+    search_api_methods.each do |m|
+      eval <<-EOF
+        def search_#{m}(query, options={})
+          options.merge!(query: query)
+          OpenStruct.new(get("/search/#{m}", options))
+        end
+      EOF
+    end
+  end
+end

data/lib/tmdb/movie.rb

@@ -0,0 +1,53 @@
+module Tmdb
+  class Movie < TmdbBase
+        
+    def initialize(id)
+      @id = id
+      @info = api.movie(id)
+    end
+    
+    def images
+      api.movie_images(id)
+    end
+    
+    def posters
+      _images = images.posters.map{|p| OpenStruct.new(p)}
+      unless _images.map{|i| i.file_path}.include?(poster_path)
+        _images << OpenStruct.new({file_path: poster_path})
+      end
+      return _images
+    end
+    
+    def backdrops
+      _images = images.backdrops.map{|p| OpenStruct.new(p)}
+      unless _images.map{|i| i.file_path}.include?(backdrop_path)
+        _images << OpenStruct.new({file_path: backdrop_path})
+      end
+      return _images
+    end
+    
+    def cast
+      api.movie_credits(id).cast.map{|c| OpenStruct.new(c)}
+    end
+    
+    def crew
+      api.movie_credits(id).crew.map{|c| OpenStruct.new(c)}
+    end
+    
+    def videos
+      api.movie_videos(id).results.map{|t| OpenStruct.new(t)}
+    end
+    
+    def release_date
+      Date.parse(@info.release_date) rescue nil
+    end
+    
+    def method_missing(method, *args, &block)
+      if @info.respond_to?(method)
+        @info.send(method, *args, &block)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/tmdb/person.rb

@@ -0,0 +1,25 @@
+module Tmdb
+  class Person < TmdbBase
+    
+    def initialize(id)
+      @id = id
+      @info = api.person(id)
+    end
+    
+    def images
+      api.person_images(id).profiles.map{|i| OpenStruct.new(i)}
+    end
+    
+    def movies
+      api.person_movie_credits(id).cast.map{|c| OpenStruct.new(c)}
+    end
+    
+    def method_missing(method, *args, &block)
+      if @info.respond_to?(method)
+        @info.send(method, *args, &block)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/tmdb/tmdb_base.rb

@@ -0,0 +1,17 @@
+module Tmdb
+  class TmdbBase
+    attr_accessor :id, :info
+    
+    def api
+      Tmdb.connection
+    end
+    
+    def status_message
+      @info.status_message
+    end
+    
+    def changes(options={})
+      api.send("#{self.class.name.split('::').last.underscore}_changes", self.id, options)
+    end
+  end
+end

data/lib/tmdb/version.rb

@@ -0,0 +1,3 @@
+module Tmdb
+  VERSION = "0.0.03"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/tmdb-movies.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tmdb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tmdb-movies"
+  spec.version       = Tmdb::VERSION
+  spec.authors       = ["Kelly Mahan"]
+  spec.email         = ["kmahan@kmahan.com"]
+  spec.summary       = %q{A gem for easy access to themoviedb.org's api.}
+  spec.description   = %q{A gem for easy access to themoviedb.org's api.}
+  spec.homepage      = "http://github.com/kellymahan/tmdb-movies"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "httparty"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: tmdb-movies
+version: !ruby/object:Gem::Version
+  version: 0.0.03
+platform: ruby
+authors:
+- Kelly Mahan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem for easy access to themoviedb.org's api.
+email:
+- kmahan@kmahan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tmdb.rb
+- lib/tmdb/connection.rb
+- lib/tmdb/connection/genre_methods.rb
+- lib/tmdb/connection/movie_methods.rb
+- lib/tmdb/connection/people_methods.rb
+- lib/tmdb/connection/search_methods.rb
+- lib/tmdb/movie.rb
+- lib/tmdb/person.rb
+- lib/tmdb/tmdb_base.rb
+- lib/tmdb/version.rb
+- spec/spec_helper.rb
+- tmdb-movies.gemspec
+homepage: http://github.com/kellymahan/tmdb-movies
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A gem for easy access to themoviedb.org's api.
+test_files:
+- spec/spec_helper.rb