daily_weekly_monthly 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13f9aa478c619dd93fce91053cf47c992ebadf08
-  data.tar.gz: abf25ce04f627f2f46db301c95105f0da4c0efc1
+  metadata.gz: 8b16518761e83780613149ff2f50e838e2178565
+  data.tar.gz: ee7a046fb559a0727e723400e8d6a8a5c3cc4224
 SHA512:
-  metadata.gz: 3d617e0f31b33e196e1ad416319634e524b4d56299beb878b3344a49b9eb6d7de7054918d6f9b45e0e9f2a999cc3be72940f6869b2e1a739b509792ccb99a400
-  data.tar.gz: 001f24d43f022ec1a780e972165036e1121766a93ad37520d8fe8034aff2eb26a6d5c81157a124205a823088d535f88cb355ba8f9164b6aaff67452c0b20e04c
+  metadata.gz: 41ca3df810e29e6ed57683a89a07db7f4b07b685776deaca30971c75c54822df496e28d741e8179e5f413491903c01ff3ff695d974f58c4a240e447cad389925
+  data.tar.gz: 787660aba84ac6f557c0d929123bbb34f545b9f6e79ee3644ba0ab119ee7fe3fa44e18b4a270fcee024b41b630c08fd8c31fa4242a92e1fda26d643d701f21ac

data/.codeclimate.yml

@@ -12,8 +12,6 @@ engines:
     enabled: true
   rubocop:
     enabled: true
-  bundler-audit:
-    enabled: true
   reek:
     enabled: true
 ratings:

data/.travis.yml

@@ -4,10 +4,8 @@ branches:
     - master
     - /^v[0-9]+\.[0-9]+\.[0-9]+/
 rvm:
-- ruby-head
-- jruby-1.7.19
-- 2.0.0
-- 2.3.0
+- 2.1.10
+- 2.3.3
 script:
 - bundle exec rake
 deploy:
@@ -17,5 +15,5 @@ deploy:
   on:
     tags: true
     all_branches: true
-    repo: tpbowden/db_backup
-    rvm: 2.0.0
+    repo: tpbowden/daily_weekly_monthly
+    rvm: 2.3.3

data/README.md

@@ -1,5 +1,7 @@
 # Daily Weekly Monthly
 
+[![Build Status](https://travis-ci.org/tpbowden/daily_monthly_weekly.svg?branch=master)](https://travis-ci.org/tpbowden/daily_monthly_weekly)
+
 Keep your data safe by backing up on a daily, weekly and monthly basis.
 
 This tool allows you to take regular backups whilst automatically removing old ones.

data/daily_weekly_monthly.gemspec

@@ -17,9 +17,12 @@ Gem::Specification.new do |s|
   s.license = "MIT"
   s.required_ruby_version = ">= 2.0.0"
 
+  s.add_dependency "mail", ">= 2.6"
+
   s.add_development_dependency "rake", ">= 10.4"
   s.add_development_dependency "rubocop", ">= 0.35"
   s.add_development_dependency "rspec", ">= 3.4"
   s.add_development_dependency "simplecov", ">= 0.11"
   s.add_development_dependency "cucumber", ">= 2.0"
+  s.add_development_dependency "codeclimate-test-reporter", ">= 0.4"
 end

data/features/daily_weekly_monthly.feature

@@ -21,3 +21,8 @@ Feature: Daily, weekly and monthly backups
       | daily   |
       | weekly  |
       | monthly |
+
+  Scenario: Notifying a failed run
+    Given it is the correct day for daily backups
+    When I run the backup and it fails
+    Then I have been notified of the failure

data/features/step_definitions/daily_weekly_monthly_steps.rb

@@ -27,6 +27,20 @@ When "I run the backups" do
                                           months_to_keep: 3)
 end
 
+When "I run the backup and it fails" do
+  begin
+    DailyWeeklyMonthly.start("exit 10;", backups_dir:  backups_dir,
+                                         day_of_week: @weekly_backup_day || 1,
+                                         day_of_month: @monthly_backup_day || 1,
+                                         days_to_keep: 3,
+                                         weeks_to_keep: 3,
+                                         months_to_keep: 3,
+                                         notify: "person@example.com")
+  rescue RuntimeError => e
+    @exception = e
+  end
+end
+
 Then(/I can see a (.+) backup file/) do |period|
   expect(File.exist?(File.join(backups_dir, period, "#{Date.today.iso8601}.pgdump.gz"))).to be true
 end
@@ -43,3 +57,7 @@ Then(/the old (.+) backups have been removed/) do |period|
     "#{Date.today.iso8601}.pgdump.gz",
   ]
 end
+
+Then "I have been notified of the failure" do
+  expect(Mail::TestMailer.deliveries.length).to eq 1
+end

data/features/support/env.rb

@@ -1,9 +1,15 @@
 require "simplecov"
-SimpleCov.start
+SimpleCov.start do
+  coverage_dir "coverage/features"
+end
 
 require "tmpdir"
 require "daily_weekly_monthly"
 
+Mail.defaults do
+  delivery_method :test
+end
+
 def backups_dir
   @backups_dir ||= Dir.mktmpdir
 end

data/lib/daily_weekly_monthly/cli.rb

@@ -3,6 +3,19 @@ require "daily_weekly_monthly"
 
 module DailyWeeklyMonthly
   class Cli
+    OPTIONS = [
+      :dir,
+      :ext,
+      :week_day,
+      :month_day,
+      :keep_days,
+      :keep_weeks,
+      :keep_months,
+      :smtp_server,
+      :smtp_port,
+      :notify,
+    ].freeze
+
     def initialize args
       @options = {}
       @command = parse args
@@ -16,29 +29,45 @@ module DailyWeeklyMonthly
 
     private
 
-    # rubocop : disable Metrics/MethodLength
     def parse args
       args.options do |opts|
         opts.banner = "Usage: daily_weekly_monthly \"database backup command\" [options]"
-        parse_dir(opts)
-        parse_ext(opts)
-        parse_week_day(opts)
-        parse_month_day(opts)
-        parse_keep_days(opts)
-        parse_keep_weeks(opts)
-        parse_keep_months(opts)
-        opts.parse!
+        parse_all_options(opts)
       end
-
       args
     end
 
+    def parse_all_options opts
+      OPTIONS.each do |option|
+        send("parse_#{option}", opts)
+      end
+      opts.parse!
+    end
+
     def parse_keep_months opts
       opts.on("-M n", "--months-to-keep=n", "Monthly backups to keep", OptionParser::DecimalInteger) do |n|
         @options[:months_to_keep] = n
       end
     end
 
+    def parse_smtp_server opts
+      opts.on("-s s", "--smtp-server=s", "SMTP server for notifications", String) do |s|
+        @options[:smtp_server] = s
+      end
+    end
+
+    def parse_smtp_port opts
+      opts.on("-p p", "--smtp-server=p", "SMTP port for notifications", OptionParser::DecimalInteger) do |p|
+        @options[:smtp_port] = p
+      end
+    end
+
+    def parse_notify opts
+      opts.on("-n s", "--notify=s", "Notification email address", String) do |s|
+        @options[:notify] = s
+      end
+    end
+
     def parse_keep_weeks opts
       opts.on("-W n", "--weeks-to-keep=n", "Weekly backups to keep", OptionParser::DecimalInteger) do |n|
         @options[:weeks_to_keep] = n

data/lib/daily_weekly_monthly/downloader.rb

@@ -8,7 +8,7 @@ module DailyWeeklyMonthly
 
     def call
       result = `#{@backup_command}`
-      raise "Failed to download backup" unless $CHILD_STATUS == 0
+      raise "Failed to download backup: #{result}" unless $CHILD_STATUS.exitstatus.zero?
       result
     end
   end

data/lib/daily_weekly_monthly/notifier.rb

@@ -0,0 +1,29 @@
+require "mail"
+
+module DailyWeeklyMonthly
+  class Notifier
+    def initialize smtp_server, smtp_port
+      @smtp_server = smtp_server
+      @smtp_port = smtp_port
+    end
+
+    # rubocop: disable Metrics/MethodLength
+    def call exception, deliver_to
+      mail = Mail.new {
+        from "backups@localhost"
+        to deliver_to
+        subject "Backup failed"
+        body <<EOF
+Backup failure
+
+#{exception.message}
+
+#{exception.backtrace.join("\n")}
+EOF
+      }
+      mail.delivery_method :smtp, address: @smtp_server, port: @smtp_port if @smtp_server && @smtp_port
+      mail.deliver
+    end
+    # rubocop: enable all
+  end
+end

