imap-backup 1.0.17 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1abac89e145c96edf61e40e5d5efc035c26e71fd
-  data.tar.gz: 793eb63a28cbf0e3fd3921c7ce72eeee4663ff2d
+  metadata.gz: b55658c2e579a76e29322a69048814b31069926e
+  data.tar.gz: 43aa7303ba81aaa1318bcb208be7a8ada52437a9
 SHA512:
-  metadata.gz: a469154e6ea6767d045dafa2c52ca04abd649e682fcffb992f4ec9c2ce399a569589d0dd2dfd75957d0757ac165f8e1439915f2e2ed0e0df6b93739e1e2ffe4a
-  data.tar.gz: 0372d03f497dcc3f2cfe1806bc27f530141ccb73618a99e1f4ec37e05d518b7bf6b067cfac466a94967a4753afb37ff52193612fef2446b9c9c44a068e96caa6
+  metadata.gz: 19480ec2c72149a8fefc0eeb6930b673072940b92fa6deae405b2318ab3491894dd1b1e29118ac59640561b8b2396d3a21fb4ff82cc8f40ad0830a375a5bed52
+  data.tar.gz: 1e9d3f8d900c3eae69e64484d88e506816a4a791b3f260caab01642ffe53f79ce171f3246cf762e05e81f4390108c663e9b4f4f2a5b0e44169325aeae0dc512f

data/.travis.yml

@@ -2,8 +2,13 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.1
+  - 2.1.5
+  - 2.2.4
+  - 2.3.0
 branches:
   only:
     - master
+before_install:
+  - gem update --system
+  - gem update bundler
 script: "bundle exec rake spec"

data/README.md

