do_snapshot 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7053ccac28ae155fac055356c0e2ef2e95373ffb
-  data.tar.gz: d315d1e4faa88f2b6562b64ab79d8480e01e25c5
+  metadata.gz: d46f25363b39fbfdbe390c2fe585a0a859414f39
+  data.tar.gz: 1163c72711dc3ccd58b21444bf0b65d75184e255
 SHA512:
-  metadata.gz: 77ca8773db485352055ca4118661451bcf1c55a538e248de7e7ed3eb44e6e8e5d6314ebb66645ed54f57f4fb31c76a21993000b1f97cc0f01223195cb3daeb80
-  data.tar.gz: 7d91bb1e124c979af67c26aed36c31e4d3e1d0f958b1ac01ca1f8e122fe8dba8e8e9e2585c1cd4d4973855e572470df7c7ea1a047b5b8e54c2fa754a3e80612a
+  metadata.gz: 5ac384653b71a000fa1511fcc84bb9233aef285320fc5bcfc76d516f75c087790f7c415fd95eeda5175eb4e09636ff1b86ed9595884d08d6c685dade01d3f90e
+  data.tar.gz: 3409ab059c16d04d4b404dc48a189e6f2c3e7623aed528fad52f8680079d9f746271911eb33a49d1b912cc94773547f600d98ef5ad39afc7f5c3181a01362a83

data/README.md

@@ -1,6 +1,22 @@
 # DoSnapshot
 
-TODO: Write a gem description
+You can use this gem to backup's DigitalOcean droplet's via snapshot.
+
+Here some features:
+
+- Binary for cron and command-line.
+- Mail notification when maximum of snapshots for droplet reached.
+- 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).
+- Logging into selected directory.
+- Trace mode for research.
+- Quiet mode for silence.
+
+There not so much of dependencies:
+
+- `Digitalocean` for API requests.
+- `Thor` for CLI.
+- `Pony` for mail notifications.
 
 ## Installation
 
