heroku_pg_backups_archive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 947869e18c118d8c6b5af03214407ce74bdd16a8
+  data.tar.gz: 24adac58e9eea4a0554ab6f1d65875cde97ba56f
+SHA512:
+  metadata.gz: a73b5e1905f54a1c91fdd7694c71688b9df08a22404c7db22a0d794013a1a7af286cc0c070d66d9e4f4255a8f60993ff5bb88a03c0972ff0901f62801a1302fe
+  data.tar.gz: ffa5a6425fe3b4a4c8978e220cc23ee8553f2d624c2bd5c27217f5b23aa9697f8e7cbb574a50a993484b1ad863ef40f18c4cf696ce42cff09d093c46169973e5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Brent Wheeldon
+
+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,59 @@
+# HerokuPgBackupsArchive
+
+This gem allows you to backup your heroku postgres database and archive it to S3, optionally with [SSE-C](http://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'heroku_pg_backups_archive'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heroku_pg_backups_archive
+
+## Usage
+
+There is some configuration required. For a rails application, create a file like `config/initializers/heroku_pg_backups_archive.rb` with contents like:
+
+```
+HerokuPgBackupsArchive.configure do |config|
+  # Required
+  config.app_name = "your-heroku-app-name"
+  config.bucket_name = "your-s3-bucket-name"
+
+  # Optional
+  config.sse_customer_key = "your-sse-c-key" # leave blank to disable SSE-C
+  config.heroku_toolbelt_path = "path/to/heroku/executable" # defaults to `vendor/heroku-toolbelt/bin/heroku` when not explicitly set
+  config.aws_access_key_id = "aws-secret-key-id" # defaults to `ENV["AWS_ACCESS_KEY_ID"]` when not explicitly set
+  config.aws_secret_access_key = "aws-secret-access-key" # defaults to `ENV["AWS_SECRET_ACCESS_KEY"]` when not explicitly set
+end
+```
+
+To run the backup, simply run:
+
+```
+rake heroku_pg_backups_archive
+```
+
+To make the heroku toolbelt available on your dyno, you can use [heroku-buildpack-toolbelt](https://github.com/gregburek/heroku-buildpack-toolbelt).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/heroku_pg_backups_archive/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,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "heroku_pg_backups_archive"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/heroku_pg_backups_archive.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heroku_pg_backups_archive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "heroku_pg_backups_archive"
+  spec.version       = HerokuPgBackupsArchive::VERSION
+  spec.authors       = ["Hightower"]
+  spec.email         = ["engineering@gethightower.com"]
+
+  spec.summary       = %q{Backup your heroku PG database, and archive it to S3.}
+  spec.description   = %q{Backup your heroku PG database, and archive it to S3 optionally with SSE-CA.}
+  spec.homepage      = "https://www.github.com/hightower/heroku_pg_backups_archive"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk-v1", "~> 0"
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0"
+end

data/lib/heroku_pg_backups_archive.rb

@@ -0,0 +1,24 @@
+require "heroku_pg_backups_archive/version"
+require "heroku_pg_backups_archive/config"
+require "heroku_pg_backups_archive/backup"
+require "heroku_pg_backups_archive/backup_archive"
+require "heroku_pg_backups_archive/backup_failed_error"
+require "heroku_pg_backups_archive/toolbelt_helper"
+require "heroku_pg_backups_archive/railtie"
+
+module HerokuPgBackupsArchive
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield config
+    end
+
+    def backup_and_archive
+      backup = Backup.create
+      BackupArchive.perform(backup)
+    end
+  end
+end

data/lib/heroku_pg_backups_archive/backup.rb

@@ -0,0 +1,33 @@
+module HerokuPgBackupsArchive
+  class Backup
+    def self.create
+      backup_output = ToolbeltHelper.capture_backup
+      new(backup_output)
+    end
+
+    attr_reader :id
+
+    def initialize(backup_output)
+      @id = extract_id(backup_output)
+    end
+
+    def url
+      @url ||= ToolbeltHelper.fetch_backup_public_url(id).chomp
+    end
+
+    def finished_at
+      @finished_at ||= begin
+        info = ToolbeltHelper.fetch_backup_info(id)
+        Time.parse(info.match(/Finished:\s*(.*)\n/)[1])
+      end
+    end
+
+    private
+
+    def extract_id(backup_output)
+      matches = backup_output.match(/---backup---> (.*)\n/)
+      raise BackupFailedError.new(backup_output) unless matches
+      matches[1]
+    end
+  end
+end

data/lib/heroku_pg_backups_archive/backup_archive.rb

@@ -0,0 +1,55 @@
+require "open-uri"
+require "aws-sdk-v1"
+require "base64"
+
+module HerokuPgBackupsArchive
+  class BackupArchive
+    def self.perform(backup)
+      backup_archive = new(backup)
+      backup_archive.perform
+    end
+
+    def initialize(backup)
+      @backup = backup
+    end
+
+    def perform
+      bucket.objects[archive_path].write(backup_data, write_options)
+    end
+
+    private
+
+    attr_reader :backup
+
+    def bucket
+      @bucket ||= s3.buckets[HerokuPgBackupsArchive.config.bucket_name]
+    end
+
+    def s3
+      @s3 ||= AWS::S3.new(
+        access_key_id: HerokuPgBackupsArchive.config.aws_access_key_id,
+        secret_access_key: HerokuPgBackupsArchive.config.aws_secret_access_key
+      )
+    end
+
+    def archive_path
+      "#{backup.finished_at.strftime("%Y/%m/%d")}/#{backup.finished_at.iso8601}"
+    end
+
+    def backup_data
+      open(backup.url)
+    end
+
+    def write_options
+      unless HerokuPgBackupsArchive.config.sse_customer_key.nil?
+        {
+          sse_customer_algorithm: :AES256,
+          sse_customer_key: Base64.encode64(HerokuPgBackupsArchive.config.sse_customer_key),
+          sse_customer_key_md5: Base64.encode64(OpenSSL::Digest::MD5.digest(HerokuPgBackupsArchive.config.sse_customer_key))
+        }
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/heroku_pg_backups_archive/backup_failed_error.rb

@@ -0,0 +1,4 @@
+module HerokuPgBackupsArchive
+  class BackupFailedError < StandardError
+  end
+end

data/lib/heroku_pg_backups_archive/config.rb

@@ -0,0 +1,11 @@
+module HerokuPgBackupsArchive
+  class Config
+    attr_accessor :heroku_toolbelt_path, :app_name, :sse_customer_key, :bucket_name, :aws_access_key_id, :aws_secret_access_key
+
+    def initialize
+      @heroku_toolbelt_path = "vendor/heroku-toolbelt/bin/heroku"
+      @aws_access_key_id = ENV["AWS_ACCESS_KEY_ID"]
+      @aws_secret_access_key = ENV["AWS_SECRET_ACCESS_KEY"]
+    end
+  end
+end

data/lib/heroku_pg_backups_archive/railtie.rb

@@ -0,0 +1,9 @@
+if defined?(Rails)
+  module HerokuPgBackupsArchive
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load "tasks/heroku_pg_backups_archive.rake"
+      end
+    end
+  end
+end

data/lib/heroku_pg_backups_archive/toolbelt_helper.rb

@@ -0,0 +1,27 @@
+module HerokuPgBackupsArchive
+  module ToolbeltHelper
+    class << self
+      def capture_backup
+        run("pg:backups capture -a #{HerokuPgBackupsArchive.config.app_name}")
+      end
+
+      def fetch_backup_public_url(backup_id)
+        run("pg:backups public-url #{backup_id} -q -a #{HerokuPgBackupsArchive.config.app_name}")
+      end
+
+      def fetch_backup_info(backup_id)
+        run("pg:backups info #{backup_id} -a #{HerokuPgBackupsArchive.config.app_name}")
+      end
+
+      private
+
+      def run(arguments)
+        command = "#{HerokuPgBackupsArchive.config.heroku_toolbelt_path} #{arguments}"
+        puts "Running: #{command}"
+        output = `#{command}`
+        puts "Output:\n#{output}"
+        output
+      end
+    end
+  end
+end

data/lib/heroku_pg_backups_archive/version.rb

@@ -0,0 +1,3 @@
+module HerokuPgBackupsArchive
+  VERSION = "0.1.0"
+end

data/lib/tasks/heroku_pg_backups_archive.rake

@@ -0,0 +1,4 @@
+desc "Capture a backup and archive it to S3"
+task heroku_pg_backups_archive: :environment do
+  HerokuPgBackupsArchive.backup_and_archive
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: heroku_pg_backups_archive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hightower
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-v1
+  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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Backup your heroku PG database, and archive it to S3 optionally with
+  SSE-CA.
+email:
+- engineering@gethightower.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- heroku_pg_backups_archive.gemspec
+- lib/heroku_pg_backups_archive.rb
+- lib/heroku_pg_backups_archive/backup.rb
+- lib/heroku_pg_backups_archive/backup_archive.rb
+- lib/heroku_pg_backups_archive/backup_failed_error.rb
+- lib/heroku_pg_backups_archive/config.rb
+- lib/heroku_pg_backups_archive/railtie.rb
+- lib/heroku_pg_backups_archive/toolbelt_helper.rb
+- lib/heroku_pg_backups_archive/version.rb
+- lib/tasks/heroku_pg_backups_archive.rake
+homepage: https://www.github.com/hightower/heroku_pg_backups_archive
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Backup your heroku PG database, and archive it to S3.
+test_files: []