mail2frontmatter 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 050bf37a3ad7a9d3207ce8ffb89c1b204c69e90a
-  data.tar.gz: 4658ee6d6a02c3a7746824d9dfcd0d1a38f9db0f
+  metadata.gz: 0ca545c2952a483060ba2c7b90aa0aeed1c85891
+  data.tar.gz: 96be89bc2de5e5cc89d2daecd2cf0633a8d0fdcd
 SHA512:
-  metadata.gz: a5114ef331caf20a530462e41730ae61a2bf02bd43cf97ccfa23816a88efc7ac5409a6c50eb2e7d44997105bedbbeb125c59357a116083c8379d36d9f71d0dc0
-  data.tar.gz: b6f0d9125761f73d4a3aa8f94899f2c25301cea925a367971267e974a99dcd6fe25f1daeea5aab4e0ddc5b779e9bf1290438fa63eec0b7f0123cd29137368942
+  metadata.gz: 2af70109d10996401cb9b20bf429af5493ef41da128352350d5e31a793aa7a5cc8cf3dfe1b5ef3d824936f57742325e706163df48bb1fdc81990bfd8f3b18e39
+  data.tar.gz: 124aa40da8be4e7bb23199384b0b375046c4f057ca0355999ac1f7a7d4f2f863307946db6b9c76ea25d150d2e59ad740142367ed9b97815d6830c1b98245f366

data/.gitignore

@@ -14,3 +14,5 @@
 mkmf.log
 /source/
 .DS_Store
+/fixtures/data/*.yml
+/fixtures/media/*/*

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.2.0
 script: bundle exec rake

data/README.md

@@ -4,7 +4,9 @@
 
 Email-to-blog parser which creates YAML FrontMatter and saves your attachments.
 
