calevipoeg-zeus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6820060f9e8309528aac997df89e9724c21c8a9533d2bac39b3172b05ca6d24a
+  data.tar.gz: 99a4d6699a253c6c8047a477294d0e2e179ce3226295051a7606c4af79aecb6b
+SHA512:
+  metadata.gz: b6642017621bf5afe8ff790282081cab1bafac9c8973c95b5a960a542093f96c6572fbb26bdef08ab3ef632356ff80ea461546dd1c997e026bb3c02ec5e17123
+  data.tar.gz: 8d884d1f4fc000b212fad4bcc625d091f09e1987fb151ad7723917a9ef930b7c0911f03a963beda42ef0e2aa80c8c55ae869f58e6103b5464340c3df38b3d22b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status
+/*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zeus.gemspec
+gemspec
+
+gem 'rake'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    zeus (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  zeus!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,61 @@
+# Zeus
+
+This is a helper package for my own projects
+
+## Installation
+
+```ruby
+gem 'calevipoeg-zeus', require: 'zeus'
+```
+
+## SSH Tunneling
+
+```ruby
+Zeus::SshTunnel.link('root@db-01', '5555:localhost:5432') do
+  system('telnet localhost 5555')
+end
+```
+
+### S3 IO
+
+This class represents an IO object (File, StringIO) which can be
+uploaded to the S3-compatible storage with PUT or multipart requests
+S3Iterate
+```ruby
+io = Zeus::S3Io.new(File.open('movie.mp4'))
+s3 = Aws::S3::Client.new
+
+io.upload(s3, bucket: 'bucket', key: 'movies/movie.mp4') do |progress|
+  puts "[#{progress.to_i}%] Uploading #{key}"
+end
+```
+
+### S3 iterable
+
+```ruby
+s3 = Aws::S3::Client.new
+
+Zeus::S3Iterate.new(s3).delete_if(bucket: 'bucket', prefix: 'movies/') do |file|
+  break(false) unless 2.years.ago >= file.last_modified
+
+  puts "[-] removing (last mod #{file.last_modified}) #{file.key}"
+end
+```
+
+### PostgreSQL Base Backup
+
+```ruby
+begin
+  s3 = Aws::S3::Client.new
+  pg = Zeus::PgBaseBackup.new(s3: s3, bucket: 'backup')
+  
+  Zeus::SshTunnel.link('root@db', '5555:localhost:5432') do
+    pg.dump(port: '5555', user: 'replica', password: 'password')
+  end
+  
+  pg.upload
+  pg.clear(12.days.ago)
+ensure
+  pg.unlink
+end
+```

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 'zeus'
+
+# 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/release.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+rm ./*.gem
+gem build zeus.gemspec
+gem push calevipoeg-zeus-*

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/zeus.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'zeus/version'
+
+module Zeus
+  autoload :PgBaseBackup, 'zeus/pg_base_backup'
+  autoload :S3Io, 'zeus/s3_io'
+  autoload :S3Iterate, 'zeus/s3_iterate'
+  autoload :SshTunnel, 'zeus/ssh_tunnel'
+end

data/lib/zeus/pg_base_backup.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Zeus
+  class PgBaseBackup
+    attr_reader :s3, :bucket, :dir, :prefix
+
+    # @param s3 [Aws::Client::S3]
+    def initialize(s3:, bucket:, prefix: 'postgresql')
+      @dir = Dir.mktmpdir('pg-base-backup')
+      @s3 = s3
+      @bucket = bucket
+      @prefix = prefix
+    end
+
+    def dump(user:, password: nil, port: '5432', host: 'localhost', rate: '10M')
+      system <<~CMD.tr("\n", ' '), exception: true
+        PG_COLOR=always PGPASSWORD=#{Shellwords.escape password} pg_basebackup
+        -D #{dir.pathmap} -Ft -z -Xs
+        --host #{host}
+        --port #{port}
+        --username #{user}
+        --max-rate="#{rate}"
+        --write-recovery-conf
+        --progress
+        --verbose
+      CMD
+    end
+
+    def upload
+      Dir.entries(dir.pathmap).each do |filename|
+        next if filename.start_with?('.')
+
+        key = File.join(folder, filename)
+        file = File.open(File.join(dir, filename), 'rb')
+        io = Zeus::S3Io.new(file)
+
+        io.upload(s3, bucket: bucket, key: key) do |progress|
+          puts "[#{progress.to_i}%] Uploading #{key}"
+        end
+      end
+    end
+
+    # clear previously sored backup
+    # @param [Time]
+    def clear(past_time)
+      Zeus::S3Iterate.new(s3).delete_if(bucket: bucket, prefix: prefix) do |file|
+        break(false) unless past_time >= file.last_modified
+
+        puts "[-] removing (last mod #{file.last_modified}) #{file.key}"
+      end
+    end
+
+    def unlink
+      FileUtils.remove_entry(dir.pathmap) if File.directory?(dir.pathmap)
+    end
+
+    private
+
+    def folder
+      "#{prefix}/#{timestamp}"
+    end
+
+    def timestamp
+      @timestamp ||= Time.current.strftime('%Y-%m-%d-%H-%M')
+    end
+  end
+end

data/lib/zeus/s3_io.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-s3'
+
+# === S3 decorator for the IO object
+module Zeus
+  class S3Io
+    # * Размер каждой части, кроме последней, должен быть не менее 5MB
+    # * Номер — это целое число в промежутке от 1 до 10000 включительно
+    DEFAULT_PART_SIZE = 1024 * 1024 * 50 # 50MB
+
+    attr_reader :io, :part_size
+
+    # @param [File, StringIO, IO]
+    def initialize(io, part_size: DEFAULT_PART_SIZE)
+      @io = io
+      @part_size = part_size
+    end
+
+    # @param s3 [Aws::S3::Client]
+    def upload(s3, bucket:, key:, **extra, &block)
+      if multipart?
+        upload_multipart(s3, bucket: bucket, key: key, **extra, &block)
+      else
+        s3.put_object(bucket: bucket, key: key, body: io.read, **extra)
+        yield(100) if block_given?
+      end
+    end
+
+    private
+
+    def upload_multipart(s3, bucket:, key:, **extra)
+      multipart = s3.create_multipart_upload(bucket: bucket, key: key, **extra)
+      parts = []
+
+      each_part do |part, num|
+        parts << s3.upload_part(
+          body: part,
+          bucket: bucket,
+          content_length: part.bytesize,
+          key: key,
+          part_number: num,
+          upload_id: multipart.upload_id
+        )
+
+        progress = (num.fdiv(total_parts) * 100).round
+        progress = 100 if progress > 100
+
+        yield(progress) if block_given?
+      end
+
+      s3.complete_multipart_upload(
+        bucket: bucket,
+        key: key,
+        upload_id: multipart.upload_id,
+        multipart_upload: {
+          parts: parts.map.with_index  do |part, ix|
+            {
+              etag: part.etag,
+              part_number: ix.next
+            }
+          end
+        }
+      )
+    end
+
+    # yields parts bytes and number of a page
+    def each_part(num: 1)
+      until io.eof?
+        yield(io.read(part_size), num)
+        num += 1
+      end
+    end
+
+    def multipart?
+      total_parts.nonzero?
+    end
+
+    def total_parts
+      io.size.fdiv(part_size).ceil
+    end
+  end
+end

data/lib/zeus/s3_iterate.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-s3'
+
+# Clean S3 files base on file#lost_mod
+module Zeus
+  class S3Iterate
+    attr_reader :s3
+
+    def initialize(s3)
+      @s3 = s3
+    end
+
+    def delete_if(bucket:, prefix:)
+      each_file(bucket: bucket, prefix: prefix) do |file|
+        next unless yield(file)
+
+        s3.delete_object(bucket: bucket, key: file.key)
+      end
+    end
+
+    def each_file(bucket:, prefix:)
+      s3.list_objects_v2(bucket: bucket, prefix: prefix).each do |page|
+        iterate(page) do |list|
+          list.contents.each do |file|
+            yield(file)
+          end
+        end
+      end
+    end
+
+    private
+
+    # @param page [Seahorse::Client::Response]
+    def iterate(page, &block)
+      yield(page)
+      iterate(page.next_page, &block) if page.next_page?
+    end
+  end
+end

data/lib/zeus/ssh_tunnel.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# === Example
+# Zeus::SshTunnel.link('root@db-01', '5555:localhost:5432') do
+#   system('telnet localhost 5555')
+# end
+module Zeus
+  class SshTunnel
+    def self.link(remote, destination)
+      IO.popen("ssh -N #{remote} -L #{destination}") do |pipe|
+        pipe.read # just like wait
+        yield
+        Process.kill('QUIT', pipe.pid)
+      end
+    end
+  end
+end

data/lib/zeus/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Zeus
+  VERSION = '0.1.0'
+end

data/zeus.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/zeus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'calevipoeg-zeus'
+  spec.version       = Zeus::VERSION
+  spec.authors       = ['Aliaksandr Shylau']
+  spec.email         = %w[alex.shilov.by@gmail.com]
+
+  spec.summary       = 'Helper package for own projects'
+  spec.description   = 'Helper package for own projects'
+  spec.homepage      = 'https://github.com/calevipoeg/zeus'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/calevipoeg/zeus'
+  spec.metadata['changelog_uri'] = 'https://github.com/calevipoeg/zeus'
+
+  # 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'
+  # @refs
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: calevipoeg-zeus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aliaksandr Shylau
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-02 00:00:00.000000000 Z
+dependencies: []
+description: Helper package for own projects
+email:
+- alex.shilov.by@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/release.sh
+- bin/setup
+- lib/zeus.rb
+- lib/zeus/pg_base_backup.rb
+- lib/zeus/s3_io.rb
+- lib/zeus/s3_iterate.rb
+- lib/zeus/ssh_tunnel.rb
+- lib/zeus/version.rb
+- zeus.gemspec
+homepage: https://github.com/calevipoeg/zeus
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/calevipoeg/zeus
+  source_code_uri: https://github.com/calevipoeg/zeus
+  changelog_uri: https://github.com/calevipoeg/zeus
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Helper package for own projects
+test_files: []