Now we use DO API V2 by default.

Author: merqlove

README.md

@@ -12,6 +12,8 @@
 
 Use this tool to backup DigitalOcean droplet's via snapshot method, on the fly!
 
+## Breaking changes: now we use DO API V2 by default, due V1 deprecation at 11.2015.
+
 Here some features:
 
 - Multiple threads out of the box. No matter how much droplet's you have.
@@ -48,7 +50,7 @@ Install it yourself as:
 
     $ gem install do_snapshot
 
-Or System Wide Install (OSX, *nix):
+System Wide Install (OSX, *nix):
 
     $ sudo gem install do_snapshot
         
@@ -81,6 +83,15 @@ Mainly it's pretty simple:
 
 ### Setup 
 
+### Digitalocean API V2 (default):
+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   
+    
 ### Digitalocean API V1:
 You'll need to generate an access token in Digital Ocean's control panel at https://cloud.digitalocean.com/api_access
 
@@ -89,26 +100,17 @@ You'll need to generate an access token in Digital Ocean's control panel at http
 
 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    
+    $ do_snapshot --digital-ocean-client-id YOURLONGAPICLIENTID --digital-ocean-api-key YOURLONGAPIKEY 
 
 ### 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:
+Using API V1:
 
-    $ do_snapshot -p 2
+    $ do_snapshot -p 1
 
 Keep latest 3 from selected droplet:
 
@@ -162,7 +164,7 @@ For working mailer you need to set e-mail settings via run options.
 
     Options:
       -p, [--protocol=1]                                             # Select api version.
-                                                                     # Default: 1
+                                                                     # Default: 2
       -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?

lib/do_snapshot/adapter.rb

@@ -10,10 +10,10 @@ module DoSnapshot
   module Adapter
     def api(protocol, options)
       case protocol
-      when 2
-        return DigitaloceanV2.new(options)
-      else
+      when 1
         return Digitalocean.new(options)
+      else
+        return DigitaloceanV2.new(options)
       end
     end
     module_function :api

lib/do_snapshot/cli.rb

@@ -42,7 +42,7 @@ def initialize(*args)
 
     Select api version (1, 2):
 
-    $ do_snapshot -a 2
+    $ do_snapshot -p 1
 
     Set DigitalOcean keys:
 
@@ -78,7 +78,7 @@ def initialize(*args)
     LONGDESC
     method_option :protocol,
                   type: :numeric,
-                  default: 1,
+                  default: 2,
                   aliases: %w( -p ),
                   banner: '1',
                   desc: 'Select api version.'

spec/do_snapshot/adapter/digitalocean_v2_spec.rb

@@ -8,8 +8,6 @@
   subject(:api) { described_class }
   subject(:log) { DoSnapshot::Log }
 
-  let(:event_id) { '7499' }
-
   describe '.initialize' do
     describe '#delay' do
       let(:delay) { 5 }

spec/do_snapshot/cli_spec.rb

@@ -3,7 +3,7 @@
 
 RSpec.describe DoSnapshot::CLI do
   include_context 'spec'
-  include_context 'api_v1_helpers'
+  include_context 'api_v2_helpers'
 
   subject(:cli)     { described_class }
   subject(:api)     { DoSnapshot::Adapter::Digitalocean }

spec/do_snapshot/command_spec.rb

@@ -8,12 +8,12 @@
   subject(:cmd)     { DoSnapshot::Command.new }
   subject(:log)     { DoSnapshot::Log }
 
-  describe 'V2' do
-    include_context 'api_v2_helpers'
-  end
-
   describe 'V1' do
     include_context 'api_v1_helpers'
+  end
+
+  describe 'V2' do
+    include_context 'api_v2_helpers'
 
     describe '.snap' do
       context 'when success' do
@@ -215,8 +215,7 @@
 
       it 'with start error' do
         stub_droplet_inactive(droplet_id)
-        stub_droplet_start_fail(droplet_id)
-        stub_event_fail(event_id)
+        stub_droplet_start_done(droplet_id)
 
         expect { cmd.fail_power_off(DoSnapshot::DropletShutdownError.new(droplet_id)) }
           .not_to raise_error
@@ -234,8 +233,8 @@
   end
 
   def load_options(options = nil)
-    options ||= default_options.merge(protocol: 1)
-    cmd.load_options(options, [:log, :mail, :smtp, :trace, :digital_ocean_client_id, :digital_ocean_api_key])
+    options ||= default_options.merge(protocol: 2)
+    cmd.load_options(options, [:log, :mail, :smtp, :trace, :digital_ocean_access_token])
   end
 
   def snap_runner

spec/do_snapshot/runner_spec.rb

@@ -185,10 +185,6 @@
       end
 
       context 'API V2' do
-        let(:default_options_cli) { default_options.reject { |key, _| %w( droplets threads ).include?(key.to_s) }.merge(protocol: 2) }
-        let(:event_id) { '7499' }
-        let(:snapshot_name) { "example.com_#{DateTime.now.strftime('%Y_%m_%d')}" }
-
         include_context 'api_v2_helpers'
         it_behaves_like '.snap methods'
 
@@ -216,6 +212,9 @@
       end
 
       context 'API V1' do
+        let(:default_options_cli) { default_options.merge(protocol: 1) }
+        let(:snapshot_name) { "foo_#{DateTime.now.strftime('%Y_%m_%d')}" }
+
         include_context 'api_v1_helpers'
         it_behaves_like '.snap methods'
 

spec/fixtures/digitalocean/v1/response_event.json

@@ -1,4 +1,4 @@
 {
     "status": "OK",
-    "event_id": 7501
+    "event_id": 7499
 }

spec/shared/api_v2_helpers.rb

@@ -50,7 +50,6 @@ def stub_droplet_inactive(id)
   def stub_droplet_stop(id)
     stub_with_id(droplet_stop_uri, id, 'v2/show_event_power_off_start', :post,
                  type: 'power_off'
-
                 )
   end
 
@@ -66,16 +65,18 @@ def stub_droplet_stop_fail(id)
   def stub_droplet_start(id)
     stub_with_id(droplet_start_uri, id, 'v2/show_event_power_on_start', :post,
                  type: 'power_on'
+                )
+  end
 
+  def stub_droplet_start_done(id)
+    stub_with_id(droplet_start_uri, id, 'v2/show_event_power_on_done', :post,
+                 type: 'power_on'
                 )
   end
 
   def stub_droplet_start_fail(id)
     stub_with_id(droplet_start_uri, id, 'v2/error_message', :post,
-                 {
-                   type: 'power_on'
-                 },
-                 404
+                 type: 'power_on'
                 )
   end
 
@@ -85,7 +86,6 @@ def stub_droplet_snapshot(id, name)
     stub_with_id_name(snapshot_uri, id, name, 'v2/response_event', :post,
                       type: 'snapshot',
                       name: name
-
                      )
   end
 

spec/shared/environment.rb

@@ -11,15 +11,15 @@ def do_not_send_email
   let(:client_key)          { 'foo' }
   let(:api_key)             { 'bar' }
   let(:access_token)        { 'sometoken' }
-  let(:event_id)            { '7501' }
+  let(:event_id)            { '7499' }
   let(:droplet_id)          { '100823' }
   let(:image_id)            { '5019770' }
   let(:image_id2)           { '5019903' }
   let(:cli_env_nil)         { Hash['DIGITAL_OCEAN_CLIENT_ID' => nil, 'DIGITAL_OCEAN_API_KEY' => nil, 'DIGITAL_OCEAN_ACCESS_TOKEN' => nil] }
   let(:cli_keys)            { Thor::CoreExt::HashWithIndifferentAccess.new(digital_ocean_client_id: client_key, digital_ocean_api_key: api_key, digital_ocean_access_token: access_token) }
   let(:cli_keys_other)      { Thor::CoreExt::HashWithIndifferentAccess.new(digital_ocean_client_id: 'NOTFOO', digital_ocean_api_key: 'NOTBAR', digital_ocean_access_token: 'NOTTOK') }
-  let(:snapshot_name)       { "foo_#{DateTime.now.strftime('%Y_%m_%d')}" }
-  let(:default_options)     { Hash[protocol: 1, only: %w( 100823 ), exclude: %w(), keep: 3, stop: false, trace: true, clean: true, delay: 0, timeout: 600, droplets: nil, threads: []] }
+  let(:snapshot_name)       { "example.com_#{DateTime.now.strftime('%Y_%m_%d')}" }
+  let(:default_options)     { Hash[protocol: 2, only: %w( 100823 ), exclude: %w(), keep: 3, stop: false, trace: true, clean: true, delay: 0, timeout: 600] }
   let(:default_options_cli) { default_options.reject { |key, _| %w( droplets threads ).include?(key.to_s) } }
   let(:no_exclude)          { [] }
   let(:exclude)             { %w( 100824 100825 ) }