imap-backup 1.3.0 → 1.4.0

data/spec/unit/serializer/mbox_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Imap::Backup::Serializer::Mbox do
-  let(:stat) { double("File::Stat", mode: 0700) }
+  let(:stat) { double("File::Stat", mode: 0o700) }
   let(:base_path) { "/base/path" }
   let(:mbox_pathname) { "/base/path/my/folder.mbox" }
   let(:mbox_exists) { true }
@@ -20,7 +20,8 @@ describe Imap::Backup::Serializer::Mbox do
     it "creates the containing directory" do
       described_class.new(base_path, "my/folder")
 
-      expect(Imap::Backup::Utils).to have_received(:make_folder).with(base_path, "my", 0700)
+      expect(Imap::Backup::Utils).
+        to have_received(:make_folder).with(base_path, "my", 0o700)
     end
 
     context "mbox and imap files" do
@@ -73,14 +74,16 @@ describe Imap::Backup::Serializer::Mbox do
     context "#save" do
       let(:mbox_formatted_message) { "message in mbox format" }
       let(:message_uid) { "999" }
-      let(:message) { double("Email::Mboxrd::Message", to_s: mbox_formatted_message) }
+      let(:message) do
+        double("Email::Mboxrd::Message", to_serialized: mbox_formatted_message)
+      end
       let(:mbox_file) { double("File - mbox", write: nil, close: nil) }
       let(:imap_file) { double("File - imap", write: nil, close: nil) }
 
       before do
         allow(Email::Mboxrd::Message).to receive(:new).and_return(message)
-        allow(File).to receive(:open).with(mbox_pathname, "ab").and_return(mbox_file)
-        allow(File).to receive(:open).with(imap_pathname, "ab").and_return(imap_file)
+        allow(File).to receive(:open).with(mbox_pathname, "ab") { mbox_file }
+        allow(File).to receive(:open).with(imap_pathname, "ab") { imap_file }
       end
 
       it "saves the message to the mbox" do
@@ -97,7 +100,7 @@ describe Imap::Backup::Serializer::Mbox do
 
       context "when the message causes parsing errors" do
         before do
-          allow(message).to receive(:to_s).and_raise(ArgumentError)
+          allow(message).to receive(:to_serialized).and_raise(ArgumentError)
         end
 
         it "skips the message" do

data/spec/unit/utils_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Imap::Backup::Utils do
   let(:filename) { "foobar" }
   let(:stat) { double("File::Stat", mode: mode) }
-  let(:mode) { 0777 }
+  let(:mode) { 0o777 }
   let(:exists) { true }
 
   before do
@@ -12,13 +12,13 @@ describe Imap::Backup::Utils do
   end
 
   context ".check_permissions" do
-    let(:requested) { 0345 }
+    let(:requested) { 0o345 }
 
     context "with existing files" do
       [
-        [0100, "less than the limit", true],
-        [0345, "equal to the limit", true],
-        [0777, "over the limit", false]
+        [0o100, "less than the limit", true],
+        [0o345, "equal to the limit", true],
+        [0o777, "over the limit", false]
       ].each do |mode, description, success|
         context "when permissions are #{description}" do
           let(:mode) { mode }
@@ -29,9 +29,10 @@ describe Imap::Backup::Utils do
             end
           else
             it "fails" do
+              message = /Permissions on '.*?' should be .*?, not .*?/
               expect do
                 described_class.check_permissions(filename, requested)
-              end.to raise_error(RuntimeError, format("Permissions on '%s' should be 0%o, not 0%o", filename, requested, mode))
+              end.to raise_error(RuntimeError, message)
             end
           end
         end
@@ -40,7 +41,7 @@ describe Imap::Backup::Utils do
 
     context "with non-existent files" do
       let(:exists) { false }
-      let(:mode) { 0111 }
+      let(:mode) { 0o111 }
 
       it "succeeds" do
         described_class.check_permissions(filename, requested)
@@ -50,10 +51,10 @@ describe Imap::Backup::Utils do
 
   context ".stat" do
     context "with existing files" do
-      let(:mode) { 02345 }
+      let(:mode) { 0o2345 }
 
       it "is the last 9 bits of the file mode" do
-        expect(described_class.stat(filename)).to eq(0345)
+        expect(described_class.stat(filename)).to eq(0o345)
       end
     end
 
@@ -73,21 +74,22 @@ describe Imap::Backup::Utils do
     end
 
     it "does nothing if an empty path is supplied" do
-      described_class.make_folder("aaa", "", 0222)
+      described_class.make_folder("aaa", "", 0o222)
 
       expect(FileUtils).to_not have_received(:mkdir_p)
     end
 
     it "creates the path" do
-      described_class.make_folder("/base/path", "new/folder", 0222)
+      described_class.make_folder("/base/path", "new/folder", 0o222)
 
       expect(FileUtils).to have_received(:mkdir_p).with("/base/path/new/folder")
     end
 
     it "sets permissions on the path" do
-      described_class.make_folder("/base/path/new", "folder", 0222)
+      described_class.make_folder("/base/path/new", "folder", 0o222)
 
-      expect(FileUtils).to have_received(:chmod).with(0222, "/base/path/new/folder")
+      expect(FileUtils).
+        to have_received(:chmod).with(0o222, "/base/path/new/folder")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap-backup
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.8
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
@@ -124,6 +139,7 @@ files:
 - README.md
 - Rakefile
 - bin/imap-backup
+- docker-compose.yml
 - imap-backup.gemspec
 - lib/email/mboxrd/message.rb
 - lib/email/provider.rb
@@ -139,12 +155,19 @@ files:
 - lib/imap/backup/configuration/store.rb
 - lib/imap/backup/downloader.rb
 - lib/imap/backup/serializer/base.rb
-- lib/imap/backup/serializer/directory.rb
 - lib/imap/backup/serializer/mbox.rb
 - lib/imap/backup/utils.rb
 - lib/imap/backup/version.rb
+- spec/features/backup_spec.rb
+- spec/features/helper.rb
+- spec/features/support/backup_directory.rb
+- spec/features/support/email_server.rb
+- spec/features/support/shared/connection_context.rb
+- spec/features/support/shared/message_fixtures.rb
+- spec/fixtures/connection.yml
 - spec/gather_rspec_coverage.rb
 - spec/spec_helper.rb
+- spec/support/fixtures.rb
 - spec/support/higline_test_helpers.rb
 - spec/support/shared_examples/account_flagging.rb
 - spec/support/silence_logging.rb
@@ -161,9 +184,9 @@ files:
 - 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
 - spec/unit/utils_spec.rb
+- tmp/.gitkeep
 homepage: https://github.com/joeyates/imap-backup
 licenses: []
 metadata: {}
@@ -188,8 +211,16 @@ signing_key:
 specification_version: 4
 summary: Backup GMail (or other IMAP) accounts to disk
 test_files:
+- spec/features/backup_spec.rb
+- spec/features/helper.rb
+- spec/features/support/backup_directory.rb
+- spec/features/support/email_server.rb
+- spec/features/support/shared/connection_context.rb
+- spec/features/support/shared/message_fixtures.rb
+- spec/fixtures/connection.yml
 - spec/gather_rspec_coverage.rb
 - spec/spec_helper.rb
+- spec/support/fixtures.rb
 - spec/support/higline_test_helpers.rb
 - spec/support/shared_examples/account_flagging.rb
 - spec/support/silence_logging.rb
@@ -206,6 +237,5 @@ test_files:
 - 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
 - spec/unit/utils_spec.rb

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

@@ -1,43 +0,0 @@
-require "fileutils"
-
-module Imap::Backup
-  module Serializer; end
-
-  class Serializer::Directory < Serializer::Base
-    def initialize(path, folder)
-      super
-      Utils.make_folder(@path, @folder, Serializer::DIRECTORY_PERMISSIONS)
-    end
-
-    def uids
-      return [] if !File.exist?(directory)
-
-      d = Dir.open(directory)
-      as_strings = d.map do |file|
-        file[/^0*(\d+).json$/, 1]
-      end.compact
-      as_strings.map(&:to_i).sort
-    end
-
-    def exist?(uid)
-      message_filename = filename(uid)
-      File.exist?(message_filename)
-    end
-
-    def save(uid, message)
-      message_filename = filename(uid)
-      File.open(message_filename, "w") { |f| f.write message.to_json }
-      FileUtils.chmod 0600, message_filename
-    end
-
-    private
-
-    def directory
-      File.join(@path, @folder)
-    end
-
-    def filename(uid)
-      "#{directory}/%012u.json" % uid.to_i
-    end
-  end
-end

data/spec/unit/serializer/directory_spec.rb

@@ -1,69 +0,0 @@
-require "spec_helper"
-
-describe Imap::Backup::Serializer::Directory do
-  let(:stat) { double("File::Stat", mode: 0700) }
-  let(:files) { ["00000123.json", "000001.json"] }
-  let(:base) { "/base/path" }
-  let(:folder) { "/base/path/my_folder" }
-  let(:folder_exists) { true }
-
-  before do
-    allow(FileUtils).to receive(:mkdir_p)
-    allow(FileUtils).to receive(:chmod)
-    allow(File).to receive(:stat).with(base).and_return(stat)
-    allow(File).to receive(:exist?).with(base).and_return(true)
-    allow(File).to receive(:exist?).with(folder).and_return(folder_exists)
-  end
-
-  subject { described_class.new(base, "my_folder") }
-
-  context "#uids" do
-    before do
-      allow(Dir).to receive(:open).with(folder).and_return(files)
-    end
-
-    it "returns the backed-up uids" do
-      expect(subject.uids).to eq([1, 123])
-    end
-
-    context "if the directory does not exist" do
-      let(:folder_exists) { false }
-
-      it "returns an empty array" do
-        expect(subject.uids).to eq([])
-      end
-    end
-  end
-
-  context "#exist?" do
-    it "checks if the file exists" do
-      allow(File).to receive(:exist?).with(%r{/base/path/my_folder/0+123.json}).and_return(true)
-
-      expect(subject.exist?(123)).to be_truthy
-    end
-  end
-
-  context "#save" do
-    let(:message) { {"RFC822" => "the body", "other" => "xxx"} }
-    let(:file) { double("File", write: nil) }
-
-    before do
-      allow(File).to receive(:exist?).with(%r{/base/path/my_folder/0+1234.json}).and_return(true)
-      allow(File).to receive(:open) do |&block|
-        block.call file
-      end
-    end
-
-    it "saves messages" do
-      subject.save("1234", message)
-
-      expect(file).to have_received(:write).with(message.to_json)
-    end
-
-    it "sets file permissions" do
-      subject.save(1234, message)
-
-      expect(FileUtils).to have_received(:chmod).with(0600, /0+1234.json$/)
-    end
-  end
-end