archivault 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18e7063c221d22627d0355b857c7bd767d14cd2312f2c04391c506cba4ba1689
-  data.tar.gz: 2b5649d48fc0eb996bc8377f7670ad1d576cfe18609363079653472f92bea66c
+  metadata.gz: 2c3fafb7a999944ce6e513420f1e90a1f842a7460c6364d69b71a9d6158b8453
+  data.tar.gz: 325edbcd21420a5079857f8e317a292587787579d3580e819c6da8dc93cac5ce
 SHA512:
-  metadata.gz: 2de400dc93463d3dd8247eaecdb9a323c59001106e1ad41d145dba5b68d50f03ec8ab2bde6fb7b98b128280a2dee21439bb4340d5a068810f654b91f586b488a
-  data.tar.gz: 9a41e8bec7f152ba8ee845e5387dfabcda6f7055ba770c012d1143da1ac81454039d20448b5b74e77527859100f51a21d0582f3af685bbe6187fcd193789fac2
+  metadata.gz: 7901b70a33e62c64bce142a02437a2ffbe520249b56ccc899403e2068f7e34fdb5c23189af5c9d65c9c0ba7e5844d04bcbf088a3b095bf28054b12d82edc709f
+  data.tar.gz: e6e05ca1b5671138ad04ab9a1f349cf4401912e7c22816b49826f0a740f63105be7178b0305275be7e3505086e9adda48c75bce2ee11683b5b20e931f2f7d511

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.1] - 2026-09-03
+
+- Allow custom database backup filename prefixes
+
+## [0.2.0] - 2026-04-10
+
+- Add PostgresqlBackup
+
 ## [0.1.0] - 2026-04-08
 
 - Initial release

data/README.md

@@ -32,8 +32,26 @@ s3_setup = {
   bucket: "bucket"
 }
 ping_url = "https://example.com/ping" # optional parameter
+filename = "production" # optional prefix; timestamp is appended
 
-Archivault::SqliteBackup.new(database_path:, gpg_passphrase:, s3_setup:, ping_url:).call
+Archivault::SqliteBackup.new(database_path:, gpg_passphrase:, s3_setup:, ping_url:, filename:).call
+```
+
+### PostgreSQL database backup
+
+```ruby
+database_url = "postgres://user:password@localhost:5432/mydb"
+gpg_passphrase = "password"
+s3_setup = { 
+  region: "region", 
+  access_key_id: "access_key_id",  
+  secret_access_key: "secret_access_key", 
+  bucket: "bucket"
+}
+ping_url = "https://example.com/ping" # optional parameter
+filename = "production" # optional prefix; timestamp is appended
+
+Archivault::PostgresqlBackup.new(database_url:, gpg_passphrase:, s3_setup:, ping_url:, filename:).call
 ```
 
 ### Logs backup
@@ -55,7 +73,7 @@ ping_url = "https://example.com/ping" # optional parameter
 Archivault::LogsBackup.new(log_path_or_paths:, gpg_passphrase:, s3_setup:, ping_url:).call
 ```
 
-## Rais usage
+## Rails usage
 
 ### SQLite database backup
 
@@ -70,11 +88,31 @@ Archivault::LogsBackup.new(log_path_or_paths:, gpg_passphrase:, s3_setup:, ping_
 #     bucket: bucket
 params = {
   database_path: Rails.root.join("storage/production.sqlite3"),
-  ping_url: "https://example.com/ping" # optional parameter
+  ping_url: "https://example.com/ping", # optional parameter
+  filename: "production" # optional prefix; timestamp is appended
 }.merge(Rails.application.credentials.archivault)
 Archivault::SqliteBackup.new(**params).call
 ```
 
+### PostgreSQL database backup
+
+```ruby
+# in config/credentials.yml.enc 
+# archivault:
+#   gpg_passphrase: password
+#   s3_setup:
+#     region: region
+#     access_key_id: access_key_id
+#     secret_access_key: secret_access_key
+#     bucket: bucket
+params = {
+  database_url: ENV["DATABASE_URL"],
+  ping_url: "https://example.com/ping", # optional parameter
+  filename: "production" # optional prefix; timestamp is appended
+}.merge(Rails.application.credentials.archivault)
+Archivault::PostgresqlBackup.new(**params).call
+```
+
 ### Logs backup
 
 ```ruby

data/lib/archivault/gpg.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# To decrypt encrypted file, use:
+# gpg --output output.txt --decrypt output.txt.gpg
 module Archivault
   class Gpg
     def initialize(file_path)

data/lib/archivault/pg_dump.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# To restore a database from a dump file, use:
+# pg_restore --no-owner -d DATABASE_URL database.dump
+module Archivault
+  class PgDump
+    def initialize(database_url:, backup_path:)
+      raise ArgumentError, "database_path is required" if database_url.nil? || database_url.to_s.empty?
+      raise ArgumentError, "backup_path is required" if backup_path.nil? || backup_path.to_s.empty?
+
+      @database_url = database_url.to_s
+      @backup_path = backup_path.to_s
+    end
+
+    def call
+      Execute.new.call("pg_dump", "-Fc", "-f", @backup_path, @database_url)
+    end
+  end
+end

data/lib/archivault/postgresql_backup.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Archivault
+  class PostgresqlBackup
+    # Parameters
+    #   - database_url: Database URL
+    #   - gpg_passphrase: GPG passphrase to encrypt the backup file
+    #   - s3_setup: Hash of S3 setup options:
+    #     - region: AWS region
+    #     - access_key_id: AWS access key ID
+    #     - secret_access_key: AWS secret access key
+    #     - bucket: S3 bucket name
+    #   - filename: Filename prefix for the backup (defaults to database)
+    def initialize(database_url:, gpg_passphrase:, s3_setup:, ping_url: nil, filename: nil)
+      @database_url = database_url.to_s
+      @gpg_passphrase = gpg_passphrase.to_s
+      @s3_setup = s3_setup
+      @ping_url = ping_url
+
+      @timestamp = Timestamp.new.timestamp
+      @tmp_path = Tmp.new.path
+      backup_filename = "#{filename || "database"}-#{@timestamp}"
+      @backup_path = "#{@tmp_path}/#{backup_filename}.dump"
+      @tar_path = "#{@tmp_path}/#{backup_filename}.tgz"
+      @gpg_path = "#{@tar_path}.gpg"
+    end
+
+    def call
+      PgDump.new(database_url: @database_url, backup_path: @backup_path).call
+      Tar.new(tar_path: @tar_path, path_or_paths: @backup_path).call
+      Gpg.new(@tar_path).call(@gpg_passphrase)
+      S3.new(@gpg_path).call(**@s3_setup)
+      Ping.new(@ping_url).call if @ping_url
+    ensure
+      Clean.new([@backup_path, @tar_path, @gpg_path]).call
+    end
+  end
+end

data/lib/archivault/sqlite_backup.rb

@@ -10,7 +10,8 @@ module Archivault
     #     - access_key_id: AWS access key ID
     #     - secret_access_key: AWS secret access key
     #     - bucket: S3 bucket name
-    def initialize(database_path:, gpg_passphrase:, s3_setup:, ping_url: nil)
+    #   - filename: Filename prefix for the backup (defaults to database)
+    def initialize(database_path:, gpg_passphrase:, s3_setup:, ping_url: nil, filename: nil)
       @database_path = database_path.to_s
       @gpg_passphrase = gpg_passphrase.to_s
       @s3_setup = s3_setup
@@ -18,8 +19,9 @@ module Archivault
 
       @timestamp = Timestamp.new.timestamp
       @tmp_path = Tmp.new.path
-      @backup_path = "#{@tmp_path}/database-#{@timestamp}.sqlite3"
-      @tar_path = "#{@tmp_path}/database-#{@timestamp}.tgz"
+      backup_filename = "#{filename || "database"}-#{@timestamp}"
+      @backup_path = "#{@tmp_path}/#{backup_filename}.sqlite3"
+      @tar_path = "#{@tmp_path}/#{backup_filename}.tgz"
       @gpg_path = "#{@tar_path}.gpg"
     end
 

data/lib/archivault/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Archivault
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/archivault.rb

@@ -10,8 +10,10 @@ require_relative "archivault/tmp"
 require_relative "archivault/gpg"
 require_relative "archivault/s3"
 require_relative "archivault/ping"
+require_relative "archivault/pg_dump"
 require_relative "archivault/sqlite_backup"
 require_relative "archivault/logs_backup"
+require_relative "archivault/postgresql_backup"
 
 module Archivault
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: archivault
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Piotr Macuk
@@ -56,7 +56,9 @@ files:
 - lib/archivault/execute.rb
 - lib/archivault/gpg.rb
 - lib/archivault/logs_backup.rb
+- lib/archivault/pg_dump.rb
 - lib/archivault/ping.rb
+- lib/archivault/postgresql_backup.rb
 - lib/archivault/s3.rb
 - lib/archivault/sqlite.rb
 - lib/archivault/sqlite_backup.rb