allocine_api 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/History.txt

@@ -0,0 +1,3 @@
+== 0.0.1 2011-11-05
+
+* First release of the Allocine gem. [mlamarque]

data/README.rdoc

@@ -0,0 +1,55 @@
+= allocine
+
+Allows you to search and inspect movies and series from allocine API
+
+== DESCRIPTION:
+
+This packages allows you to easy access publicly available data from Allocine API. 
+
+== FEATURES/PROBLEMS:
+
+Allocine currently features the following:
+
+* Querying details movie info
+
+== SYNOPSIS:
+
+Movies:
+
+  i = Allocine::Movie.new("20754")
+  
+  i.title
+  #=> "Star Wars : Episode I - La Menace fantôme"
+
+
+== TESTING:
+
+You'll need rspec installed to run the specs.
+
+    $ bundle install
+    $ rspec spec/imdb/movie_spec.rb
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Matthieu Lamarque
+
+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/allocine.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "allocine/version"
+
+Gem::Specification.new do |s|
+  s.name        = "allocine_api"
+  s.version     = Allocine::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matthieu Lamarque"]
+  s.email       = ["lamarque.matthieu@gmail.com"]
+  s.homepage    = "http://github.com/mlamarque/allocine"
+  s.summary     = %q{Easily access the publicly available information on Allocine website.}
+  s.description = %q{Easily use Ruby to find information on allocine website.}
+
+  s.rubyforge_project = "allocine"
+
+  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"]
+
+  s.add_dependency 'hpricot', '~> 0.8.4'
+
+  s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'rspec', '~> 1.3.2'
+end

data/lib/allocine/allocine_base.rb

@@ -0,0 +1,114 @@
+module Allocine
+  
+  require 'rubygems'
+  require 'json'
+  require 'net/http'
+  
+  # Represents a AllocineBase
+  class AllocineBase
+    attr_accessor :id, :url, :title, :also_known_as
+    
+    def initialize(allocine_id, title = nil, also_known_as = [])
+      @id = allocine_id
+      @url = "http://api.allocine.fr/rest/v3/movie?code=#{allocine_id}&profile=large&format=json&partner=YW5kcm9pZC12M3M"
+    end
+    
+    # Returns the name of the director
+    def directors
+      document["castingShort"]["directors"].split(", ") rescue nil
+    end
+
+    # Returns an array with cast members
+    def actors
+      document["castingShort"]["actors"].split(", ") rescue nil
+    end
+
+    # Returns an array of genres (as strings)
+    def genres
+      document["genre"].collect {|gender| gender["$"]} rescue nil
+    end
+
+    # Returns an array of countries as strings.
+    def countries
+      document["nationality"].collect {|nation| nation["$"]} rescue nil
+    end
+    
+    # Returns the duration of the movie in minutes as an integer.
+    def length
+      document["runtime"].to_i/60 rescue nil 
+    end
+    
+    # Returns a string containing the URL to the movie poster.
+    def poster
+      document["poster"]["href"] rescue nil 
+    end
+    
+    # Returns a string containing trailer code.
+    def trailer_id
+      document["trailer"]["code"] rescue nil 
+    end
+
+    # Returns a string containing the URL to the movie trailer.
+    def trailer
+      document["trailer"]["href"] rescue nil 
+    end
+    
+    # Returns a float containing the average user rating
+    def press_rating
+      document["statistics"]["pressRating"] rescue nil 
+    end
+
+    # Returns an int containing the number of user ratings
+    def user_rating
+      document["statistics"]["userRating"] rescue nil 
+    end
+        
+    # Returns a string containing the title
+    def title(force_refresh = false)
+      if @title && !force_refresh
+        @title
+      else
+        @title = document["title"] rescue nil 
+      end
+    end
+
+    # Returns originalTitle.
+    def original_title
+      document["originalTitle"] rescue nil
+    end
+    
+    
+    # Returns release date for the movie.
+    def release_date
+      document["release"]["releaseDate"] rescue nil
+    end
+        
+    # Return production Year for the movie
+    def production_year
+      document["productionYear"]
+    end
+    
+    def plot(short = true)
+      short ? document["synopsisShort"] : document["synopsis"]
+    end
+
+    private
+    
+    # Returns a new Hpricot document for parsing.
+    def document
+      @document ||= Allocine::Movie.find_by_id(@id)
+    end
+    
+    def self.find_by_id(allocine_id)
+      url = "http://api.allocine.fr/rest/v3/movie?code=#{allocine_id}&profile=large&format=json&partner=YW5kcm9pZC12M3M"
+      JSON.parse(Net::HTTP.get_response(URI.parse(url)).body)["movie"] rescue nil
+    end
+    
+    # Convenience method for search
+    def self.search(query)
+      Allocine::Search.new(query).movies
+    end
+        
+  end
+  
+end

data/lib/allocine/movie.rb

@@ -0,0 +1,9 @@
+module Allocine
+  
+  # Represents a Movie on Allocine website
+  class Movie < AllocineBase
+    
+    
+  end
+  
+end

data/lib/allocine/movie_list.rb

