imap-filter 0.0.2

data/Rakefile

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'semver'
+
+def s_version
+  SemVer.find.format "%M.%m.%p%s"
+end
+
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "imap-filter"
+  gem.homepage = "http://github.com/flajann2/imap-filter"
+  gem.license = "MIT"
+  gem.summary = %Q{IMAP Scriptable filter for one or multiple Email accounts.}
+  gem.description = %Q{
+  imap-filter is a Ruby implementation of an IMAP filtering application.
+  it can handle multiple IMAP accounts, and create IMAP folders automatically
+  where none exists.
+
+  The imap-filter DSL makes it easy to filter. You can also do "dry-runs"
+  to make sure what happens is what is expected.}
+  
+  gem.email = "fred.mitchell@gmx.de"
+  gem.authors = ["Fred Mitchell"]
+  gem.version = s_version
+  gem.required_ruby_version = '>= 2.2'
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/bin/imap-filter

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+IMAP_PATH = File.expand_path '..', File.dirname(__FILE__)
+IMAP_EXECUTABLE = File.expand_path 'bin/imap-filter', Dir.pwd
+
+$:.unshift File.join([IMAP_PATH, 'lib'])
+
+require 'imap-filter/cli'
+
+ImapFilter::Cli::Main.start
+

data/examples/default.imap

@@ -0,0 +1,56 @@
+# My Email accounts
+account :gmx do
+  login ENV['GMX_EMAIL'], ENV['GMX_PASS']
+  serv "imap.gmx.net"
+  ssl true
+  auth :login
+  port 993
+end
+
+account :yahoo do
+  login ENV['YAHOO_EMAIL'], ENV['YAHOO_PASS']
+  serv 'imap.mail.yahoo.com'
+  auth :login
+end
+
+account :google do
+  login ENV['GOOGLE_EMAIL'], ENV['GOOGLE_PASS']
+  serv "imap.gmail.com"
+  auth :plain
+end
+
+filter :slashdot, 'gmx:INBOX', from: 'slashdot' do
+  mark :seen
+  cp 'google:INBOX'
+  mv 'gmx:Slashdot'
+end
+
+filter :github, 'gmx:INBOX' do
+  search do
+    from 'github.com'
+    unseen
+  end
+
+  cp 'google:news/Github'
+  mv 'gmx:Github'
+end
+
+filter :gitter, 'gmx:INBOX', from: 'gitter' do
+  mv 'gmx:Gitter'
+end
+
+filter :xing, 'gmx:INBOX', from: 'xing.com' do
+  mv 'gmx:XING'
+  unmark :seen
+end
+
+filter :neat, 'yahoo:NEAT', :unseen do
+  cp 'gmx:Lists/NEAT'
+  mark :seen
+end
+
+filter :spam, 'gmx:INBOX', from: ['news.brgmedia.com', 'travel.hoteltravel-email.com'] do
+  delete
+end
+
+activate :all

data/imap-filter.gemspec

