do_snapshot 0.0.14 → 0.0.15

data/lib/do_snapshot/cli.rb

@@ -23,7 +23,7 @@ module DoSnapshot
       set_mailer
 
       # Check for keys via options
-      %w( digital_ocean_client_id digital_ocean_api_key ).each do |key|
+      %w( digital_ocean_client_id digital_ocean_api_key digital_ocean_access_token ).each do |key|
         ENV[key.upcase] = options[key] if options.include? key
       end
     end
@@ -36,6 +36,14 @@ module DoSnapshot
 
     ### Examples
 
+    Select api version (1, 2):
+
+    $ do_snapshot -a 2
+
+    Set DigitalOcean keys:
+
+    $ do_snapshot --digital_ocean_api_token SOMELONGTOKEN
+
     Keep latest 5 and cleanup older if maximum is reached, verbose:
 
     $ do_snapshot -k 5 -c -v
@@ -64,6 +72,12 @@ module DoSnapshot
 
     VERSION: #{DoSnapshot::VERSION}
     LONGDESC
+    method_option :protocol,
+                  type: :numeric,
+                  default: 1,
+                  aliases: %w( -p ),
+                  banner: '1',
+                  desc: 'Select api version.'
     method_option :only,
                   type: :array,
                   default: [],
@@ -90,7 +104,7 @@ module DoSnapshot
                   desc: 'Delay between snapshot operation status requests.'
     method_option :timeout,
                   type: :numeric,
-                  default: 600,
+                  default: 3600,
                   banner: '250',
                   desc: 'Timeout in sec\'s for events like Power Off or Create Snapshot.'
     method_option :mail,
@@ -109,6 +123,7 @@ module DoSnapshot
                   banner: '/Users/someone/.do_snapshot/main.log',
                   desc: 'Log file path. By default logging is disabled.'
     method_option :clean,
+                  default: true,
                   type: :boolean,
                   aliases: %w( -c ),
                   desc: 'Cleanup snapshots after create. If you have more images than you want to `keep`, older will be deleted.'
@@ -125,6 +140,10 @@ module DoSnapshot
                   aliases: %w( -q ),
                   desc: 'Quiet mode. If don\'t need any messages and in console.'
 
+    method_option :digital_ocean_access_token,
+                  type: :string,
+                  banner: 'YOURLONGAPITOKEN',
+                  desc: 'DIGITAL_OCEAN_ACCESS_TOKEN. if you can\'t use environment.'
     method_option :digital_ocean_client_id,
                   type: :string,
                   banner: 'YOURLONGAPICLIENTID',
@@ -135,8 +154,7 @@ module DoSnapshot
                   desc: 'DIGITAL_OCEAN_API_KEY. if you can\'t use environment.'
 
     def snap
-      try_keys_first
-      Command.load_options 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 digital_ocean_access_token )
       Command.snap
     rescue => e
       Command.fail_power_off(e) if [SnapshotCreateError, DropletShutdownError].include?(e.class)
@@ -182,14 +200,6 @@ module DoSnapshot
           Log.error t
         end
       end
-
-      # Check for DigitalOcean API keys
-      def try_keys_first
-        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
     end
   end
 end

data/lib/do_snapshot/command.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
-require_relative 'api'
+require_relative 'adapter'
 
 module DoSnapshot
   # Our commands live here :)
@@ -40,7 +40,7 @@ module DoSnapshot
         today         = DateTime.now
         name          = "#{droplet.name}_#{today.strftime('%Y_%m_%d')}"
         # noinspection RubyResolve
-        snapshot_size = droplet.snapshots.size
+        snapshot_size = api.snapshots(droplet).size
 
         Log.debug 'Wait until snapshot will be created.'
 
@@ -63,13 +63,13 @@ module DoSnapshot
       end
 
       def api
-        @api ||= API.new(delay: delay, timeout: timeout)
+        @api ||= DoSnapshot::Adapter.api(protocol, delay: delay, timeout: timeout)
       end
 
       protected
 
       attr_accessor :droplets, :exclude, :only
-      attr_accessor :keep, :quiet, :stop, :clean, :timeout, :delay
+      attr_accessor :keep, :quiet, :stop, :clean, :timeout, :delay, :protocol
 
       attr_writer :notify, :threads, :api
 
@@ -95,7 +95,7 @@ module DoSnapshot
       #
       def load_droplets
         Log.debug 'Loading list of DigitalOcean droplets'
-        self.droplets = api.droplets.droplets
+        self.droplets = api.droplets
       end
 
       # Dispatch received droplets, each by each.
