cine-passion 0.7.0 → 0.8.0

data/Manifest.txt

@@ -3,7 +3,6 @@ Manifest.txt
 README.txt
 Rakefile
 lib/cine_passion.rb
-lib/cine_passion_config.rb.sample
 test/test_cine_passion.rb
 test/data/cinepassion-scraper-test-00-no-response.xml
 test/data/cinepassion-scraper-test-01-one-response.xml

data/README.txt

@@ -22,7 +22,13 @@ http://passion-xbmc.org/scraper-cine-passion-support-francais/
 
 == SYNOPSIS:
 
-  FIX (code sample of usage)
+require 'cine_passion'
+@scrap = CinePassion.new("my-real-api-key")
+@scrap.MovieSearch("Home")
+#=> Return you a movies list 
+@scrap.movies_info
+#=> All info are here
+
 
 == REQUIREMENTS:
 
@@ -31,14 +37,11 @@ In my project, you can't find Cine Passion API Key.
 In fact you need a key your own side, you can request one here :
 http://passion-xbmc.org/demande-clef-api-api-key-request/
 
-See INSTALL
+See INSTALL & SYNOPSIS
 
 == INSTALL:
 
 * gem install cine-passion
-* cd /lib/to/gem/cine-passion
-* cp lib/cine_passion_config.rb.sample lib/cine_passion_config.rb
-* edit lib/cine_passion_config.rb # And replace APIKEY
 
 == DEVELOPERS:
 

data/lib/cine_passion.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 # This class can be used to extract data from Cine Passion scraper
 #
 # = API Key
@@ -16,75 +17,112 @@ require 'net/http'
 require 'rexml/document'
 include REXML
 
-begin
-   require 'cine_passion_config'
-rescue LoadError => load_error
-   # Define default variables
-   SITEURL="http://scraper-cine-passion-demo.ledez.net"
-   APIKEY="fake-7945cb-fake"
-
-   puts '*'*50
-   puts File.join(File.dirname(__FILE__), 'cine_passion_config.rb') + " is missing"
-   puts " Please see README to create it"
-   puts "currently I use theres values :"
-   puts "SITEURL: #{SITEURL}"
-   puts "APIKEY; #{APIKEY}"
-   puts '*'*50
-end
-
-if not (defined? SITEURL || (not SITEURL.nil?))
-   raise 'Need to define SITEURL'
-end
-
-if not (defined? APIKEY || (not APIKEY.nil?))
-   raise 'Need to define APIKEY'
-end
-
 class CinePassion
-  attr_reader :xml_data, :movies_info, :result_nb, :status, :quota
-
-  VERSION = '0.7.0'
-
+  attr_reader :xml_data, :movies_info, :result_nb, :status, :quota, :apikey, :siteurl, :proxyinfo, :lang
+  
+  VERSION = '0.8.0'
+  
   # This class does not require parameters
   # First action is reset object
-  def initialize
+  def initialize(apikey=nil, proxy=nil)
+     if apikey.nil?
+        @apikey = "fake-7945cb-fake"
+        defineOtherSiteURL("http://scraper-cine-passion-demo.ledez.net")
+        puts '*'*50
+        puts "I need a apikey to get real values"
+        puts " Please see README to create it"
+        puts "currently I use theres values :"
+        puts "@siteurl: #{@siteurl}"
+        puts "@apikey; #{@apikey}"
+        puts '*'*50
+     else
+        @apikey = apikey
+        defineOtherSiteURL("http://passion-xbmc.org")
+     end
+     
+     @proxy_host = @proxy_port = @proxy_user = @proxy_password = nil
+     if (ENV['http_proxy'] || proxy)
+         uri=URI.parse(ENV['http_proxy']) if proxy.nil?
+         uri=URI.parse(proxy) if ENV['http_proxy'].nil?
+         @proxy_host = uri.host
+         @proxy_port = uri.port
+         @proxy_user, @proxy_password = uri.userinfo.split(/:/) if uri.userinfo
+     end
+     @proxyinfo = [@proxy_host, @proxy_port, @proxy_user, @proxy_password]
+     
+     self.defineLanguage()
      self.DataReset()
   end
