furaffinity 0.1.0

data/lib/furaffinity/queue.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "shellwords"
+require "yaml"
+
+module Furaffinity
+  class Queue
+    include SemanticLogger::Loggable
+
+    FA_QUEUE_DIR = ".fa"
+
+    SUBMISSION_INFO_EXT = ".info.yml"
+
+    SUBMISSION_TEMPLATE = <<~YAML
+      ---
+      # Submission info for %<file_name>s
+
+      # Required field
+      title: ""
+
+      # Required field
+      description: |-
+        Your description goes here
+
+      # Optional field, keywords separated by spaces
+      keywords: ""
+
+      # Required field, one of: [#{Furaffinity::Client::RATING_MAP.keys.join(", ")}]
+      rating: general
+
+      # Required field, one of: [#{Furaffinity::Client::SUBMISSION_TYPES.join(", ")}]
+      type: submission
+
+      scrap: false
+      lock_comments: false
+
+      # Folder name to place this submission under, leave blank if it should not be in any.
+      folder_name: ""
+    YAML
+
+    attr_reader :client, :queue_dir, :queue, :upload_status, :file_info
+
+    # @param client [Furaffinity::Client]
+    # @param queue_dir [String]
+    def initialize(client, queue_dir)
+      @client = client
+      @queue_dir = queue_dir
+      @queue = []
+      @upload_status = {}
+      @file_info = {}
+    end
+
+    def fa_info_dir = File.join(queue_dir, FA_QUEUE_DIR)
+
+    def fa_info_path(*path) = File.join(fa_info_dir, *path)
+
+    def submission_template_path = fa_info_path("templates", "submission.yml")
+
+    # loads state info from queue dir
+    def reload
+      logger.trace { "Loading state info" }
+
+      @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
+
+      logger.trace "Loaded state info", queue:, file_info:
+    end
+
+    def init
+      if Dir.exist?(queue_dir)
+        logger.trace { "Checking if directory #{queue_dir.inspect} is empty" }
+        raise Error.new("#{queue_dir.inspect} is not empty") unless Dir.empty?(queue_dir)
+      end
+
+      logger.trace { "Creating directory #{fa_info_dir.inspect}" }
+      FileUtils.mkdir_p(fa_info_dir)
+
+      %w[templates].each do |dir|
+        logger.trace { "Creating directory #{fa_info_path(dir).inspect}" }
+        FileUtils.mkdir_p(fa_info_path(dir))
+      end
+
+      logger.trace { "Creating empty state files" }
+      save
+
+      logger.trace { "Creating submission template" }
+      File.open(submission_template_path, "w") do |f|
+        f.puts(SUBMISSION_TEMPLATE)
+      end
+
+      logger.debug "Created new queue dir in #{queue_dir.inspect}"
+      queue_dir
+    end
+
+    def add(*files)
+      files.select do |file|
+        unless File.exist?(file)
+          logger.warn "File #{file.inspect} does not exist"
+          next false
+        end
+
+        if queue.include?(file)
+          logger.warn "File #{file.inspect} is already in the queue"
+          next false
+        end
+
+        submission_info_path = create_submission_info(file)
+        open_editor submission_info_path
+
+        queue << file
+        upload_status[file] = {
+          uploaded: false,
+          url:      nil,
+        }
+
+        save
+
+        true
+      end
+    end
+
+    def remove(*files)
+      files.select do |file|
+        unless queue.include?(file)
+          logger.warn "File #{file.inspect} is not in the queue"
+          next false
+        end
+
+        queue.delete(file)
+        upload_status.delete(file)
+
+        save
+
+        true
+      end
+    end
+
+    def clean
+      uploaded_files.each do |file, _upload_info|
+        logger.trace { "Deleting #{file} ..." }
+        queue.delete(file)
+        upload_status.delete(file)
+        File.unlink(file)
+        File.unlink(file + SUBMISSION_INFO_EXT)
+        save
+      end
+    end
+
+    def reorder
+      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
+        info = file_info[file_name]
+        unless info
+          logger.warn "no file info found for #{file_name}, ignoring"
+          next
+        end
+
+        logger.info "Uploading #{info[:title].inspect} (#{file_name.inspect})"
+        url = client.upload(
+          File.new(file_name),
+          **file_info[file_name]
+        )
+
+        upload_status[file_name][:uploaded] = true
+        upload_status[file_name][:url] = url
+
+        save
+
+        unless queue.empty?
+          logger.info "Waiting #{wait_time} seconds until the next upload"
+          sleep wait_time
+        end
+      end
+    end
+
+    def uploaded_files
+      upload_status.select { _2[:uploaded] }
+    end
+
+    def save
+      { queue:, status: upload_status }.each do |type, content|
+        path = fa_info_path("#{type}.yml")
+        logger.trace { "Writing #{path}" }
+        yaml_content = content.to_yaml
+        File.open(path, "w") do |f|
+          f.puts(yaml_content)
+        end
+      end
+    end
+
+    def create_submission_info(file)
+      template = File.read(submission_template_path)
+
+      submission_info_path = "#{file}#{SUBMISSION_INFO_EXT}"
+      return submission_info_path if File.exist?(submission_info_path)
+
+      rendered_template = format(template, file_name: file.inspect)
+      File.open(submission_info_path, "w") do |f|
+        f.puts rendered_template
+      end
+
+      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/version.rb

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

data/lib/furaffinity.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "semantic_logger"
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module Furaffinity
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: furaffinity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Georg Gadinger
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: semantic_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.14'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: A command line tool to interface with FurAffinity
+email:
+- nilsding@nilsding.org
+executables:
+- fa
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- exe/fa
+- lib/furaffinity.rb
+- lib/furaffinity/cli.rb
+- lib/furaffinity/cli_base.rb
+- lib/furaffinity/cli_queue.rb
+- lib/furaffinity/client.rb
+- lib/furaffinity/config.rb
+- lib/furaffinity/queue.rb
+- lib/furaffinity/version.rb
+homepage: https://github.com/nilsding/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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: FurAffinity CLI tool
+test_files: []