@@ -130,8 +130,7 @@ module DoSnapshot
       #
       def prepare_droplet(id, name)
         Log.debug "Droplet id: #{id} name: #{name} "
-        instance = api.droplet id
-        droplet = instance.droplet
+        droplet = api.droplet id
 
         return unless droplet
         Log.info "Preparing droplet id: #{droplet.id} name: #{droplet.name} to take snapshot."
@@ -141,7 +140,7 @@ module DoSnapshot
 
       def too_much_snapshots(instance)
         # noinspection RubyResolve
-        return false unless instance.snapshots.size >= keep
+        return false unless api.snapshots(instance).size >= keep
         warning_size(instance.id, instance.name, keep)
         stop ? true : false
       end

data/lib/do_snapshot/version.rb

@@ -2,5 +2,5 @@
 # Current version
 #
 module DoSnapshot
-  VERSION = '0.0.14'
+  VERSION = '0.0.15'
 end

data/spec/do_snapshot/adapter/abstract_spec.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe DoSnapshot::Adapter::Abstract do
+  include_context 'spec'
+
+  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
+
+  before(:each) do
+    log.buffer = %w()
+    log.verbose = false
+    log.quiet = true
+  end
+end

data/spec/do_snapshot/{api_spec.rb → adapter/digitalocean_spec.rb}

@@ -1,8 +1,9 @@
 # -*- encoding : utf-8 -*-
 require 'spec_helper'
 
-describe DoSnapshot::API do
+describe DoSnapshot::Adapter::Digitalocean do
   include_context 'spec'
+  include_context 'api_v1_helpers'
 
   subject(:api) { described_class }
   subject(:log) { DoSnapshot::Log }
@@ -178,7 +179,7 @@ describe DoSnapshot::API do
         stub_image_destroy(image_id2)
 
         droplet = instance.droplet(droplet_id)
-        expect { instance.cleanup_snapshots(droplet.droplet, 1) }
+        expect { instance.cleanup_snapshots(droplet, 1) }
           .not_to raise_error
         expect(log.buffer)
           .to include 'Snapshot name: mrcr.ru_2014_07_19 delete requested.'
@@ -197,7 +198,7 @@ describe DoSnapshot::API do
         stub_image_destroy_fail(image_id2)
 
         droplet = instance.droplet(droplet_id)
-        expect { instance.cleanup_snapshots(droplet.droplet, 1) }
+        expect { instance.cleanup_snapshots(droplet, 1) }
           .not_to raise_error
         expect(log.buffer)
           .to include 'Some Message'

data/spec/do_snapshot/adapter/digitalocean_v2_spec.rb

@@ -0,0 +1,223 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe DoSnapshot::Adapter::DigitaloceanV2 do
+  include_context 'spec'
+  include_context 'api_v2_helpers'
+
+  subject(:api) { described_class }
+  subject(:log) { DoSnapshot::Log }
+
+  let(:event_id) { '7499' }
+
+  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_context 'uri_helpers'
+
+    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
+        expect(log.buffer)
+          .to include 'Droplet Not Found'
+
+        expect(a_request(:get, droplet_url))
+          .to have_been_made
+      end
+    end
+
+    describe '.droplets' do
+      it 'with droplets' do
+        stub_droplets
+
+        instance.droplets
+
+        expect(a_request(:get, droplets_uri))
+          .to have_been_made
+      end
+
+      it 'with error' do
+        stub_droplets_fail
+
+        expect { instance.droplets }.to raise_error
+        expect(log.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(log.buffer).to include 'Power On has been requested.'
+
+        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(log.buffer)
+          .to include 'Droplet is still running.'
+
+        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
+
+        expect(a_request(:get, droplet_url))
+          .to have_been_made
+      end
+    end
+
+    describe '.stop_droplet' do
+      it 'with event' 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
+        expect(log.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
+
+        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) }
+          .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
+    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(log.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(log.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
+
+  before(:each) do
+    log.buffer = %w()
+    log.verbose = false
+    log.quiet = true
+  end
+end

data/spec/do_snapshot/cli_spec.rb

@@ -3,10 +3,11 @@ require 'spec_helper'
 
 describe DoSnapshot::CLI do
   include_context 'spec'
+  include_context 'api_v1_helpers'
 
   subject(:cli)     { described_class }
   subject(:command) { DoSnapshot::Command }
-  subject(:api)     { DoSnapshot::API }
+  subject(:api)     { DoSnapshot::Adapter::Digitalocean }
 
   describe '.initialize' do
     it 'with args & options' do