do_snapshot 0.2.2 → 0.3.0

data/lib/do_snapshot/mail.rb

@@ -2,99 +2,82 @@
 require 'date'
 require 'pony'
 require_relative 'core_ext/hash'
-require_relative 'log'
+require_relative 'helpers'
 
 module DoSnapshot
   # Shared mailer.
   #
-  module Mail
-    def mailer
-      UniversalMailer
-    end
+  class Mail
+    include DoSnapshot::Helpers
 
-    # UniversalMailer is module to deal with singleton methods.
-    # Used to give classes access only for selected methods
-    #
-    module UniversalMailer
-      module_function
+    attr_writer :mailer, :opts_default, :smtp_default
 
-      def notify
-        Mail.notify
-      end
+    def initialize(options = {})
+      options.each { |key, option| send("#{key}=", option) }
     end
 
-    class << self
-      include DoSnapshot::Log
-
-      attr_writer :mailer, :opts_default, :smtp_default
-
-      def load_options(options = {})
-        options.each { |key, option| send("#{key}=", option) }
-      end
-
-      def reset_options
-        @opts = opts_default
-        @smtp = smtp_default
-      end
+    def reset_options
+      @opts = opts_default
+      @smtp = smtp_default
+    end
 
-      def mailer
-        @mailer ||= Pony.method(:mail)
-      end
+    def mailer
+      @mailer ||= Pony.method(:mail)
+    end
 
-      def smtp
-        @smtp ||= smtp_default.dup
-      end
+    def smtp
+      @smtp ||= smtp_default.dup
+    end
 
-      def opts
-        @opts ||= opts_default.dup
-      end
+    def opts
+      @opts ||= opts_default.dup
+    end
 
-      def smtp=(options)
-        options.each_pair do |key, value|
-          smtp[key.to_sym] = value
-        end if options
-      end
+    def smtp=(options)
+      options.each_pair do |key, value|
+        smtp[key.to_sym] = value
+      end if options
+    end
 
-      def opts=(options)
-        options.each_pair do |key, value|
-          opts[key.to_sym] = value
-        end if options
-      end
+    def opts=(options)
+      options.each_pair do |key, value|
+        opts[key.to_sym] = value
+      end if options
+    end
 
-      # Sending message via Hash params.
-      #
-      # Options:: --mail to:mail@somehost.com from:from@host.com --smtp address:smtp.gmail.com user_name:someuser password:somepassword
-      #
-      def notify
-        setup_notify
-        log.debug 'Sending e-mail notification.'
-        # Look into your inbox :)
-        mailer.call(opts)
-      end
+    # Sending message via Hash params.
+    #
+    # Options:: --mail to:mail@somehost.com from:from@host.com --smtp address:smtp.gmail.com user_name:someuser password:somepassword
+    #
+    def notify
+      setup_notify
+      logger.debug 'Sending e-mail notification.'
+      # Look into your inbox :)
+      mailer.call(opts)
+    end
 
-      protected
+    protected
 
-      def opts_default
-        @opts_default ||= {
-          subject: 'Digital Ocean: maximum snapshots is reached.',
-          body: "Please cleanup your Digital Ocean account.\nSnapshot maximum is reached.",
-          from: 'noreply@someonelse.com',
-          to: 'to@someonelse.com',
-          via: :smtp
-        }
-      end
+    def opts_default
+      @opts_default ||= {
+        subject: 'Digital Ocean: maximum snapshots is reached.',
+        body: "Please cleanup your Digital Ocean account.\nSnapshot maximum is reached.",
+        from: 'noreply@someonelse.com',
+        to: 'to@someonelse.com',
+        via: :smtp
+      }
+    end
 
-      def smtp_default
-        @smtp_default ||= {
-          domain: 'localhost.localdomain',
-          port: '25'
-        }
-      end
+    def smtp_default
+      @smtp_default ||= {
+        domain: 'localhost.localdomain',
+        port: '25'
+      }
+    end
 
-      def setup_notify
-        opts[:body] = "#{opts[:body]}\n\nTrace: #{DateTime.now}\n#{Log.buffer.join("\n")}"
-        opts[:via_options] = smtp
-      end
+    def setup_notify
+      opts[:body] = "#{opts[:body]}\n\nTrace: #{DateTime.now}\n#{DoSnapshot.logger.buffer.join("\n")}"
+      opts[:via_options] = smtp
     end
   end
 end

data/lib/do_snapshot/runner.rb

@@ -0,0 +1,59 @@
+require 'do_snapshot/cli'
+
+module DoSnapshot
+  # CLI Runner
+  #
+  class Runner
+    def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
+      @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+    end
+
+    def execute! # rubocop:disable Metrics/MethodLength
+      exit_code = begin
+        run_cli
+      rescue DoSnapshot::NoTokenError, DoSnapshot::NoKeysError => _
+        do_nothing_on_shown_error
+      rescue StandardError => e
+        display_backtrace_otherwise(e)
+      rescue SystemExit => e
+        e.status
+      ensure
+        clean_before_exit
+      end
+
+      @kernel.exit(exit_code)
+    end
+
+    private
+
+    def run_cli
+      $stderr = @stderr
+      $stdin = @stdin
+      $stdout = @stdout
+
+      DoSnapshot::CLI.start(@argv)
+
+      0
+    end
+
+    def do_nothing_on_shown_error
+      clean_before_exit
+      1
+    end
+
+    def display_backtrace_otherwise(e)
+      b = e.backtrace
+      @stderr.puts("#{b.shift}: #{e.message} (#{e.class})")
+      @stderr.puts(b.map { |s| "\tfrom #{s}" }.join("\n"))
+      1
+    end
+
+    def clean_before_exit
+      DoSnapshot.cleanup
+
+      $stderr = STDERR
+      $stdin = STDIN
+      $stdout = STDOUT
+    end
+  end
+end

data/lib/do_snapshot/version.rb

@@ -2,5 +2,5 @@
 # Current version
 #
 module DoSnapshot
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/do_snapshot.rb

@@ -1,13 +1,46 @@
 # -*- encoding : utf-8 -*-
 require_relative 'do_snapshot/version'
+require_relative 'do_snapshot/configuration'
 
 # Used primary for creating snapshot's as backups for DigitalOcean
 #
 module DoSnapshot
+  class << self
+    attr_accessor :logger, :mailer
+
+    def configure
+      yield(config)
+    end
+
+    def reconfigure
+      @config = Configuration.new
+      yield(config)
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def cleanup
+      logger.close if logger
+      @logger = nil
+      @mailer = nil
+      @config = nil
+    end
+  end
+
   # Standard Request Exception. When we don't need droplet instance id.
   #
   class RequestError < StandardError; end
 
+  # Every call must have keys in environment or via params.
+  #
+  class NoKeysError < StandardError; end
+
+  # Every call must have token in environment or via params.
+  #
+  class NoTokenError < StandardError; end
+
   # Base Exception for cases when we need id for log and/or something actions.
   #
   class RequestActionError < RequestError
@@ -22,7 +55,7 @@ module DoSnapshot
   #
   class DropletShutdownError < RequestActionError
     def initialize(*args)
-      Log.log :error, "Droplet id: #{args[0]} is Failed to Power Off."
+      DoSnapshot.logger.error "Droplet id: #{args[0]} is Failed to Power Off."
       super
     end
   end
@@ -32,7 +65,7 @@ module DoSnapshot
   #
   class SnapshotCreateError < RequestActionError
     def initialize(*args)
-      Log.log :error, "Droplet id: #{args[0]} is Failed to Snapshot."
+      DoSnapshot.logger.error "Droplet id: #{args[0]} is Failed to Snapshot."
       super
     end
   end
@@ -42,7 +75,7 @@ module DoSnapshot
   #
   class DropletFindError < RequestError
     def initialize(*args)
-      Log.log :error, 'Droplet Not Found'
+      DoSnapshot.logger.error 'Droplet Not Found'
       super
     end
   end
@@ -52,7 +85,7 @@ module DoSnapshot
   #
   class DropletListError < RequestError
     def initialize(*args)
-      Log.log :error, 'Droplet Listing is failed to retrieve'
+      DoSnapshot.logger.error 'Droplet Listing is failed to retrieve'
       super
     end
   end

data/spec/do_snapshot/adapter/abstract_spec.rb

@@ -5,7 +5,6 @@ describe DoSnapshot::Adapter::Abstract do
   include_context 'spec'
 
   subject(:api) { described_class }
-  subject(:log) { DoSnapshot::Log }
 
   describe '.initialize' do
     describe '#delay' do
@@ -20,10 +19,4 @@ describe DoSnapshot::Adapter::Abstract do
       it('with custom timeout') { expect(instance.timeout).to eq timeout  }
     end
   end
