imap-backup 14.6.0 → 15.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80b99aa3b4c713e6a88c9dbe504186fd64065a1d03d50d2d47a79de6ab14902f
-  data.tar.gz: c7a7d6f52b36819de9f660c488a8b4dfcf75794affa56547e197aab79c56cf7b
+  metadata.gz: 3504dad0e3f788bcfa95b38065e0ff4035239886461689c478a2e991f5e06cf9
+  data.tar.gz: 7d1151b5fb25f2d84ae2013f8f9f74fee7f998ca36b29333bf44151e52726376
 SHA512:
-  metadata.gz: 75e98d37c675dab0d44fe98f2689f3dd36cf30eb2968f3c6260268e733122fccf212b0e91024b4031bc2b8243011e240a8370c03681dca4b21e8a155262292f5
-  data.tar.gz: 46ca660ed4f2f87a3285db448b6e77e052df7628e512c57d7600876abca390b5e872529c76ef1f01b4ae35035d08a4941e24dd298d3db5850f44968ccbda25c2
+  metadata.gz: 3ec40ec413bd6bedce02d4c823ae1654c06585223532d1260bf01fe4ef0e8ba6e0b8c25c7adf0d2b39f8ff29c5199251d07fb9234a75a3ac50856075c91ccc52
+  data.tar.gz: d31020db8b37295d8d7209758161ce4fe5d16869a6976f3538e12b2d7a74f3cb363328d0dcd79ce665a2b113cf7f6289794ee328ded6e8a73cb544c4d0897428

data/imap-backup.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
 
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.require_paths = ["lib"]
-  gem.required_ruby_version = ">= 2.7"
+  gem.required_ruby_version = ">= 3.0"
 
   gem.add_runtime_dependency "highline"
   gem.add_runtime_dependency "mail", "2.7.1"

data/lib/imap/backup/account/folder_backup.rb

@@ -29,11 +29,13 @@ module Imap::Backup
 
       serializer.apply_uid_validity(folder.uid_validity)
 
-      download_serializer.transaction do
+      serializer.transaction do
         downloader.run
+        FlagRefresher.new(folder, serializer).run if account.mirror_mode || refresh
       end
-
-      clean_up
+      # After the transaction the serializer will have any appended messages
+      # so we can check differences between the server and the local backup
+      LocalOnlyMessageDeleter.new(folder, raw_serializer).run if account.mirror_mode
     end
 
     private
@@ -55,34 +57,29 @@ module Imap::Backup
       true
     end
 
-    def clean_up
-      LocalOnlyMessageDeleter.new(folder, serializer).run if account.mirror_mode
-      FlagRefresher.new(folder, serializer).run if account.mirror_mode || refresh
-    end
-
     def downloader
       @downloader ||= Downloader.new(
         folder,
-        download_serializer,
+        serializer,
         multi_fetch_size: account.multi_fetch_size,
         reset_seen_flags_after_fetch: account.reset_seen_flags_after_fetch
       )
     end
 
-    def download_serializer
-      @download_serializer ||=
+    def serializer
+      @serializer ||=
         case account.download_strategy
         when "direct"
-          serializer
+          raw_serializer
         when "delay_metadata"
-          Serializer::DelayedMetadataSerializer.new(serializer: serializer)
+          Serializer::DelayedMetadataSerializer.new(serializer: raw_serializer)
         else
           raise "Unknown download strategy '#{account.download_strategy}'"
         end
     end
 
-    def serializer
-      @serializer ||= Serializer.new(account.local_path, folder.name)
+    def raw_serializer
+      @raw_serializer ||= Serializer.new(account.local_path, folder.name)
     end
   end
 end

data/lib/imap/backup/account.rb

@@ -59,6 +59,7 @@ module Imap::Backup
     attr_reader :reset_seen_flags_after_fetch
 
     def initialize(options)
+      check_options!(options)
       @username = options[:username]
       @password = options[:password]
       @local_path = options[:local_path]
@@ -97,14 +98,6 @@ module Imap::Backup
       client.capability
     end
 
-    # Indicates whether the account has been configured, and is ready
-    # to be used
-    #
-    # @return [Boolean]
-    def valid?
-      username && password ? true : false
-    end
-
     def modified?
       changes.any?
     end
@@ -245,6 +238,23 @@ module Imap::Backup
 
     attr_reader :changes
 
+    REQUIRED_ATTRIBUTES = %i[password username].freeze
+    OPTIONAL_ATTRIBUTES = %i[
+      connection_options download_strategy folders folder_blacklist local_path mirror_mode
+      multi_fetch_size reset_seen_flags_after_fetch server
+    ].freeze
+    KNOWN_ATTRIBUTES = REQUIRED_ATTRIBUTES + OPTIONAL_ATTRIBUTES
+
+    def check_options!(options)
+      missing_required = REQUIRED_ATTRIBUTES - options.keys
+      if missing_required.any?
+        raise ArgumentError, "Missing required options: #{missing_required.join(', ')}"
+      end
+
+      unknown = options.keys - KNOWN_ATTRIBUTES
+      raise ArgumentError, "Unknown options: #{unknown.join(', ')}" if unknown.any?
+    end
+
     def update(field, value)
       key = :"@#{field}"
       if changes[field]

data/lib/imap/backup/cli/single/backup.rb

@@ -28,7 +28,7 @@ module Imap::Backup
         download_strategy: download_strategy,
         folder_blacklist: folder_blacklist,
         local_path: local_path,
-        mirror: mirror,
+        mirror_mode: mirror,
         reset_seen_flags_after_fetch: reset_seen_flags_after_fetch
       )
       account.connection_options = connection_options if connection_options

data/lib/imap/backup/client/automatic_login_wrapper.rb

@@ -23,12 +23,12 @@ module Imap::Backup
     # Proxies calls to the client.
     # Before the first call does login
     # @return the return value of the client method called
-    def method_missing(method_name, *arguments, &block)
+    def method_missing(method_name, ...)
       if login_called
-        client.send(method_name, *arguments, &block)
+        client.send(method_name, ...)
       else
         do_first_login
-        client.send(method_name, *arguments, &block) if method_name != :login
+        client.send(method_name, ...) if method_name != :login
       end
     end
 

data/lib/imap/backup/naming.rb

@@ -7,7 +7,7 @@ module Imap::Backup
     # The characters that cannot be used in file names
     INVALID_FILENAME_CHARACTERS = ":%;".freeze
     # A regular expression that captures each disallowed character
-    INVALID_FILENAME_CHARACTER_MATCH = /([#{INVALID_FILENAME_CHARACTERS}])/.freeze
+    INVALID_FILENAME_CHARACTER_MATCH = /([#{INVALID_FILENAME_CHARACTERS}])/
 
     # @param name [String] a folder name
     # @return [String] the supplied string iwth disallowed characters replaced

data/lib/imap/backup/serializer/delayed_metadata_serializer.rb

@@ -10,7 +10,7 @@ module Imap; end
 module Imap::Backup
   class Serializer; end
 
-  # Wraps the Serializer, delaying metadata appends
+  # Wraps the Serializer, delaying metadata changes
   class Serializer::DelayedMetadataSerializer
     extend Forwardable
 
@@ -31,7 +31,7 @@ module Imap::Backup
     def transaction(&block)
       tsx.fail_in_transaction!(:transaction, message: "nested transactions are not supported")
 
-      tsx.begin({metadata: []}) do
+      tsx.begin({appends: [], updates: []}) do
         mbox.transaction do
           block.call
 
@@ -42,7 +42,21 @@ module Imap::Backup
       end
     end
 
-    # Appends a message to the mbox file and adds the metadata
+    # Sets the folder's UID validity via the serializer
+    #
+    # @param uid_validity [Integer] the UID validity to apply
+    # @raise [RuntimeError] if called inside a transaction
+    # @return [void]
+    def apply_uid_validity(uid_validity)
+      tsx.fail_in_transaction!(
+        :transaction,
+        message: "UID validity cannot be changed in a transaction"
+      )
+
+      serializer.apply_uid_validity(uid_validity)
+    end
+
+    # Appends a message to the mbox file and adds the appended message's metadata
     # to the transaction
     #
     # @param uid [Integer] the UID of the message
@@ -53,10 +67,21 @@ module Imap::Backup
       tsx.fail_outside_transaction!(:append)
       mboxrd_message = Email::Mboxrd::Message.new(message)
       serialized = mboxrd_message.to_serialized
-      tsx.data[:metadata] << {uid: uid, length: serialized.bytesize, flags: flags}
+      tsx.data[:appends] << {uid: uid, length: serialized.bytesize, flags: flags}
       mbox.append(serialized)
     end
 
+    # Stores changes to a message's metadata for later update
+    #
+    # @param uid [Integer] the UID of the message
+    # @param length [Integer] the length of the message
+    # @param flags [Array<Symbol>] the flags for the message
+    # @return [void]
+    def update(uid, length: nil, flags: nil)
+      tsx.fail_outside_transaction!(:update)
+      tsx.data[:updates] << {uid: uid, length: length, flags: flags}
+    end
+
     private
 
     attr_reader :serializer
@@ -64,9 +89,12 @@ module Imap::Backup
     def commit
       # rubocop:disable Lint/RescueException
       imap.transaction do
-        tsx.data[:metadata].each do |m|
+        tsx.data[:appends].each do |m|
           imap.append m[:uid], m[:length], flags: m[:flags]
         end
+        tsx.data[:updates].each do |m|
+          imap.update m[:uid], length: m[:length], flags: m[:flags]
+        end
       rescue Exception => e
         Logger.logger.error "#{self.class} handling #{e.class}"
         imap.rollback

data/lib/imap/backup/serializer/imap.rb

@@ -97,11 +97,27 @@ module Imap::Backup
       save
     end
 
-    # Get message metadata
+    # Updates a message's length and/or flags
+    # @param uid [Integer] the existing message's UID
+    # @param length [Integer] the length of the message (as stored on disk)
+    # @param flags [Array[Symbol]] the message's flags
+    # @raise [RuntimeError] if the UID does not exist
+    # @return [void]
+    def update(uid, length: nil, flags: nil)
+      index = messages.find_index { |m| m.uid == uid }
+      raise "UID #{uid} not found" if !index
+
+      messages[index].length = length if length
+      messages[index].flags = flags if flags
+      save
+    end
+
+    # Get a copy of message metadata
     # @param uid [Integer] a message UID
     # @return [Serializer::Message]
     def get(uid)
-      messages.find { |m| m.uid == uid }
+      message = messages.find { |m| m.uid == uid }
+      message&.dup
     end
 
     # Deletes the metadata file
@@ -158,11 +174,15 @@ module Imap::Backup
       messages.map(&:uid)
     end
 
-    # Update a message's metadata, replacing its UID
+    # Update a message's UID
     # @param old [Integer] the existing message UID
     # @param new [Integer] the new UID to apply to the message
+    # @raise [RuntimeError] if the new UID already exists
     # @return [void]
     def update_uid(old, new)
+      existing = messages.find_index { |m| m.uid == new }
+      raise "UID #{new} already exists" if existing
+
       index = messages.find_index { |m| m.uid == old }
       return if index.nil?
 

data/lib/imap/backup/serializer.rb

@@ -28,6 +28,7 @@ module Imap::Backup
     extend Forwardable
 
     def_delegator :mbox, :pathname, :mbox_pathname
+    def_delegator :imap, :update
 
     # Get message metadata
     # @param uid [Integer] a message UID
@@ -77,7 +78,7 @@ module Imap::Backup
       @validated = nil
     end
 
-    # Calls the supplied block.
+    # Calls the supplied block without implementing transactional behaviour.
     # This method is present so that this class implements the same
     # interface as {DelayedMetadataSerializer}
     # @param block [block] the block that is wrapped by the transaction
@@ -177,18 +178,6 @@ module Imap::Backup
       appender.append(uid: uid, message: message, flags: flags)
     end
 
-    # Updates a messages flags
-    # @param uid [Integer] the message's UID
-    # @param flags [Array<Symbol>] the flags to set on the message
-    # @return [void]
-    def update(uid, flags: nil)
-      message = imap.get(uid)
-      return if !message
-
-      message.flags = flags if flags
-      imap.save
-    end
-
     # Enumerates over a series of messages.
     # When called without a block, returns an Enumerator
     # @param required_uids [Array<Integer>] the UIDs of the message to enumerate over

data/lib/imap/backup/setup/asker.rb

@@ -55,7 +55,7 @@ module Imap::Backup
 
     private
 
-    EMAIL_MATCHER = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]+$/i.freeze
+    EMAIL_MATCHER = /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]+$/i
 
     attr_reader :highline
   end

data/lib/imap/backup/version.rb

@@ -2,11 +2,11 @@ module Imap; end
 
 module Imap::Backup
   # @private
-  MAJOR    = 14
+  MAJOR    = 15
   # @private
-  MINOR    = 6
+  MINOR    = 0
   # @private
-  REVISION = 0
+  REVISION = 1
   # @private
   PRE      = nil
   # The application version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 14.6.0
+  version: 15.0.1
 platform: ruby
 authors:
 - Joe Yates
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -218,7 +218,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -226,7 +226,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -234,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Backup GMail (or other IMAP) accounts to disk
 test_files: []