imapcli 0.0.1 → 1.0.0

data/lib/imapcli/option_validator.rb

@@ -0,0 +1,70 @@
+module Imapcli
+  # Utility class to validate user options
+  #
+  # Invalid options will trigger a runtime exception (which is handled by GLI).
+  class OptionValidator
+    attr_reader :errors, :warnings, :options
+
+    def initialize
+      @errors = []
+      @warnings = []
+    end
+
+    def global_options_valid?(global_options)
+      if global_options[:s].nil? || global_options[:s].empty?
+        @errors << 'missing server name (use -s option or set IMAP_SERVER environment variable)'
+      end
+      if global_options[:s].nil? || global_options[:s].empty?
+        @errors << 'missing server name (use -s option or set IMAP_SERVER environment variable)'
+      end
+      if global_options[:P] && global_options[:p]
+        @errors << '-p and -P options do not agree'
+      end
+
+      pass?
+    end
+
+    # Validates options for the stats command.
+    #
+    # @return [true false] indicating success or failure; warnings can be accessed as attribute
+    def stats_options_valid?(options, args)
+      @options = {}
+      raise 'incompatible options -r/--recurse and -R/--no_recurse' if options[:r] && options[:R]
+
+      if options[:recurse]
+        if args.empty?
+          @warnings << 'warning: superfluous -r/--recurse option; will recurse from root by default'
+        else
+          @options[:depth] = -1
+        end
+      elsif options[:no_recurse]
+        if args.empty?
+          @options[:depth] = 0
+        else
+          @warnings << 'warning: superfluous -R/--no_recurse option; will not recurse from non-root mailbox by default'
+        end
+      end
+
+      if options[:sort]
+        available_sort_options = %w(count total_size min_size q1 median_size q3 max_size)
+        if available_sort_options.include? options[:sort].downcase
+          @options[:sort] = options[:sort].to_sym
+        else
+          # GLI did not print the available options even with the :must_match option
+          @errors << "sort option must be one of: #{available_sort_options.join(', ')}"
+        end
+      end
+
+      pass?
+    end
+
+    def pass?
+      @errors.empty?
+    end
+
+    def warnings?
+      @warnings.count > 0
+    end
+
+  end
+end

data/lib/imapcli/stats.rb

@@ -0,0 +1,62 @@
+module Imapcli
+  # Handles mailbox statistics.
+  #
+  # +message_sizes+ is an array of message sizes in bytes.
+  class Stats
+
+    def initialize(message_sizes = [])
+      @message_sizes = message_sizes
+    end
+
+    # Adds other statistics.
+    def add(other_stats)
+      return unless other_stats
+      @message_sizes += other_stats.message_sizes
+      invalidate
+    end
+
+    def count
+      @count ||= @message_sizes&.length
+    end
+
+    def total_size
+      @total_size ||= convert_bytes(@message_sizes.sum)
+    end
+
+    def min_size
+      @min ||= convert_bytes(@message_sizes.min)
+    end
+
+    def quartile_1_size
+      @q1 ||= convert_bytes(@message_sizes.percentile(25))
+    end
+
+    def median_size
+      @median ||= convert_bytes(@message_sizes.median)
+    end
+
+    def quartile_3_size
+      @q3 ||= convert_bytes(@message_sizes.percentile(75))
+    end
+
+    def max_size
+      @max ||= convert_bytes(@message_sizes.max)
+    end
+
+    protected
+
+    attr_accessor :message_sizes
+
+    private
+
+    # Converts a number of bytes to kiB.
+    def convert_bytes(bytes)
+      bytes.fdiv(1024).round if bytes
+    end
+
+    def invalidate
+      @count, @total_size, @min, @max, @q1, @q3, @median = nil # sets others to nil too
+    end
+
+  end
+end

data/lib/imapcli/version.rb

@@ -1,3 +1,3 @@
 module Imapcli
-  VERSION = '0.0.1'
+  VERSION = '1.0.0'
 end

data/spec/lib/imapcli/client_spec.rb

@@ -34,7 +34,7 @@ RSpec.describe Imapcli::Client do
     end
   end
 
-  context 'with valid credentials for an actual server' do
+  context 'with valid credentials for an actual server', network: true do
     before :all do
       Dotenv.load
     end
@@ -55,12 +55,12 @@ RSpec.describe Imapcli::Client do
     end
   end
 
-  context 'with invalid credentials for an actual server' do
+  context 'with invalid credentials for an actual server', network: true do
     before :all do
       Dotenv.load
     end
 
-    let(:client) { Imapcli::Client.new(ENV['IMAP_SERVER'], ENV['IMAP_USER'], ENV['IMAP_PASS'] + 'invalid') }
+    let(:client) { Imapcli::Client.new(ENV['IMAP_SERVER'], ENV['IMAP_USER'], "#{ENV['IMAP_PASS']}invalid") }
 
     it 'cannot log in to the server' do
       expect(client.login).to eq false

data/spec/lib/imapcli/command_spec.rb

@@ -0,0 +1,123 @@
+require 'imapcli'
+
+RSpec.describe Imapcli::Command do
+
+  context 'without a client' do
+    it 'cannot be instantiated' do
+      expect { Imapcli::Command.new('foobar') }.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'with a mock client' do
+    let(:client) do
+      client = Imapcli::Client.new('server', 'user', 'pass')
+      allow(client).to receive(:login).and_return(true)
+      client
+    end
+    let(:command) { Imapcli::Command.new(client) }
+    let(:mailbox_root) do
+      Imapcli::Mailbox.new([
+        Net::IMAP::MailboxList.new(nil, '/', 'Inbox'),
+        Net::IMAP::MailboxList.new(nil, '/', 'Inbox/Foo'),
+        Net::IMAP::MailboxList.new(nil, '/', 'Inbox/Foo/Sub'),
+        Net::IMAP::MailboxList.new(nil, '/', 'Inbox/Bar'),
+        Net::IMAP::MailboxList.new(nil, '/', 'Inbox/Bar/Sub'),
+        Net::IMAP::MailboxList.new(nil, '/', 'Inbox/Bar/Sub/Subsub'),
+      ])
+    end
+
+    it 'can be instantiated' do
+      expect { Imapcli::Command.new(client) }.to_not raise_error
+    end
+
+    it 'logs in' do
+      expect(command.check).to eq true
+    end
+
+    it 'collects information about the server' do
+      allow(client).to receive(:greeting).and_return 'hello'
+      allow(client).to receive(:capability).and_return ['lots', 'of', 'capabilities']
+      allow(client).to receive(:separator).and_return '/'
+      allow(client).to receive(:supports_quota).and_return true
+      allow(client).to receive(:quota).and_return [ '1024', '2048', 50.00 ]
+      output = command.info
+      expect(output).to be_a Array
+      expect(output[0]).to eq 'greeting: hello'
+    end
+
+    it 'lists mailboxes' do
+      allow(client).to receive(:mailbox_root).and_return mailbox_root
+      output = command.list
+      expect(output).to be_a Array
+      expect(output[0]).to eq '- Inbox'
+    end
+
+    context 'collecting statistics' do
+      before :each do
+        allow(client).to receive(:mailbox_root).and_return mailbox_root
+        allow(client).to receive(:separator).and_return '/'
+        allow(client).to receive(:message_sizes) do |mailbox|
+          case mailbox
+          when 'Inbox'
+            (1..4).map { |i| 1024 * i }
+          when 'Inbox/Foo'
+            (3..10).map { |i| 1024 * i }
+          when 'Inbox/Foo/Sub'
+            Array.new(10, 1024)
+          when 'Inbox/Bar'
+            (1..2).map { |i| 1024 * i }
+          when 'Inbox/Bar/Sub'
+            [ 1, 1024 * 20 ]
+          when 'Inbox/Bar/Sub/Subsub'
+            (1..4).map { |i| 1024 * i }
+          else
+            [1024, 2048, 4096, 8192]
+          end
+        end
+      end
+
+      it 'for all folders' do
+        output = command.stats()
+        expect(output).to be_a Array
+        expect(output.length).to eq 8 # including divider and summary line
+        expect(output[0][0]).to eq 'Inbox'
+        expect(output[0][1]).to eq 4
+      end
+      it 'for a given folder' do
+        output = command.stats('Inbox/Foo')
+        expect(output).to be_a Array
+        expect(output.length).to eq 3 # including divider and summary line
+        expect(output[0][0]).to eq 'Inbox/Foo'
+        expect(output[0][1]).to eq 8 # depends on message_sizes stub (see above)
+      end
+      it 'for a given folder and subfolders' do
+        output = command.stats('Inbox/Foo', depth: -1)
+        expect(output).to be_a Array
+        expect(output.length).to eq 4 # including divider and summary line
+        expect(output[1][0]).to eq 'Inbox/Foo/Sub'
+      end
+      it 'sorts by number of messages' do
+        output = command.stats('Inbox', depth: -1, sort: :count, sort_order: :desc)
+        expect(output).to be_a Array
+        expect(output[0][0]).to eq 'Inbox/Foo/Sub'
+      end
+      it 'sorts by total message size' do
+        output = command.stats('Inbox', depth: -1, sort: :total_size, sort_order: :desc)
+        expect(output).to be_a Array
+        expect(output[0][0]).to eq 'Inbox/Foo'
+      end
+      it 'sorts by largest message' do
+        output = command.stats('Inbox', depth: -1, sort: :max_size, sort_order: :desc)
+        expect(output).to be_a Array
+        expect(output[0][0]).to eq 'Inbox/Bar/Sub'
+      end
+      it 'sorts by smallest message' do
+        output = command.stats('Inbox', depth: -1, sort: :min_size, sort_order: :desc)
+        expect(output).to be_a Array
+        # binding.pry
+        expect(output[0][0]).to eq 'Inbox/Foo'
+      end
+    end
+
+  end
+end

data/spec/lib/imapcli/mailbox_spec.rb

@@ -2,13 +2,22 @@ require 'imapcli'
 require 'net/imap'
 
 RSpec.describe Imapcli::Mailbox do
+  let(:mailbox) do
+    Imapcli::Mailbox.new([
+      Net::IMAP::MailboxList.new(nil, '/', 'Inbox'),
+      Net::IMAP::MailboxList.new(nil, '/', 'Inbox/Foo'),
+      Net::IMAP::MailboxList.new(nil, '/', 'Inbox/Foo/Sub'),
+      Net::IMAP::MailboxList.new(nil, '/', 'Inbox/Bar'),
+      Net::IMAP::MailboxList.new(nil, '/', 'Inbox/Bar/Sub'),
+      Net::IMAP::MailboxList.new(nil, '/', 'Inbox/Bar/Sub/Subsub'),
+    ])
+  end
   # it 'parses a mailbox list' do
   #   mailbox_list = Net::IMAP::MailboxList.new(attr: nil, delim: '/', name: 'Root/Subfolder')
-  #   mailbox_tree = Imapcli::MailboxTree.new(mailbox_list)
-  #   expect(mailbox_tree.tree.length).to eq 1
+  #   mailbox_root = Imapcli::MailboxTree.new(mailbox_list)
+  #   expect(mailbox_root.tree.length).to eq 1
   # end
   it 'returns nil if a given sub mailbox does not exist' do
-    mailbox = Imapcli::Mailbox.new
     expect(mailbox.find_sub_mailbox('INBOX.does.not.exist', '.')).to eq nil
   end
   it 'adds and retrieves an existing sub mailbox' do
@@ -18,4 +27,53 @@ RSpec.describe Imapcli::Mailbox do
     mailbox.add_mailbox(imap_mailbox_list)
     expect(mailbox.find_sub_mailbox(name, '/').imap_mailbox_list).to eq imap_mailbox_list
   end
+  it 'counts the number of mailboxes' do
+    expect(mailbox.count).to eq 7 # includes virtual root mailbox
+  end
+  it 'determines the maximum level in the subtree' do
+    expect(mailbox.get_max_level).to eq 3
+  end
+  it 'converts a tree to a list' do
+    list = mailbox.to_list
+    list_names = list.map { |m| m.full_name }
+    expect(list_names).to eq [
+      'Inbox',
+      'Inbox/Bar',
+      'Inbox/Bar/Sub',
+      'Inbox/Bar/Sub/Subsub',
+      'Inbox/Foo',
+      'Inbox/Foo/Sub',
+    ]
+  end
+  it 'converts a tree to a list up to a certain level' do
+    list = mailbox.to_list(1)
+    list_names = list.map { |m| m.full_name }
+    expect(list_names).to eq [
+      'Inbox',
+      'Inbox/Bar',
+      'Inbox/Foo'
+    ]
+  end
+
+  context 'identification and consolidation' do
+    let(:parent) { mailbox.find_sub_mailbox('Inbox', '/') }
+    let(:child) { mailbox.find_sub_mailbox('Inbox/Bar/Sub/Subsub', '/') }
+
+    it 'knows if it is contains another mailbox' do
+      expect(parent.contains? child).to eq true
+    end
+    it 'knows if it is does not contain another mailbox' do
+      expect(child.contains? mailbox).to eq false
+    end
+    # it 'consolidates several of the same mailboxes' do
+    #  expect(Imapcli::Mailbox.consolidate([parent, parent])).to eq [ parent ]
+    # end
+    it 'consolidates several of the same mailbox' do
+     expect(Imapcli::Mailbox.consolidate([child, child])).to eq [ child ]
+    end
+    it 'consolidates several different mailboxes' do
+     expect(Imapcli::Mailbox.consolidate([child, parent])).to eq [ parent ]
+    end
+
+  end
 end

data/spec/lib/imapcli/option_validator_spec.rb

@@ -0,0 +1,4 @@
+require 'imapcli'
+
+RSpec.describe Imapcli::OptionValidator do
+end

data/spec/lib/imapcli/stats_spec.rb

@@ -0,0 +1,68 @@
+require 'imapcli'
+
+RSpec.describe Imapcli::Stats do
+  let(:array) { (1..12).map { |i| i * 1024 } }
+  let(:other_array) { (13..24).map { |i| i * 1024 } }
+  let(:stats) { Imapcli::Stats.new(array) }
+  let(:other_stats) { Imapcli::Stats.new(other_array) }
+
+  it 'knows the number of items' do
+    expect(stats.count).to eq 12
+  end
+
+  it 'computes the minimum' do
+    expect(stats.min_size).to eq 1
+  end
+
+  it 'computes the maximum' do
+    expect(stats.max_size).to eq 12
+  end
+
+  it 'computes the median' do
+    expect(stats.median_size).to eq 7 # response is rounded
+  end
+
+  it 'computes the first quartile' do
+    expect(stats.quartile_1_size).to eq 4 # response is rounded
+  end
+
+  it 'computes the third quartile' do
+    expect(stats.quartile_3_size).to eq 9 # response is rounded
+  end
+
+  it 'adds nothing if other stats are nil' do
+    expect { stats.add nil }.to_not raise_error
+  end
+
+  context 'adding other stats' do
+    before :each do
+      stats.add other_stats
+    end
+
+    it 'can add other stats' do
+      expect(stats.count).to eq 24
+    end
+
+    it 'computes the minimum' do
+      expect(stats.min_size).to eq 1
+    end
+
+    it 'computes the maximum' do
+      expect(stats.max_size).to eq 24
+    end
+
+    it 'computes the median' do
+      expect(stats.median_size).to eq 13 # response is rounded
+    end
+
+    it 'computes the first quartile' do
+      expect(stats.quartile_1_size).to eq 7 # response is rounded
+    end
+
+    it 'computes the third quartile' do
+      expect(stats.quartile_3_size).to eq 18 # response is rounded
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -46,6 +46,8 @@ RSpec.configure do |config|
   # triggering implicit auto-inclusion in groups with matching metadata.
   config.shared_context_metadata_behavior = :apply_to_host_groups
 
+  config.filter_run_excluding network: true
+
 # The settings below are suggested to provide a good initial experience
 # with RSpec, but feel free to customize to your heart's content.
 =begin