do_snapshot 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: e50e39afd9fac811be4207a14b617657b693cd82
-  data.tar.gz: 6f986b2879036aa093088593a553c2e87eb0f6d6
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjljNmNiZDVlYmJkYmMzYjE2ZDY4NWQ3ZTYyMzAwZWRiODdmZTEwMg==
+  data.tar.gz: !binary |-
+    YmVmZGFjMzIwNjZmZDY1NjA3M2QzMDI0OGFmZDJkYTk3NzM0NmE2ZA==
 SHA512:
-  metadata.gz: 30c103ccbeb7b93993a0f675cb084c367aabf5f1bd6a7e996a16cd089ce1ad93048d421b8abd3e1cf815afd960bf891bd3ed9ae42d7cd5c85fc7df99e6e186e6
-  data.tar.gz: 70d05a6af6884d49e78aa232a62976e76a0b6743f677f4b7ea201d325bc06c0ab61e4cd0e27d536dacb8134e21c09c885c8703f22f5bdcde65ed9cb8d49c2e30
+  metadata.gz: !binary |-
+    NGMzMjdiZTg5ODlmNzZiZWE2YzVjY2YwMDI4Y2U0YjE2ODQzYWQwZTI2N2U2
+    Mzc0MTUxZWUzODFkYjBkMGIyNGIwOWU3MGY2Y2EzNzJmNDgwNzQ1M2E2NWYx
+    MjBkYWY2MTIxNTNmMWZmN2U1MDMzNjBkNGIxODQwOWNiZGI5MmQ=
+  data.tar.gz: !binary |-
+    MTY2YmI2NWQ1ZWYxZWYwMGNjMjYzMzk1NjU5M2Q2YjM0NGNjNjU4ZGVjOTc2
+    YWZjZWEzMDYzZDE0Yjk4Njg3ZWEyNDQwZDVmODEzN2UwNjk1OTYyZmI4NGJj
+    MGQ4NGQzMGZhNjJhYTZiMzcyOGZhNjNlNWZmNTJjNjNiNDQwMTg=

data/.gitignore

@@ -14,7 +14,10 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
-tmp
+log/*
+!log/.keep
+tmp/*
+!tmp/.keep
 *.bundle
 *.so
 *.o
@@ -22,4 +25,4 @@ tmp
 mkmf.log
 .idea
 .irb_history
-
+.ruby-version

data/.rubocop.yml

@@ -9,3 +9,6 @@ SingleSpaceBeforeFirstArg:
 
 TrailingComma:
   Enabled: false
+AllCops:
+  Exclude:
+    - '*.gemspec'

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 1.9.3
+  - jruby-19mode
+notifications:
+  email:
+    - api@mrcr.ru
+script:
+    - bundle exec rubocop

data/README.md

@@ -1,5 +1,12 @@
 # DoSnapshot
 
+[![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)
+[![Dependency Status](https://gemnasium.com/merqlove/do_snapshot.svg)](https://gemnasium.com/merqlove/do_snapshot)
+[![Coverage Status](https://coveralls.io/repos/merqlove/do_snapshot/badge.png?branch=master)](https://coveralls.io/r/merqlove/do_snapshot?branch=master)
+[![Inline docs](http://inch-ci.org/github/merqlove/do_snapshot.png?branch=master)](http://inch-ci.org/github/merqlove/do_snapshot)
+[![Code Climate](https://codeclimate.com/github/merqlove/do_snapshot.png)](https://codeclimate.com/github/merqlove/do_snapshot)
+
 You can use this gem to backup's DigitalOcean droplet's via snapshot method.
 
 Here some features:
@@ -10,6 +17,7 @@ Here some features:
 - Mail notifications when fail or maximum of snapshots is reached for one or multiple droplets.
 - Custom mail settings (You can set [Pony](https://github.com/benprew/pony) mail settings).
 - Stop mode (when you don't want to create new snapshots when maximum is reached).
+- Timeout for bad requests & uncaught loops.
 - Logging into selected directory.
 - Verbose mode for research.
 - Quiet mode for silence.
@@ -20,6 +28,10 @@ There not so much of dependencies:
 - `Thor` for CLI.
 - `Pony` for mail notifications.
 
+## Compatibility
+
+Ruby versions: 1.9.3 and higher.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -104,6 +116,10 @@ For working mailer you need to set e-mail settings via run options.
       -e, [--exclude=123456 123456 123456]                           # Except some droplets.
       -k, [--keep=5]                                                 # How much snapshots you want to keep?
                                                                      # Default: 10
+      -d, [--delay=5]                                                # Delay between snapshot operation status requests.
+                                                                     # Default: 10                                                                    
+          [--timeout=250]                                            # Timeout in sec's for events like Power Off or Create Snapshot.
+                                                                     # Default: 180                                                                     
       -m, [--mail=to:yourmail@example.com]                           # Receive mail if fail or maximum is reached.
       -t, [--smtp=user_name:yourmail@example.com password:password]  # SMTP options.
       -l, [--log=/Users/someone/.do_snapshot/main.log]               # Log file path. By default logging is disabled.

data/Rakefile

@@ -1 +1,7 @@
+# -*- encoding : utf-8 -*-
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/do_snapshot

@@ -1,11 +1,14 @@
 #!/usr/bin/env ruby
+# -*- encoding : utf-8 -*-
+
+Signal.trap('INT') { exit 1 }
 
 # resolve bin path, ignoring symlinks
 require 'pathname'
 bin_file = Pathname.new(__FILE__).realpath
 
 # add self to libpath
-$:.unshift File.expand_path('../../lib', bin_file)
+$LOAD_PATH.unshift File.expand_path('../../lib', bin_file)
 
 require 'do_snapshot/cli'
 

data/do_snapshot.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = DoSnapshot::VERSION
   spec.authors       = ['Alexander Merkulov']
   spec.email         = ['sasha@merqlove.ru']
-  spec.summary       = %q{Snapshot creator for Digital Ocean droplets. Multi-threading. Auto-cleanup. Cron optimized.}
-  spec.description   = %q{Snapshot creator for Digital Ocean droplets. Multi-threading inside. Auto-cleanup feature. No matter how much droplets you have. Cron optimized.}
+  spec.summary       = 'Snapshot creator for Digital Ocean droplets. Multi-threading. Auto-cleanup. Cron optimized.'
+  spec.description   = 'Snapshot creator for Digital Ocean droplets. Multi-threading inside. Auto-cleanup feature. No matter how much droplets you have. Cron optimized.'
   spec.homepage      = 'http://github.com/merqlove/do_snapshot'
   spec.license       = 'MIT'
 
@@ -19,9 +19,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'digitalocean', '~> 1.2'
-  spec.add_dependency 'thor'
-  spec.add_dependency 'pony'
+  spec.add_dependency 'thor', '~> 0.19.1'
+  spec.add_dependency 'pony', '~> 1.1.0'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rspec-core', '~> 3.0.2'
+  spec.add_development_dependency 'rspec-expectations', '~> 3.0.2'
+  spec.add_development_dependency 'rspec-mocks', '~> 3.0.2'
+  spec.add_development_dependency 'webmock', '~> 1.18.0'
+  spec.add_development_dependency 'coveralls', '~> 0.7.0'
 end

data/lib/do_snapshot.rb

@@ -1,121 +1,64 @@
+# -*- encoding : utf-8 -*-
 require 'do_snapshot/version'
-require 'thor'
-require 'logger'
-require 'date'
-require 'pony'
-require 'do_snapshot/core_ext/hash'
 
 # Used primary for creating snapshot's as backups for DigitalOcean
 #
 module DoSnapshot
-  # Set multiple Errors with `id` @param
+  # Standard Request Exception. When we don't need droplet instance id.
   #
-  class DigitalOceanError < StandardError
+  class RequestError < StandardError; end
+
+  # Base Exception for cases when we need id for log and/or something actions.
+  #
+  class RequestActionError < RequestError
     attr_reader :id
-    # @param [Object] id
-    def initialize(id)
-      @id = id
+
+    def initialize(*args)
+      @id = args[0]
     end
   end
-  class DropletShutdownError < DigitalOceanError; end
-  class SnapshotCreateError < DigitalOceanError; end
-  class SnapshotCleanupError < DigitalOceanError; end
 
-  # Shared logger
+  # Droplet must be powered off before snapshot operation!
   #
-  class Log
-    class << self
-      attr_accessor :logger
-      attr_accessor :shell
-      attr_accessor :mail
-      attr_accessor :quiet
-      attr_accessor :verbose
-      attr_writer :smtp
-
-      def smtp
-        @smtp ||= {}
-      end
-
-      def log(type, message)
-        buffer << message
-        logger.send(type, message) if logger
-
-        say message, color(type) unless type == :debug && !debug?
-      end
-
-      def color(type)
-        case type
-        when :debug
-          :white
-        when :error
-          :red
-        when :warn
-          :yellow
-        else
-          :green
-        end
-      end
-
-      def info(message)
-        log :info, message
-      end
-
-      def warning(message)
-        log :warn, message
-      end
-
-      def error(message)
-        log :error, message
-      end
-
-      def debug(message)
-        log :debug, message
-      end
-
-      def say(message, color)
-        shell.say message, color if shell
-      end
-
-      def debug?
-        logger && logger.level == Logger::DEBUG
-      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
-        return unless mail
-
-        mail.symbolize_keys!
-        smtp.symbolize_keys!
-
-        notify_init
-
-        Log.debug 'Sending e-mail notification.'
-        # Look into your inbox :)
-        Pony.mail(mail)
-      end
-
-      protected
+  class DropletShutdownError < RequestActionError
+    def initialize(*args)
+      Log.error "Droplet id: #{args[0]} is Failed to Power Off."
+      super
+    end
+  end
 
-      def notify_init
-        mail[:subject] = 'Digital Ocean: maximum snapshots is reached.' unless mail[:subject]
-        mail[:body]    = "Please cleanup your Digital Ocean account.\nSnapshot maximum is reached." unless mail[:body]
-        mail[:from]    = 'noreply@someonelse.com' unless mail[:from]
-        mail[:to]      = 'to@someonelse.com' unless mail[:to]
-        mail[:via]     = :smtp unless mail[:via]
-        mail[:body]    = "#{mail[:body]}\n\nTrace: #{DateTime.now}\n#{buffer.join("\n")}"
-        smtp[:domain]  = 'localhost.localdomain' unless smtp[:domain]
-        smtp[:port]    = '25' unless smtp[:port]
+  # When snapshot create operation is failed.
+  # It can be because of something wrong with droplet or Digital Ocean API.
+  #
+  class SnapshotCreateError < RequestActionError
+    def initialize(*args)
+      Log.error "Droplet id: #{args[0]} is Failed to Snapshot."
+      super
+    end
+  end
 
-        mail[:via_options] = smtp
-      end
+  # When Digital Ocean API say us that not found droplet by id.
+  # Or something wrong happened.
+  #
+  class DropletFindError < RequestError
+    def initialize(*args)
+      Log.error 'Droplet Not Found'
+      super
+    end
+  end
 
-      attr_writer :buffer
-      def buffer
-        @buffer ||= %w()
-      end
+  # When Digital Ocean API cannot retrieve list of droplets.
+  # Sometimes it connection problem or DigitalOcean API maintenance.
+  #
+  class DropletListError < RequestError
+    def initialize(*args)
+      Log.error 'Droplet Listing is failed to retrieve'
+      super
     end
   end
+
+  # When Digital Ocean API cannot remove old images.
+  # Sometimes it connection problem or DigitalOcean API maintenance.
+  #
+  class SnapshotCleanupError < RequestError; end
 end

data/lib/do_snapshot/api.rb

@@ -0,0 +1,140 @@
+# -*- encoding : utf-8 -*-
+require 'digitalocean'
+
+module DoSnapshot
+  # API for CLI commands
+  # Operating with Digital Ocean.
+  #
+  class API
+    attr_accessor :delay
+    attr_accessor :timeout
+
+    def initialize(options)
+      set_id
+      options.each_pair do |key, option|
+        send("#{key}=", option)
+      end
+    end
+
+    # Get single droplet from DigitalOcean
+    #
+    def droplet(id)
+      # noinspection RubyResolve
+      instance = Digitalocean::Droplet.find(id)
+      fail DropletFindError, instance.message unless instance.status.include? 'OK'
+      instance
+    end
+
+    # Get droplets list from DigitalOcean
+    #
+    def droplets
+      # noinspection RubyResolve
+      droplets = Digitalocean::Droplet.all
+      fail DropletListError, droplets.message unless droplets.status.include? 'OK'
+      droplets
+    end
+
+    # Power On request for Droplet
+    #
+    def start_droplet(id)
+      # noinspection RubyResolve
+      instance = Digitalocean::Droplet.find(id)
+
+      fail unless instance.status.include? 'OK'
+
+      if instance.droplet.status.include? 'active'
+        Log.error 'Droplet is still running.'
+      else
+        power_on id
+      end
+    end
+
+    # Power Off request for Droplet
+    #
+    def stop_droplet(id)
+      # noinspection RubyResolve,RubyResolve
+      event = Digitalocean::Droplet.power_off(id)
+
+      fail event.message unless event.status.include? 'OK'
+
+      # noinspection RubyResolve
+      wait_event(event.event_id)
+    rescue => e
+      raise DropletShutdownError.new(id), e.message, e.backtrace
+    end
+
+    # Sending event to create snapshot via DigitalOcean API and wait for success
+    #
+    def create_snapshot(id, name)
+      # noinspection RubyResolve,RubyResolve
+      event = Digitalocean::Droplet.snapshot(id, name: name)
+
+      if !event
+        fail 'Something wrong with DigitalOcean or with your connection :)'
+      elsif event && !event.status.include?('OK')
+        fail event.message
+      end
+
+      # noinspection RubyResolve
+      wait_event(event.event_id)
+    end
+
+    # Cleanup our snapshots.
+    #
+    def cleanup_snapshots(instance, size) # rubocop:disable MethodLength
+      (0..size).each do |i|
+        # noinspection RubyResolve
+        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
+      end
+    end
+
+    protected
+
+    # Set id's of Digital Ocean API.
+    #
+    def set_id
+      Log.debug 'Setting DigitalOcean Id\'s.'
+      Digitalocean.client_id = ENV['DIGITAL_OCEAN_CLIENT_ID']
+      Digitalocean.api_key = ENV['DIGITAL_OCEAN_API_KEY']
+    end
+
+    # Waiting for event exit
+    def wait_event(id)
+      time = Time.now.to_f
+      sleep delay until get_event_status(id, time)
+    end
+
+    # Looking for event status.
+    # Before snapshot we to know that machine has powered off.
+    #
+    def get_event_status(id, time)
+      return true if (Time.now.to_f - time) > timeout
+      event = Digitalocean::Event.find(id)
+      fail event.message unless event.status.include?('OK')
+      # noinspection RubyResolve,RubyResolve
+      event.event.percentage && event.event.percentage.include?('100') ? true : false
+    end
+
+    # Request Power On for droplet
+    #
+    def power_on(id)
+      # noinspection RubyResolve
+      event = Digitalocean::Droplet.power_on(id)
+      case event && event.status
+      when 'OK'
+        Log.info 'Power On has been requested.'
+      else
+        Log.error 'Power On failed to request.'
+      end
+    end
+  end
+end