s3streambackup 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+ruby "1.9.3"
+
+gem "cli", "~> 1.3"
+gem "aws-sdk", "~> 1.10"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+	gem "rspec", "~> 2.8"
+	gem "rdoc", "~> 3.12"
+	gem "cucumber", ">= 0"
+	gem "bundler", "~> 1.0"
+	gem "jeweler", "~> 1.8"
+	gem "simplecov-rcov", ">= 0"
+end
+

data/Gemfile.lock

@@ -0,0 +1,88 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    aws-sdk (1.10.0)
+      json (~> 1.4)
+      nokogiri (>= 1.4.4)
+      uuidtools (~> 2.1)
+    builder (3.2.2)
+    cli (1.3.1)
+    cucumber (1.3.5)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.0)
+      multi_json (~> 1.7.5)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    gherkin (2.12.0)
+      multi_json (~> 1.3)
+    git (1.2.5)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    jeweler (1.8.6)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.7.8)
+    multi_test (0.0.2)
+    multi_xml (0.5.4)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    simplecov-rcov (0.2.3)
+      simplecov (>= 0.4.1)
+    uuidtools (2.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-sdk (~> 1.10)
+  bundler (~> 1.0)
+  cli (~> 1.3)
+  cucumber
+  jeweler (~> 1.8)
+  rdoc (~> 3.12)
+  rspec (~> 2.8)
+  simplecov-rcov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Jakub Pastuszek
+
+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,49 @@
+# S3 Stream Backup
+
+Stores data from STDIN in S3 object using multipart upload and removes oldest backups to keep maximum desired backup object count.
+
+## Installing
+
+You will need the following system packages installed: `gcc`, `make` and `libxslt-devel`.
+
+Then you can install the gem as usual:
+
+```bash
+gem install s3streambackup
+```
+
+## Usage
+
+```bash
+s3streambackup mybucket some-backup < some-backup.file
+```
+
+Note that you should have your S3 key and secret set in environment `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` or you can specify them in command line with `--key` and `--secret`.
+
+You can store your backup object within prefix by using `--prefix` option e.g.: `--prefix backups/server1/`.
+
+By default two backup copies will be kept. You can change this number by using `--keep` options.
+
+For other usage information use `--help`.
+
+### PostgreSQL backup example
+
+```bash
+/bin/su - postgres -c '/usr/bin/pg_dumpall' | xz -2 | s3streambackup --keep 7 --prefix backups/zabbix/ mybucket postgress-all
+```
+
+## Contributing to S3 Stream Backup
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 Jakub Pastuszek. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "s3streambackup"
+  gem.homepage = "http://github.com/jpastuszek/s3streambackup"
+  gem.license = "MIT"
+  gem.summary = %Q{streaming backup of STDIN to S3 object}
+  gem.description = %Q{Stores data from STDIN in S3 object using multipart upload and removes oldest backups to keep maximum desired backup object count.}
+  gem.email = "jpastuszek@gmail.com"
+  gem.authors = ["Jakub Pastuszek"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "s3streambackup #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/s3streambackup

@@ -0,0 +1,117 @@
+#!/usr/bin/env ruby
+
+require 'cli'
+require 'aws-sdk'
+require 'logger'
+
+## HACK: Auto select region based on location_constraint
+module AWS
+	class S3
+		class BucketCollection
+			def [](name)
+				# if name is DNS compatible we still cannot use it for writes if it does contain dots
+				return S3::Bucket.new(name.to_s, :owner => nil, :config => config) if client.dns_compatible_bucket_name?(name) and not name.include? '.'
+
+				# save region mapping for bucket for futher requests
+				@@location_cache = {} unless defined? @@location_cache
+				# if we have it cased use it; else try to fetch it and if it is nil bucket is in standard region
+				region = @@location_cache[name] || @@location_cache[name] = S3::Bucket.new(name.to_s, :owner => nil, :config => config).location_constraint || @@location_cache[name] = :standard
+
+				# no need to specify region if bucket is in standard region
+				return S3::Bucket.new(name.to_s, :owner => nil, :config => config) if region == :standard
+
+				# use same config but with region specified for buckets that are not DNS compatible or have dots and are not in standard region
+				S3::Bucket.new(name.to_s, :owner => nil, :config => config.with(region: region))
+			end
+		end
+	end
+end
+
+settings = CLI.new do
+		stdin :data
+	    option :key, 
+			short: :k,
+			description: 'S3 key',
+			default: ENV['AWS_ACCESS_KEY_ID']
+		option :secret, 
+			short: :s,
+			description: 'S3 key secret',
+			default_label: '<secret>',
+			default: ENV['AWS_SECRET_ACCESS_KEY']
+		option :prefix,
+			short: :p,
+			description: 'prefix under which the objects will be kept',
+			default: ''
+		option :keep,
+			short: :K,
+			description: 'how many backup file to keep',
+			cast: Integer,
+			default: 2
+		option :log_file,
+			short: :l,
+			description: 'location of log file'
+		switch :plain,
+			description: 'use plain connections instead of SSL to S3'
+		switch :debug,
+			description: 'log debug messages'
+		argument :bucket,
+			description: 'name of bucket to upload data to'
+		argument :name,
+			description: 'name under which the object will be stored'
+end.parse! do |settings|
+	fail 'AWS_ACCESS_KEY_ID environment not set and --key not used' unless settings.key
+	fail 'AWS_SECRET_ACCESS_KEY environment not set and --secret not used' unless settings.secret
+end
+
+log = Logger.new(settings.log_file ? settings.log_file : STDOUT)
+log.formatter = proc do |severity, datetime, progname, msg|
+	"[#{datetime.utc.strftime "%Y-%m-%d %H:%M:%S.%6N %Z"}] [#{$$}] #{severity}: #{msg.strip}\n"
+end
+
+log.level = Logger::INFO
+log.level = Logger::DEBUG if settings.debug
+
+begin
+	s3 = AWS::S3.new(
+		access_key_id: settings.key,
+		secret_access_key: settings.secret,
+		logger: log,
+		log_level: :debug,
+		use_ssl: ! settings.plain
+	)
+
+	upload_date = Time.now.utc.strftime "%y%m%d_%H%M%S"
+	prefix = "#{settings.prefix}#{settings.name}.backup."
+	path = "#{prefix}#{upload_date}"
+
+	bucket = s3.buckets[settings.bucket]
+	backup = bucket.objects[path] 
+	log.info "writting to: #{path}"
+
+	# make sure we use multipart upload
+	total_bytes = 0
+	backup.write(estimated_content_length: 10 * 1024 ** 3) do |buffer, bytes|
+		log.info "#{total_bytes} bytes written..."
+		data = settings.stdin.read(bytes)
+		total_bytes += data.bytesize
+		buffer.write data
+	end
+	log.info "total upload size: #{total_bytes}"
+
+	backups = bucket.objects.with_prefix(prefix).to_a
+
+	log.info "keeping maximum #{settings.keep} latest buckups of #{backups.length} storred"
+
+	if backups.length > settings.keep
+		backups.take(backups.length - settings.keep).each do |backup|
+			log.info "removing oldest backup: #{backup.key}"
+			backup.delete
+		end
+	end
+rescue => error
+	msg = "#{error.class.name}: #{error.message}\n#{error.backtrace.join("\n")}"
+	log.error msg
+	STDERR.write msg 
+	exit 10
+end
+

data/features/s3streambackup.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 's3streambackup'
+
+require 'rspec/expectations'

data/s3streambackup.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "s3streambackup"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jakub Pastuszek"]
+  s.date = "2013-08-05"
+  s.description = "Stores data from STDIN in S3 object using multipart upload and removes oldest backups to keep maximum desired backup object count."
+  s.email = "jpastuszek@gmail.com"
+  s.executables = ["s3streambackup"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/s3streambackup",
+    "features/s3streambackup.feature",
+    "features/step_definitions/s3streambackup_steps.rb",
+    "features/support/env.rb",
+    "s3streambackup.gemspec",
+    "spec/s3streambackup_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/jpastuszek/s3streambackup"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "streaming backup of STDIN to S3 object"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<cli>, ["~> 1.3"])
+      s.add_runtime_dependency(%q<aws-sdk>, ["~> 1.10"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_development_dependency(%q<simplecov-rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<cli>, ["~> 1.3"])
+      s.add_dependency(%q<aws-sdk>, ["~> 1.10"])
+      s.add_dependency(%q<rspec>, ["~> 2.8"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_dependency(%q<simplecov-rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<cli>, ["~> 1.3"])
+    s.add_dependency(%q<aws-sdk>, ["~> 1.10"])
+    s.add_dependency(%q<rspec>, ["~> 2.8"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8"])
+    s.add_dependency(%q<simplecov-rcov>, [">= 0"])
+  end
+end
+

data/spec/s3streambackup_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "S3streambackup" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 's3streambackup'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: s3streambackup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jakub Pastuszek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Stores data from STDIN in S3 object using multipart upload and removes
+  oldest backups to keep maximum desired backup object count.
+email: jpastuszek@gmail.com
+executables:
+- s3streambackup
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/s3streambackup
+- features/s3streambackup.feature
+- features/step_definitions/s3streambackup_steps.rb
+- features/support/env.rb
+- s3streambackup.gemspec
+- spec/s3streambackup_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jpastuszek/s3streambackup
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1306132470382039118
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: streaming backup of STDIN to S3 object
+test_files: []