mail2frontmatter 0.0.1 → 0.0.2

data/fixtures/no_attachments.eml

@@ -0,0 +1,61 @@
+                                                                                                                                                                                                                                                               
+Delivered-To: stream@kunalashah.com
+Received: by 10.216.42.73 with SMTP id i51csp1168497web;
+        Mon, 12 Jan 2015 16:14:52 -0800 (PST)
+X-Received: by 10.170.120.195 with SMTP id m186mr27431216ykb.27.1421108091508;
+        Mon, 12 Jan 2015 16:14:51 -0800 (PST)
+Return-Path: <me@kunalashah.com>
+Received: from mail-yk0-x229.google.com (mail-yk0-x229.google.com. [2607:f8b0:4002:c07::229])
+        by mx.google.com with ESMTPS id t25si5238386yhg.25.2015.01.12.16.14.50
+        for <stream@kunalashah.com>
+        (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128);
+        Mon, 12 Jan 2015 16:14:51 -0800 (PST)
+Received-SPF: none (google.com: me@kunalashah.com does not designate permitted sender hosts) client-ip=2607:f8b0:4002:c07::229;
+Authentication-Results: mx.google.com;
+       spf=none (google.com: me@kunalashah.com does not designate permitted sender hosts) smtp.mail=me@kunalashah.com;
+       dkim=pass header.i=@kunalashah.com
+Received: by mail-yk0-f169.google.com with SMTP id 79so21939ykr.0
+        for <stream@kunalashah.com>; Mon, 12 Jan 2015 16:14:50 -0800 (PST)
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
+        d=kunalashah.com; s=google;
+        h=mime-version:date:message-id:subject:from:to:content-type;
+        bh=hya9e//LW4XQ2bkKvEYKS38O0pdjqIhxVUGoAex/w5M=;
+        b=fVomZxRYAjkkH3p498EkXyvZiO6Z5WPwEuFzlMyJGTOCFJMzANfJ4vkl8P/LFpzHz4
+         Ql2q1s/nbLRdBKANbHNh442okwVIy/shBjFT1uRt0LQ5n0CiIjz5SbE6BSdEnp6eSDtQ
+         oQE3yqJnkf/X4yC0If2HawkZ98hjfz2TKDths=
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
+        d=1e100.net; s=20130820;
+        h=x-gm-message-state:mime-version:date:message-id:subject:from:to
+         :content-type;
+        bh=hya9e//LW4XQ2bkKvEYKS38O0pdjqIhxVUGoAex/w5M=;
+        b=iOD7ofc0a5kQhf/lZnJC9kXIXBPzlWH6eKog61pofebqNJfSLZHkw4jC2A9Y19VjuY
+         jpb4l247HJC3F1aYWCBeetUeoE/XOblN5A8/jygSXvpCIJTgTOH/Udgz4kxRjae01FOY
+         bPxGinme7Nln+MMSGVq/7KGqPYRopTj7zcO0aOsiegQgVqSshml6umHTSJS21QGWDgZS
+         XWUMukc4JlcZscLFKP9EEQjvCEPmEI32L0KR/kcvQLcJsz5QAFQfbPhm7tSzPXuuY/1/
+         Wot5+1NRK9XFAjXF9X6NUNixNAFzo6qsCM8FUoFgbCjo7+E85VY0Y5lixNLkn5h9rOeB
+         677w==
+X-Gm-Message-State: ALoCoQmw5gttL+2jOT4D8w/7c3QySWp8/TW1ZlM0yazuZFLm5Fmc3/nyHioSBE2ud1EuPPdlKCoo
+MIME-Version: 1.0
+X-Received: by 10.170.95.7 with SMTP id m7mr28078171yka.67.1421108090560; Mon,
+ 12 Jan 2015 16:14:50 -0800 (PST)
+Received: by 10.170.205.16 with HTTP; Mon, 12 Jan 2015 16:14:50 -0800 (PST)
+X-Originating-IP: [66.108.230.254]
+Received: by 10.170.205.16 with HTTP; Mon, 12 Jan 2015 16:14:50 -0800 (PST)
+Date: Mon, 12 Jan 2015 19:14:50 -0500
+Message-ID: <CAN-VoWnLrcfGJ6kdEK-Ba2B3ENE6h2OpRMRF91svJVMb3U5fNA@mail.gmail.com>
+Subject: [thoughts] the earth is the best manufacturer we have
+From: Kunal Shah <me@kunalashah.com>
+To: stream@kunalashah.com
+Content-Type: multipart/alternative; boundary=001a113aba9cecfbdc050c7d82bb
+
+--001a113aba9cecfbdc050c7d82bb
+Content-Type: text/plain; charset=UTF-8
+
+vv
+
+--001a113aba9cecfbdc050c7d82bb
+Content-Type: text/html; charset=UTF-8
+
+<p dir="ltr">vv</p>
+
+--001a113aba9cecfbdc050c7d82bb--

data/lib/mail2frontmatter/parser.rb

@@ -60,8 +60,8 @@ module Mail2FrontMatter
       @body = @body.inner_html
 
       @metadata = {
-        from:        message[:to].value,
-        to:          message[:from].value,
+        from:        message[:from].value,
+        to:          message[:to].value,
         received:    message.date,
         subject:     message.subject,
         attachments: attachments

data/lib/mail2frontmatter/preprocessor.rb

@@ -1,23 +1,5 @@
 
 # Pre-processes blog data, allows hooks
-# 
-# 
-# Build a Pre-Processor that accepts two arguments
-# metadata, a symbolized hash of metadata extracted from the email
-# and body, a Nokogiri parsed representation of the email
-# 
-# modify as necessary and as atomically as possible and return two arguments
-# 
-# example:
-# 
-# module Mail2FrontMatter
-#   class MyProcessor < PreProcessor
-#     def self.run(metadata, body)
-#       metadata[:some_field] = some_transformation_of(metadata[:some_field])
-#       return metadata, body
-#     end
-#   end
-# end
 
 module Mail2FrontMatter
   class PreProcessor

data/lib/mail2frontmatter/version.rb

@@ -1,3 +1,3 @@
 module Mail2FrontMatter
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/mail2frontmatter.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mailman"
   spec.add_dependency "activesupport"
 
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 end

data/spec/parser_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'byebug'
+
+describe Mail2FrontMatter::Parser, "parsing" do
+
+  let(:message_one) { Mail::Message.new(File.read(File.join(M2FM_GEM_PATH, 'fixtures', 'attachments.eml'))) }
+
+  it "should parse HTML email" do
+    expect {
+      Mail2FrontMatter::Parser.new(message_one)
+    }.to_not raise_error
+  end
+
+  it "should return an html body as a string" do
+    Mail2FrontMatter::Parser.new(message_one).body.should match(/Charlie<br>/)
+  end
+
+  it "should return have an email metadata hash with a from key" do
+    from = Mail2FrontMatter::Parser.new(message_one).metadata[:from]
+    from.should eq("Kunal Shah <kunalashokshah@gmail.com>")
+  end
+
+  it "should return have an email metadata hash with a to key" do
+    to = Mail2FrontMatter::Parser.new(message_one).metadata[:to]
+    to.should eq("stream@kunalashah.com")
+  end
+
+  it "should return have an email metadata hash with a received key" do
+    received = Mail2FrontMatter::Parser.new(message_one).metadata[:received]
+    received.class.should eq(DateTime)
+  end
+
+  it "should return have an email metadata hash with a subject key" do
+    subject = Mail2FrontMatter::Parser.new(message_one).metadata[:subject]
+    subject.should eq("295 Abandoned Elevator Shaft")
+  end
+
+  it "should save attachments to disk" do
+    attachment_path = Mail2FrontMatter::Parser.new(message_one).metadata[:attachments].first[1][:filepath]
+    File.exist?(attachment_path).should eq(true)
+  end
+
+end

data/spec/preprocessor_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'byebug'
+
+describe Mail2FrontMatter::PreProcessor, "registration" do
+
+  let(:invalidly_defined_preprocessor) { 
+    class MyInvalidProcessor < Mail2FrontMatter::PreProcessor
+      # note, instanced not class
+      def run(metadata, body)
+        # some modification
+        return metadata, body
+      end
+    end
+
+    return MyInvalidProcessor
+  }
+
+  let(:validly_defined_preprocessor) { 
+    class MyValidProcessor < Mail2FrontMatter::PreProcessor
+      def self.run(metadata, body)
+        # some modification
+        return metadata, body
+      end
+    end
+
+    return MyValidProcessor
+  }
+
+  it "should raise errors for invalid processors" do
+    expect {
+      invalidly_defined_preprocessor.register({})
+    }.to raise_error
+  end
+
+  it "should not raise errors for valid processors" do
+    expect {
+      validly_defined_preprocessor.register({})
+    }.to_not raise_error
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+
+M2FM_GEM_PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+require 'yaml'
+require File.join(M2FM_GEM_PATH, 'lib', 'mail2frontmatter')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail2frontmatter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kunal Shah
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-12 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mailman
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +109,9 @@ files:
 - README.md
 - Rakefile
 - bin/mail2frontmatter
+- fixtures/attachments.eml
+- fixtures/attachments_inline.eml
+- fixtures/no_attachments.eml
 - lib/mail2frontmatter.rb
 - lib/mail2frontmatter/parser.rb
 - lib/mail2frontmatter/preprocessor.rb
@@ -88,6 +119,9 @@ files:
 - lib/mail2frontmatter/watcher.rb
 - lib/mail2frontmatter/writer.rb
 - mail2frontmatter.gemspec
+- spec/parser_spec.rb
+- spec/preprocessor_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/whistlerbrk/Mail2FrontMatter
 licenses:
 - MIT
@@ -112,4 +146,7 @@ rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Email-to-blog parser which creates YAML FrontMatter
-test_files: []
+test_files:
+- spec/parser_spec.rb
+- spec/preprocessor_spec.rb
+- spec/spec_helper.rb