imap-backup 14.4.5 → 14.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e492fd50201bbf2424231905b4cdb6fe3d44d99fa446c624b851c9ef50eb686f
-  data.tar.gz: e2ed159ec5e92e7d97a685093456491afe94d34e70702d4e7a0449cf150009dd
+  metadata.gz: 7ff8bf4fdd37e57e1fd9cef8abc4485813eeb48752768a3f463df3afac3dc4d6
+  data.tar.gz: 831899f082fff0997acd46d1e341004ac43cf53a2883358e67ab095b88a26bf7
 SHA512:
-  metadata.gz: d0f4acc27fa79b789c83298af7788c01e9b8c837aa5086d1675e98b7ef80abd7fe1b3decb4b36c3f586126f7d9dc54499358bc05f7e65e0de3cbc29207233188
-  data.tar.gz: e036ad78bff71f98012907444f5eb36c56e01f3a3a8d2f37fbb0b06f5c1850eaddd26a4be86a8581a8f25e322731eac06a25a18853ac4433a2793cbd603b8727
+  metadata.gz: d826d98de67625935c73a0ae01f2896717428dc3357ba899f5edee47a8b458064c932eea98a7331b0c6678f233329ae71001d7038cfaf1dd22aa5ea5f19d723e
+  data.tar.gz: 9570a8070e6ab390c65dfb1a395a69f5b26aa501a777acb8e1cd58956adddd76b0c6e6bdd828b26f29c375ff671adcb31a91fdd85839be363d99179bea92bf9f

data/README.md

@@ -63,7 +63,7 @@ $ rspec
 To exclude container-based tests
 
 ```sh
-$ rspec --tag ~docker
+$ rspec --tag ~container
 ```
 
 To run **just** the feature specs

data/imap-backup.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "os"
   gem.add_runtime_dependency "rake"
   gem.add_runtime_dependency "thor", "~> 1.1"
-  gem.add_runtime_dependency "thunderbird", ">= 0.0.0"
+  gem.add_runtime_dependency "thunderbird", "0.3.0"
 
   gem.metadata = {
     "rubygems_mfa_required" => "true"

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

@@ -22,7 +22,7 @@ module Imap::Backup
       )
       wanted = backup_folders.map(&:name)
       serialized_folders = Account::SerializedFolders.new(account: account)
-      serialized_folders.each do |serializer, _folder|
+      serialized_folders.each_key do |serializer|
         serializer.delete if !wanted.include?(serializer.folder)
       end
     end

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

@@ -17,7 +17,7 @@ module Imap::Backup
       @account = account
     end
 
-    # Runs the enumeration
+    # Runs the enumeration over local serializers and remote folders
     # @yieldparam serializer [Serializer] the folder's serializer
     # @yieldparam folder [Account::Folder] the online folder
     # @return [void]
@@ -32,6 +32,32 @@ module Imap::Backup
       end
     end
 
+    # Runs the enumeration over each local serializer
+    # @yieldparam serializer [Serializer] the folder's serializer
+    # @return [void]
+    def each_key(&block)
+      return enum_for(:each_key) if !block
+
+      glob.each do |path|
+        name = path.relative_path_from(base).to_s[0..-6]
+        serializer = Serializer.new(account.local_path, name)
+        block.call(serializer)
+      end
+    end
+
+    # Runs the enumeration over each remote folder
+    # @yieldparam folder [Account::Folder] the online folder
+    # @return [void]
+    def each_value(&block)
+      return enum_for(:each_value) if !block
+
+      glob.each do |path|
+        name = path.relative_path_from(base).to_s[0..-6]
+        folder = Account::Folder.new(account.client, name)
+        block.call(folder)
+      end
+    end
+
     private
 
     attr_reader :account

data/lib/imap/backup/account.rb

@@ -42,9 +42,6 @@ module Imap::Backup
     # The address of the IMAP server
     # @return [String]
     attr_reader :server
-    # Extra options to be passed to the IMAP server when connecting
-    # @return [Hash, void]
-    attr_reader :connection_options
     # The name of the download strategy to adopt during backups
     # @return [String]
     attr_accessor :download_strategy
@@ -67,10 +64,11 @@ module Imap::Backup
       @password = options[:password]
       @local_path = options[:local_path]
       @folders = options[:folders]
-      @folder_blacklist = options[:folder_blacklist]
-      @mirror_mode = options[:mirror_mode]
+      @folder_blacklist = options[:folder_blacklist] || false
+      @mirror_mode = options[:mirror_mode] || false
       @server = options[:server]
-      @connection_options = options[:connection_options]
+      @connection_options = nil
+      @supplied_connection_options = options[:connection_options]
       @download_strategy = options[:download_strategy]
       @multi_fetch_size_orignal = options[:multi_fetch_size]
       @reset_seen_flags_after_fetch = options[:reset_seen_flags_after_fetch]
@@ -146,7 +144,7 @@ module Imap::Backup
       h[:folder_blacklist] = true if @folder_blacklist
       h[:mirror_mode] = true if @mirror_mode
       h[:server] = @server if @server
-      h[:connection_options] = @connection_options if @connection_options
+      h[:connection_options] = @connection_options if connection_options
       h[:multi_fetch_size] = multi_fetch_size
       if @reset_seen_flags_after_fetch
         h[:reset_seen_flags_after_fetch] = @reset_seen_flags_after_fetch