@@ -18,7 +34,61 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First you may need to set DigitalOcean API keys:
+ 
+```shell
+  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:
+
+```shell
+  do_snapshot --digital-ocean-client-id YOURLONGAPICLIENTID --digital-ocean-api-key YOURLONGAPIKEY
+```
+
+E-mail notifications disabled out of the box. 
+For working mailer you need to set e-mail settings via run options.
+
+```shell
+Usage:
+  do_snapshot create
+
+Options:
+  -o, [--only=123456 123456 123456]                              # Use only selected droplets.
+  -e, [--exclude=123456 123456 123456]                           # Except some droplets.
+  -k, [--keep=5]                                                 # How much snapshots you want to keep?
+                                                                 # Default: 10
+  -s, [--stop], [--no-stop]                                      # Stop creating snapshots if maximum is reached.
+  -m, [--mail=to:yourmail@example.com]                           # Receive mail if 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.
+  -d, [--trace], [--no-trace]                                    # Debug mode.
+  -q, [--quiet], [--no-quiet]                                    # Quiet mode. If don't need any messages and log's
+      [--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.
+
+Description:
+  `do_snapshot create` will create and cleanup snapshots on your droplets.
+
+  You can optionally specify parameters to select or exclude some droplets.
+
+  Advanced options example for MAIL feature:
+
+  --mail to:mail@somehost.com from:from@host.com --smtp address:smtp.gmail.com user_name:someuser password:somepassword
+
+  For more details look here: [https://github.com/benprew/pony](https://github.com/benprew/pony)
+
+  Example:
+
+  > $ do_snapshot --keep 5 --quiet
+
+  > $ do_snapshot --only 123456 1234567 --store 3
+
+  > $ do_snapshot --exclude 123456 123457
+
+  > $ do_snapshot --keep 10 --stop true --mail to:yourmail@example.com
+```
 
 ## Contributing
 

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 runner for Digital Ocean droplets. Use it with Cron or other tools.}
-  spec.description   = %q{Snapshot runner for Digital Ocean droplets. Use it with Cron or other tools.}
+  spec.summary       = %q{Snapshot creator for Digital Ocean droplets. Use it with Cron or other tools.}
+  spec.description   = %q{Snapshot creator for Digital Ocean droplets. Use it with Cron or other tools.}
   spec.homepage      = 'http://github.com/merqlove/do_snapshot'
   spec.license       = 'MIT'
 

data/lib/do_snapshot/cli.rb

@@ -10,11 +10,19 @@ module DoSnapshot
 
     def initialize(*args)
       super
-      if options.include? 'log'
+
+      # Use Thor log especially
+      Log.thor_log = Thor::Shell::Color.new unless options.include?('quiet')
+
+      if options.include?('log')
         Log.logger       = Logger.new(options['log'])
-        Log.thor_log     = Thor::Shell::Color.new
         Log.logger.level = options.include?('trace') ? Logger::DEBUG : Logger::INFO
       end
+
+      # Check for keys via options
+      ENV['DIGITAL_OCEAN_CLIENT_ID'] = options['digital_ocean_client_id'] if options.include? 'digital_ocean_client_id'
+      ENV['DIGITAL_OCEAN_API_KEY']   = options['digital_ocean_api_key'] if options.include? 'digital_ocean_api_key'
+
       try_keys_first
     end
 
@@ -43,13 +51,17 @@ module DoSnapshot
     option :only, type: :array, default: [], aliases: ['-o'], banner: '123456 123456 123456', desc: 'Use only selected droplets.'
     option :exclude, type: :array, default: [], aliases: ['-e'], banner: '123456 123456 123456', desc: 'Except some droplets.'
     option :keep, type: :numeric, default: 10, aliases: ['-k'], banner: '5', desc: 'How much snapshots you want to keep?'
-    option :stop, type: :boolean, aliases: ['-s'], banner: 'true', desc: 'Stop creating snapshots if maximum is reached.'
+    option :stop, type: :boolean, aliases: ['-s'], desc: 'Stop creating snapshots if maximum is reached.'
     option :mail, type: :hash, default: {}, aliases: ['-m'], banner: 'to:yourmail@example.com', desc: 'Receive mail if maximum is reached.'
     option :smtp, type: :hash, default: {}, aliases: ['-t'], banner: 'user_name:yourmail@example.com password:password', desc: 'SMTP options.'
     option :log, type: :string, aliases: ['-l'], banner: '/Users/someone/.do_snapshot/main.log', desc: 'Log file path. By default logging is disabled.'
-    option :trace, type: :boolean, aliases: ['-d'], desc: 'Debug mode. Not implented now. Switched only log mode.'
+    option :trace, type: :boolean, aliases: ['-d'], desc: 'Debug mode.'
+    option :quiet, type: :boolean, aliases: ['-q'], desc: 'Quiet mode. If don\'t need any messages and log\'s'
+    option :digital_ocean_client_id, type: :string, banner: 'YOURLONGAPICLIENTID', desc: 'DIGITAL_OCEAN_CLIENT_ID. if you can\'t use environment.'
+    option :digital_ocean_api_key, type: :string, banner: 'YOURLONGAPIKEY', desc: 'DIGITAL_OCEAN_API_KEY. if you can\'t use environment.'
+
     def create
-      DoSnapshot::Command.execute options, %w( log trace )
+      DoSnapshot::Command.execute options, %w( log trace quiet digital_ocean_client_id digital_ocean_api_key )
     rescue => e
       Log.error e.message
       backtrace(e) if options.include? 'trace'
@@ -63,11 +75,11 @@ module DoSnapshot
       end
     end
 
-    # Check DigitalOcean API keys
+    # Check for DigitalOcean API keys
     def try_keys_first
       Log.debug 'Checking DigitalOcean Id\'s.'
-      fail Thor::Error, 'You must have DIGITAL_OCEAN_CLIENT_ID in environment.' if !ENV['DIGITAL_OCEAN_CLIENT_ID'] || ENV['DIGITAL_OCEAN_CLIENT_ID'].empty?
-      fail Thor::Error, 'You must have DIGITAL_OCEAN_API_KEY in environment.' if !ENV['DIGITAL_OCEAN_API_KEY'] || ENV['DIGITAL_OCEAN_API_KEY'].empty?
+      fail Thor::Error, 'You must have DIGITAL_OCEAN_CLIENT_ID in environment or set via options.' if !ENV['DIGITAL_OCEAN_CLIENT_ID'] || ENV['DIGITAL_OCEAN_CLIENT_ID'].empty?
+      fail Thor::Error, 'You must have DIGITAL_OCEAN_API_KEY in environment or set via options.' if !ENV['DIGITAL_OCEAN_API_KEY'] || ENV['DIGITAL_OCEAN_API_KEY'].empty?
     end
   end
 end

data/lib/do_snapshot/version.rb

@@ -1,5 +1,5 @@
 # Current version
 #
 module DoSnapshot
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/do_snapshot.rb

@@ -1,7 +1,6 @@
 require 'do_snapshot/version'
 require 'logger'
 
-
 # Used primary for creating snapshot's as backups for DigitalOcean
 #
 module DoSnapshot

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: do_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alexander Merkulov
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Snapshot runner for Digital Ocean droplets. Use it with Cron or other
+description: Snapshot creator for Digital Ocean droplets. Use it with Cron or other
   tools.
 email:
 - sasha@merqlove.ru
@@ -127,6 +127,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Snapshot runner for Digital Ocean droplets. Use it with Cron or other tools.
+summary: Snapshot creator for Digital Ocean droplets. Use it with Cron or other tools.
 test_files:
 - test/.keep