-
+  
+  # Define other host to scrap
+  #  Default http://passion-xbmc.org
+  def defineOtherSiteURL(siteurl=nil)
+      if siteurl.nil?
+        @siteurl = "http://passion-xbmc.org"
+      else
+        @siteurl = siteurl
+      end
+  end
+  
+  # define a language to scrap
+  #  Default en
+  def defineLanguage(lang="en")
+    @lang = lang
+  end
+  
   # Reset object (With empty XML xml_data)
   def DataReset()
     @xml_data = ""
   end
-
+  
   # Load XML data from online Cine Passion Scraper
   # Put movie name in parameter
-  def DataLoadFromSite(search)
-    query="Title" #|IMDB"
-    lang="fr" # / en"
-    format="XML"
-    api_url="#{SITEURL}/scraper/API/1/Movie.Search/#{query}/#{lang}/#{format}/#{APIKEY}/#{search}"
-
-    url = URI.parse(URI.escape(api_url))
-        res = Net::HTTP.start(url.host, url.port) {|http|
-        http.get(url.path)
+  def DataLoadFromSite(url)
+    conn = Net::HTTP::Proxy(@proxy_host, @proxy_port, @proxy_user, @proxy_password)
+    
+    request = URI.parse(URI.escape(url))
+        res = conn.start(request.host, request.port) {|http|
+        http.get(request.path)
     }
-
+    
     @xml_data = res.body
     self.ScrapAnalyse()
   end
-
+  
+  # Generate URL For Movie.Search
+  def GenerateURLMovieSearch(search, query="Title", format="XML")
+    "#{@siteurl}/scraper/API/1/Movie.Search/#{query}/#{@lang}/#{format}/#{@apikey}/#{search}"
+  end
+  
+  # Generate URL For Movie.GetInfo
+  def GenerateURLMovieGetInfo(search, query="Title", format="XML")
+    "#{@siteurl}/scraper/API/1/Movie.GetInfo/#{query}/#{@lang}/#{format}/#{@apikey}/#{search}"
+  end
+  
+  # Execute a MovieSearch on scraper
+  def MovieSearch(search)
+    DataLoadFromSite(GenerateURLMovieSearch(search))
+    @xml_data
+  end
+  
+  # Execute a MovieGetInfo on scraper
+  def MovieGetInfo(search)
+    DataLoadFromSite(GenerateURLMovieSearch(search))
+    @xml_data
+  end
+  
   # Load XML data from file
   # Put filename with full path in parameter
   def DataLoadFromFile(filename)
     file = File.new(filename)
-
+    
     @xml_data = file
     self.ScrapAnalyse()
   end
-
+  
   # Explore XML data to extract informations
   # At this time the class get there informations:
-  # * Movie -> See ScrapAnalyseOneMovie function
+  # * Movie -> See ScrapAnalyseOneMovieElement function
   # * Quota
   #  - authorize
   #  - use
@@ -96,16 +134,16 @@ class CinePassion
     @result_nb = 0
     @quota = {}
     @movies_info = []
-
+    
     doc = Document.new(@xml_data)
     root = doc.root
-
+    
     @movies_info = []
     root.each_element('movie') do |movie|
-      @movies_info.push ScrapAnalyseOneMovie(movie)
+      @movies_info.push ScrapAnalyseOneMovieElement(movie)
     end
     @result_nb = @movies_info.count()
-
+    
     if @result_nb == 0
       @status = 0
     elsif @result_nb == 1
@@ -114,23 +152,23 @@ class CinePassion
       @status = 2
     end
     
-    quota = root.elements['quota']      
+    quota = root.elements['quota']
     if not quota.nil?
        @quota['authorize']  = quota.attributes['authorize']
        @quota['use']        = quota.attributes['use']
        @quota['reset_date'] = quota.attributes['reset_date']
     end
-
+    
     @result['quota'] = @quota
     @result['result_nb'] = @result_nb
     @result['line'] = @line
     @result['xml'] = doc.root
     @result['status'] = @status
     @result['movies_info'] = @movies_info
-
+    
     return @result
   end
-
+  
   # * Movie
   #  - id
   #  - id_allocine
@@ -144,9 +182,9 @@ class CinePassion
   #  - plot
   #  - images
   #  - ratings
-  def ScrapAnalyseOneMovie(oneMovieXML)
+  def ScrapAnalyseOneMovieElement(oneMovieXML)
     movie_info = {}
-  
+    
     movie_info['id'] = oneMovieXML.elements['id'].text
     movie_info['id_allocine'] = oneMovieXML.elements['id_allocine'].text
     movie_info['id_imdb'] = oneMovieXML.elements['id_imdb'].text
@@ -157,18 +195,18 @@ class CinePassion
     movie_info['year'] = oneMovieXML.elements['year'].text
     movie_info['runtime'] = oneMovieXML.elements['runtime'].text
     movie_info['plot'] = oneMovieXML.elements['plot'].text
-
+    
     movie_info['images'] = {}
     images = oneMovieXML.elements["images"]
     if not images.nil?
       images.each_element("image") do |image|
          img_id = image.attributes['id']
          img_size = image.attributes['size']
-
+         
          if not movie_info['images'].has_key? img_id
             movie_info['images'][img_id] = {}
          end
-
+         
          movie_info['images'][img_id]['type'] = image.attributes['type']
          if not movie_info['images'][img_id].has_key? img_size
             movie_info['images'][img_id][img_size] = {}
@@ -178,7 +216,7 @@ class CinePassion
          movie_info['images'][img_id][img_size]['height'] = image.attributes['height']
       end
     end
-        
+    
     movie_info['ratings'] = {}
     movie_info['ratings']['cinepassion'] = {}
     movie_info['ratings']['allocine'] = {}
@@ -193,16 +231,26 @@ class CinePassion
     ratings_imdb = ratings.elements["rating[@type='imdb']"]
     movie_info['ratings']['imdb']['votes'] = ratings_imdb.attributes['votes']
     movie_info['ratings']['imdb']['value'] = ratings_imdb.text
-
+    
+    nfo_base = "#{@siteurl}/scraper/index.php?id=#{movie_info['id']}&Download=1"
+    movie_info['nfo'] = {}
+    movie_info['nfo']['Babylon'] = {}
+    movie_info['nfo']['Camelot'] = {}
+    nfo_babylon = "#{nfo_base}&Version=0"
+    movie_info['nfo']['Babylon']['fr'] = "#{nfo_babylon}&Lang=fr&OK=1"
+    movie_info['nfo']['Babylon']['en'] = "#{nfo_babylon}&Lang=en&OK=1"
+    nfo_camelot = "#{nfo_base}&Version=1"
+    movie_info['nfo']['Camelot']['fr'] = "#{nfo_camelot}&Lang=fr&OK=1"
+    movie_info['nfo']['Camelot']['en'] = "#{nfo_camelot}&Lang=en&OK=1"
+    
     return movie_info
   end
-
   
   # Scrap get a filename with garbage information & clean it
-  def Scrap(search)
+  def CleanMovieName(search)
     short_name = search.gsub(/\./, ' ')
     short_name.gsub!(/ (DVDRip|LiMiTED|REPACK|720p|FRENCH|UNRATED|iNTERNAL|TRUEFRENCH).*$/, '')
     
-    DataLoadFromSite(short_name)
+    short_name
   end
 end

data/test/test_cine_passion.rb

@@ -1,54 +1,114 @@
+# -*- coding: utf-8 -*-
 require 'test/unit'
 require 'cine_passion'
 
 # Suite tests of CinePassion scraper binding
 # Many tests can be launch offline
 class TestCinePassion < Test::Unit::TestCase
-
+  
   # Test creation of object with right class
   def test_create_object
     @test = CinePassion.new
     assert_not_nil(@test)
     assert_instance_of(CinePassion, @test)
   end
-
+  
+  # Test ability to define a apikey
+  def test_can_have_apikey
+    @test1 = CinePassion.new()
+    assert_equal(@test1.apikey, "test-api-key")
+    @test2 = CinePassion.new("fake-7945cb-fake")
+    assert_equal(@test2.apikey, "test-api-key")
+  end
+  
+  # Test ability to define a server
+  def test_can_change_siteurl
+    @test1 = CinePassion.new()
+    assert_equal(@test1.siteurl, "http://scraper-cine-passion-demo.ledez.net")
+    @test2 = CinePassion.new("a-key")
+    assert_equal(@test2.siteurl, "http://passion-xbmc.org")
+    @test2.defineOtherSiteURL("http://localhost:4567")
+    assert_equal(@test2.siteurl, "http://localhost:4567")
+    @test2.defineOtherSiteURL()
+    assert_equal(@test2.siteurl, "http://passion-xbmc.org")
+  end
+  
+  # Test GenerateURLMovieSearch & GenerateURLMovieGetInfo
+  def test_generate_url
+    @test1 = CinePassion.new()
+    assert_equal(@test1.GenerateURLMovieSearch("toto"), "http://scraper-cine-passion-demo.ledez.net/scraper/API/1/Movie.Search/Title/en/XML/fake-7945cb-fake/toto")
+    assert_equal(@test1.GenerateURLMovieGetInfo("toto"), "http://scraper-cine-passion-demo.ledez.net/scraper/API/1/Movie.GetInfo/Title/en/XML/fake-7945cb-fake/toto")
+  end
+  
+  # Test ability to define a language for requests
+  def test_can_change_language
+    @test1 = CinePassion.new()
+    assert_equal(@test1.lang, "en")
+    @test1.defineLanguage("fr")
+    assert_equal(@test1.lang, "fr")
+  end
+  
+  # Test ability to define a proxy
+  def test_can_have_apikey
+    @test1 = CinePassion.new("test-api-key")
+    assert_equal(@test1.proxyinfo, [nil, nil, nil, nil])
+    
+    @test2 = CinePassion.new("test-api-key", "http://127.0.0.1:3128/")
+    assert_equal(@test2.proxyinfo, ["127.0.0.1", 3128, nil, nil])
+    
+    @test3 = CinePassion.new("test-api-key", "http://user:pass@127.0.0.1:3128/")
+    assert_equal(@test3.proxyinfo, ["127.0.0.1", 3128, "user", "pass"])
+  end
+  
   # Test ability to load data from xml & reset data
   def test_data_load_and_reset
     @test = CinePassion.new
     assert_equal(@test.xml_data, "")
-
+    
     @test.DataLoadFromFile("test/data/cinepassion-scraper-test-01-one-response.xml")
     assert_not_equal(@test.xml_data, "")
-
+    
     @test.DataReset()
     assert_equal(@test.xml_data, "")
   end
-
+  
   # Test ability to load data from network
   def test_data_load_from_network
     @test = CinePassion.new
-
-    @test.DataLoadFromSite("Home")
+    
+    @test.MovieSearch("Home")
+    assert_not_equal(@test.xml_data, "")
+    @test.DataReset()
+    
+    @test.MovieGetInfo("136356")
     assert_not_equal(@test.xml_data, "")
   end
-
+  
   # Test if scrap working
-  def test_scrap_load_data
+  def test_clean_moviename_working
     @test = CinePassion.new
-
-    @test.Scrap("Home")
-    assert_not_equal(@test.xml_data, "")
+    
+    assert_equal(@test.CleanMovieName("Home.DVDRip"), "Home")
+    assert_equal(@test.CleanMovieName("Home.LiMiTED"), "Home")
+    assert_equal(@test.CleanMovieName("Home.REPACK"), "Home")
+    assert_equal(@test.CleanMovieName("Home.720p"), "Home")
+    assert_equal(@test.CleanMovieName("Home.FRENCH"), "Home")
+    assert_equal(@test.CleanMovieName("Home.UNRATED"), "Home")
+    assert_equal(@test.CleanMovieName("Home.iNTERNAL"), "Home")
+    assert_equal(@test.CleanMovieName("Home.TRUEFRENCH"), "Home")
+    assert_equal(@test.CleanMovieName("Home.DVDRip.LiMiTED.REPACK.720p.FRENCH.UNRATED.iNTERNAL.TRUEFRENCH"), "Home")
+    assert_equal(@test.CleanMovieName("Home.TRUEFRENCH.iNTERNAL.UNRATED.FRENCH.720p.REPACK.LiMiTED.DVDRip"), "Home")
   end
-
+  
   # Test if datas was properly extracted
   def test_xml_load_data
     @test = CinePassion.new
-
+    
     # Test no response
     @test.DataLoadFromFile("test/data/cinepassion-scraper-test-00-no-response.xml")
     assert_not_equal(@test.xml_data, "")
     assert_equal(@test.result_nb, 0)
-
+    
     # Extract all data in one result
     @test.DataLoadFromFile("test/data/cinepassion-scraper-test-01-one-response.xml")
     assert_not_equal(@test.xml_data, "")
@@ -63,39 +123,43 @@ class TestCinePassion < Test::Unit::TestCase
     assert_equal(@test.movies_info[0]['year'], "2009")
     assert_equal(@test.movies_info[0]['runtime'], "90")
     assert_equal(@test.movies_info[0]['plot'], "Bob Wilton, un journaliste désespéré fait l'heureuse rencontre de Lyn Cassady, un soldat aux pouvoirs paranormaux combattant le terrorisme. Ils se rendent ensemble en Irak ou ils rencontrent Bill Django, le fondateur de l'unité, et Larry Hooper, soldat de l'unité qui dirige une prison.")
-
+    
     assert_equal(@test.movies_info[0]['images']['311335']['type'], "Poster")
     assert_equal(@test.movies_info[0]['images']['311335']['original']['height'], "2716")
     assert_equal(@test.movies_info[0]['images']['311335']['original']['width'], "2000")
     assert_equal(@test.movies_info[0]['images']['311335']['original']['url'], "http://passion-xbmc.org/scraper/Gallery/main/Poster_LesChvresduPentagone-311335.jpg")
     assert_equal(@test.movies_info[0]['images']['311335']['preview']['url'], "http://passion-xbmc.org/scraper/Gallery/preview/Poster_LesChvresduPentagone-311335.jpg")
     assert_equal(@test.movies_info[0]['images']['311335']['thumb']['url'], "http://passion-xbmc.org/scraper/Gallery/thumb/Poster_LesChvresduPentagone-311335.jpg")
-
+    
     assert_equal(@test.movies_info[0]['images']['316672']['type'], "Fanart")
     assert_equal(@test.movies_info[0]['images']['316672']['original']['height'], "1080")
     assert_equal(@test.movies_info[0]['images']['316672']['original']['width'], "1920")
     assert_equal(@test.movies_info[0]['images']['316672']['original']['url'], "http://passion-xbmc.org/scraper/Gallery/main/Fanart_LesChvresduPentagone-316672.jpg")
     assert_equal(@test.movies_info[0]['images']['316672']['preview']['url'], "http://passion-xbmc.org/scraper/Gallery/preview/Fanart_LesChvresduPentagone-316672.jpg")
     assert_equal(@test.movies_info[0]['images']['316672']['thumb']['url'], "http://passion-xbmc.org/scraper/Gallery/thumb/Fanart_LesChvresduPentagone-316672.jpg")
-
+    
     assert_equal(@test.movies_info[0]['ratings']['cinepassion']['votes'], "1")
     assert_equal(@test.movies_info[0]['ratings']['cinepassion']['value'], "7")
     assert_equal(@test.movies_info[0]['ratings']['allocine']['votes'], "1603")
     assert_equal(@test.movies_info[0]['ratings']['allocine']['value'], "2,5")
     assert_equal(@test.movies_info[0]['ratings']['imdb']['votes'], "30695")
     assert_equal(@test.movies_info[0]['ratings']['imdb']['value'], "6,4")
-
+    
+    assert_equal(@test.movies_info[0]['nfo']['Babylon']['fr'], "http://scraper-cine-passion-demo.ledez.net/scraper/index.php?id=136356&Download=1&Version=0&Lang=fr&OK=1")
+    assert_equal(@test.movies_info[0]['nfo']['Babylon']['en'], "http://scraper-cine-passion-demo.ledez.net/scraper/index.php?id=136356&Download=1&Version=0&Lang=en&OK=1") 
+    assert_equal(@test.movies_info[0]['nfo']['Camelot']['fr'], "http://scraper-cine-passion-demo.ledez.net/scraper/index.php?id=136356&Download=1&Version=1&Lang=fr&OK=1")
+    assert_equal(@test.movies_info[0]['nfo']['Camelot']['en'], "http://scraper-cine-passion-demo.ledez.net/scraper/index.php?id=136356&Download=1&Version=1&Lang=en&OK=1")
+    
     # Quota extraction
     assert_equal(@test.quota['authorize'], "300")
     assert_equal(@test.quota['use'], "1")
     assert_equal(@test.quota['reset_date'], "2010-08-04 12:45:26")
-
   end
   
   def test_xml_load_data_multiple_movies
     @test = CinePassion.new
     @test.DataLoadFromFile("test/data/cinepassion-scraper-test-02-mutiple-response.xml")
-
+    
     # Quota extraction
     assert_not_equal(@test.xml_data, "")
     
@@ -105,7 +169,7 @@ class TestCinePassion < Test::Unit::TestCase
     assert_equal(@test.movies_info[0]['id_allocine'], "128179")
     assert_equal(@test.movies_info[0]['id_imdb'], "1014762")
     assert_equal(@test.movies_info[0]['last_change'], "1279466610")
-
+    
     assert_equal(@test.movies_info[1]['id'], "125081")
     assert_equal(@test.movies_info[1]['id_allocine'], "125081")
     assert_equal(@test.movies_info[1]['id_imdb'], "822388")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cine-passion
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 63
   prerelease: false
   segments: 
   - 0
-  - 7
+  - 8
   - 0
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Nicolas Ledez
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-30 00:00:00 +02:00
+date: 2010-09-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,7 +66,6 @@ files:
 - README.txt
 - Rakefile
 - lib/cine_passion.rb
-- lib/cine_passion_config.rb.sample
 - test/test_cine_passion.rb
 - test/data/cinepassion-scraper-test-00-no-response.xml
 - test/data/cinepassion-scraper-test-01-one-response.xml
@@ -81,7 +80,7 @@ licenses: []
 post_install_message: |
   **************************************************
   
-    Thank you for installing cine-passion-0.7.0
+    Thank you for installing cine-passion-0.8.0
   
     Please be copy lib/lib/cine_passion_config.rb.sample to lib/cine_passion_config.rb
     And replace APIKEY with your own.

data/lib/cine_passion_config.rb.sample

@@ -1,2 +0,0 @@
-SITEURL="http://passion-xbmc.org"
-APIKEY="your_key_here_ruby_cine_passion"