-
-  before(:each) do
-    log.buffer = %w()
-    log.verbose = false
-    log.quiet = true
-  end
 end

data/spec/do_snapshot/adapter/digitalocean_spec.rb

@@ -41,7 +41,7 @@ describe DoSnapshot::Adapter::Digitalocean do
 
         expect { instance.droplet(droplet_id) }
           .to raise_error
-        expect(log.buffer)
+        expect(DoSnapshot.logger.buffer)
           .to include 'Droplet Not Found'
 
         expect(a_request(:get, droplet_url))
@@ -63,7 +63,7 @@ describe DoSnapshot::Adapter::Digitalocean do
         stub_droplets_fail
 
         expect { instance.droplets }.to raise_error
-        expect(log.buffer)
+        expect(DoSnapshot.logger.buffer)
           .to include 'Droplet Listing is failed to retrieve'
 
         expect(a_request(:get, droplets_uri))
@@ -77,7 +77,7 @@ describe DoSnapshot::Adapter::Digitalocean do
         stub_droplet_start(droplet_id)
 
         instance.start_droplet(droplet_id)
-        expect(log.buffer).to include 'Power On has been requested.'
+        expect(DoSnapshot.logger.buffer).to include 'Power On has been requested.'
 
         expect(a_request(:get, droplet_start_url))
           .to have_been_made
@@ -90,7 +90,7 @@ describe DoSnapshot::Adapter::Digitalocean do
 
         expect { instance.start_droplet(droplet_id) }
           .not_to raise_error
-        expect(log.buffer)
+        expect(DoSnapshot.logger.buffer)
           .to include 'Droplet is still running.'
 
         expect(a_request(:get, droplet_url))
@@ -126,7 +126,7 @@ describe DoSnapshot::Adapter::Digitalocean do
 
         expect { instance.stop_droplet(droplet_id) }
           .to raise_error
-        expect(log.buffer)
+        expect(DoSnapshot.logger.buffer)
           .to include 'Droplet id: 100823 is Failed to Power Off.'
 
         expect(a_request(:get, droplet_stop_url))
@@ -181,7 +181,7 @@ describe DoSnapshot::Adapter::Digitalocean do
         droplet = instance.droplet(droplet_id)
         expect { instance.cleanup_snapshots(droplet, 1) }
           .not_to raise_error
-        expect(log.buffer)
+        expect(DoSnapshot.logger.buffer)
           .to include 'Snapshot name: mrcr.ru_2014_07_19 delete requested.'
 
         expect(a_request(:get, droplet_url))
@@ -200,7 +200,7 @@ describe DoSnapshot::Adapter::Digitalocean do
         droplet = instance.droplet(droplet_id)
         expect { instance.cleanup_snapshots(droplet, 1) }
           .not_to raise_error
-        expect(log.buffer)
+        expect(DoSnapshot.logger.buffer)
           .to include 'Some Message'
 
         expect(a_request(:get, droplet_url))
@@ -212,10 +212,4 @@ describe DoSnapshot::Adapter::Digitalocean do
       end
     end
   end
-
-  before(:each) do
-    log.buffer = %w()
-    log.verbose = false
-    log.quiet = true
-  end
 end

data/spec/do_snapshot/adapter/digitalocean_v2_spec.rb

@@ -43,7 +43,7 @@ describe DoSnapshot::Adapter::DigitaloceanV2 do
 
         expect { instance.droplet(droplet_id) }
           .to raise_error
-        expect(log.buffer)
+        expect(DoSnapshot.logger.buffer)
           .to include 'Droplet Not Found'
 
         expect(a_request(:get, droplet_url))
@@ -65,7 +65,7 @@ describe DoSnapshot::Adapter::DigitaloceanV2 do
         stub_droplets_fail
 
         expect { instance.droplets }.to raise_error
-        expect(log.buffer)
+        expect(DoSnapshot.logger.buffer)
           .to include 'Droplet Listing is failed to retrieve'
 
         expect(a_request(:get, droplets_uri))
@@ -79,7 +79,7 @@ describe DoSnapshot::Adapter::DigitaloceanV2 do
         stub_droplet_start(droplet_id)
 
         instance.start_droplet(droplet_id)
-        expect(log.buffer).to include 'Power On has been requested.'
+        expect(DoSnapshot.logger.buffer).to include 'Power On has been requested.'
 
         expect(a_request(:post, droplet_start_url))
           .to have_been_made
