tmdb_party 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 John Duff
+
+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.rdoc

@@ -0,0 +1,40 @@
+= tmdb_party
+
+Simple ruby wrapper to themoviedb.org (http://api.themoviedb.org/2.0/docs/) using HTTParty
+
+= usage:
+  sudo gem install jduff-tmdb_party
+  require 'tmdb_party'
+
+= example:
+
+  @tmdb = TMDBParty::Base.new('key')
+  results = @tmdb.search('transformers')
+
+  results.length
+    # => 5
+
+  transformers = results.detect{|m| m.title == "Transformers"}
+
+  transformers.popularity
+    # => 31
+  transformers.score
+    # => 1.0
+  transformers.imdb
+    # => 'tt0418279'
+
+  # some attributes don't come back with the search result, they are lazily loaded on demand
+  transformers.homepage
+    # => "http://www.transformersmovie.com/"
+  transformers.trailer.url
+    # => "http://www.youtube.com/watch?v=eduwcuq1Exg"
+
+  transformers.categories.collect{|cat| cat.name}.include?("Adventure Film")
+    # => true
+
+= what is themoviedb.org?
+It's a movie database, kind of like IMDB except it's more of a community wiki. They also have an api that they're cool with people using. More on the api here: http://api.themoviedb.org/2.0/docs/
+
+== Copyright
+
+Copyright (c) 2009 John Duff. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tmdb_party"
+    gem.summary = %Q{Simple ruby wrapper to themoviedb.org (http://api.themoviedb.org/2.0/docs/) using HTTParty}
+    gem.email = "duff.john@gmail.com"
+    gem.homepage = "http://github.com/jduff/tmdb_party"
+    gem.authors = ["John Duff", "Jon Maddox"]
+    gem.add_dependency('httparty', '>= 0.4.3')
+    
+    gem.add_development_dependency('fakeweb')
+    gem.add_development_dependency('context')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tmdb_party #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 3
+:patch: 0

data/lib/tmdb_party/attributes.rb

@@ -0,0 +1,53 @@
+module TMDBParty
+  module Attributes
+    # based on http://github.com/nullstyle/ruby-satisfaction
+    
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+        attr_reader :attributes
+      end
+    end
+
+    module ClassMethods
+      def attributes(*names)
+        options = names.extract_options!
+
+        names.each do |name|
+          attribute name, options unless name.blank?
+        end
+      end
+
+      def attribute(name, options)
+        options.replace({:type => 'nil', :lazy=>false}.merge(options))
+        raise "Name can't be empty" if name.blank?
+
+        lazy_load = "self.#{options[:lazy]} unless self.loaded?" if options[:lazy]
+        class_eval <<-EOS
+  def #{name}
+    #{lazy_load}
+    @#{name} ||= decode_raw_attribute(@attributes['#{name}'], #{options[:type]}) if @attributes
+  end
+  EOS
+      end
+
+    end
+
+    module InstanceMethods
+      def attributes=(value)
+        @attributes = value
+      end
+      
+      def loaded?
+        @loaded
+      end
+
+      private
+      def decode_raw_attribute(value, type)
+        return nil unless value
+        type.respond_to?(:parse) ? type.parse(value) : value
+      end
+    end
+  end
+end

data/lib/tmdb_party/category.rb

@@ -0,0 +1,22 @@
+module TMDBParty
+  class Category
+    include Attributes
+    attributes :name, :url
+    
+    def initialize(values)
+      self.attributes = values
+    end
+    
+    def self.parse(data)
+      return unless data
+      data = data["category"]
+      if data.is_a?(Array)
+        data.collect do |category|
+          Category.new(category)
+        end
+      else
+        [Category.new(data)]
+      end
+    end
+  end
+end

data/lib/tmdb_party/core_extensions.rb

@@ -0,0 +1,18 @@
+class Array
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+  
+end
+
+class Float
+  def self.parse(val)
+    Float(val)
+  end
+end
+
+class Integer
+  def self.parse(val)
+    Integer(val)
+  end
+end

data/lib/tmdb_party/image.rb

@@ -0,0 +1,19 @@
+module TMDBParty
+  class Image
+    attr_reader :url
+    
+    def initialize(url)
+      @url = url
+    end
+    
+    def self.parse(data)
+      if data.is_a?(Array)
+        data.collect do |url|
+          Image.new(url)
+        end
+      else
+        Image.new(data)
+      end
+    end
+  end
+end

data/lib/tmdb_party/movie.rb

@@ -0,0 +1,50 @@
+module TMDBParty
+  class Movie
+    include Attributes
+    attr_reader :tmdb
+    
+    attributes :title, :short_overview, :id, :score, :imdb, :type, :url, :popularity, :alternative_title
+    attributes :release, :type=>DateTime
+    attributes :id, :runtime, :type => Integer
+    attributes :popularity, :score, :type => Float
+    attributes :poster, :backdrop, :type => Image
+    
+    attributes :homepage, :lazy => :get_info!
+    attributes :trailer, :lazy => :get_info!, :type=> Video
+    attributes :categories, :lazy => :get_info!, :type=> Category
+    attributes :people, :lazy => :get_info!, :type=> Person
+    
+    def initialize(values, tmdb)
+      @tmdb = tmdb
+      self.attributes = values
+    end
+    
+    def get_info!
+      movie = tmdb.get_info(self.id)
+      @attributes.merge!(movie.attributes) if movie
+      @loaded = true
+    end
+
+    def directors
+      find_people('director')
+    end
+
+    def actors
+      find_people('actor')
+    end
+
+    def writers
+      find_people('writer')
+    end
+    
+    
+    private
+    
+    def find_people(type)
+      return [] unless people
+      people.select{|p| p.job == type}
+    end
+
+  end
+  
+end

data/lib/tmdb_party/person.rb

@@ -0,0 +1,22 @@
+module TMDBParty
+  class Person
+    include Attributes
+    attributes :name, :url, :job
+    
+    def initialize(values)
+      self.attributes = values
+    end
+    
+    def self.parse(data)
+      return unless data
+      data = data["person"]
+      if data.is_a?(Array)
+        data.collect do |person|
+          Person.new(person)
+        end
+      else
+        [Person.new(data)]
+      end
+    end
+  end
+end

data/lib/tmdb_party/video.rb

@@ -0,0 +1,20 @@
+module TMDBParty
+  class Video
+    attr_reader :url
+    
+    def initialize(url)
+      @url = url
+    end
+    
+    def self.parse(data)
+      return unless data
+      if data.is_a?(Array)
+        data.collect do |url|
+          Video.new(url)
+        end
+      else
+        Video.new(data)
+      end
+    end
+  end
+end

data/lib/tmdb_party.rb

@@ -0,0 +1,49 @@
+# gem 'httparty'
+require 'httparty'
+require 'tmdb_party/core_extensions'
+require 'tmdb_party/attributes'
+require 'tmdb_party/video'
+require 'tmdb_party/category'
+require 'tmdb_party/person'
+require 'tmdb_party/image'
+require 'tmdb_party/movie'
+
+module TMDBParty
+  class Base
+    include HTTParty
+    base_uri 'http://api.themoviedb.org/2.0'
+    format :xml
+    
+    def initialize(key)
+      self.class.default_params :api_key => key
+    end
+    
+    def search(query)
+      data = self.class.get('/Movie.search', :query=>{:title=>query})
+      
+      case data['results']['moviematches']['movie']
+      when Array
+        data['results']['moviematches']['movie'].collect { |movie| Movie.new(movie, self) }
+      when Hash
+        [Movie.new(data['results']['moviematches']['movie'], self)]
+      else
+        []
+      end
+    end
+    
+    def imdb_lookup(imdb_id)
+      data = self.class.get('/Movie.imdbLookup', :query=>{:imdb_id=>imdb_id})
+      case data['results']['moviematches']['movie']
+      when String
+        return nil
+      when Hash
+        Movie.new(data['results']['moviematches']['movie'], self)
+      end
+    end
+    
+    def get_info(id)
+      data = self.class.get('/Movie.getInfo', :query=>{:id=>id})
+      Movie.new(data['results']['moviematches']['movie'], self)
+    end
+  end
+end

data/test/fixtures/imdb_no_results.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results for="tt041827sdd9" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
+<opensearch:Query searchTerms="tt041827sdd9"/>
+<opensearch:totalResults>0</opensearch:totalResults>
+<moviematches>
+<movie>Your query didn't return any results.</movie>
+</moviematches>
+</results>

data/test/fixtures/imdb_search.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results for="tt0418279" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
+<opensearch:Query searchTerms="tt0418279"/>
+<opensearch:totalResults>1</opensearch:totalResults>
+<moviematches>
+<movie>
+<score>1.0</score>
+<popularity>52</popularity>
+<title>Transformers</title>
+<alternative_title>The Transformers</alternative_title>
+<type>movie</type>
+<id>1858</id>
+<imdb>tt0418279</imdb>
+<url>http://www.themoviedb.org/movie/1858</url>
+<short_overview>The Earth is caught in the middle of an intergalactic war between two races of robots, the heroic Autobots and the evil Decepticons, which are able to change into a variety of objects, including cars, trucks, planes and other technological creations.</short_overview>
+<release>2007-07-04</release>
+<poster size="original">http://images.themoviedb.org/posters/937/Transformers_3d7ecdab.jpg</poster>
+<poster size="thumb">http://images.themoviedb.org/posters/937/Transformers_3d7ecdab_thumb.jpg</poster>
+<poster size="mid">http://images.themoviedb.org/posters/937/Transformers_3d7ecdab_mid.jpg</poster>
+<poster size="cover">http://images.themoviedb.org/posters/937/Transformers_3d7ecdab_cover.jpg</poster>
+<backdrop size="original">http://images.themoviedb.org/backdrops/1394/tt0418279-1.jpg</backdrop>
+<backdrop size="mid">http://images.themoviedb.org/backdrops/1394/tt0418279-1_poster.jpg</backdrop>
+<backdrop size="thumb">http://images.themoviedb.org/backdrops/1394/tt0418279-1_thumb.jpg</backdrop>
+</movie>
+</moviematches>
+</results>

data/test/fixtures/no_groups.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results for="13841" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
+<opensearch:Query searchTerms="13841"/>
+<opensearch:totalResults>1</opensearch:totalResults>
+<moviematches>
+<movie>
+<score>0.472535759210587</score>
+<popularity>2</popularity>
+<title>Rad</title>
+<alternative_title></alternative_title>
+<type>movie</type>
+<id>13841</id>
+<imdb>tt0091817</imdb>
+<url>http://www.themoviedb.org/movie/13841</url>
+<short_overview>A BMX racer who lives in a small town with his mother and sister is faced with a tough decision, qualify for Helltrack or take his SAT&apos;s in order to attend college.</short_overview>
+<rating>0.0</rating>
+<release>1986-03-21</release>
+<runtime>91</runtime>
+<budget>0</budget>
+<revenue>0</revenue>
+<homepage></homepage>
+<production_countries>
+</production_countries>
+<poster size="original">http://images.themoviedb.org/posters/7081/rad.jpg</poster>
+<poster size="mid">http://images.themoviedb.org/posters/7081/rad_mid.jpg</poster>
+<poster size="cover">http://images.themoviedb.org/posters/7081/rad_cover.jpg</poster>
+<poster size="thumb">http://images.themoviedb.org/posters/7081/rad_thumb.jpg</poster>
+<poster size="original">http://images.themoviedb.org/posters/14249/radderbg.jpg</poster>
+<poster size="mid">http://images.themoviedb.org/posters/14249/radderbg_mid.jpg</poster>
+<poster size="thumb">http://images.themoviedb.org/posters/14249/radderbg_thumb.jpg</poster>
+<poster size="cover">http://images.themoviedb.org/posters/14249/radderbg_cover.jpg</poster>
+<backdrop size="original">http://images.themoviedb.org/backdrops/17198/jimmy.jpg</backdrop>
+<backdrop size="mid">http://images.themoviedb.org/backdrops/17198/jimmy_poster.jpg</backdrop>
+<backdrop size="thumb">http://images.themoviedb.org/backdrops/17198/jimmy_thumb.jpg</backdrop>
+</movie>
+</moviematches>
+</results>

data/test/fixtures/rad.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results for="rad" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
+<opensearch:Query searchTerms="rad"/>
+<opensearch:totalResults>1</opensearch:totalResults>
+<moviematches>
+<movie>
+<score>1.0</score>
+<popularity>2</popularity>
+<title>Rad</title>
+<alternative_title></alternative_title>
+<type>movie</type>
+<id>13841</id>
+<imdb>tt0091817</imdb>
+<url>http://www.themoviedb.org/movie/13841</url>
+<short_overview>A BMX racer who lives in a small town with his mother and sister is faced with a tough decision, qualify for Helltrack or take his SAT&apos;s in order to attend college.</short_overview>
+<release>1986-03-21</release>
+<poster size="original">http://images.themoviedb.org/posters/7081/rad.jpg</poster>
+<poster size="mid">http://images.themoviedb.org/posters/7081/rad_mid.jpg</poster>
+<poster size="cover">http://images.themoviedb.org/posters/7081/rad_cover.jpg</poster>
+<poster size="thumb">http://images.themoviedb.org/posters/7081/rad_thumb.jpg</poster>
+<backdrop size="original">http://images.themoviedb.org/backdrops/17198/jimmy.jpg</backdrop>
+<backdrop size="mid">http://images.themoviedb.org/backdrops/17198/jimmy_poster.jpg</backdrop>
+<backdrop size="thumb">http://images.themoviedb.org/backdrops/17198/jimmy_thumb.jpg</backdrop>
+</movie>
+</moviematches>
+</results>

data/test/fixtures/search.xml

@@ -0,0 +1,104 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results for="transformers" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
+<opensearch:Query searchTerms="transformers"/>
+<opensearch:totalResults>5</opensearch:totalResults>
+<moviematches>
+<movie>
+<score>1.0</score>
+<popularity>31</popularity>
+<title>Transformers</title>
+<alternative_title>The Transformers</alternative_title>
+<type>movie</type>
+
+<id>1858</id>
+<imdb>tt0418279</imdb>
+<url>http://www.themoviedb.org/movie/1858</url>
+<short_overview>The Earth is caught in the middle of an intergalactic war between two races of robots, the heroic Autobots and the evil Decepticons, which are able to change into a variety of objects, including cars, trucks, planes and other technological creations.</short_overview>
+<release>2007-07-04</release>
+<poster size="original">http://images.themoviedb.org/posters/937/Transformers_3d7ecdab.jpg</poster>
+<poster size="thumb">http://images.themoviedb.org/posters/937/Transformers_3d7ecdab_thumb.jpg</poster>
+<poster size="mid">http://images.themoviedb.org/posters/937/Transformers_3d7ecdab_mid.jpg</poster>
+<poster size="cover">http://images.themoviedb.org/posters/937/Transformers_3d7ecdab_cover.jpg</poster>
+
+<backdrop size="original">http://images.themoviedb.org/backdrops/1394/tt0418279-1.jpg</backdrop>
+<backdrop size="mid">http://images.themoviedb.org/backdrops/1394/tt0418279-1_poster.jpg</backdrop>
+<backdrop size="thumb">http://images.themoviedb.org/backdrops/1394/tt0418279-1_thumb.jpg</backdrop>
+</movie>
+<movie>
+<score>0.120507517597236</score>
+<popularity>5</popularity>
+<title>Transformers: Revenge of the Fallen</title>
+<alternative_title>Transformers 2</alternative_title>
+
+<type>movie</type>
+<id>8373</id>
+<imdb>tt1055369</imdb>
+<url>http://www.themoviedb.org/movie/8373</url>
+<short_overview></short_overview>
+<release>2009-06-24</release>
+<poster size="original">http://images.themoviedb.org/posters/11433/Transformers_2_v1.jpg</poster>
+<poster size="mid">http://images.themoviedb.org/posters/11433/Transformers_2_v1_mid.jpg</poster>
+<poster size="thumb">http://images.themoviedb.org/posters/11433/Transformers_2_v1_thumb.jpg</poster>
+
+<poster size="cover">http://images.themoviedb.org/posters/11433/Transformers_2_v1_cover.jpg</poster>
+<backdrop size="original">http://images.themoviedb.org/backdrops/19763/Transformers_2_v1_1920x1080.jpg</backdrop>
+<backdrop size="mid">http://images.themoviedb.org/backdrops/19763/Transformers_2_v1_1920x1080_poster.jpg</backdrop>
+<backdrop size="thumb">http://images.themoviedb.org/backdrops/19763/Transformers_2_v1_1920x1080_thumb.jpg</backdrop>
+</movie>
+<movie>
+<score>0.0291530167991967</score>
+<popularity>2</popularity>
+<title>Transformers</title>
+<alternative_title></alternative_title>
+
+<type>movie_series</type>
+<id>8650</id>
+<imdb></imdb>
+<url>http://www.themoviedb.org/movie/8650</url>
+<short_overview>The Transformers series follows the continuing battle between the Autobots and the Decepticons and ultimately, the triumph of good over evil.</short_overview>
+<release>2009-06-24</release>
+<poster size="cover">http://images.themoviedb.org/posters//transformers_cover.JPG</poster>
+<poster size="cover">http://images.themoviedb.org/posters/35390/transformers_cover_thumb.JPG</poster>
+<poster size="mid">http://images.themoviedb.org/posters/35390/transformers_cover_mid.JPG</poster>
+
+<poster size="cover">http://images.themoviedb.org/posters/35390/transformers_cover_cover.JPG</poster>
+<backdrop size="original">http://images.themoviedb.org/backdrops/37808/transformers_bg.jpg</backdrop>
+<backdrop size="thumb">http://images.themoviedb.org/backdrops/37808/transformers_bg_thumb.jpg</backdrop>
+<backdrop size="mid">http://images.themoviedb.org/backdrops/37808/transformers_bg_poster.jpg</backdrop>
+</movie>
+<movie>
+<score>0.0146628580052701</score>
+<popularity>2</popularity>
+<title>The Transformers (TV series)</title>
+<alternative_title></alternative_title>
+
+<type>series</type>
+<id>1856</id>
+<imdb></imdb>
+<url>http://www.themoviedb.org/movie/1856</url>
+<short_overview>Transformers is the popular animated television series staring a cast of giant robots who can transform themselves into different creatures, objects, or other robots. The show was a huge success in the USA and Japan, and produced a popular Transformer toy line.</short_overview>
+<release></release>
+</movie>
+<movie>
+<score>0.0146628580052701</score>
+<popularity>2</popularity>
+<title>The Transformers: The Movie</title>
+
+<alternative_title></alternative_title>
+<type>movie</type>
+<id>1857</id>
+<imdb>tt0092106</imdb>
+<url>http://www.themoviedb.org/movie/1857</url>
+<short_overview>The Transformers: The Movie is the animated film from 1986 based on the popular television series of the same name. The television series and the film were both directed by Nelson Shin.</short_overview>
+<release>1986-08-08</release>
+<poster size="original">http://images.themoviedb.org/posters/16658/TF_TM.jpg</poster>
+<poster size="mid">http://images.themoviedb.org/posters/16658/TF_TM_mid.jpg</poster>
+
+<poster size="thumb">http://images.themoviedb.org/posters/16658/TF_TM_thumb.jpg</poster>
+<poster size="cover">http://images.themoviedb.org/posters/16658/TF_TM_cover.jpg</poster>
+<backdrop size="original">http://images.themoviedb.org/backdrops/584/tt0092106.jpg</backdrop>
+<backdrop size="mid">http://images.themoviedb.org/backdrops/584/tt0092106_poster.jpg</backdrop>
+<backdrop size="thumb">http://images.themoviedb.org/backdrops/584/tt0092106_thumb.jpg</backdrop>
+</movie>
+</moviematches>
+</results>