do_snapshot 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5378c837dccf17028be844060295b82be0349b8
-  data.tar.gz: 4c548fa5590fb87b696c7dba43a6fa5330e2dc32
+  metadata.gz: daa05c7961b1c4dbf9275fb6242817289a52f9c8
+  data.tar.gz: fc001ff0e7c71e660220972f9494106d1293e162
 SHA512:
-  metadata.gz: f97a8affb32bd8e371df9ec8646cc46ac6ef66f624bc9939bc156a6ce703b7055096ab0b4cfc15c1c162e25a55abf333578ce977bb0afdaee6ca662dfa11b643
-  data.tar.gz: b67bd75db1fe228f4e1cbd624a5ba4b2fa0f3e0c8e827e1cdcac2f8af38dab941bfb68f970a8ff2b9faaf097acb5fef9c62e33ee3d65c97a60217d6b54001bf7
+  metadata.gz: a1fd3c4e7b308883ffd689aadfaed8cc45295879ad471636ce0735e63f3e426387caca44ed110f5de6fc3190871f953c11cafd27121e45038c4bf7aa51bd1dc1
+  data.tar.gz: 754e0414a459cc7125ca7991068cde13f3e12cfe82adbd8c07ad62f9d07ab6cd662c1a5a2a794b1320993d3fee816813163548304e5dd268767e2625a606cf52

data/README.md

@@ -1,4 +1,6 @@
 # DoSnapshot CLI 
+
+[![Join the chat at https://gitter.im/merqlove/do_snapshot](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/merqlove/do_snapshot?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [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)
@@ -26,7 +28,9 @@ Here some features:
 
 ## Compatibility
 
-Ruby versions: 1.9.3 and higher. JRuby in 1.9 mode is also supported.
+Ruby versions 2.0.0 and higher. JRuby 9.0.0.0 or later is also supported.
+
+*Ruby versions 1.9.3 or less and JRuby in 1.9-mode supported in releases 0.0.14 or earlier.*
 
 <img src="https://raw.githubusercontent.com/merqlove/do_snapshot/master/assets/example.png" style="max-width:100%" alt="DoSnaphot example">
 
@@ -73,23 +77,37 @@ Mainly it's pretty simple:
 
     $ do_snapshot --only 123456 -k 5 -c -v
 
-### Setup
+### Setup 
 
-How to set DigitalOcean API keys: 
+### Digitalocean API V1:
+You'll need to generate an access token in Digital Ocean's control panel at https://cloud.digitalocean.com/api_access
 
     $ export DIGITAL_OCEAN_CLIENT_ID="SOMEID"
     $ export DIGITAL_OCEAN_API_KEY="SOMEKEY"
- 
+    
 If you want to set keys without environment, than set it via options when you run do_snapshot:
 
     $ do_snapshot --digital-ocean-client-id YOURLONGAPICLIENTID --digital-ocean-api-key YOURLONGAPIKEY
+    
+### Digitalocean API V2:
+You'll need to generate an access token in Digital Ocean's control panel at https://cloud.digitalocean.com/settings/applications
+    
+    $ export DIGITAL_OCEAN_ACCESS_TOKEN="SOMETOKEN"
+    
+If you want to set keys without environment, than set it via options when you run do_snapshot:
+    
+    $ do_snapshot --digital-ocean-access-token YOURLONGTOKEN    
 
 ### How-To (Here is also [Longren Tutorial](https://longren.io/automate-making-snapshots-of-your-digitalocean-droplets/))
  
 Here we `keeping` only 5 **latest** snapshots and cleanup older after new one is created. If creation of snapshots failed no one will be deleted. By default we keeping `10` droplets.
 
     $ do_snapshot --keep 5 -c
+
+Using API V2:
   
+    $ do_snapshot -p 2
+    
 Keep latest 3 from selected droplet:
   
     $ do_snapshot --only 123456 --keep 3
@@ -141,6 +159,8 @@ For working mailer you need to set e-mail settings via run options.
     aliases: s, snap, create
     
     Options:
+      -p, [--protocol=1]                                             # Select api version.
+                                                                     # Default: 1
       -o, [--only=123456 123456 123456]                              # Select some droplets.
       -e, [--exclude=123456 123456 123456]                           # Except some droplets.
       -k, [--keep=5]                                                 # How much snapshots you want to keep?
@@ -148,7 +168,7 @@ For working mailer you need to set e-mail settings via run options.
       -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: 600                                                                     
+                                                                     # Default: 3600                                                                     
       -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.
@@ -156,6 +176,7 @@ For working mailer you need to set e-mail settings via run options.
       -s, [--stop], [--no-stop]                                      # Stop creating snapshots if maximum is reached.
       -v, [--trace], [--no-trace]                                    # Verbose mode.
       -q, [--quiet], [--no-quiet]                                    # Quiet mode. If don't need any messages in console.
+          [--digital-ocean-access-token=YOURLONGAPITOKEN]            # DIGITAL_OCEAN_ACCESS_TOKEN. if you can't use environment.
           [--digital-ocean-client-id=YOURLONGAPICLIENTID]            # DIGITAL_OCEAN_CLIENT_ID. if you can't use environment.
           [--digital-ocean-api-key=YOURLONGAPIKEY]                   # DIGITAL_OCEAN_API_KEY. if you can't use environment.    
     
@@ -167,7 +188,8 @@ For working mailer you need to set e-mail settings via run options.
 ## Dependencies:
 
 - [Thor](https://github.com/erikhuda/thor) for CLI.
-- [Digitalocean](https://github.com/scottmotte/digitalocean) for API requests.
+- [Digitalocean](https://github.com/scottmotte/digitalocean) for API V1 requests.
+- [DropletKit](https://github.com/digitalocean/droplet_kit) for API V2 requests.
 - [Pony](https://github.com/benprew/pony) for mail notifications.
 
 ## Contributing
@@ -182,6 +204,6 @@ For working mailer you need to set e-mail settings via run options.
 
     $ rake spec 
 
-Copyright (c) 2014 Alexander Merkulov
+Copyright (c) 2015 Alexander Merkulov
 
 MIT License

data/lib/do_snapshot/adapter.rb

@@ -0,0 +1,21 @@
+require_relative 'adapter/abstract'
+
+require_relative 'adapter/digitalocean'
+require_relative 'adapter/digitalocean_v2'
+
+module DoSnapshot
+  # Adapter interface for API connections
+  # Ability to select DigitalOcean API versions.
+  #
+  module Adapter
+    def api(protocol, options)
+      case protocol
+      when 2
+        return DigitaloceanV2.new(options)
+      else
+        return Digitalocean.new(options)
+      end
+    end
+    module_function :api
+  end
+end

data/lib/do_snapshot/adapter/abstract.rb

@@ -0,0 +1,44 @@
+# -*- encoding : utf-8 -*-
+
+module DoSnapshot
+  module Adapter
+    # API for CLI commands
+    # Operating with Digital Ocean.
+    #
+    class Abstract
+      attr_accessor :delay
+      attr_accessor :timeout
+
+      def initialize(options)
+        check_keys
+        set_id
+        options.each_pair do |key, option|
+          send("#{key}=", option)
+        end
+      end
+
+      protected
+
+      def set_id; end
+
+      def check_keys; end
+
+      # Waiting for event exit
+      def wait_event(id)
+        Log.debug "Event Id: #{id}"
+        time = Time.now
+        sleep(delay) until get_event_status(id, time)
+      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
+end

data/lib/do_snapshot/adapter/digitalocean.rb

@@ -0,0 +1,133 @@
+# -*- encoding : utf-8 -*-
+require 'digitalocean_c' unless defined?(::DigitaloceanC)
+
+module DoSnapshot
+  module Adapter
+    # API for CLI commands
+    # Operating with Digital Ocean.
+    #
+    class Digitalocean < Abstract
+      # Get single droplet from DigitalOcean
+      #
+      def droplet(id)
+        # noinspection RubyResolve
+        response = ::DigitaloceanC::Droplet.find(id)
+        fail DropletFindError, response.message unless response.status.include? 'OK'
+        response.droplet
+      end
+
+      # Get droplets list from DigitalOcean
+      #
+      def droplets
+        # noinspection RubyResolve
+        response = ::DigitaloceanC::Droplet.all
+        fail DropletListError, response.message unless response.status.include? 'OK'
+        response.droplets
+      end
+
+      def snapshots(instance)
+        instance.snapshots
+      end
+
+      # Power On request for Droplet
+      #
+      def start_droplet(id)
+        # noinspection RubyResolve
+        instance = droplet(id)
+
+        if instance.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 = ::DigitaloceanC::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 = ::DigitaloceanC::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 = ::DigitaloceanC::Image.destroy(snapshot.id)
+
+          after_cleanup(instance.id, instance.name, snapshot, event)
+        end
+      end
+
+      def check_keys
+        Log.debug 'Checking DigitalOcean Id\'s.'
+        %w( DIGITAL_OCEAN_CLIENT_ID DIGITAL_OCEAN_API_KEY ).each do |key|
+          Log.error "You must have #{key} in environment or set it via options." if ENV[key].blank?
+        end
+      end
+
+      protected
+
+      # Set id's of Digital Ocean API.
+      #
+      def set_id
+        Log.debug 'Setting DigitalOcean Id\'s.'
+        ::DigitaloceanC.client_id = ENV['DIGITAL_OCEAN_CLIENT_ID']
+        ::DigitaloceanC.api_key = ENV['DIGITAL_OCEAN_API_KEY']
+      end
+
+      # Looking for event status.
+      # Before snapshot we to know that machine has powered off.
+      #
+      def get_event_status(id, time)
+        if (Time.now - time) > @timeout
+          Log.debug "Event #{id} finished by timeout #{time}"
+          return true
+        end
+
+        event = ::DigitaloceanC::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 = ::DigitaloceanC::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
+end

data/lib/do_snapshot/adapter/digitalocean_v2.rb

@@ -0,0 +1,145 @@
+# -*- encoding : utf-8 -*-
+require 'droplet_kit' unless defined?(::DropletKit)
+
+module DoSnapshot
+  module Adapter
+    # API for CLI commands
+    # Operating with Digital Ocean.
+    #
+    class DigitaloceanV2 < Abstract
+      attr_reader :client
+
+      # Get single droplet from DigitalOcean
+      #
+      def droplet(id)
+        # noinspection RubyResolve
+        response = client.droplets.find(id: id)
+        fail DropletFindError unless response
+        response
+      rescue => e
+        raise DropletFindError, e.message
+      end
+
+      # Get droplets list from DigitalOcean
+      #
+      def droplets
+        # noinspection RubyResolve
+        response = client.droplets.all
+        fail DropletListError unless response
+        response.each
+      rescue => e
+        raise DropletListError, e.message
+      end
+
+      def snapshots(instance)
+        instance.snapshot_ids
+      end
+
+      # Power On request for Droplet
+      #
+      def start_droplet(id)
+        # noinspection RubyResolve
+        instance = droplet(id)
+
+        if instance.status && instance.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 = client.droplet_actions.power_off(droplet_id: id)
+
+        # noinspection RubyResolve
+        wait_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 = client.droplet_actions.snapshot(droplet_id: id, name: name)
+
+        # noinspection RubyResolve
+        wait_event(event.id)
+      rescue => e
+        raise e.message, e.backtrace
+      end
+
+      # Cleanup our snapshots.
+      #
+      def cleanup_snapshots(instance, size) # rubocop:disable MethodLength
+        (0..size).each do |i|
+          # noinspection RubyResolve
+          snapshot = instance.snapshot_ids[i]
+          event = client.images.delete(id: snapshot)
+
+          unless event.is_a?(TrueClass)
+            Log.debug event
+            event = false
+          end
+
+          after_cleanup(instance.id, instance.name, snapshot, event)
+        end
+      end
+
+      def check_keys
+        Log.debug 'Checking DigitalOcean Access Token.'
+        %w( DIGITAL_OCEAN_ACCESS_TOKEN ).each do |key|
+          Log.error "You must have #{key} in environment or set it via options." if ENV[key].blank?
+        end
+      end
+
+      # Set id's of Digital Ocean API.
+      #
+      def set_id
+        Log.debug 'Setting DigitalOcean Access Token.'
+        @client = ::DropletKit::Client.new(access_token: ENV['DIGITAL_OCEAN_ACCESS_TOKEN'])
+      end
+
+      protected
+
+      def after_cleanup(droplet_id, droplet_name, snapshot, event)
+        if !event
+          Log.error "Destroy of snapshot #{snapshot} for droplet id: #{droplet_id} name: #{droplet_name} is failed."
+        else
+          Log.debug "Snapshot: #{snapshot} delete requested."
+        end
+      end
+
+      # Looking for event status.
+      # Before snapshot we to know that machine has powered off.
+      #
+      def get_event_status(id, time)
+        if (Time.now - time) > @timeout
+          Log.debug "Event #{id} finished by timeout #{time}"
+          return true
+        end
+
+        action = client.actions.find(id: id)
+        # noinspection RubyResolve,RubyResolve
+        action.status.include?('completed') ? true : false
+      rescue => e
+        raise e.message, e.backtrace
+      end
+
+      # Request Power On for droplet
+      #
+      def power_on(id)
+        # noinspection RubyResolve
+        event = client.droplet_actions.power_on(droplet_id: id)
+        if event.status.include?('in-progress')
+          Log.info 'Power On has been requested.'
+        else
+          Log.error 'Power On failed to request.'
+        end
+      end
+    end
+  end
+end