pg_drive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab3ae3369f6b249ed79922616d3e5899e76cf2be
+  data.tar.gz: 91f66db35af2c2c69187d6d27fd78f46b9ee4249
+SHA512:
+  metadata.gz: e14d16c331a36ba42287b08edbab61dc28b068e4e5cb3b6fb6cd7cc1535a61cef1bd9e98e006312059fac13403865e5054613b3729926c10a7589913c8336b43
+  data.tar.gz: 996c3384f8e6bf9bc05829b41a84fade7719cfd4a3358ac627485a0318ac6a0fdc749d14f1148946aecb5b87a3bc16a8cda05158929de0bfab992d1a45935440

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'vendor/**/*'
+    - 'bin/**/*'
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+Metrics/LineLength:
+    Max: 90
+Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+Style/IfUnlessModifier:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+pg_drive

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gal Tsubery
+
+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,54 @@
+# PgDrive
+
+This library is intended to be a minimalist backup solution for Postgres, Rails and Goodle Drive.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_drive'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_drive
+
+You need to (https://console.developers.google.com)[create] a new project and credential in order to use google drive. Make sure the credential is for "Oauth Client" and the application type is "Other".
+Set the following environment variables:
+```
+ENV['PG_DRIVE_GOOGLE_KEY']="Your credential client id"
+ENV['PG_DRIVE_GOOGLE_SECRET']="Your credential secret"
+```
+These values should be easy to find after you created new credentials.
+
+After that you should run the following command inside rails console and follow the instructions.
+```ruby
+PgDrive.setup_credentials
+```
+This process is will generate a new token so the app could use a specific user's google drive account to store the backup files.
+
+## Usage
+
+```ruby
+PgDrive.perform
+```
+Creates a new backup and uploads it to google drive.
+You can run this command in your favorite queueing system and favorite scheduler.
+
+## Notes
+Keep in mind the backup dump and zipping are all done in memory. If your database is more than 50mb you should find a better solution.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tsubery/pg_drive.
+
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pg_drive"
+
+# 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,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/pg_drive/dump.rb

@@ -0,0 +1,47 @@
+module PgDrive
+  module Dump
+    class << self
+      def call
+        stdin, out_and_error, wait_thr = exec_pg_dump
+        read_with_timeout(out_and_error, wait_thr)
+      ensure
+        stdin&.close
+        out_and_error&.close
+      end
+
+      def read_with_timeout(input, wait_thr)
+        result = Timeout.timeout(backup_timeout_seconds) { input.read }
+
+        unless wait_thr.value.success? || result.blank?
+          raise BackupFailed, "Exit status: #{wait_thr.value.exitstatus}: #{result}"
+        end
+        result
+      rescue Timeout::Error
+        if (kill_pid = wait_thr[:pid])
+          Process.kill(9, Process.getpgid(kill_pid))
+        end
+        raise BackupFailed, "Timeout error for backup_command #{kill_pid}"
+      end
+
+      def exec_pg_dump
+        Open3.popen2e(
+          pg_env,
+          BACKUP_CMD,
+          pgroup: true
+        )
+      end
+
+      def pg_env
+        PG_ENV_MAP.map { |k, v| [k, db_conf[v].to_s] }.to_h
+      end
+
+      def db_conf
+        @db_conf ||= Rails.configuration.database_configuration[Rails.env]
+      end
+
+      def backup_timeout_seconds
+        DEFAULT_BACKUP_TIMEOUT_SECONDS
+      end
+    end
+  end
+end

data/lib/pg_drive/uploader.rb

@@ -0,0 +1,53 @@
+module PgDrive
+  module Uploader
+    Drive = Google::Apis::DriveV2
+    AUTH_SCOPE = "https://www.googleapis.com/auth/drive".freeze
+    RETRY_COUNT = 3
+
+    class << self
+      def call(content)
+        drive = Drive::DriveService.new
+        drive.authorization = credentials
+        drive.insert_file(
+          Drive::File.new(title: "backup-#{Time.now.to_i}"),
+          upload_source: gzip(content),
+          content_type: GZIP_MIME_TYPE,
+          options: { retries: RETRY_COUNT }
+        )
+      end
+
+      def gzip(string)
+        gzipped_io = StringIO.new
+        writer = Zlib::GzipWriter.new(gzipped_io)
+        writer.write(string)
+        writer.close
+        StringIO.new(gzipped_io.string)
+      end
+
+      def client_id
+        Google::Auth::ClientId.new(google_key, google_secret)
+      end
+
+      def google_key
+        ENV.fetch("PG_DRIVE_GOOGLE_KEY")
+      end
+
+      def google_secret
+        ENV.fetch("PG_DRIVE_GOOGLE_SECRET")
+      end
+
+      def credentials
+        refresh_token = ENV["PG_DRIVE_CREDENTIALS"]
+        if refresh_token.nil? || refresh_token.empty?
+          raise InvalidEnvironment, MISSING_CRED_WARNING
+        end
+        Google::Auth::UserRefreshCredentials.new(
+          client_id: google_key,
+          client_secret: google_secret,
+          refresh_token: refresh_token,
+          scope: AUTH_SCOPE
+        )
+      end
+    end
+  end
+end

data/lib/pg_drive/version.rb

@@ -0,0 +1,3 @@
+module PgDrive
+  VERSION = "0.1.0".freeze
+end

data/lib/pg_drive.rb

@@ -0,0 +1,60 @@
+require "pg_drive/version"
+require "google/apis/drive_v2"
+require "googleauth"
+require "pg_drive/uploader"
+require "pg_drive/dump"
+
+module PgDrive
+  InvalidEnvironment = Class.new(StandardError)
+  BackupFailed = Class.new(StandardError)
+
+  OOB_URI = "urn:ietf:wg:oauth:2.0:oob".freeze
+  DEFAULT_BACKUP_TIMEOUT_SECONDS = 60 * 5 # 5 minutes
+  MISSING_CRED_WARNING = "Please use the run #{self}.setup_credentials"\
+    " from console to set up credentials".freeze
+  CREDENTIALS_INTRO = "Please open your browser and go to the following url."\
+    "Login with the user you wish to use as target for backup".freeze
+  CREDENTIALS_ENV_INSTRUCTIONS = "Please set the following line as the value of "\
+  '"PG_DRIVE_CREDENTIALS" key in the environment hash:'.freeze
+
+  BACKUP_CMD = "pg_dump -c -C -b".freeze
+  PG_ENV_MAP = {
+    "PGPASSWORD" => "password",
+    "PGDATABASE" => "database",
+    "PGHOST" => "host",
+    "PGPORT" => "port",
+    "PGUSER" => "username",
+  }.freeze
+  GZIP_MIME_TYPE = "application/x-gzip".freeze
+
+  class << self
+    def perform
+      Uploader.call(Dump.call)
+    end
+
+    def setup_credentials
+      puts CREDENTIALS_INTRO
+      puts authorizer.get_authorization_url(base_url: OOB_URI)
+      puts "Please enter the token you receive for further instructions"
+      code = gets
+      puts CREDENTIALS_ENV_INSTRUCTIONS
+      puts refresh_token_from_code(code)
+    end
+
+    def authorizer
+      Google::Auth::UserAuthorizer.new(
+        Uploader.client_id,
+        Uploader::AUTH_SCOPE,
+        nil
+      )
+    end
+
+    def refresh_token_from_code(code)
+      authorizer.get_credentials_from_code(
+        user_id: :owner,
+        code: code,
+        base_url: OOB_URI
+      )
+    end
+  end
+end

data/pg_drive.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pg_drive/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pg_drive"
+  spec.version       = PgDrive::VERSION
+  spec.authors       = ["Gal Tsubery"]
+  spec.email         = ["gal.tsubery@gmail.com"]
+
+  spec.summary       = "Backup rails postgres to google drive"
+  spec.description   = "This gem backs up postgres and stores the backup in google drive"
+  spec.homepage      = "http://github.com/tsubery/pg_drive/"
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "google-api-client", "0.9"
+  spec.add_dependency "pg" # Just to make sure we are using postgres
+  spec.add_dependency "rails", [">4.0.0", "<6.0.0"]
+  # Just to make sure we are using postgres
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: pg_drive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gal Tsubery
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rubocop
+  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: 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: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: This gem backs up postgres and stores the backup in google drive
+email:
+- gal.tsubery@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pg_drive.rb
+- lib/pg_drive/dump.rb
+- lib/pg_drive/uploader.rb
+- lib/pg_drive/version.rb
+- pg_drive.gemspec
+homepage: http://github.com/tsubery/pg_drive/
+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.1
+signing_key: 
+specification_version: 4
+summary: Backup rails postgres to google drive
+test_files: []