imap-backup 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85975662cee269fb87e3de1150cd3a02c123e729e2d2f4e1a2e4905de477a897
-  data.tar.gz: 06aa1c25d470bc8f38cf78e124d00f90f498e9ba2e803804ebf7a58ce9f81579
+  metadata.gz: 55d07b2ed9eae209a118323f3e8c494b831183468ef92e05cfe2ae139177f82b
+  data.tar.gz: c76ad04b8363dd146fc2abdc5ba6243fe3cd446a107f946187bf45bf16689906
 SHA512:
-  metadata.gz: c75aff4a749a5630fe86bca252f676be0338c30c492ce3fdbe654c895143dcd7846ab654733f2aeb3a4316fe4b8f630d3ca0a1db0227c7d06918e7362d17970b
-  data.tar.gz: b3b267870e606d407931ac337c36865aaccf430b1b91ab0a9a3dfe49e1db65ae159ddaeaf2f22041715e6998a8d00db8d76b02dafc6ac0a11dcd91218129a62e
+  metadata.gz: cd396bf6b70d293ef00ac83bc4e3f3ac0efdfdbf56c835484abf5c503ec84d5690537c0f36c5d23cf9e18f27f64372b66157b45491954fa6dfd0c2779b8b7aac
+  data.tar.gz: 1af9c675e2641debc9e897b4a4ae1a13834550e234887bcdd8ef75cafd3aadde58b296fdd903c377bddf142b340f9ed32fd8e8d6305d673e7fde5a7acb4437a5

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: https://gist.githubusercontent.com/joeyates/4763b79425cf903fc70df3bc8fccda36/raw/356fa04037feedb212735d4e7002cbd8778a33e8/.rubocop.yaml
+
+AllCops:
+  Exclude:
+    - "bin/stubs/*"
+  DisplayCopNames:
+    Enabled: true

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

data/Rakefile

@@ -1,9 +1,9 @@
 #!/usr/bin/env rake
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-task :default => :spec
+task default: :spec
 
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = 'spec/**/*_spec.rb'
+  t.pattern = "spec/**/*_spec.rb"
 end

data/bin/imap-backup

@@ -1,32 +1,30 @@
 #!/usr/bin/env ruby
-# -*- encoding: utf-8 -*-
+require "optparse"
 
-require 'optparse'
-
-$:.unshift(File.expand_path('../../lib/', __FILE__))
-require 'imap/backup'
+$LOAD_PATH.unshift(File.expand_path("../../lib/", __FILE__))
+require "imap/backup"
 
 KNOWN_COMMANDS = [
-  {:name => 'setup',   :help => 'Create/edit the configuration file'},
-  {:name => 'backup',  :help => 'Do the backup (default)'},
-  {:name => 'folders', :help => 'List folders for all (or selected) accounts'},
-  {:name => 'status',  :help => 'List count of non backed-up emails per folder'},
-  {:name => 'help',    :help => 'Show usage'},
+  {name: "setup",   help: "Create/edit the configuration file"},
+  {name: "backup",  help: "Do the backup (default)"},
+  {name: "folders", help: "List folders for all (or selected) accounts"},
+  {name: "status",  help: "List count of non backed-up emails per folder"},
+  {name: "help",    help: "Show usage"}
 ]
 
-options = {:command => 'backup'}
+options = {command: "backup"}
 opts = OptionParser.new do |opts|
-  opts.banner = "Usage: #{$0} [options] COMMAND"
+  opts.banner = "Usage: #{$PROGRAM_NAME} [options] COMMAND"
 
-  opts.separator ''
-  opts.separator 'Commands:'
+  opts.separator ""
+  opts.separator "Commands:"
   KNOWN_COMMANDS.each do |command|
     opts.separator "\t%- 20s %s" % [command[:name], command[:help]]
   end
-  opts.separator ''
-  opts.separator 'Common options:'
+  opts.separator ""
+  opts.separator "Common options:"
 
-  opts.on('-a', '--accounts ACCOUNT1[,ACCOUNT2,...]', Array, 'only these accounts') do |account|
+  opts.on("-a", "--accounts ACCOUNT1[,ACCOUNT2,...]", Array, "only these accounts") do |account|
     options[:accounts] = account
   end
 