@@ -0,0 +1,7 @@
+module Allocine
+
+  class MovieList
+  
+  end
+  
+end

data/lib/allocine/search.rb

@@ -0,0 +1,6 @@
+module Allocine
+  
+  class Search < MovieList
+    
+  end
+end

data/lib/allocine/version.rb

@@ -0,0 +1,3 @@
+module Allocine
+  VERSION = '1.0.0'
+end

data/lib/allocine.rb

@@ -0,0 +1,13 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'open-uri'
+require 'rubygems'
+require 'hpricot'
+require 'awesome_print'
+
+require 'allocine/allocine_base'
+require 'allocine/movie'
+require 'allocine/movie_list'
+require 'allocine/search'
+require 'allocine/version'

data/script/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+
+require "awesome_print"
+
+libs =  " -r irb/completion"
+libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+#libs <<  " -r /path.../allocine/lib/allocine.rb"
+puts "Loading allocine gem"
+exec "#{irb} #{libs} --simple-prompt"

data/spec/imdb/movie_spec.rb

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+# This test uses "Star Wars : Episode I - La Menace fantôme " as a testing sample:
+#   
+#     http://api.allocine.fr/rest/v3/movie?code=20754&profile=large&format=json&partner=YW5kcm9pZC12M3M
+#
+
+describe "Allocine::Movie" do
+  
+  describe "valid movie" do
+
+    before(:each) do
+      @movie = Allocine::Movie.new("20754")
+    end
+  
+    it "should find the cast members" do
+      cast = @movie.actors
+    
+      cast.should be_an(Array)
+      cast.should include("Liam Neeson")
+      cast.should include("Natalie Portman")
+      cast.should include("Jake Lloyd")
+      cast.should include("Ian McDiarmid")
+    end
+
+    it "should find the directors" do
+      @movie.directors.should be_an(Array)
+      @movie.directors.size.should eql(1)
+      @movie.directors.first.should =~ /George Lucas/
+    end
+  
+    it "should find the genres" do
+      genres = @movie.genres
+      genres.should be_an(Array)
+      genres.should include('Science fiction')
+      genres.should include('Fantastique')
+      genres.should include('Aventure')
+    end
+
+    it "should find the countries" do
+      countries = @movie.countries
+
+      countries.should be_an(Array)
+      countries.size.should eql(1)
+      countries.should include('U.S.A.')
+    end    
+
+    it "should find the length (in minutes)" do
+      @movie.length.should eql(133)
+    end
+  
+    it "should find the plot" do
+      @movie.plot.should eql("Il y a bien longtemps, dans une galaxie très lointaine... La Fédération du Commerce impose par la force la taxation des routes commerciales à la pacifique planète Naboo. Les chevaliers Jedi Qui-Gon Jinn et Obi-Wan Kenobi sont envoyés sur place...")
+    end
+  
+    it "should find the poster" do
+      @movie.poster.should eql("http://images.allocine.fr/medias/nmedia/18/86/24/04/19835018.jpg")
+    end
+  
+    it "should find the press rating" do
+      @movie.press_rating.should eql(3.125)
+    end
+  
+    it "should find the user rating" do
+      @movie.user_rating.should eql(3.64026)
+    end
+      
+    it "should find the title" do
+      @movie.title.should =~ /Star Wars : Episode I - La Menace fantôme/
+    end
+    
+    it "should find the production year" do
+      @movie.production_year.should eql(1999)
+    end
+
+    it "should find the release date" do
+      @movie.release_date.should eql("1999-10-13")
+    end
+    
+    it "should find the trailer" do
+      @movie.trailer.should eql("http://www.allocine.fr/blogvision/19259278")
+    end
+  end
+    
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# By default if you have the FakeWeb gem installed when the specs are
+# run they will hit recorded responses.  However, if you don't have
+# the FakeWeb gem installed or you set the environment variable
+# LIVE_TEST then the tests will hit the live site IMDB.com.
+#
+# Having both methods available for testing allows you to quickly
+# refactor and add features, while also being able to make sure that
+# no changes to the IMDB.com interface have affected the parser.
+###
+
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+#  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'allocine'
+
+def read_fixture(path)
+  File.read(File.expand_path(File.join(File.dirname(__FILE__), "fixtures", path)))
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: allocine_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Matthieu Lamarque
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-05 00:00:00.000000000 +01:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: &2168755320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *2168755320
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2168754820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2168754820
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2168754240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: *2168754240
+description: Easily use Ruby to find information on allocine website.
+email:
+- lamarque.matthieu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- History.txt
+- Manifest.txt
+- README.rdoc
+- allocine.gemspec
+- lib/allocine.rb
+- lib/allocine/allocine_base.rb
+- lib/allocine/movie.rb
+- lib/allocine/movie_list.rb
+- lib/allocine/search.rb
+- lib/allocine/version.rb
+- script/console
+- spec/imdb/movie_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mlamarque/allocine
+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: allocine
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Easily access the publicly available information on Allocine website.
+test_files:
+- spec/imdb/movie_spec.rb
+- spec/spec_helper.rb