furaffinity 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50e5e2ea8cd319bee7eb1665afe2888c7d763dd63ab1889ff861621d0871c96d
-  data.tar.gz: 984287cda209a247bda7499bda6b5509cb56ae9bdda37ae1e32b9e17b98b4ce5
+  metadata.gz: 486881425319cc8b49b196f58f5e4784462d39baa62aa27e985c91a0606c0f21
+  data.tar.gz: 81eef14d9b5b32e2874ae3d1e83e6811086cdc902b47b3e861f0e70d0a1f6810
 SHA512:
-  metadata.gz: 961c5c9f67fcc98522a3c09f51f83c299c4016d1987f29d18f8ba516f4d6b3b16f11213b70d76902f00b4174d213a423a94b854943d983bc69044678ffe0c031
-  data.tar.gz: 9f87aa43971869236f1f7b2d0ad02ba9bfa73a45cba39a103c84488cfbc51c60d6ea021a6dbcba2ccf6f399e2ec87608b4b4b4c16b65e9408d0276269ce785f2
+  metadata.gz: 1d4ea145d6886a771017f00189153022947575f5184d8328ec0252748b29d17802188ad307dc9abee02806ff7af2d4bc5552cfa94f5d9e6119ca87369d7c59d6
+  data.tar.gz: 8e91c5403692b846cf7078735af81a67f4e462d8e04e99d51d4268fa13d7778e70ecb22c2ef2690690bfc1f25c8186d27903d179ab48c29e652a60f88855caa8

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [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`

data/lib/furaffinity/cli.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "json"
+require "tempfile"
 require "thor"
+require "yaml"
 
 module Furaffinity
   class Cli < Thor
@@ -63,9 +65,9 @@ module Furaffinity
       type:    :string,
       desc:    "Keywords, separated by spaces.",
       default: ""
-    option :folder_name,
+    option :create_folder_name,
       type:    :string,
-      desc:    "Place this submission into this folder.",
+      desc:    "Create a new folder and place this submission into it.",
       default: ""
     def upload(file_path)
       set_log_level(options)
@@ -83,6 +85,55 @@ module Furaffinity
       say "Submission uploaded!  #{url}", :green
     end
 
+    EDIT_TEMPLATE = <<~YAML
+      ---
+      # 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 +173,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_utils.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "shellwords"
+
+module Furaffinity
+  module CliUtils
+    module_function
+
+    include SemanticLogger::Loggable
+
+    def open_editor(file, fatal: false)
+      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"
+        raise "No suitable editor found to edit #{file.inspect}, set one of FA_EDITOR, VISUAL, or EDITOR in your ENV" if fatal
+
+        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/client.rb

@@ -73,23 +73,18 @@ 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)
+    def fake_upload(file, title:, rating:, description:, keywords:, create_folder_name: "", lock_comments: false, scrap: false, type: :submission)
+      validate_args!(type:, rating:) => { type:, 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://..."
+      "https://www.furaffinity.net/view/54328944/?upload-successful"
     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
 
@@ -143,7 +138,7 @@ module Furaffinity
         message:  description,
         keywords: keywords,
 
-        create_folder_name: folder_name,
+        create_folder_name:,
 
         # finalize button :)
         finalize: "Finalize ",
@@ -164,8 +159,100 @@ module Furaffinity
       end
     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))
+
+      {}.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 gender].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 { _1.attr(:value) }
+      end
+    end
+
+    def fake_update(id:, title:, rating:, description:, keywords:, lock_comments: false, scrap: false)
+      validate_args!(rating:) => { rating: }
+
+      "https://www.furaffinity.net/view/54328944/"
+    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))
+      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 { _1.attr(:value) },
+      }.tap do |h|
+        %i[cat atype species gender].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,
+
+        **already_set_params,
+
+        # update button ;-)
+        submit: "Update",
+      }
+      params[:lock_comments] = "1" if lock_comments
+      params[:scrap] = "1" if scrap
+
+      logger.debug { "Updating submission #{id}..." }
+      update_response = post("/controls/submissions/changeinfo/#{id}/", form: params, client:)
+      if update_response.status == 302
+        redirect_location = update_response.headers[:location]
+        url = File.join(BASE_URL, redirect_location)
+        logger.info "Updated! #{url}"
+        return url
+      else
+        fa_error = parse_response(update_response).css(".redirect-message").text
+        raise Error.new("FA returned: #{fa_error}")
+      end
+    end
+
     private
 
+    def validate_args!(type: nil, rating:)
+      if type
+        type = type.to_sym
+        raise ArgumentError.new("#{type.inspect} is not in #{SUBMISSION_TYPES.inspect}") unless SUBMISSION_TYPES.include?(type)
+      end
+      rating = rating.to_sym
+      raise ArgumentError.new("#{rating.inspect} is not in #{RATING_MAP.keys.inspect}") unless RATING_MAP.include?(rating)
+
+      { type:, rating: }
+    end
+
     def parse_response(httpx_response)
       logger.measure_trace "Parsing response" do
         Nokogiri::HTML.parse(httpx_response)

data/lib/furaffinity/queue.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "fileutils"
-require "shellwords"
 require "yaml"
 
 module Furaffinity
@@ -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
@@ -109,7 +146,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] = {
@@ -151,12 +188,14 @@ 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
 
+      hook_handler = QueueHook.new(client, file_info)
+
       while file_name = queue.shift
         info = file_info[file_name]
         unless info
@@ -164,6 +203,8 @@ module Furaffinity
           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 +216,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 +256,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,65 @@
+# 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 { "passed hash does not have an ID, probably not uploaded yet?  hash keys: #{url_or_submission.keys.inspect}" }
+                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.each_with_object({}) do |(file_name, info), h|
+        # 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.
+        h[file_name] = 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 = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: furaffinity
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Georg Gadinger
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2023-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpx
@@ -113,9 +113,11 @@ 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
 licenses: