allocine_api 1.0.0 → 1.5.0

data/History.txt

@@ -1,3 +1,7 @@
 == 0.0.1 2011-11-05
 
 * First release of the Allocine gem. [mlamarque]
+
+== 1.5.0 2011-11-06
+
+* Add Serie, Season, Episode [mlamarque]

data/README.rdoc

@@ -22,12 +22,31 @@ Movies:
   #=> "Star Wars : Episode I - La Menace fantôme"
 
 
+Serie:
+
+  i = Allocine::Serie.new(223)
+  i.title
+  #=> "Lost, les disparus"
+
+
+Season:
+
+  i = Allocine::Season.new(12277)
+  i.episode_ids
+  #=> [233014, 233015, 233016, 233017, 233018, 233019, 233020, 233021, 233022, 233023, 233024, 233025, 233026, 233027, 233028, 233029, 233030, 247699]
+
+Episode:
+
+  s = Allocine::Episode.new(233014)
+  s.title
+  #=> "On efface tout"
+
 == TESTING:
 
 You'll need rspec installed to run the specs.
 
     $ bundle install
-    $ rspec spec/imdb/movie_spec.rb
+    $ rspec spec
 
 == LICENSE:
 

data/allocine.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   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.summary     = %q{Easily access the API information on Allocine API.}
+  s.description = %q{Easily use Ruby to find information on allocine API.}
 
   s.rubyforge_project = "allocine"
 

data/lib/allocine.rb

@@ -11,3 +11,6 @@ require 'allocine/movie'
 require 'allocine/movie_list'
 require 'allocine/search'
 require 'allocine/version'
+require 'allocine/serie'
+require 'allocine/season'
+require 'allocine/episode'

data/lib/allocine/allocine_base.rb

@@ -6,9 +6,9 @@ module Allocine
   
   # Represents a AllocineBase
   class AllocineBase
-    attr_accessor :id, :url, :title, :also_known_as
+    attr_accessor :id, :url, :title
     
-    def initialize(allocine_id, title = nil, also_known_as = [])
+    def initialize(allocine_id, title = nil)
       @id = allocine_id
       @url = "http://api.allocine.fr/rest/v3/movie?code=#{allocine_id}&profile=large&format=json&partner=YW5kcm9pZC12M3M"
     end

data/lib/allocine/episode.rb

@@ -0,0 +1,65 @@
+module Allocine
+  
+  class Episode
+
+    # Represent an Episode on Allocine website
+    # s = Allocine::Episode.new(233014)
+    # e = s.title
+    
+    attr_accessor :title, :synopsis, :number, :release_date
+    
+    def initialize(allocine_id)
+      @id = allocine_id
+    end
+    
+    # Returns the season parent
+    def season
+      Allocine::Season.new(document["parentSeason"]["code"])
+    end
+
+    # Returns the serie parent
+    def serie
+      Allocine::Serie.new(document["parentSeries"]["code"])
+    end
+    
+    # Returns the title
+    def title
+      document["title"] rescue nil
+    end
+
+    # Returns the original title
+    def original_title
+      document["originalTitle"] rescue nil
+    end
+    
+    # Returns the broadcast date
+    def original_broadcast_date
+      document["originalBroadcastDate"] rescue nil
+    end
+    
+    # Returns the plot
+    def plot(short = true)
+      short == true ? document["synopsisShort"] : document["synopsis"] 
+    end
+    
+    def episode_number_series
+      document["episodeNumberSeries"]
+    end
+
+    def episode_number_season
+      document["episodeNumberSeason"]
+    end
+
+    private
+    
+     def document
+       @document ||= Allocine::Episode.find_by_id(@id)
+     end
+
+     def self.find_by_id(allocine_id)
+       url = "http://api.allocine.fr/rest/v3/episode?partner=YW5kcm9pZC12M3M&code=#{allocine_id}&profile=large&format=json"
+       JSON.parse(Net::HTTP.get_response(URI.parse(url)).body)["episode"]
+     end
+    
+  end
+end

data/lib/allocine/movie_list.rb

@@ -1,7 +1,21 @@
 module Allocine
 
   class MovieList
-  
+    def movies
+      @movies ||= parse_movies
+    end
+    
+    private
+    def parse_movies
+      id, originalTitle = nil
+      movies = []
+      document["movie"].each do |element|
+        id = element['code']
+        title = element['originalTitle']
+        movies << Allocine::Movie.new(id, originalTitle)
+      end
+      movies
+    end
   end
