filedepot 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d53822cb0793186be40e3532598732de7294227c353dd20932b36b97a439a020
-  data.tar.gz: 4433043fce6deeca6b44f8de0a0f1fdf921759bf4af1eb64f828ae65facd2660
+  metadata.gz: 2e47c70e2249f31321d1bcebfdf547d828ea1fa2414abe5cae782cfb1cc494bb
+  data.tar.gz: 3707898672533edd8e377b3f0a4d8c6e7fbc60b7c001626784ecefa16b4b9ec2
 SHA512:
-  metadata.gz: b77aabe8883cc7f675e4156f2160c03229837666036b1ad9de2d7d2ecd913dfdf1cbaea31ac543788419c0f296116e6651af7a23ed28dd274716fd0f8bbc521b
-  data.tar.gz: 5fe65c7e2840f7eaf8550d1434222647b19742cfdf01391d737ed6fcefcd20e551b8e20ca6d5922571ab36fcadd0bccf8d51bda7a3e9e849eafeefa53b56a56b
+  metadata.gz: 6758ed8235980592480dc3ed51316e7ff87ba6f3d9fe6198adde995f3488177103adcf860afb39cac131f49b08e5888ef7dcf1433c195021c3d9408afcc8ca09
+  data.tar.gz: ff7decf067599ee4b36c6855f354bbd09efa78055ea206559adf10f2ff48a5162abf79039abfae6454b3aa03ce658ac103dacdab2d2d92368b982fa529361862

data/README.md

@@ -20,36 +20,38 @@ gem "filedepot"
 
 Config file: `$HOME/.filedepot/config.yml`
 
-On first run, a default config is created:
+Run `filedepot setup` to create the config. On first run of any command, setup is automatically invoked if no config exists.
 
 ```yaml
-default_source: test
-sources:
+stores:
   - name: test
-    ssh: ssh
+    type: ssh
     host: 127.0.0.1
-    username:
+    username: user
     base_path: /Users/user/filedepot
+default_store: test
 ```
 
-Optional `public_base_path` for public URLs (shown in info and after push):
+Optional `public_base_url` for public URLs (shown in info and after push):
 
 ```yaml
-sources:
+stores:
   - name: test
-    ssh: ssh
+    type: ssh
     host: 127.0.0.1
     base_path: /data/filedepot
-    public_base_path: https://example.com/files
+    public_base_url: https://example.com/files
+default_store: test
 ```
 
-When `default_source` does not match any source name, the first source is used.
+When `default_store` does not match any store name, the first store is used.
 
 ## Commands
 
 | Command | Description |
 |---------|-------------|
-| `filedepot` | Show current source and available commands |
+| `filedepot` | Show current store and available commands |
+| `filedepot setup` | Create or reconfigure config (interactive) |
 | `filedepot config` | Open config file with $EDITOR |
 | `filedepot push HANDLE FILE` | Send file to current storage |
 | `filedepot pull HANDLE [--path PATH] [--version N]` | Get file from storage |
@@ -64,7 +66,7 @@ When `default_source` does not match any source name, the first source is used.
 filedepot push test test.txt
 ```
 
-Sends `test.txt` to storage with handle `test`. Each push creates a new version. When `public_base_path` is configured, the URL is shown after upload.
+Sends `test.txt` to storage with handle `test`. Each push creates a new version. When `public_base_url` is configured, the URL is shown after upload.
 
 ### Pull
 
@@ -83,7 +85,7 @@ Lists versions in descending order with creation datetime. Shows at most 10, wit
 
 ### Info
 
-Shows handle, remote base path, current version, updated-at datetime, and latest version URL (when `public_base_path` is set).
+Shows handle, remote base path, current version, updated-at datetime, and latest version URL (when `public_base_url` is set).
 
 ## Testing
 

data/bin/filedepot

@@ -3,6 +3,12 @@
 
 require "filedepot"
 
+# Run setup if config does not exist (first run)
+if ARGV[0] != "setup" && !Filedepot::Config.exists?
+  puts "~/.filedepot/config.yml not found, let's config it"
+  Filedepot::CLI.start(["setup"])
+end
+
 # Handle no-args: Thor by default shows help, we want our custom default output
 if ARGV.empty?
   Filedepot::CLI.new.invoke(:default)

data/lib/filedepot/cli.rb

@@ -14,6 +14,12 @@ module Filedepot
 
         Opens the config file ($HOME/.filedepot/config.yml) using $EDITOR.
       HELP
+      setup: <<~HELP,
+        Usage:
+          filedepot setup
+
+        Create or reconfigure the config file. Prompts for store name, type, host, username, and base path.
+      HELP
       push: <<~HELP,
         Usage:
           filedepot push HANDLE FILE
@@ -38,15 +44,114 @@ module Filedepot
       versions: "Usage: filedepot versions HANDLE\n\nList all versions of a handle. Each version has an integer ID from 1 to n.",
       delete: "Usage: filedepot delete HANDLE [VERSION]\n\nAfter confirmation, deletes all versions of a file.\nIf VERSION is specified, deletes only that specific version.",
       info: "Usage: filedepot info HANDLE\n\nShow info for a handle: remote base path and current version.",
-      handles: "Usage: filedepot handles\n\nList all handles in storage."
+      handles: "Usage: filedepot handles\n\nList all handles in storage.",
+      test: "Usage: filedepot test\n\nRun end-to-end test: push, pull, delete a temporary file."
     }.freeze
 
+    desc "test", "Run end-to-end test (push, pull, delete)"
+    def test
+      store = check_config
+      return unless store
+
+      timestamp = Time.now.to_i
+      test_handle = timestamp.to_s
+      test_filename = "#{timestamp}.txt"
+
+      File.write(test_filename, Time.now.to_s)
+      invoke :push, [test_handle, test_filename]
+
+      File.delete(test_filename)
+
+      invoke :pull, [test_handle]
+
+      invoke :delete, [test_handle], yes: true
+
+      if File.exist?(test_filename)
+        File.delete(test_filename)
+        puts "Test is OK"
+      else
+        puts "Test is KO, see the outputs for errors"
+      end
+    rescue RuntimeError => e
+      puts "Test is KO, see the outputs for errors"
+      puts "Error: #{e.message}"
+    end
+
     desc "config", "Open the config file using $EDITOR"
     def config
       config_path = Config::CONFIG_PATH
-      Config.ensure_config!
+      unless Config.exists?
+        puts "Error: No config file. Run 'filedepot setup' first."
+        return
+      end
       editor = ENV["EDITOR"] || "vim"
-      exec(editor, config_path)
+      system(editor, config_path)
+      return unless confirm?("Run a test? [y/N]")
+
+      invoke :test
+    end
+
+    desc "setup", "Create or reconfigure the config file"
+    def setup
+      store_types = Storage::Base.store_types
+      first_type = store_types.keys.first
+      defaults = store_types[first_type][:config].transform_keys(&:to_s)
+
+      if Config.exists?
+        config = Config.load
+        stores = config["stores"] || []
+        first_store = stores.first
+        if first_store
+          defaults["name"] = (first_store["name"] || first_store[:name]).to_s
+          defaults["host"] = (first_store["host"] || first_store[:host]).to_s
+          defaults["username"] = (first_store["username"] || first_store[:username]).to_s
+          defaults["base_path"] = (first_store["base_path"] || first_store[:base_path]).to_s
+          defaults["public_base_url"] = (first_store["public_base_url"] || first_store[:public_base_url]).to_s
+        end
+      end
+
+      puts "Configure storage store (press Enter to accept default)"
+      puts ""
+
+      name = prompt_with_default("store name", defaults["name"])
+      type = prompt_with_default("Type (#{store_types.keys.join(', ')})", first_type.to_s)
+      host = prompt_with_default("Host", defaults["host"])
+      username = prompt_with_default("Username", defaults["username"])
+      base_path = prompt_with_default("Base path", defaults["base_path"])
+      public_base_url = prompt_with_default("Public base URL (optional)", defaults["public_base_url"])
+
+      puts ""
+      puts "Store: #{name}"
+      puts "  Type: #{type}"
+      puts "  Host: #{host}"
+      puts "  Username: #{username}"
+      puts "  Base path: #{base_path}"
+      puts "  Public base URL: #{public_base_url}" unless public_base_url.empty?
+      puts ""
+
+      return unless confirm?("Write config? [y/N]")
+
+      store_hash = {
+        "name" => name,
+        "type" => type,
+        "host" => host,
+        "username" => username,
+        "base_path" => base_path,
+        "public_base_url" => (public_base_url.empty? ? nil : public_base_url)
+      }.compact
+
+      config = {
+        "default_store" => name,
+        "stores" => [store_hash]
+      }
+
+      FileUtils.mkdir_p(Config::CONFIG_DIR)
+      File.write(Config::CONFIG_PATH, config.to_yaml)
+      puts "Config written to #{Config::CONFIG_PATH}"
+
+      return unless confirm?("Run a test? [y/N]")
+
+      invoke :test
     end
 
     desc "push HANDLE FILE", "Send a file to the current storage with a specific handle"
@@ -65,13 +170,10 @@ module Filedepot
         return
       end
 
-      source = Config.current_source
-      if source.nil?
-        puts "Error: No storage source configured. Run 'filedepot config' to set up."
-        return
-      end
+      store = check_config
+      return unless store
 
-      storage = Storage::Base.for(source)
+      storage = Storage::Base.for(store)
       storage.push(handle, path)
       version = storage.current_version(handle)
       puts "Pushed #{file_path} as #{handle} (version #{version})"
@@ -90,16 +192,13 @@ module Filedepot
         return
       end
 
-      source = Config.current_source
-      if source.nil?
-        puts "Error: No storage source configured. Run 'filedepot config' to set up."
-        return
-      end
+      store = check_config
+      return unless store
 
       local_path = options[:path]
       version = (options[:version].nil? || options[:version].empty?) ? nil : options[:version].to_i
 
-      storage = Storage::Base.for(source)
+      storage = Storage::Base.for(store)
       info = storage.pull_info(handle, version, local_path)
       target_path = info[:target_path]
 
@@ -128,13 +227,10 @@ module Filedepot
         return
       end
 
-      source = Config.current_source
-      if source.nil?
-        puts "Error: No storage source configured. Run 'filedepot config' to set up."
-        return
-      end
+      store = check_config
+      return unless store
 
-      storage = Storage::Base.for(source)
+      storage = Storage::Base.for(store)
       versions_list = storage.versions(handle)
       if versions_list.empty?
         puts "Error: Handle '#{handle}' not found."
@@ -156,13 +252,10 @@ module Filedepot
         return
       end
 
-      source = Config.current_source
-      if source.nil?
-        puts "Error: No storage source configured. Run 'filedepot config' to set up."
-        return
-      end
+      store = check_config
+      return unless store
 
-      storage = Storage::Base.for(source)
+      storage = Storage::Base.for(store)
       versions_list = storage.versions(handle)
       if versions_list.empty?
         puts "Error: Handle '#{handle}' not found."
@@ -180,13 +273,10 @@ module Filedepot
 
     desc "handles", "List all handles in storage"
     def handles
-      source = Config.current_source
-      if source.nil?
-        puts "Error: No storage source configured. Run 'filedepot config' to set up."
-        return
-      end
+      store = check_config
+      return unless store
 
-      storage = Storage::Base.for(source)
+      storage = Storage::Base.for(store)
       handles = storage.ls
       if handles.empty?
         puts "No handles found."
@@ -196,19 +286,17 @@ module Filedepot
     end
 
     desc "delete HANDLE [VERSION]", "After confirmation, delete all versions of a file; or only a specific version if specified"
+    method_option :yes, type: :boolean, aliases: "-y", desc: "Skip confirmation (for scripts)"
     def delete(handle = nil, version = nil)
       if handle.nil?
         puts COMMAND_HELP[:delete]
         return
       end
 
-      source = Config.current_source
-      if source.nil?
-        puts "Error: No storage source configured. Run 'filedepot config' to set up."
-        return
-      end
+      store = check_config
+      return unless store
 
-      storage = Storage::Base.for(source)
+      storage = Storage::Base.for(store)
       versions_list = storage.versions(handle)
       if versions_list.empty?
         puts "Error: Handle '#{handle}' not found."
@@ -222,44 +310,53 @@ module Filedepot
         end
       end
 
-      version_str = version ? " version #{version}" : " all versions"
-      puts "This will delete '#{handle}'#{version_str}."
-      begin
-        print "Type the handle name to confirm: "
-        input = $stdin.gets&.strip
-      rescue Interrupt
-        puts
-        return
-      end
+      unless options[:yes]
+        version_str = version ? " version #{version}" : " all versions"
+        puts "This will delete '#{handle}'#{version_str}."
+        begin
+          print "Type the handle name to confirm: "
+          input = $stdin.gets&.strip
+        rescue Interrupt
+          puts
+          return
+        end
 
-      unless input == handle
-        puts "Aborted (handle name did not match)."
-        return
+        unless input == handle
+          puts "Aborted (handle name did not match)."
+          return
+        end
       end
 
       storage.delete(handle, version)
-      puts "Deleted handle#{handle}#{version ? " version #{version}" : ""}."
+      puts "Deleted handle '#{handle}'#{version ? " version #{version}" : ""}."
     rescue RuntimeError => e
       puts "Error: #{e.message}"
     end
 
     default_task :default
 
-    desc "default", "Show current source and list of available commands"
+    desc "default", "Show current store and list of available commands"
     def default
-      source = Config.current_source
       config = Config.load
-      default_name = config["default_source"]
+      if config.nil?
+        puts "Error: No storage store configured. Run 'filedepot setup' to set up."
+        return
+      end
+
+      store = Config.current_store
+      default_name = config["default_store"]
 
       puts "filedepot"
       puts "--------"
-      puts "Current source: #{default_name}"
-      if source
-        puts "  Type: #{source['ssh']} (#{source['host']})"
-        puts "  Base path: #{source['base_path']}"
+      puts "Current store: #{default_name}"
+      if store
+        type_str = store["type"] ? store["type"] : "unknown"
+      puts "  Type: #{type_str} (#{store['host']})"
+        puts "  Base path: #{store['base_path']}"
       end
       puts ""
       puts "Available commands:"
+      puts "  filedepot setup               Create or reconfigure config"
       puts "  filedepot config              Open config file using $EDITOR"
       puts "  filedepot info HANDLE         Show info for a handle"
       puts "  filedepot handles             List all handles in storage"
@@ -267,6 +364,7 @@ module Filedepot
       puts "  filedepot push HANDLE FILE    Send file to current storage"
       puts "  filedepot pull HANDLE [--path PATH] [--version N]  Get file from storage"
       puts "  filedepot delete HANDLE [VER] Delete file(s) after confirmation"
+      puts "  filedepot test                 Run end-to-end test"
       puts ""
       puts "Use 'filedepot help COMMAND' for more information on a command."
     end
@@ -277,6 +375,26 @@ module Filedepot
 
     private
 
+    def prompt_with_default(label, default)
+      default_str = default.to_s
+      prompt = default_str.empty? ? "#{label}: " : "#{label} [#{default_str}]: "
+      print prompt
+      input = $stdin.gets&.strip
+      input.empty? ? default_str : input
+    rescue Interrupt
+      puts
+      exit 1
+    end
+
+    def check_config
+      store = Config.current_store
+      if store.nil?
+        puts "Error: No storage store configured. Run 'filedepot setup' to set up."
+        return nil
+      end
+      store
+    end
+
     def confirm?(prompt)
       print "#{prompt} "
       input = $stdin.gets&.strip&.downcase

data/lib/filedepot/config.rb

@@ -8,38 +8,27 @@ module Filedepot
     CONFIG_DIR = File.expand_path("~/.filedepot")
     CONFIG_PATH = File.join(CONFIG_DIR, "config.yml")
 
-    DEFAULT_CONFIG = <<~YAML
-      default_source: test
-      sources:
-        - name: test
-          ssh: ssh
-          host: 127.0.0.1
-          username:
-          base_path: %<base_path>s
-    YAML
-
     class << self
-      def ensure_config!
-        return if File.exist?(CONFIG_PATH)
-
-        FileUtils.mkdir_p(CONFIG_DIR)
-        base_path = File.join(File.expand_path("~"), "filedepot")
-        File.write(CONFIG_PATH, format(DEFAULT_CONFIG, base_path: base_path))
+      def exists?
+        File.exist?(CONFIG_PATH)
       end
 
       def load
-        ensure_config!
+        return nil unless exists?
+
         YAML.load_file(CONFIG_PATH)
       end
 
-      def current_source
+      def current_store
         config = load
-        default = config["default_source"]
-        sources = config["sources"] || []
-        return nil if sources.empty?
+        return nil if config.nil?
+
+        default = config["default_store"]
+        stores = config["stores"] || []
+        return nil if stores.empty?
 
-        source = sources.find { |s| (s["name"] || s[:name]) == default }
-        source || sources.first
+        store = stores.find { |s| (s["name"] || s[:name]) == default }
+        store || stores.first
       end
     end
   end

data/lib/filedepot/storage/base.rb

@@ -3,16 +3,33 @@
 module Filedepot
   module Storage
     class Base
-      def self.for(source)
-        if source["ssh"]
-          Ssh.new(source)
+      STORE_TYPES = {
+        ssh: {
+          config: {
+            "name" => "test",
+            "type" => "ssh",
+            "host" => "127.0.0.1",
+            "username" => ENV["USER"].to_s.empty? ? "username" : ENV["USER"],
+            "base_path" => File.join(File.expand_path("~"), "filedepot"),
+            "public_base_url" => nil
+          }
+        }
+      }.freeze
+
+      def self.store_types
+        STORE_TYPES
+      end
+
+      def self.for(store)
+        if store["type"] == "ssh"
+          Ssh.new(store)
         else
-          raise ArgumentError, "Unknown storage type for source: #{source["name"]}"
+          raise ArgumentError, "Unknown storage type for store: #{store["name"]}"
         end
       end
 
-      def initialize(source)
-        @source = source
+      def initialize(store)
+        @store = store
       end
 
       def current_version(handle)
@@ -74,7 +91,7 @@ module Filedepot
       end
 
       def url(handle, version, filename)
-        base = @source["public_base_path"].to_s.sub(%r{/+$}, "")
+        base = @store["public_base_url"].to_s.sub(%r{/+$}, "")
         return nil if base.empty? || filename.nil? || filename.empty?
 
         path = [handle, version, filename].join("/")
@@ -84,7 +101,7 @@ module Filedepot
       protected
 
       def remote_base_path
-        @source["base_path"] || "/tmp/filedepot"
+        @store["base_path"] || "/tmp/filedepot"
       end
 
       def remote_handle_path(handle)

data/lib/filedepot/storage/ssh.rb

@@ -140,8 +140,8 @@ module Filedepot
       end
 
       def ssh_session
-        host = @source["host"] || "localhost"
-        user = @source["username"].to_s.strip
+        host = @store["host"] || "localhost"
+        user = @store["username"].to_s.strip
         user = ENV["USER"] if user.empty?
 
         Net::SSH.start(host, user) do |ssh|

data/lib/filedepot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Filedepot
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filedepot
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Filedepot