data/lib/daily_weekly_monthly/runner.rb

@@ -1,5 +1,6 @@
 require "daily_weekly_monthly/processor"
 require "daily_weekly_monthly/downloader"
+require "daily_weekly_monthly/notifier"
 
 module DailyWeeklyMonthly
   class Runner
@@ -11,6 +12,9 @@ module DailyWeeklyMonthly
       days_to_keep: 7,
       weeks_to_keep: 5,
       months_to_keep: 12,
+      smtp_server: false,
+      smtp_port: false,
+      notify: false,
     }.freeze
 
     def initialize backup_command, options = {}
@@ -37,6 +41,9 @@ module DailyWeeklyMonthly
 
     def backup
       Downloader.new(@backup_command).call
+    rescue StandardError => e
+      Notifier.new(@options[:smtp_server], @options[:smtp_port]).call(e, @options[:notify]) if @options[:notify]
+      raise e
     end
   end
 end

data/lib/daily_weekly_monthly/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module DailyWeeklyMonthly
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.3".freeze
 end

data/spec/daily_weekly_monthly/cleaner_spec.rb

@@ -18,7 +18,7 @@ describe DailyWeeklyMonthly::Cleaner do
 
     it "removes all files except the newest N from the target directory" do
       subject.call "weekly", 2
-      expect(Dir[File.join(backups_dir, "weekly", "*.#{ext}")].map { |f|
+      expect(Dir[File.join(backups_dir, "weekly", "*.#{ext}")].map {|f|
         File.basename(f)
       }).to match_array ["2020-01-01.txt", "2019-01-01.txt"]
     end

data/spec/daily_weekly_monthly/cli_spec.rb

@@ -25,6 +25,9 @@ describe DailyWeeklyMonthly::Cli do
           "-e", "foo",
           "-w", "2",
           "-d", "bar",
+          "-n", "me@example.com",
+          "-s", "smpt.example.com",
+          "-p", "25",
           "some", "command"
         ]
       end
@@ -36,7 +39,10 @@ describe DailyWeeklyMonthly::Cli do
                                                                            day_of_month: 1,
                                                                            output_extension: "foo",
                                                                            day_of_week: 2,
-                                                                           backups_dir: "bar")
+                                                                           backups_dir: "bar",
+                                                                           smtp_server: "smpt.example.com",
+                                                                           smtp_port: 25,
+                                                                           notify: "me@example.com")
         subject.call
       end
     end

data/spec/daily_weekly_monthly/downloader_spec.rb

@@ -4,10 +4,10 @@ require "daily_weekly_monthly/downloader"
 describe DailyWeeklyMonthly::Downloader do
   describe "#call" do
     context "when the command fails" do
-      subject { described_class.new "commandThatAlwaysFails 2> /dev/null" }
+      subject { described_class.new "echo 'foo' && exit 1" }
 
       it "raises a runtime error" do
-        expect { subject.call }.to raise_error RuntimeError, "Failed to download backup"
+        expect { subject.call }.to raise_error RuntimeError, "Failed to download backup: foo\n"
       end
     end
 

data/spec/spec_helper.rb

@@ -1,2 +1,19 @@
+require "codeclimate-test-reporter"
 require "simplecov"
-SimpleCov.start
+
+CodeClimate::TestReporter.configure do |config|
+  config.logger.level = Logger::WARN
+end
+
+SimpleCov.start do
+  formatter(
+    SimpleCov::Formatter::MultiFormatter.new(
+      [
+        SimpleCov::Formatter::HTMLFormatter,
+        CodeClimate::TestReporter::Formatter,
+      ],
+    ),
+  )
+
+  coverage_dir "coverage/rspec"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: daily_weekly_monthly
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tom Bowden
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
 description: Automatically manage daily, weekly and monthly database backups
 email: tom.b1992@gmail.com
 executables:
@@ -105,6 +133,7 @@ files:
 - lib/daily_weekly_monthly/cli.rb
 - lib/daily_weekly_monthly/creator.rb
 - lib/daily_weekly_monthly/downloader.rb
+- lib/daily_weekly_monthly/notifier.rb
 - lib/daily_weekly_monthly/processor.rb
 - lib/daily_weekly_monthly/runner.rb
 - lib/daily_weekly_monthly/version.rb
@@ -136,9 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Manage database backups
 test_files: []
-has_rdoc: