do_snapshot 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1832957a7416c15f2755720be734b7153dc19856
-  data.tar.gz: 4cd6ea976f4bbbe26051e10b538e4e213f7cd87c
+  metadata.gz: fd8a67c728fd77180645b3ea87ee37db50ab627e
+  data.tar.gz: e3196ed56ad208a890c3be2f55bb02cb7499a06f
 SHA512:
-  metadata.gz: 2c988328d3c25992b45336a37e34ff535f5db6e4545ae9946c77b24dd9866517734bf27653e4e170451463ae94580053c88a968f2f9acda141b00ccbb66a0b12
-  data.tar.gz: 10532b1d32445a9cd7c28d84119524cd6a8399103295639dcabfe308dd6eddb2aa2c2a1fb4c95e2eecd36a7d026574d33d4693e745a5a00b93d89662272fc471
+  metadata.gz: 1f91dd0dc2e68e03eb59a48e7e2077893d2d4574d6f2fc2900070adcaa1c9c580b9d001ece9283d34da67fdbe4ec93e0ed8894d0f74e446b774f3837ed4f1a44
+  data.tar.gz: 7a27ff1d46bc31ffd257ae77f0e474408172d4dc6dd755615215dedf280e842f88c1fe543b099ca522bf552a8ec070744d4d7ee661a712638e9d0211495aafbb

data/README.md