@@ -92,7 +92,7 @@ describe DoSnapshot::Adapter::DigitaloceanV2 do
 
         expect { instance.start_droplet(droplet_id) }
           .not_to raise_error
-        expect(log.buffer)
+        expect(DoSnapshot.logger.buffer)
           .to include 'Droplet is still running.'
 
         expect(a_request(:get, droplet_url))
@@ -128,7 +128,7 @@ describe DoSnapshot::Adapter::DigitaloceanV2 do
 
         expect { instance.stop_droplet(droplet_id) }
           .to raise_error
-        expect(log.buffer)
+        expect(DoSnapshot.logger.buffer)
           .to include 'Droplet id: 100823 is Failed to Power Off.'
 
         expect(a_request(:post, droplet_stop_url))
@@ -183,7 +183,7 @@ describe DoSnapshot::Adapter::DigitaloceanV2 do
         droplet = instance.droplet(droplet_id)
         expect { instance.cleanup_snapshots(droplet, 1) }
           .not_to raise_error
-        expect(log.buffer)
+        expect(DoSnapshot.logger.buffer)
           .to include 'Snapshot: 5019770 delete requested.'
 
         expect(a_request(:get, droplet_url))
@@ -202,7 +202,7 @@ describe DoSnapshot::Adapter::DigitaloceanV2 do
         droplet = instance.droplet(droplet_id)
         expect { instance.cleanup_snapshots(droplet, 1) }
           .not_to raise_error
-        expect(log.buffer)
+        expect(DoSnapshot.logger.buffer)
           .to include 'Destroy of snapshot 5019903 for droplet id: 100823 name: example.com is failed.'
 
         expect(a_request(:get, droplet_url))
@@ -214,10 +214,4 @@ describe DoSnapshot::Adapter::DigitaloceanV2 do
       end
     end
   end
-
-  before(:each) do
-    log.buffer = %w()
-    log.verbose = false
-    log.quiet = true
-  end
 end

data/spec/do_snapshot/command_spec.rb

@@ -14,7 +14,7 @@ describe DoSnapshot::Command do
       it 'sends message' do
         expect { snap_runner }
           .not_to raise_error
-        expect(log.buffer)
+        expect(DoSnapshot.logger.buffer)
           .to include 'All operations has been finished.'
       end
     end
@@ -108,7 +108,7 @@ describe DoSnapshot::Command do
 
       expect { cmd.fail_power_off(DoSnapshot::DropletShutdownError.new(droplet_id)) }
         .not_to raise_error
-      expect(log.buffer)
+      expect(DoSnapshot.logger.buffer)
         .to include 'Power On has been requested.'
     end
 
@@ -117,9 +117,9 @@ describe DoSnapshot::Command do
 
       expect { cmd.fail_power_off(DoSnapshot::DropletShutdownError.new(droplet_id)) }
         .to raise_error
-      expect(log.buffer)
+      expect(DoSnapshot.logger.buffer)
         .to include 'Droplet id: 100823 is Failed to Power Off.'
-      expect(log.buffer)
+      expect(DoSnapshot.logger.buffer)
         .to include 'Droplet Not Found'
     end
 
@@ -130,16 +130,16 @@ describe DoSnapshot::Command do
 
       expect { cmd.fail_power_off(DoSnapshot::DropletShutdownError.new(droplet_id)) }
         .not_to raise_error
-      expect(log.buffer)
+      expect(DoSnapshot.logger.buffer)
         .to include 'Power On failed to request.'
     end
   end
 
   before(:each) do
     stub_all_api(nil, true)
-    log.buffer = %w()
-    log.verbose = false
-    log.quiet = true
+    DoSnapshot.logger.buffer = %w()
+    DoSnapshot.logger.verbose = false
+    DoSnapshot.logger.quiet = true
   end
 
   def load_options(options = nil)

data/spec/do_snapshot/configuration_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe DoSnapshot::Configuration do
+  subject(:cli) { described_class }
+
+  it { expect(cli.new).to respond_to(:logger) }
+  it { expect(cli.new).to respond_to(:logger_level) }
+  it { expect(cli.new).to respond_to(:verbose) }
+  it { expect(cli.new).to respond_to(:quiet) }
+  it { expect(cli.new).to respond_to(:mailer) }
+end