@@ -0,0 +1,110 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: imap-filter 0.0.2 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "imap-filter"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Fred Mitchell"]
+  s.date = "2016-09-25"
+  s.description = "\n  imap-filter is a Ruby implementation of an IMAP filtering application.\n  it can handle multiple IMAP accounts, and create IMAP folders automatically\n  where none exists.\n\n  The imap-filter DSL makes it easy to filter. You can also do \"dry-runs\"\n  to make sure what happens is what is expected."
+  s.email = "fred.mitchell@gmx.de"
+  s.executables = ["imap-filter"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.org"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".ruby-version",
+    ".semver",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.org",
+    "Rakefile",
+    "bin/imap-filter",
+    "examples/default.imap",
+    "imap-filter.gemspec",
+    "lib/imap-filter.rb",
+    "lib/imap-filter/cli.rb",
+    "lib/imap-filter/dsl.rb",
+    "lib/imap-filter/functionality.rb",
+    "lib/imap-filter/imap-filter.rb",
+    "lib/imap-filter/monkeypatches.rb",
+    "spec/imap-filter_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/flajann2/imap-filter"
+  s.licenses = ["MIT"]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.2")
+  s.rubygems_version = "2.5.1"
+  s.summary = "IMAP Scriptable filter for one or multiple Email accounts."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<semver>, ["~> 1"])
+      s.add_runtime_dependency(%q<awesome_print>, ["~> 1"])
+      s.add_runtime_dependency(%q<text-table>, ["~> 1"])
+      s.add_runtime_dependency(%q<thor>, ["~> 0"])
+      s.add_runtime_dependency(%q<colorize>, ["~> 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2"])
+      s.add_development_dependency(%q<yard>, ["~> 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3"])
+      s.add_development_dependency(%q<bundler>, ["~> 1"])
+      s.add_development_dependency(%q<juwelier>, ["~> 2"])
+      s.add_development_dependency(%q<simplecov>, ["~> 0"])
+      s.add_development_dependency(%q<pry>, ["~> 0"])
+      s.add_development_dependency(%q<pry-byebug>, ["~> 3"])
+      s.add_development_dependency(%q<pry-doc>, ["~> 0"])
+      s.add_development_dependency(%q<pry-remote>, ["~> 0"])
+      s.add_development_dependency(%q<pry-rescue>, ["~> 1"])
+      s.add_development_dependency(%q<pry-stack_explorer>, ["~> 0"])
+    else
+      s.add_dependency(%q<semver>, ["~> 1"])
+      s.add_dependency(%q<awesome_print>, ["~> 1"])
+      s.add_dependency(%q<text-table>, ["~> 1"])
+      s.add_dependency(%q<thor>, ["~> 0"])
+      s.add_dependency(%q<colorize>, ["~> 0"])
+      s.add_dependency(%q<rspec>, ["~> 2"])
+      s.add_dependency(%q<yard>, ["~> 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3"])
+      s.add_dependency(%q<bundler>, ["~> 1"])
+      s.add_dependency(%q<juwelier>, ["~> 2"])
+      s.add_dependency(%q<simplecov>, ["~> 0"])
+      s.add_dependency(%q<pry>, ["~> 0"])
+      s.add_dependency(%q<pry-byebug>, ["~> 3"])
+      s.add_dependency(%q<pry-doc>, ["~> 0"])
+      s.add_dependency(%q<pry-remote>, ["~> 0"])
+      s.add_dependency(%q<pry-rescue>, ["~> 1"])
+      s.add_dependency(%q<pry-stack_explorer>, ["~> 0"])
+    end
+  else
+    s.add_dependency(%q<semver>, ["~> 1"])
+    s.add_dependency(%q<awesome_print>, ["~> 1"])
+    s.add_dependency(%q<text-table>, ["~> 1"])
+    s.add_dependency(%q<thor>, ["~> 0"])
+    s.add_dependency(%q<colorize>, ["~> 0"])
+    s.add_dependency(%q<rspec>, ["~> 2"])
+    s.add_dependency(%q<yard>, ["~> 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3"])
+    s.add_dependency(%q<bundler>, ["~> 1"])
+    s.add_dependency(%q<juwelier>, ["~> 2"])
+    s.add_dependency(%q<simplecov>, ["~> 0"])
+    s.add_dependency(%q<pry>, ["~> 0"])
+    s.add_dependency(%q<pry-byebug>, ["~> 3"])
+    s.add_dependency(%q<pry-doc>, ["~> 0"])
+    s.add_dependency(%q<pry-remote>, ["~> 0"])
+    s.add_dependency(%q<pry-rescue>, ["~> 1"])
+    s.add_dependency(%q<pry-stack_explorer>, ["~> 0"])
+  end
+end
+

data/lib/imap-filter.rb

@@ -0,0 +1,17 @@
+require 'thor'
+require 'semver'
+require 'pp'
+require 'ap'
+require 'colorize'
+require 'awesome_print'
+require 'net/imap'
+require 'forwardable'
+
+module ImapFilter
+end
+
+require_relative 'imap-filter/monkeypatches'
+require_relative 'imap-filter/dsl'
+require_relative 'imap-filter/functionality'
+require_relative 'imap-filter/imap-filter'
+require_relative 'imap-filter/cli'