@@ -1,4 +1,8 @@
-# imap-backup [![Build Status](https://secure.travis-ci.org/joeyates/imap-backup.png)][Continuous Integration]
+[![Build Status](https://secure.travis-ci.org/joeyates/imap-backup.png)][Continuous Integration]
+[![Source Analysis](https://codeclimate.com/github/joeyates/imap-backup/badges/gpa.svg)](https://codeclimate.com/github/joeyates/imap-backup)
+[![Test Coverage](https://codeclimate.com/github/joeyates/imap-backup/badges/coverage.svg)](https://codeclimate.com/github/joeyates/imap-backup/coverage)
+
+# imap-backup
 
 *Backup GMail (or other IMAP) accounts to disk*
 
@@ -71,6 +75,35 @@ It connects to GMail by default, but you can also specify a server:
 }
 ```
 
+## Connection options
+
+You can override the parameters passed to `Net::IMAP` with `connection_options`.
+
+Specifically, if you are using a self-signed certificate and get SSL errors, e.g.
+`certificate verify failed`, you can choose to not verify the TLS connection:
+
+```json
+{
+  "accounts":
+  [
+    {
+      "username": "my.user@gmail.com",
+      "password": "secret",
+      "server": "my.imap.example.com",
+      "local_path": "/path/to/backup/root",
+      "folders": [
+        {"name": "[Gmail]/All Mail"},
+        {"name": "my_folder"}
+      ],
+      "connection_options": {
+        "ssl": {"verify_mode": 0},
+        "port": 993
+      }
+    }
+  ]
+}
+```
+
 ## Google Apps
 
 * Enable IMAP access to your account via the GMail interface (Settings/Forwarding and POP/IMAP),

data/bin/imap-backup

@@ -7,11 +7,11 @@ $:.unshift(File.expand_path('../../lib/', __FILE__))
 require 'imap/backup'
 
 KNOWN_COMMANDS = [
-  {: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'}
@@ -27,7 +27,7 @@ opts = OptionParser.new do |opts|
   opts.separator 'Common options:'
 
   opts.on('-a', '--accounts ACCOUNT1[,ACCOUNT2,...]', Array, 'only these accounts') do |account|
-    options[:account] = account
+    options[:accounts] = account
   end
 
   opts.on_tail("-h", "--help", "Show usage") do
@@ -60,6 +60,8 @@ end
 configuration.setup_logging
 
 case options[:command]
+when 'setup'
+  Imap::Backup::Configuration::Setup.new.run
 when 'backup'
   configuration.each_connection do |connection|
     connection.run_backup
@@ -74,8 +76,6 @@ when 'folders'
     end
     folders.each { |f| puts "\t" + f.name }
   end
-when 'setup'
-  Imap::Backup::Configuration::Setup.new.run
 when 'status'
   configuration.each_connection do |connection|
     puts connection.username

data/imap-backup.gemspec

@@ -18,8 +18,14 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'rake'
   gem.add_runtime_dependency 'highline'
-  gem.add_runtime_dependency 'mail'
+  if RUBY_VERSION > '2'
+    gem.add_runtime_dependency 'mail'
+  else
+    gem.add_runtime_dependency 'mime-types', '~> 2.6'
+    gem.add_runtime_dependency 'mail', '~> 2.6.3'
+  end
 
+  gem.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.8'
   gem.add_development_dependency 'rspec',  '>= 3.0.0'
   gem.add_development_dependency 'simplecov'
 end

data/lib/email/provider.rb

@@ -0,0 +1,40 @@
+module Email; end
+
+class Email::Provider
+  def self.for_address(address)
+    case 
+    when address.end_with?('@gmail.com')
+      new(:gmail)
+    when address.end_with?('@fastmail.fm')
+      new(:fastmail)
+    else
+      new(:default)
+    end
+  end
+
+  attr_reader :provider
+
+  def initialize(provider)
+    @provider = provider
+  end
+
+  def options
+    case provider
+    when :gmail
+      {port: 993, ssl: true}
+    when :fastmail
+      {port: 993, ssl: true}
+    else
+      {port: 993, ssl: true}
+    end
+  end
+
+  def host
+    case provider
+    when :gmail
+      'imap.gmail.com'
+    when :fastmail
+      'mail.messagingengine.com'
+    end
+  end
+end

data/lib/imap/backup.rb

@@ -15,6 +15,7 @@ require 'imap/backup/serializer/base'
 require 'imap/backup/serializer/directory'
 require 'imap/backup/serializer/mbox'
 require 'imap/backup/version'
+require 'email/provider'
 
 require 'logger'
 

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

@@ -6,21 +6,23 @@ module Imap::Backup
   class Account::Connection
     attr_reader :username
     attr_reader :local_path
+    attr_reader :connection_options
 
     def initialize(options)
       @username, @password = options[:username], options[:password]
       @local_path = options[:local_path]
       @backup_folders = options[:folders]
       @server = options[:server]
+      @connection_options = options[:connection_options] || {}
       @folders = nil
+      create_account_folder
     end
 
     def folders
       return @folders if @folders
-      root = root_for(username)
-      @folders = imap.list(root, '*')
+      @folders = imap.list('', '*')
       if @folders.nil?
-        Imap::Backup.logger.warn "Unable to get folder list for account #{username}, (root '#{root}'"
+        Imap::Backup.logger.warn "Unable to get folder list for account #{username}"
       end
       @folders
     end
@@ -37,12 +39,9 @@ module Imap::Backup
       Imap::Backup.logger.debug "Running backup of account: #{username}"
       # start the connection so we get logging messages in the right order
       imap
-      backup_folders.each do |folder|
-        Imap::Backup.logger.debug "[#{folder[:name]}] running backup"
-        f = Account::Folder.new(self, folder[:name])
-        s = Serializer::Mbox.new(local_path, folder[:name])
-        d = Downloader.new(f, s)
-        d.run
+      each_folder do |folder, serializer|
+        Imap::Backup.logger.debug "[#{folder.name}] running backup"
+        Downloader.new(folder, serializer).run
       end
     end
 
@@ -50,13 +49,9 @@ module Imap::Backup
       imap.disconnect
     end
 
-    def server
-      @server ||= host_for(username)
-    end
-
     def imap
       return @imap unless @imap.nil?
-      options = options_for(server)
+      options = provider_options
       Imap::Backup.logger.debug "Creating IMAP instance: #{server}, options: #{options.inspect}"
       @imap = Net::IMAP.new(server, options)
       Imap::Backup.logger.debug "Logging in: #{username}/#{masked_password}"
@@ -67,6 +62,22 @@ module Imap::Backup
 
     private
 
+    def each_folder
+      backup_folders.each do |folder_info|
+        folder = Account::Folder.new(self, folder_info[:name])
+        serializer = Serializer::Mbox.new(local_path, folder_info[:name])
+        yield folder, serializer
+      end
+    end
+
+    def create_account_folder
+      Utils.make_folder(
+        Configuration::Store::CONFIGURATION_DIRECTORY,
+        File.basename(local_path),
+        Serializer::DIRECTORY_PERMISSIONS
+      )
+    end
+
     def password
       @password
     end
@@ -80,35 +91,18 @@ module Imap::Backup
       (folders || []).map { |f| {:name => f.name} }
     end
 
-    def host_for(username)
-      case username
-      when /@gmail\.com/
-        'imap.gmail.com'
-      when /@fastmail\.fm/
-        'mail.messagingengine.com'
-      end
+    def provider
+      @provider ||= Email::Provider.for_address(username)
     end
 
-    def root_for(username)
-      case username
-      when /@gmail\.com/
-        '/'
-      when /@fastmail\.fm/
-        'INBOX'
-      else
-        '/'
-      end
+    def server
+      return @server if @server
+      return nil if provider.nil?
+      @server = provider.host
     end
 
-    def options_for(server)
-      case server
-      when 'imap.gmail.com'
-        {:port => 993, :ssl => true}
-      when 'mail.messagingengine.com'
-        {:port => 993, :ssl => true}
-      else
-        {:port => 993, :ssl => true}
-      end
+    def provider_options
+      provider.options.merge(connection_options)
     end
   end
 end

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

@@ -138,12 +138,12 @@ Account:
     end
 
     def default_server(username)
-      case username
-      when /@gmail\.com/
-        'imap.gmail.com'
-      when /@fastmail\.fm/
-        'mail.messagingengine.com'
+      provider = Email::Provider.for_address(username)
+      if provider.provider == :default
+        puts "Can't decide provider for email address '#{username}'"
+        return nil
       end
+      provider.host
     end
   end
 end

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

@@ -27,9 +27,6 @@ module Imap::Backup
     end
 
     def save
-      if File.directory?(path)
-        Utils.check_permissions path, 0700
-      end
       mkdir_private path
       remove_modified_flags
       remove_deleted_accounts

data/lib/imap/backup/downloader.rb

@@ -1,6 +1,4 @@
 # encoding: utf-8
-require 'rubygems' if RUBY_VERSION < '1.9'
-require 'json'
 
 module Imap::Backup
   class Downloader

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

@@ -33,6 +33,10 @@ module Imap::Backup
         Imap::Backup.logger.debug "[#{folder}] message #{uid} already downloaded - skipping"
         return
       end
+
+      # invalidate cache
+      @uids = nil
+
       body = message['RFC822']
       mboxrd_message = Email::Mboxrd::Message.new(body)
       mbox = imap = nil

data/lib/imap/backup/version.rb

@@ -2,7 +2,7 @@ module Imap; end
 
 module Imap::Backup
   MAJOR    = 1
-  MINOR    = 0
-  REVISION = 17
+  MINOR    = 1
+  REVISION = 0
   VERSION  = [MAJOR, MINOR, REVISION].map(&:to_s).join('.')
 end

data/spec/spec_helper.rb

@@ -1,18 +1,17 @@
+require "codeclimate-test-reporter"
 require 'rspec'
+
+CodeClimate::TestReporter.start
+
 spec_path = File.dirname(__FILE__)
 $LOAD_PATH << File.expand_path('../lib', spec_path)
 
 support_glob = File.join(spec_path, 'support', '**', '*.rb')
 Dir[support_glob].each { |f| require f }
 
-if RUBY_VERSION < '1.9'
-  require 'rspec/autorun'
-else
-  require 'simplecov'
-  SimpleCov.start do
-    add_filter '/spec/'
-    add_filter '/vendor/'
-  end
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
 end
 
 require 'imap/backup'

data/spec/unit/account/connection_spec.rb

@@ -10,7 +10,7 @@ describe Imap::Backup::Account::Connection do
     {:name => backup_folder}
   end
 
-  let(:imap) { double('Net::IMAP', :login => nil, :list => imap_folders) }
+  let(:imap) { double('Net::IMAP', :login => nil, :list => imap_folders, :disconnect => nil) }
   let(:imap_folders) { [] }
   let(:options) do
     {
@@ -26,21 +26,18 @@ describe Imap::Backup::Account::Connection do
 
   before do
     allow(Net::IMAP).to receive(:new).and_return(imap)
+    allow(Imap::Backup::Utils).to receive(:make_folder)
   end
 
   subject { described_class.new(options) }
 
-  shared_examples 'connects to IMAP' do |options|
-    options ||= {}
-    username = options[:username] || 'username@gmail.com'
-    server = options[:server] || 'imap.gmail.com'
-
+  shared_examples 'connects to IMAP' do
     it 'sets up the IMAP connection' do
-      expect(Net::IMAP).to have_received(:new).with(server, {:port => 993, :ssl => true})
+      expect(Net::IMAP).to have_received(:new)
     end
 
     it 'logs in to the imap server' do
-      expect(imap).to have_received(:login).with(username, 'password')
+      expect(imap).to have_received(:login)
     end
   end
 
@@ -55,37 +52,20 @@ describe Imap::Backup::Account::Connection do
       end
     end
 
-    context 'server' do
-      context 'with a supplied value' do
-        before do
-          options.merge!(:server => 'imap.example.com')
-        end
-
-        it 'uses the supplied value' do
-          expect(subject.server).to eq('imap.example.com')
-        end
-      end
-
-      context 'without a supplied value' do
-        it 'uses the guesses the value' do
-          expect(subject.server).to eq('imap.gmail.com')
-        end
-      end
+    it 'creates the path' do
+      subject.username
+      expect(Imap::Backup::Utils).to have_received(:make_folder)
     end
   end
 
-  [
-    ['GMail', 'user@gmail.com', 'imap.gmail.com'],
-    ['Fastmail', 'user@fastmail.fm', 'mail.messagingengine.com'],
-  ].each do |service, email_username, server|
-    context service do
-      let(:username) { email_username }
+  describe '#imap' do
+    before { @result = subject.imap }
 
-      before { allow(imap).to receive(:disconnect) }
-      before { subject.disconnect }
-
-      include_examples 'connects to IMAP', {:username => email_username, :server => server}
+    it 'returns the IMAP connection' do
+      expect(@result).to eq(imap)
     end
+
+    include_examples 'connects to IMAP'
   end
 
   context '#folders' do
@@ -122,19 +102,8 @@ describe Imap::Backup::Account::Connection do
     end
   end
 
-  context '#disconnect' do
-    before { allow(imap).to receive(:disconnect) }
-    before { subject.disconnect }
-
-    it 'disconnects from the server' do
-      expect(imap).to have_received(:disconnect)
-    end
-
-    include_examples 'connects to IMAP'
-  end
-
   context '#run_backup' do
-    let(:folder) { double('folder') }
+    let(:folder) { double('folder', name: 'folder') }
     let(:serializer) { double('serializer') }
     let(:downloader) { double('downloader', :run => nil) }
 
@@ -197,4 +166,14 @@ describe Imap::Backup::Account::Connection do
       end
     end
   end
+
+  context '#disconnect' do
+    before { subject.disconnect }
+
+    it 'disconnects from the server' do
+      expect(imap).to have_received(:disconnect)
+    end
+
+    include_examples 'connects to IMAP'
+  end
 end

data/spec/unit/configuration/asker_spec.rb

@@ -48,7 +48,7 @@ module Imap::Backup
       it 'requires 1 parameter' do
         expect do
           described_class.new
-        end.to raise_error(ArgumentError, /0 for 1/)
+        end.to raise_error(ArgumentError, /wrong number/)
       end
 
       it 'expects a higline' do

data/spec/unit/email/provider_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Email::Provider do
+  describe '.for_address' do
+    context 'known providers' do
+      [['gmail.com', :gmail], ['fastmail.fm', :fastmail]].each do |domain, provider|
+        it "recognizes #{provider}" do
+          address = "foo@#{domain}"
+          expect(described_class.for_address(address).provider).to eq(provider)
+        end
+      end
+    end
+
+    context 'with unknown providers' do
+      it 'returns a default provider' do
+        expect(described_class.for_address('foo@unknown.com').provider).to eq(:default)
+      end
+    end
+  end
+
+  subject { described_class.new(:gmail) }
+
+  describe '#options' do
+    it 'returns options' do
+      expect(subject.options).to eq(port: 993, ssl: true)
+    end
+  end
+
+  describe '#host' do
+    it 'returns host' do
+      expect(subject.host).to eq('imap.gmail.com')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 1.0.17
+  version: 1.1.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-14 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.8
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +111,7 @@ files:
 - bin/imap-backup
 - imap-backup.gemspec
 - lib/email/mboxrd/message.rb
+- lib/email/provider.rb
 - lib/imap/backup.rb
 - lib/imap/backup/account/connection.rb
 - lib/imap/backup/account/folder.rb
@@ -129,6 +144,7 @@ files:
 - spec/unit/configuration/store_spec.rb
 - spec/unit/downloader_spec.rb
 - spec/unit/email/mboxrd/message_spec.rb
+- spec/unit/email/provider_spec.rb
 - spec/unit/serializer/base_spec.rb
 - spec/unit/serializer/directory_spec.rb
 - spec/unit/serializer/mbox_spec.rb
@@ -152,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Backup GMail (or other IMAP) accounts to disk
@@ -173,6 +189,7 @@ test_files:
 - spec/unit/configuration/store_spec.rb
 - spec/unit/downloader_spec.rb
 - spec/unit/email/mboxrd/message_spec.rb
+- spec/unit/email/provider_spec.rb
 - spec/unit/serializer/base_spec.rb
 - spec/unit/serializer/directory_spec.rb
 - spec/unit/serializer/mbox_spec.rb