furaffinity 0.1.0 → 26.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50e5e2ea8cd319bee7eb1665afe2888c7d763dd63ab1889ff861621d0871c96d
-  data.tar.gz: 984287cda209a247bda7499bda6b5509cb56ae9bdda37ae1e32b9e17b98b4ce5
+  metadata.gz: 73eb5f5ac1b82da18816b27a511134753ee22ea2387f932e929540c639ed4f79
+  data.tar.gz: 578e0d9a28ebb0a991107dff1966d25ca05f2abdf47e0fe119922f0ad4dd3e91
 SHA512:
-  metadata.gz: 961c5c9f67fcc98522a3c09f51f83c299c4016d1987f29d18f8ba516f4d6b3b16f11213b70d76902f00b4174d213a423a94b854943d983bc69044678ffe0c031
-  data.tar.gz: 9f87aa43971869236f1f7b2d0ad02ba9bfa73a45cba39a103c84488cfbc51c60d6ea021a6dbcba2ccf6f399e2ec87608b4b4b4c16b65e9408d0276269ce785f2
+  metadata.gz: c7beca8cd88a0bb0da1c2d4af70434c97a1d199f99a3c9aacd82b0539cc4ff224430783ffa8eb6aa768226c943a76629cfd3b2c4eb073277915591d068d93a32
+  data.tar.gz: 16f425069ee8c619328dcc1ce3a433df9a3bfd3684e97d3f140215565f5807f69f928c72d3db8dd8d901f04933e4e28edaf0cb557ef60027c3731519c1dd5589

data/.rubocop.yml

@@ -1,5 +1,12 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 4.0
+  NewCops: enable
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: diff_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: diff_comma
 
 Style/StringLiterals:
   Enabled: true
@@ -9,5 +16,12 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
 Layout/LineLength:
   Max: 120

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 ## [Unreleased]
 
+## [26.1.0] - 2026-01-12
+
+### Added
+- On unexpected errors received from FurAffinity an `Furaffinity::RemoteError`
+  error is raised now.
+
+### Changed
+- Ruby 4.0 required
+- Removed `gender` field handling as these are just keywords now
+- Version scheme is now `year.month.patch`.
+
+## [0.2.0] - 2023-12-21
+
+### Added
+- `fa edit` command to edit submissions
+- `after_upload` hook to queues
+
+### Changed
+- `folder_name` is now called `create_folder_name` as it should
+
 ## [0.1.0] - 2023-11-04
 
 - Initial release

data/README.md

@@ -30,6 +30,10 @@ fa notifications
 
 # upload a new submission
 fa upload my_image.png --title "test post please ignore" --description "This is an image as you can see" --rating general --scrap