@@ -1,4 +1,5 @@
-# DoSnapshot CLI
+# DoSnapshot CLI 
+[Project Page at Digital Ocean](https://www.digitalocean.com/community/projects/dosnapshot), comment or vote for this project.
 
 [![Gem Version](https://badge.fury.io/rb/do_snapshot.svg)](http://badge.fury.io/rb/do_snapshot)
 [![Build Status](https://travis-ci.org/merqlove/do_snapshot.svg?branch=master)](https://travis-ci.org/merqlove/do_snapshot)
@@ -183,4 +184,4 @@ For working mailer you need to set e-mail settings via run options.
 
 Copyright (c) 2014 Alexander Merkulov
 
-MIT License
+MIT License

data/lib/do_snapshot/api.rb

@@ -87,13 +87,7 @@ module DoSnapshot
         snapshot = instance.snapshots[i]
         event = Digitalocean::Image.destroy(snapshot.id)
 
-        if !event
-          Log.error "Destroy of snapshot #{snapshot.name} for droplet id: #{instance.id} name: #{instance.name} is failed."
-        elsif event && !event.status.include?('OK')
-          Log.error event.message
-        else
-          Log.debug "Snapshot name: #{snapshot.name} delete requested."
-        end
+        after_cleanup(instance.id, instance.name, snapshot, event)
       end
     end
 
@@ -136,5 +130,15 @@ module DoSnapshot
         Log.error 'Power On failed to request.'
       end
     end
+
+    def after_cleanup(droplet_id, droplet_name, snapshot, event)
+      if !event
+        Log.error "Destroy of snapshot #{snapshot.name} for droplet id: #{droplet_id} name: #{droplet_name} is failed."
+      elsif event && !event.status.include?('OK')
+        Log.error event.message
+      else
+        Log.debug "Snapshot name: #{snapshot.name} delete requested."
+      end
+    end
   end
 end

data/lib/do_snapshot/cli.rb

@@ -1,9 +1,9 @@
 # -*- encoding : utf-8 -*-
 require 'thor'
 require 'do_snapshot'
-require 'do_snapshot/command'
-require 'do_snapshot/mail'
-require 'do_snapshot/log'
+require_relative 'command'
+require_relative 'mail'
+require_relative 'log'
 
 module DoSnapshot
   # CLI is here
@@ -137,16 +137,13 @@ module DoSnapshot
                   desc: 'DIGITAL_OCEAN_API_KEY. if you can\'t use environment.'
 
     def snap
-      Command.snap options, %w( log mail smtp trace digital_ocean_client_id digital_ocean_api_key )
+      Command.load_options options, %w( log mail smtp trace digital_ocean_client_id digital_ocean_api_key )
+      Command.snap
     rescue => e
       Command.fail_power_off(e) if [SnapshotCreateError, DropletShutdownError].include?(e.class)
       Log.error e.message
       backtrace(e) if options.include? 'trace'
-      if Mail.opts
-        Mail.opts[:subject] = 'Digital Ocean: Error.'
-        Mail.opts[:body] = 'Please check your droplets.'
-        Mail.notify
-      end
+      send_error
     end
 
     desc 'version, -V', 'Shows the version of the currently installed DoSnapshot gem'
@@ -160,6 +157,14 @@ module DoSnapshot
         Mail.smtp = options['smtp']
       end
 
+      def send_error
+        return unless Mail.opts
+
+        Mail.opts[:subject] = 'Digital Ocean: Error.'
+        Mail.opts[:body] = 'Please check your droplets.'
+        Mail.notify
+      end
+
       def set_logger
         Log.quiet = options['quiet']
         Log.verbose = options['trace']

data/lib/do_snapshot/command.rb

@@ -1,18 +1,12 @@
 # -*- encoding : utf-8 -*-
-require 'do_snapshot/api'
+require_relative 'api'
 
 module DoSnapshot
   # Our commands live here :)
   #
   class Command # rubocop:disable ClassLength
     class << self
-      def snap(options, skip)
-        return unless options
-
-        options.each_pair do |key, option|
-          send("#{key}=", option) unless skip.include?(key)
-        end
-
+      def snap
         Log.info 'Start performing operations'
         work_with_droplets
         Log.info 'All operations has been finished.'
@@ -20,6 +14,12 @@ module DoSnapshot
         Mail.notify if notify && !quiet
       end
 
+      def load_options(options = {}, skip = %w())
+        options.each_pair do |key, option|
+          send("#{key}=", option) unless skip.include?(key)
+        end if options
+      end
+
       def fail_power_off(e)
         return unless e && e.id
         api.start_droplet(e.id)
@@ -27,17 +27,52 @@ module DoSnapshot
         raise DropletFindError, e.message, e.backtrace
       end
 
-      protected
+      def stop_droplet(droplet)
+        Log.debug 'Shutting down droplet.'
+        api.stop_droplet(droplet.id) unless droplet.status.include? 'off'
+      end
 
-      attr_accessor :droplets, :exclude, :only
-      attr_accessor :keep, :quiet, :stop, :clean, :timeout, :delay
+      # Trying to create a snapshot.
+      #
+      def create_snapshot(droplet) # rubocop:disable MethodLength,Metrics/AbcSize
+        Log.info "Start creating snapshot for droplet id: #{droplet.id} name: #{droplet.name}."
 
-      attr_writer :notify, :threads, :api
+        today         = DateTime.now
+        name          = "#{droplet.name}_#{today.strftime('%Y_%m_%d')}"
+        # noinspection RubyResolve
+        snapshot_size = droplet.snapshots.size
+
+        Log.debug 'Wait until snapshot will be created.'
+
+        api.create_snapshot droplet.id, name
+
+        snapshot_size += 1
+
+        Log.info "Snapshot name: #{name} created successfully."
+        Log.info "Droplet id: #{droplet.id} name: #{droplet.name} snapshots: #{snapshot_size}."
+
+        # Cleanup snapshots.
+        cleanup_snapshots droplet, snapshot_size if clean
+      rescue => e
+        case e.class.to_s
+        when 'DoSnapshot::SnapshotCleanupError'
+          raise e.class, e.message, e.backtrace
+        else
+          raise SnapshotCreateError.new(droplet.id), e.message, e.backtrace
+        end
+      end
 
       def api
         @api ||= API.new(delay: delay, timeout: timeout)
       end
 
+      protected
+
+      attr_accessor :droplets, :exclude, :only
+      attr_accessor :keep, :quiet, :stop, :clean, :timeout, :delay
+
+      attr_writer :notify, :threads, :api
+
       def notify
         @notify ||= false
       end
@@ -69,12 +104,9 @@ module DoSnapshot
         droplets.each do |droplet|
           id = droplet.id.to_s
           next if exclude.include? id
-          next if !only.empty? && !only.include?(id)
-
-          Log.debug "Droplet id: #{id} name: #{droplet.name} "
-          instance = api.droplet id
+          next unless only.empty? || only.include?(id)
 
-          prepare_instance instance.droplet
+          prepare_droplet id, droplet.name
         end
       end
 
@@ -86,81 +118,50 @@ module DoSnapshot
 
       # Run threads
       #
-      def thread_runner(instance)
+      def thread_runner(droplet)
         threads << Thread.new do
-          Log.debug 'Shutting down droplet.'
-          stop_droplet instance
-          create_snapshot instance
+          stop_droplet droplet
+          create_snapshot droplet
         end
       end
 
-      # Preparing instance to take snapshot.
-      # Instance must be powered off first!
+      # Preparing droplet to take a snapshot.
+      # Droplet instance must be powered off first!
       #
-      def prepare_instance(instance)
-        return unless instance
-        Log.info "Preparing droplet id: #{instance.id} name: #{instance.name} to take snapshot."
-        return if too_much_snapshots(instance)
-        thread_runner(instance)
-      end
+      def prepare_droplet(id, name)
+        Log.debug "Droplet id: #{id} name: #{name} "
+        instance = api.droplet id
+        droplet = instance.droplet
 
-      def too_much_snapshots(instance)
-        # noinspection RubyResolve
-        if instance.snapshots.size >= keep
-          warning_size(instance.id, instance.name, keep)
-          return true if stop
-        end
-        false
-      end
-
-      def stop_droplet(instance)
-        api.stop_droplet(instance.id) unless instance.status.include? 'off'
+        return unless droplet
+        Log.info "Preparing droplet id: #{droplet.id} name: #{droplet.name} to take snapshot."
+        return if too_much_snapshots(droplet)
+        thread_runner(droplet)
       end
 
-      # Trying to create a snapshot.
-      #
-      def create_snapshot(instance) # rubocop:disable MethodLength
-        Log.info "Start creating snapshot for droplet id: #{instance.id} name: #{instance.name}."
-
-        today         = DateTime.now
-        name          = "#{instance.name}_#{today.strftime('%Y_%m_%d')}"
+      def too_much_snapshots(instance)
         # noinspection RubyResolve
-        snapshot_size = instance.snapshots.size
-
-        Log.debug 'Wait until snapshot will be created.'
-
-        api.create_snapshot instance.id, name
-
-        snapshot_size += 1
-
-        Log.info "Snapshot name: #{name} created successfully."
-        Log.info "Droplet id: #{instance.id} name: #{instance.name} snapshots: #{snapshot_size}."
-
-        # Cleanup snapshots.
-        cleanup_snapshots instance, snapshot_size if clean
-      rescue => e
-        case e.class.to_s
-        when 'DoSnapshot::SnapshotCleanupError'
-          raise e.class, e.message, e.backtrace
-        else
-          raise SnapshotCreateError.new(instance.id), e.message, e.backtrace
-        end
+        return false unless instance.snapshots.size >= keep
+        warning_size(instance.id, instance.name, keep)
+        stop ? true : false
       end
 
       # Cleanup our snapshots.
       #
-      def cleanup_snapshots(instance, size)
+      def cleanup_snapshots(droplet, size) # rubocop:disable Metrics/AbcSize
         return unless size > keep
 
-        warning_size(instance.id, instance.name, size)
+        warning_size(droplet.id, droplet.name, size)
 
-        Log.debug "Cleaning up snapshots for droplet id: #{instance.id} name: #{instance.name}."
+        Log.debug "Cleaning up snapshots for droplet id: #{droplet.id} name: #{droplet.name}."
 
-        api.cleanup_snapshots(instance, size - keep - 1)
+        api.cleanup_snapshots(droplet, size - keep - 1)
       rescue => e
         raise SnapshotCleanupError, e.message, e.backtrace
       end
 
+      # Helpers
+      #
       def warning_size(id, name, keep)
         message = "For droplet with id: #{id} and name: #{name} the maximum number #{keep} of snapshots is reached."
         Log.warning message

data/lib/do_snapshot/mail.rb

@@ -1,7 +1,7 @@
 # -*- encoding : utf-8 -*-
 require 'date'
 require 'pony'
-require 'do_snapshot/core_ext/hash'
+require_relative 'core_ext/hash'
 
 module DoSnapshot
   # Shared mailer.

data/lib/do_snapshot/version.rb

@@ -2,5 +2,5 @@
 # Current version
 #
 module DoSnapshot
-  VERSION = '0.0.12'
+  VERSION = '0.0.13'
 end

data/lib/do_snapshot.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
-require 'do_snapshot/version'
+require_relative 'do_snapshot/version'
 
 # Used primary for creating snapshot's as backups for DigitalOcean
 #

data/spec/do_snapshot/api_spec.rb

@@ -207,7 +207,7 @@ describe DoSnapshot::API do
         expect(a_request(:get, image_destroy_url))
           .to have_been_made
         expect(a_request(:get, image_destroy2_url))
-        .to have_been_made
+          .to have_been_made
       end
     end
   end

data/spec/do_snapshot/cli_spec.rb

@@ -9,7 +9,6 @@ describe DoSnapshot::CLI do
   subject(:api)     { DoSnapshot::API }
 
   describe '.snap' do
-
     it 'with exclude' do
       excluded_droplets = %w( 100824 )
       stub_all_api(%w(100825 100823))

data/spec/do_snapshot/command_spec.rb

@@ -65,7 +65,47 @@ describe DoSnapshot::Command do
     end
   end
 
-  describe  '.fail_power_off' do
+  describe '.stop_droplet' do
+    it 'when raised with error' do
+      stub_droplet_stop_fail(droplet_id)
+      load_options
+      instance = cmd.api.droplet droplet_id
+      droplet = instance.droplet
+      expect { cmd.stop_droplet(droplet) }
+        .to raise_error(DoSnapshot::DropletShutdownError)
+    end
+
+    it 'when stopped' do
+      stub_droplet_stop(droplet_id)
+      load_options
+      instance = cmd.api.droplet droplet_id
+      droplet = instance.droplet
+      expect { cmd.stop_droplet(droplet) }
+        .not_to raise_error
+    end
+  end
+
+  describe '.create_snapshot' do
+    it 'when raised with error' do
+      stub_droplet_snapshot_fail(droplet_id, snapshot_name)
+      load_options
+      instance = cmd.api.droplet droplet_id
+      droplet = instance.droplet
+      expect { cmd.create_snapshot(droplet) }
+        .to raise_error(DoSnapshot::SnapshotCreateError)
+    end
+
+    it 'when snapshot is created' do
+      stub_droplet_snapshot(droplet_id, snapshot_name)
+      load_options
+      instance = cmd.api.droplet droplet_id
+      droplet = instance.droplet
+      expect { cmd.create_snapshot(droplet) }
+        .not_to raise_error
+    end
+  end
+
+  describe '.fail_power_off' do
     it 'when success' do
       stub_droplet_inactive(droplet_id)
 
@@ -83,7 +123,7 @@ describe DoSnapshot::Command do
       expect(log.buffer)
         .to include 'Droplet id: 100823 is Failed to Power Off.'
       expect(log.buffer)
-      .to include 'Droplet Not Found'
+        .to include 'Droplet Not Found'
     end
 
     it 'with start error' do
@@ -105,9 +145,14 @@ describe DoSnapshot::Command do
     log.quiet = true
   end
 
-  def snap_runner(options = nil)
+  def load_options(options = nil)
     options ||= default_options
     cmd.send('api=', nil)
-    cmd.snap(options, [:log, :mail, :smtp, :trace, :digital_ocean_client_id, :digital_ocean_api_key])
+    cmd.load_options(options, [:log, :mail, :smtp, :trace, :digital_ocean_client_id, :digital_ocean_api_key])
+  end
+
+  def snap_runner
+    load_options
+    cmd.snap
   end
 end

data/spec/do_snapshots_spec.rb

@@ -30,7 +30,6 @@ describe DoSnapshot do
     subject(:error) { described_class }
 
     it 'should be' do
-
       expect { error.new }
         .not_to raise_error
     end

data/spec/shared/api_helpers.rb

@@ -2,7 +2,6 @@
 require 'spec_helper'
 
 shared_context 'api_helpers' do
-
   # List of droplets
   #
   def stub_droplets

data/spec/spec_helper.rb

@@ -8,10 +8,9 @@ end
 require 'do_snapshot/cli'
 require 'webmock/rspec'
 require 'digitalocean'
-require 'shared/api_helpers'
-require 'shared/uri_helpers'
-require 'shared/environment'
-require 'shared/uri_helpers'
+require_relative 'shared/api_helpers'
+require_relative 'shared/uri_helpers'
+require_relative 'shared/environment'
 require 'do_snapshot/core_ext/hash'
 
 WebMock.disable_net_connect!(allow_localhost: true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: do_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Alexander Merkulov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-24 00:00:00.000000000 Z
+date: 2015-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: digitalocean
@@ -263,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A command-line snapshot maker for your DigitalOcean droplets. Fully Automated.