snapshooter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  data.tar.gz: f1d9d9da326c97b443ad449e6bbc008fda31ad54931755a9dd863ac9217937faba8025c0fde0b1188b2ec45d9c1e74509e7364528f05e345baa2ae485c385318
+  metadata.gz: 06cf492690e9d4c971717ed0b75c25be8fa7c5b2d946880dff9c23439b8373dff42e7c414e0a97180a02296d1c7cc00134771722a2ffa0f35756e611f463ff12
+SHA1: 
+  data.tar.gz: 36a0a5174a10f743e221c8ae4ac7e93763239dfd
+  metadata.gz: fd9ee346389d36362fba8638436f6e4fd820627b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Julio Santos
+
+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 @@
+# Snapshooter
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'snapshooter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snapshooter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/snapshooter/base.rb

@@ -0,0 +1,54 @@
+module Snapshooter
+  class Base
+    include Log
+
+    def initialize(id, storage=:local)
+      @id = id
+      case storage
+      when :s3
+        @storage = Storage::S3.new
+      when :local
+        @storage = Storage::Local.new
+      else
+        raise "Unknown storage type: #{storage}"
+      end
+    end
+
+    def restore
+      datastores.each do |datastore|
+        filename = "#{@id}-#{datastore.filename}"
+
+        @storage.get filename do |file|
+          with_log("Restore from #{filename}") do
+            datastore.restore(file)
+          end
+        end
+      end
+    end
+
+    def snapshot!
+      datastores.each do |datastore|
+        filename = "#{@id}-#{datastore.filename}"
+
+        @storage.save filename do |tmp_file|
+          with_log "Snapshot to #{filename}" do
+            datastore.snapshot tmp_file
+          end
+        end
+      end
+    end
+
+    private
+
+    def datastores
+      Snapshooter.datastores.map do |store|
+        case store[:type]
+        when :mysql
+          Datastore::Mysql.new(store[:config])
+        else
+          raise "Unknown Datastore: #{store[:type]}"
+        end
+      end
+    end
+  end
+end

data/lib/snapshooter/cli.rb

@@ -0,0 +1,50 @@
+require 'optparse'
+
+module Snapshooter
+  class CLI
+    def self.start
+      new.run
+    end
+
+    def initialize
+      @options = {
+        :storage => :local,
+        :id      => Time.now.to_i,
+        :restore => false
+      }
+      @options.merge! parse_options
+    end
+
+    def run
+      shooter = Base.new(@options[:id], @options[:storage])
+      if @options[:restore]
+        shooter.restore
+      else
+        shooter.snapshot!
+      end
+    end
+
+    private
+
+    def parse_options
+      options = {}
+      OptionParser.new do |opts|
+        opts.banner = "Usage: script/snapshot [options]"
+
+        opts.on("-i", "--id [IDENTIFIER]", "The identifier for the snapshot (default current timestamp)") do |identifier|
+          options[:id] = identifier
+        end
+
+        opts.on("-s", "--storage [STORAGE]", "Select the storage mechanism to use (default local)") do |storage|
+          options[:storage] = storage.to_sym
+        end
+
+        opts.on("--restore", "Restores a snapshot given the identifier") do
+          options[:restore] = true
+        end
+      end.parse!
+
+      options
+    end
+  end
+end

data/lib/snapshooter/datastore/mysql.rb

@@ -0,0 +1,42 @@
+require 'digest/md5'
+
+module Snapshooter
+  module Datastore
+    class Mysql
+      def initialize(options={})
+        @options = options
+      end
+
+      def snapshot(tmp_file)
+        `mysqldump #{mysqldump_options} #{@options[:database]} > #{tmp_file}`
+      end
+
+      def restore(file)
+        `mysql #{mysql_options} #{@options[:database]} < #{file}`
+      end
+
+      def filename
+        "#{id}.sql"
+      end
+
+      private
+
+      def id
+        Digest::MD5.hexdigest(@options.to_s)
+      end
+
+      def mysql_options
+        options = []
+        options << "-u#{@options[:user]}"     if @options[:user]
+        options << "-p#{@options[:password]}" if @options[:password]
+        options << "-h#{@options[:host]}"     if @options[:host]
+
+        options.join(" ")
+      end
+
+      def mysqldump_options
+        ["--single-transaction", mysql_options].join(" ")
+      end
+    end
+  end
+end

data/lib/snapshooter/log.rb

@@ -0,0 +1,12 @@
+module Snapshooter
+  module Log
+    def with_log(message, &block)
+      t0 = Time.now
+      puts "[START] #{message}"
+      result = yield
+      t1 = Time.now
+      puts "[END] #{message} (it took #{(t1-t0)/60.0} minutes)"
+      result
+    end
+  end
+end

data/lib/snapshooter/storage/base.rb

@@ -0,0 +1,15 @@
+module Snapshooter
+  module Storage
+    class Base
+      include Log
+
+      def save(filename, &block)
+        raise "NotImplemented"
+      end
+
+      def get(filename, &block)
+        raise "NotImplemented"
+      end
+    end
+  end
+end

data/lib/snapshooter/storage/local.rb

@@ -0,0 +1,30 @@
+require 'fileutils'
+
+module Snapshooter
+  module Storage
+    class Local < Base
+      def save(filename, &block)
+        with_log("Save snapshots/#{filename} to local") do
+          FileUtils.mkdir_p "snapshots" unless File.exists?("snapshots")
+
+          file = Tempfile.new("snapshooter_local_storage")
+          file.close
+
+          begin
+            yield file.path
+
+            File.open "snapshots/#{filename}", "w" do |f|
+              f.write File.read(file.path)
+            end
+          ensure
+            file.unlink
+          end
+        end
+      end
+
+      def get(filename, &block)
+        yield "snapshots/#{filename}"
+      end
+    end
+  end
+end

data/lib/snapshooter/storage/s3.rb

@@ -0,0 +1,58 @@
+require 'tempfile'
+
+module Snapshooter
+  module Storage
+    class S3 < Base
+      def save(filename, &block)
+        with_log("Save #{bucket}/#{filename} to S3") do
+          directory = connection.directories.create(
+            :key    => bucket,
+            :public => false
+          )
+
+          file = Tempfile.new("snapshooter_s3_storage")
+          file.close
+
+          begin
+            yield file.path
+
+            directory.files.create(
+              :key    => filename,
+              :body   => File.open(file.path),
+              :public => false
+            )
+          ensure
+            file.unlink
+          end
+        end
+      end
+
+      def get(filename, &block)
+        directory = connection.directories.get(bucket)
+        file      = directory.files.get(filename)
+
+        with_tempfile file.body, &block
+      end
+
+      private
+
+      def bucket
+        "#{Snapshooter.environment}-snapshots-#{Snapshooter.application_name}"
+      end
+
+      def connection
+        FogFactory.storage
+      end
+
+      def with_tempfile(data)
+        file = Tempfile.new("snapshooter_s3_storage")
+        file.write data
+        file.close
+
+        yield file.path
+
+        file.unlink
+      end
+    end
+  end
+end

data/lib/snapshooter/version.rb

@@ -0,0 +1,3 @@
+module Snapshooter
+  VERSION = "0.0.1"
+end

data/lib/snapshooter.rb

@@ -0,0 +1,12 @@
+require 'snapshooter/version'
+require 'snapshooter/log'
+require 'snapshooter/base'
+require 'snapshooter/cli'
+require 'snapshooter/storage/base'
+require 'snapshooter/storage/local'
+require 'snapshooter/storage/s3'
+require 'snapshooter/datastore/mysql'
+
+module Snapshooter
+  mattr_accessor :datastores, :environment, :application_name
+end

data/snapshooter.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snapshooter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "snapshooter"
+  spec.version       = Snapshooter::VERSION
+  spec.authors       = ["Julio Santos", "Trae Robrock"]
+  spec.email         = ["julio@morgane.com", "trobrock@gmail.com"]
+  spec.description   = %q{Simple tool for snapshotting application data.}
+  spec.summary       = %q{Simple tool for snapshotting application data.}
+  spec.homepage      = "https://github.com/trobrock/snapshooter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: snapshooter
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Julio Santos
+- Trae Robrock
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-10-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id003 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Simple tool for snapshotting application data.
+email: 
+- julio@morgane.com
+- trobrock@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/snapshooter.rb
+- lib/snapshooter/base.rb
+- lib/snapshooter/cli.rb
+- lib/snapshooter/datastore/mysql.rb
+- lib/snapshooter/log.rb
+- lib/snapshooter/storage/base.rb
+- lib/snapshooter/storage/local.rb
+- lib/snapshooter/storage/s3.rb
+- lib/snapshooter/version.rb
+- snapshooter.gemspec
+homepage: https://github.com/trobrock/snapshooter
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.4
+signing_key: 
+specification_version: 4
+summary: Simple tool for snapshotting application data.
+test_files: []
+
+has_rdoc: