RubyGems - mms2r - Versions diffs - 1.1.7 → 1.1.8 - Mend

mms2r 1.1.7 → 1.1.8

Files changed (11) hide show

data/History.txt +8 -1
data/Manifest.txt +4 -0
data/README.txt +1 -0
data/conf/mms2r_orange_france_media_ignore.yml +6 -0
data/lib/mms2r.rb +3 -1
data/lib/mms2r/media.rb +12 -10
data/lib/mms2r/orange_france_media.rb +10 -0
data/test/fixtures/orangefrance-text-and-image.mail +68 -0
data/test/test_mms2r_media.rb +8 -23
data/test/test_mms2r_orange_france_media.rb +53 -0
metadata +9 -4

data/History.txt CHANGED Viewed

@@ -1,6 +1,13 @@
+== 1.1.8 / 2007-09-08 (James Grishnack - Head of Behemoth Productions, producer
+   of Blood Ocean)
+* Added support for Orange of France, Orange orange.fr (Julian Biard)
+* purge in the process block removed, purge must be called explicitly
+  after processing to clean up extracted temporary media files.
 == 1.1.7 / 2007-08-25 (Adam Nergal, friend of Skwisgaar, but not Pickles)
-* Added suport for Orange of Poland Orange mmsemail.orange.pl (Zbigniew
+* Added suport for Orange of Poland, Orange mmsemail.orange.pl (Zbigniew
   Sobiecki)
 * Cleaned up documentation modifiers
 * Cleaned out non-Ruby code idioms

data/Manifest.txt CHANGED Viewed

@@ -11,6 +11,7 @@ conf/mms2r_media_ignore.yml
 conf/mms2r_media_subject.yml
 conf/mms2r_my_cingular_media_subject.yml
 conf/mms2r_nextel_media_ignore.yml
+conf/mms2r_orange_france_media_ignore.yml
 conf/mms2r_orange_poland_media_subject.yml
 conf/mms2r_sprint_media_ignore.yml
 conf/mms2r_sprint_media_subject.yml
@@ -27,6 +28,7 @@ lib/mms2r/m_mode_media.rb
 lib/mms2r/media.rb
 lib/mms2r/my_cingular_media.rb
 lib/mms2r/nextel_media.rb
+lib/mms2r/orange_france_media.rb
 lib/mms2r/orange_poland_media.rb
 lib/mms2r/sprint_media.rb
 lib/mms2r/sprint_pcs_media.rb
@@ -74,6 +76,7 @@ test/fixtures/nextel-image-01.mail
 test/fixtures/nextel-image-02.mail
 test/fixtures/nextel-image-03.mail
 test/fixtures/nextel-image-04.mail
+test/fixtures/orangefrance-text-and-image.mail
 test/fixtures/orangepoland-text-01.mail
 test/fixtures/orangepoland-text-02.mail
 test/fixtures/simple-with-two-images-two-texts.mail
@@ -102,6 +105,7 @@ test/test_mms2r_m_mode_media.rb
 test/test_mms2r_media.rb
 test/test_mms2r_my_cingular_media.rb
 test/test_mms2r_nextel_media.rb
+test/test_mms2r_orange_france_media.rb
 test/test_mms2r_orange_poland_media.rb
 test/test_mms2r_sprint_media.rb
 test/test_mms2r_sprint_pcs_media.rb

data/README.txt CHANGED Viewed

@@ -26,6 +26,7 @@ Corpus of carriers currently processed by MMS2R:
 * Helio => mms.myhelio.com
 * Nextel => messaging.nextel.com
 * Orange (Poland) => mmsemail.orange.pl
+* Orange (France) => orange.fr
 * Sprint => pm.sprint.com
 * Sprint => messaging.sprintpcs.com
 * T-Mobile => tmomail.net

data/conf/mms2r_orange_france_media_ignore.yml ADDED Viewed

@@ -0,0 +1,6 @@
+---
+application/smil:
+- !ruby/regexp /^<smil><head><layout><root-layout height=/
+text/plain:
+- banniere.txt

data/lib/mms2r.rb CHANGED Viewed

@@ -13,6 +13,7 @@ require 'mms2r/helio_media'
 require 'mms2r/m_mode_media'
 require 'mms2r/my_cingular_media'
 require 'mms2r/nextel_media'
+require 'mms2r/orange_france_media'
 require 'mms2r/orange_poland_media'
 require 'mms2r/sprint_media'
 require 'mms2r/sprint_pcs_media'
@@ -37,6 +38,7 @@ module MMS2R
     'mmode.com' => MMS2R::MModeMedia,
     'mms.mycingular.com' => MMS2R::MyCingularMedia,
     'messaging.nextel.com' => MMS2R::NextelMedia,
+    'orange.fr' => MMS2R::OrangeFranceMedia,
     'mmsemail.orange.pl' => MMS2R::OrangePolandMedia,
     'pm.sprint.com' => MMS2R::SprintMedia,
     'messaging.sprintpcs.com' => MMS2R::SprintPcsMedia,
@@ -63,7 +65,7 @@ module MMS2R
     ##
     # MMS2R Library version
-    VERSION = '1.1.7'
+    VERSION = '1.1.8'
     end

data/lib/mms2r/media.rb CHANGED Viewed

@@ -54,6 +54,11 @@ module MMS2R
     attr_reader :media_dir
+    ##
+    # Various multi-parts that are bundled into mail
+    MULTIPARTS_TO_SPLIT = [ 'multipart/related', 'multipart/alternative', 'multipart/mixed' ]
     ##
     # Factory method that creates MMS2R::Media products.
     #
@@ -180,22 +185,21 @@ module MMS2R
     # overridden unless there is an extreme special case in processing the
     # media of a MMS (like Sprint)
     #
-    # Helpers methods for the process template:
+    # Helper methods for the process template:
     # * ignore_media? -- true if the media contained in a part should be ignored.
     # * process_media -- retrieves media to temporary file, returns path to file.
     # * transform_text -- called by process_media, strips out advertising.
     # * temp_file -- creates a temporary filepath based on information from the part.
     #
     # Block support:
-    # Calling process() with a block to automatically iterate through media
-    # and *purge* after the block yields. For example, to process and receive
-    # all media types of video, you can do:
+    # Calling process() with a block to automatically iterate through media.
+    # For example, to process and receive all media types of video, you can do:
     #   mms.process do |media_type, file|
     #     results << file if media_type =~ /video/
     #   end
     #
-    # note: auto-purging is a feature of calling process() with a block, purge
-    # must be explicitly called otherwise
+    # note: purge must be explicitly called to remove the media files
+    #       mms2r extracts from an mms message.
     def process() # :yields: media_type, file
       @logger.info("#{self.class} processing") unless @logger.nil?
@@ -210,7 +214,7 @@ module MMS2R
       # double check for multipart/related, if it exists
       # replace it with its children parts
       parts.each do |p|
-        if self.class.part_type?(p).eql?('multipart/related')
+        if MULTIPARTS_TO_SPLIT.include?(self.class.part_type?(p))
           part = parts.delete(p)
           part.parts.each { |mp| parts << mp }
         end
@@ -238,7 +242,6 @@ module MMS2R
       if block_given?
         media.each do |k, v|
           yield(k, v)
-          purge
         end
       end
@@ -289,9 +292,8 @@ module MMS2R
         if m.eql?('text') || type.eql?('application/smil')
           s = part.body.gsub(/\s+/m," ").strip
           break(i) if i.match(s)
-        else
-          break(i) if filename?(part).eql?(i)
         end
+        break(i) if filename?(part).eql?(i)
       end
       return ignore.eql?(a) ? false : true # when ignore is equal to 'a' that
                                           # means none of the breaks fired in

data/lib/mms2r/orange_france_media.rb ADDED Viewed

@@ -0,0 +1,10 @@
+module MMS2R
+  ##
+  # Orange-France version of MMS2R::Media
+  #
+  # Orange uses multipart/mixed
+  class MMS2R::OrangeFranceMedia < MMS2R::Media
+  end
+end

data/test/fixtures/orangefrance-text-and-image.mail ADDED Viewed

@@ -0,0 +1,68 @@
+Message-ID: <803565.1188978142556.JavaMail.root@tn-03>
+Date: Wed, 5 Sep 2007 09:42:22 +0200 (CEST)
+From: <0688675309@orange.fr>
+To: example@example.com
+Mime-Version: 1.0
+X-Mms-Delivery-Report: no
+X-Mms-Delivery-Time: Wed, 05 Sep 2007 09:42:22 CEST
+X-Mms-MMS-Version: 1.0
+X-Mms-Message-Class: Personal
+X-Mms-Message-Type: m-send-req
+X-Mms-Message-Size: 56110
+Original_Msg_Size: 56110
+X-Mms-Read-Reply: no
+X-Mms-Sender-Visibility: Show
+X-Mms-Transaction-ID: 4660@
+X-Mms-Message-ID: 5181920103@ericsson.mms.orange.fr
+X-Priority: 3
+X-MMS-OPERATOR: ORANGE
+Content-Type: multipart/mixed; boundary="------------755776262782926"
+X-Ovh-Remote: 80.12.242.30 (smtp59.orange.fr)
+X-Ovh-Local: 213.186.33.73 (mx3.ovh.net)
+X-Spam-Check: DONE|H 0.5/N
+--------------755776262782926
+Content-Type: multipart/mixed;
+	boundary="----=_Part_3197436_24584554.1188978142551"
+------=_Part_3197436_24584554.1188978142551
+Content-Type: application/smil; charset=utf-8
+Content-Transfer-Encoding: 7bit
+Content-ID: <AAAA>
+<smil><head><layout><root-layout height="1200px" width="1600px"/><region fit="hidden" height="1170px" id="Image" left="0px" top="0px" width="1600px"/><region fit="hidden" height="30px" id="Text" left="0px" top="1171px" width="1600px"/></layout></head><body><par dur="5000ms"><img region="Image" src="IMAGE.jpeg"/><text region="Text" src="Ar1.txt"/></par></body></smil>
+------=_Part_3197436_24584554.1188978142551
+Content-Type: image/jpeg; name=IMAGE.jpeg
+Content-Transfer-Encoding: base64
+Content-ID: <IMAGE.jpeg>
+Content-Location: IMAGE.jpeg
+/9j/4AAQSkZJRgABAQEASABIAAD/4QAWRXhpZgAATU0AKgAAAAgAAAAAAAD//gAXQ3JlYXRl
+ZCB3aXRoIFRoZSBHSU1Q/9sAQwAFAwQEBAMFBAQEBQUFBgcMCAcHBwcPCwsJDBEPEhIRDxER
+ExYcFxMUGhURERghGBodHR8fHxMXIiQiHiQcHh8e/9sAQwEFBQUHBgcOCAgOHhQRFB4eHh4e
+Hh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4e/8AAEQgAAQAB
+AwEiAAIRAQMRAf/EABUAAQEAAAAAAAAAAAAAAAAAAAAH/8QAFBABAAAAAAAAAAAAAAAAAAAA
+AP/EABUBAQEAAAAAAAAAAAAAAAAAAAcI/8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAwDAQAC
+EQMRAD8AlgA6WW//2Q==
+------=_Part_3197436_24584554.1188978142551
+Content-Type: text/plain; name=Ar1.txt; charset=utf-8
+Content-Transfer-Encoding: 7bit
+Content-ID: <Ar1.txt>
+Content-Location: Ar1.txt
+Test ma poule
+------=_Part_3197436_24584554.1188978142551--
+--------------755776262782926
+Content-Type: text/plain; name=banniere.txt; charset=iso-8859-1
+Content-Transfer-Encoding: 8bit
+Un abonn� Orange vous a envoy� ce message directement depuis son t�l�phone mobile. Vous aussi, communiquez en images avec MMS, les Messages Multim�dia. Rendez-vous sur www.orange.fr.
+--------------755776262782926--

data/test/test_mms2r_media.rb CHANGED Viewed

@@ -16,22 +16,6 @@ class MMS2R::MediaTest < Test::Unit::TestCase
   JENNYSNUMER = '2068675309'
   GENERIC_CARRIER = 'mms.example.com'
-  CARRIER_TO_CLASS = {
-    'mms2r.media' => MMS2R::Media,
-    'mms.att.net' => MMS2R::ATTMedia,
-    'cingularme.com' => MMS2R::CingularMeMedia,
-    'mms.dobson.net' => MMS2R::DobsonMedia,
-    'mms.myhelio.com' => MMS2R::HelioMedia,
-    'mmode.com' => MMS2R::MModeMedia,
-    'mms.mycingular.com' => MMS2R::MyCingularMedia,
-    'messaging.nextel.com' => MMS2R::NextelMedia,
-    'pm.sprint.com' => MMS2R::SprintMedia,
-    'messaging.sprintpcs.com' => MMS2R::SprintPcsMedia,
-    'tmomail.net' => MMS2R::TMobileMedia,
-    'vzwpix.com' => MMS2R::VerizonMedia,
-    'vtext.com' => MMS2R::VtextMedia
-  }
   def use_temp_dirs
     MMS2R::Media.tmp_dir = @tmpdir
     MMS2R::Media.conf_dir = @confdir
@@ -103,7 +87,8 @@ class MMS2R::MediaTest < Test::Unit::TestCase
       assert(File::exist?(file), "file #{file} does not exist")
       assert(File.basename(file) =~ /spacer\.gif/, "file #{file} does not exist")
     end
-    assert !File.exist?(file_array.first)
+    # mms.purge has to be called manually
+    assert File.exist?(file_array.first)
   end
   def test_collect_text_plain
@@ -159,7 +144,7 @@ class MMS2R::MediaTest < Test::Unit::TestCase
   end
   def test_create
-    CARRIER_TO_CLASS.each {|car, cls|
+    MMS2R::CARRIER_CLASSES.each do |car, cls|
       mail = TMail::Mail.new
       mail.from = ["#{JENNYSNUMER}@#{car}"]
       mms = MMS2R::Media.create(mail)
@@ -167,16 +152,16 @@ class MMS2R::MediaTest < Test::Unit::TestCase
       mms = MMS2R::Media.create(mail)
       assert_equal cls, mms.class, "expected a #{cls} and received a #{mms.class}"
       assert_equal car, mms.carrier, "expected a #{car} and received a #{mms.carrier}"
-    }
+    end
   end
   def test_logging
-    CARRIER_TO_CLASS.each {|car, cls|
+    MMS2R::CARRIER_CLASSES.each do |car, cls|
       mail = TMail::Mail.new
       mail.from = ["#{JENNYSNUMER}@#{car}"]
       mms = MMS2R::Media.create(mail,@log)
       assert_equal cls, mms.class, "expected a #{cls} and received a #{mms.class}"
-    }
+    end
   end
   def test_tmp_dir
@@ -366,13 +351,13 @@ class MMS2R::MediaTest < Test::Unit::TestCase
     subjects = [nil, '', '(no subject)']
     mail = TMail::Mail.parse(load_mail('hello_world_mail_plain_no_content_type.mail').join)
-    subjects.each{|s|
+    subjects.each do |s|
       mail.subject = s
       mms = MMS2R::Media.create(mail)
       mms.process
       assert_equal nil, mms.get_subject, "Default subject not scrubbed."
       mms.purge
-    }
+    end
     mail = TMail::Mail.parse(load_mail('hello_world_mail_plain_no_content_type.mail').join)
     mms = MMS2R::Media.create(mail)

data/test/test_mms2r_orange_france_media.rb ADDED Viewed

@@ -0,0 +1,53 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require File.dirname(__FILE__) + "/test_helper"
+require 'test/unit'
+require 'rubygems'
+require 'mms2r'
+require 'mms2r/media'
+require 'tmail/mail'
+require 'logger'
+class MMS2R::OrangeFranceMediaTest < Test::Unit::TestCase
+  include MMS2R::TestHelper
+  def test_create_should_return_orange_france
+    mail = TMail::Mail.parse(load_mail('orangefrance-text-and-image.mail').join)
+    mms = MMS2R::Media.create(mail)
+    assert_equal MMS2R::OrangeFranceMedia, mms.class, "expected a #{MMS2R::OrangeFranceMedia} and received a #{mms.class}"
+  end
+  def test_empty_subject
+    mail = TMail::Mail.parse(load_mail('orangefrance-text-and-image.mail').join)
+    mms = MMS2R::Media.create(mail)
+    mms.process
+    assert_nil mms.get_subject
+  end
+  def test_processed_content
+    mail = TMail::Mail.parse(load_mail('orangefrance-text-and-image.mail').join)
+    mms = MMS2R::Media.create(mail)
+    mms.process
+    # there should be one text and one image
+    assert_equal 2, mms.media.size
+    #text
+    # there is a text banner that Orange attaches but
+    # that should be ignored
+    assert_not_nil mms.media['text/plain']
+    assert_equal 1, mms.media['text/plain'].size
+    file = mms.media['text/plain'].first
+    assert File::exist?(file), "file #{file} does not exist"
+    text = IO.readlines("#{file}").join
+    assert_match /Test ma poule/, text
+    # image
+    assert_not_nil mms.media['image/jpeg']
+    assert_equal 1, mms.media['image/jpeg'].size
+    assert_match /IMAGE.jpeg$/, mms.media['image/jpeg'].first
+    assert_file_size mms.media['image/jpeg'].first, 337
+    mms.purge
+  end
+end

metadata CHANGED Viewed

@@ -3,15 +3,15 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: mms2r
 version: !ruby/object:Gem::Version
-  version: 1.1.7
-date: 2007-08-27 00:00:00 -07:00
+  version: 1.1.8
+date: 2007-09-08 00:00:00 -07:00
 summary: Extract user media from MMS (and not carrier cruft)
 require_paths:
 - lib
 email: mikemondragon@gmail.com
 homepage: http://mms2r.rubyforge.org/
 rubyforge_project: mms2r
-description: "== DESCRIPTION:  MMS2R is a library that decodes the parts of an MMS message to disk while  stripping out advertising injected by the cellphone carriers.  MMS messages are  multipart email and the carriers often inject branding into these messages.  Use MMS2R if you want to get at the real user generated content from a MMS without having to deal with the cruft from the carriers.  If MMS2R is not aware of a particular carrier no extra processing is done  to the MMS other than decoding and consolidating its media.  Contact the author to add additional carriers to be processed by the  library.  Suggestions and patches appreciated and welcomed!  Corpus of carriers currently processed by MMS2R:  * AT&T => mms.att.net * AT&T/Cingular => mmode.com * Cingular => mms.mycingular.com * Cingular => cingularme.com * Dobson/Cellular One => mms.dobson.net * Helio => mms.myhelio.com * Nextel => messaging.nextel.com * Orange (Poland) => mmsemail.orange.pl * Sprint => pm.sprint.com * Sprint => messaging.sprintpcs.com * T-Mobile => tmomail.net * Verizon => vzwpix.com * Verizon => vtext.com"
+description: "== DESCRIPTION:  MMS2R is a library that decodes the parts of an MMS message to disk while  stripping out advertising injected by the cellphone carriers.  MMS messages are  multipart email and the carriers often inject branding into these messages.  Use MMS2R if you want to get at the real user generated content from a MMS without having to deal with the cruft from the carriers.  If MMS2R is not aware of a particular carrier no extra processing is done  to the MMS other than decoding and consolidating its media.  Contact the author to add additional carriers to be processed by the  library.  Suggestions and patches appreciated and welcomed!  Corpus of carriers currently processed by MMS2R:  * AT&T => mms.att.net * AT&T/Cingular => mmode.com * Cingular => mms.mycingular.com * Cingular => cingularme.com * Dobson/Cellular One => mms.dobson.net * Helio => mms.myhelio.com * Nextel => messaging.nextel.com * Orange (Poland) => mmsemail.orange.pl * Orange (France) => orange.fr * Sprint => pm.sprint.com * Sprint => messaging.sprintpcs.com * T-Mobile => tmomail.net * Verizon => vzwpix.com * Verizon => vtext.com"
 autorequire:
 default_executable:
 bindir: bin
@@ -42,6 +42,7 @@ files:
 - conf/mms2r_media_subject.yml
 - conf/mms2r_my_cingular_media_subject.yml
 - conf/mms2r_nextel_media_ignore.yml
+- conf/mms2r_orange_france_media_ignore.yml
 - conf/mms2r_orange_poland_media_subject.yml
 - conf/mms2r_sprint_media_ignore.yml
 - conf/mms2r_sprint_media_subject.yml
@@ -58,6 +59,7 @@ files:
 - lib/mms2r/media.rb
 - lib/mms2r/my_cingular_media.rb
 - lib/mms2r/nextel_media.rb
+- lib/mms2r/orange_france_media.rb
 - lib/mms2r/orange_poland_media.rb
 - lib/mms2r/sprint_media.rb
 - lib/mms2r/sprint_pcs_media.rb
@@ -105,6 +107,7 @@ files:
 - test/fixtures/nextel-image-02.mail
 - test/fixtures/nextel-image-03.mail
 - test/fixtures/nextel-image-04.mail
+- test/fixtures/orangefrance-text-and-image.mail
 - test/fixtures/orangepoland-text-01.mail
 - test/fixtures/orangepoland-text-02.mail
 - test/fixtures/simple-with-two-images-two-texts.mail
@@ -133,6 +136,7 @@ files:
 - test/test_mms2r_media.rb
 - test/test_mms2r_my_cingular_media.rb
 - test/test_mms2r_nextel_media.rb
+- test/test_mms2r_orange_france_media.rb
 - test/test_mms2r_orange_poland_media.rb
 - test/test_mms2r_sprint_media.rb
 - test/test_mms2r_sprint_pcs_media.rb
@@ -152,6 +156,7 @@ test_files:
 - test/test_mms2r_sprint_media.rb
 - test/test_mms2r_vtext_media.rb
 - test/test_mms2r_dobson_media.rb
+- test/test_mms2r_orange_france_media.rb
 - test/test_mms2r_m_mode_media.rb
 - test/test_mms2r_verizon_media.rb
 - test/test_helper.rb
@@ -196,5 +201,5 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.2.1
     version: