pg_drive_backup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02b992847439cdf0579b8a2266b3388f56a045f0
+  data.tar.gz: ca2c38d42d80a217c7928c36439e8d6909fe8f59
+SHA512:
+  metadata.gz: 04d55bec48cff495104c9962328d713b9cbf205d54e85dbbaf861a8b5c3832e2e27440513e68c3315e80a10a86a4bdba9c06dd707e953e0b360639c32f27aff4
+  data.tar.gz: 01c8e460d47f2696f232478ef95dc6933166304ac9c785cd822043f2637f86a7b2b2f2e428c165ea656cd0f9dc8a0a8c67daa8bf004bcd003b55b6e9d05d4427

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  DisplayCopNames:    true
+  DisplayStyleGuide:  true
+  StyleGuideCopsOnly: true
+  TargetRubyVersion:  2.4
+
+Metrics/LineLength:
+  Max: 120
+
+Documentation:
+  Enabled: false
+
+FrozenStringLiteralComment:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Exclude:
+    - spec/**/*_spec.rb

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 pg_drive_backup.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kirill Shevchenko
+
+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,80 @@
+# PgDriveBackup
+
+Simple solution to make encrypted with [ccrypt](http://ccrypt.sourceforge.net/) PostgreSQL backups with storing on [Google Drive API](https://github.com/gimite/google-drive-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_drive_backup'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_drive_backup
+
+## Usage
+
+### Quick start
+
+Required database config credentials: 
+
+`config/initializers/pg_drive_backup.rb`
+```ruby
+PgDriveBackup::Settings.configure do |config|
+  config.database.name = 'database_name'
+  config.database.user = ENV.fetch('PG_USERNAME')
+  config.database.password = ENV.fetch('PG_PASSWORD')
+end
+```
+
+Add your google drive [authorization](https://github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md) JSON file to `config/drive.json`
+
+Generate your encryption key, for example:
+```bash
+openssl passwd -1 "somepassword"
+```
+
+And put it into `config/key.txt`
+
+Run it:
+```ruby
+PgDriveBackup::Run.call
+```
+
+It uploads your encrypted backup with name like `20171009083306693-dump.sql.cpt`
+
+To decrypt:
+```bash
+ccrypt -k config/key.txt -d 20171009083306693-dump.sql.cpt
+```
+
+### Tunning
+
+Config options:
+
+```ruby
+PgDriveBackup::Settings.configure do |config|
+  config.credentials_path = 'config/drive.json'       # default: 'config/drive.json'
+  config.key_path = 'config/key.txt'                  # default: 'config/key.txt'
+  config.prefix = '-dump'                             # default: '-dump'
+
+  config.database.name = 'database_name'              # default: nil
+  config.database.user = ENV.fetch('PG_USERNAME')     # default: nil
+  config.database.password = ENV.fetch('PG_PASSWORD') # default: nil
+  config.database.host = 'localhost'                  # default: 'localhost'
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kirillshevch/pg_drive_backup.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/lib/pg_drive_backup/run.rb

@@ -0,0 +1,22 @@
+module PgDriveBackup
+  class Run
+    def self.call
+      config = Settings.config
+
+      filename = Time.now.strftime('%Y%m%d%H%M%S%L') + config.prefix
+
+      system("PGPASSWORD=#{config.database.password}
+                pg_dump #{config.database.name} > #{filename}.sql
+                -h #{config.database.host}
+                -U #{config.database.user}")
+
+      system("ccrypt -k #{config.key_path} -e #{filename}.sql")
+
+      session = GoogleDrive::Session.from_service_account_key(config.credentials_path)
+
+      if session.upload_from_file("#{filename}.sql.cpt")
+        system("rm -r #{filename}.sql.cpt")
+      end
+    end
+  end
+end

data/lib/pg_drive_backup/settings.rb

@@ -0,0 +1,18 @@
+module PgDriveBackup
+  class Settings
+    extend ::Dry::Configurable
+
+    setting :credentials_path, 'config/drive.json'
+
+    setting :key_path, 'config/key.txt'
+
+    setting :prefix, '-dump'
+
+    setting :database do
+      setting :name
+      setting :user
+      setting :password
+      setting :host, 'localhost'
+    end
+  end
+end

data/lib/pg_drive_backup/version.rb

@@ -0,0 +1,3 @@
+module PgDriveBackup
+  VERSION = '0.1.0'
+end

data/lib/pg_drive_backup.rb

@@ -0,0 +1,5 @@
+require 'dry-configurable'
+require 'google_drive'
+require 'pg_drive_backup/version'
+require 'pg_drive_backup/settings'
+require 'pg_drive_backup/run'

data/pg_drive_backup.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pg_drive_backup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pg_drive_backup'
+  spec.version       = PgDriveBackup::VERSION
+  spec.authors       = ['Kirill Shevchenko']
+  spec.email         = ['hello@kirillshevch.com']
+
+  spec.summary       = 'PostgreSQL backups with ccrypt to Google Drive API'
+  spec.description   = 'Simple solution to make encrypted with ccrypt PostgreSQL backups with storing on Google Drive API'
+  spec.homepage      = 'https://github.com/kirillshevch/pg_drive_backup'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'google_drive', '~> 2.1.6'
+  spec.add_dependency 'dry-configurable', '~> 0.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'byebug', '~> 9.1.0'
+  spec.add_development_dependency 'rubocop', '~> 0.50.0'
+end

data/spec/pg_drive_backup/settings_spec.rb

@@ -0,0 +1,17 @@
+describe PgDriveBackup::Settings do
+  subject { PgDriveBackup::Settings.config }
+
+  context 'has default settings' do
+    it { expect(subject.credentials_path).to eq('config/drive.json') }
+    it { expect(subject.key_path).to eq('config/key.txt') }
+    it { expect(subject.prefix).to eq('-dump') }
+
+    it { expect(subject.database.host).to eq('localhost') }
+  end
+
+  context 'has not default database credentials' do
+    it { expect(subject.database.name).to be_nil }
+    it { expect(subject.database.user).to be_nil }
+    it { expect(subject.database.password).to be_nil }
+  end
+end

data/spec/pg_drive_backup_spec.rb

@@ -0,0 +1,5 @@
+describe PgDriveBackup do
+  it 'has a version number' do
+    expect(PgDriveBackup::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+require 'byebug'
+require 'pg_drive_backup'
+
+RSpec.configure do |config|
+  config.order = :random
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: pg_drive_backup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kirill Shevchenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google_drive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.6
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+description: Simple solution to make encrypted with ccrypt PostgreSQL backups with
+  storing on Google Drive API
+email:
+- hello@kirillshevch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circle.yml
+- lib/pg_drive_backup.rb
+- lib/pg_drive_backup/run.rb
+- lib/pg_drive_backup/settings.rb
+- lib/pg_drive_backup/version.rb
+- pg_drive_backup.gemspec
+- spec/pg_drive_backup/settings_spec.rb
+- spec/pg_drive_backup_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kirillshevch/pg_drive_backup
+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.5.2
+signing_key: 
+specification_version: 4
+summary: PostgreSQL backups with ccrypt to Google Drive API
+test_files: []