bkp 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e35406050d99e452d6cd2f9a780f345ad5139ccefc93bb248f0eaf6ad46871ec
-  data.tar.gz: 0d53ae0985b1a2acf3dc5ea9c735e6a62db12bcd75977c47c1cd9b91d6999007
+  metadata.gz: 7f7f2dbb1125aa7389f550edd88efb0cc6f47ba7462a3897d67179f014f34abc
+  data.tar.gz: 7718b010f57402ed73891a50c210b676823069a2a40e884fb34c0e63a2e34fe6
 SHA512:
-  metadata.gz: 6a9fb68afa5d77be1440fe1ef69a9c1271e78bb3954b91b0ddab61d92330da85870ba91d17cf8c6fda562f481b9fa777981f1f03a93afdb437294a3e9b2f2717
-  data.tar.gz: 24d81d917b11e79a76cbfe09395d84619dc459506c9a3f89abe8c1ca42c9b9b873028f60dd5ed018bf235a5b921f912e54244ecb17dc8737b7b4eba1fd5275cc
+  metadata.gz: 946e793f94795068719875cd36f802035a53db26c9b04dcb3ad4805e41bf461d785bf6b7350a967c203646a847b3887bb69749a029367179e27430aac172c6fc
+  data.tar.gz: 8167b607e70e9e59e55212b9a711a31bb26ef0988dc04d9bf4094c25e58fcaa9876dc0f06f1829797c1a869024dadba1c5ed5720af71f907208c806378c3174f

data/Onafile

@@ -1,3 +1,133 @@
 #!/usr/bin/env ruby
 
+require 'yaml'
+require 'time'
+require 'tmpdir'
+require 'json'
+require 'fileutils'
+require './lib/validations.rb'
+require './lib/helpers.rb'
+
+if ENV['OLDPWD']
+  Dir.chdir(ENV['OLDPWD'])
+end
+
+config_check
+
 Ona.prompt = 'bkp'
+
+Ona.resource(:backup, [
+  :background,
+  :bucket,
+  :date,
+  :name,
+  :owner,
+  :summary,
+  :ticket,
+  :path,
+  :directory
+])
+
+reload_manifests
+
+Ona.action(
+  :regex    => /(^)(ls)($)/,
+  :resource => :backup,
+  :text     => "List backups.",
+  :example  => "ls"
+) do |items, command, regex|
+  items.sort do |a, b|
+    Time.parse(a.date) <=> Time.parse(b.date)
+  end.each_with_index do |item, id|
+    pretty_backup_list(id, item)
+  end
+end
+
+Ona.action(
+  :regex    => /(^)(new)($)/,
+  :resource => :backup,
+  :text     => "Creates a new backup config file.",
+  :example  => "new"
+) do |items, command, regex|
+  generate_template
+end
+
+Ona.action(
+  :regex    => /(^)(check)(\s+)(.*)($)/,
+  :resource => :backup,
+  :text     => "Validates a backup config file.",
+  :example  => "check [FILENAME]"
+) do |items, command, regex|
+  file = command.scan(regex)[0][3]
+  file.gsub!(/(\s+$)/, '')
+  load_file(file)
+end
+
+Ona.action(
+  :regex    => /(^)(upload)(\s+)(.*)($)/,
+  :resource => :backup,
+  :text     => "Uploads backups from config file.",
+  :example  => "upload [FILENAME]"
+) do |items, command, regex|
+  file = command.scan(regex)[0][3]
+  file.gsub!(/(\s+$)/, '')
+  backups = load_file(file)
+  unless Ona.confirm('Are you sure you want to upload these backups?', 'yes')
+    next
+  end
+  backups.each do |backup|
+    create_backup(backup)
+  end
+end
+
+Ona.action(
+  :regex    => /(^)(sync)($)/,
+  :resource => :backup,
+  :text     => "Reads remote backups so they can be evaluated locally.",
+  :example  => "sync"
+) do |items, command, regex|
+  download_manifests
+  reload_manifests
+end
+
+Ona.action(
+  :regex    => /(^)(show)(\s+)(.*)($)/,
+  :resource => :backup,
+  :text     => "Shows a backup config file.",
+  :example  => "show [NUMBER]",
+) do |items, command, regex|
+  queried_id = command.scan(regex)[0][3]
+  if queried_id =~ /\d+/
+    queried_id = queried_id.to_i
+  else
+    next
+  end
+  items.sort do |a, b|
+    Time.parse(a.date) <=> Time.parse(b.date)
+  end.each_with_index do |backup, id|
+    if id == queried_id
+      pretty_backup_body(id, backup)
+    end
+  end
+end
+
+Ona.action(
+  :regex    => /(^)(download)(\s+)(.*)($)/,
+  :resource => :backup,
+  :text     => 'Download a remote backup',
+  :example  => "download [NUMBER]",
+) do |items, command, regex|
+  queried_id = command.scan(regex)[0][3]
+  if queried_id =~ /\d+/
+    queried_id = queried_id.to_i
+  else
+    next
+  end
+  items.sort do |a, b|
+    Time.parse(a.date) <=> Time.parse(b.date)
+  end.each_with_index do |backup, id|
+    if id == queried_id
+      run_command('aws s3 cp ' + s3_path(backup) + ' .' )
+    end
+  end
+end

data/bin/bkp

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
-system "cd #{__dir__}/../ && ona #{ARGV.join(' ')}"
+system "cd #{__dir__}/../ && OLDPWD=#{Dir.pwd} ona #{ARGV.join(' ')}"
 

data/lib/helpers.rb

@@ -0,0 +1,233 @@
+#!/usr/bin/env ruby
+
+TEMPLATE = "---
+-
+  # A short one line easy to understand summary of what the backup is for.
+  summary:
+
+  # Some context about the backup (why are we doing this?)
+  background: |-
+    This is a backup of the database for the website.
+    You can find the website at http://www.example.com
+
+    It is important to backup the database because it contains all the information for the website.
+
+  # The local diretory you want to backup
+  directory: ./mydata
+
+  # The date of the backup
+  date: '%<date>s'
+
+  # Who created the backup. (usually your name)
+  owner:
+
+  # The ticket url associated with the backup
+  ticket: ''
+
+  # The bucket where the backup will be stored
+  # (probably okay to keep as is) 
+  bucket: %<bucket>s
+
+  # The path where all the backups are stored in the bucket
+  # Think about it this way: bucket/path/[backups live here]
+  # (probably okay to keep as is) 
+  path: %<path>s
+"
+
+CONFIG_FILE = "#{ENV['HOME']}/.bkp/config.yml"
+
+DEFAULT_CONFIG = "---
+# The default bucket where all backups will be stored
+bucket: ''
+
+# The default path where all backups will be stored
+# Think about it this way: bucket/path/[backups live here]
+path: ''
+"
+
+def to_hyphen(string)
+  string = string.chomp
+  string.gsub!(/\W+/, ' ')
+  string.gsub!(/\s+/, '-')
+  string.gsub!(/^[-]+|[-]+$/, '')
+  string.downcase
+end
+
+def create_backup(backup)
+  Dir.mktmpdir do |dir|
+    # we keep the original directory when we tar and gzip the directory
+    run_command "cd #{backup['directory']} && cd .. && tar -czf #{dir}/#{backup['name']}.tar.gz #{backup['directory'].split('/').last}"
+    run_command "aws s3 cp #{dir}/#{backup['name']}.tar.gz s3://#{backup['bucket']}/#{backup['path']}/#{backup['name']}/#{backup['name']}.tar.gz"
+
+    manifest = "#{dir}/manifest.json"
+
+    File.open(manifest, 'w+') do |file|
+      file.write(backup.to_json)
+    end
+
+    run_command "aws s3 cp #{manifest} s3://#{backup['bucket']}/#{backup['path']}/#{backup['name']}/manifest.json"
+  end
+end
+
+def load_file(file)
+  unless File.exist?(file)
+    $stderr.puts "Backup File #{file.inspect} does not exist."
+    exit 1
+  end
+
+  backups = YAML.load_file(file)
+
+  backups.each_with_index do |backup, index|
+    validate_summary(backup['summary'], index)
+    validate_background(backup['background'], index)
+    validate_directory(backup['directory'], index)
+    validate_date(backup['date'], index)
+    validate_owner(backup['owner'], index)
+    validate_ticket(backup['ticket'], index)
+    validate_bucket(backup['bucket'], index)
+    validate_path(backup['path'], index)
+    date = Time.parse(backup['date'], index)
+    date = date.strftime('%Y-%m-%d')
+    backup['name'] = date + '-' + to_hyphen(backup['summary'])
+  end
+end
+
+def backup_list
+  config = YAML.load_file(CONFIG_FILE)
+  list = File.expand_path("~/.bkp/list.txt")
+  run_command "aws s3 ls s3://#{config['bucket']}/#{config['path']}/ > #{list}"
+  files = []
+  File.read(list).each_line do |line|
+    files << line.split(' ').last
+  end
+  files
+end
+
+def download_manifests
+  config = YAML.load_file(CONFIG_FILE)
+  backups = backup_list
+  FileUtils.mkdir_p(File.expand_path('~/.bkp/manifests'))
+  FileUtils.rm(Dir.glob(File.expand_path('~/.bkp/manifests/*.json')))
+  backups.each do |backup|
+    backup = backup.split('/').first
+    run_command "aws s3 cp s3://#{config['bucket']}/#{config['path']}/#{backup}/manifest.json ~/.bkp/manifests/#{backup}.json"
+  end
+  reload_manifests
+end
+
+def load_manifests
+  Dir.glob(File.expand_path('~/.bkp/manifests/*.json')).map do |file|
+    object = JSON.parse(File.read(file))
+    Ona.register(:backup) do |backup|
+      backup.name = object['name']
+      backup.summary = object['summary']
+      backup.background = object['background']
+      backup.directory = object['directory']
+      backup.date = object['date']
+      backup.owner = object['owner']
+      backup.ticket = object['ticket']
+      backup.bucket = object['bucket']
+      backup.path = object['path']
+    end
+  end
+end
+
+def unload_manifests
+  Ona.class_eval do
+    puts @resources[:backup][:entries] = []
+  end
+end
+
+def reload_manifests
+  unload_manifests
+  load_manifests
+end
+
+def config_check
+  return if File.exist?(CONFIG_FILE)
+
+  puts "Config file #{CONFIG_FILE.inspect} does not exist."
+
+  unless Ona.confirm('Okay to create a new config file in ~/.bkp/config.yml?', 'yes')
+    $stderr.puts 'Will exit this program now.'
+    exit 1
+  end
+
+  puts 'What is the name of the bucket where you want to store your backups?'
+  print 'S3 Bucket name> '
+  bucket = gets.chomp
+
+  puts "What is the 'path' where you want to store your backups?"
+  print 'S3 Bucket path> '
+  path = gets.chomp
+
+  config = YAML.load(DEFAULT_CONFIG)
+  config['bucket'] = bucket
+  config['path'] = path
+  FileUtils.mkdir_p(File.expand_path('~/.bkp'))
+  File.open(CONFIG_FILE, 'w+') do |file|
+    file.write(config.to_yaml)
+  end
+end
+
+# we use gsub because older rubies format method works differently.
+def generate_template
+  config = YAML.load_file(CONFIG_FILE)
+  template = TEMPLATE.dup
+  template.gsub!('%<date>s', Time.now.to_s)
+  template.gsub!('%<bucket>s', config['bucket'])
+  template.gsub!('%<path>s', config['path'])
+  puts template
+end
+
+def run_command(command)
+  puts ''
+  puts "# Command: #{command.to_ansi.yellow.to_s}"
+  puts "# Executed at: #{Time.now.to_s}"
+  puts "# #{('=' * 76).to_ansi.cyan.to_s}"
+  system command
+  puts ''
+end
+
+def pretty_backup_list(id, backup)
+  pretty_id     = id.to_s.to_s.rjust(5, ' ').to_ansi.cyan.to_s
+  pretty_name   = 'name'.to_ansi.green.to_s
+  pretty_date   = backup.date.to_ansi.yellow.to_s
+  puts "#{pretty_id} - [#{pretty_date}] #{pretty_name}: #{backup.name}"
+end
+
+def pretty_backup_body(id, backup)
+  puts ''
+  puts 'Summary:'.to_ansi.green.to_s
+  puts backup.summary.to_ansi.cyan.to_s
+  puts ''
+  puts 'Background:'.to_ansi.green.to_s
+  puts backup.background.to_ansi.cyan.to_s
+  puts ''
+  puts 'Date:'.to_ansi.green.to_s
+  puts backup.date.to_ansi.cyan.to_s
+  puts ''
+  puts 'Owner:'.to_ansi.green.to_s
+  puts backup.owner.to_ansi.cyan.to_s
+  puts ''
+  puts 'Ticket:'.to_ansi.green.to_s
+  puts backup.ticket.to_ansi.cyan.to_s
+  puts ''
+  puts 'Bucket:'.to_ansi.green.to_s
+  puts backup.bucket.to_ansi.cyan.to_s
+  puts ''
+  puts 'Path:'.to_ansi.green.to_s
+  puts backup.path.to_ansi.cyan.to_s
+  puts ''
+  puts 'Directory:'.to_ansi.green.to_s
+  puts backup.directory.to_ansi.cyan.to_s
+  puts ''
+  puts 'S3 Path:'.to_ansi.green.to_s
+  puts s3_path(backup).to_ansi.cyan.to_s
+  puts ''
+
+end
+
+def s3_path(backup)
+  's3://' + backup.bucket + '/' + backup.path + '/' + backup.name + '/' + backup.name + '.tar.gz'
+end

