martilla 0.3.1 → 0.4.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ddec52e6ea8e2f0ae5251811b050dfbb5c514cc2d3c359cb1a744e0f24e058b
-  data.tar.gz: e34e08990fd2055561471c3f9ee9b97ba19e15e79aa4d0ffa69211f23979a61b
+  metadata.gz: 52022187479500d2fe42d9bbf8153a7383811b06904be9e334a12b6379789ab5
+  data.tar.gz: b19c9c14f59b5bee0db4fc62ef5f1dfc9cbcc01d6ae3bd717e2c59616f6d5292
 SHA512:
-  metadata.gz: b60213c9e11b06571ef8d081d1219073622b3f8efdc447a26b8ffc814f0ce626ed740ad41478c6d68143fb52ab4b38492ce90f30b026cb0640b361cac8dbf911
-  data.tar.gz: 121370b1a2fd0634cdf3b5e507deac53574e1c1cd20948adb96f8569efa0f2cfcbdcfcc75a27498928004fcee6dbf72f34f177f3a4c8c25a34a0d7ec6f82a217
+  metadata.gz: a34c2e035a36c9069d40333b4fd98c377f27d4b0ef6ee467def1983d33a3d0214b8ee659217fd308a5e24b486ba6a7a9377b33138b386d83ff06395727048054
+  data.tar.gz: 38a6e9f03a5b691067d34b8048c1399e627caa469fe3c43c4106abc8f2bbf1b3ed60199afb1483162b76c72d921afd6877b3f05aeb4258d4d87b4d25653dd9ad

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.3.1
+2019-11-14
+
+- Fixes a bug that caused absolute paths sent to the CLI for the `backup` command to fail
+
 ## 0.3.0
 2019-11-10
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    martilla (0.3.1)
+    martilla (0.4.0.rc1)
       aws-sdk-s3 (~> 1.49)
       aws-sdk-ses (~> 1.26)
       memoist (~> 0.16.0)

data/README.md

@@ -102,6 +102,9 @@ The available Storages types are **local**, **S3** & **SCP**. They each have dif
      - can be specified with the usual ENV variables or IAM roles
    - `retention`
      - An integer that defines the max number of backups stored at the defined location
+     - **IMPORTANT NOTE:** Releases `v0.3.0` & `v0.3.1` added a bug where the s3 storage option **will possibly delete other files when enforcing retention**. Ways to avoid this problem:
+       - Don't use retention configuration for **s3** storage and wait until a fix is released soon. More details and the status of the issue [here](https://github.com/fdoxyz/martilla/issues/18)
+       - Use a subdirectory within your bucket exclusively for the backups by using the `filename` option to something like `/path/to/backups/backup_name.sql`
  - options for type: **scp**
    - `filename`
      - The location to where the backup will be stored within remote server

data/lib/martilla/storage.rb

@@ -26,8 +26,12 @@ module Martilla
       @options['suffix']
     end
 
+    def options_filename
+      @options['filename'] || 'backup.sql'
+    end
+
     def output_filename(gzip)
-      filename = @options['filename'] || 'backup.sql'
+      filename = options_filename
       filename = append_datetime_suffix(filename) if suffix?
       filename = "#{filename}.gz" if gzip
       filename

data/lib/martilla/storages/s3.rb

@@ -4,9 +4,11 @@ module Martilla
   class S3 < Storage
     def persist(tmp_file:, gzip:)
       path = output_filename(gzip)
-      obj = s3_resource.bucket(bucket_name).object(path)
+      # Files in the root path of a bucket need to be stripped of './'
+      # See https://github.com/fdoxyz/martilla/issues/17
+      path.slice!(0, 2) if path[0...2] == './'
 
-      # Upload it
+      obj = s3_resource.bucket(bucket_name).object(path)
       return nil if obj.upload_file(tmp_file)
       raise Error.new('Error uploading backup to bucket')
     end
@@ -14,15 +16,44 @@ module Martilla
     def enfore_retention!(gzip:)
       return if retention_limit < 1
 
-      objs = s3_resource.bucket(bucket_name).objects.sort_by(&:last_modified)
+      objs = bucket_objs_for_retention(output_file: output_filename(gzip))
       while objs.count > retention_limit do
-        objs.first.delete
+        delete_params = { bucket: bucket_name, key: objs.first.key }
+        s3_resource.client.delete_object(delete_params)
         puts "Retention limit met. Removed the backup file: #{objs.shift.key}"
       end
     end
 
     private
 
+    # Returns array of objs in the bucket that match the backup output file
+    # format, ordered by `last_modified` where oldest is first and newest last
+    def bucket_objs_for_retention(output_file:)
+      res = s3_resource.client.list_objects({ bucket: bucket_name })
+      objs = res.contents.sort_by(&:last_modified)
+
+      # Path & File basename to check against to enforce retention restriction
+      path = File.dirname(output_file)
+      base_name = File.basename(output_file)
+
+      if suffix?
+        # When using a suffix make sure we replace the actual timestamp for a
+        # regexp, otherwise because of different timestamps they'll never match
+        index = base_name =~ timestamp_regex
+        base_name.slice!(timestamp_regex)
+        base_name.insert(index, "\\d{4}-\\d{2}-\\d{2}T\\d{6}")
+      end
+
+      # Rejects objects that don't match the directory location or if they don't
+      # match with the same file basename structure
+      objs.reject do |obj|
+        directory_mismatch = File.dirname(obj.key) != path
+        filename_mismatch = !(File.basename(obj.key) =~ /#{base_name}/)
+
+        directory_mismatch || filename_mismatch
+      end
+    end
+
     def s3_resource
       options = {}
       options[:region] = aws_region unless aws_region.nil?

data/lib/martilla/version.rb

@@ -1,3 +1,3 @@
 module Martilla
-  VERSION = '0.3.1'
+  VERSION = '0.4.0.rc1'
 end

data/martilla.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |spec|
   spec.name          = 'martilla'
   spec.version       = Martilla::VERSION
   spec.authors       = ['Fernando Valverde']
-  spec.email         = ['fdov88@gmail.com']
+  spec.email         = ['fernando@visualcosita.com']
 
-  spec.summary       = 'Modern backup tool'
+  spec.summary       = 'Easy to configure backup tool for simple everyday use'
   spec.description   = ''
   spec.homepage      = 'https://github.com/fdoxyz/martilla'
   spec.license       = 'MIT'
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/fdoxyz/martilla'
-  spec.metadata['changelog_uri'] = 'https://github.com/fdoxyz/martilla/changelog'
+  spec.metadata['changelog_uri'] = 'https://github.com/fdoxyz/martilla/blob/master/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: martilla
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0.rc1
 platform: ruby
 authors:
 - Fernando Valverde
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2019-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -180,7 +180,7 @@ dependencies:
         version: 0.17.1
 description: ''
 email:
-- fdov88@gmail.com
+- fernando@visualcosita.com
 executables:
 - martilla
 extensions: []
@@ -226,7 +226,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/fdoxyz/martilla
   source_code_uri: https://github.com/fdoxyz/martilla
-  changelog_uri: https://github.com/fdoxyz/martilla/changelog
+  changelog_uri: https://github.com/fdoxyz/martilla/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -238,12 +238,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Modern backup tool
+summary: Easy to configure backup tool for simple everyday use
 test_files: []