martilla 0.0.1 → 0.2.0

data/lib/martilla/notifiers/sendmail.rb

@@ -0,0 +1,21 @@
+require 'pony'
+
+module Martilla
+  class Sendmail < EmailNotifier
+    def success(data)
+      Pony.mail(to: to_email,
+                from: from_email,
+                subject: success_subject,
+                html_body: success_html(data),
+                body: success_txt(data))
+    end
+
+    def error(msg, data)
+      Pony.mail(to: to_email,
+                from: from_email,
+                subject: failure_subject,
+                html_body: error_html(msg, data),
+                body: error_txt(msg, data))
+    end
+  end
+end

data/lib/martilla/notifiers/ses.rb

@@ -1,5 +1,89 @@
-class Martilla::Notifiers::Ses < Martilla::Notifiers::Base
-  def notify(opts)
+require 'aws-sdk-ses'
 
+module Martilla
+  class Ses < EmailNotifier
+    def success(data)
+      begin
+        ses_client.send_email(
+          destination: {
+            to_addresses: to_email.split(',')
+          },
+          message: {
+            body: {
+              html: {
+                charset: 'UTF-8',
+                data: success_html(data)
+              },
+              text: {
+                charset: 'UTF-8',
+                data: success_txt(data)
+              }
+            },
+            subject: {
+              charset: 'UTF-8',
+              data: success_subject
+            }
+          },
+          source: from_email
+        )
+      rescue Aws::SES::Errors::ServiceError => error
+        puts "Email not sent. Error message: #{error}"
+      end
+    end
+
+    def error(msg, data)
+      begin
+        ses_client.send_email(
+          destination: {
+            to_addresses: [
+              to_email.split(',')
+            ]
+          },
+          message: {
+            body: {
+              html: {
+                charset: 'UTF-8',
+                data: error_html(msg, data)
+              },
+              text: {
+                charset: 'UTF-8',
+                data: error_txt(msg, data)
+              }
+            },
+            subject: {
+              charset: 'UTF-8',
+              data: failure_subject
+            }
+          },
+          source: from_email
+        )
+      rescue Aws::SES::Errors::ServiceError => error
+        puts "Email not sent. Error message: #{error}"
+      end
+    end
+
+    private
+
+    def ses_client
+      options = {}
+      options[:region] = aws_region unless aws_region.nil?
+      options[:access_key_id] = aws_access_key unless aws_access_key.nil?
+      options[:secret_access_key] = aws_secret_key unless aws_secret_key.nil?
+      Aws::SES::Client.new(options)
+    end
+
+    def aws_region
+      aws_region = @options['region']
+      raise config_error('region') if aws_region.nil?
+      aws_region
+    end
+
+    def aws_access_key
+      @options['access_key_id']
+    end
+
+    def aws_secret_key
+      @options['secret_access_key']
+    end
   end
 end

data/lib/martilla/notifiers/slack.rb

@@ -1,5 +1,4 @@
-class Martilla::Notifiers::Slack < Martilla::Notifiers::Base
-  def notify(opts)
-
+module Martilla
+  class Slack < Notifier
   end
 end

data/lib/martilla/notifiers/smtp.rb

@@ -0,0 +1,70 @@
+require 'pony'
+
+module Martilla
+  class Smtp < EmailNotifier
+    def success(data)
+      Pony.mail(to: to_email,
+                from: from_email,
+                subject: success_subject,
+                via: :smtp,
+                html_body: success_html(data),
+                body: success_txt(data),
+                via_options: via_options)
+    end
+
+    def error(msg, data)
+      Pony.mail(to: to_email,
+                from: from_email,
+                subject: failure_subject,
+                via: :smtp,
+                html_body: error_html(msg, data),
+                body: error_txt(msg, data),
+                via_options: via_options)
+    end
+
+    private
+
+    def via_options
+      {
+        address: address,
+        port: port,
+        user_name: user_name,
+        password: password,
+        authentication: authentication, # :plain, :login, :cram_md5, no auth by default
+        domain: domain # the HELO domain provided by the client to the server
+      }
+    end
+
+    def address
+      email = @options['address']
+      raise config_error('address') if email.nil?
+      email
+    end
+
+    def domain
+      smtp_domain = @options['domain']
+      raise config_error('domain') if smtp_domain.nil?
+      smtp_domain
+    end
+
+    def user_name
+      smtp_user_name = @options['user_name']
+      raise config_error('user_name') if smtp_user_name.nil?
+      smtp_user_name
+    end
+
+    def password
+      smtp_password = @options['password']
+      raise config_error('password') if smtp_password.nil?
+      smtp_password
+    end
+
+    def port
+      @options['port'] || '25'
+    end
+
+    def authentication
+      @options['authentication'] || :plain
+    end
+  end
+end

data/lib/martilla/storage.rb

@@ -2,22 +2,62 @@ require 'forwardable'
 
 module Martilla
   class Storage
-    extend Forwardable
+    attr_reader :options
 
     def initialize(config)
-      # When a new core target is added to the project include it here
+      @options = config
+      raise Error.new(invalid_options_msg) if @options.nil?
+    end
+
+    def persist(temp_file:, gzip:)
+      raise NotImplementedError, 'You must implement the persist method'
+    end
+
+    def invalid_options_msg
+      'Storage configuration is invalid. Details here: https://github.com/fdoxyz/martilla'
+    end
+
+    def suffix?
+      return true if @options['suffix'].nil?
+      @options['suffix']
+    end
+
+    def output_filename(gzip)
+      filename = @options['filename'] || 'backup.sql'
+      filename = append_datetime_suffix(filename) if suffix?
+      filename = "#{filename}.gz" if gzip
+      filename
+    end
+
+    def append_datetime_suffix(filename)
+      dirname = File.dirname(filename)
+      basename = File.basename(filename, '.*')
+
+      # 'dir_with_name' is the original filename WITHOUT the extension
+      dir_with_name = "#{dirname}/#{basename}"
+      dir_with_name = basename if dirname == '.'
+
+      extension = filename.gsub(dir_with_name, '')
+      timestamp = Time.now.strftime("%Y-%m-%dT%H%M%S")
+      "#{dirname}/#{basename}_#{timestamp}#{extension}"
+    end
+
+    def config_error(config_name)
+      Error.new("Storage adapter configuration requires #{config_name}. Details here: https://github.com/fdoxyz/martilla")
+    end
+
+    # When a new Storage is supported it needs to go here
+    def self.create(config = {})
       case config['type'].downcase
       when 'local'
-        @storage = Storages::Local.new(config['options'])
+        Local.new(config['options'])
       when 's3'
-        @storage = Storages::S3.new(config['options'])
+        S3.new(config['options'])
       when 'scp'
-        @storage = Storages::Scp.new(config['options'])
+        Scp.new(config['options'])
       else
         raise Error.new("Invalid Storage type: #{config['type']}")
       end
     end
-
-    def_delegators :@storage, :persist
   end
 end

data/lib/martilla/storages/local.rb

@@ -1,5 +1,9 @@
-class Martilla::Storages::Local < Martilla::Storages::Base
-  def persist(filepath, opts)
-
+module Martilla
+  class Local < Storage
+    def persist(tmp_file:, gzip:)
+      `mv #{tmp_file} #{output_filename(gzip)}`
+      return nil if $?.success?
+      raise Error.new("Local storage failed with code #{$?.exitstatus}")
+    end
   end
 end

data/lib/martilla/storages/s3.rb

@@ -1,5 +1,42 @@
-class Martilla::Storages::S3 < Martilla::Storages::Base
-  def persist(filepath, opts)
+require 'aws-sdk-s3'
 