data/lib/validations.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+def validate_summary(summary, index)
+  if summary.nil? || summary.empty?
+    $stderr.puts "Backup(#{index}) summary is empty: #{summary.inspect}"
+    exit 1
+  end
+
+  if summary.size > 80
+    $stderr.puts "Backup(#{index}) summary is too long: #{summary.size} characters"
+    exit 1
+  end
+end
+
+def validate_background(background, index)
+  if background.nil? || background.empty?
+    $stderr.puts "Backup(#{index}) background is empty: #{background.inspect}"
+    exit 1
+  end
+
+  if background.size < 80
+    $stderr.puts "Backup(#{index}) background is too short: #{background.size} characters"
+    exit 1
+  end
+end
+
+def validate_directory(directory, index)
+  if directory.nil? || directory.empty?
+    $stderr.puts "Backup(#{index}) directory is empty: #{directory.inspect}"
+    exit 1
+  end
+
+  unless File.directory?(directory)
+    $stderr.puts "Backup(#{index}) directory does not exist: #{directory.inspect}"
+    exit 1
+  end
+end
+
+def validate_date(date, index)
+  if date.nil? || date.empty?
+    $stderr.puts "Backup(#{index}) date is empty: #{date.inspect}"
+    exit 1
+  end
+
+  begin
+    Time.parse(date)
+  rescue ArgumentError
+    $stderr.puts "Backup(#{index}) date is not a valid date: #{date.inspect}"
+    exit 1
+  end
+end
+
+def validate_owner(owner, index)
+  if owner.nil? || owner.empty?
+    $stderr.puts "Backup(#{index}) owner is empty: #{owner.inspect}"
+    exit 1
+  end
+end
+
+def validate_ticket(ticket, index)
+  if ticket.nil? || ticket.empty?
+    $stderr.puts "Backup(#{index}) ticket is empty: #{ticket.inspect}"
+    exit 1
+  end
+end
+
+def validate_bucket(bucket, index)
+  if bucket.nil? || bucket.empty?
+    $stderr.puts "Backup(#{index}) bucket is empty: #{bucket.inspect}"
+    exit 1
+  end
+end
+
+def validate_path(path, index)
+  if path.nil? || path.empty?
+    $stderr.puts "Backup(#{index}) path is empty: #{path.inspect}"
+    exit 1
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bkp
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kazuyoshi Tlacaelel
@@ -48,6 +48,9 @@ files:
 - Gemfile
 - Onafile
 - bin/bkp
+- lib/bkp.rb
+- lib/helpers.rb
+- lib/validations.rb
 homepage: https://github.com/ktlacaelel/bkp
 licenses:
 - MIT
@@ -70,5 +73,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: bkp - Backup Management Tool
+summary: bkp - Shell Backup Management Tool (for AWS S3 Bucket)
 test_files: []