exjournal 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Trampoline Systems Ltd
+
+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/README.rdoc

@@ -0,0 +1,19 @@
+= exjournal
+
+Description goes here.
+
+== Contributing to exjournal
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Trampoline Systems Ltd. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "exjournal"
+  gem.homepage = "http://github.com/trampoline/exjournal"
+  gem.license = "MIT"
+  gem.summary = %Q{extract original messages from Exchange Journal entry messages}
+  gem.description = %Q{Exchange journalling wraps emails as a MIME attachment of a journal message. This extracts the original message our of a journal message}
+  gem.email = "craig@trampolinesystems.com"
+  gem.authors = ["Trampoline Systems Ltd"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_dependency "actionmailer", "~> 2.3.10"
+  gem.add_development_dependency "rspec", "~> 1.3.0"
+  gem.add_development_dependency "jeweler", "~> 1.5.2"
+  gem.add_development_dependency "rcov", ">= 0"
+  gem.add_development_dependency "rr", ">= 0.10.5"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "exjournal #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/exjournal.rb

@@ -0,0 +1,83 @@
+require 'action_mailer'
+require 'tmail'
+
+module Exjournal
+  module_function
+  
+  # extract the first message/rfc822 attachment from the RFC822 encoded content, and return it as a TMail::Mail
+  # if +headers_only+ is true then message content will be discarded, and only headers processed
+  def extract_journalled_mail(mail, strip_content=true)
+    journal_mail = TMail::Mail.parse(mail) if mail.is_a?(String)
+    
+    # get the attachment
+    attachment = journal_mail.parts.select{ |p| p.content_disposition == "attachment" || p.content_type == "message/rfc822" }.first
+    
+    # complain if the email has no attachment to extract
+    raise "attempted to extract journalled mail, but message has no attachments: \n#{mail}\n\n" unless attachment
+
+    mail_content = strip_content ? discard_mail_body(attachment.body) : attachment.body
+
+    TMail::Mail.parse(mail_content)
+  end
+
+  # discard everything after the first \n\n , i.e. all message body content from an RFC822 encoded mail
+  def discard_mail_body(content)
+    content.gsub(/^(.*?)\r\n\r\n.*$/m, '\1')
+  end
+
+  # remove angle brackets from a header string
+  def strip_header(header)
+    header.gsub(/^<(.*)>$/, '\1')
+  end
+
+  def with_headers(headers)
+    [*(headers||[])].map{|h| yield h}
+  end
+
+  # remove angle brackets from one or more headers
+  def strip_headers(headers)
+    with_headers(headers){|h| strip_header(h)}
+  end
+
+  # parse an address to a hash
+  def parse_address(address)
+    address = TMail::Address.parse(address) if address.is_a?(String)
+    {:name=>address.name, :address=>address.address}
+  end
+
+  # parse one or more addresses to hash
+  def parse_addresses(addresses)
+    [*(addresses||[])].map{|a| parse_address(a)}
+  end
+
+  # turn a TMail::Mail into a has suitable for JSON representation
+  def mail_to_hash(mail, strip_content=true)
+    mail = TMail::Mail.parse(mail) if mail.is_a?(String)
+
+    message_id = strip_header(mail.message_id) if mail.message_id
+    sent_at = mail.date.xmlschema
+    in_reply_to = strip_headers(mail.in_reply_to) if mail.in_reply_to
+    references = strip_headers(mail.references) if mail.references
+    from = parse_addresses(mail.from_addrs).first
+    to = parse_addresses(mail.to_addrs)
+    cc=parse_addresses(mail.cc_addrs)
+    bcc=parse_addresses(mail.bcc_addrs)
+
+    h = {
+      :message_id=>message_id,
+      :sent_at=>sent_at,
+      :in_reply_to=>in_reply_to,
+      :references=>references,
+      :from=>from,
+      :to=>to,
+      :cc=>cc,
+      :bcc=>bcc
+    }
+
+    if !strip_content
+      h[:subject] = mail.subject
+    end
+
+    h
+  end
+end

data/spec/exjournal_spec.rb

@@ -0,0 +1,127 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Exjournal" do
+  describe "extract_journalled_mail" do
+    it "should extract the first message/rfc822 attachment without content" do
+      s=File.read(File.expand_path("../fixtures/email_with_email_attachment.eml", __FILE__))
+      jm = Exjournal.extract_journalled_mail(s)
+      jm.message_id.should == "<0FDFBAF6-0960-40FB-B730-B0C7C3299948@empire42.com>"
+      jm.body.should =~ /\s*/
+    end
+
+    it "should extract the first message/rfc822 attachment with content" do
+      s=File.read(File.expand_path("../fixtures/email_with_email_attachment.eml", __FILE__))
+      jm = Exjournal.extract_journalled_mail(s, false)
+      jm.message_id.should == "<0FDFBAF6-0960-40FB-B730-B0C7C3299948@empire42.com>"
+      jm.body.should !~ /\s*/
+    end
+
+    it "should raise if there is no message/rfc822 attachment" do
+      s=File.read(File.expand_path("../fixtures/email_without_attachment.eml", __FILE__))
+      lambda{
+        Exjournal.extract_journalled_mail(s)
+      }.should raise_error(/has no attachments/)
+    end
+  end
+
+  describe "discard_mail_body" do
+    it "should discard everything after \r\n\r\n" do
+      s=<<-EOF
+From: foo@bar.com\r
+To: baz@boo.com\r
+Subject: i can't tell you\r
+\r
+because it's a secret\r
+      EOF
+      Exjournal.discard_mail_body(s).should =~ /^From: foo@bar.com.*tell you$/m
+    end
+
+    it "should do nothing if no \r\n\r\n" do
+      s=<<-EOF
+From: foo@bar.com\r
+To: baz@boo.com\r
+Subject: i can't tell you
+      EOF
+      Exjournal.discard_mail_body(s).should == s
+    end
+  end
+
+  describe "strip_header" do
+    it "should strip angle brackets if present" do
+      Exjournal.strip_header("<foo>").should == "foo"
+    end
+
+    it "should do nothing if no angle brackets" do
+      Exjournal.strip_header("foo").should == "foo"
+    end
+  end
+
+  describe "strip_headers" do
+    it "should strip_header from a single header" do
+      Exjournal.strip_headers("<foo>").should == ["foo"]
+    end
+
+    it "should strip_header from more than one header" do
+      Exjournal.strip_headers(["<foo>", "<bar>"]).should == ["foo", "bar"]
+    end
+  end
+
+  describe "parse_address" do
+    it "should extract a hash from an address" do
+      h = Exjournal.parse_address(TMail::Address.parse('"foo mcfoo" <foo@bar.com>'))
+      h.should == {:name=>"foo mcfoo", :address=>"foo@bar.com"}
+    end
+  end
+
+  describe "parse_addresses" do
+    it "should extract a hash from a single address" do
+      h = Exjournal.parse_addresses(TMail::Address.parse('"foo mcfoo" <foo@bar.com>'))
+      h.should == [{:name=>"foo mcfoo", :address=>"foo@bar.com"}]
+    end
+
+    it "should extract hashes from more than one address" do
+      h = Exjournal.parse_addresses([TMail::Address.parse('"foo mcfoo" <foo@bar.com>'),
+                                     TMail::Address.parse('"baz mcbaz" <baz@boo.com>')])
+      h.should == [{:name=>"foo mcfoo", :address=>"foo@bar.com"},
+                   {:name=>"baz mcbaz", :address=>"baz@boo.com"}]
+    end
+  end
+
+  describe "mail_to_hash" do
+    it "should turn a mail to json excluding subject" do
+      s=File.read(File.expand_path("../fixtures/email_with_references.eml", __FILE__))    
+      h = Exjournal.mail_to_hash(s)
+
+      h[:message_id].should == "B63CAA43-F378-4033-BA8B-ED408805B5B5@empire42.com"
+      h[:sent_at].should == DateTime.parse('Wed, 21 Apr 2010 14:43:24 +0100').xmlschema
+      h[:in_reply_to].should == ["B63CAA43-F378-4033-BA8B-foo@empire42.com"]
+      h[:references].should == ["B63CAA43-F378-4033-BA8B-foo@empire42.com", 
+                                "B63CAA43-F378-4033-BA8B-bar@empire42.com", 
+                                "B63CAA43-F378-4033-BA8B-baz@empire42.com"]
+      h[:from].should == {:name=>"Peter MacRobert", :address=>"peter.macrobert@empire42.com"}
+      h[:to].should == [{:name=>nil, :address=>"foo@bar.com"},
+                        {:name=>"bar mcbar", :address=>"bar.mcbar@bar.com"}]
+      h[:cc].should == []
+      h[:bcc].should == []
+      h[:subject].should == nil
+    end
+
+    it "should turn a mail to json including subject" do
+      s=File.read(File.expand_path("../fixtures/email_with_references.eml", __FILE__))    
+      h = Exjournal.mail_to_hash(s, false)
+
+      h[:message_id].should == "B63CAA43-F378-4033-BA8B-ED408805B5B5@empire42.com"
+      h[:sent_at].should == DateTime.parse('Wed, 21 Apr 2010 14:43:24 +0100').xmlschema
+      h[:in_reply_to].should == ["B63CAA43-F378-4033-BA8B-foo@empire42.com"]
+      h[:references].should == ["B63CAA43-F378-4033-BA8B-foo@empire42.com", 
+                                "B63CAA43-F378-4033-BA8B-bar@empire42.com", 
+                                "B63CAA43-F378-4033-BA8B-baz@empire42.com"]
+      h[:from].should == {:name=>"Peter MacRobert", :address=>"peter.macrobert@empire42.com"}
+      h[:to].should == [{:name=>nil, :address=>"foo@bar.com"},
+                        {:name=>"bar mcbar", :address=>"bar.mcbar@bar.com"}]
+      h[:cc].should == []
+      h[:bcc].should == []
+      h[:subject].should == "Test email"
+    end
+  end
+end

data/spec/fixtures/email_with_email_attachment.eml

@@ -0,0 +1,52 @@
+Subject: Top-level email
+Mime-Version: 1.0 (Apple Message framework v1078)
+Content-Type: multipart/related;
+	type="text/html";
+	boundary=Apple-Mail-1--656091021
+X-Apple-Base-Url: x-msg://3/
+X-Universally-Unique-Identifier: 505346e8-98bc-41b0-95a2-0f60a22e4589
+X-Apple-Mail-Remote-Attachments: YES
+From: Peter MacRobert <peter.macrobert@empire42.com>
+X-Apple-Windows-Friendly: 1
+Date: Wed, 21 Apr 2010 14:26:08 +0100
+X-Apple-Mail-Signature: 
+Message-Id: <6612CEDB-F33D-4588-83C5-AFB2B28FD85A@empire42.com>
+X-Uniform-Type-Identifier: com.apple.mail-draft
+To: foo2@example.com
+
+
+--Apple-Mail-1--656091021
+Content-Transfer-Encoding: 7bit
+Content-Type: text/html;
+	charset=us-ascii
+
+<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; ">This is the main email content. This email has an attachment which is another email.<div><object type="application/x-apple-msg-attachment" data="cid:93E2F850-5D35-4619-87A1-469BB289F188@snowdonia.trampolinesystems.com" id="eee2d418-5b17-4488-8c96-f9d1fcad486c" height="46" width="150" apple-width="yes" apple-height="yes"></object></div></body></html>
+--Apple-Mail-1--656091021
+Content-Transfer-Encoding: 7bit
+Content-Disposition: attachment;
+	filename="This is an attachment"
+Content-Type: message/rfc822;
+	x-mac-hide-extension=yes;
+	x-unix-mode=0666;
+	name="This is an attachment"
+Content-Id: <93E2F850-5D35-4619-87A1-469BB289F188@snowdonia.trampolinesystems.com>
+
+Subject: This is an attachment
+Mime-Version: 1.0 (Apple Message framework v1078)
+Content-Type: text/html;
+	charset=us-ascii
+X-Apple-Base-Url: x-msg://1/
+X-Universally-Unique-Identifier: c7cc15b2-7186-4f82-9936-894288fe9450
+X-Apple-Mail-Remote-Attachments: YES
+From: Peter MacRobert <peter.macrobert@empire42.com>
+X-Apple-Windows-Friendly: 1
+Date: Wed, 21 Apr 2010 14:25:01 +0100
+X-Apple-Mail-Signature: 
+Content-Transfer-Encoding: 7bit
+Message-Id: <0FDFBAF6-0960-40FB-B730-B0C7C3299948@empire42.com>
+X-Uniform-Type-Identifier: com.apple.mail-draft
+To: foo@bar.com
+
+<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; ">Attached email.</body></html>
+
+--Apple-Mail-1--656091021--

data/spec/fixtures/email_with_references.eml

@@ -0,0 +1,20 @@
+Subject: Test email
+Mime-Version: 1.0 (Apple Message framework v1078)
+Content-Type: text/html;
+	charset=us-ascii
+X-Apple-Base-Url: x-msg://1/
+X-Universally-Unique-Identifier: c7cc15b2-7186-4f82-9936-894288fe9450
+X-Apple-Mail-Remote-Attachments: YES
+From: Peter MacRobert <peter.macrobert@empire42.com>
+X-Apple-Windows-Friendly: 1
+Date: Wed, 21 Apr 2010 14:43:24 +0100
+Content-Transfer-Encoding: 7bit
+Message-Id: <B63CAA43-F378-4033-BA8B-ED408805B5B5@empire42.com>
+In-Reply-To: <B63CAA43-F378-4033-BA8B-foo@empire42.com>
+References: <B63CAA43-F378-4033-BA8B-foo@empire42.com>
+ <B63CAA43-F378-4033-BA8B-bar@empire42.com>
+ <B63CAA43-F378-4033-BA8B-baz@empire42.com>
+X-Uniform-Type-Identifier: com.apple.mail-draft
+To: foo@bar.com, "bar mcbar" <bar.mcbar@bar.com>
+
+<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; ">Plain email with no attachments.</body></html>

data/spec/fixtures/email_without_attachment.eml

@@ -0,0 +1,16 @@
+Subject: Test email
+Mime-Version: 1.0 (Apple Message framework v1078)
+Content-Type: text/html;
+	charset=us-ascii
+X-Apple-Base-Url: x-msg://1/
+X-Universally-Unique-Identifier: c7cc15b2-7186-4f82-9936-894288fe9450
+X-Apple-Mail-Remote-Attachments: YES
+From: Peter MacRobert <peter.macrobert@empire42.com>
+X-Apple-Windows-Friendly: 1
+Date: Wed, 21 Apr 2010 14:43:24 +0100
+Content-Transfer-Encoding: 7bit
+Message-Id: <B63CAA43-F378-4033-BA8B-ED408805B5B5@empire42.com>
+X-Uniform-Type-Identifier: com.apple.mail-draft
+To: foo@bar.com
+
+<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; ">Plain email with no attachments.</body></html>

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubygems'
+require 'spec'
+require 'spec/autorun'
+require 'rr'
+require 'exjournal'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+Spec::Runner.configure do |config|
+  config.mock_with RR::Adapters::Rspec
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: exjournal
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Trampoline Systems Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-23 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionmailer
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 3
+        - 10
+        version: 2.3.10
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 0
+        - 10
+        - 5
+        version: 0.10.5
+  type: :development
+  version_requirements: *id005
+description: Exchange journalling wraps emails as a MIME attachment of a journal message. This extracts the original message our of a journal message
+email: craig@trampolinesystems.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/exjournal.rb
+- spec/exjournal_spec.rb
+- spec/fixtures/email_with_email_attachment.eml
+- spec/fixtures/email_with_references.eml
+- spec/fixtures/email_without_attachment.eml
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/trampoline/exjournal
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: extract original messages from Exchange Journal entry messages
+test_files: 
+- spec/exjournal_spec.rb
+- spec/spec_helper.rb