inbox-sync 0.1.0

data/test/helper.rb

@@ -0,0 +1,87 @@
+# this file is automatically required in when you require 'assert' in your tests
+# put test helpers here
+
+# add root dir to the load path
+$LOAD_PATH.unshift(File.expand_path("../..", __FILE__))
+
+require 'logger'
+require 'net/imap'
+require 'inbox-sync/sync'
+require 'inbox-sync/mail_item'
+
+class Assert::Context
+
+  def configured_sync
+    InboxSync::Sync.new.configure do
+      source.host  'imap.gmail.com'
+      source.port  993
+      source.ssl   'Yes'
+      source.login 'joetest@kellyredding.com', 'joetest1'
+
+      dest.host  'imap.gmail.com'
+      dest.port  993
+      dest.ssl   'Yes'
+      dest.login 'suetest@kellyredding.com', 'suetest1'
+
+      notify.host  'smtp.gmail.com'
+      notify.port  587
+      notify.tls   'Yes'
+      notify.helo  'gmail.com'
+      notify.login 'suetest@kellyredding.com', 'suetest1'
+      notify.from_addr 'suetest@kellyredding.com'
+      notify.to_addr 'suetest@kellyredding.com'
+
+      logger Logger.new('log/tests.log')
+    end
+  end
+
+  TEST_MAIL_DATA = {
+    'RFC822' => "Delivered-To: joetest@kellyredding.com\r\nReceived: by 10.114.62.209 with SMTP id a17csp11732lds;\r\n        Thu, 24 May 2012 08:34:46 -0700 (PDT)\r\nReceived: by 10.112.84.65 with SMTP id w1mr13705338lby.40.1337873686521;\r\n        Thu, 24 May 2012 08:34:46 -0700 (PDT)\r\nReturn-Path: <suetest@kellyredding.com>\r\nReceived: from mail-lpp01m010-f67.google.com (mail-lpp01m010-f67.google.com [209.85.215.67])\r\n        by mx.google.com with ESMTPS id a9si2217645lbh.1.2012.05.24.08.34.46\r\n        (version=TLSv1/SSLv3 cipher=OTHER);\r\n        Thu, 24 May 2012 08:34:46 -0700 (PDT)\r\nReceived-SPF: neutral (google.com: 209.85.215.67 is neither permitted nor denied by best guess record for domain of suetest@kellyredding.com) client-ip=209.85.215.67;\r\nAuthentication-Results: mx.google.com; spf=neutral (google.com: 209.85.215.67 is neither permitted nor denied by best guess record for domain of suetest@kellyredding.com) smtp.mail=suetest@kellyredding.com\r\nReceived: by lagv3 with SMTP id v3so751705lag.2\r\n        for <joetest@kellyredding.com>; Thu, 24 May 2012 08:34:44 -0700 (PDT)\r\nX-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r\n        d=google.com; s=20120113;\r\n        h=mime-version:x-originating-ip:date:message-id:subject:from:to\r\n         :content-type:x-gm-message-state;\r\n        bh=jC/axn7WeCoH+0tXbYrcmVfGSuJ82WTAoccq2csJ8HA=;\r\n        b=T5W+Ba0za3EsMrBgVM6Z2kJww/GvOIr5JzEMVwNnqJDMgFseumYcHw9f6OGZMuhvtH\r\n         Ok3PCmg8uiDRj1Mm2YiE1O8dhQL7BgBd4UO5zBGcLzUDYHBLor+oSjh8pZOsNgHEJk9H\r\n         dZSn0Af4q8RuCRNCyeD8xJt7rRF1EESAgqdQ35fd1GiTefGyhE1UwGkS/P4BiUga1wUr\r\n         qG2fA7Sbj2XcTyCjvsXqgw/EoOuIgnOqeMHZ5CsCfE0FBhW24cIwAt59FIeTELcsb0QQ\r\n         4w76+RkaS4SxuNCEagsRN6DHnLB7SKqTRF6ZKt6xs/zbkz1Qz3mq4yrhrrYa3pNnK9Ez\r\n         F2ug==\r\nMIME-Version: 1.0\r\nReceived: by 10.112.29.199 with SMTP id m7mr14024566lbh.31.1337873684699; Thu,\r\n 24 May 2012 08:34:44 -0700 (PDT)\r\nReceived: by 10.114.59.80 with HTTP; Thu, 24 May 2012 08:34:44 -0700 (PDT)\r\nX-Originating-IP: [209.133.30.126]\r\nDate: Thu, 24 May 2012 10:34:44 -0500\r\nMessage-ID: <CAA9i=SubBh6kAv=cxgGskY9cmS7gsT4m6YSGGdc417bM+DFk4Q@mail.gmail.com>\r\nSubject: test mail\r\nFrom: Sue Test <suetest@kellyredding.com>\r\nTo: joetest@kellyredding.com\r\nContent-Type: multipart/alternative; boundary=f46d04016b2dbb1bfe04c0c9fd9a\r\nX-Gm-Message-State: ALoCoQkFFPgZHO7zDsv7I5mvZqbwHdNjnyobpEyOYxxXgPySrU+OEAOtZSKX6G3vlddVo15J3A5s\r\n\r\n--f46d04016b2dbb1bfe04c0c9fd9a\r\nContent-Type: text/plain; charset=ISO-8859-1\r\n\r\nThis is a test mail\r\n\r\nWITH MARKUP!!!\r\n\r\n--f46d04016b2dbb1bfe04c0c9fd9a\r\nContent-Type: text/html; charset=ISO-8859-1\r\n\r\nThis is a test mail<div><br></div><div><font class=\"Apple-style-span\" color=\"#ff0000\">WITH MARKUP!!!</font></div>\r\n\r\n--f46d04016b2dbb1bfe04c0c9fd9a--\r\n",
+    'INTERNALDATE' => "24-May-2012 15:34:46 +0000"
+  }
+
+  def test_mail_item
+    InboxSync::MailItem.new('12345', TEST_MAIL_DATA['RFC822'], TEST_MAIL_DATA['INTERNALDATE'])
+  end
+
+  def setup_sync_mail_item
+    @sync = Assert::Context.new.configured_sync
+    @sync.login
+    @mail_item = Assert::Context.new.test_mail_item
+    [@sync, @mail_item]
+  end
+
+  def empty_source_selected(sync)
+    sync.source_imap.uid_search(['ALL']).each do |uid|
+      sync.source_imap.uid_store(uid, "+FLAGS", [:Deleted])
+    end
+    sync.source_imap.expunge
+  end
+
+  def reset_source_inbox(sync)
+    sync.source_imap.select(sync.config.source.inbox)
+    empty_source_selected(sync)
+
+    # append the test mail on the source imap
+    inbox  = sync.config.source.inbox
+    mail_s = test_mail_item.meta['RFC822']
+    flags  = []
+    date   = test_mail_item.meta['INTERNALDATE']
+
+    sync.source_imap.append(inbox, mail_s, flags, date)
+  end
+
+  def reset_source_archive(sync)
+    begin
+      sync.source_imap.select(sync.config.archive_folder)
+    rescue Net::IMAP::NoResponseError => err
+      # do nothing - archive folder not present - no action needed
+    else
+      empty_source_selected(sync)
+      sync.source_imap.delete(sync.config.archive_folder)
+    ensure
+      sync.source_imap.select(sync.config.source.inbox)
+    end
+  end
+
+end

