heroku_s3_backups 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4ebe2a44196fd136fe77c4ec9c6f7fb050e7784ba3ef4b4d8e4d7c33a33f85e
+  data.tar.gz: 35c81e1edd9a93f901ac863af86320cba8126a76d7532fdfd74e026f8b394e23
+SHA512:
+  metadata.gz: 23d1b2fab7143f3ce2f0fcdbef70c25e263c4368e8f044f34a654b72399a84a4351dae44c44f67e3ea3cd16e3b83f2cbe2ef7d205a442a71c221642b5ee936ca
+  data.tar.gz: aa0c592410ecf9ea85f8b4f79037719912e45db87802645aa46d5a0b2d7e33bb1e0a8936795826d45c62337cf959dfd62ebbc62162b83424c68fc0e1b8ab967b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joerodrig3@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in heroku_s3_backups.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    heroku_s3_backups (0.1.0)
+      s3 (~> 0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    diff-lcs (1.3)
+    proxies (0.2.3)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    s3 (0.3.26)
+      addressable
+      proxies
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  heroku_s3_backups!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 joerodrig
+
+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,64 @@
+# HerokuS3Backups
+
+**Experimental**
+
+This gem allows you to easily backup your PG database in Heroku to an S3 bucket.
+
+
+## Requirements
+- Heroku CLI
+- S3
+- {optional} Heroku Scheduler(automated backups)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "heroku_s3_backups"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heroku_s3_backups
+
+## Usage
+The following environment variables must be set:
+- S3_ACCESS_KEY_ID - Key of an account that has write access to the backup bucket
+- S3_SECRET_ACCESS_KEY - Key of an account that has write access to the backup bucket
+- S3_PRODUCTION_BACKUP_BUCKET - Bucket to backup db to
+- HEROKU_API_KEY - Auth token for Heroku to access the app’s DB settings(ie pg:backup). This can be generated by running `heroku auth:token` from the CLI.
+
+To run:
+`HerokuS3Backups.new("name-of-application").backup("folder/to/backup/to")`
+
+## Automating backups
+To automate backups in Heroku, you can create a rake task and add the ‘Heroku Scheduler’
+add-on to have it run the task in preset intervals.
+
+Example:
+1) Create a rake task in `db.rake` named `s3_production_backup`
+2) Have the task run `HerokuS3Backups.new("name-of-application").backup("folder/to/backup/to")`
+3) Set Heroku scheduler to run `rake db:s3_production_backup`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/heroku_s3_backups. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the HerokuS3Backups project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/heroku_s3_backups/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "heroku_s3_backups"
+
+# 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(__FILE__)

data/bin/setup

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

data/heroku_s3_backups.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "heroku_s3_backups/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "heroku_s3_backups"
+  spec.version       = HerokuS3Backups::VERSION
+  spec.authors       = ["joerodrig"]
+  spec.email         = ["joerodrig3@gmail.com"]
+
+  spec.summary       = "Easy Heroku DB backups to S3"
+  spec.homepage      = "https://github.com/ableco/heroku_s3_backups"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "s3", "~> 0.3"
+end

data/lib/heroku_cli.rb

@@ -0,0 +1,29 @@
+module HerokuCLI
+  VALID_HEROKU_CLI_PATHS = [
+    "/app/heroku-cli/bin/heroku",
+    "/usr/local/bin/heroku",
+    "/usr/bin/heroku"
+  ]
+
+  # Invokes a command using the Heroku CLI
+  # @param {string} arg
+  # @param {string} app_name
+  # @return nil
+  def HerokuCLI.cmd(arg, app_name)
+    system("#{HerokuCLI.path} #{arg} --app #{app_name}")
+  end
+
+  private
+
+  # Searches for the Heroku CLI and returns a string containing the found path,
+  # otherwise it raises an error
+  # @return {string}
+  def HerokuCLI.path
+    path = nil
+    VALID_HEROKU_CLI_PATHS.each { |p| path = p if File.exist?(p) }
+    if path.nil?
+      raise "Heroku cli not found. Install the heroku-cli and ensure the path is set properly"
+    end
+    path
+  end
+end

data/lib/heroku_s3_backups.rb

@@ -0,0 +1,64 @@
+require "s3"
+require "heroku_s3_backups/version"
+require "./lib/heroku_cli.rb"
+
+class HerokuS3Backups
+  include HerokuCLI
+
+  # @param {string} app_name
+  # @param {string} backup_location
+  # @return nil
+  def initialize(app_name)
+    @app_name = app_name
+  end
+
+  # @param {hash} options
+  # @return nil
+  def backup(backup_location, options = { capture: true })
+
+    # Capture backups if toggled
+    HerokuCLI.cmd("pg:backups:capture", @app_name) if options[:capture]
+
+    # Generate the filename for the backup
+    backup_filename = generate_backup_name
+
+    # Download the latest backup
+    # TODO: Be more explicit about which DB to download
+    HerokuCLI.cmd("pg:backups:download --output #{backup_filename}", @app_name)
+
+    store_on_s3(backup_location, backup_filename)
+
+    # Remove the backup from the system
+    system("rm #{backup_filename}")
+  end
+
+  private
+
+  # Stores the recently backed up file in a specified S3 bucket
+  # @param {string} backup_location
+  # @param {string} backup_filename
+  def store_on_s3(backup_location, backup_filename)
+    prod_backup_folder = AWS_S3().buckets.find(ENV["S3_PRODUCTION_BACKUP_BUCKET"]).objects(prefix: backup_location)
+
+    backup_obj = prod_backup_folder.build("#{backup_location}/#{backup_filename}")
+
+    # Need to do this to set content length for some reason
+    backup_obj.content = open(backup_filename)
+
+    backup_obj.save
+  end
+
+  def generate_backup_name
+    curr_time = Time.now.strftime("%Y-%m-%d_%H%M%S")
+    "backup_#{curr_time}.dump"
+  end
+
+  # Instantiates a new S3 service using the provided credentials
+  # @return S3::Service
+  def AWS_S3
+    S3::Service.new(
+      access_key_id: ENV["S3_ACCESS_KEY_ID"],
+      secret_access_key: ENV["S3_SECRET_ACCESS_KEY"]
+    )
+  end
+end

data/lib/heroku_s3_backups/version.rb

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: heroku_s3_backups
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joerodrig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: 
+email:
+- joerodrig3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- heroku_s3_backups.gemspec
+- lib/heroku_cli.rb
+- lib/heroku_s3_backups.rb
+- lib/heroku_s3_backups/version.rb
+homepage: https://github.com/ableco/heroku_s3_backups
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Easy Heroku DB backups to S3
+test_files: []