-  
+
 end

data/lib/allocine/search.rb

@@ -1,6 +1,31 @@
 module Allocine
   
   class Search < MovieList
+    attr_reader :query
+
+    # Initialize a new Allocine search with the specified query
+    #
+    #   search = Allocine::Search.new("Superman")
+    #
+    def initialize(query)
+      @query = query
+    end
+    
+    # Returns an array of Allocine::Movie objects for easy search result yielded.
+    def movies
+      @movies ||= parse_movies
+    end
+
+    private
+    def document
+      @document ||= Allocine::Search.query(@query)
+    end
+    
+    def self.query(query)
+      url = "http://api.allocine.fr/rest/v3/search?partner=YW5kcm9pZC12M3M&filter=movie,tvseries&q=#{query}&format=json"
+      JSON.parse(Net::HTTP.get_response(URI.parse(URI.encode(url))).body)["feed"] rescue nil
+    end
+        
     
   end
 end

data/lib/allocine/season.rb

@@ -0,0 +1,63 @@
+module Allocine
+  
+  class Season
+    attr_accessor :id, :url, :season_number, :episodes
+    
+    # Represent a serie Season on Allocine website
+    # s = Allocine::Season.new(12277)
+    # e = s.episodes.first
+    
+    
+    def initialize(id)
+      @id = id
+      @episodes = []
+    end
+    
+    # Returns parent serie
+    def serie
+      Allocine::Serie.new(document["parentSeries"]["code"])
+    end
+
+    # Returns season number    
+    def season_number
+      document["seasonNumber"] rescue nil
+    end
+    
+    # Returns numbers of episode
+    def episode_count
+      document["episodeCount"] rescue nil
+    end
+             
+    # Returns numbers of episode
+    def episode_numbers
+      document["episode"].size rescue nil
+    end
+    
+    # Returns an Array of episode ids
+    def episode_ids
+      document["episode"].map { |episode| episode["code"]} rescue []
+    end
+
+    # Returns an Array of Allocine::Episode
+    def episodes
+      s = []
+      episode_ids.each do |allocine_id|
+        s << Allocine::Episode.new(allocine_id)
+      end
+      s
+    end
+        
+   private
+
+    def document
+      @document ||= Allocine::Season.find_by_id(@id)
+    end
+
+    def self.find_by_id(allocine_id)
+      url = "http://api.allocine.fr/rest/v3/season?partner=YW5kcm9pZC12M3M&code=#{allocine_id}&profile=large&format=json"
+      JSON.parse(Net::HTTP.get_response(URI.parse(url)).body)["season"]
+    end
+    
+  end
+  
+end

data/lib/allocine/serie.rb

@@ -0,0 +1,54 @@
+module Allocine
+  
+  class Serie < AllocineBase
+    
+    # s = Allocine::Serie.new(223)
+    # e = s.seasons.first.episodes.first
+    
+
+    def initialize(allocine_id, title = nil)
+      @id = allocine_id
+      @url = "http://api.allocine.fr/rest/v3/tvseries?partner=YW5kcm9pZC12M3M&code=#{allocine_id}&profile=large&format=json"
+    end
+
+    def number_of_seasons
+      document["seasonCount"] rescue nil
+    end
+    
+    def number_of_episodes
+      document["episodeCount"] rescue nil
+    end
+    
+    def year_start
+      document["yearStart"] rescue nil
+    end
+    
+    def year_end
+      document["yearEnd"] rescue nil
+    end
+
+    def season_ids
+      document["season"].map { |season| season["code"]} rescue []
+    end
+    
+    def seasons
+      s = []
+      season_ids.each do |allocine_id|
+        s << Allocine::Season.new(allocine_id)
+      end
+      s
+    end
+
+    private
+
+    def document
+      @document ||= Allocine::Serie.find_by_id(@id)
+    end
+
+    def self.find_by_id(allocine_id)
+      url = "http://api.allocine.fr/rest/v3/tvseries?partner=YW5kcm9pZC12M3M&code=#{allocine_id}&profile=large&format=json"
+      JSON.parse(Net::HTTP.get_response(URI.parse(url)).body)["tvseries"]
+    end
+      
+  end
+end

data/lib/allocine/version.rb

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

data/script/console

