nxt_heroku_database_backup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6f9bc7071511bef9e7526bd263414833ed783263451bf9cb58a266645d6f985
+  data.tar.gz: 07f88c0d18c20745775d551da611238298adafa8d1ea1980f26a7f6b0f21e881
+SHA512:
+  metadata.gz: 60c9be3d5356e5911605a12d97ac93b9392acb6f4b5e6aa4174f3c0f01ceef8ae8cce44266ea308abe3f3aec1c78353f86cf121914060eab6031338369261a95
+  data.tar.gz: 4138a9f8a442239ac427bba1904931b800ae97adfcdc680c03228b058e91ec6137bae65bbd48fccf6e6ca0bea453c0965067076187b06242fa3d0281c7d6ebb8

data/.env.test

@@ -0,0 +1,4 @@
+DATABASE_BACKUP_AWS_ACCESS_KEY_ID=HEREGOESTHEKEYID
+DATABASE_BACKUP_AWS_SECRET_ACCESS_KEY=hereGOESTHEACTUALKEY
+DATABASE_BACKUP_AWS_REGION=eu-central-1
+HEROKU_APP_NAME=heroku-test-app

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.env.development.local
+.env.test.local
+
+!/**/.keep
+/storage/
+.idea/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    nxt_heroku_database_backup (0.1.0)
+      aws-sdk-s3
+      nxt_init
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    aws-eventstream (1.0.3)
+    aws-partitions (1.207.0)
+    aws-sdk-core (3.65.1)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-kms (1.24.0)
+      aws-sdk-core (~> 3, >= 3.61.1)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.48.0)
+      aws-sdk-core (~> 3, >= 3.61.1)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    dotenv (2.7.5)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.4.0)
+    method_source (0.9.2)
+    minitest (5.12.0)
+    nxt_init (0.1.5)
+      activesupport
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  dotenv
+  nxt_heroku_database_backup!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Andreas Robecke
+
+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,39 @@
+# NxtHerokuDatabaseBackup
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nxt_heroku_database_backup`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nxt_heroku_database_backup'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nxt_heroku_database_backup
+
+## Usage
+
+In order to use the `NxtHerokuDatabaseBackup::Manager`, you need to add the [heroku-buildpack-cli](https://github.com/heroku/heroku-buildpack-cli)
+to your heroku project. Then you probably want to add a rake task to you project and schedule it with the heroku scheduler to be called once a day or so.
+
+
+## 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]/nxt_heroku_database_backup.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "nxt_heroku_database_backup"
+
+# 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/lib/nxt_heroku_database_backup/manager.rb

@@ -0,0 +1,84 @@
+require 'open-uri'
+require 'aws-sdk-s3'
+
+module NxtHerokuDatabaseBackup
+  class Manager
+    include NxtInit
+
+    attr_init success_callback: -> { -> { true } },
+              environment: -> { default_environment },
+              backup_name: -> { default_backup_name },
+              backup_tmp_path: -> { default_backup_tmp_path }
+
+
+    def backup_latest_dump
+      database_backup = open(database_backup_url)
+      IO.copy_stream(database_backup, backup_tmp_path)
+      aws_object.upload_file(backup_tmp_path)
+      execute_success_callback
+    ensure
+      File.delete(backup_tmp_path) if File.exist?(backup_tmp_path)
+    end
+
+    private
+
+    def execute_success_callback
+      success_callback.call
+    end
+
+    def aws_object
+      @aws_object ||= begin
+        ensure_bucket_exists
+        Aws::S3::Resource.new(aws_credentials).bucket(bucket_name).object(backup_name)
+      end
+    end
+
+    def default_backup_name
+      "#{heroku_app_name}-#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}.dump"
+    end
+
+    def default_backup_tmp_path
+      "/tmp/#{backup_name}"
+    end
+
+    def database_backup_url
+      @database_backup_url ||= begin
+        run_heroku_cli_command "pg:backups:url"
+      end
+    end
+
+    def run_heroku_cli_command(command)
+      `heroku #{command} -a #{heroku_app_name}`
+    end
+
+    def heroku_app_name
+      @heroku_app_name ||= ENV.fetch('HEROKU_APP_NAME')
+    end
+
+    def ensure_bucket_exists
+      s3.head_bucket(bucket: bucket_name)
+    rescue Aws::S3::Errors::NotFound
+      s3.create_bucket(bucket: bucket_name)
+    end
+
+    def bucket_name
+      @bucket_name ||= "#{heroku_app_name}-db-backups"
+    end
+
+    def default_environment
+      Object.const_defined?('HerokuEnv') && HerokuEnv.env || 'development'
+    end
+
+    def s3
+      @s3 ||= Aws::S3::Client.new(**aws_credentials)
+    end
+
+    def aws_credentials
+      {
+        access_key_id: ENV.fetch('DATABASE_BACKUP_AWS_ACCESS_KEY_ID'),
+        secret_access_key: ENV.fetch('DATABASE_BACKUP_AWS_SECRET_ACCESS_KEY'),
+        region: ENV.fetch('DATABASE_BACKUP_AWS_REGION')
+      }
+    end
+  end
+end

data/lib/nxt_heroku_database_backup/version.rb

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

data/lib/nxt_heroku_database_backup.rb

@@ -0,0 +1,6 @@
+require 'nxt_init'
+require "nxt_heroku_database_backup/version"
+require "nxt_heroku_database_backup/manager"
+
+module NxtHerokuDatabaseBackup
+end

data/nxt_heroku_database_backup.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nxt_heroku_database_backup/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nxt_heroku_database_backup"
+  spec.version       = NxtHerokuDatabaseBackup::VERSION
+  spec.authors       = ["Andreas Robecke"]
+  spec.email         = ["a.robecke@getsafe.de"]
+
+  spec.summary       = %q{Backup your heroku databases in the cloud}
+  spec.homepage      = "https://www.getsafe.de"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://www.getsafe.de"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "aws-sdk-s3"
+  spec.add_dependency "nxt_init"
+  # spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  # spec.add_development_dependency "vcr"
+  # spec.add_development_dependency "webmock"
+  # spec.add_development_dependency "nxt_vcr_harness"
+  spec.add_development_dependency "dotenv"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: nxt_heroku_database_backup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andreas Robecke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  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: nxt_init
+  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: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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'
+- !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: dotenv
+  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: 
+email:
+- a.robecke@getsafe.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.test"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nxt_heroku_database_backup.rb
+- lib/nxt_heroku_database_backup/manager.rb
+- lib/nxt_heroku_database_backup/version.rb
+- nxt_heroku_database_backup.gemspec
+homepage: https://www.getsafe.de
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.getsafe.de
+  source_code_uri: https://www.getsafe.de
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Backup your heroku databases in the cloud
+test_files: []