+module Martilla
+  class S3 < Storage
+    def persist(tmp_file:, gzip:)
+      path = output_filename(gzip)
+      obj = s3_resource.bucket(bucket_name).object(path)
+
+      # Upload it
+      return nil if obj.upload_file(tmp_file)
+      raise Error.new('Error uploading backup to bucket')
+    end
+
+    private
+
+    def s3_resource
+      options = {}
+      options[:region] = aws_region unless aws_region.nil?
+      options[:access_key_id] = aws_access_key unless aws_access_key.nil?
+      options[:secret_access_key] = aws_secret_key unless aws_secret_key.nil?
+      Aws::S3::Resource.new(options)
+    end
+
+    def aws_region
+      @options['region']
+    end
+
+    def aws_access_key
+      @options['access_key_id']
+    end
+
+    def aws_secret_key
+      @options['secret_access_key']
+    end
+
+    def bucket_name
+      bucket = @options['bucket']
+      raise config_error('bucket') if bucket.nil?
+      bucket
+    end
   end
 end

data/lib/martilla/storages/scp.rb

@@ -1,5 +1,29 @@
-class Martilla::Storages::Scp < Martilla::Storages::Base
-  def persist(filepath, opts)
+module Martilla
+  class Scp < Storage
+    def persist(tmp_file:, gzip:)
+      `scp -i #{identity_file} #{user}@#{host}:#{output_filename(gzip)}`
+      return nil if $?.success?
+      raise Error.new("SCP storage failed with code #{$?.exitstatus}")
+    end
 
+    private
+
+    def host
+      scp_host = @options['host']
+      raise config_error('host') if scp_host.nil?
+      scp_host
+    end
+
+    def user
+      scp_user = @options['user']
+      raise config_error('user') if scp_user.nil?
+      scp_user
+    end
+
+    def identity_file
+      file = @options['identity_file']
+      raise config_error('identity_file') if file.nil?
+      file
+    end
   end
 end

data/lib/martilla/utilities.rb

@@ -0,0 +1,45 @@
+module Martilla
+  class Backup
+    module Utilities
+      def duration_format(seconds)
+        case seconds
+        when 0..59
+          # 22s
+          "#{seconds}s"
+        when 60..3599
+          # 18m 19s
+          "#{s_to_m(seconds)}m #{seconds % 60}s"
+        else
+          # 7h 9m 51s
+          "#{s_to_h(seconds)}h #{s_to_m(seconds)}m #{seconds % 60}s"
+        end
+      end
+
+      def s_to_m(seconds)
+        (seconds / 60) % 60
+      end
+
+      def s_to_h(seconds)
+        (seconds / 3600) % 3600
+      end
+
+      def formatted_file_size
+        return if @file_size.nil?
+
+        if @file_size <= 799_999
+          compressed_file_size = @file_size / 2**10
+          formatted_size = '%.2f' % compressed_file_size
+          "#{formatted_size} KB"
+        elsif @file_size <= 799_999_999
+          compressed_file_size = @file_size / 2**20
+          formatted_size = '%.2f' % compressed_file_size
+          "#{formatted_size} MB"
+        else
+          compressed_file_size = @file_size / 2**30
+          formatted_size = '%.2f' % compressed_file_size
+          "#{formatted_size} GB"
+        end
+      end
+    end
+  end
+end

data/lib/martilla/version.rb

@@ -1,3 +1,3 @@
 module Martilla
-  VERSION = '0.0.1'
+  VERSION = '0.2.0'
 end

data/lib/martilla.rb

@@ -1,31 +1,24 @@
 require 'martilla/version'
 require 'martilla/cli'
 
-module Martilla
-  class Error < StandardError; end
+require 'martilla/backup'
+
+require 'martilla/database'
+require 'martilla/databases/mysql'
+require 'martilla/databases/postgres'
 
-  def execute_backup(config)
-    puts "EXECUTING BACKUP WITH CONFIG: #{config}"
-    db = Database.new(config['db'])
-    storage = Storage.new(config['storage'])
-    notifiers = config['notifiers'].map { |c| Notifier.new(c) }
+require 'martilla/notifier'
+require 'martilla/notifiers/email_notifier'
+require 'martilla/notifiers/smtp'
+require 'martilla/notifiers/sendmail'
+require 'martilla/notifiers/ses'
+require 'martilla/notifiers/slack'
 
