ruborg 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e48935c72c444956ca0b7918efb14bd3d5b8a38273ec6843adec2fbb2da6968
-  data.tar.gz: f200cb546d62431ec1ff84544da0b96b9f84cf7877aa29627608f8c43119d2b7
+  metadata.gz: ca72109e555872d29ba3b56a07b6ed10ea5b41fec351631232265c42216fd376
+  data.tar.gz: 2049a2ba62a07171f2fc62237243043be6dacf83200f0ffa4f10b6a05285d5b1
 SHA512:
-  metadata.gz: 4614d7f78363f420ae4ce80355725fb84e068bfac0d94591f1cee56a6d14c7c6664dd415405462086bdf2fa7543187702f346645655b2bb32b5ffb62fea288a9
-  data.tar.gz: f70898563085b03b78cf4cf140abb5efd9bd3bd6881918aa7a77c976823a15469688e3aeafd6814c4ff880b3e5c8f949264a1c03f9b1251f3467d409ebe1f302
+  metadata.gz: ce9e39076fbb118801cf910ca241e930d2139e0f15c8adaf139a62e36bf8dad5a7495d81618db5f82d45d7c1e6c0784c143258afbc0c4ad524945d13b91ca345
+  data.tar.gz: 94534dfd27da62827c5976bcbbe291d9c6906a7e3355905a970b6f9ea65bb3b7612ae50373445a249f2b57ad9283028ca06ab5db87d85f05e6ff76e3b6d34121

data/.rspec

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

data/CHANGELOG.md

@@ -7,6 +7,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2025-10-05
+
+### Added
+- `--remove-source` option to delete source files after successful backup
+- Comprehensive logging system with daily rotation (default: `~/.ruborg/logs/ruborg.log`)
+- Custom log file support via `--log` option for all commands
+- `--path` option for restore command to extract single files/directories from archives
+- Comprehensive RSpec test suite with mocked Passbolt and actual Borg integration tests
+- Borg installation instructions for macOS and Ubuntu in README
+- Support for environment variables to prevent interactive prompts (`BORG_RELOCATED_REPO_ACCESS_IS_OK`, etc.)
+- Automatic destination directory creation for restore operations
+- Test helpers and fixtures for easier testing
+
+### Fixed
+- Passbolt CLI command corrected from `passbolt get <id>` to `passbolt get resource <id>`
+- Borg commands now properly redirect stdin to prevent interactive passphrase prompts
+- Improved error handling and logging throughout the application
+
+### Changed
+- Refactored Passbolt class to use testable `execute_command` method
+- Enhanced Repository and Backup classes to properly handle environment variables
+- Improved CLI integration with better Passbolt mock support in tests
+
+## [0.1.0] - 2025-10-04
+
 ### Added
 - Initial gem structure
 - Borg repository initialization and management
@@ -14,8 +39,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - YAML configuration file support
 - Passbolt CLI integration for password management
 - Command-line interface with Thor
-
-## [0.1.0] - 2025-10-04
-
-### Added
-- Initial release
+- Basic error handling

data/README.md

@@ -1,7 +1,5 @@
 # Ruborg
 
-> **⚠️ WARNING: This project is under heavy development and is not yet functional. Do not use in production.**
->
 > This gem is being developed with the assistance of Claude AI.
 
 A friendly Ruby frontend for [Borg Backup](https://www.borgbackup.org/). Ruborg simplifies backup management by providing a YAML-based configuration system and seamless integration with Passbolt for encryption password management.
@@ -14,13 +12,35 @@ A friendly Ruby frontend for [Borg Backup](https://www.borgbackup.org/). Ruborg
 - 🔐 **Passbolt Integration** - Secure password management via Passbolt CLI
 - 🎯 **Pattern Exclusions** - Flexible file exclusion patterns
 - 🗜️ **Compression Options** - Support for multiple compression algorithms
+- 🗂️ **Selective Restore** - Restore individual files or directories from archives
+- 🧹 **Auto-cleanup** - Optionally remove source files after successful backup
+- 📊 **Logging** - Comprehensive logging with daily rotation
+- ✅ **Well-tested** - Comprehensive test suite with RSpec
 
 ## Prerequisites
 
-- Ruby >= 2.7.0
+- Ruby >= 3.2.0
 - [Borg Backup](https://www.borgbackup.org/) installed and available in PATH
 - [Passbolt CLI](https://github.com/passbolt/go-passbolt-cli) (optional, for password management)
 
+### Installing Borg Backup
+
+**macOS:**
+```bash
+brew install borgbackup
+```
+
+**Ubuntu/Debian:**
+```bash
+sudo apt update
+sudo apt install borgbackup
+```
+
+**Verify installation:**
+```bash
+borg --version
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -99,6 +119,9 @@ ruborg backup --config /path/to/config.yml
 
 # With custom archive name
 ruborg backup --name "my-backup-2025-10-04"
+
+# Remove source files after successful backup
+ruborg backup --remove-source
 ```
 
 ### List Archives
@@ -110,11 +133,14 @@ ruborg list
 ### Restore from Archive
 
 ```bash
-# Restore to current directory
+# Restore entire archive to current directory
 ruborg restore archive-name
 
 # Restore to specific directory
 ruborg restore archive-name --destination /path/to/restore
+
+# Restore a single file from archive
+ruborg restore archive-name --path /path/to/file.txt --destination /new/location
 ```
 
 ### View Repository Information
@@ -123,13 +149,40 @@ ruborg restore archive-name --destination /path/to/restore
 ruborg info
 ```
 
+## Logging
+
+Ruborg automatically logs all operations to `~/.ruborg/logs/ruborg.log` with daily rotation. You can specify a custom log file:
+
+```bash
+ruborg backup --log /path/to/custom.log
+```
+
+Logs include:
+- Operation start/completion timestamps
+- Paths being backed up
+- Archive names created
+- Success and error messages
+- Source file removal actions
+
 ## Passbolt Integration
 
 Ruborg can retrieve encryption passphrases from Passbolt using the Passbolt CLI:
 
 1. Install and configure [Passbolt CLI](https://github.com/passbolt/go-passbolt-cli)
-2. Store your Borg repository passphrase in Passbolt
-3. Add the resource ID to your `ruborg.yml`:
+2. Configure Passbolt CLI with your server credentials:
+   ```bash
+   passbolt configure --serverAddress https://server.address \
+                      --userPrivateKeyFile /path/to/private.key \
+                      --userPassword YOUR_PASSWORD
+   ```
+   Or set environment variables:
+   ```bash
+   export PASSBOLT_SERVER_ADDRESS=https://server.address
+   export PASSBOLT_USER_PRIVATE_KEY_FILE=/path/to/private.key
+   export PASSBOLT_USER_PASSWORD=YOUR_PASSWORD
+   ```
+3. Store your Borg repository passphrase in Passbolt
+4. Add the resource ID to your `ruborg.yml`:
 
 ```yaml
 passbolt:
@@ -142,11 +195,16 @@ Ruborg will automatically retrieve the passphrase when performing backup operati
 
 | Command | Description | Options |
 |---------|-------------|---------|
-| `init REPOSITORY` | Initialize a new Borg repository | `--passphrase`, `--passbolt-id` |
-| `backup` | Create a backup using config file | `--config`, `--name` |
-| `list` | List all archives in repository | `--config` |
-| `restore ARCHIVE` | Restore files from archive | `--config`, `--destination` |
-| `info` | Show repository information | `--config` |
+| `init REPOSITORY` | Initialize a new Borg repository | `--passphrase`, `--passbolt-id`, `--log` |
+| `backup` | Create a backup using config file | `--config`, `--name`, `--remove-source`, `--log` |
+| `list` | List all archives in repository | `--config`, `--log` |
+| `restore ARCHIVE` | Restore files from archive | `--config`, `--destination`, `--path`, `--log` |
+| `info` | Show repository information | `--config`, `--log` |
+
+### Global Options
+
+- `--config`: Path to configuration file (default: `ruborg.yml`)
+- `--log`: Path to log file (default: `~/.ruborg/logs/ruborg.log`)
 
 ## Development
 
@@ -169,9 +227,24 @@ bundle exec rake release
 Run the test suite:
 
 ```bash
+# Run all tests
 bundle exec rspec
+
+# Run only unit tests (no Borg required)
+bundle exec rspec --tag ~borg
+
+# Run only integration tests (requires Borg)
+bundle exec rspec --tag borg
 ```
 
+The test suite includes:
+- Config loading and validation
+- Repository management (with actual Borg integration)
+- Backup and restore operations
+- Passbolt integration (mocked)
+- CLI commands
+- Logging functionality
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mpantel/ruborg.

data/lib/ruborg/backup.rb

@@ -8,22 +8,33 @@ module Ruborg
       @config = config
     end
 
-    def create(name: nil)
+    def create(name: nil, remove_source: false)
       raise BorgError, "Repository does not exist" unless @repository.exists?
 
       archive_name = name || Time.now.strftime("%Y-%m-%d_%H-%M-%S")
       cmd = build_create_command(archive_name)
 
       execute_borg_command(cmd)
+
+      remove_source_files if remove_source
     end
 
-    def extract(archive_name, destination: ".")
+    def extract(archive_name, destination: ".", path: nil)
       raise BorgError, "Repository does not exist" unless @repository.exists?
 
       cmd = ["borg", "extract", "#{@repository.path}::#{archive_name}"]
-      cmd += ["--destination", destination] if destination != "."
-
-      execute_borg_command(cmd)
+      cmd << path if path
+
+      # Change to destination directory if specified
+      if destination != "."
+        require "fileutils"
+        FileUtils.mkdir_p(destination) unless File.directory?(destination)
+        Dir.chdir(destination) do
+          execute_borg_command(cmd)
+        end
+      else
+        execute_borg_command(cmd)
+      end
     end
 
     def list_archives
@@ -52,10 +63,28 @@ module Ruborg
     end
 
     def execute_borg_command(cmd)
-      result = system(*cmd)
+      env = {}
+      passphrase = @repository.instance_variable_get(:@passphrase)
+      env["BORG_PASSPHRASE"] = passphrase if passphrase
+      env["BORG_RELOCATED_REPO_ACCESS_IS_OK"] = "yes"
+      env["BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK"] = "yes"
+
+      result = system(env, *cmd, in: "/dev/null")
       raise BorgError, "Borg command failed: #{cmd.join(' ')}" unless result
 
       result
     end
+
+    def remove_source_files
+      require "fileutils"
+
+      @config.backup_paths.each do |path|
+        if File.directory?(path)
+          FileUtils.rm_rf(path)
+        elsif File.file?(path)
+          FileUtils.rm(path)
+        end
+      end
+    end
   end
 end

data/lib/ruborg/cli.rb

@@ -6,68 +6,106 @@ module Ruborg
   # Command-line interface for ruborg
   class CLI < Thor
     class_option :config, type: :string, default: "ruborg.yml", desc: "Path to configuration file"
+    class_option :log, type: :string, desc: "Path to log file"
+
+    def initialize(*args)
+      super
+      @logger = RuborgLogger.new(log_file: options[:log])
+    end
 
     desc "init REPOSITORY", "Initialize a new Borg repository"
     option :passphrase, type: :string, desc: "Repository passphrase"
     option :passbolt_id, type: :string, desc: "Passbolt resource ID for passphrase"
     def init(repository_path)
+      @logger.info("Initializing repository at #{repository_path}")
       passphrase = get_passphrase(options[:passphrase], options[:passbolt_id])
       repo = Repository.new(repository_path, passphrase: passphrase)
       repo.create
+      @logger.info("Repository successfully initialized at #{repository_path}")
       puts "Repository initialized at #{repository_path}"
     rescue Error => e
+      @logger.error("Failed to initialize repository: #{e.message}")
       error_exit(e)
     end
 
     desc "backup", "Create a backup using configuration file"
     option :name, type: :string, desc: "Archive name"
+    option :remove_source, type: :boolean, default: false, desc: "Remove source files after successful backup"
     def backup
+      @logger.info("Starting backup operation with config: #{options[:config]}")
       config = Config.new(options[:config])
+      @logger.info("Backing up paths: #{config.backup_paths.join(', ')}")
       passphrase = fetch_passphrase_from_config(config)
 
       repo = Repository.new(config.repository, passphrase: passphrase)
       backup = Backup.new(repo, config: config)
 
-      backup.create(name: options[:name])
+      archive_name = options[:name] || Time.now.strftime("%Y-%m-%d_%H-%M-%S")
+      @logger.info("Creating archive: #{archive_name}")
+      backup.create(name: options[:name], remove_source: options[:remove_source])
+      @logger.info("Backup created successfully: #{archive_name}")
+
+      if options[:remove_source]
+        @logger.info("Removed source files: #{config.backup_paths.join(', ')}")
+      end
+
       puts "Backup created successfully"
+      puts "Source files removed" if options[:remove_source]
     rescue Error => e
+      @logger.error("Backup failed: #{e.message}")
       error_exit(e)
     end
 
     desc "list", "List all archives in the repository"
     def list
+      @logger.info("Listing archives in repository")
       config = Config.new(options[:config])
       passphrase = fetch_passphrase_from_config(config)
 
       repo = Repository.new(config.repository, passphrase: passphrase)
       repo.list
+      @logger.info("Successfully listed archives")
     rescue Error => e
+      @logger.error("Failed to list archives: #{e.message}")
       error_exit(e)
     end
 
     desc "restore ARCHIVE", "Restore files from an archive"
     option :destination, type: :string, default: ".", desc: "Destination directory"
+    option :path, type: :string, desc: "Specific file or directory path to restore from archive"
     def restore(archive_name)
+      restore_target = options[:path] ? "#{options[:path]} from #{archive_name}" : archive_name
+      @logger.info("Restoring #{restore_target} to #{options[:destination]}")
       config = Config.new(options[:config])
       passphrase = fetch_passphrase_from_config(config)
 
       repo = Repository.new(config.repository, passphrase: passphrase)
       backup = Backup.new(repo, config: config)
 
-      backup.extract(archive_name, destination: options[:destination])
-      puts "Archive restored to #{options[:destination]}"
+      backup.extract(archive_name, destination: options[:destination], path: options[:path])
+      @logger.info("Successfully restored #{restore_target} to #{options[:destination]}")
+
+      if options[:path]
+        puts "Restored #{options[:path]} from #{archive_name} to #{options[:destination]}"
+      else
+        puts "Archive restored to #{options[:destination]}"
+      end
     rescue Error => e
+      @logger.error("Failed to restore archive: #{e.message}")
       error_exit(e)
     end
 
     desc "info", "Show repository information"
     def info
+      @logger.info("Retrieving repository information")
       config = Config.new(options[:config])
       passphrase = fetch_passphrase_from_config(config)
 
       repo = Repository.new(config.repository, passphrase: passphrase)
       repo.info
+      @logger.info("Successfully retrieved repository information")
     rescue Error => e
+      @logger.error("Failed to get repository info: #{e.message}")
       error_exit(e)
     end
 

data/lib/ruborg/logger.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "logger"
+require "fileutils"
+
+module Ruborg
+  # Logging functionality for ruborg
+  class RuborgLogger
+    attr_reader :logger
+
+    def initialize(log_file: nil)
+      @log_file = log_file || default_log_file
+      ensure_log_directory
+      @logger = Logger.new(@log_file, "daily")
+      @logger.level = Logger::INFO
+      @logger.formatter = proc do |severity, datetime, progname, msg|
+        "[#{datetime.strftime('%Y-%m-%d %H:%M:%S')}] #{severity}: #{msg}\n"
+      end
+    end
+
+    def info(message)
+      @logger.info(message)
+    end
+
+    def error(message)
+      @logger.error(message)
+    end
+
+    def warn(message)
+      @logger.warn(message)
+    end
+
+    def debug(message)
+      @logger.debug(message)
+    end
+
+    private
+
+    def default_log_file
+      File.join(log_directory, "ruborg.log")
+    end
+
+    def log_directory
+      dir = File.expand_path("~/.ruborg/logs")
+      dir
+    end
+
+    def ensure_log_directory
+      FileUtils.mkdir_p(File.dirname(@log_file)) unless File.directory?(File.dirname(@log_file))
+    end
+  end
+end

data/lib/ruborg/passbolt.rb

@@ -13,10 +13,10 @@ module Ruborg
     def get_password
       raise PassboltError, "Resource ID not configured" unless @resource_id
 
-      cmd = ["passbolt", "get", @resource_id, "--json"]
-      output = `#{cmd.join(' ')}`
+      cmd = ["passbolt", "get", "resource", @resource_id, "--json"]
+      output, status = execute_command(cmd)
 
-      raise PassboltError, "Failed to retrieve password from Passbolt" unless $?.success?
+      raise PassboltError, "Failed to retrieve password from Passbolt" unless status
 
       parse_password(output)
     end
@@ -29,6 +29,11 @@ module Ruborg
       end
     end
 
+    def execute_command(cmd)
+      output = `#{cmd.join(' ')}`
+      [output, $?.success?]
+    end
+
     def parse_password(json_output)
       data = JSON.parse(json_output)
       data["password"] || data["secret"]

data/lib/ruborg/repository.rb

@@ -40,8 +40,11 @@ module Ruborg
     def execute_borg_command(cmd)
       env = {}
       env["BORG_PASSPHRASE"] = @passphrase if @passphrase
+      env["BORG_RELOCATED_REPO_ACCESS_IS_OK"] = "yes"
+      env["BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK"] = "yes"
 
-      result = system(env, *cmd)
+      # Redirect stdin from /dev/null to prevent interactive prompts
+      result = system(env, *cmd, in: "/dev/null")
       raise BorgError, "Borg command failed: #{cmd.join(' ')}" unless result
 
       result

data/lib/ruborg/version.rb

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

data/lib/ruborg.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "ruborg/version"
+require_relative "ruborg/logger"
 require_relative "ruborg/config"
 require_relative "ruborg/repository"
 require_relative "ruborg/backup"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruborg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michail Pantelelis
@@ -115,10 +115,10 @@ files:
 - lib/ruborg/backup.rb
 - lib/ruborg/cli.rb
 - lib/ruborg/config.rb
+- lib/ruborg/logger.rb
 - lib/ruborg/passbolt.rb
 - lib/ruborg/repository.rb
 - lib/ruborg/version.rb
-- ruborg.gemspec
 - ruborg.yml.example
 homepage: https://github.com/mpantel/ruborg
 licenses:

data/ruborg.gemspec

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/ruborg/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "ruborg"
-  spec.version = Ruborg::VERSION
-  spec.authors = ["Michail Pantelelis"]
-  spec.email = ["mpantel@aegean.gr"]
-
-  spec.summary = "A friendly Ruby frontend for Borg backup"
-  spec.description = "Ruborg is a Ruby gem that provides a user-friendly interface to Borg backup. It reads YAML configuration files and orchestrates backup operations, supporting repository creation, backup management, and integration with Passbolt for encryption password management."
-  spec.homepage = "https://github.com/mpantel/ruborg"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.2.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "#{spec.homepage}.git"
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Dependencies
-  spec.add_dependency "thor", "~> 1.3"
-  spec.add_dependency "psych", "~> 5.0"
-
-  # Development dependencies
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 1.0"
-end