+
+# interactively update a submission, this needs your preferred editor in ENV
+export EDITOR=vi
+fa edit 54328944
 ```
 
 There is also a way to upload submissions in bulk: `fa queue`
@@ -73,7 +77,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/nilsding/furaffinity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nilsding/furaffinity/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on Codeberg at https://codeberg.org/jyrki/furaffinity-cli.com/nilsding/furaffinity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://codeberg.org/jyrki/furaffinity-cli/src/branch/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -81,4 +85,4 @@ The gem is available as open source under the terms of the [AGPLv3 License](http
 
 ## Code of Conduct
 
-Everyone interacting in the Furaffinity project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nilsding/furaffinity/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Furaffinity project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://codeberg.org/jyrki/furaffinity-cli/src/branch/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "minitest/test_task"
 
 task :default
+
+Minitest::TestTask.create

data/exe/fa

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 lib_dir = File.expand_path("../lib", __dir__)
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)

data/lib/furaffinity/cli.rb

@@ -1,21 +1,23 @@
 # frozen_string_literal: true
 
 require "json"
+require "tempfile"
 require "thor"
+require "yaml"
 
 module Furaffinity
   class Cli < Thor
     include CliBase
 
     class_option :log_level,
-      type:    :string,
-      desc:    "Log level to use",
-      default: "info"
+                 type:    :string,
+                 desc:    "Log level to use",
+                 default: "info"
 
     class_option :config,
-      type:    :string,
-      desc:    "Path to the config",
-      default: File.join(Dir.home, ".farc")
+                 type:    :string,
+                 desc:    "Path to the config",
+                 default: File.join(Dir.home, ".farc")
 
     desc "auth A_COOKIE B_COOKIE", "Store authentication info for FurAffinity"
     def auth(a_cookie, b_cookie)
@@ -36,37 +38,37 @@ module Furaffinity
 
     desc "upload FILE_PATH", "Upload a new submission"
     option :type,
-      type:    :string,
-      desc:    "Submission type.  One of: #{Furaffinity::Client::SUBMISSION_TYPES.join(", ")}",
-      default: "submission"
+           type:    :string,
+           desc:    "Submission type.  One of: #{Furaffinity::Client::SUBMISSION_TYPES.join(", ")}",
+           default: "submission"
     option :title,
-      type:     :string,
-      desc:     "Submission title.",
-      required: true
+           type:     :string,
+           desc:     "Submission title.",
+           required: true
     option :description,
-      type:     :string,
-      desc:     "Submission description.",
-      required: true
+           type:     :string,
+           desc:     "Submission description.",
+           required: true
     option :rating,
-      type:     :string,
-      desc:     "Submission rating.  One of: #{Furaffinity::Client::RATING_MAP.keys.join(", ")}",
-      required: true
+           type:     :string,
+           desc:     "Submission rating.  One of: #{Furaffinity::Client::RATING_MAP.keys.join(", ")}",
+           required: true
     option :lock_comments,
-      type:    :boolean,
-      desc:    "Disable comments on this submission.",
-      default: false
+           type:    :boolean,
+           desc:    "Disable comments on this submission.",
+           default: false
     option :scrap,
-      type:    :boolean,
-      desc:    "Place this upload to your scraps.",
-      default: false
+           type:    :boolean,
+           desc:    "Place this upload to your scraps.",
+           default: false
     option :keywords,
-      type:    :string,
-      desc:    "Keywords, separated by spaces.",
-      default: ""
-    option :folder_name,
-      type:    :string,
-      desc:    "Place this submission into this folder.",
-      default: ""
+           type:    :string,
+           desc:    "Keywords, separated by spaces.",
+           default: ""
+    option :create_folder_name,
+           type:    :string,
+           desc:    "Create a new folder and place this submission into it.",
+           default: ""
     def upload(file_path)
       set_log_level(options)
       config = config_for(options)
@@ -76,13 +78,61 @@ module Furaffinity
         *client
           .method(:upload)
           .parameters
-          .select { |(type, name)| %i[keyreq key].include?(type) }
+          .select { |(type, _name)| %i[keyreq key].include?(type) }
           .map(&:last)
       ).transform_keys(&:to_sym)
       url = client.upload(File.new(file_path), **upload_options)
       say "Submission uploaded!  #{url}", :green
     end
 
+    EDIT_TEMPLATE = <<~YAML.freeze
+      ---
+      # Submission info for %<id>s
+
+      # Required field:
+      title: %<title>s
+
+      # Required field
+      description: |-
+      %<description>s
+
+      # Optional field, keywords separated by spaces:
+      keywords: %<keywords>s
+
+      # Required field, one of: [#{Furaffinity::Client::RATING_MAP.keys.join(", ")}]
+      rating: %<rating>s
+
+      scrap: %<scrap>s
+      lock_comments: %<lock_comments>s
+
+      # vim: syntax=yaml
+    YAML
+
+    desc "edit ID", "Edit submission info"
+    def edit_interactive(id)
+      set_log_level(options)
+      config = config_for(options)
+      client = config.new_client
+
+      submission_info = client.submission_info(id)
+      # write template
+      file = Tempfile.new("facli_edit_#{id}")
+      file.puts format(EDIT_TEMPLATE,
+                       id:,
+                       **submission_info.slice(:title, :keywords, :scrap, :lock_comments).transform_values(&:inspect),
+                       description: submission_info.fetch(:message).gsub(/^/, "  "),
+                       rating:      submission_info.fetch(:rating))
+      file.close
+      CliUtils.open_editor file.path, fatal: true
+      params = YAML.safe_load_file(file.path, permitted_classes: [Symbol]).transform_keys(&:to_sym)
+
+      url = client.update(id:, **params)
+      say "Submission updated!  #{url}", :green
+    ensure
+      file.close
+      file.unlink
+    end
+
     desc "queue SUBCOMMAND ...ARGS", "Manage an upload queue"
     long_desc <<~LONG_DESC, wrap: false
       `#{basename} queue` manages an upload queue.
@@ -122,5 +172,10 @@ module Furaffinity
           #{basename} queue clean
     LONG_DESC
     subcommand "queue", CliQueue
+
+    map %w[--version -v] => :__print_version
+
+    desc "--version, -v", "Print the version"
+    def __print_version = puts "furaffinity-cli/#{VERSION}"
   end
 end

data/lib/furaffinity/cli_queue.rb

@@ -76,7 +76,7 @@ module Furaffinity
       queue.reload
 
       if queue.queue.empty?
-        say "Nothing is in the queue yet, use `#{File.basename $0} queue add ...` to add files.", :yellow
+        say "Nothing is in the queue yet, use `#{File.basename $PROGRAM_NAME} queue add ...` to add files.", :yellow
 
         print_uploaded_files
         return
@@ -91,7 +91,6 @@ module Furaffinity
       print_table queue_table, borders: true
 
       print_uploaded_files
-
     rescue Furaffinity::Error => e
       say e.message, :red
       exit 1
@@ -125,16 +124,16 @@ module Furaffinity
 
     def print_uploaded_files
       uploaded_files = queue.uploaded_files
-      unless uploaded_files.empty?
-        say
-        say "Uploaded files (will be removed when you run `#{File.basename $0} queue clean`):"
-        uploaded_table = [["File name", "Title", "Submission URL"], :separator]
-        uploaded_files.each do |file_name, upload_status|
-          file_info = queue.file_info.fetch(file_name)
-          uploaded_table << [file_name, file_info[:title], upload_status[:url]]
-        end
-        print_table uploaded_table, borders: true
+      return if uploaded_files.empty?
+
+      say
+      say "Uploaded files (will be removed when you run `#{File.basename $PROGRAM_NAME} queue clean`):"
+      uploaded_table = [["File name", "Title", "Submission URL"], :separator]
+      uploaded_files.each do |file_name, upload_status|
+        file_info = queue.file_info.fetch(file_name)
+        uploaded_table << [file_name, file_info[:title], upload_status[:url]]
       end
+      print_table uploaded_table, borders: true
     end
   end
 end

data/lib/furaffinity/cli_utils.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "English"
+require "shellwords"
+
+module Furaffinity
+  module CliUtils
+    module_function
+
+    include SemanticLogger::Loggable
+
+    def open_editor(file, fatal: false)
+      editor = ENV["FA_EDITOR"] || ENV["VISUAL"] || ENV.fetch("EDITOR", nil)
+      unless editor
+        logger.warn "could not open editor for #{file.inspect}, set one of FA_EDITOR, VISUAL, or EDITOR in your ENV"
+        if fatal
+          raise "No suitable editor found to edit #{file.inspect}, set one of FA_EDITOR, VISUAL, or EDITOR in your ENV"
+        end
+
+        return
+      end
+
+      system(*Shellwords.shellwords(editor), file).tap do
+        next if $CHILD_STATUS.exitstatus.zero?
+
+        logger.error "could not run #{editor} #{file}, exit code: #{$CHILD_STATUS.exitstatus}"
+      end
+    end
+  end
+end

data/lib/furaffinity/client.rb

@@ -51,16 +51,16 @@ module Furaffinity
       "journal"       => :journals,
       "unread"        => :notes,
       "troubleticket" => :trouble_tickets,
-    }
+    }.freeze
 
     def notifications
       get("/")
         .then(&method(:parse_response))
         .css("a.notification-container")
-        .map { _1.attr(:title) }
+        .map { it.attr(:title) }
         .uniq
         .each_with_object({}) do |item, h|
-          count, type, *_rest = item.split(" ")
+          count, type, *_rest = item.split
           count = count.tr(",", "").strip.to_i
           h[NOTIFICATIONS_MAP.fetch(type.downcase.strip)] = count
         end
@@ -73,44 +73,34 @@ module Furaffinity
       adult:   1,
     }.freeze
 
-    def fake_upload(file, title:, rating:, description:, keywords:, folder_name: "", lock_comments: false, scrap: false, type: :submission)
-      type = type.to_sym
-      raise ArgumentError.new("#{type.inspect} is not in #{SUBMISSION_TYPES.inspect}") unless SUBMISSION_TYPES.include?(type)
-      rating = rating.to_sym
-      raise ArgumentError.new("#{rating.inspect} is not in #{RATING_MAP.keys.inspect}") unless RATING_MAP.include?(rating)
-      raise "not a file" unless file.is_a?(File)
-      params = { MAX_FILE_SIZE: "10485760" }
-      raise ArgumentError.new("file size of #{file.size} is greater than FA limit of #{params[:MAX_FILE_SIZE]}") if file.size > params[:MAX_FILE_SIZE].to_i
-      "https://..."
-    end
-
     # @param file [File]
-    def upload(file, title:, rating:, description:, keywords:, folder_name: "", lock_comments: false, scrap: false, type: :submission)
-      type = type.to_sym
-      raise ArgumentError.new("#{type.inspect} is not in #{SUBMISSION_TYPES.inspect}") unless SUBMISSION_TYPES.include?(type)
-      rating = rating.to_sym
-      raise ArgumentError.new("#{rating.inspect} is not in #{RATING_MAP.keys.inspect}") unless RATING_MAP.include?(rating)
+    def upload(file, title:, rating:, description:, keywords:, create_folder_name: "", lock_comments: false,
+               scrap: false, type: :submission)
+      validate_args!(type:, rating:) => { type:, rating: }
 
       client = http_client
 
       # step 1: get the required keys
       logger.trace "Extracting keys from upload form"
       response = get("/submit/", client:).then(&method(:parse_response))
+      raise_if_system_message!(response)
+
       params = {
         submission_type: type,
         submission:      file,
         thumbnail:       {
           content_type: "application/octet-stream",
-          filename: "",
-          body: ""
+          filename:     "",
+          body:         "",
         },
       }
       params.merge!(
         %w[MAX_FILE_SIZE key]
-          .map { [_1.to_sym, response.css("form#myform input[name=#{_1}]").first.attr(:value)] }
-          .to_h
+          .to_h { [it.to_sym, response.css("form#myform input[name=#{it}]").first.attr(:value)] }
       )
-      raise ArgumentError.new("file size of #{file.size} is greater than FA limit of #{params[:MAX_FILE_SIZE]}") if file.size > params[:MAX_FILE_SIZE].to_i
+      if file.size > params[:MAX_FILE_SIZE].to_i
+        raise ArgumentError.new("file size of #{file.size} is greater than FA limit of #{params[:MAX_FILE_SIZE]}")
+      end
 
       # step 2: upload the submission file
       logger.debug "Uploading submission..."
@@ -118,7 +108,10 @@ module Furaffinity
       # for some reason HTTPX performs a GET redirect with the params so we
       # can't use its plugin here
       # --> follow the redirect ourselves
-      raise Error.new("expected a 302 response, got #{upload_response.status}") unless upload_response.status == 302
+      unless upload_response.status == 302
+        raise_if_system_message!(upload_response.then(&method(:parse_response)))
+        raise Error.new("expected a 302 response, got #{upload_response.status} without a system message.")
+      end
 
       redirect_location = upload_response.headers[:location]
       unless redirect_location == "/submit/finalize/"
@@ -127,49 +120,156 @@ module Furaffinity
       response = get(redirect_location, client:).then(&method(:parse_response))
 
       params = {
-        key: response.css("form#myform input[name=key]").first.attr(:value),
+        key:                response.css("form#myform input[name=key]").first.attr(:value),
 
         # category, "1" is "Visual Art -> All"
-        cat: "1",
+        cat:                "1",
         # theme, "1" is "General Things -> All"
-        atype: "1",
+        atype:              "1",
         # species, "1" is "Unspecified / Any"
-        species: "1",
-        # gender, "0" is "Any"
-        gender: "0",
+        species:            "1",
+
+        rating:             RATING_MAP.fetch(rating),
+        title:              title,
+        message:            description,
+        keywords:           keywords,
+
+        create_folder_name:,
+
+        # finalize button :)
+        finalize:           "Finalize ",
+      }
+      params[:lock_comments] = "1" if lock_comments
+      params[:scrap] = "1" if scrap
+
+      logger.debug "Finalising submission..."
+      finalize_response = post("/submit/finalize/", form: params, client:)
+      unless finalize_response.status == 302
+        raise_if_system_message!(finalize_response.then(&method(:parse_response)))
+        return
+      end
+
+      redirect_location = finalize_response.headers[:location]
+      url = File.join(BASE_URL, redirect_location)
+      logger.info "Uploaded! #{url}"
+      url
+    end
+
+    # Returns submission information from your own gallery.
+    def submission_info(id)
+      client = http_client
+
+      logger.trace { "Retrieving submission information for #{id}" }
+      response = get("/controls/submissions/changeinfo/#{id}/", client:).then(&method(:parse_response))
+      raise_if_system_message!(response)
+
+      {}.tap do |h|
+        h[:title] = response.css("form[name=MsgForm] input[name=title]").first.attr(:value)
+
+        %i[message keywords].each do |field|
+          h[field] = response.css("form[name=MsgForm] textarea[name=#{field}]").first.text
+        end
+
+        h[:rating] =
+          RATING_MAP.invert.fetch(response.css("form[name=MsgForm] input[name=rating][checked]").first.attr(:value).to_i)
+
+        %i[lock_comments scrap].each do |field|
+          h[field] = !!response.css("form[name=MsgForm] input[name=#{field}][checked]").first&.attr(:value)
+        end
+
+        %i[cat atype species].each do |field|
+          h[field] = response.css("form[name=MsgForm] select[name=#{field}] option[selected]").first.attr(:value)
+        end
+
+        h[:folder_ids] = response.css("form[name=MsgForm] input[name=\"folder_ids[]\"][checked]").map do
+          it.attr(:value)
+        end
+      end
+    end
+
+    # NOTE: only tested with `type=submission`
+    def update(id:, title:, rating:, description:, keywords:, lock_comments: false, scrap: false)
+      validate_args!(rating:) => { rating: }
+
+      client = http_client
+
+      # step 1: get the required keys
+      logger.trace { "Extracting keys from submission #{id}" }
+      response = get("/controls/submissions/changeinfo/#{id}/", client:).then(&method(:parse_response))
+      raise_if_system_message!(response)
+
+      already_set_params = {
+        key:        response.css("form[name=MsgForm] input[name=key]").first.attr(:value),
+        folder_ids: response.css("form[name=MsgForm] input[name=\"folder_ids[]\"][checked]").map { it.attr(:value) },
+      }.tap do |h|
+        %i[cat atype species].each do |field|
+          h[field] = response.css("form[name=MsgForm] select[name=#{field}] option[selected]").first.attr(:value)
+        end
+      end
+
+      params = {
+        update:   "yes",
 
         rating:   RATING_MAP.fetch(rating),
         title:    title,
         message:  description,
         keywords: keywords,
 
-        create_folder_name: folder_name,
+        **already_set_params,
 
-        # finalize button :)
-        finalize: "Finalize ",
+        # update button ;-)
+        submit:   "Update",
       }
       params[:lock_comments] = "1" if lock_comments
       params[:scrap] = "1" if scrap
 
-      logger.debug "Finalising submission..."
-      finalize_response = post("/submit/finalize/", form: params, client:)
-      if finalize_response.status == 302
-        redirect_location = finalize_response.headers[:location]
-        url = File.join(BASE_URL, redirect_location)
-        logger.info "Uploaded! #{url}"
-        return url
-      else
-        fa_error = parse_response(finalize_response).css(".redirect-message").text
-        raise Error.new("FA returned: #{fa_error}")
+      logger.debug { "Updating submission #{id}..." }
+      update_response = post("/controls/submissions/changeinfo/#{id}/", form: params, client:)
+      unless update_response.status == 302
+        raise_if_system_message!(update_response.then(&method(:parse_response)))
+        return
       end
+
+      redirect_location = update_response.headers[:location]
+      url = File.join(BASE_URL, redirect_location)
+      logger.info "Updated! #{url}"
+      url
     end
 
     private
 
+    def validate_args!(rating:, type: nil)
+      if type
+        type = type.to_sym
+        unless SUBMISSION_TYPES.include?(type)
+          raise ArgumentError.new("#{type.inspect} is not in #{SUBMISSION_TYPES.inspect}")
+        end
+      end
+      rating = rating.to_sym
+      unless RATING_MAP.include?(rating)
+        raise ArgumentError.new("#{rating.inspect} is not in #{RATING_MAP.keys.inspect}")
+      end
+
+      { type:, rating: }
+    end
+
+    # @return [Nokogiri::HTML::Document]
     def parse_response(httpx_response)
       logger.measure_trace "Parsing response" do
         Nokogiri::HTML.parse(httpx_response)
       end
     end
+
+    # @param response [Nokogiri::HTML::Document]
+    # @return String
+    def system_message(response) = response.css(".redirect-message")&.text
+
+    # @param response [Nokogiri::HTML::Document]
+    def raise_if_system_message!(response)
+      fa_error = system_message(response)
+      return if fa_error&.empty?
+
+      raise RemoteError.new(fa_error)
+    end
   end
 end

data/lib/furaffinity/config.rb

@@ -15,7 +15,7 @@ module Furaffinity
       else
         @config_hash = {}
       end
-    rescue => e
+    rescue StandardError => e
       logger.fatal("Error while loading configuration:", e)
       raise
     end
@@ -36,8 +36,8 @@ module Furaffinity
       end
     end
 
-    def set!(**kwargs)
-      set(**kwargs)
+    def set!(**)
+      set(**)
       save
     end
 

data/lib/furaffinity/queue.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "fileutils"
-require "shellwords"
 require "yaml"
 
 module Furaffinity
@@ -12,7 +11,7 @@ module Furaffinity
 
     SUBMISSION_INFO_EXT = ".info.yml"
 
-    SUBMISSION_TEMPLATE = <<~YAML
+    SUBMISSION_TEMPLATE = <<~YAML.freeze
       ---
       # Submission info for %<file_name>s
 
@@ -35,8 +34,46 @@ module Furaffinity
       scrap: false
       lock_comments: false
 
-      # Folder name to place this submission under, leave blank if it should not be in any.
-      folder_name: ""
+      # Create a new folder to place this submission under, leave blank if none should be created.
+      create_folder_name: ""
+
+      # Run this Ruby code after uploading
+      after_upload: |-
+        # Quick reference
+        #
+        # Available objects:
+        # - `client` (Furaffinity::Client)
+        #   The client object used to interact with FurAffinity.
+        # - `submission_info` (Hash)
+        #   The current submission information of this YAML file.  Keys are symbols.
+        #   To get the description use e.g. `submission_info[:description]`.
+        #   This also contains the ID of the uploaded submission, e.g.
+        #   `submission_info[:id]`.
+        # - `file_info` (Hash)
+        #   A hash of all YAML files.  Format is
+        #   `{ "filename.png" => { submission_info } }`.
+        #   Like `submission_info` it also contains the submission's ID as the `:id`
+        #   field if it's been uploaded.
+        #
+        # Helper functions:
+        # - `submission_url(submission_id)`
+        #   Generates a submission URL, e.g.
+        #   "https://www.furaffinity.net/view/54328944/"
+        # - `link_to(url_or_submission, text)`
+        #   Generates a link.  If the first parameter is a submission info hash it will
+        #   generate the URL using `submission_url(submission_info[:id])`.
+
+        # Remove this `return` if you want to run Ruby code
+        return
+
+        # Append a link to this submission to a previously uploaded one
+        previous_submission = file_info.fetch("previous_file.png")
+        previous_submission[:description] += ("\n\n" + link_to(submission_info, "Alt version 2"))
+        client.update(**previous_submission)
+
+        # Append a link to the previous submission to the current one
+        submission_info[:description] += ("\n\n" + link_to(previous_submission, "Alt version 1"))
+        client.update(**submission_info)
     YAML
 
     attr_reader :client, :queue_dir, :queue, :upload_status, :file_info
@@ -63,9 +100,10 @@ module Furaffinity
 
       @queue = YAML.safe_load_file(fa_info_path("queue.yml"), permitted_classes: [Symbol])
       @upload_status = YAML.safe_load_file(fa_info_path("status.yml"), permitted_classes: [Symbol])
-      @file_info = Dir[File.join(queue_dir, "**/*#{SUBMISSION_INFO_EXT}")].map do |path|
-        [path.delete_suffix(SUBMISSION_INFO_EXT).sub(/^#{Regexp.escape(queue_dir)}\/?/, ""), YAML.safe_load_file(path, permitted_classes: [Symbol]).transform_keys(&:to_sym)]
-      end.to_h
+      @file_info = Dir[File.join(queue_dir, "**/*#{SUBMISSION_INFO_EXT}")].to_h do |path|
+        [path.delete_suffix(SUBMISSION_INFO_EXT).sub(%r{^#{Regexp.escape(queue_dir)}/?}, ""),
+         YAML.safe_load_file(path, permitted_classes: [Symbol]).transform_keys(&:to_sym)]
+      end
 
       logger.trace "Loaded state info", queue:, file_info:
     end
@@ -109,7 +147,7 @@ module Furaffinity
         end
 
         submission_info_path = create_submission_info(file)
-        open_editor submission_info_path
+        CliUtils.open_editor submission_info_path
 
         queue << file
         upload_status[file] = {
@@ -140,7 +178,7 @@ module Furaffinity
     end
 
     def clean
-      uploaded_files.each do |file, _upload_info|
+      uploaded_files.each_key do |file|
         logger.trace { "Deleting #{file} ..." }
         queue.delete(file)
         upload_status.delete(file)
@@ -151,19 +189,23 @@ module Furaffinity
     end
 
     def reorder
-      open_editor fa_info_path("queue.yml")
+      CliUtils.open_editor fa_info_path("queue.yml")
     end
 
     def upload(wait_time = 60)
       raise ArgumentError.new("wait_time must be at least 30") if wait_time < 30
 
-      while file_name = queue.shift
+      hook_handler = QueueHook.new(client, file_info)
+
+      while (file_name = queue.shift)
         info = file_info[file_name]
         unless info
           logger.warn "no file info found for #{file_name}, ignoring"
           next
         end
 
+        code = file_info[file_name].delete(:after_upload)
+
         logger.info "Uploading #{info[:title].inspect} (#{file_name.inspect})"
         url = client.upload(
           File.new(file_name),
@@ -175,6 +217,11 @@ module Furaffinity
 
         save
 
+        if code
+          hook_handler.update_ids(upload_status)
+          hook_handler.run_hook(file_name, code)
+        end
+
         unless queue.empty?
           logger.info "Waiting #{wait_time} seconds until the next upload"
           sleep wait_time
@@ -210,19 +257,5 @@ module Furaffinity
 
       submission_info_path
     end
-
-    def open_editor(file)
-      editor = ENV["FA_EDITOR"] || ENV["VISUAL"] || ENV["EDITOR"]
-      unless editor
-        logger.warn "could not open editor for #{file.inspect}, set one of FA_EDITOR, VISUAL, or EDITOR in your ENV"
-        return
-      end
-
-      system(*Shellwords.shellwords(editor), file).tap do
-        next if $?.exitstatus == 0
-
-        logger.error "could not run #{editor} #{file}, exit code: #{$?.exitstatus}"
-      end
-    end
   end
 end

data/lib/furaffinity/queue_hook.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Furaffinity
+  class QueueHook
+    include SemanticLogger::Loggable
+
+    class HookRunner
+      include SemanticLogger::Loggable
+
+      attr_reader :client, :file_info, :submission_info
+
+      def initialize(client, file_info, file_name)
+        @client = client
+        @file_info = file_info
+        @submission_info = file_info.fetch(file_name)
+      end
+
+      def submission_url(submission_id) = "https://www.furaffinity.net/view/#{submission_id}/"
+
+      def link_to(url_or_submission, text)
+        url = case url_or_submission
+              in { id: }
+                submission_url(id)
+              else
+                if url_or_submission.is_a?(Hash)
+                  logger.warn do
+                    "passed hash does not have an ID, probably not uploaded yet?  hash keys: #{url_or_submission.keys.inspect}"
+                  end
+                end
+                url_or_submission.to_s
+              end
+
+        "[url=#{url}]#{text}[/url]"
+      end
+    end
+
+    attr_reader :client, :file_info
+
+    def initialize(client, file_info)
+      @client = client
+      @file_info = file_info.transform_values do |info|
+        # Hash#except duplicates the hash, which is good here as we don't want
+        # to modify the queue.
+        # exclude after_upload as it's not needed, and create_folder_name and
+        # type is only relevant when initially uploading the submission.
+        info.except(:create_folder_name, :after_upload, :type)
+      end
+    end
+
+    def update_ids(upload_status)
+      logger.trace { "Updating file info ids" }
+      upload_status.each do |file_name, status|
+        next unless status[:uploaded]
+
+        @file_info[file_name][:id] = status[:url].match(%{/view/(?<id>[^/]+)})[:id]
+      end
+    end
+
+    def run_hook(file_name, code)
+      logger.debug { "Running hook" }
+      logger.trace { "Hook code:\n#{code}" }
+      HookRunner
+        .new(client, file_info, file_name)
+        .instance_eval(code, File.join(Dir.pwd, "#{file_name}.info.yml"), 0)
+    end
+  end
+end

data/lib/furaffinity/version.rb

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

data/lib/furaffinity.rb

@@ -7,4 +7,7 @@ loader.setup
 
 module Furaffinity
   class Error < StandardError; end
+
+  # Raised when FurAffinity returned a system message where we did not expect one.
+  class RemoteError < Error; end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: furaffinity
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 26.1.0
 platform: ruby
 authors:
-- Georg Gadinger
-autorequire:
+- Jyrki Gadinger
 bindir: exe
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpx
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +37,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -113,17 +126,19 @@ files:
 - lib/furaffinity/cli.rb
 - lib/furaffinity/cli_base.rb
 - lib/furaffinity/cli_queue.rb
+- lib/furaffinity/cli_utils.rb
 - lib/furaffinity/client.rb
 - lib/furaffinity/config.rb
 - lib/furaffinity/queue.rb
+- lib/furaffinity/queue_hook.rb
 - lib/furaffinity/version.rb
-homepage: https://github.com/nilsding/furaffinity-cli
+homepage: https://codeberg.org/jyrki/furaffinity-cli
 licenses:
 - AGPLv3
 metadata:
-  homepage_uri: https://github.com/nilsding/furaffinity-cli
-  source_code_uri: https://github.com/nilsding/furaffinity-cli
-post_install_message:
+  homepage_uri: https://codeberg.org/jyrki/furaffinity-cli
+  source_code_uri: https://codeberg.org/jyrki/furaffinity-cli
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -131,15 +146,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 4.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: FurAffinity CLI tool
 test_files: []