do_snapshot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7053ccac28ae155fac055356c0e2ef2e95373ffb
+  data.tar.gz: d315d1e4faa88f2b6562b64ab79d8480e01e25c5
+SHA512:
+  metadata.gz: 77ca8773db485352055ca4118661451bcf1c55a538e248de7e7ed3eb44e6e8e5d6314ebb66645ed54f57f4fb31c76a21993000b1f97cc0f01223195cb3daeb80
+  data.tar.gz: 7d91bb1e124c979af67c26aed36c31e4d3e1d0f958b1ac01ca1f8e122fe8dba8e8e9e2585c1cd4d4973855e572470df7c7ea1a047b5b8e54c2fa754a3e80612a

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+.irb_history
+

data/.rubocop.yml

@@ -0,0 +1,11 @@
+LineLength:
+  Max: 200
+
+HashSyntax:
+  EnforcedStyle: ruby19
+
+SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+TrailingComma:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in do_snapshot.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alexander Merkulov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# DoSnapshot
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'do_snapshot'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install do_snapshot
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/do_snapshot/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/do_snapshot

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+# resolve bin path, ignoring symlinks
+require 'pathname'
+bin_file = Pathname.new(__FILE__).realpath
+
+# add self to libpath
+$:.unshift File.expand_path('../../lib', bin_file)
+
+require 'do_snapshot/cli'
+
+DoSnapshot::CLI.start(ARGV)

data/do_snapshot.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'do_snapshot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'do_snapshot'
+  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.homepage      = 'http://github.com/merqlove/do_snapshot'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'digitalocean', '~> 1.2'
+  spec.add_dependency 'thor'
+  spec.add_dependency 'pony'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+end

data/lib/do_snapshot.rb

@@ -0,0 +1,46 @@
+require 'do_snapshot/version'
+require 'logger'
+
+
+# Used primary for creating snapshot's as backups for DigitalOcean
+#
+module DoSnapshot
+  # Shared logger
+  #
+  class Log
+    class << self
+      attr_accessor :logger
+      attr_accessor :thor_log
+
+      def log(type, message)
+        logger.send(type, message) if logger
+      end
+
+      def info(message)
+        log :info, message
+        say message, :green
+      end
+
+      def warning(message)
+        log :warn, message
+        say message, :yellow
+      end
+
+      def error(message)
+        log :error, message
+        say message, :red
+      end
+
+      def debug(message)
+        log :debug, message
+        say message, :white if logger && logger.level == Logger::DEBUG
+      end
+
+      protected
+
+      def say(message, color)
+        thor_log.say message, color if thor_log
+      end
+    end
+  end
+end

data/lib/do_snapshot/cli.rb

@@ -0,0 +1,73 @@
+require 'do_snapshot'
+require 'do_snapshot/command'
+require 'thor'
+
+module DoSnapshot
+  # CLI is here
+  #
+  class CLI < Thor
+    default_task :create
+
+    def initialize(*args)
+      super
+      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
+      try_keys_first
+    end
+
+    desc 'create', 'create and cleanup snapshot\'s'
+    long_desc <<-LONGDESC
+    `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
+
+    Example:
+
+    > $ do_snapshot --keep 5
+
+    > $ do_snapshot --only 123456 1234567 --store 3
+
+    > $ do_snapshot --exclude 123456 123457
+
+    > $ do_snapshot --keep 10 --stop true --mail to:yourmail@example.com
+    LONGDESC
+    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 :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.'
+    def create
+      DoSnapshot::Command.execute options, %w( log trace )
+    rescue => e
+      Log.error e.message
+      backtrace(e) if options.include? 'trace'
+    end
+
+    protected
+
+    def backtrace(e)
+      e.backtrace.each do |t|
+        Log.error t
+      end
+    end
+
+    # Check 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?
+    end
+  end
+end

data/lib/do_snapshot/command.rb

@@ -0,0 +1,166 @@
+require 'digitalocean'
+require 'date'
+require 'pony'
+require 'core_ext/hash'
+
+module DoSnapshot
+  # Our commands live here :)
+  #
+  class Command
+    class << self
+      def execute(options, skip)
+        return unless options
+
+        options.each_pair do |key, option|
+          send("#{key}=", option) unless skip.include? key
+        end
+
+        self.notify = false
+
+        work_droplets
+        email_message if notify && mail
+
+        Log.info 'All snapshots requested'
+      end
+
+      protected
+
+      attr_accessor :droplets
+      attr_accessor :exclude
+      attr_accessor :only
+      attr_accessor :keep
+      attr_accessor :mail
+      attr_accessor :smtp
+      attr_accessor :stop
+      attr_accessor :notify
+
+      # Getting droplets list from API.
+      # And store into object.
+      #
+      def load_droplets
+        set_id
+        Log.debug 'Loading list of DigitalOcean droplets'
+        droplets = Digitalocean::Droplet.all
+        fail droplets.message unless droplets.status == 'OK'
+        self.droplets = droplets.droplets
+      end
+
+      # Working with received list of droplets.
+      #
+      def work_droplets
+        load_droplets
+        Log.debug 'Working with list of DigitalOcean droplets'
+        droplets.each do |droplet|
+          id = droplet.id.to_s
+          next if exclude.include? id
+          next if !only.empty? && !only.include?(id)
+
+          instance = Digitalocean::Droplet.find(id)
+          fail instance.message unless instance.status == 'OK'
+
+          prepare_instance instance.droplet
+        end
+      end
+
+      # Preparing instance to take snapshot.
+      # Instance must be powered off first!
+      #
+      def prepare_instance(instance)
+        return unless instance
+        Log.debug "Preparing droplet id: #{instance.id} name: #{instance.name} to snapshot."
+
+        warning_size = "For droplet with id: #{instance.id} and name: #{instance.name} the maximum #{keep} is reached."
+
+        if instance.snapshots.size >= keep && stop
+          Log.warning warning_size
+          self.notify = true
+          return
+        end
+
+        # Stopping instance.
+        Log.debug 'Shutting down droplet.'
+        unless instance.status.include? 'off'
+          event = Digitalocean::Droplet.power_off(instance.id)
+          if event.status.include? 'OK'
+            sleep 1.3 until get_event_status(event.event_id)
+          end
+        end
+
+        # Create snapshot.
+        create_snapshot instance, warning_size
+      end
+
+      # Trying to create a snapshot.
+      #
+      def create_snapshot(instance, warning_size)
+        Log.debug "Start creating snapshot for droplet id: #{instance.id} name: #{instance.name}."
+
+        today         = DateTime.now
+        name          = "#{instance.name}_#{today.strftime('%Y_%m_%d')}"
+        event         = Digitalocean::Droplet.snapshot(instance.id, name: name)
+        snapshot_size = instance.snapshots.size
+
+        if !event
+          fail 'Something wrong with DigitalOcean or with your connection :)'
+        elsif event && !event.status.include?('OK')
+          fail event.message
+        end
+
+        Log.debug 'Wait until snapshot will be created.'
+
+        sleep 10 until get_event_status(event.event_id)
+
+        snapshot_size += 1
+
+        Log.info "Snapshot name: #{name} created successfully."
+        Log.info "Droplet id: #{instance.id} name: #{instance.name} snapshots: #{snapshot_size}."
+
+        if snapshot_size > keep
+          Log.warning warning_size if snapshot_size > keep
+          self.notify = true
+        end
+      end
+
+      # Looking for event status.
+      #
+      # Before snapshot we to know that machine has powered off.
+      #
+      def get_event_status(id)
+        event = Digitalocean::Event.find(id)
+        fail event.message unless event.status.include?('OK')
+        event.event.percentage && event.event.percentage.include?('100') ? true : false
+      end
+
+      # Sending message via Hash params.
+      #
+      # Options:: -m to:mail@somehost.com from:from@host.com -t address:smtp.gmail.com user_name:someuser password:somepassword
+      #
+      def email_message
+        mail.symbolize_keys!
+        smtp.symbolize_keys!
+
+        mail[:subject] = 'DigitalOcean Snapshot maximum is reached.' unless mail[:subject]
+        mail[:body] = "Please cleanup your Digital Ocean account. \nSnapshot maximum is reached." unless mail[:body]
+        mail[:from] = 'noreply@someonelse.com' unless mail[:from]
+        mail[:via] = :smtp unless mail[:via]
+
+        smtp[:domain] = 'localhost.localdomain' unless smtp[:domain]
+        smtp[:port] = '25' unless smtp[:port]
+
+        mail[:via_options] = smtp
+
+        Log.debug 'Sending e-mail notification.'
+        # Look into your inbox :)
+        Pony.mail(mail)
+      end
+
+      # Set id's of Digital Ocean API.
+      #
+      def set_id
+        Log.debug 'Setting DigitalOcean Id\'s.'
+        Digitalocean.client_id = ENV['DIGITAL_OCEAN_CLIENT_ID']
+        Digitalocean.api_key = ENV['DIGITAL_OCEAN_API_KEY']
+      end
+    end
+  end
+end

data/lib/do_snapshot/core_ext/hash.rb

@@ -0,0 +1,36 @@
+# Rails symbolize keys methods for Hash
+#
+class Hash
+  # Returns a new hash with all keys converted using the block operation.
+  #
+  #  hash = { name: 'Rob', age: '28' }
+  #
+  #  hash.transform_keys{ |key| key.to_s.upcase }
+  #  # => {"NAME"=>"Rob", "AGE"=>"28"}
+  def transform_keys
+    result = {}
+    each_key do |key|
+      result[yield(key)] = self[key]
+    end
+    result
+  end
+
+  # Destructively convert all keys using the block operations.
+  # Same as transform_keys but modifies +self+.
+  def transform_keys!
+    keys.each do |key|
+      self[yield(key)] = delete(key)
+    end
+    self
+  end
+
+  def symbolize_keys
+    transform_keys { |key| key.to_sym rescue key }
+  end
+
+  # Destructively convert all keys to symbols, as long as they respond
+  # to +to_sym+. Same as +symbolize_keys+, but modifies +self+.
+  def symbolize_keys!
+    transform_keys! { |key| key.to_sym rescue key }
+  end
+end

data/lib/do_snapshot/version.rb

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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: do_snapshot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander Merkulov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: digitalocean
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Snapshot runner for Digital Ocean droplets. Use it with Cron or other
+  tools.
+email:
+- sasha@merqlove.ru
+executables:
+- do_snapshot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/do_snapshot
+- do_snapshot.gemspec
+- lib/do_snapshot.rb
+- lib/do_snapshot/cli.rb
+- lib/do_snapshot/command.rb
+- lib/do_snapshot/core_ext/hash.rb
+- lib/do_snapshot/version.rb
+- test/.keep
+homepage: http://github.com/merqlove/do_snapshot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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.
+test_files:
+- test/.keep