discourse_cli_tool 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 688cddf126e1f109caa8824d80fc514566742cff6a5d1a535ccb7a27d8c0bae6
+  data.tar.gz: 37e886fb922d7481d80dfe8370419c03f6f45d4a6a6f0eee1086a01c151b7614
+SHA512:
+  metadata.gz: b1f8f285a6d0138b95c991713cca48e47f61a42afb633a6e5fc3d9720674a43d78d61deb3308b9511203f5a458dc5cececffada7d5d9162ef811583da32a9177
+  data.tar.gz: bd8734e7f6f47197a8a65b7faa2b47d23dd3bbf6d3b7113702a0e3b1c405f8475968215aa76bee4098449457413c925895a803cd10a9d718ad5e3a2fc303c264

data/exe/dsc

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "discourse_cli"
+DiscourseCli::CLI.start(ARGV)

data/lib/discourse_cli/cli.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module DiscourseCli
+  class CLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    register(Commands::Config,     "config",     "config <command>",     "Manage site configuration")
+    register(Commands::Categories, "categories", "categories <command>", "Manage categories")
+    register(Commands::Topics,     "topics",     "topics <command>",     "Manage topics")
+    register(Commands::Posts,      "posts",      "posts <command>",      "Manage posts")
+  end
+end

data/lib/discourse_cli/client_factory.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "discourse_api"
+
+module DiscourseCli
+  class ClientFactory
+    def self.build(config)
+      missing = []
+      missing << "host" unless config.host
+      missing << "api_key" unless config.api_key
+      missing << "api_username" unless config.api_username
+
+      if missing.any?
+        raise "Missing required config: #{missing.join(", ")}. " \
+              "Run `dsc config set` or set #{missing.map { |k| "DISCOURSE_#{k.upcase}" }.join(", ")}."
+      end
+
+      DiscourseApi::Client.new(config.host, config.api_key, config.api_username)
+    end
+  end
+end

data/lib/discourse_cli/commands/base.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module DiscourseCli
+  module Commands
+    class Base < Thor
+      class_option :site, type: :string, desc: "Named site from config file"
+      class_option :host, type: :string, desc: "Discourse host URL"
+      class_option :"api-key", type: :string, desc: "API key"
+      class_option :"api-username", type: :string, desc: "API username"
+      class_option :json, type: :boolean, default: false, desc: "Output JSON"
+      class_option :quiet, type: :boolean, default: false, desc: "Suppress output, exit code only"
+
+      def self.exit_on_failure?
+        true
+      end
+
+      private
+
+      def client
+        @client ||= ClientFactory.build(config)
+      end
+
+      def config
+        @config ||= DiscourseCli::Config.new(
+          site: options[:site],
+          host: options[:host],
+          api_key: options[:"api-key"],
+          api_username: options[:"api-username"],
+        )
+      end
+
+      def formatter
+        @formatter ||= Formatter.new(json: options[:json], quiet: options[:quiet])
+      end
+
+      def resolve_raw(given_raw)
+        return given_raw if given_raw
+        return $stdin.read unless $stdin.tty?
+        Editor.new.open
+      end
+
+      def handle_error(error)
+        message =
+          case error
+          when DiscourseApi::UnauthenticatedError
+            "Authentication failed — check your api_key and api_username"
+          when DiscourseApi::NotFoundError
+            "Not found"
+          when DiscourseApi::UnprocessableEntity
+            errors = error.response&.dig(:body, "errors")
+            errors ? Array(errors).join("\n") : error.message
+          when DiscourseApi::TooManyRequests
+            "Rate limited — try again shortly"
+          when DiscourseApi::Timeout
+            "Request timed out"
+          else
+            error.message
+          end
+        $stderr.puts message
+        exit 1
+      end
+    end
+  end
+end

data/lib/discourse_cli/commands/categories.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module DiscourseCli
+  module Commands
+    class Categories < Base
+      desc "list", "List all categories"
+      def list
+        formatter.print_list(client.categories)
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+
+      desc "show ID", "Show a category"
+      def show(id)
+        formatter.print_item(client.category(id.to_i))
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+
+      desc "create", "Create a category"
+      option :name,         type: :string, required: true
+      option :color,        type: :string
+      option :"text-color", type: :string
+      option :description,  type: :string
+      def create
+        params = { name: options[:name] }
+        params[:color]       = options[:color]          if options[:color]
+        params[:text_color]  = options[:"text-color"]   if options[:"text-color"]
+        params[:description] = options[:description]    if options[:description]
+        formatter.print_item(client.create_category(params))
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+
+      desc "update ID", "Update a category"
+      option :name,         type: :string, required: true
+      option :color,        type: :string
+      option :"text-color", type: :string
+      option :description,  type: :string
+      def update(id)
+        params = { id: id.to_i, name: options[:name] }
+        params[:color]       = options[:color]          if options[:color]
+        params[:text_color]  = options[:"text-color"]   if options[:"text-color"]
+        params[:description] = options[:description]    if options[:description]
+        result = client.update_category(params)
+        formatter.print_item(result) if result
+        formatter.print_success("Updated category #{id}")
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+
+      desc "delete ID", "Delete a category"
+      def delete(id)
+        client.delete_category(id.to_i)
+        formatter.print_success("Deleted category #{id}")
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+    end
+  end
+end

data/lib/discourse_cli/commands/config.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "yaml"
+
+module DiscourseCli
+  module Commands
+    class Config < Base
+      def self.config_path
+        DiscourseCli::Config.config_path
+      end
+
+      desc "set", "Save connection details for a named site"
+      option :site,           type: :string, required: true, desc: "Site name"
+      option :host,           type: :string, required: true, desc: "Discourse host URL"
+      option :"api-key",      type: :string, required: true, desc: "API key"
+      option :"api-username", type: :string, required: true, desc: "API username"
+      def set
+        data = load_file
+        data["sites"] ||= {}
+        data["default"] ||= options[:site]
+        data["sites"][options[:site]] = {
+          "host"         => options[:host],
+          "api_key"      => options[:"api-key"],
+          "api_username" => options[:"api-username"],
+        }
+        FileUtils.mkdir_p(File.dirname(self.class.config_path))
+        File.write(self.class.config_path, YAML.dump(data))
+        formatter.print_success("Saved config for site '#{options[:site]}'")
+      end
+
+      desc "list", "List configured sites"
+      def list
+        data = load_file
+        sites = data["sites"] || {}
+        default_site = data["default"]
+        if sites.empty?
+          puts "No sites configured. Run `dsc config set` to add one."
+          return
+        end
+        sites.each do |name, cfg|
+          marker = name == default_site ? " (default)" : ""
+          puts "#{name}#{marker}"
+          puts "  host:         #{cfg["host"]}"
+          puts "  api_username: #{cfg["api_username"]}"
+          puts
+        end
+      end
+
+      private
+
+      def load_file
+        path = self.class.config_path
+        File.exist?(path) ? YAML.safe_load(File.read(path)) || {} : {}
+      end
+    end
+  end
+end

data/lib/discourse_cli/commands/posts.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module DiscourseCli
+  module Commands
+    class Posts < Base
+      desc "list", "List recent posts"
+      def list
+        response = client.posts
+        items = response["latest_posts"] || []
+        formatter.print_list(items)
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+
+      desc "show ID", "Show a post"
+      def show(id)
+        formatter.print_item(client.get_post(id.to_i))
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+
+      desc "create", "Create a post (opens $EDITOR if --raw not given)"
+      option :"topic-id", type: :numeric, required: true
+      option :raw, type: :string
+      def create
+        raw = resolve_raw(options[:raw])
+        result = client.create_post(topic_id: options[:"topic-id"], raw: raw)
+        formatter.print_item(result)
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+
+      desc "update ID", "Update a post (opens $EDITOR if --raw not given)"
+      option :raw, type: :string
+      def update(id)
+        raw = resolve_raw(options[:raw])
+        client.edit_post(id.to_i, raw)
+        formatter.print_success("Updated post #{id}")
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+
+      desc "delete ID", "Delete a post"
+      def delete(id)
+        client.delete_post(id.to_i)
+        formatter.print_success("Deleted post #{id}")
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+    end
+  end
+end

data/lib/discourse_cli/commands/topics.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module DiscourseCli
+  module Commands
+    class Topics < Base
+      desc "list", "List latest topics"
+      option :category, type: :string, desc: "Filter by category slug"
+      def list
+        params = {}
+        params[:category] = options[:category] if options[:category]
+        formatter.print_list(client.latest_topics(params))
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+
+      desc "show ID", "Show a topic"
+      def show(id)
+        formatter.print_item(client.topic(id.to_i))
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+
+      desc "create", "Create a topic (opens $EDITOR if --raw not given)"
+      option :title,    type: :string, required: true
+      option :category, type: :string
+      option :tags,     type: :string, desc: "Comma-separated tags"
+      option :raw,      type: :string
+      def create
+        raw = resolve_raw(options[:raw])
+        params = { title: options[:title], raw: raw }
+        params[:category] = options[:category]                      if options[:category]
+        params[:tags]     = options[:tags].split(",").map(&:strip)  if options[:tags]
+        formatter.print_item(client.create_topic(params))
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+
+      desc "update ID", "Update a topic"
+      option :title,    type: :string
+      option :category, type: :string, desc: "Category slug or name"
+      option :raw,      type: :string, desc: "Replace first post content (opens $EDITOR if not given and no other options)"
+      def update(id)
+        updated_anything = false
+
+        if options[:title]
+          client.rename_topic(id.to_i, options[:title])
+          updated_anything = true
+        end
+
+        if options[:category]
+          cats = client.categories
+          cat = cats.find { |c| c["slug"] == options[:category] || c["name"] == options[:category] }
+          unless cat
+            $stderr.puts "Category not found: #{options[:category]}"
+            exit 1
+          end
+          client.recategorize_topic(id.to_i, cat["id"])
+          updated_anything = true
+        end
+
+        raw =
+          if options[:raw]
+            options[:raw]
+          elsif !updated_anything && !$stdin.tty?
+            $stdin.read
+          elsif !updated_anything
+            Editor.new.open
+          end
+
+        if raw
+          topic_data = client.topic(id.to_i)
+          first_post_id = topic_data["post_stream"]["posts"][0]["id"]
+          client.edit_post(first_post_id, raw)
+        end
+
+        formatter.print_success("Updated topic #{id}")
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+
+      desc "delete ID", "Delete a topic"
+      def delete(id)
+        client.delete_topic(id.to_i)
+        formatter.print_success("Deleted topic #{id}")
+      rescue DiscourseApi::DiscourseError => e
+        handle_error(e)
+      end
+    end
+  end
+end

data/lib/discourse_cli/config.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module DiscourseCli
+  class Config
+    def self.config_path
+      File.expand_path("~/.config/dsc/config.yml")
+    end
+
+    def initialize(overrides = {})
+      @overrides = overrides
+      @config_path_snapshot = self.class.config_path
+    end
+
+    def host
+      @overrides[:host] || ENV["DISCOURSE_HOST"] || site_config["host"]
+    end
+
+    def api_key
+      @overrides[:api_key] || ENV["DISCOURSE_API_KEY"] || site_config["api_key"]
+    end
+
+    def api_username
+      @overrides[:api_username] || ENV["DISCOURSE_API_USERNAME"] || site_config["api_username"]
+    end
+
+    def sites
+      file_config["sites"] || {}
+    end
+
+    def default_site
+      file_config["default"]
+    end
+
+    private
+
+    def site_name
+      @overrides[:site] || ENV["DISCOURSE_SITE"] || file_config["default"]
+    end
+
+    def site_config
+      return {} unless site_name
+      (file_config["sites"] || {})[site_name] || {}
+    end
+
+    def file_config
+      @file_config ||=
+        if File.exist?(@config_path_snapshot)
+          YAML.safe_load(File.read(@config_path_snapshot)) || {}
+        else
+          {}
+        end
+    end
+  end
+end

data/lib/discourse_cli/editor.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "tempfile"
+require "shellwords"
+
+module DiscourseCli
+  class Editor
+    def initialize(spawn: nil)
+      @spawn = spawn || method(:default_spawn)
+    end
+
+    def open(initial_content = "")
+      Tempfile.create(["dsc", ".md"]) do |f|
+        f.write(initial_content)
+        f.flush
+        @spawn.call(f.path)
+        f.rewind
+        f.read
+      end
+    end
+
+    private
+
+    def default_spawn(path)
+      editor = ENV.fetch("EDITOR", "vi")
+      system("#{editor} #{Shellwords.escape(path)}")
+    end
+  end
+end

data/lib/discourse_cli/formatter.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "json"
+
+module DiscourseCli
+  class Formatter
+    def initialize(output: $stdout, json: false, quiet: false)
+      @output = output
+      @json = json
+      @quiet = quiet
+    end
+
+    def print_list(items)
+      return if @quiet
+      if @json
+        @output.puts JSON.pretty_generate(items)
+      else
+        items.each { |item| @output.puts format_row(item) }
+      end
+    end
+
+    def print_item(item)
+      return if @quiet
+      if @json
+        @output.puts JSON.pretty_generate(item)
+      else
+        item.each { |k, v| @output.puts "#{k}: #{v}" }
+      end
+    end
+
+    def print_success(message)
+      return if @quiet || @json
+      @output.puts message
+    end
+
+    private
+
+    def format_row(item)
+      id = item["id"] || item[:id]
+      label = item["title"] || item["name"] || item["slug"] || item.values.compact.first
+      "#{id}\t#{label}"
+    end
+  end
+end

data/lib/discourse_cli/version.rb

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

data/lib/discourse_cli.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "discourse_cli/version"
+require_relative "discourse_cli/config"
+require_relative "discourse_cli/client_factory"
+require_relative "discourse_cli/editor"
+require_relative "discourse_cli/formatter"
+require_relative "discourse_cli/commands/base"
+require_relative "discourse_cli/commands/config"
+require_relative "discourse_cli/commands/categories"
+require_relative "discourse_cli/commands/topics"
+require_relative "discourse_cli/commands/posts"
+require_relative "discourse_cli/cli"

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: discourse_cli_tool
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Case
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  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: discourse_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+email:
+- tim@2drops.net
+executables:
+- dsc
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/dsc
+- lib/discourse_cli.rb
+- lib/discourse_cli/cli.rb
+- lib/discourse_cli/client_factory.rb
+- lib/discourse_cli/commands/base.rb
+- lib/discourse_cli/commands/categories.rb
+- lib/discourse_cli/commands/config.rb
+- lib/discourse_cli/commands/posts.rb
+- lib/discourse_cli/commands/topics.rb
+- lib/discourse_cli/config.rb
+- lib/discourse_cli/editor.rb
+- lib/discourse_cli/formatter.rb
+- lib/discourse_cli/version.rb
+homepage: https://github.com/timcase/discourse-cli-tool
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: CLI tool for managing Discourse forums from the command line
+test_files: []