data/spec/do_snapshot/log_spec.rb

@@ -0,0 +1,88 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe DoSnapshot::Log do
+  include_context 'spec'
+
+  subject(:log) { described_class }
+
+  describe 'will have message' do
+    it '#info' do
+      expect(DoSnapshot.logger).to respond_to(:info)
+      DoSnapshot.logger.info('fff')
+      expect(DoSnapshot.logger.buffer).to include('fff')
+    end
+
+    it '#debug' do
+      expect(DoSnapshot.logger).to respond_to(:debug)
+      DoSnapshot.logger.info('fff')
+      expect(DoSnapshot.logger.buffer).to include('fff')
+    end
+
+    it '#warn' do
+      expect(DoSnapshot.logger).to respond_to(:warn)
+      DoSnapshot.logger.info('fff')
+      expect(DoSnapshot.logger.buffer).to include('fff')
+    end
+
+    it '#fatal' do
+      expect(DoSnapshot.logger).to respond_to(:fatal)
+      DoSnapshot.logger.info('fff')
+      expect(DoSnapshot.logger.buffer).to include('fff')
+    end
+
+    it '#error' do
+      expect(DoSnapshot.logger).to respond_to(:error)
+      DoSnapshot.logger.info('fff')
+      expect(DoSnapshot.logger.buffer).to include('fff')
+    end
+
+    it '#blablabla' do
+      expect(DoSnapshot.logger).not_to respond_to(:blablabla)
+    end
+
+    before :each do
+      DoSnapshot.configure do |config|
+        config.logger = Logger.new(log_path)
+        config.verbose = true
+        config.quiet = true
+      end
+      DoSnapshot.logger = DoSnapshot::Log.new
+    end
+  end
+
+  describe 'will work with files' do
+    it 'with file' do
+      FileUtils.remove_file(log_path, true)
+
+      DoSnapshot.configure do |config|
+        config.logger = Logger.new(log_path)
+        config.verbose = true
+        config.quiet = true
+      end
+      DoSnapshot.logger = DoSnapshot::Log.new
+
+      expect(File.exist?(log_path)).to be_truthy
+    end
+
+    it 'with no file' do
+      FileUtils.remove_file(log_path, true)
+
+      DoSnapshot.logger = DoSnapshot::Log.new
+
+      expect(File.exist?(log_path)).to be_falsey
+    end
+
+    it 'with no file but logging' do
+      FileUtils.remove_file(log_path, true)
+
+      DoSnapshot.logger = DoSnapshot::Log.new
+
+      expect(File.exist?(log_path)).to be_falsey
+
+      expect(DoSnapshot.logger).to respond_to(:info)
+      DoSnapshot.logger.info('fff')
+      expect(DoSnapshot.logger.buffer).to include('fff')
+    end
+  end
+end

data/spec/do_snapshot/mail_spec.rb

@@ -4,12 +4,26 @@ require 'spec_helper'
 describe DoSnapshot::Mail do
   include_context 'spec'
 
+  subject(:mail) { described_class }
+
   describe 'will send mail with options' do
     it '#notify' do
-      DoSnapshot::Mail.reset_options
-      DoSnapshot::Mail.load_options(opts: mail_options, smtp: smtp_options)
-      expect { DoSnapshot::Mail.notify }.not_to raise_error
-      expect(DoSnapshot::Mail.smtp[:address]).to eq(smtp_options[:address])
+      mail = DoSnapshot.mailer.notify
+      expect(mail).not_to be_falsey
+      expect(mail.delivery_method.settings[:address]).to eq(smtp_options[:address])
+      expect(mail.delivery_method.settings[:port]).to eq(smtp_options[:port])
+      expect(mail.delivery_method.settings[:user_name]).to eq(smtp_options[:user_name])
+      expect(mail.delivery_method.settings[:password]).to eq(smtp_options[:password])
+      expect(mail.header.fields).to include(::Mail::Field.new('From', mail_options[:from], 'UTF-8'))
+      expect(mail.header.fields).to include(::Mail::Field.new('To', mail_options[:to], 'UTF-8'))
+    end
+
+    before :each do
+      DoSnapshot.configure do |config|
+        config.mailer = mail.new(opts: mail_options, smtp: smtp_options)
+      end
+      DoSnapshot.mailer = DoSnapshot.config.mailer
+      DoSnapshot.logger = DoSnapshot::Log.new
     end
   end
 end