@@ -6,7 +6,7 @@ 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"
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r /Users/matthieu/Dev/rails/perso/allocine/lib/allocine.rb"
 puts "Loading allocine gem"
 exec "#{irb} #{libs} --simple-prompt"

data/spec/allocine/episode_spec.rb

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+# This test uses "Lost - season 6 episode 1" as a testing sample:
+#   
+#     http://api.allocine.fr/rest/v3/episode?partner=YW5kcm9pZC12M3M&code=#{allocine_id}&profile=large&format=json
+#
+
+describe "Allocine::Episode" do
+  
+  describe "valid episode" do
+
+    before(:each) do
+      @episode = Allocine::Episode.new("233014")
+    end
+
+    it "should find the plot" do
+      @episode.plot.should eql("Deux situations parallèles se font face. Dans la première, l'explosion a eu l'effet escompté. A bord du vol Oceanic 815 entre Sydney à Los Angeles, l'appareil subit de violentes turbulences qui cessent rapidement. Mais des choses ont changé : Desmond est là alors qu'à l'origine, il n'était pas à bord...")
+    end
+      
+    it "should find the title" do
+      @episode.title.should =~ /On efface tout/
+    end
+    
+    it "should find the the broadcast date" do
+      @episode.original_broadcast_date.should eql("2010-02-02")
+    end
+
+    it "should find the serie parent" do
+      @episode.serie.id.should eql(223)
+    end
+    
+    it "should find the season parent" do
+      @episode.season.id.should eql(12277)
+    end
+  end
+    
+end

data/spec/{imdb → allocine}/movie_spec.rb

@@ -63,10 +63,6 @@ describe "Allocine::Movie" 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

data/spec/allocine/season_spec.rb

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+# This test uses "Lost - season 6" as a testing sample:
+#   
+#     http://api.allocine.fr/rest/v3/season?partner=YW5kcm9pZC12M3M&code=#{allocine_id}&profile=large&format=json
+#
+
+describe "Allocine::Season" do
+  
+  describe "valid season" do
+
+    before(:each) do
+      @serie = Allocine::Season.new("12277")
+    end
+    
+    it "should find the season_number" do
+      @serie.season_number.should eql(6)
+    end
+      
+    it "should find the episode count" do
+      @serie.episode_count.should eql(18)
+    end
+    
+    it "should find the serie parent" do
+      @serie.serie.id.should eql(223)
+    end
+    
+  end
+    
+end

data/spec/spec_helper.rb

@@ -1,12 +1,3 @@
-# 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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allocine_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-05 00:00:00.000000000 +01:00
+date: 2011-11-06 00:00:00.000000000 +01:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hpricot
-  requirement: &2168755320 !ruby/object:Gem::Requirement
+  requirement: &2164553800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 0.8.4
   type: :runtime
   prerelease: false
-  version_requirements: *2168755320
+  version_requirements: *2164553800
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2168754820 !ruby/object:Gem::Requirement
+  requirement: &2164550840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168754820
+  version_requirements: *2164550840
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2168754240 !ruby/object:Gem::Requirement
+  requirement: &2164541800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,8 +44,8 @@ dependencies:
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *2168754240
-description: Easily use Ruby to find information on allocine website.
+  version_requirements: *2164541800
+description: Easily use Ruby to find information on allocine API.
 email:
 - lamarque.matthieu@gmail.com
 executables: []
@@ -60,12 +60,18 @@ files:
 - allocine.gemspec
 - lib/allocine.rb
 - lib/allocine/allocine_base.rb
+- lib/allocine/episode.rb
 - lib/allocine/movie.rb
 - lib/allocine/movie_list.rb
 - lib/allocine/search.rb
+- lib/allocine/season.rb
+- lib/allocine/serie.rb
 - lib/allocine/version.rb
 - script/console
-- spec/imdb/movie_spec.rb
+- spec/allocine/episode_spec.rb
+- spec/allocine/movie_spec.rb
+- spec/allocine/season_spec.rb
+- spec/allocine/serie_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/mlamarque/allocine
@@ -91,7 +97,10 @@ rubyforge_project: allocine
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Easily access the publicly available information on Allocine website.
+summary: Easily access the API information on Allocine API.
 test_files:
-- spec/imdb/movie_spec.rb
+- spec/allocine/episode_spec.rb
+- spec/allocine/movie_spec.rb
+- spec/allocine/season_spec.rb
+- spec/allocine/serie_spec.rb
 - spec/spec_helper.rb