data/test/irb.rb

@@ -0,0 +1,9 @@
+require 'assert/setup'
+
+# this file is required in when the 'irb' rake test is run.
+# b/c 'assert/setup' is required above, the test helper will be
+# required in as well.
+
+# put any IRB setup code here
+
+require 'inbox-sync'

data/test/mail_item_test.rb

@@ -0,0 +1,62 @@
+require 'assert'
+require 'mail'
+require 'inbox-sync/mail_item'
+
+module InboxSync
+
+  class MailItemTests < Assert::Context
+    desc 'a mail item'
+    before do
+      @item = test_mail_item
+    end
+    subject { @item }
+
+    should have_readers :uid, :meta, :message
+    should have_class_method :find
+    should have_instance_method :name, :stripped
+
+    should "build a Mail Message from the raw IMAP attr data" do
+      assert_kind_of ::Mail::Message, subject.message
+    end
+
+    should "provide the raw IMAP attrs in the meta hash" do
+      assert_includes 'RFC822', subject.meta
+      assert_includes 'INTERNALDATE', subject.meta
+
+      assert_equal TEST_MAIL_DATA['RFC822'], subject.meta['RFC822']
+      assert_equal TEST_MAIL_DATA['INTERNALDATE'], subject.meta['INTERNALDATE']
+    end
+
+    should "be named by its uid, from, subject, and date" do
+      exp = "[12345] suetest@kellyredding.com: \"test mail\" (Thu May 24 2012, 10:34 AM)"
+      assert_equal exp, subject.name
+    end
+
+  end
+
+  class StrippedMailItemTests < MailItemTests
+    desc 'that has been stripped'
+    before do
+      @stripped = @item.stripped
+    end
+    subject { @stripped }
+
+    should "be single part plain text only" do
+      assert_equal 1, subject.message.parts.size
+    end
+
+    should "have no attachments" do
+      assert_equal 0, subject.message.attachments.size
+    end
+
+    should "prefix the body with a note saying that it is stripped down" do
+      pref = /\A\*\*\[inbox-sync\] stripped down to just plain text part\*\*/
+      assert_match pref, subject.message.parts.first.body.to_s
+    end
+
+    should "set its RFC822 to the stripped message string" do
+      assert_equal subject.meta['RFC822'], subject.message.to_s
+    end
+  end
+
+end

