mail_extract 0.1.3 → 0.1.4

data/README.md

@@ -12,31 +12,48 @@ It removes all quoted text and signatures leaving only original text.
 
 ### General usage
 
-    require 'mail_extract'
+```ruby
+require 'mail_extract'
 
-    body = MailExtract::Parser.new('MESSAGE').body
+body = MailExtract::Parser.new('MESSAGE').body
 
-    # or via shortcut
-    body = MailExtract.new('MESSAGE').body
+# or via shortcut
+body = MailExtract.new('MESSAGE').body
+
+# or via another shortcut
+body = MailExtract.parse('MESSAGE')
+```
 
 ### Using with Mail gem
 
-    require 'mail'
-    require 'mail_extract'
-
-    mail = Mail.read_from_string(YOUR_MESSAGE_BODY)
-    
-    # find only plain-text parts
-    if mail.multipart?
-      part = mail.parts.select { |p| p.content_type =~ /text\/plain/ }.first rescue nil
-      unless part.nil?
-        message = part.body.decoded
-      end
-    else
-      message = part.body.decoded
-    end
-
-    clean_message = MailExtract.new(message).body
+```ruby
+require 'mail'
+require 'mail_extract'
+
+mail = Mail.read_from_string(YOUR_MESSAGE_BODY)
+
+# find only plain-text parts
+if mail.multipart?
+  part = mail.parts.select { |p| p.content_type =~ /text\/plain/ }.first rescue nil
+  unless part.nil?
+    message = part.body.decoded
+  end
+else
+  message = part.body.decoded
+end
+
+clean_message = MailExtract.new(message).body
+```
+
+### Configuration
+
+If you need to grab only a head part of the message body you need to specify *:only_head* parameter:
+
+```ruby
+MailExtract.new(message, :only_head => true)
+```
+
+This is extremely useful if you're parsing an email from mobile devices (iphone?) which do not follow the quote pattens.
 
 ## Known issues
 

data/lib/mail_extract.rb

@@ -5,10 +5,24 @@ module MailExtract
   class << self
     # Shortcut to MailExtract::Parser.new
     #
+    # body    - Email message contents
+    # options - Parser options
+    #
     # @return [MailExtract::Parser]
     #
     def new(body, options={})
       MailExtract::Parser.new(body, options)
     end
+    
+    # Parse the email message
+    #
+    # body    - Email message contents
+    # options - Parser options
+    #
+    # @return [String]
+    #
+    def parse(body, options={})
+      MailExtract::Parser.new(body, options).body
+    end
   end
 end

data/lib/mail_extract/version.rb

@@ -1,5 +1,5 @@
 module MailExtract
   unless defined? ::MailExtract::VERSION
-    VERSION = "0.1.3".freeze
+    VERSION = "0.1.4".freeze
   end
 end

data/spec/mail_extract_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe 'MailExtract' do
+  it 'parses an email via shortcuts' do
+    MailExtract.new(fixture('simple.txt')).body.should == result_fixture('simple.txt')
+    MailExtract.parse(fixture('simple.txt')).should == result_fixture('simple.txt')
+  end
+end

metadata

@@ -1,49 +1,44 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mail_extract
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.4
   prerelease: 
-  version: 0.1.3
 platform: ruby
-authors: 
+authors:
 - Dan Sosedoff
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-12 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2161093000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2161093000
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2161092340 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.6"
+      - !ruby/object:Gem::Version
+        version: '2.6'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *2161092340
 description: Email body parser that strips out all quotes and signatures.
 email: dan.sosedoff@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
@@ -63,37 +58,34 @@ files:
 - spec/fixtures/simple.txt
 - spec/fixtures/simple_with_quotes.txt
 - spec/line_spec.rb
+- spec/mail_extract_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/sosedoff/mail_extract
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Extracts email message body
-test_files: 
+test_files:
 - spec/fixtures/iphone.txt
 - spec/fixtures/iphone_with_quotes.txt
 - spec/fixtures/reply_with_quotes.txt
@@ -102,5 +94,6 @@ test_files:
 - spec/fixtures/simple.txt
 - spec/fixtures/simple_with_quotes.txt
 - spec/line_spec.rb
+- spec/mail_extract_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb