do_snapshot 0.6.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95c8aa6d9470c9eae1cc0f27b822e15b17d2bb61
-  data.tar.gz: 90ace05ddc9bf40be16447f3880390a9168eb072
+  metadata.gz: eb7ae5cc912690b2cd5850c46fd364ced760b5dd
+  data.tar.gz: a1664c690b7940bc93f6ae58904ff111af531551
 SHA512:
-  metadata.gz: b460b5736c090dd0345989d134068442d1589759e05f118e8e30b9a910d4e5acc80987640ae27f642ff536d872ae088c02383ad690b739dd9407ca6bec32246d
-  data.tar.gz: d1a35778507e3d9379df0678aa78186ca3a079507c163e7ac8a752a5e39ec2f744eba576a34b9db27a41bae25074de4211cf59875f8dead74cadfd3d582e86e7
+  metadata.gz: b2554982045d10d24c5d054ae03dd51cd7745412d64eb5da06dca91d0b3b46e5391ef71725ff3f8407ac86c9a4564963e362e6f2f8c3819db0fde574dcd0fe26
+  data.tar.gz: eb9d432913d910285373520713a695ac5572303517de158a13921f5d8bad1739c8bcc0b505d7a349c1b58454350c4ede9992c04052115fdbcece902353dc4c1f

data/README.md

@@ -13,6 +13,7 @@
 Use this tool to backup DigitalOcean droplet's via snapshot method, on the fly!
 
 ## API Changes: 
+- 20.08.17: Change `Barge` to `DropletKit`. Release `1.0.0`.   
 - 03.08.16: DO now automagically keeps our droplets running when snapshot is processing, so:  
   Added options `--shutdown`, `--no-shutdown`.    
   `shutdown` now disabled by default, no downtime anymore, `YES`!  
@@ -36,7 +37,13 @@ Here are some features:
 
 ## Compatibility
 
-Ruby versions 1.9.3 and higher. JRuby 1.7, 9.0.0.0 or later is also supported.
+From `1.0.0`:
+- Ruby version 2.0.0 or higher
+- JRuby 9.1.0.0 or higher
+
+Prior to `0.6.4`:
+- Ruby version 1.9.3 or higher
+- JRuby 1.7, 9.0.0.0 or higher
 
 <img src="https://raw.githubusercontent.com/merqlove/do_snapshot/master/assets/example.png" style="max-width:100%" alt="DoSnaphot example">
 
@@ -195,7 +202,7 @@ Support this project and others by [merqlove](https://gratipay.com/~merqlove/) v
 ## Dependencies:
 
 - [Thor](https://github.com/erikhuda/thor) for CLI.
-- [Barge](https://github.com/blom/barge) for API V2 requests.
+- [DropletKit](https://github.com/digitalocean/droplet_kit) for API V2 requests.
 - [Pony](https://github.com/benprew/pony) for mail notifications.
 
 ## Contributing

data/bin/do_snapshot

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 
 Signal.trap('INT') { exit 1 }
 

data/lib/do_snapshot.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 require_relative 'do_snapshot/version'
 require_relative 'do_snapshot/configuration'
 

data/lib/do_snapshot/adapter.rb

@@ -1,29 +1,32 @@
+# frozen_string_literal: true
 module DoSnapshot
   # Adapter interface for API connections
   # Ability to select DigitalOcean API versions.
   #
   module Adapter
     autoload :Abstract, 'do_snapshot/adapter/abstract'
-    autoload :DigitaloceanV2, 'do_snapshot/adapter/digitalocean_v2'
+    autoload :DropletKit, 'do_snapshot/adapter/droplet_kit'
 
     class << self
       def api(protocol, options = {})
         konst = find_protocol(protocol)
-        fail DoSnapshot::NoProtocolError, "Not existing protocol: #{protocol}." unless
-            DoSnapshot::Adapter.const_defined?(konst)
+        error_protocol(protocol) unless DoSnapshot::Adapter.const_defined?(konst)
         obj = DoSnapshot::Adapter.const_get(konst)
         obj.new(options)
       end
 
       private
 
+      def error_protocol(protocol)
+        fail DoSnapshot::NoProtocolError, "Not existing protocol: #{protocol}."
+      end
+
       def find_protocol(protocol)
-        if protocol.is_a?(Integer)
-          "DigitaloceanV#{protocol}"
-        elsif protocol.is_a?(String)
+        if protocol.is_a?(String)
           protocol
         else
-          'DigitaloceanV2'
+          error_protocol(protocol) if protocol.is_a?(Integer) && protocol < 2
+          'DropletKit'
         end
       end
     end

data/lib/do_snapshot/adapter/abstract.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 
 module DoSnapshot
   module Adapter
@@ -25,7 +26,7 @@ module DoSnapshot
         # noinspection RubyResolve
         instance = droplet(id)
 
-        return power_on(id) unless instance.status.include?('active')
+        return power_on(id) if instance.respond_to?(:status) && !instance.status.include?('active')
 
         logger.error "Droplet #{id} is still running. Skipping."
       end

data/lib/do_snapshot/adapter/{digitalocean_v2.rb → droplet_kit.rb}

@@ -1,73 +1,86 @@
 # -*- encoding : utf-8 -*-
-require 'barge' unless defined?(::Barge)
+# frozen_string_literal: true
+
+require_relative '../gem_ext/resource_kit'
+require 'droplet_kit' unless defined?(::DropletKit)
 
 module DoSnapshot
   module Adapter
     # API for CLI commands
     # Operating with Digital Ocean.
     #
-    class DigitaloceanV2 < Abstract
-      attr_reader :client
+    class DropletKit < Abstract
+      attr_reader :client, :per_page, :page
+
+      def initialize(*args)
+        @per_page = 1000
+        @page = 1
+        super(*args)
+      end
 
       # Get single droplet from DigitalOcean
       #
       def droplet(id)
         # noinspection RubyResolve
-        response = client.droplet.show(id)
-        fail DropletFindError.new(id), response.message unless response.respond_to?(:droplet)
-        response.droplet
+        result = client.droplets.find(id: id)
+        fail DropletFindError, id unless result
+        result
+      rescue ::DropletKit::Error => e
+        raise DropletFindError, id unless e.message
       end
 
       # Get droplets list from DigitalOcean
       #
       def droplets
         # noinspection RubyResolve
-        response = client.droplet.all
-        fail DropletListError, response.message unless response.respond_to?(:droplets)
-        response.droplets
+        response = client.droplets.all(page: page, per_page: per_page)
+        response.many?
+        response
+      rescue ::NoMethodError => e
+        fail DropletListError, e
       end
 
       def snapshots(instance)
-        instance.snapshot_ids
+        instance.snapshot_ids if instance.respond_to?(:snapshot_ids)
       end
 
       # Request Power On for droplet
       #
       def power_on(id)
         # noinspection RubyResolve
-        response = client.droplet.power_on(id)
+        response = client.droplet_actions.power_on(droplet_id: id)
 
-        fail DoSnapshot::EventError.new(id), response.message unless response.respond_to?(:action)
-
-        if response.action.status.include?('in-progress')
+        if response.status.include?('in-progress')
           logger.info "Droplet id: #{id} is requested for Power On."
         else
           logger.error "Droplet id: #{id} is failed to request for Power On."
         end
+      rescue ::DropletKit::Error => e
+        fail DoSnapshot::EventError.new(id), e.message
       end
 
       # Power Off request for Droplet
       #
       def stop_droplet(id)
         # noinspection RubyResolve,RubyResolve
-        response = client.droplet.power_off(id)
-
-        fail DropletShutdownError.new(id), response.message unless response.respond_to?(:action)
+        response = client.droplet_actions.power_off(droplet_id: id)
 
         # noinspection RubyResolve
-        wait_shutdown(id, response.action.id)
+        wait_shutdown(id, response.id)
+      rescue ::DropletKit::Error => e
+        fail DropletShutdownError.new(id), e.message
       end
 
       # Sending event to create snapshot via DigitalOcean API and wait for success
       #
       def create_snapshot(id, name)
         # noinspection RubyResolve,RubyResolve
-        response = client.droplet.snapshot(id, name: name)
-
-        fail DoSnapshot::SnapshotCreateError.new(id), response.message unless response.respond_to?(:action)
+        response = client.droplet_actions.snapshot(droplet_id: id, name: name)
 
         # noinspection RubyResolve
-        wait_event(response.action.id)
+        wait_event(response.id)
+      rescue ::DropletKit::Error => e
+        fail DoSnapshot::SnapshotCreateError.new(id), e.message
       end
 
       # Checking if droplet is powered off.
@@ -75,7 +88,7 @@ module DoSnapshot
       def inactive?(id)
         instance = droplet(id)
 
-        instance.status.include?('off')
+        instance.status.include?('off') if instance.respond_to?(:status)
       end
 
       # Cleanup our snapshots.
@@ -83,12 +96,8 @@ module DoSnapshot
       def cleanup_snapshots(instance, size)
         (0..size).each do |i|
           # noinspection RubyResolve
-          snapshot = instance.snapshot_ids[i]
-          action = client.image.destroy(snapshot)
-
-          logger.debug action unless action.success?
-
-          after_cleanup(instance.id, instance.name, snapshot, action)
+          snapshot = snapshots(instance)[i]
+          delete_image(instance, snapshot)
         end
       end
 
@@ -103,13 +112,21 @@ module DoSnapshot
       #
       def set_id
         logger.debug 'Setting DigitalOcean Access Token.'
-        @client = ::Barge::Client.new(access_token: ENV['DIGITAL_OCEAN_ACCESS_TOKEN'], timeout: 15, open_timeout: 15)
+        @client = ::DropletKit::Client.new(access_token: ENV['DIGITAL_OCEAN_ACCESS_TOKEN'])
       end
 
       protected
 
+      def delete_image(instance, snapshot) # rubocop:disable Metrics/AbcSize
+        action = client.images.delete(id: snapshot)
+        after_cleanup(instance.id, instance.name, snapshot, action)
+      rescue ::DropletKit::Error => e
+        logger.debug "#{snapshot} #{e.message}"
+        after_cleanup(instance.id, instance.name, snapshot, false)
+      end
+
       def after_cleanup(droplet_id, droplet_name, snapshot, action)
-        if !action.success?
+        if !action
           logger.error "Destroy of snapshot #{snapshot} for droplet id: #{droplet_id} name: #{droplet_name} is failed."
         else
           logger.debug "Snapshot: #{snapshot} delete requested."
@@ -121,9 +138,9 @@ module DoSnapshot
       def get_event_status(id, time)
         return true if timeout?(id, time)
 
-        response = client.action.show(id)
+        response = client.actions.find(id: id)
 
-        fail DoSnapshot::EventError.new(id), response.message unless response.respond_to?(:action)
+        fail DoSnapshot::EventError.new(id), response.message unless response.respond_to?(:status)
 
         # noinspection RubyResolve,RubyResolve
         response.action.status.include?('completed') ? true : false

data/lib/do_snapshot/cli.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 require 'thor'
 require 'do_snapshot'
 require_relative 'log'

data/lib/do_snapshot/command.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 require_relative 'adapter'
 
 module DoSnapshot

data/lib/do_snapshot/configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DoSnapshot
   # Configuration class. Used to share config across application.
   #

data/lib/do_snapshot/core_ext/hash.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 # Rails symbolize keys methods for Hash
 #
 class Hash

data/lib/do_snapshot/distribution.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 module DoSnapshot
   # Distributive files
   # Used part of Heroku script https://github.com/heroku/heroku

data/lib/do_snapshot/gem_ext/resource_kit.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require 'resource_kit'
+
+# TODO: Remove after `resource_kit` gem update.
+ResourceKit::Action.class_eval do
+  def handler(*response_codes, &block)
+    if response_codes.empty?
+      handlers[:any] = block
+    else
+      response_codes.each do |code|
+        code = ResourceKit::StatusCodeMapper.code_for(code) unless code.is_a?(Integer)
+        handlers[code] = block
+      end
+    end
+  end
+end
+
+# TODO: Remove after `resource_kit` gem update.
+ResourceKit::ResourceCollection.class_eval do
+  def default_handler(*response_codes, &block)
+    if response_codes.empty?
+      default_handlers[:any] = block
+    else
+      response_codes.each do |code|
+        code = ResourceKit::StatusCodeMapper.code_for(code) unless code.is_a?(Integer)
+        default_handlers[code] = block
+      end
+    end
+  end
+end

data/lib/do_snapshot/helpers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'log'
 require_relative 'mail'
 

data/lib/do_snapshot/log.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 require 'logger'
 require 'hashie'
 

data/lib/do_snapshot/mail.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+# frozen_string_literal: true
 require 'date'
 require 'pony'
 require_relative 'core_ext/hash'

data/lib/do_snapshot/rspec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'rspec/core/shared_context'
+
+module DoSnapshot
+  module RSpec # rubocop:disable Style/Documentation
+    autoload :Adapter, 'do_snapshot/rspec/adapter'
+    autoload :ApiHelpers, 'do_snapshot/rspec/api_helpers'
+    autoload :ApiV2Helpers, 'do_snapshot/rspec/api_v2_helpers'
+    autoload :Environment, 'do_snapshot/rspec/environment'
+    autoload :UriHelpers, 'do_snapshot/rspec/uri_helpers'
+  end
+end

data/lib/do_snapshot/rspec/adapter.rb

@@ -0,0 +1,265 @@
+# frozen_string_literal: true
+module DoSnapshot
+  module RSpec
+    module Adapter # rubocop:disable Style/Documentation,Metrics/ModuleLength
+      extend ::RSpec::Core::SharedContext
+
+      subject(:api) { described_class }
+      subject(:log) { DoSnapshot::Log }
+
+      describe '.initialize' do
+        describe '#delay' do
+          let(:delay) { 5 }
+          let(:instance) { api.new(delay: delay) }
+          it('with custom delay') { expect(instance.delay).to eq delay }
+        end
+
+        describe '#timeout' do
+          let(:timeout) { 5 }
+          let(:instance) { api.new(timeout: timeout) }
+          it('with custom timeout') { expect(instance.timeout).to eq timeout }
+        end
+      end
+
+      describe 'droplets' do
+        let(:instance) { api.new(delay: delay, timeout: timeout) }
+        include UriHelpers
+
+        describe '.droplet' do
+          it 'with droplet' do
+            stub_droplet(droplet_id)
+
+            instance.droplet(droplet_id)
+
+            expect(a_request(:get, droplet_url))
+              .to have_been_made
+          end
+
+          it 'with error' do
+            stub_droplet_fail(droplet_id)
+
+            expect { instance.droplet(droplet_id) }
+              .to raise_error(DoSnapshot::DropletFindError)
+            expect(DoSnapshot.logger.buffer)
+              .to include "Droplet id: #{droplet_id} Not Found"
+
+            expect(a_request(:get, droplet_url))
+              .to have_been_made
+          end
+        end
+
+        describe '.droplets' do
+          it 'with droplets' do
+            stub_droplets
+
+            expect(instance.droplets.many?).to be_truthy
+
+            expect(a_request(:get, droplets_uri))
+              .to have_been_made
+          end
+
+          it 'with error' do
+            stub_droplets_fail
+
+            expect { instance.droplets }.to raise_error(DoSnapshot::DropletListError)
+            expect(DoSnapshot.logger.buffer)
+              .to include 'Droplet Listing is failed to retrieve'
+
+            expect(a_request(:get, droplets_uri))
+              .to have_been_made
+          end
+        end
+
+        describe '.start_droplet' do
+          it 'with event' do
+            stub_droplet_inactive(droplet_id)
+            stub_droplet_start(droplet_id)
+
+            instance.start_droplet(droplet_id)
+            expect(DoSnapshot.logger.buffer).to include "Droplet id: #{droplet_id} is requested for Power On."
+
+            expect(a_request(:post, droplet_start_url))
+              .to have_been_made
+            expect(a_request(:get, droplet_url))
+              .to have_been_made
+          end
+
+          it 'with warning message' do
+            stub_droplet(droplet_id)
+
+            expect { instance.start_droplet(droplet_id) }
+              .not_to raise_error
+            expect(DoSnapshot.logger.buffer)
+              .to include "Droplet #{droplet_id} is still running. Skipping."
+
+            expect(a_request(:get, droplet_url))
+              .to have_been_made
+          end
+
+          it 'with error' do
+            stub_droplet_fail(droplet_id)
+
+            expect { instance.start_droplet(droplet_id) }
+              .to raise_error(DoSnapshot::DropletFindError)
+
+            expect(a_request(:get, droplet_url))
+              .to have_been_made
+          end
+        end
+
+        describe '.stop_droplet by power status' do
+          let(:instance) { api.new(delay: delay, timeout: timeout, stop_by: :power_status) }
+
+          it 'with success' do
+            stub_event_done(event_id)
+            stub_droplet_stop(droplet_id)
+            stub_droplet_inactive(droplet_id)
+
+            instance.stop_droplet(droplet_id)
+
+            expect(a_request(:post, droplet_stop_url))
+              .to have_been_made
+            expect(a_request(:get, droplet_url))
+              .to have_been_made
+          end
+
+          it 'with error' do
+            stub_droplet_stop_fail(droplet_id)
+            stub_droplet(droplet_id)
+            instance.timeout = 1
+            expect { instance.stop_droplet(droplet_id) }
+              .to raise_error(DoSnapshot::DropletShutdownError)
+            instance.timeout = timeout
+            expect(DoSnapshot.logger.buffer)
+              .to include 'Droplet id: 100823 is Failed to Power Off.'
+
+            expect(a_request(:post, droplet_stop_url))
+              .to have_been_made
+          end
+        end
+
+        describe '.stop_droplet by event' do
+          it 'with success' do
+            stub_event_done(event_id)
+            stub_droplet_stop(droplet_id)
+
+            instance.stop_droplet(droplet_id)
+
+            expect(a_request(:post, droplet_stop_url))
+              .to have_been_made
+            expect(a_request(:get, action_find_url))
+              .to have_been_made
+          end
+
+          it 'with error' do
+            stub_droplet_stop_fail(droplet_id)
+
+            expect { instance.stop_droplet(droplet_id) }
+              .to raise_error(DoSnapshot::DropletShutdownError)
+            expect(DoSnapshot.logger.buffer)
+              .to include 'Droplet id: 100823 is Failed to Power Off.'
+
+            expect(a_request(:post, droplet_stop_url))
+              .to have_been_made
+          end
+        end
+
+        describe '.create_snapshot' do
+          it 'with success' do
+            stub_event_done(event_id)
+            stub_droplet_snapshot(droplet_id, snapshot_name)
+
+            expect { instance.create_snapshot(droplet_id, snapshot_name) }
+              .not_to raise_error
+
+            expect(a_request(:post, droplet_snapshot_url))
+              .to have_been_made
+            expect(a_request(:get, action_find_url))
+              .to have_been_made
+          end
+
+          it 'with error' do
+            stub_droplet_snapshot_fail(droplet_id, snapshot_name)
+
+            expect { instance.create_snapshot(droplet_id, snapshot_name) }
+              .to raise_error(DoSnapshot::SnapshotCreateError)
+
+            expect(a_request(:post, droplet_snapshot_url))
+              .to have_been_made
+          end
+
+          it 'with event error' do
+            stub_droplet_snapshot(droplet_id, snapshot_name)
+            stub_event_fail(event_id)
+
+            expect { instance.create_snapshot(droplet_id, snapshot_name) }
+              .not_to raise_error
+            expect(DoSnapshot.logger.buffer)
+              .to include "Event id: #{event_id} is failed!"
+
+            expect(a_request(:post, droplet_snapshot_url))
+              .to have_been_made
+            expect(a_request(:get, action_find_url))
+              .to have_been_made
+          end
+        end
+
+        describe '.inactive?' do
+          it 'when inactive' do
+            stub_droplet_inactive(droplet_id)
+
+            expect(instance.inactive?(droplet_id))
+              .to be_truthy
+          end
+
+          it 'when active' do
+            stub_droplet(droplet_id)
+
+            expect(instance.inactive?(droplet_id))
+              .to be_falsey
+          end
+        end
+
+        describe '.cleanup_snapshots' do
+          it 'with success' do
+            stub_droplet(droplet_id)
+            stub_image_destroy(image_id)
+            stub_image_destroy(image_id2)
+
+            droplet = instance.droplet(droplet_id)
+            expect { instance.cleanup_snapshots(droplet, 1) }
+              .not_to raise_error
+            expect(DoSnapshot.logger.buffer)
+              .to include 'Snapshot: 5019770 delete requested.'
+
+            expect(a_request(:get, droplet_url))
+              .to have_been_made
+            expect(a_request(:delete, image_destroy_url))
+              .to have_been_made
+            expect(a_request(:delete, image_destroy2_url))
+              .to have_been_made
+          end
+
+          it 'with warning message' do
+            stub_droplet(droplet_id)
+            stub_image_destroy_fail(image_id)
+            stub_image_destroy_fail(image_id2)
+
+            droplet = instance.droplet(droplet_id)
+            expect { instance.cleanup_snapshots(droplet, 1) }
+              .not_to raise_error
+            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))
+              .to have_been_made
+            expect(a_request(:delete, image_destroy_url))
+              .to have_been_made
+            expect(a_request(:delete, image_destroy2_url))
+              .to have_been_made
+          end
+        end
+      end
+    end
+  end
+end