@@ -198,8 +196,22 @@ module Imap::Backup
       update(:server, value)
     end
 
+    # Extra options to be passed to the IMAP server when connecting
+    # @return [Hash, void]
+    def connection_options
+      @connection_options ||=
+        case @supplied_connection_options
+        when String
+          JSON.parse(@supplied_connection_options, symbolize_names: true)
+        else
+          @supplied_connection_options
+        end
+    end
+
     # @return [void]
     def connection_options=(value)
+      # Ensure we've loaded the connection_options
+      connection_options
       parsed =
         if value == ""
           nil

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

@@ -70,7 +70,7 @@ module Imap::Backup
         list = serialized_folders.map { |_s, f| {name: f.name} }
         Kernel.puts list.to_json
       else
-        serialized_folders.each do |_s, f|
+        serialized_folders.each_value do |f|
           Kernel.puts %("#{f.name}")
         end
       end

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

@@ -84,7 +84,7 @@ module Imap::Backup
 
       raise "No serialized folders were found for account '#{email}'" if serialized_folders.none?
 
-      serialized_folders.each do |serializer, _folder|
+      serialized_folders.each_key do |serializer|
         Thunderbird::MailboxExporter.new(
           email, serializer, profile, force: force
         ).run

data/lib/imap/backup/email/provider/base.rb

@@ -8,9 +8,7 @@ module Imap::Backup
   class Email::Provider::Base
     # @return [Hash] defaults for the Net::IMAP connection
     def options
-      # rubocop:disable Naming/VariableNumber
-      {port: 993, ssl: {ssl_version: :TLSv1_2}}
-      # rubocop:enable Naming/VariableNumber
+      {port: 993, ssl: {min_version: OpenSSL::SSL::TLS1_2_VERSION}}
     end
 
     def sets_seen_flags_on_fetch?

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

@@ -108,6 +108,7 @@ module Imap::Backup
     def delete
       return if !exist?
 
+      Logger.logger.info("Deleting metadata file '#{pathname}'")
       FileUtils.rm(pathname)
       @loaded = false
       @messages = nil

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

@@ -70,6 +70,7 @@ module Imap::Backup
     def delete
       return if !exist?
 
+      Logger.logger.info("Deleting mailbox '#{pathname}'")
       FileUtils.rm(pathname)
     end
 

data/lib/imap/backup/serializer.rb

@@ -28,7 +28,41 @@ module Imap::Backup
     extend Forwardable
 
     def_delegator :mbox, :pathname, :mbox_pathname
-    def_delegators :imap, :get, :messages, :uid_validity, :uids, :update_uid
+
+    # Get message metadata
+    # @param uid [Integer] a message UID
+    # @return [Serializer::Message]
+    def get(uid)
+      validate!
+      imap.get(uid)
+    end
+
+    # @return [Array<Hash>]
+    def messages
+      validate!
+      imap.messages
+    end
+
+    # @return [Integer] the UID validity for the folder
+    def uid_validity
+      validate!
+      imap.uid_validity
+    end
+
+    # @return [Array<Integer>] The uids of all messages
+    def uids
+      validate!
+      imap.uids
+    end
+
+    # Update a message's metadata, replacing its UID
+    # @param old [Integer] the existing message UID
+    # @param new [Integer] the new UID to apply to the message
+    # @return [void]
+    def update_uid(old, new)
+      validate!
+      imap.update_uid(old, new)
+    end
 
     # @return [String] a folder name
     attr_reader :folder
@@ -62,10 +96,14 @@ module Imap::Backup
 
       optionally_migrate2to3
 
-      if imap.valid? && mbox.valid?
+      imap_valid = imap.valid?
+      mbox_valid = mbox.valid?
+      if imap_valid && mbox_valid
         @validated = true
         return true
       end
+      Logger.logger.info("Metadata file '#{imap.pathname}' is invalid") if !imap_valid
+      Logger.logger.info("Mailbox '#{mbox.pathname}' is invalid") if !mbox_valid
 
       delete
 
@@ -247,6 +285,8 @@ module Imap::Backup
       MESSAGE
 
       migrator.run
+      # Ensure new metadata gets loaded
+      @imap = nil
     end
 
     def ensure_containing_directory

data/lib/imap/backup/thunderbird/mailbox_exporter.rb

@@ -104,7 +104,7 @@ module Imap::Backup
       @local_folder ||= begin
         top_level_folders = [EXPORT_PREFIX, email]
         prefixed_folder_path = File.join(top_level_folders, serializer.folder)
-        ::Thunderbird::LocalFolder.new(profile, prefixed_folder_path)
+        ::Thunderbird::LocalFolder.new(profile: profile, path: prefixed_folder_path)
       end
     end
 

data/lib/imap/backup/version.rb

@@ -4,9 +4,9 @@ module Imap::Backup
   # @private
   MAJOR    = 14
   # @private
-  MINOR    = 4
+  MINOR    = 5
   # @private
-  REVISION = 5
+  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.4.5
+  version: 14.5.1
 platform: ruby
 authors:
 - Joe Yates
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-24 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -112,16 +112,16 @@ dependencies:
   name: thunderbird
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.0
+        version: 0.3.0
 description: Backup GMail, or any other IMAP email service, to disk.
 email:
 - joe.g.yates@gmail.com
@@ -218,7 +218,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -233,8 +233,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: Backup GMail (or other IMAP) accounts to disk
 test_files: []