data/lib/imap-filter/cli.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+require 'imap-filter'
+
+include ImapFilter::DSL
+
+module ImapFilter
+  module Cli
+    class Main < Thor
+      class_option :verbose, type: :numeric, banner: '[1|2|3|4]', aliases: '-v', default: 0
+      @@default_script = ENV['IMAPF_IMAP_FILE'] || 'default.imap'
+      
+      desc 'filter [script]', "Run the powerplay script. Default #{@@default_script}"
+      option :dryrun, type: :boolean, aliases: '-u', desc: "Dry run, do not actually execute."
+      option :test, type: :boolean, aliases: '-t', desc: "Test IMAP accounts only."
+      option :filters, type: :array,   aliases: '-f', banner: %(<FILT1>[ FILT2 FILT3...]), 
+                                                      desc: "Run specified filters. The default is to run all of them."
+      def filter(script = @@default_script)
+        _global[:options] = options
+        puts "script %s " % [script] if _options[:verbose] >= 1
+        load script, true
+      end
+    end
+  end
+end

data/lib/imap-filter/dsl.rb

@@ -0,0 +1,321 @@
+# coding: utf-8
+require 'imap-filter'
+
+module ImapFilter
+  module DSL
+    @@global_config = {}
+
+    def _global
+      @@global_config
+    end
+
+    def _options
+      DSL::_global[:options]
+    end
+    
+    def _accounts
+      DSL::_global[:accounts] ||= {}
+    end
+
+    def _filters
+      DSL::_global[:filters] ||= {}
+    end
+
+    class Dsl
+      attr :name, :desc
+      
+      def initialize(name, desc=nil, &ignore)
+        @name = name
+        @desc = desc
+      end
+    end
+    
+    class Account < Dsl
+      attr :name, :userid, :pass, :fqdn, :use_ssl, :use_port, :auth_type
+      attr :imap, :delim
+      
+      def login userid, password
+        @userid = userid
+        @pass = password
+        @use_ssl = true
+        @use_port = nil
+        @auth_type = 'PLAIN'
+      end
+
+      def serv fqdn
+        @fqdn = fqdn
+      end
+
+      def ssl t
+        @use_ssl = t
+      end
+      
+      def port p
+        @use_port = p
+      end
+
+      def auth type
+        @auth_type = type.to_s.upcase
+      end
+      
+      def initialize(name, &block)
+        super
+        @name = name
+        instance_eval( &block )
+        _accounts[name] = self        
+      end
+
+      def to_s
+        "SERV #{fqdn} USER #{userid} SSL #{use_ssl} PORT #{ use_port ? use_port : '<default>'} AUTH #{auth_type} >DELIM #{delim}"
+      end
+
+      # connects and logs in
+      def _open_connection
+        print "\n    *** connect #{fqdn} port '#{use_port}' ssl #{use_ssl}".light_cyan unless _options[:verbose] < 2
+        unless use_port.nil?
+          @imap =  Net::IMAP.new(fqdn, port: use_port, ssl: use_ssl)
+        else
+          @imap =  Net::IMAP.new(fqdn, ssl: use_ssl)
+        end
+
+        print "\n    *** auth #{userid} pass #{pass}...".light_cyan unless _options[:verbose] < 2
+        imap.authenticate(auth_type, userid, pass)
+        @delim = imap.list('', '').first.delim
+      end
+
+      def _close_connection
+        imap.close
+      end
+    end
+
+    class Filter < Dsl
+      attr :mbox, :directives, :actions
+      OPS = [:or, :not, :new]
+      MARKS = {
+        seen: :Seen,
+        read: :Seen,
+        unread: :Unseen,
+        unseen: :Unseen,
+        deleted: :Deleted,
+        flagged: :Flagged
+      }
+      DIRECTIVES = {
+        all: 'ALL',
+        new: 'NEW',
+        recent: 'RECENT',
+        seen: 'SEEN',
+        read: 'SEEN',
+        unseen: 'UNSEEN',
+        unread: 'UNSEEN',
+        answered: 'ANSWERED',
+        unanswered: 'UNANSWERED',
+        deleted: 'DELETED',
+        undeleted: 'UNDELETED',
+        draft: 'DRAFT',
+        undraft: 'UNDRAFT',
+        flagged: 'FLAGGED',
+        unflagged: 'UNFLAGGED',
+      }
+
+      def list *a, **h
+        @actions << [:list, a, h]
+      end
+      
+      def move to_mbox
+        @actions << [:move, to_mbox]
+      end
+      alias mv move
+
+      def copy to_mbox
+        @actions << [:copy, to_mbox]
+      end
+      alias cp copy
+      
+      def delete
+        @actions << [:delete]
+      end
+
+      def mark *flags, custom: false
+        flags.each do |f|
+          raise "Illegal flag #{f}" unless MARKS.member? f
+        end unless custom
+        @actions << [:mark] + flags.map{ |f| MARKS[f] || f }
+      end
+      alias store mark
+
+      def unmark *flags,  custom: false
+        flags.each do |f|
+          raise "Illegal flag #{f}" unless MARKS.member? f
+        end unless custom
+        @actions << [:unmark] + flags.map{ |f| MARKS[f] || f }
+      end
+      alias unstore unmark
+
+      def search &block        
+        def before d
+          directives << 'BEFORE' << d
+        end
+
+        def body s
+          directives << 'BODY'<< s
+        end
+
+        def cc s
+          directives << 'CC' << s
+        end
+
+        def bcc s
+          directives << 'BCC' << s
+        end
+
+        def from s
+          directives << 'FROM' << s
+        end
+
+        def op *a          
+          a.each { |x|
+            raise "illegal operator #{x}" unless OPS.member? x
+            directives << x.to_s.upcase
+          }
+        end          
+        
+        def on d
+          directives << 'ON' << d
+        end
+
+        def since d
+          directives << 'SINCE' << d
+        end
+        
+        def senton d
+          directives << 'SENTON' << d
+        end
+        
+        def sentsince d
+          directives << 'SENTSINCE' << d
+        end
+        
+        def sentbefore d
+          directives << 'SENTBEFORE' << d
+        end
+        
+        def smaller n 
+          directives << 'SMALLER' << n
+        end
+
+        def subject s
+          directives << 'SUBJECT' << s
+        end
+        
+        def text s
+          directives << 'TEXT' << s
+        end
+
+        def to s
+          directives << 'TO' << s
+        end
+
+        def all
+          directives << 'ALL'
+        end
+        
+        def answered
+          directives << 'ANSWERED'
+        end
+        
+        def unanswered
+          directives << 'UNANSWERED'
+        end
+        
+        def deleted
+          directives << 'DELETED'
+        end
+        
+        def undeleted
+          directives << 'UNDELETED'
+        end
+        
+        def draft
+          directives << 'DRAFT'
+        end
+        
+        def undraft
+          directives << 'UNDRAFT'
+        end
+        
+        def flagged
+          directives << 'FLAGGED'
+        end
+        
+        def unflagged
+          directives << 'UNFLAGGED'
+        end
+        
+        def seen
+          directives << 'SEEN'
+        end
+        alias red seen
+        
+        def unseen
+          directives << 'UNSEEN'
+        end
+        alias unread unseen
+        
+        def keyword key
+          directives << 'KEYWORD' << key
+        end      
+        
+        def unkeyword key
+          directives << 'UNKEYWORD' << key
+        end      
+        
+        instance_eval &block        
+      end
+
+      def massage directives
+        if directives.is_a?(Hash)
+          directives.map{ |k, v|
+            unless v.is_a? Array
+              [k.to_s.upcase, v]
+            else
+              ['OR',
+               v.map{ |va|
+                 [k.to_s.upcase, va]
+               }].flatten
+            end
+          }.flatten
+        elsif directives.is_a?(Symbol)
+          DIRECTIVES[directives]
+        else
+          directives
+        end
+      end
+      
+      # note that directives can be either a hash or a single symbol
+      def initialize(name, mbox, directives=[], &block)
+        super(name)
+        @mbox = mbox
+        @directives = massage directives
+        @actions = []
+        instance_eval &block 
+        _filters[name] = self
+      end
+
+      def to_s
+        "MBOX #{mbox} DIRECTIVES #{directives}"
+      end
+    end
+    
+    def account name, &block
+      Account.new name, &block
+    end
+
+    def filter name, mbox, singledir=nil, **directives, &block
+      Filter.new name, mbox, (singledir || directives), &block
+    end
+    
+    def activate filters
+      Functionality.run_filters filters
+    end
+  end
+end