@@ -35,7 +33,7 @@ opts = OptionParser.new do |opts|
     exit
   end
 
-  opts.on_tail("--version", "Show version" ) do
+  opts.on_tail("--version", "Show version") do
     puts Imap::Backup::VERSION
     exit
   end
@@ -46,11 +44,11 @@ if ARGV.size > 0
   options[:command] = ARGV.shift
 end
 
-if KNOWN_COMMANDS.find{ |c| c[:name] == options[:command] }.nil?
+if KNOWN_COMMANDS.find { |c| c[:name] == options[:command] }.nil?
   raise "Unknown command '#{options[:command]}'"
 end
 
-if options[:command] == 'help'
+if options[:command] == "help"
   puts opts
   exit
 end
@@ -65,23 +63,23 @@ end
 configuration.setup_logging
 
 case options[:command]
-when 'setup'
+when "setup"
   Imap::Backup::Configuration::Setup.new.run
-when 'backup'
+when "backup"
   configuration.each_connection do |connection|
     connection.run_backup
   end
-when 'folders'
+when "folders"
   configuration.each_connection do |connection|
     puts connection.username
     folders = connection.folders
     if folders.nil?
-      warn 'Unable to list account folders'
+      warn "Unable to list account folders"
       exit 1
     end
     folders.each { |f| puts "\t" + f.name }
   end
-when 'status'
+when "status"
   configuration.each_connection do |connection|
     puts connection.username
     folders = connection.status

data/imap-backup.gemspec

@@ -1,26 +1,26 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
-require 'imap/backup/version'
+$LOAD_PATH.unshift(File.expand_path("../lib", __FILE__))
+require "imap/backup/version"
 
 Gem::Specification.new do |gem|
-  gem.name          = 'imap-backup'
+  gem.name          = "imap-backup"
   gem.description   = %q{Backup GMail, or any other IMAP email service, to disk.}
   gem.summary       = %q{Backup GMail (or other IMAP) accounts to disk}
-  gem.authors       = ['Joe Yates']
-  gem.email         = ['joe.g.yates@gmail.com']
-  gem.homepage      = 'https://github.com/joeyates/imap-backup'
+  gem.authors       = ["Joe Yates"]
+  gem.email         = ["joe.g.yates@gmail.com"]
+  gem.homepage      = "https://github.com/joeyates/imap-backup"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^spec/})
-  gem.require_paths = ['lib']
+  gem.require_paths = ["lib"]
   gem.version       = Imap::Backup::VERSION
 
-  gem.add_runtime_dependency 'rake'
-  gem.add_runtime_dependency 'highline'
-  gem.add_runtime_dependency 'mail'
+  gem.add_runtime_dependency "rake"
+  gem.add_runtime_dependency "highline"
+  gem.add_runtime_dependency "mail"
 
-  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.8'
-  gem.add_development_dependency 'rspec',  '>= 3.0.0'
-  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency "codeclimate-test-reporter", "~> 0.4.8"
+  gem.add_development_dependency "rspec", ">= 3.0.0"
+  gem.add_development_dependency "rubocop-rspec"
+  gem.add_development_dependency "simplecov"
 end

data/lib/email/mboxrd/message.rb

@@ -1,4 +1,4 @@
-require 'mail'
+require "mail"
 
 module Email; end
 
@@ -8,11 +8,11 @@ module Email::Mboxrd
 
     def initialize(supplied_body)
       @supplied_body = supplied_body.clone
-      @supplied_body.force_encoding('binary')
+      @supplied_body.force_encoding("binary")
     end
 
     def to_s
-      'From ' + from + "\n" + mboxrd_body + "\n"
+      "From " + from + "\n" + mboxrd_body + "\n"
     end
 
     private
@@ -21,8 +21,26 @@ module Email::Mboxrd
       @parsed ||= Mail.new(supplied_body)
     end
 
+    def best_from
+      if parsed.from.is_a? Enumerable
+        parsed.from.each do |addr|
+          if addr
+            return addr
+          end
+        end
+      end
+      if parsed.envelope_from
+        return parsed.envelope_from
+      end
+      if parsed.return_path
+        return parsed.return_path
+      end
+
+      return ''
+    end
+
     def from