-    begin
-      # Perform DB dump & storage of backup
-      temp_filepath = db.dump
-      storage.persist(temp_filepath)
-    rescue Exception => e
-      puts "EXCEPTION RAISED: #{e.inspect}"
-      notifiers.each do |notifier|
-        notifier.error(e)
-      end
-    else
-      puts "SUCCESS"
-      notifiers.each do |notifier|
-        notifier.success
-      end
-    end
+require 'martilla/storage'
+require 'martilla/storages/local'
+require 'martilla/storages/s3'
+require 'martilla/storages/scp'
 
-    File.delete(temp_filepath) if File.exist?(temp_filepath)
-  end
+module Martilla
+  class Error < StandardError; end
 end

data/martilla.gemspec

@@ -28,11 +28,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'pony', '~> 1.13'
-  spec.add_dependency 'aws-ses', '~> 0.6.0'
   spec.add_dependency 'thor', '~> 0.20.3'
+  spec.add_dependency 'memoist', '~> 0.16.0'
+  spec.add_dependency 'pony', '~> 1.13'
+  spec.add_dependency 'aws-sdk-ses', '~> 1.26'
+  spec.add_dependency 'aws-sdk-s3', '~> 1.49'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'byebug', '~> 11.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.7'
+  spec.add_development_dependency 'simplecov', '~> 0.17.1'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: martilla
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Fernando Valverde
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2019-10-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: pony
   requirement: !ruby/object:Gem::Requirement
@@ -25,33 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: aws-ses
+  name: aws-sdk-ses
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '1.26'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '1.26'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: '1.49'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: '1.49'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +122,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
 description: ''
 email:
 - fdov88@gmail.com
@@ -113,22 +183,24 @@ files:
 - bin/console
 - bin/martilla
 - bin/setup
+- config.yml
 - lib/martilla.rb
+- lib/martilla/backup.rb
 - lib/martilla/cli.rb
 - lib/martilla/database.rb
-- lib/martilla/databases/base.rb
 - lib/martilla/databases/mysql.rb
 - lib/martilla/databases/postgres.rb
 - lib/martilla/notifier.rb
-- lib/martilla/notifiers/base.rb
-- lib/martilla/notifiers/email.rb
+- lib/martilla/notifiers/email_notifier.rb
+- lib/martilla/notifiers/sendmail.rb
 - lib/martilla/notifiers/ses.rb
 - lib/martilla/notifiers/slack.rb
+- lib/martilla/notifiers/smtp.rb
 - lib/martilla/storage.rb
-- lib/martilla/storages/base.rb
 - lib/martilla/storages/local.rb
 - lib/martilla/storages/s3.rb
 - lib/martilla/storages/scp.rb
+- lib/martilla/utilities.rb
 - lib/martilla/version.rb
 - martilla.gemspec
 homepage: https://github.com/fdoxyz/martilla

data/lib/martilla/databases/base.rb

@@ -1,11 +0,0 @@
-class Martilla::Databases::Base
-  attr_reader :options
-
-  def initialize(opts)
-    @options = opts
-  end
-
-  def temp_filepath
-    @options['tmp_file'] || '/tmp/db.sql'
-  end
-end

data/lib/martilla/notifiers/base.rb

@@ -1,7 +0,0 @@
-class Martilla::Notifiers::Base
-  attr_reader :options
-
-  def initialize(opts)
-    @options = opts
-  end
-end

data/lib/martilla/notifiers/email.rb

@@ -1,5 +0,0 @@
-class Martilla::Notifiers::Email < Martilla::Notifiers::Base
-  def notify(opts)
-
-  end
-end

data/lib/martilla/storages/base.rb

@@ -1,7 +0,0 @@
-class Martilla::Storages::Base
-  attr_reader :options
-
-  def initialize(opts)
-    @options = opts
-  end
-end