unified_db 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'rake'

data/README.md

@@ -0,0 +1,5 @@
+# Unified Movie Database
+
+This is project for unifying multiple movie database. Currently it support only IMDB and TVDB, but TMDB will be done shortly.
+
+To see it in action please go to [demo site](http://unified-db.heroku.com)

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/lib/ext/crack.rb

@@ -0,0 +1,10 @@
+require 'crack/json'
+require 'yajl'
+
+module Crack
+  class JSON
+    def self.parse(json)
+      Yajl::Parser.parse(json)
+    end
+  end
+end

data/lib/unified_db.rb

@@ -0,0 +1,19 @@
+module UnifiedDB
+  
+  ROOT = File.expand_path(File.dirname(__FILE__))
+
+  autoload :ApiError, "#{ROOT}/unified_db/api_error"
+  autoload :Backend,  "#{ROOT}/unified_db/backend"
+  autoload :Result,   "#{ROOT}/unified_db/result"
+  autoload :Version,  "#{ROOT}/unified_db/version"
+  
+  class << self
+    attr_accessor :json_encoder, :tvdb_secret
+    
+    def json_encoder
+      @json_encoder ||= Yajl::Encoder.new
+    end
+  end
+end
+
+require "#{UnifiedDB::ROOT}/ext/crack"

data/lib/unified_db/api_error.rb

@@ -0,0 +1,16 @@
+module UnifiedDB
+  class ApiError < RuntimeError
+  
+    def to_h
+      {
+        :result => 'error',
+        :reason => message
+      }
+    end
+    
+    def to_json(*args)
+      UnifiedDB.json_encoder.encode to_h
+    end
+  
+  end
+end

data/lib/unified_db/backend.rb

@@ -0,0 +1,18 @@
+module UnifiedDB
+  module Backend
+    
+    autoload :Base, "#{ROOT}/unified_db/backend/base"
+    autoload :IMDB, "#{ROOT}/unified_db/backend/imdb"
+    autoload :TVDB, "#{ROOT}/unified_db/backend/tvdb"
+    
+    AVAILABLE = {
+      'imdb' => Backend::IMDB,
+      'tvdb' => Backend::TVDB
+    }
+
+    def self.select(name)
+      AVAILABLE[name.to_s]
+    end
+    
+  end
+end

data/lib/unified_db/backend/base.rb

@@ -0,0 +1,66 @@
+module UnifiedDB
+  module Backend
+    class Base
+    
+      attr_accessor :id, :title
+    
+      def self.find(params)
+        new.find(params)
+      end
+    
+      def initialize
+        @result = []
+      end
+    
+      def find(params)
+        if params[:id]
+          find_by_id params[:id]
+        elsif params[:t] || params[:title]
+          find_by_title(params[:t] || params[:title])
+        else
+          raise ApiError, 'no search criteria specified'
+        end
+      
+        result
+      rescue ApiError => e
+        {
+          :status => 'error',
+          :reason => e.message
+        }
+      end
+    
+      def find_by_id(id)
+        raise ApiError, 'not implemented'
+      end
+    
+      def find_by_title(title)
+        raise ApiError, 'not implemented'
+      end
+    
+      def result
+        {
+          :status => 'success',
+          :service => service,
+          :result => @result
+        }
+      end
+    
+      private
+    
+      def service; 'base'; end
+    
+      def format_actors(actors)
+        Array(actors).collect { |a| { a.name => a.role } }
+      end
+    
+      def format_directors(directors)
+        Array(directors).collect(&:name)
+      end
+    
+      def format_writers(writers)
+        Array(writers).collect(&:name)
+      end
+    
+    end
+  end
+end

data/lib/unified_db/backend/imdb.rb

@@ -0,0 +1,46 @@
+require 'imdb_party'
+
+module UnifiedDB
+  module Backend
+    class IMDB < Base
+    
+      def find_by_id(id)
+        movie = handler.find_movie_by_id(id)
+        @result = Result::ID.new(
+          :id => movie.imdb_id,
+          :title => movie.title,
+          :overview => movie.plot,
+          :release_date => movie.release_date,
+          :genres => movie.genres,
+          :rating => movie.rating,
+          :runtime => movie.runtime.to_i,
+          :actors => format_actors(movie.actors),
+          :directors => format_directors(movie.directors),
+          :writers => format_writers(movie.writers),
+          :posters => Array(movie.poster_url)
+        )
+      rescue
+        raise ApiError, 'not found'
+      end
+    
+      def find_by_title(title)
+        movies = handler.find_by_title(title)
+        movies.each do |movie|
+          @result << Result::Title.new(
+            :id => movie[:imdb_id],
+            :title => movie[:title],
+            :year => movie[:year])
+        end
+      end
+    
+      private
+    
+      def service; 'imdb'; end
+    
+      def handler
+        @handler ||= ImdbParty::Imdb.new(:anonymize => true)
+      end
+    
+    end
+  end
+end

data/lib/unified_db/backend/tvdb.rb

@@ -0,0 +1,51 @@
+require 'tvdb_party'
+
+module UnifiedDB
+  module Backend
+    class TVDB < Base
+    
+      def find_by_id(id)
+        movie = handler.get_series_by_id(id)
+        @result = Result::ID.new(
+          :id => movie.id,
+          :title => movie.name,
+          :overview => movie.overview,
+          :release_date => movie.first_aired.to_s,
+          :genres => movie.genres,
+          :rating => movie.rating,
+          :runtime => movie.runtime.to_i,
+          :actors => format_actors(movie.actors),
+          :directors => [],
+          :writers => [],
+          :posters => format_posters(movie.banners)
+        )
+      rescue
+        raise ApiError, 'not found'
+      end
+    
+      def find_by_title(title)
+        movies = handler.search(title)
+        movies.each do |movie|
+          @result << Result::Title.new(
+            :id => movie['seriesid'],
+            :title => movie['SeriesName'],
+            :year => movie['FirstAired'].to_s.split('-')[0])
+        end
+      end
+    
+      private
+    
+      def service; 'tvdb'; end
+    
+      def handler
+        raise ApiError, 'no TVDB secret provided' if UnifiedDB.tvdb_secret.nil? 
+        @handler ||= TvdbParty::Search.new(UnifiedDB.tvdb_secret)
+      end
+        
+      def format_posters(posters)
+        posters.select{|poster| poster.banner_type == 'season'}.collect(&:url)
+      end
+    
+    end
+  end
+end

data/lib/unified_db/result.rb

@@ -0,0 +1,9 @@
+module UnifiedDB
+  module Result
+    
+    autoload :Base,  "#{ROOT}/unified_db/result/base"
+    autoload :ID,    "#{ROOT}/unified_db/result/id"
+    autoload :Title, "#{ROOT}/unified_db/result/title"
+    
+  end
+end

data/lib/unified_db/result/base.rb

@@ -0,0 +1,29 @@
+module UnifiedDB
+  module Result
+    class Base
+      
+      def self.allowed_keys; []; end
+      
+      def initialize(params)
+        allowed_keys.each do |key|
+          instance_variable_set("@#{key}", params[key])
+        end
+      end
+      
+      def to_h
+        allowed_keys.inject({}) { |hash, key| hash[key] = instance_variable_get("@#{key}"); hash }
+      end
+      
+      def to_json(*args)
+        UnifiedDB.json_encoder.encode to_h
+      end
+      
+      private
+      
+      def allowed_keys
+        self.class.allowed_keys
+      end
+      
+    end
+  end
+end

data/lib/unified_db/result/id.rb

@@ -0,0 +1,13 @@
+module UnifiedDB
+  module Result
+    class ID < Base
+      
+      def self.allowed_keys
+        [ :id, :title, :overview, :release_date, :genres, :rating, :runtime, :actors, :directors, :writers, :posters ]
+      end
+      
+      attr_reader *allowed_keys
+      
+    end
+  end
+end

data/lib/unified_db/result/title.rb

@@ -0,0 +1,13 @@
+module UnifiedDB
+  module Result
+    class Title < Base
+      
+      def self.allowed_keys
+        [ :id, :title, :year ]
+      end
+      
+      attr_reader *allowed_keys
+      
+    end
+  end
+end

data/lib/unified_db/version.rb

@@ -0,0 +1,5 @@
+module UnifiedDB
+  
+  VERSION = '0.1.0'
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'rspec'
+require 'yajl'
+
+require 'unified_db'
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+# This is secret is for testing purposes
+# PLEASE don't copy and reuse it :)
+UnifiedDB.tvdb_secret = '7ED5C5E4CAFAF90E'

data/spec/unified_db/backend/imdb_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe UnifiedDB::Backend::IMDB do
+  subject { described_class.new }
+  
+  it "should return valid find by title" do
+    result = subject.find(:title => 'Dark Knight')
+    result.class.should eql(Hash)
+    result.keys.sort.should eql([:result, :service, :status])
+    result[:status].should eql('success')
+    result[:service].should eql('imdb')
+    result[:result].class.should eql(Array)
+    result[:result].size.should be > 18
+    
+    first_result = result[:result].first
+    first_result.class.should eql(UnifiedDB::Result::Title)
+    first_result.id.should eql('tt0468569')
+    first_result.title.should eql('The Dark Knight')
+    first_result.year.should eql('2008')
+    
+    encoded = Yajl::Encoder.new.encode result
+    decoded = Yajl::Parser.new.parse encoded
+    
+    decoded.class.should eql(Hash)
+    decoded.keys.sort.should eql(['result', 'service', 'status'])
+    decoded['status'].should eql('success')
+    decoded['service'].should eql('imdb')
+    decoded['result'].class.should eql(Array)
+    decoded['result'].size.should be > 18
+    
+    first_result = decoded['result'].first
+    first_result.class.should eql(Hash)
+    first_result['id'].should eql('tt0468569')
+    first_result['title'].should eql('The Dark Knight')
+    first_result['year'].should eql('2008')
+  end
+  
+  it "should return empty array if invalid find by title specified" do
+    result = subject.find(:title => "qwertyuiopasdfghjkllzxcvbnm")
+    result.class.should eql(Hash)
+    result.keys.sort.should eql([:result, :service, :status])
+    result[:status].should eql('success')
+    result[:service].should eql('imdb')
+    result[:result].class.should eql(Array)
+    result[:result].size.should eql(0)
+  end
+    
+  
+  it "should return valid find by id" do
+    result = subject.find(:id => 'tt0468569')
+    result.class.should eql(Hash)
+    result.keys.sort.should eql([:result, :service, :status])
+    result[:status].should eql('success')
+    result[:service].should eql('imdb')
+    
+    result[:result].class.should eql(UnifiedDB::Result::ID)
+    result[:result].id.should eql('tt0468569')
+    result[:result].title.should eql('The Dark Knight')
+    result[:result].overview.class.should eql(String)
+    result[:result].overview.length.should be > 20
+    result[:result].release_date.class.should eql(String)
+    result[:result].genres.should eql(["Action", "Crime", "Thriller"])
+    result[:result].rating.class.should eql(Float)
+    result[:result].rating.should be > 4
+    result[:result].rating.should be < 10
+    result[:result].runtime.should eql(152)
+    result[:result].actors.class.should eql(Array)
+    result[:result].actors.first.should eql({"Christian Bale" => "Bruce Wayne/Batman"})
+    result[:result].directors.should eql(["Christopher Nolan"])
+    result[:result].writers.should eql(["Jonathan Nolan", "Christopher Nolan"])
+    result[:result].posters.class.should eql(Array)
+    result[:result].posters.size.should be > 0
+  end
+  
+  it "should return error if id was not found" do
+    result = subject.find(:id => 'tt046856910')
+    result.class.should eql(Hash)
+    result.keys.sort.should eql([:reason, :status])
+    result[:status].should eql('error')
+    result[:reason].should eql('not found')
+  end
+  
+end

data/spec/unified_db/backend/tvdb_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe UnifiedDB::Backend::TVDB do
+  subject { described_class.new }
+  
+  it "should return valid find by title" do
+    result = subject.find(:title => 'StarGate')
+    result.class.should eql(Hash)
+    result.keys.sort.should eql([:result, :service, :status])
+    result[:status].should eql('success')
+    result[:service].should eql('tvdb')
+    result[:result].class.should eql(Array)
+    result[:result].size.should be > 3
+    
+    first_result = result[:result].first
+    first_result.class.should eql(UnifiedDB::Result::Title)
+    first_result.id.should eql('72449')
+    first_result.title.should eql('Stargate SG-1')
+    first_result.year.should eql('1997')
+    
+    encoded = Yajl::Encoder.new.encode result
+    decoded = Yajl::Parser.new.parse encoded
+    
+    decoded.class.should eql(Hash)
+    decoded.keys.sort.should eql(['result', 'service', 'status'])
+    decoded['status'].should eql('success')
+    decoded['service'].should eql('tvdb')
+    decoded['result'].class.should eql(Array)
+    decoded['result'].size.should be > 3
+    
+    first_result = decoded['result'].first
+    first_result.class.should eql(Hash)
+    first_result['id'].should eql('72449')
+    first_result['title'].should eql('Stargate SG-1')
+    first_result['year'].should eql('1997')
+  end
+  
+  it "should return empty array if invalid find by title specified" do
+    result = subject.find(:title => "qwertyuiopasdfghjkllzxcvbnm")
+    result.class.should eql(Hash)
+    result.keys.sort.should eql([:result, :service, :status])
+    result[:status].should eql('success')
+    result[:service].should eql('tvdb')
+    result[:result].class.should eql(Array)
+    result[:result].size.should eql(0)
+  end
+    
+  
+  it "should return valid find by id" do
+    result = subject.find(:id => '72449')
+    result.class.should eql(Hash)
+    result.keys.sort.should eql([:result, :service, :status])
+    result[:status].should eql('success')
+    result[:service].should eql('tvdb')
+    
+    result[:result].class.should eql(UnifiedDB::Result::ID)
+    result[:result].id.should eql('72449')
+    result[:result].title.should eql('Stargate SG-1')
+    result[:result].overview.class.should eql(String)
+    result[:result].overview.length.should be > 20
+    result[:result].release_date.class.should eql(String)
+    result[:result].genres.should eql(["Action and Adventure", "Science-Fiction"])
+    result[:result].rating.class.should eql(Float)
+    result[:result].rating.should be > 4
+    result[:result].rating.should be < 10
+    result[:result].runtime.should eql(60)
+    result[:result].actors.class.should eql(Array)
+    result[:result].actors.first.should eql({"Richard Dean Anderson"=>"Col./Gen. Jack O'Neill"})
+    result[:result].directors.should eql([])
+    result[:result].writers.should eql([])
+    result[:result].posters.class.should eql(Array)
+    result[:result].posters.size.should be > 0
+  end
+  
+  it "should return error if id was not found" do
+    result = subject.find(:id => '72449123')
+    result.class.should eql(Hash)
+    result.keys.sort.should eql([:reason, :status])
+    result[:status].should eql('error')
+    result[:reason].should eql('not found')
+  end
+  
+end

data/unified_db.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "unified_db/version"
+
+Gem::Specification.new do |s|
+  s.name        = "unified_db"
+  s.version     = UnifiedDB::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bernard Potocki"]
+  s.email       = ["bernard.potocki@imanel.org"]
+  s.homepage    = "http://github.com/imanel/unifieddb"
+  s.summary     = %q{Scrapper for multiple Movie Databases}
+  s.description = %q{Scrapper for multiple Movie Databases}
+  
+  s.add_dependency 'yajl-ruby'
+  s.add_dependency 'imdb_party', '~> 0.6.0'
+  s.add_dependency 'tvdb_party', '~> 0.6.0'
+  s.add_development_dependency 'rspec', '~> 2.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: unified_db
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bernard Potocki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-22 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70343143888220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70343143888220
+- !ruby/object:Gem::Dependency
+  name: imdb_party
+  requirement: &70343143887680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70343143887680
+- !ruby/object:Gem::Dependency
+  name: tvdb_party
+  requirement: &70343143887140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70343143887140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70343143886640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70343143886640
+description: Scrapper for multiple Movie Databases
+email:
+- bernard.potocki@imanel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/ext/crack.rb
+- lib/unified_db.rb
+- lib/unified_db/api_error.rb
+- lib/unified_db/backend.rb
+- lib/unified_db/backend/base.rb
+- lib/unified_db/backend/imdb.rb
+- lib/unified_db/backend/tvdb.rb
+- lib/unified_db/result.rb
+- lib/unified_db/result/base.rb
+- lib/unified_db/result/id.rb
+- lib/unified_db/result/title.rb
+- lib/unified_db/version.rb
+- spec/spec_helper.rb
+- spec/unified_db/backend/imdb_spec.rb
+- spec/unified_db/backend/tvdb_spec.rb
+- unified_db.gemspec
+has_rdoc: true
+homepage: http://github.com/imanel/unifieddb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Scrapper for multiple Movie Databases
+test_files:
+- spec/spec_helper.rb
+- spec/unified_db/backend/imdb_spec.rb
+- spec/unified_db/backend/tvdb_spec.rb