imap_guard 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b9bad59e96b10c29a2a065cd6b5d866f10e8d7c8
-  data.tar.gz: d110224b73afef6abc0cc7805aefc906ee222b35
+SHA256:
+  metadata.gz: 25df25da92ea0dae5ec4d6aaf9484049aa9713cc358ad43e6fce41628e2007a3
+  data.tar.gz: '0028b947283d027fa80184fbcbc211e922539644a452e4ed859c4ea3822ec832'
 SHA512:
-  metadata.gz: ef2d1979d3459bf83732861e5d6972af03cf698dd3178b8d9b7326eed9b0c44c4b17b3dab7c038a14425c5eb980c7f3255f6d412729af4c89810e66d597a42f9
-  data.tar.gz: f23003553803bf31aaf648d840f221a627387c147e326e399f8ecf02a320059325ef6a412161a00c35a96efea91fc65f1e2e2097309c18097045f8b932b02a0d
+  metadata.gz: 87d43bcba3020e0d2ec1b4a7e5d589abff5fa842ce83ab3405c2216818cfd43c877003613a4d65cb42abe190ab75d72435ab577efdd1dc914ebc77b87f46d74a
+  data.tar.gz: 4279c2dd1877d4f83508094d0725298d8e08ea1940c0c925c89a4842ffd196465b0cb3186555f73dbf15e50cafbda2b884d8982df0b3162dd1740a608316765a

data/.gitlab-ci.yml

@@ -0,0 +1,16 @@
+# Official language image. Look for the different tagged releases at:
+# https://hub.docker.com/r/library/ruby/tags/
+image: ruby:latest
+
+before_script:
+  - ruby -v
+  - bundle install -j $(nproc)
+
+rspec:
+  script: rspec spec
+
+rubocop:
+  script: rubocop
+
+yard:
+  script: yard stats --list-undoc

data/.rspec

@@ -1,3 +1,3 @@
 --color
 --format d
---order random
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,46 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Metrics:
+  Enabled: false
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Layout/LineLength:
+  Enabled: 100
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/ExpectInHook:
+  Enabled: false
+
+RSpec/ExpectOutput:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false # TODO: enable
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false

data/Gemfile

@@ -1,4 +1,16 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-# Specify your gem's dependencies in imap_guard.gemspec
+source "https://rubygems.org"
+
+# Specify your gem's runtime dependencies in imap_guard.gemspec
 gemspec
+
+# Specify your gem's development dependencies below:
+gem "bundler", ">= 1.3"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "simplecov"
+gem "yard"

data/Guardfile

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec' do
+guard "rspec" do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})        { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch(%r{^lib/(.+)/(.+)\.rb$})   { |m| "spec/#{m[1]}/#{m[2]}_spec.rb" }
-  watch('spec/spec_helper.rb')     { "spec" }
+  watch("spec/spec_helper.rb")     { "spec" }
   watch(%r{^spec/support/.+\.rb$}) { "spec" }
 end
-

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2015 Cédric Félizard
+Copyright (c) 2013-2022 Cédric Félizard
 
 MIT License
 

data/README.md

@@ -1,13 +1,11 @@
-# ImapGuard [![Build Status](https://secure.travis-ci.org/infertux/imap_guard.png?branch=master)](https://travis-ci.org/infertux/imap_guard) [![Dependency Status](https://gemnasium.com/infertux/imap_guard.png)](https://gemnasium.com/infertux/imap_guard) [![Code Climate](https://codeclimate.com/github/infertux/imap_guard.png)](https://codeclimate.com/github/infertux/imap_guard)
+# ImapGuard
 
-**A guard for your IMAP mailboxes.**
+[![Gem Version](https://badge.fury.io/rb/imap_guard.svg)](https://badge.fury.io/rb/imap_guard)
+[![Build Status](https://gitlab.com/infertux/imap_guard/badges/master/pipeline.svg)](https://gitlab.com/infertux/imap_guard/-/pipelines)
+[![Code Climate](https://codeclimate.com/github/infertux/imap_guard.png)](https://codeclimate.com/github/infertux/imap_guard)
+[![Inline docs](http://inch-ci.org/github/infertux/imap_guard.svg)](http://inch-ci.org/github/infertux/imap_guard)
 
-  * [Source Code](https://github.com/infertux/imap_guard "Source Code on Github")
-  * [Bug Tracker](https://github.com/infertux/imap_guard/issues "Bug Tracker on Github")
-  * [API documentation](http://rubydoc.info/gems/imap_guard/frames "API Documentation on Rubydoc")
-  * [Rubygem](https://rubygems.org/gems/imap_guard "ImapGuard on Rubygems")
-  * [Continuous Integration](https://travis-ci.org/infertux/imap_guard "ImapGuard on Travis-CI")
-  * [Dependencies](https://gemnasium.com/infertux/imap_guard "ImapGuard dependencies on Gemnasium")
+**A guard for your IMAP mailboxes.**
 
 ImapGuard connects to your IMAP server and processes your emails.
 You can finely pick them thanks to advanced search queries and Ruby blocks.
@@ -70,7 +68,7 @@ guard.delete base_query.dup.before(7).subject("Logwatch for ") do |mail|
 end
 ```
 
-Finally, you can always forge your own raw IMAP search queries (the [RFC](http://tools.ietf.org/html/rfc3501#section-6.4.4) can help in that case):
+You can always forge your own raw IMAP search queries (the [RFC](http://tools.ietf.org/html/rfc3501#section-6.4.4) can help in that case):
 
 ```ruby
 query = 'SEEN SUBJECT "ALERT" FROM "root"'
@@ -79,19 +77,19 @@ guard.delete query do |mail|
 end
 ```
 
-Be aware that emails won't be touched until you `expunge` or `close` the mailbox:
+There is a `move` method as well:
 
 ```ruby
-guard.expunge # effectively delete emails marked as deleted
-guard.close # expunge then close the connection
+guard.move query, 'destination_folder' do |mail|
+  # and it can take a filter block like `delete`
+end
 ```
 
-Oh, and there is a `move` method as well:
+Finally, this should be handled automatically but you can explicitly expunge pending emails and close the connection:
 
 ```ruby
-guard.move query, 'destination_folder' do |mail|
-  # and it can take a filter block like `delete`
-end
+guard.expunge # effectively delete emails marked as deleted
+guard.close # expunge then close the connection
 ```
 
 ### Advanced features
@@ -134,4 +132,3 @@ MIT
 
 
 [Mail]: https://github.com/mikel/mail
-

data/Rakefile

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.ruby_opts = '-w'
+  t.ruby_opts = "-w"
 end
 
-task default: :spec
+RuboCop::RakeTask.new(:rubocop)
 
+task default: %i[spec rubocop]

data/examples/example.rb

@@ -1,43 +1,45 @@
 #!/usr/bin/env ruby
 
-require 'imap_guard'
+# frozen_string_literal: true
+# rubocop:disable all
+
+require "imap_guard"
 
 SETTINGS = {
-  host: 'imap.googlemail.com',
+  host: "imap.googlemail.com",
   port: 993,
-  username: 'you@gmail.com',
-  password: 'your_pass',
-}
+  username: "you@gmail.com",
+  password: "your_pass",
+}.freeze
 
-settings = SETTINGS.merge({ read_only: false })
+settings = SETTINGS.merge(read_only: false)
 base_query = ImapGuard::Query.new.unflagged.unanswered.freeze
 guard = ImapGuard::Guard.new settings
 # guard.debug = ->(mail) { print "#{mail.subject}: " }
 guard.login
 
-guard.select 'INBOX'
+guard.select "INBOX"
 
 # Github
 %w(github.com notifications@travis-ci.org app@gemnasium.com).map do |from|
   base_query.dup.from(from)
 end.each do |query|
-  guard.move query, 'INBOX.Github'
+  guard.move query, "INBOX.Github"
 end
 
 # To Do
-guard.move base_query.dup.from("me").to("me"), 'INBOX.TODO'
+guard.move base_query.dup.from("me").to("me"), "INBOX.TODO"
 
 # Ops
-guard.select 'INBOX.Ops'
+guard.select "INBOX.Ops"
 query = base_query.dup.seen
 guard.delete query.dup.subject("monit alert -- ").before(7)
 guard.delete query.dup.subject("CRON-APT completed on ").before(3)
 guard.delete query.dup.subject("Logwatch for ").before(7)
-guard.select 'INBOX'
+guard.select "INBOX"
 
 # Uni
-guard.move base_query.dup.or.from("uni.tld").to("uni.tld"), 'INBOX.Uni'
+guard.move base_query.dup.or.from("uni.tld").to("uni.tld"), "INBOX.Uni"
 
 # Bye!
 guard.disconnect
-

data/imap_guard.gemspec

@@ -1,32 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "imap_guard"
-  spec.version       = "1.0.0"
+  spec.version       = "2.0.0"
   spec.authors       = ["Cédric Félizard"]
   spec.email         = ["cedric@felizard.fr"]
-  spec.description   = %q{A guard for your IMAP server}
+  spec.description   = "A guard for your IMAP server"
   spec.summary       = spec.description
   spec.homepage      = "https://github.com/infertux/imap_guard"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($/) # rubocop:disable Style/SpecialGlobalVars
   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.add_dependency 'mail', '>= 2.5.3'
-  spec.add_dependency 'term-ansicolor', '>= 1.2.2'
+  spec.required_ruby_version = ">= 3.0.5"
+
+  spec.metadata["rubygems_mfa_required"] = "true"
 
-  spec.add_development_dependency 'bundler', '>= 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'guard-rspec'
-  spec.add_development_dependency 'rb-inotify'
-  spec.add_development_dependency 'cane'
-  spec.add_development_dependency 'yard'
-  spec.add_development_dependency 'redcarpet' # for yardoc
+  spec.add_dependency "mail", ">= 2.7.1"
+  spec.add_dependency "net-imap"
+  spec.add_dependency "term-ansicolor", ">= 1.2.2"
 end

data/lib/imap_guard/guard.rb

@@ -1,30 +1,35 @@
-require 'net/imap'
-require 'ostruct'
-require 'mail'
-require 'term/ansicolor'
-String.send(:include, Term::ANSIColor)
-Term::ANSIColor::coloring = STDOUT.isatty
+# frozen_string_literal: true
+
+require "net/imap"
+require "ostruct"
+require "mail"
+require "term/ansicolor"
+
+String.include Term::ANSIColor
+Term::ANSIColor.coloring = $stdout.isatty
 
 module ImapGuard
   # Guard allows you to process your mailboxes.
   class Guard
     # List of required settings
-    REQUIRED_SETTINGS = [:host, :port, :username, :password]
+    REQUIRED_SETTINGS = %i[host port username password].freeze
 
     # List of optional settings
-    OPTIONAL_SETTINGS = [:read_only, :verbose]
+    OPTIONAL_SETTINGS = %i[read_only verbose].freeze
+
+    Settings = Struct.new("Settings", *(REQUIRED_SETTINGS + OPTIONAL_SETTINGS))
 
     # @return [Proc, nil] Matched emails are passed to this debug lambda if present
     attr_accessor :debug
 
     # @note The settings are frozen
-    # @return [OpenStruct] ImapGuard settings
+    # @return [Struct::Settings] ImapGuard settings
     attr_reader :settings
 
     # @return [String, nil] Currently selected mailbox
     attr_reader :mailbox
 
-    def initialize settings
+    def initialize(settings)
       self.settings = settings
     end
 
@@ -39,7 +44,7 @@ module ImapGuard
 
     # Selects a mailbox (folder)
     # @return [void]
-    def select mailbox
+    def select(mailbox)
       if @settings.read_only
         @imap.examine(mailbox) # open in read-only
       else
@@ -53,15 +58,15 @@ module ImapGuard
     # @param mailbox Destination mailbox
     # @param filter Optional filter block
     # @return [void]
-    def move query, mailbox, &filter
-      operation = lambda { |message_id|
+    def move(query, mailbox, &filter)
+      operation = lambda do |message_id|
         unless @settings.read_only
           @imap.copy(message_id, mailbox)
           @imap.store(message_id, "+FLAGS", [Net::IMAP::DELETED])
         end
 
         "moved to #{mailbox}".yellow
-      }
+      end
       process query, operation, &filter
     end
 
@@ -69,14 +74,12 @@ module ImapGuard
     # @param query IMAP query
     # @param filter Optional filter block
     # @return [void]
-    def delete query, &filter
-      operation = lambda { |message_id|
-        unless @settings.read_only
-          @imap.store(message_id, "+FLAGS", [Net::IMAP::DELETED])
-        end
+    def delete(query, &filter)
+      operation = lambda do |message_id|
+        @imap.store(message_id, "+FLAGS", [Net::IMAP::DELETED]) unless @settings.read_only
 
-        'deleted'.red
-      }
+        "deleted".red
+      end
       process query, operation, &filter
     end
 
@@ -84,16 +87,16 @@ module ImapGuard
     # @param query IMAP query
     # @param opration Lambda to call on each message
     # @return [void]
-    def each query
-      operation = lambda { |message_id| yield message_id }
+    def each(query)
+      operation = ->(message_id) { yield message_id } # rubocop:disable Style/ExplicitBlockArgument
       process query, operation
     end
 
     # Fetches a message from its UID
     # @return [Mail]
     # @note We use "BODY.PEEK[]" to avoid setting the \Seen flag.
-    def fetch_mail message_id
-      msg = @imap.fetch(message_id, 'BODY.PEEK[]').first.attr['BODY[]']
+    def fetch_mail(message_id)
+      msg = @imap.fetch(message_id, "BODY.PEEK[]").first.attr["BODY[]"]
       Mail.read_from_string msg
     end
 
@@ -125,7 +128,7 @@ module ImapGuard
 
   private
 
-    def process query, operation
+    def process(query, operation)
       message_ids = search query
       count = message_ids.size
 
@@ -133,10 +136,10 @@ module ImapGuard
         print "Processing UID #{message_id} (#{index.succ}/#{count}): "
 
         result = true
-        if block_given? or debug
+        if block_given? || debug
           mail = fetch_mail message_id
 
-          debug.call(mail) if debug
+          debug.call(mail) if debug # rubocop:disable Style/SafeNavigation
 
           if block_given?
             result = yield(mail)
@@ -146,12 +149,11 @@ module ImapGuard
 
         puts result ? operation.call(message_id) : "ignored".green
       end
-
     ensure
       expunge
     end
 
-    def search query
+    def search(query)
       unless [Array, String].any? { |type| query.is_a? type }
         raise TypeError, "Query must be either a string holding the entire search string, or a single-dimension array of search keywords and arguments."
       end
@@ -164,27 +166,25 @@ module ImapGuard
 
     def verbose
       @verbose ||= if @settings.verbose
-        $stdout
-      else
-        # anonymous null object
-        Class.new do
-          def method_missing(*)
-            nil
-          end
-        end.new
-      end
+                     $stdout
+                   else
+                     # anonymous null object
+                     # rubocop:disable all
+                     Class.new do def method_missing(*); nil end end.new
+                     # rubocop:enable all
+                   end
     end
 
-    def settings= settings
+    def settings=(settings)
       missing = REQUIRED_SETTINGS - settings.keys
       raise ArgumentError, "Missing settings: #{missing}" unless missing.empty?
 
       unknown = settings.keys - REQUIRED_SETTINGS - OPTIONAL_SETTINGS
       raise ArgumentError, "Unknown settings: #{unknown}" unless unknown.empty?
 
-      @settings = OpenStruct.new(settings).freeze
+      struct = Settings.members.map { |member| settings.fetch(member, false) }
+      @settings = Settings.new(*struct).freeze
       puts "DRY-RUN MODE ENABLED".yellow.bold.negative if @settings.read_only
     end
   end
 end
-

data/lib/imap_guard/query.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ImapGuard
   # Query is a neat DSL to help you generate IMAP search queries.
   # @note All methods return self so they can be chained.
@@ -5,31 +7,31 @@ module ImapGuard
     # Messages that have the +\Seen+ flag set.
     # @return [self]
     def seen
-      self << 'SEEN'
+      self << "SEEN"
     end
 
     # Messages that do not have the +\Seen+ flag set.
     # @return [self]
     def unseen
-      self << 'UNSEEN'
+      self << "UNSEEN"
     end
 
     # Messages that do not have the +\Answered+ flag set.
     # @return [self]
     def unanswered
-      self << 'UNANSWERED'
+      self << "UNANSWERED"
     end
 
     # Messages that do not have the +\Flagged+ flag set.
     # @return [self]
     def unflagged
-      self << 'UNFLAGGED'
+      self << "UNFLAGGED"
     end
 
     # Messages with the +\Deleted+ flag set.
     # @return [self]
     def deleted
-      self << 'DELETED'
+      self << "DELETED"
     end
 
     # Messages that match either search key.
@@ -41,13 +43,13 @@ module ImapGuard
     #   or.unanswered.unflagged     #=> ["OR", "UNANSWERED", "UNFLAGGED"]
     #   or(:unanswered, :unflagged) #=> ["OR", "UNANSWERED", "UNFLAGGED"]
     # @return [self]
-    def or search_key1 = nil, search_key2 = nil
-      self << 'OR'
+    def or(search_key1 = nil, search_key2 = nil)
+      self << "OR"
 
-      if search_key1 and search_key2
+      if search_key1 && search_key2
         send(search_key1)
         send(search_key2)
-      elsif search_key1 or search_key2
+      elsif search_key1 || search_key2
         raise ArgumentError, "You must give either zero or two arguments."
       end
 
@@ -60,8 +62,8 @@ module ImapGuard
     #   not.deleted   #=> ["NOT", "DELETED"]
     #   not(:deleted) #=> ["NOT", "DELETED"]
     # @return [self]
-    def not search_key = nil
-      self << 'NOT'
+    def not(search_key = nil)
+      self << "NOT"
       send(search_key) if search_key
       self
     end
@@ -69,29 +71,29 @@ module ImapGuard
     # Messages that contain the specified string in the envelope
     # structure's SUBJECT field.
     # @return [self]
-    def subject string
-      self << 'SUBJECT' << string
+    def subject(string)
+      self << "SUBJECT" << string
     end
 
     # Messages that contain the specified string in the envelope
     # structure's FROM field.
     # @return [self]
-    def from string
-      self << 'FROM' << string
+    def from(string)
+      self << "FROM" << string
     end
 
     # Messages that contain the specified string in the envelope
     # structure's TO field.
     # @return [self]
-    def to string
-      self << 'TO' << string
+    def to(string)
+      self << "TO" << string
     end
 
     # Messages that contain the specified string in the envelope
     # structure's CC field.
     # @return [self]
-    def cc string
-      self << 'CC' << string
+    def cc(string)
+      self << "CC" << string
     end
 
     # Messages whose internal date (disregarding time and timezone)
@@ -101,20 +103,19 @@ module ImapGuard
     #   - [Fixnum]: _n_ days before today
     #   - [Date]: uses this date
     # @return [self]
-    def before date
-      case date
-      when String
-        # noop, uses it as is
-      when Fixnum
-        date = (Date.today - date).strftime '%e-%b-%Y'
-      when Date
-        date = date.strftime '%e-%b-%Y'
-      else
-        raise ArgumentError, "#{date.inspect} is invalid."
-      end
+    def before(date)
+      date = case date
+             when String
+               date
+             when Integer
+               (Date.today - date).strftime "%e-%b-%Y"
+             when Date
+               date.strftime "%e-%b-%Y"
+             else
+               raise ArgumentError, "#{date.inspect} is invalid."
+             end
 
-      self << 'BEFORE' << date
+      self << "BEFORE" << date
     end
   end
 end
-

data/lib/imap_guard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "imap_guard/guard"
 require "imap_guard/query"