-      parsed.from[0] + ' ' + asctime
+      best_from + " " + asctime
     end
 
     def mboxrd_body
@@ -33,7 +51,7 @@ module Email::Mboxrd
     end
 
     def asctime
-      date ? date.asctime : ''
+      date ? date.asctime : ""
     end
 
     def date

data/lib/email/provider.rb

@@ -3,9 +3,9 @@ module Email; end
 class Email::Provider
   def self.for_address(address)
     case 
-    when address.end_with?('@gmail.com')
+    when address.end_with?("@gmail.com")
       new(:gmail)
-    when address.end_with?('@fastmail.fm')
+    when address.end_with?("@fastmail.fm")
       new(:fastmail)
     else
       new(:default)
@@ -32,9 +32,9 @@ class Email::Provider
   def host
     case provider
     when :gmail
-      'imap.gmail.com'
+      "imap.gmail.com"
     when :fastmail
-      'mail.messagingengine.com'
+      "mail.messagingengine.com"
     end
   end
 end

data/lib/imap/backup.rb

@@ -1,23 +1,23 @@
 module Imap; end
 
-require 'imap/backup/utils'
-require 'imap/backup/account/connection'
-require 'imap/backup/account/folder'
-require 'imap/backup/configuration/account'
-require 'imap/backup/configuration/asker'
-require 'imap/backup/configuration/connection_tester'
-require 'imap/backup/configuration/folder_chooser'
-require 'imap/backup/configuration/list'
-require 'imap/backup/configuration/setup'
-require 'imap/backup/configuration/store'
-require 'imap/backup/downloader'
-require 'imap/backup/serializer/base'
-require 'imap/backup/serializer/directory'
-require 'imap/backup/serializer/mbox'
-require 'imap/backup/version'
-require 'email/provider'
-
-require 'logger'
+require "imap/backup/utils"
+require "imap/backup/account/connection"
+require "imap/backup/account/folder"
+require "imap/backup/configuration/account"
+require "imap/backup/configuration/asker"
+require "imap/backup/configuration/connection_tester"
+require "imap/backup/configuration/folder_chooser"
+require "imap/backup/configuration/list"
+require "imap/backup/configuration/setup"
+require "imap/backup/configuration/store"
+require "imap/backup/downloader"
+require "imap/backup/serializer/base"
+require "imap/backup/serializer/directory"
+require "imap/backup/serializer/mbox"
+require "imap/backup/version"
+require "email/provider"
+
+require "logger"
 
 module Imap::Backup
   class ConfigurationNotFound < StandardError; end

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

@@ -1,4 +1,4 @@
-require 'net/imap'
+require "net/imap"
 
 module Imap::Backup
   module Account; end
@@ -20,7 +20,7 @@ module Imap::Backup
 
     def folders
       return @folders if @folders
-      @folders = imap.list('', '*')
+      @folders = imap.list("", "*")
       if @folders.nil?
         Imap::Backup.logger.warn "Unable to get folder list for account #{username}"
       end
@@ -31,7 +31,7 @@ module Imap::Backup
       backup_folders.map do |folder|
         f = Account::Folder.new(self, folder[:name])
         s = Serializer::Directory.new(local_path, folder[:name])
-        {:name => folder[:name], :local => s.uids, :remote => f.uids}
+        {name: folder[:name], local: s.uids, remote: f.uids}
       end
     end
 
@@ -83,12 +83,12 @@ module Imap::Backup
     end
 
     def masked_password
-      password.gsub(/./, 'x')
+      password.gsub(/./, "x")
     end
     
     def backup_folders
-      return @backup_folders if @backup_folders and @backup_folders.size > 0
-      (folders || []).map { |f| {:name => f.name} }
+      return @backup_folders if @backup_folders && (@backup_folders.size > 0)
+      (folders || []).map { |f| {name: f.name} }
     end
 
     def provider

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

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require 'forwardable'
+require "forwardable"
 
 module Imap::Backup
   module Account; end
@@ -7,7 +6,7 @@ module Imap::Backup
   class Account::Folder
     extend Forwardable
 
-    REQUESTED_ATTRIBUTES = ['RFC822', 'FLAGS', 'INTERNALDATE']
+    REQUESTED_ATTRIBUTES = ["RFC822", "FLAGS", "INTERNALDATE"]
 
     attr_reader :connection
     attr_reader :name