data/test/runner_test.rb

@@ -0,0 +1,40 @@
+require 'assert'
+
+require 'inbox-sync/sync'
+require 'inbox-sync/runner'
+
+module InboxSync
+
+  class RunnerTests < Assert::Context
+    desc "a sync runner"
+    before do
+      @syncs = [InboxSync::Sync.new, InboxSync::Sync.new]
+      @runner = InboxSync::Runner.new(@syncs, :interval => 20)
+    end
+    subject { @runner }
+
+    should have_readers :syncs, :interval, :logger
+
+    should "know its syncs" do
+      assert_equal @syncs, subject.syncs
+    end
+
+    should "know its interval seconds" do
+      assert_equal 20, subject.interval
+    end
+
+    should "default its interval to -1" do
+      assert_equal -1, InboxSync::Runner.new.interval
+    end
+
+    should "build from zero or many syncs" do
+      assert_equal @syncs, InboxSync::Runner.new(@syncs).syncs
+      assert_equal @syncs, InboxSync::Runner.new(*@syncs).syncs
+      assert_equal [@syncs.first], InboxSync::Runner.new(@syncs.first).syncs
+      assert_equal [], InboxSync::Runner.new(:interval => 5).syncs
+      assert_equal [], InboxSync::Runner.new().syncs
+    end
+
+  end
+
+end

data/test/sync/basic_test.rb

@@ -0,0 +1,62 @@
+require 'assert'
+
+require 'inbox-sync/sync'
+require 'inbox-sync/config'
+
+module InboxSync
+
+  class BasicSyncTests < Assert::Context
+    desc "a sync"
+    before do
+      @sync = InboxSync::Sync.new
+      @raw_config = InboxSync::Config.new({
+       :source => { :host => 'imap.test.com'}
+      })
+    end
+    subject { @sync }
+
+    should have_readers :config, :source_imap, :notify_smtp
+    should have_instance_methods :uid, :name, :logger, :logged_in?
+    should have_instance_method  :configure, :setup, :teardown, :run, :notify
+
+    should "configure using a block" do
+      subject.configure do
+        source.host 'imap.test.com'
+      end
+      assert_equal @raw_config.source, subject.config.source
+    end
+
+    should "configure passing in a settings hash" do
+      a_sync = InboxSync::Sync.new({
+        :source => {:host => 'imap.test.com'}
+      })
+
+      assert_equal a_sync.config.source, @raw_config.source
+    end
+
+    should "return itself when calling `configure`" do
+      assert_equal subject, subject.configure
+    end
+
+  end
+
+  class BasicConfiguredSyncTests < BasicSyncTests
+    desc 'that has the basic configs'
+    before do
+      subject.configure do
+        source.host 'imap.test.com'
+        source.login.user 'me@example.com'
+      end
+    end
+
+    should "have a unique id" do
+      assert_equal "me@example.com:imap.test.com", subject.uid
+    end
+
+    should "be named by its source" do
+      assert_equal "me@example.com (imap.test.com)", subject.name
+    end
+
+  end
+
+end

data/test/sync/login_test.rb