-Designed to be used with either Middleman or Jekyll
+Designed to be used with either Middleman or Jekyll.
+
+This project is actively being developed. I wrap the executable with the [eye](https://github.com/kostya/eye) gem at the moment.
 
 ## Installation
 
@@ -147,6 +149,27 @@ You should always always return metadata and body as shown since this will be pa
 
 ### TODO
 
-* White list sanitization by default
-* defaults for Jekyll out of the box
+* core plugins
+
+Core plugins should be included out of the box and disabled upon request. It's just simpler to use
+
+* zero config for Jekyll
+
+current we 'detect' the directory structure to see if the executable is run from Middleman, 
+do the same for Jekyll in order to support it out of the box with zero configuration
+
+* remove dependency on Mailman, use Mail directly
+
+no need to use Mailman if I intend to manage the process myself. Use Mail directly
+
+* detach runner
+
+incoming mail checks in the main thread, processing, writing, commiting should be handled in a separate process to discard leaks
+
+
+
+
+
+
+
 

data/Rakefile

@@ -1,9 +1,5 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 task default: 'spec'
-
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
-end
+RSpec::Core::RakeTask.new(:spec)

data/bin/mail2frontmatter

@@ -13,34 +13,34 @@ options = {
 }
 
 OptionParser.new do |opts|
-  opts.banner = "Usage: mail2frontmatter [options]"
+  opts.banner = 'Usage: mail2frontmatter [options]'
 
-  opts.on("-k", "--stop", "stop the running process if any") do
+  opts.on('-k', '--stop', 'stop the running process if any') do
     stop = true
   end
 
-  opts.on("-cCONFIG", "--config=CONFIG", "path to configuration file, defaults to ./data/mail2frontmatter.yml") do |config_file|
+  opts.on('-cCONFIG', '--config=CONFIG', 'path to configuration file, defaults to ./data/mail2frontmatter.yml') do |config_file|
     config = config_file
   end
 
-  opts.on("-d", "--detach", "detach process and run in the background") do
+  opts.on('-d', '--detach', 'detach process and run in the background') do
     options[:background] = true
   end
 
-  opts.on("-lLOGFILE", "--log=LOGFILE", "path to log file, defaults to STDOUT in the foreground or ./log/mail2frontmatter.log when daemonized") do |log_file|
+  opts.on('-lLOGFILE', '--log=LOGFILE', 'path to log file, defaults to STDOUT in the foreground or ./log/mail2frontmatter.log when daemonized') do |log_file|
     config[:log_file] = log_file
   end
 
-  opts.on("-pPIDFILE", "--pid=PIDFILE", "path to pid file, defaults to ./tmp/pids/mail2frontmatter.pid") do |pid_file|
+  opts.on('-pPIDFILE', '--pid=PIDFILE', 'path to pid file, defaults to ./tmp/pids/mail2frontmatter.pid') do |pid_file|
     options[:pid_file] = pid_file
   end
 
-  opts.on("-h", "--help", "Prints this help") do
+  opts.on('-h', '--help', 'Prints this help') do
     puts opts
     exit
   end
 
-  opts.on_tail("-v", "--version", "Prints version") do
+  opts.on_tail('-v', '--version', 'Prints version') do
     require File.join(File.dirname(__FILE__), '..', 'lib', 'mail2frontmatter', 'version')
     puts Mail2FrontMatter::VERSION
     exit
@@ -50,8 +50,8 @@ end.parse!
 # TRY TO KILL
 if stop
 
-  if !File.exist?(options[:pid_file])
-    puts "no pidfile! are you sure mail2frontmatter is running?"
+  unless File.exist?(options[:pid_file])
+    puts 'no pidfile! are you sure mail2frontmatter is running?'
     exit 1
   end
 
@@ -63,13 +63,13 @@ if stop
     Process.kill('TERM', pid)
     exit 0
 
-    # FUTURE: library intercepts TERM, 
-    # waits to finish processing if it is
-    # or if kill exits dirty.
+  # FUTURE: library intercepts TERM,
+  # waits to finish processing if it is
+  # or if kill exits dirty.
 
   # CATCH STALE PID
   rescue Errno::ESRCH
-    puts "stale pidfile... cleaning"
+    puts 'stale pidfile... cleaning'
 
     # also exit here! but don't move exit 0 to ensure block
     # because "in the future" we may intelligently intercept pkill above
@@ -90,7 +90,7 @@ require File.join(File.dirname(__FILE__), '..', 'lib', 'mail2frontmatter')
 if options[:background]
 
   # CHECKING ALREADY RUNNING / CHECK STALE
-  if File.exists?(options[:pid_file])
+  if File.exist?(options[:pid_file])
     pid = File.read(options[:pid_file]).to_i
 
     begin
@@ -99,12 +99,12 @@ if options[:background]
       exit 1
 
     rescue Errno::ESRCH
-      puts "stale pidfile... cleaning"
+      puts 'stale pidfile... cleaning'
       File.delete(options[:pid_file])
     end
   end
 
-  puts "daemonizing..."
+  puts 'daemonizing...'
 
   # SET CONFIG...
   Mail2FrontMatter.set_config(config)

data/fixtures/mail2frontmatter/broken-processor.rb

@@ -1,8 +1,8 @@
 module Mail2FrontMatter
   class BrokenProcessor < PreProcessor
     def self.run(metadata, body)
-      raise NoMethodError, "because this is a test"
-      return metadata, body
+      fail NoMethodError, 'because this is a test'
+      [metadata, body]
     end
   end
 end

data/fixtures/mail2frontmatter/fake-processor-with-options.rb

@@ -1,7 +1,7 @@
 module Mail2FrontMatter
   class FakeProcessorWithOptions < PreProcessor
     def self.run(metadata, body)
-      return metadata, body
+      [metadata, body]
     end
   end
 end

data/fixtures/mail2frontmatter/fake-processor.rb

@@ -1,7 +1,7 @@
 module Mail2FrontMatter
   class FakeProcessor < PreProcessor
     def self.run(metadata, body)
-      return metadata, body
+      [metadata, body]
     end
   end
 end

data/lib/mail2frontmatter.rb

@@ -2,5 +2,6 @@ require 'mail2frontmatter/version'
 require 'mail2frontmatter/configuration'
 require 'mail2frontmatter/watcher'
 require 'mail2frontmatter/parser'
-require 'mail2frontmatter/writer'
 require 'mail2frontmatter/preprocessor'
+require 'mail2frontmatter/writer'
+require 'mail2frontmatter/committer'

data/lib/mail2frontmatter/committer.rb

@@ -0,0 +1,68 @@
+
+# Commits Changes to git
+#
+module Mail2FrontMatter
+  class Committer
+    begin
+      require 'rugged'
+      @@available = true
+
+    rescue LoadError
+      @@available = false
+    end
+
+    def self.available?
+      @@available
+    end
+
+    def self.commit(metadata, _body)
+      repo = Rugged::Repository.new(Mail2FrontMatter.config[:git][:path])
+      index = repo.index
+
+      # stage frontmatter/erb
+      relative_path = metadata[:filepath].gsub(Mail2FrontMatter.config[:git][:path] + '/', '')
+
+      index.add(path: relative_path,
+                oid: (Rugged::Blob.from_workdir repo, relative_path),
+                mode: 0100644)
+
+      # stage attachments
+      metadata[:attachments].each_pair do |_k, filemeta|
+        relative_path = filemeta[:filepath].gsub(Mail2FrontMatter.config[:git][:path] + '/', '')
+
+        index.add(path: relative_path,
+                  oid: (Rugged::Blob.from_workdir repo, relative_path),
+                  mode: 0100644)
+      end
+
+      # commit
+      tree = index.write_tree(repo)
+      index.write
+
+      author = {
+        email: Mail2FrontMatter.config[:git][:email] || metadata[:from].match(/\<(.*)\>/)[1],
+        name:  Mail2FrontMatter.config[:git][:name]  || metadata[:from].match(/(.*) \<.*\>/)[1],
+        time:  Time.now
+      }
+
+      Rugged::Commit.create(repo, author:     author,
+                                  committer:  author,
+                                  message:    "post via email, #{metadata[:subject]}",
+                                  parents:    [repo.head.target],
+                                  tree:       tree,
+                                  update_ref: 'HEAD')
+
+      # push
+      begin
+        credentials = Rugged::Credentials::SshKeyFromAgent.new(username: 'git')
+        repo.push 'origin', ['refs/heads/master'], { credentials: credentials }
+      rescue StandardError => e
+        Mail2FrontMatter.logger.info("Could not push!")
+        Mail2FrontMatter.logger.error(e)
+      end
+
+      # return sha
+      repo.references['refs/heads/master'].target_id
+    end
+  end
+end

data/lib/mail2frontmatter/configuration.rb

@@ -3,15 +3,11 @@ module Mail2FrontMatter
   require 'active_support/inflector'
 
   class << self
-    def logger
-      @logger
-    end
+    attr_reader :logger
 
-    def config
-      @config
-    end
+    attr_reader :config
 
-    def set_config(passed_config = nil, &block)
+    def set_config(passed_config = nil, &_block)
       # load config from file
       if passed_config.is_a?(String)
         @config = YAML.load_file(passed_config).deep_symbolize_keys!
@@ -24,14 +20,14 @@ module Mail2FrontMatter
         if File.exist?(default_config)
           @config = YAML.load_file(default_config).deep_symbolize_keys!
         else
-          raise LoadError, 'no configuration given or found at ./data/mail2frontmatter.yml'
+          fail LoadError, 'no configuration given or found at ./data/mail2frontmatter.yml'
         end
 
       elsif passed_config.is_a?(Hash)
         @config = passed_config
 
       else
-        raise ArgumentError, 'not a valid configuration type'
+        fail ArgumentError, 'not a valid configuration type'
       end
 
       # setup logger, use provided location
@@ -47,6 +43,10 @@ module Mail2FrontMatter
         @logger = Logger.new(STDOUT)
       end
 
+      @config[:git] ||= {
+        path:  Dir.pwd
+      }
+
       # set default for data directory unless already specified
       # the data directory is where the posts will be written to
       unless @config[:data_directory]
@@ -83,9 +83,8 @@ module Mail2FrontMatter
           raise e
         end
 
-        klass = "Mail2FrontMatter::#{processor[:key].underscore.camelize}".constantize.register(processor[:options] || {})
+        "Mail2FrontMatter::#{processor[:key].underscore.camelize}".constantize.register(processor[:options] || {})
       end
-
     end
   end
 end

data/lib/mail2frontmatter/parser.rb

@@ -8,19 +8,19 @@ module Mail2FrontMatter
     attr_accessor :message, :metadata, :body
 
     ALLOWED_TYPES = {
-      "audio" => "audio",
-      "video" => "videos", 
-      "image" => "images"
+      'audio' => 'audio',
+      'video' => 'videos',
+      'image' => 'images'
     }
 
     def initialize(message)
       @message = message
       raw_parsed_html = Nokogiri::HTML.parse(@message.html_part.decoded.strip)
 
-      @body = raw_parsed_html.at("body")
+      @body = raw_parsed_html.at('body')
 
       # remove extraneous nesting
-      while(@body.children.count == 1 && @body.children.first.name == "div") do
+      while @body.children.count == 1 && @body.children.first.name == 'div'
         @body = @body.children.first
       end
 
@@ -33,10 +33,10 @@ module Mail2FrontMatter
           media_type_directory = File.join(Mail2FrontMatter.config[:media_directory], Parser::ALLOWED_TYPES[attachment.main_type])
           FileUtils.mkdir_p(media_type_directory)
 
-          filepath = File.join(media_type_directory, attachment.filename) 
+          filepath = File.join(media_type_directory, attachment.filename)
 
           # save attachment
-          File.open(filepath, "w+b", 0644) { |f| f.write attachment.body.decoded }
+          File.open(filepath, 'w+b', 0644) { |f| f.write attachment.body.decoded }
 
           # retain metadata
           attachments[attachment.cid] = {
@@ -67,7 +67,6 @@ module Mail2FrontMatter
         subject:     message.subject,
         attachments: attachments
       }
-
     end
   end
 end

data/lib/mail2frontmatter/preprocessor.rb

@@ -1,11 +1,10 @@
-
 # Pre-processes blog data, allows hooks
 
 module Mail2FrontMatter
   class PreProcessor
     require 'set'
 
-    class InvalidProcessor < StandardError ; end
+    class InvalidProcessor < StandardError; end
 
     @@processors = Set.new
 
@@ -14,8 +13,8 @@ module Mail2FrontMatter
     end
 
     def self.register(options = {})
-      raise InvalidProcessor, "run method not defined on #{self}" if !self.respond_to?(:run)
-      raise ArgumentError, "options must be a hash" unless options.is_a? Hash
+      fail InvalidProcessor, "run method not defined on #{self}" unless self.respond_to?(:run)
+      fail ArgumentError, 'options must be a hash' unless options.is_a? Hash
       @options = options
 
       @@processors << self
@@ -26,13 +25,12 @@ module Mail2FrontMatter
         begin
           metadata, body = processor.run(metadata, body)
         rescue StandardError => e
-          Mail2FrontMatter.logger.error("processor failed!")
+          Mail2FrontMatter.logger.error('processor failed!')
           Mail2FrontMatter.logger.error(e)
         end
       end
 
-      return metadata, body
+      [metadata, body]
     end
-
   end
 end

data/lib/mail2frontmatter/version.rb

@@ -1,3 +1,3 @@
 module Mail2FrontMatter
-  VERSION = "0.1.0"
+  VERSION = '0.1.2'
 end

data/lib/mail2frontmatter/watcher.rb

@@ -4,24 +4,22 @@ module Mail2FrontMatter
   require 'mailman'
 
   class Watcher
-
     def self.run
       mail_protocol = Mail2FrontMatter.config[:protocol] || :imap
       poll_interval = Mail2FrontMatter.config[:interval] || 60
 
-      @receiver = Mail2FrontMatter.config[:receiver]
-      @senders  = Mail2FrontMatter.config[:senders]
-
       Mailman.config.poll_interval = poll_interval
       Mailman.config.ignore_stdin = true
 
       Mailman.config.send("#{mail_protocol}=", Mail2FrontMatter.config[:mailman])
       Mailman.config.logger = Mail2FrontMatter.logger
 
+      Mail2FrontMatter.logger.info("Mail2FrontMatter v#{Mail2FrontMatter::VERSION} is starting...")
+
       Mailman::Application.run do
-        from(@senders).to(@receiver) do
-          logger = Mailman.config.logger
+        logger = Mail2FrontMatter.logger
 
+        from(Mail2FrontMatter.config[:senders]).to(Mail2FrontMatter.config[:receiver]) do
           logger.info('parsing message...')
           parser = Mail2FrontMatter::Parser.new(message)
 
@@ -30,9 +28,17 @@ module Mail2FrontMatter
 
           logger.info('saving processed post...')
           Mail2FrontMatter::Writer.write(metadata, body)
+
+          logger.info('commiting written post and attachments...')
+          Mail2FrontMatter::Committer.commit(metadata, body)
+
+          logger.info('done...')
+        end
+
+        default do
+          logger.error("received and discarded email from unknown address!")
         end
       end
     end
-
   end
 end

data/lib/mail2frontmatter/writer.rb

@@ -1,20 +1,19 @@
 
 # Writes YAML FrontMatter & Article Content in ERB
-# 
-# TODO How do I support other templating solutions here?
-#      Same plugin style as processors?
-#      Is processor and writer doing the same thing?
+#
+# TODO: How do I support other templating solutions here?
+#       Same plugin style as processors?
+#       Is processor and writer doing the same thing?
 #       --- probably just let anyone specify the extension.. keep it simple
-# 
+#
 module Mail2FrontMatter
   class Writer
-
     require 'yaml'
     require 'active_support/inflector'
 
     def self.write(metadata, body)
       # MAPPINGS!
-      # 
+      #
       # Play nice with programs which will read this data
       # And set sensible defaults as fall throughs
 
@@ -22,12 +21,12 @@ module Mail2FrontMatter
       metadata[:title] ||= metadata[:subject]
 
       # make a sensible standard blog filename unless one is given
-      metadata[:filename] ||= [metadata[:received].strftime("%Y-%m-%d"), '-', metadata[:subject].parameterize, '.html.erb'].join
+      metadata[:filename] ||= [metadata[:received].strftime('%Y-%m-%d'), '-', metadata[:subject].parameterize, '.html.erb'].join
+      metadata[:filepath] ||= File.join(Mail2FrontMatter.config[:data_directory], metadata[:filename])
 
       data = metadata.to_yaml + "---\n" + body
 
-      File.write(File.join(Mail2FrontMatter.config[:data_directory], metadata[:filename]), data)
+      File.write(metadata[:filepath], data)
     end
-
   end
 end

data/mail2frontmatter.gemspec

@@ -4,26 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mail2frontmatter/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "mail2frontmatter"
+  spec.name          = 'mail2frontmatter'
   spec.version       = Mail2FrontMatter::VERSION
-  spec.authors       = ["Kunal Shah"]
-  spec.email         = ["me@kunalashah.com"]
-  spec.summary       = %q{Email-to-blog parser which creates YAML FrontMatter}
-  spec.description   = spec.summary + %q{. Uses Mailman to poll an account. }
-  spec.homepage      = "https://github.com/whistlerbrk/Mail2FrontMatter"
-  spec.license       = "MIT"
+  spec.authors       = ['Kunal Shah']
+  spec.email         = ['me@kunalashah.com']
+  spec.summary       = 'email-in for static blogs like Middleman'
+  spec.description   = spec.summary + '. Uses Mailman to poll an account. '
+  spec.homepage      = 'https://github.com/whistlerbrk/Mail2FrontMatter'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "mailman", "~> 0.7"
-  spec.add_dependency "nokogiri", "~> 1.6"
-  spec.add_dependency "activesupport", "~> 4"
+  spec.add_dependency 'mailman', '~> 0.7.3'
+  spec.add_dependency 'nokogiri', '~> 1.6'
+  spec.add_dependency 'activesupport', '~> 4'
+  spec.add_dependency 'rugged', '~> 0.21'
 
-  spec.add_development_dependency "rspec", "~> 3.1"
-  spec.add_development_dependency "byebug", "~> 3.5" unless RUBY_VERSION =~ /1.9/
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'byebug', '~> 3.5'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
 end

data/spec/committer_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Mail2FrontMatter::Committer, 'committing' do
+  require 'rugged'
+
+  let(:config) { File.join(M2FM_GEM_PATH, 'fixtures', 'mail2frontmatter.simple.yml') }
+  let(:message_one) { Mail::Message.new(File.read(File.join(M2FM_GEM_PATH, 'fixtures', 'attachments.eml'))) }
+
+  it 'should commit new posts' do
+    Mail2FrontMatter.set_config(config) do |config|
+      config[:data_directory]  = File.join(M2FM_GEM_PATH, 'spec', 'installation', 'data')
+      config[:media_directory] = File.join(M2FM_GEM_PATH, 'spec', 'installation', 'media')
+      config[:git] = { path: File.join(M2FM_GEM_PATH, 'spec', 'installation') }
+    end
+
+    repo = Rugged::Repository.new(Mail2FrontMatter.config[:git][:path])
+    opening_sha = repo.references['refs/heads/master'].target_id
+
+    parser = Mail2FrontMatter::Parser.new(message_one)
+    Mail2FrontMatter::Writer.write(parser.metadata, parser.body)
+    Mail2FrontMatter::Committer.commit(parser.metadata, parser.body)
+
+    closing_sha = repo.references['refs/heads/master'].target_id
+
+    expect(opening_sha == closing_sha).to be(false)
+  end
+end

data/spec/configuration_spec.rb

@@ -1,42 +1,40 @@
 require 'spec_helper'
 
-describe Mail2FrontMatter, "configuration" do
-
+describe Mail2FrontMatter, 'configuration' do
   let(:simple_config)    { File.join(M2FM_GEM_PATH, 'fixtures', 'mail2frontmatter.simple.yml') }
   let(:complex_config)   { File.join(M2FM_GEM_PATH, 'fixtures', 'mail2frontmatter.complex.yml') }
   let(:malformed_config) { File.join(M2FM_GEM_PATH, 'fixtures', 'mail2frontmatter.malformed.yml') }
 
-  it "should load a configuration by passing a YAML file location" do
-    expect {
+  it 'should load a configuration by passing a YAML file location' do
+    expect do
       Mail2FrontMatter.set_config(simple_config)
-    }.to_not raise_error
+    end.to_not raise_error
   end
 
-  it "should load a configuration by passing a hash" do
-    expect {
-      Mail2FrontMatter.set_config({foo: 'bar'})
-    }.to_not raise_error
+  it 'should load a configuration by passing a hash' do
+    expect do
+      Mail2FrontMatter.set_config(foo: 'bar')
+    end.to_not raise_error
   end
 
-  it "should raise an error for other types" do
-    expect {
+  it 'should raise an error for other types' do
+    expect do
       Mail2FrontMatter.set_config([])
-    }.to raise_error
+    end.to raise_error
   end
 
-  it "should fail loading malformed configs" do
-    expect {
+  it 'should fail loading malformed configs' do
+    expect do
       Mail2FrontMatter.set_config(malformed_config)
-    }.to raise_error
+    end.to raise_error
   end
 
-  it "should attempt to load the default configuration if nothing is passed" do
+  it 'should attempt to load the default configuration if nothing is passed' do
     # this should attempt and fail because there is no ./data/mail2frontmatter.yml
-    expect {
+    expect do
       Mail2FrontMatter.set_config do |config|
         config[:foo] = 'bar'
       end
-    }.to raise_error(LoadError)
+    end.to raise_error(LoadError)
   end
-
-end
+end

data/spec/parser_spec.rb

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

data/spec/preprocessor_spec.rb

@@ -7,56 +7,55 @@ describe Mail2FrontMatter::PreProcessor do
 
   let(:message_one) { Mail::Message.new(File.read(File.join(M2FM_GEM_PATH, 'fixtures', 'attachments.eml'))) }
 
-  let(:invalidly_defined_preprocessor) { 
+  let(:invalidly_defined_preprocessor) do
     class MyInvalidProcessor < Mail2FrontMatter::PreProcessor
       # note, instanced not class
       def run(metadata, body)
         # some modification
-        return metadata, body
+        [metadata, body]
       end
     end
 
     return MyInvalidProcessor
-  }
+  end
 
-  let(:validly_defined_preprocessor) { 
+  let(:validly_defined_preprocessor) do
     class MyValidProcessor < Mail2FrontMatter::PreProcessor
       def self.run(metadata, body)
         # some modification
-        return metadata, body
+        [metadata, body]
       end
     end
 
     return MyValidProcessor
-  }
-
-  context "registration" do
+  end
 
-    it "should raise errors for invalid processors" do
-      expect {
+  context 'registration' do
+    it 'should raise errors for invalid processors' do
+      expect do
         invalidly_defined_preprocessor.register({})
-      }.to raise_error
+      end.to raise_error
     end
 
-    it "should not raise errors for valid processors" do
-      expect {
+    it 'should not raise errors for valid processors' do
+      expect do
         validly_defined_preprocessor.register({})
-      }.to_not raise_error
+      end.to_not raise_error
     end
 
-    it "should raise an error when registered without a hash" do
-      expect {
+    it 'should raise an error when registered without a hash' do
+      expect do
         validly_defined_preprocessor.register(nil)
-      }.to raise_error(ArgumentError)
+      end.to raise_error(ArgumentError)
     end
 
-    it "should not raise an error when registered with a hash" do
-      expect {
-        validly_defined_preprocessor.register({ foo: 'bar' })
-      }.to_not raise_error
+    it 'should not raise an error when registered with a hash' do
+      expect do
+        validly_defined_preprocessor.register(foo: 'bar')
+      end.to_not raise_error
     end
 
-    it "should load preprocessors" do
+    it 'should load preprocessors' do
       Mail2FrontMatter.set_config(complex_config)
       processors = Mail2FrontMatter::PreProcessor.processors
 
@@ -64,23 +63,23 @@ describe Mail2FrontMatter::PreProcessor do
       expect(processors).to include(Mail2FrontMatter::FakeProcessorWithOptions)
     end
 
-    it "should provide preprocessors with passed options" do
+    it 'should provide preprocessors with passed options' do
       Mail2FrontMatter.set_config(complex_config)
       options = Mail2FrontMatter::FakeProcessorWithOptions.instance_variable_get(:@options)
 
       expect(options.class).to eq(Hash)
-      expect(options[:foo]).to eq("bar")
+      expect(options[:foo]).to eq('bar')
     end
   end
 
-  context "operation" do
-    it "should continue processing if an individual processor fails" do
+  context 'operation' do
+    it 'should continue processing if an individual processor fails' do
       Mail2FrontMatter.set_config(broken_config)
       parser = Mail2FrontMatter::Parser.new(message_one)
 
-      expect {
-        metadata, body = Mail2FrontMatter::PreProcessor.process(parser.metadata, parser.body)
-      }.to_not raise_error
+      expect do
+        Mail2FrontMatter::PreProcessor.process(parser.metadata, parser.body)
+      end.to_not raise_error
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,67 @@
 
 M2FM_GEM_PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-$: << File.join(M2FM_GEM_PATH, 'fixtures')
+$LOAD_PATH << File.join(M2FM_GEM_PATH, 'fixtures')
 
 require 'yaml'
+require 'fileutils'
 require File.join(M2FM_GEM_PATH, 'lib', 'mail2frontmatter')
+
+module RSpec
+  # remove any data hanging around from spec runs...
+  def self.clean_testbed
+    FileUtils.rm_rf(Dir[File.join(M2FM_GEM_PATH, 'spec', 'remote', '*')])
+    FileUtils.rm_rf(Dir[File.join(M2FM_GEM_PATH, 'spec', 'installation', 'data', '*')])
+    FileUtils.rm_rf(Dir[File.join(M2FM_GEM_PATH, 'spec', 'installation', 'media', '*')])
+    FileUtils.rm_rf(Dir[File.join(M2FM_GEM_PATH, 'spec', 'installation', '.git')])
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    RSpec.clean_testbed
+
+    # setup a repo in spec/installation
+    repo = Rugged::Repository.init_at(File.join(M2FM_GEM_PATH, 'spec', 'installation', '.git'))
+
+    # setup another repo in spec/remote
+    Rugged::Repository.init_at(File.join(M2FM_GEM_PATH, 'spec', 'remote'), :bare)
+
+    # add the second repo as the origin of the first
+    repo.remotes.create('origin', File.join(M2FM_GEM_PATH, 'spec', 'remote'))
+
+    index = repo.index
+
+    # stage the blank folders
+    index.add(path: 'data/.gitkeep',
+              oid: (Rugged::Blob.from_workdir repo, 'data/.gitkeep'),
+              mode: 0100644)
+
+    index.add(path: 'media/.gitkeep',
+              oid: (Rugged::Blob.from_workdir repo, 'media/.gitkeep'),
+              mode: 0100644)
+
+    # commit them
+    tree = index.write_tree(repo)
+    index.write
+
+    author = {
+      email: 'sender@example.com',
+      name:  'The Sender',
+      time:  Time.now
+    }
+
+    Rugged::Commit.create(repo, author:     author,
+                                committer:  author,
+                                message:    'checking in data/media empties',
+                                parents:    [],
+                                tree:       tree,
+                                update_ref: 'HEAD')
+
+    # push
+    repo.push 'origin', ['refs/heads/master']
+  end
+
+  config.after(:suite) do
+    RSpec.clean_testbed
+  end
+end

data/spec/writer_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Mail2FrontMatter::Writer, 'writing' do
+  let(:config) { File.join(M2FM_GEM_PATH, 'fixtures', 'mail2frontmatter.simple.yml') }
+  let(:message_one) { Mail::Message.new(File.read(File.join(M2FM_GEM_PATH, 'fixtures', 'attachments.eml'))) }
+
+  it 'should write a parse and processed email' do
+    Mail2FrontMatter.set_config(config) do |config|
+      config[:data_directory]  = File.join(M2FM_GEM_PATH, 'spec', 'installation', 'data')
+      config[:media_directory] = File.join(M2FM_GEM_PATH, 'spec', 'installation', 'media')
+    end
+
+    parser = Mail2FrontMatter::Parser.new(message_one)
+    metadata, body = Mail2FrontMatter::PreProcessor.process(parser.metadata, parser.body)
+
+    Mail2FrontMatter::Writer.write(metadata, body)
+
+    expect(File.exist?(File.join(Mail2FrontMatter.config[:data_directory], '2009-11-25-295-abandoned-elevator-shaft.html.erb'))).to be(true)
+    expect(File.exist?(File.join(Mail2FrontMatter.config[:media_directory], 'images', 'IMG_0141.JPG'))).to be(true)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail2frontmatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Kunal Shah
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-01 00:00:00.000000000 Z
+date: 2016-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mailman
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.7.3
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,8 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: 'Email-to-blog parser which creates YAML FrontMatter. Uses Mailman to
-  poll an account. '
+description: 'email-in for static blogs like Middleman. Uses Mailman to poll an account. '
 email:
 - me@kunalashah.com
 executables:
@@ -135,6 +148,7 @@ files:
 - fixtures/mail2frontmatter/fake-processor.rb
 - fixtures/no_attachments.eml
 - lib/mail2frontmatter.rb
+- lib/mail2frontmatter/committer.rb
 - lib/mail2frontmatter/configuration.rb
 - lib/mail2frontmatter/parser.rb
 - lib/mail2frontmatter/preprocessor.rb
@@ -142,10 +156,15 @@ files:
 - lib/mail2frontmatter/watcher.rb
 - lib/mail2frontmatter/writer.rb
 - mail2frontmatter.gemspec
+- spec/committer_spec.rb
 - spec/configuration_spec.rb
+- spec/installation/data/.gitkeep
+- spec/installation/media/.gitkeep
 - spec/parser_spec.rb
 - spec/preprocessor_spec.rb
+- spec/remote/.gitkeep
 - spec/spec_helper.rb
+- spec/writer_spec.rb
 homepage: https://github.com/whistlerbrk/Mail2FrontMatter
 licenses:
 - MIT
@@ -166,12 +185,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Email-to-blog parser which creates YAML FrontMatter
+summary: email-in for static blogs like Middleman
 test_files:
+- spec/committer_spec.rb
 - spec/configuration_spec.rb
+- spec/installation/data/.gitkeep
+- spec/installation/media/.gitkeep
 - spec/parser_spec.rb
 - spec/preprocessor_spec.rb
+- spec/remote/.gitkeep
 - spec/spec_helper.rb
+- spec/writer_spec.rb