yobi 0.1.0

data/sig/yobi.rbs

@@ -0,0 +1,660 @@
+module Yobi
+  VERSION: String
+
+  class Error < StandardError
+  end
+
+  class ExitError < SimpleDelegator
+    LINE_PATTERN: Regexp
+
+    def self.from_output: (ResticOutput output) -> ExitError?
+
+    def code: () -> String?
+
+    def message: () -> String?
+  end
+
+  class UnsupportedResticVersion < Error
+    attr_reader installed_version: String
+    attr_reader minimum_version: String
+
+    def initialize: (installed_version: String, minimum_version: String) -> void
+  end
+
+  class ResticNotFound < Error
+    attr_reader restic_path: String
+    attr_reader argv: Array[String]
+
+    def initialize: (restic_path: String, argv: Array[String]) -> void
+  end
+
+  type execution = { exit_code: Integer, output: ResticOutput, argv: Array[String] }
+
+  class ResticExecutionError < Error
+    attr_reader execution: execution
+    attr_reader exit_error: ExitError?
+
+    def initialize: (execution execution) -> void
+  end
+
+  class RepositoryNotFound < ResticExecutionError
+  end
+
+  class RepositoryLocked < ResticExecutionError
+  end
+
+  class AuthenticationFailed < ResticExecutionError
+  end
+
+  class ResticCommandFailed < ResticExecutionError
+  end
+
+  class MountTimeout < Error
+    attr_reader argv: Array[String]
+    attr_reader timeout: Numeric
+
+    def initialize: (argv: Array[String], timeout: Numeric) -> void
+  end
+
+  class ArgvBuilder
+    FLAGS: Hash[Symbol, String]
+    SHORT_FLAGS: Hash[Symbol, String]
+
+    def initialize: () -> void
+
+    def to_a: () -> Array[String]
+
+    def append: (*untyped values) -> self
+
+    def flag: (Symbol name, ?untyped value) -> self
+
+    def repeat_flag: (Symbol name, untyped values) -> self
+
+    def short_flag: (Symbol name) -> self
+
+    def end_of_options: () -> self
+  end
+
+  class IOHandle
+    attr_reader io: IO
+    attr_reader pid: Integer
+
+    def initialize: (IO io, pid: Integer, output_file: File, argv: Array[String]) -> void
+
+    def closed?: () -> bool
+
+    def close: () -> void
+
+    def each: () { (String chunk) -> void } -> void
+  end
+
+  class Mount
+    attr_reader mountpoint: String
+
+    def initialize: (wait_thr: Process::Waiter, mountpoint: String, output: IO, output_file: File, argv: Array[String]) -> void
+
+    def pid: () -> Integer
+
+    def stopped?: () -> bool
+
+    def stop: () -> void
+  end
+
+  class ResticOutput
+    DEFAULT_TAIL_CHUNK_SIZE: Integer
+
+    def initialize: (File file, ?tail_chunk_size: Integer) -> void
+
+    def index: () -> Hash[String, Array[Integer]]
+
+    def read_line_at: (Integer offset) -> String
+
+    def last_line: () -> String?
+
+    def each_line: () { (String line) -> void } -> void
+                 | () -> Enumerator[String, void]
+
+    def to_s: () -> String
+  end
+
+  class Snapshot < SimpleDelegator
+    def id: () -> String
+
+    def short_id: () -> String
+
+    def time: () -> Time
+
+    def host: () -> String
+
+    def tags: () -> Array[String]
+
+    def paths: () -> Array[String]
+
+    def parent_id: () -> String?
+  end
+
+  type password = String | [:command, String] | [:file, String] | :insecure_no_password | (^() -> String) | nil
+  type backend_credentials = Hash[String, String] | (^() -> Hash[String, String])
+  type restic_or_path = Restic | String | nil
+
+  class Restic
+    MINIMUM_VERSION: Gem::Version
+    ALLOWED_ENV_VARS: Set[String]
+
+    attr_reader restic_path: String
+    attr_accessor cache_dir: String?
+    attr_accessor compression: String?
+    attr_accessor pack_size: Integer?
+    attr_accessor read_concurrency: Integer?
+    attr_accessor host: String?
+    attr_accessor progress_fps: Integer?
+    attr_accessor cacert: String?
+    attr_accessor tls_client_cert: String?
+    attr_accessor key_hint: String?
+    attr_accessor limit_download: String?
+    attr_accessor limit_upload: String?
+    attr_accessor retry_lock: String?
+    attr_accessor no_lock: bool
+    attr_accessor no_cache: bool
+    attr_accessor cleanup_cache: bool
+    attr_accessor no_extra_verify: bool
+    attr_accessor stuck_request_timeout: String?
+    attr_accessor options: Array[String]
+    attr_accessor http_user_agent: String?
+    attr_accessor quiet: bool
+
+    def initialize: (?String? restic_path, ?env: Hash[String, String], ?cache_dir: String?,
+      ?compression: String?, ?pack_size: Integer?, ?read_concurrency: Integer?, ?host: String?,
+      ?progress_fps: Integer?, ?cacert: String?, ?tls_client_cert: String?, ?key_hint: String?,
+      ?limit_download: String?, ?limit_upload: String?, ?retry_lock: String?, ?no_lock: bool,
+      ?no_cache: bool, ?cleanup_cache: bool, ?no_extra_verify: bool, ?stuck_request_timeout: String?,
+      ?options: Array[String], ?http_user_agent: String?, ?quiet: bool) -> void
+
+    def env: () -> Hash[String, String]
+
+    def append_global_flags: (ArgvBuilder a) -> void
+
+    def inspect: () -> String
+
+    def version: () -> Hash[String, untyped]
+
+    def cache: (?cleanup: bool, ?max_age: String?, ?no_size: bool) -> true
+
+    def run: (Array[String] argv, ?extra_env: Hash[String, String], ?skip_version_check: bool) ?{ (Hash[String, untyped] message) -> void } -> execution
+
+    def self.dispatch: (execution execution) -> execution
+
+    def run_dump: (Array[String] argv, ?extra_env: Hash[String, String]) { (IO io) -> untyped } -> untyped
+                | (Array[String] argv, ?extra_env: Hash[String, String]) -> IOHandle
+
+    def ensure_minimum_version!: () -> void
+
+    def run_mount: (Array[String] argv, mountpoint: String, ?extra_env: Hash[String, String], ?ready_timeout: Numeric) -> Mount
+  end
+
+  class Repository
+    attr_reader url: String
+    attr_reader password: password
+    attr_reader backend_credentials: backend_credentials
+
+    def initialize: (url: String, ?password: password, ?backend_credentials: backend_credentials, ?restic: restic_or_path) -> void
+
+    def env: () -> Hash[String, String]
+
+    def inspect: () -> String
+
+    def init: (?copy_chunker_params: bool, ?from_insecure_no_password: bool, ?from_key_hint: String?,
+      ?from_password_command: String?, ?from_password_file: String?, ?from_repo: String?,
+      ?from_repository_file: String?, ?repository_version: String?) -> Hash[String, untyped]
+
+    def config: () -> Hash[String, untyped]
+
+    def backup: (source: String | [:stdin_from_command, String | Array[String]] | [:stdin_from_command, String | Array[String], String],
+      ?excludes: Array[String] | String, ?exclude_files: Array[String] | String,
+      ?exclude_if_present: Array[String] | String, ?exclude_larger_than: String?,
+      ?files_from: Array[String] | String, ?files_from_raw: Array[String] | String,
+      ?files_from_verbatim: Array[String] | String, ?iexcludes: Array[String] | String,
+      ?iexclude_files: Array[String] | String, ?tags: Array[String] | String, ?dry_run: bool,
+      ?exclude_caches: bool, ?exclude_cloud_files: bool, ?force: bool, ?group_by: String?,
+      ?host: String?, ?ignore_ctime: bool, ?ignore_inode: bool, ?no_scan: bool,
+      ?one_file_system: bool, ?parent: String?, ?read_concurrency: Integer?,
+      ?skip_if_unchanged: bool, ?time: String?, ?verbose: bool, ?with_atime: bool)
+      ?{ (BackupStatus | BackupError | BackupVerboseStatus message) -> void } -> BackupOutcome
+
+    def cat_snapshot: (String | Snapshot id) -> Hash[String, untyped]
+
+    def cat_index: (String id) -> Hash[String, untyped]
+
+    def cat_key: (String | Key id) -> Hash[String, untyped]
+
+    def cat_tree: (String | Snapshot snapshot_id, ?subfolder: String?) -> Hash[String, untyped]
+
+    def cat_pack: (String id) { (IO io) -> untyped } -> untyped
+                | (String id) -> IOHandle
+
+    def cat_blob: (String id) { (IO io) -> untyped } -> untyped
+                | (String id) -> IOHandle
+
+    def cat_masterkey_and_game_over_if_this_leaks: () -> Hash[String, untyped]
+
+    def check: (?hosts: Array[String] | String, ?paths: Array[String] | String, ?read_data: bool,
+      ?read_data_subset: String?, ?tags: Array[String] | String, ?with_cache: bool) -> CheckOutcome
+
+    def copy: (from_repo: String | Repository, ?from_password: password, ?snapshot_ids: Array[String] | String,
+      ?from_key_hint: String?, ?from_repository_file: String?, ?hosts: Array[String] | String,
+      ?paths: Array[String] | String, ?tags: Array[String] | String) -> true
+
+    def diff: (from: String, to: String, ?metadata: bool) -> DiffOutcome
+
+    def dump: (snapshot_id: String, file: String, ?target: String?, ?archive: String | Symbol | nil,
+      ?hosts: Array[String] | String, ?paths: Array[String] | String, ?tags: Array[String] | String)
+      { (IO io) -> untyped } -> untyped
+                | (snapshot_id: String, file: String, target: String, ?archive: String | Symbol | nil,
+      ?hosts: Array[String] | String, ?paths: Array[String] | String, ?tags: Array[String] | String) -> true
+                | (snapshot_id: String, file: String, ?target: String?, ?archive: String | Symbol | nil,
+      ?hosts: Array[String] | String, ?paths: Array[String] | String, ?tags: Array[String] | String) -> IOHandle
+
+    def find: (patterns: Array[String] | String, ?blob: bool, ?pack: bool, ?tree: bool,
+      ?hosts: Array[String] | String, ?human_readable: bool, ?ignore_case: bool, ?long: bool,
+      ?newest: String?, ?oldest: String?, ?paths: Array[String] | String, ?reverse: bool,
+      ?show_pack_id: bool, ?snapshot_ids: Array[String] | String, ?tags: Array[String] | String) -> FindMatches
+
+    def forget: (?keep_last: Integer?, ?keep_hourly: Integer?, ?keep_daily: Integer?, ?keep_weekly: Integer?,
+      ?keep_monthly: Integer?, ?keep_yearly: Integer?, ?keep_within: String?, ?keep_within_hourly: String?,
+      ?keep_within_daily: String?, ?keep_within_weekly: String?, ?keep_within_monthly: String?,
+      ?keep_within_yearly: String?, ?keep_tags: Array[String] | String, ?hosts: Array[String] | String,
+      ?tags: Array[String] | String, ?paths: Array[String] | String, ?compact: bool, ?group_by: String?,
+      ?dry_run: bool, ?prune: bool, ?unsafe_allow_remove_all: bool, ?max_unused: String?,
+      ?max_repack_size: String?, ?repack_cacheable_only: bool, ?repack_uncompressed: bool,
+      ?repack_smaller_than: String?) -> ForgetGroups
+
+    def key_add: (?host: String?, ?user: String?, ?new_insecure_no_password: bool, ?new_password_file: String?) -> true
+
+    def add_key: (?host: String?, ?user: String?, ?new_insecure_no_password: bool, ?new_password_file: String?) -> true
+
+    def key_list: () -> Keys
+
+    def keys: () -> Keys
+
+    def key_passwd: (?host: String?, ?user: String?, ?new_insecure_no_password: bool, ?new_password_file: String?) -> true
+
+    def change_password: (?host: String?, ?user: String?, ?new_insecure_no_password: bool, ?new_password_file: String?) -> true
+
+    def key_remove: (id: String) -> true
+
+    def remove_key: (id: String) -> true
+
+    def list: (Symbol | String type) -> Array[String]
+
+    def ls: (snapshot_id: String, ?dirs: Array[String] | String, ?hosts: Array[String] | String,
+      ?human_readable: bool, ?long: bool, ?paths: Array[String] | String, ?recursive: bool,
+      ?reverse: bool, ?sort: String?, ?tags: Array[String] | String) -> LsOutcome
+
+    def migrate: (?names: Array[String] | String, ?force: bool) -> true
+
+    def mount: (mountpoint: String, ?hosts: Array[String] | String, ?paths: Array[String] | String,
+      ?tags: Array[String] | String, ?allow_other: bool, ?no_default_permissions: bool,
+      ?owner_root: bool, ?path_templates: Array[String] | String, ?time_template: String?,
+      ?ready_timeout: Numeric) { (Mount mount) -> untyped } -> untyped
+                | (mountpoint: String, ?hosts: Array[String] | String, ?paths: Array[String] | String,
+      ?tags: Array[String] | String, ?allow_other: bool, ?no_default_permissions: bool,
+      ?owner_root: bool, ?path_templates: Array[String] | String, ?time_template: String?,
+      ?ready_timeout: Numeric) -> Mount
+
+    def prune: (?dry_run: bool, ?max_repack_size: String?, ?max_unused: String?,
+      ?repack_cacheable_only: bool, ?repack_smaller_than: String?, ?repack_uncompressed: bool,
+      ?unsafe_recover_no_free_space: String?) -> true
+
+    def recover: () -> true
+
+    def repair_index: (?read_all_packs: bool) -> true
+
+    def repair_packs: (ids: Array[String] | String) -> true
+
+    def repair_snapshots: (?snapshot_ids: Array[String] | String, ?dry_run: bool, ?forget: bool,
+      ?hosts: Array[String] | String, ?paths: Array[String] | String, ?tags: Array[String] | String) -> true
+
+    def restore: (snapshot_id: String, target: String, ?excludes: Array[String] | String,
+      ?exclude_files: Array[String] | String, ?exclude_xattrs: Array[String] | String,
+      ?hosts: Array[String] | String, ?iexcludes: Array[String] | String,
+      ?iexclude_files: Array[String] | String, ?iincludes: Array[String] | String,
+      ?iinclude_files: Array[String] | String, ?includes: Array[String] | String,
+      ?include_files: Array[String] | String, ?include_xattrs: Array[String] | String,
+      ?paths: Array[String] | String, ?tags: Array[String] | String, ?delete: bool, ?dry_run: bool,
+      ?overwrite: String | Symbol | nil, ?ownership_by_name: bool, ?sparse: bool, ?verbose: bool,
+      ?verify: bool) ?{ (RestoreStatus | RestoreVerboseStatus message) -> void } -> RestoreOutcome
+
+    def rewrite: (?snapshot_ids: Array[String] | String, ?hosts: Array[String] | String,
+      ?tags: Array[String] | String, ?paths: Array[String] | String, ?excludes: Array[String] | String,
+      ?exclude_files: Array[String] | String, ?iexcludes: Array[String] | String,
+      ?iexclude_files: Array[String] | String, ?includes: Array[String] | String,
+      ?include_files: Array[String] | String, ?iincludes: Array[String] | String,
+      ?iinclude_files: Array[String] | String, ?dry_run: bool, ?forget: bool, ?new_host: String?,
+      ?new_time: String?, ?snapshot_summary: bool) -> true
+
+    def snapshots: (?tags: Array[String] | String, ?hosts: Array[String] | String,
+      ?paths: Array[String] | String, ?compact: bool, ?group_by: String?, ?latest: Integer?) -> Snapshots
+
+    def stats: (?snapshot_ids: Array[String] | String, ?hosts: Array[String] | String,
+      ?mode: String | Symbol | nil, ?paths: Array[String] | String, ?tags: Array[String] | String) -> Hash[String, untyped]
+
+    def tag: (?snapshot_ids: Array[String] | String, ?add: Array[String] | String,
+      ?remove: Array[String] | String, ?set: Array[String] | String, ?tags: Array[String] | String,
+      ?hosts: Array[String] | String, ?paths: Array[String] | String) -> TagOutcome
+
+    def unlock: (?remove_all: bool) -> true
+  end
+
+  class BackupOutcome
+    attr_reader exit_code: Integer
+    attr_reader output: ResticOutput
+
+    COMMAND_OUTPUT_LINE_PATTERN: Regexp
+
+    def success?: () -> bool
+
+    def partial?: () -> bool
+
+    def errors: () -> BackupErrors
+
+    def command_output: () -> Array[String]
+
+    def report: () -> Hash[String, untyped]
+  end
+
+  class BackupStatus < SimpleDelegator
+    def percent_done: () -> Float?
+
+    def total_files: () -> Integer?
+
+    def files_done: () -> Integer?
+
+    def total_bytes: () -> Integer?
+
+    def bytes_done: () -> Integer?
+
+    def current_files: () -> Array[String]
+
+    def error_count: () -> Integer
+  end
+
+  class BackupError < SimpleDelegator
+    def message: () -> String?
+
+    def during: () -> String?
+
+    def item: () -> String?
+  end
+
+  class BackupErrors
+    include Enumerable[BackupError]
+
+    def initialize: (ResticOutput output) -> void
+
+    def each: () { (BackupError error) -> void } -> void
+            | () -> Enumerator[BackupError, void]
+  end
+
+  class BackupVerboseStatus < SimpleDelegator
+    def action: () -> String
+
+    def item: () -> String
+
+    def duration: () -> Integer
+
+    def data_size: () -> Integer
+
+    def data_size_in_repo: () -> Integer
+
+    def metadata_size: () -> Integer
+
+    def metadata_size_in_repo: () -> Integer
+
+    def total_files: () -> Integer
+  end
+
+  class CheckOutcome
+    attr_reader exit_code: Integer
+    attr_reader output: ResticOutput
+
+    def report: () -> Hash[String, untyped]
+
+    def errors: () -> CheckErrors
+  end
+
+  class CheckError < SimpleDelegator
+    def message: () -> String
+  end
+
+  class CheckErrors
+    include Enumerable[CheckError]
+
+    def initialize: (ResticOutput output) -> void
+
+    def each: () { (CheckError error) -> void } -> void
+            | () -> Enumerator[CheckError, void]
+  end
+
+  class DiffOutcome
+    attr_reader exit_code: Integer
+    attr_reader output: ResticOutput
+
+    def report: () -> Hash[String, untyped]
+
+    def changes: () -> DiffChanges
+  end
+
+  class DiffChange < SimpleDelegator
+    def path: () -> String
+
+    def modifier: () -> String
+  end
+
+  class DiffChanges
+    include Enumerable[DiffChange]
+
+    def initialize: (ResticOutput output) -> void
+
+    def each: () { (DiffChange change) -> void } -> void
+            | () -> Enumerator[DiffChange, void]
+  end
+
+  class FindMatch < SimpleDelegator
+    def path: () -> String
+
+    def type: () -> String
+
+    def size: () -> Integer
+
+    def permissions: () -> String
+
+    def uid: () -> Integer
+
+    def gid: () -> Integer
+
+    def user: () -> String
+
+    def group: () -> String
+
+    def inode: () -> Integer
+
+    def mtime: () -> Time
+
+    def atime: () -> Time
+
+    def ctime: () -> Time
+  end
+
+  class MatchesPerSnapshot < SimpleDelegator
+    def snapshot: () -> Hash[String, untyped]
+
+    def hits: () -> Integer
+
+    def matches: () -> Array[FindMatch]
+  end
+
+  class FindMatches
+    include Enumerable[MatchesPerSnapshot]
+
+    attr_reader output: ResticOutput
+
+    def initialize: (ResticOutput output) -> void
+
+    def each: () { (MatchesPerSnapshot matches) -> void } -> void
+            | () -> Enumerator[MatchesPerSnapshot, void]
+  end
+
+  class ForgetGroups
+    include Enumerable[ForgetGroup]
+
+    attr_reader exit_code: Integer
+    attr_reader output: ResticOutput
+
+    def initialize: (Integer exit_code, ResticOutput output) -> void
+
+    def each: () { (ForgetGroup group) -> void } -> void
+            | () -> Enumerator[ForgetGroup, void]
+
+    def success?: () -> bool
+
+    def partial?: () -> bool
+  end
+
+  class ForgetGroup < SimpleDelegator
+    def host: () -> String
+
+    def tags: () -> Array[String]
+
+    def paths: () -> Array[String]
+
+    def keep: () -> Array[Snapshot]
+
+    def remove: () -> Array[Snapshot]
+
+    def reasons: () -> Array[ForgetReason]
+  end
+
+  class ForgetReason < SimpleDelegator
+    def snapshot: () -> Snapshot
+
+    def matches: () -> Array[String]
+  end
+
+  class Key < SimpleDelegator
+    def id: () -> String
+
+    def user_name: () -> String
+
+    def host_name: () -> String
+
+    def current?: () -> bool
+
+    def created: () -> Time
+  end
+
+  class Keys
+    include Enumerable[Key]
+
+    attr_reader output: ResticOutput
+
+    def initialize: (ResticOutput output) -> void
+
+    def each: () { (Key key) -> void } -> void
+            | () -> Enumerator[Key, void]
+  end
+
+  class LsOutcome
+    attr_reader exit_code: Integer
+    attr_reader output: ResticOutput
+
+    def snapshot: () -> Snapshot
+
+    def entries: () -> LsEntries
+  end
+
+  class LsEntry < SimpleDelegator
+    def name: () -> String
+
+    def type: () -> String
+
+    def path: () -> String
+
+    def size: () -> Integer
+
+    def permissions: () -> String
+
+    def uid: () -> Integer
+
+    def gid: () -> Integer
+
+    def inode: () -> Integer
+
+    def mtime: () -> Time
+
+    def atime: () -> Time
+
+    def ctime: () -> Time
+  end
+
+  class LsEntries
+    include Enumerable[LsEntry]
+
+    def initialize: (ResticOutput output) -> void
+
+    def each: () { (LsEntry entry) -> void } -> void
+            | () -> Enumerator[LsEntry, void]
+  end
+
+  class RestoreOutcome
+    attr_reader exit_code: Integer
+    attr_reader output: ResticOutput
+
+    def report: () -> Hash[String, untyped]
+  end
+
+  class RestoreStatus < SimpleDelegator
+    def percent_done: () -> Float?
+
+    def total_files: () -> Integer?
+
+    def files_restored: () -> Integer?
+
+    def total_bytes: () -> Integer?
+
+    def bytes_restored: () -> Integer?
+  end
+
+  class RestoreVerboseStatus < SimpleDelegator
+    def action: () -> String
+
+    def item: () -> String
+
+    def size: () -> Integer
+  end
+
+  class Snapshots
+    include Enumerable[Snapshot]
+
+    attr_reader output: ResticOutput
+
+    def initialize: (ResticOutput output) -> void
+
+    def each: () { (Snapshot snapshot) -> void } -> void
+            | () -> Enumerator[Snapshot, void]
+  end
+
+  class TagOutcome
+    attr_reader exit_code: Integer
+    attr_reader output: ResticOutput
+
+    def report: () -> Hash[String, untyped]
+
+    def changes: () -> Array[TagChange]
+  end
+
+  class TagChange < SimpleDelegator
+    def old_snapshot_id: () -> String
+
+    def new_snapshot_id: () -> String
+  end
+end