@@ -0,0 +1,110 @@
+require 'assert'
+
+require 'inbox-sync/sync'
+
+module InboxSync
+
+  class ConfiguredSyncTests < Assert::Context
+    desc "a sync that has been configured and setup"
+    before do
+      @sync = configured_sync
+      @sync.setup
+    end
+    after do
+      @sync.teardown
+    end
+    subject { @sync }
+
+    should "be logged in" do
+      assert subject.logged_in?
+    end
+
+    should "be logged out after teardown" do
+      subject.teardown
+
+      assert_not subject.logged_in?
+    end
+
+    should "set source IMAP and notify SMTP objects" do
+      assert_kind_of Net::IMAP, subject.source_imap
+      assert_kind_of Net::SMTP, subject.notify_smtp
+    end
+
+    should "remove source IMAP and notify SMTP objects after teardown" do
+      subject.teardown
+
+      assert_nil subject.source_imap
+      assert_nil subject.notify_smtp
+    end
+
+    should "validate the configs on setup" do
+      assert_raises ArgumentError do
+        InboxSync::Sync.new(:logger => '/dev/null').setup
+      end
+    end
+
+  end
+
+  class LoggedInTests < ConfiguredSyncTests
+    desc 'and is logged in and ready to run'
+    before do
+      reset_source_inbox(@sync)
+      reset_source_archive(@sync)
+
+      @sync_archive_folder = @sync.config.archive_folder
+      @mail_item = MailItem.find(@sync.source_imap).first
+    end
+
+    after do
+      @sync.config.archive_folder = @sync_archive_folder
+      @sync.source_imap.select(@sync.config.source.inbox)
+
+      reset_source_archive(@sync)
+    end
+
+    should "run without any errors" do
+      assert_nothing_raised do
+        subject.run
+      end
+    end
+
+  end
+
+  # class ArchiveTests < RunTests
+  #   should "remove the message from the inbox" do
+  #     @sync.archive_from_source(@mail_item)
+
+  #     assert_not_included @mail_item.uid, @sync.source_imap.uid_search(['ALL'])
+  #     assert_empty @sync.source_imap.uid_search(['ALL'])
+  #   end
+
+  #   should "move it to the archive folder" do
+  #     @sync.archive_from_source(@mail_item)
+  #     @sync.source_imap.select(@sync.config.archive_folder)
+
+  #     assert_equal 1, @sync.source_imap.uid_search(['ALL']).size
+  #   end
+
+  #   should "not archive if no archive folder configured" do
+  #     @sync.config.archive_folder = nil
+  #     @sync.archive_from_source(@mail_item)
+  #     @sync.source_imap.select(@sync.config.source.inbox)
+
+  #     assert_not_included @mail_item.uid, @sync.source_imap.uid_search(['ALL'])
+  #   end
+
+  # end
+
+  # class AppendTests < LoggedInTests
+  #   should "append a source msg onto the dest" do
+  #     assert_nothing_raised do
+  #       @sync.append_to_dest(test_mail_item)
+  #     end
+  #   end
+
+  #   should "parse the destination UID when appending mail items" do
+  #     assert_match /\A\d+\Z/, @sync.append_to_dest(test_mail_item)
+  #   end
+  # end
+
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: inbox-sync
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kelly Redding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: assert
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 4
+        - 1
+        version: 0.4.1
+  name: ns-options
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 4
+        version: "2.4"
+  name: mail
+  version_requirements: *id003
+  prerelease: false
+description: Move messages from one inbox to another
+email: 
+- kelly@kellyredding.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- inbox-sync.gemspec
+- lib/inbox-sync.rb
+- lib/inbox-sync/config.rb
+- lib/inbox-sync/config/credentials.rb
+- lib/inbox-sync/config/imap_config.rb
+- lib/inbox-sync/config/smtp_config.rb
+- lib/inbox-sync/mail_item.rb
+- lib/inbox-sync/notice/base.rb
+- lib/inbox-sync/notice/run_sync_error.rb
+- lib/inbox-sync/notice/sync_mail_item_error.rb
+- lib/inbox-sync/runner.rb
+- lib/inbox-sync/sync.rb
+- lib/inbox-sync/version.rb
+- log/.gitkeep
+- test/config_test.rb
+- test/helper.rb
+- test/irb.rb
+- test/mail_item_test.rb
+- test/runner_test.rb
+- test/sync/basic_test.rb
+- test/sync/login_test.rb
+homepage: http://github.com/kellyredding/inbox-sync
+licenses: []
+
+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.8.11
+signing_key: 
+specification_version: 3
+summary: Move messages from one inbox to another
+test_files: 
+- test/config_test.rb
+- test/helper.rb
+- test/irb.rb
+- test/mail_item_test.rb
+- test/runner_test.rb
+- test/sync/basic_test.rb
+- test/sync/login_test.rb