@@ -25,7 +24,7 @@ module Imap::Backup
 
     def uids
       imap.examine(name)
-      imap.uid_search(['ALL']).sort
+      imap.uid_search(["ALL"]).sort
     rescue Net::IMAP::NoResponseError => e
       Imap::Backup.logger.warn "Folder '#{name}' does not exist"
       []
@@ -37,7 +36,7 @@ module Imap::Backup
       return nil if fetch_data_items.nil?
       fetch_data_item = fetch_data_items[0]
       attributes = fetch_data_item.attr
-      attributes['RFC822'].force_encoding('utf-8')
+      attributes["RFC822"].force_encoding("utf-8")
       attributes
     rescue Net::IMAP::NoResponseError => e
       Imap::Backup.logger.warn "Folder '#{name}' does not exist"

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Imap::Backup
   module Configuration; end
 
@@ -11,7 +9,7 @@ module Imap::Backup
     def run
       catch :done do
         loop do
-          system('clear')
+          system("clear")
           create_menu
         end
       end
@@ -29,8 +27,8 @@ module Imap::Backup
         choose_folders menu
         test_connection menu
         delete_account menu
-        menu.choice('return to main menu') { throw :done }
-        menu.hidden('quit') { throw :done }
+        menu.choice("return to main menu") { throw :done }
+        menu.hidden("quit") { throw :done }
       end
     end
 
@@ -46,16 +44,16 @@ Account:
     end
 
     def modify_email(menu)
-      menu.choice('modify email') do
+      menu.choice("modify email") do
         username = Configuration::Asker.email(username)
         puts "username: #{username}"
-        others   = store.accounts.select { |a| a != account}.map { |a| a[:username] }
+        others = store.accounts.select { |a| a != account }.map { |a| a[:username] }
         puts "others: #{others.inspect}"
         if others.include?(username)
-          puts 'There is already an account set up with that email address'
+          puts "There is already an account set up with that email address"
         else
           account[:username] = username
-          if account[:server].nil? or account[:server] == ''
+          if account[:server].nil? || (account[:server] == "")
             account[:server] = default_server(username)
           end
           account[:modified] = true
@@ -64,9 +62,9 @@ Account:
     end
 
     def modify_password(menu)
-      menu.choice('modify password') do
+      menu.choice("modify password") do
         password = Configuration::Asker.password
-        if ! password.nil?
+        if !password.nil?
           account[:password] = password
           account[:modified] = true
         end
@@ -74,9 +72,9 @@ Account:
     end
 
     def modify_server(menu)
-      menu.choice('modify server') do
-        server = highline.ask('server: ')
-        if ! server.nil?
+      menu.choice("modify server") do
+        server = highline.ask("server: ")
+        if !server.nil?
           account[:server] = server
           account[:modified] = true
         end
@@ -84,7 +82,7 @@ Account:
     end
 
     def modify_backup_path(menu)
-      menu.choice('modify backup path') do
+      menu.choice("modify backup path") do
         validator = lambda do |p|
           same = store.accounts.find do |a|
             a[:username] != account[:username] && a[:local_path] == p
@@ -103,21 +101,21 @@ Account:
     end
 
     def choose_folders(menu)
-      menu.choice('choose backup folders') do
+      menu.choice("choose backup folders") do
         Configuration::FolderChooser.new(account).run
       end
     end
 
     def test_connection(menu)
-      menu.choice('test connection') do
+      menu.choice("test connection") do
         result = Configuration::ConnectionTester.test(account)
         puts result
-        highline.ask 'Press a key '
+        highline.ask "Press a key "
       end
     end
 
     def delete_account(menu)
-      menu.choice('delete') do
+      menu.choice("delete") do
         if highline.agree("Are you sure? (y/n) ")
           account[:delete] = true
           throw :done
@@ -130,10 +128,10 @@ Account:
     end
 
     def masked_password
-      if account[:password] == '' or account[:password].nil?
-        '(unset)'
+      if (account[:password] == "") || account[:password].nil?
+        "(unset)"
       else
-        account[:password].gsub(/./, 'x')
+        account[:password].gsub(/./, "x")
       end
     end