dcomm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: afe381b99e90819d8530a275dd4de7fdf3a3704f2f8d4732bdd86ac6c9610336
+  data.tar.gz: 248bbe289da6a683b4ff3ccbe336ef81b35ce5c866664cabe370c4f579d5f927
+SHA512:
+  metadata.gz: 642d3e6f7dddde8be673de3768df61b92ff7021edf87791c38b1e1afc2fd1b8b364305b9a765d1121ced5ca536bc40015c5952636797b0d512ab18f8904089b3
+  data.tar.gz: 9f1a031b657346e840b1580f41056bd6c577deeb35f0eb7591641a913cb4124cefc5b4318cc844e13acd2dc09b031ef462f5d70e8d4b593cca9c3b07cbb29930

data/exe/dcomm

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'dry/cli'
+require 'dcomm/cli'
+
+cli = Dry::CLI.new(DComm::CLI)
+
+begin
+  cli.call
+rescue => e # rubocop:disable Style/RescueStandardError
+  warn e.message
+  exit(1)
+end
+
+# ex: filetype=ruby

data/lib/dcomm/cli/apply.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    class Apply < Command
+      desc 'Bulk overwrite one or more global application commands'
+
+      argument :app_id, required: true, desc: 'Discord application ID'
+      argument(
+        :commands_file,
+        required: true,
+        desc: 'YAML file containing a collection of command objects',
+      )
+
+      def call(app_id:, commands_file:)
+        commands = YAML.safe_load_file(File.expand_path(commands_file))
+        response = discord.apply_global_app_cmds(app_id:, commands:)
+        renderer.call(response)
+      end
+    end
+  end
+end

data/lib/dcomm/cli/command.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'dry/cli/command'
+require 'dcomm/discord_api'
+require 'dcomm/renderer'
+
+module DComm
+  module CLI
+    class Command < Dry::CLI::Command
+      attr_reader :discord, :renderer
+
+      def initialize(discord: nil, renderer: nil) # rubocop:disable Lint/MissingSuper
+        require 'dcomm/config'
+
+        @discord = discord || DiscordAPI.new(
+          auth_header: "Bot #{DComm.config.discord_bot_token}",
+        )
+
+        @renderer = renderer || Renderer.new
+      end
+    end
+  end
+end

data/lib/dcomm/cli/create.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    class Create < Command
+      desc 'Create a global application command'
+
+      argument :app_id, required: true, desc: 'Discord application ID'
+      argument(
+        :command_file,
+        required: true,
+        desc: 'YAML file containing a single command object',
+      )
+
+      def call(app_id:, command_file:)
+        command = YAML.safe_load_file(File.expand_path(command_file))
+        response = discord.create_global_app_cmd(app_id:, command:)
+        renderer.call(response)
+      end
+    end
+  end
+end

data/lib/dcomm/cli/delete.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    class Delete < Command
+      desc 'Delete a global application command'
+
+      argument :app_id, required: true, desc: 'Discord application ID'
+      argument :command_id, required: true, desc: 'Discord application command ID'
+
+      def call(app_id:, command_id:)
+        response = discord.delete_global_app_cmd(app_id:, command_id:)
+        renderer.call(response)
+      end
+    end
+  end
+end

data/lib/dcomm/cli/edit.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    class Edit < Command
+      desc 'Edit a global application command'
+
+      def call
+        puts 'edit command'
+      end
+    end
+  end
+end

data/lib/dcomm/cli/guild/apply.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    module Guild
+      class Apply < Command
+        desc 'Bulk overwrite one or more guild application commands'
+
+        argument :app_id, required: true, desc: 'Discord application ID'
+        argument :guild_id, required: true, desc: 'Discord guild ID'
+        argument(
+          :commands_file,
+          required: true,
+          desc: 'YAML file containing a collection of command objects',
+        )
+
+        def call(app_id:, guild_id:, commands_file:)
+          commands = YAML.safe_load_file(File.expand_path(commands_file))
+          response = discord.apply_guild_app_cmds(app_id:, guild_id:, commands:)
+          renderer.call(response)
+        end
+      end
+    end
+  end
+end

data/lib/dcomm/cli/guild/create.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    module Guild
+      class Create < Command
+        desc 'Create a guild application command'
+
+        argument :app_id, required: true, desc: 'Discord application ID'
+        argument :guild_id, required: true, desc: 'Discord guild ID'
+        argument(
+          :command_file,
+          required: true,
+          desc: 'YAML file containing a single command object',
+        )
+
+        def call(app_id:, guild_id:, command_file:)
+          command = YAML.safe_load_file(File.expand_path(command_file))
+          response = discord.create_guild_app_cmd(app_id:, guild_id:, command:)
+          renderer.call(response)
+        end
+      end
+    end
+  end
+end

data/lib/dcomm/cli/guild/delete.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    module Guild
+      class Delete < Command
+        desc 'Delete a guild application command'
+
+        argument :app_id, required: true, desc: 'Discord application ID'
+        argument :guild_id, required: true, desc: 'Discord guild ID'
+        argument :command_id, required: true, desc: 'Discord application command ID'
+
+        def call(app_id:, guild_id:, command_id:)
+          response = discord.delete_guild_app_cmd(app_id:, guild_id:, command_id:)
+          renderer.call(response)
+        end
+      end
+    end
+  end
+end

data/lib/dcomm/cli/guild/edit.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    module Guild
+      class Edit < Command
+        desc 'Edit a guild application command'
+
+        def call
+          puts 'guild edit command'
+        end
+      end
+    end
+  end
+end

data/lib/dcomm/cli/guild/list.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    module Guild
+      class List < Command
+        desc 'List guild application commands'
+
+        argument :app_id, required: true, desc: 'Discord application ID'
+        argument :guild_id, required: true, desc: 'Discord guild ID'
+
+        def call(app_id:, guild_id:)
+          response = discord.list_guild_app_cmds(app_id:, guild_id:)
+          renderer.call(response)
+        end
+      end
+    end
+  end
+end

data/lib/dcomm/cli/guild/show.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    module Guild
+      class Show < Command
+        desc 'View details of a guild application command'
+
+        argument :app_id, required: true, desc: 'Discord application ID'
+        argument :guild_id, required: true, desc: 'Discord guild ID'
+        argument :command_id, required: true, desc: 'Discord application command ID'
+
+        def call(app_id:, guild_id:, command_id:)
+          response = discord.show_guild_app_cmd(app_id:, guild_id:, command_id:)
+          renderer.call(response)
+        end
+      end
+    end
+  end
+end

data/lib/dcomm/cli/guild/update.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    module Guild
+      class Update < Command
+        desc 'Update a guild application command'
+
+        argument :app_id, required: true, desc: 'Discord application ID'
+        argument :guild_id, required: true, desc: 'Discord guild ID'
+        argument :command_id, required: true, desc: 'Discord application command ID'
+        argument(
+          :command_file,
+          required: true,
+          desc: 'YAML file containing a single command object',
+        )
+
+        def call(app_id:, guild_id:, command_id:, command_file:)
+          command = YAML.safe_load_file(File.expand_path(command_file))
+          response = discord.edit_guild_app_cmd(
+            app_id:,
+            guild_id:,
+            command_id:,
+            command:,
+          )
+          renderer.call(response)
+        end
+      end
+    end
+  end
+end

data/lib/dcomm/cli/list.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    class List < Command
+      desc 'List global application commands'
+
+      argument :app_id, required: true, desc: 'Discord application ID'
+
+      def call(app_id:)
+        response = discord.list_global_app_cmds(app_id:)
+        renderer.call(response)
+      end
+    end
+  end
+end

data/lib/dcomm/cli/show.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    class Show < Command
+      desc 'View details of a global application command'
+
+      argument :app_id, required: true, desc: 'Discord application ID'
+      argument :command_id, required: true, desc: 'Discord application command ID'
+
+      def call(app_id:, command_id:)
+        response = discord.show_global_app_cmd(app_id:, command_id:)
+        renderer.call(response)
+      end
+    end
+  end
+end

data/lib/dcomm/cli/update.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'dcomm/cli/command'
+
+module DComm
+  module CLI
+    class Update < Command
+      desc 'Update a global application command'
+
+      argument :app_id, required: true, desc: 'Discord application ID'
+      argument :command_id, required: true, desc: 'Discord application command ID'
+      argument(
+        :command_file,
+        required: true,
+        desc: 'YAML file containing a single command object',
+      )
+
+      def call(app_id:, command_id:, command_file:)
+        command = YAML.safe_load_file(File.expand_path(command_file))
+        response = discord.edit_global_app_cmd(app_id:, command_id:, command:)
+        renderer.call(response)
+      end
+    end
+  end
+end

data/lib/dcomm/cli/version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'dry/cli/command'
+
+module DComm
+  module CLI
+    class Version < Dry::CLI::Command
+      desc 'DComm version info'
+
+      def call
+        puts "DComm version #{DComm.version}"
+      end
+    end
+  end
+end

data/lib/dcomm/cli.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+require 'dcomm/cli/apply'
+require 'dcomm/cli/create'
+require 'dcomm/cli/delete'
+require 'dcomm/cli/edit'
+require 'dcomm/cli/list'
+require 'dcomm/cli/show'
+require 'dcomm/cli/update'
+require 'dcomm/cli/version'
+require 'dcomm/cli/guild/apply'
+require 'dcomm/cli/guild/create'
+require 'dcomm/cli/guild/delete'
+require 'dcomm/cli/guild/edit'
+require 'dcomm/cli/guild/list'
+require 'dcomm/cli/guild/show'
+require 'dcomm/cli/guild/update'
+
+module DComm
+  module CLI
+    extend Dry::CLI::Registry
+
+    register('apply', Apply, aliases: %w[bulk-overwrite])
+    register('create', Create)
+    register('delete', Delete, aliases: %w[remove rm])
+
+    # TODO: this is a fancier command where we open the command in $EDITOR for
+    # the user to make changes, and then the update is submitted upon quitting.
+    #
+    # register('edit', Edit)
+
+    register('list', List, aliases: %w[ls])
+    register('show', Show, aliases: %w[info describe])
+    register('update', Update)
+    register('version', Version, aliases: %w[--version])
+
+    register('guild') do |prefix|
+      prefix.register('apply', Guild::Apply, aliases: %w[bulk-overwrite])
+      prefix.register('create', Guild::Create)
+      prefix.register('delete', Guild::Delete, aliases: %w[remove rm])
+
+      # TODO: this is a fancier command where we open the command in $EDITOR for
+      # the user to make changes, and then the update is submitted upon quitting.
+      #
+      # prefix.register('edit', Guild::Edit)
+
+      prefix.register('list', Guild::List, aliases: %w[ls])
+      prefix.register('show', Guild::Show, aliases: %w[info describe])
+      prefix.register('update', Guild::Update)
+    end
+  end
+end

data/lib/dcomm/config.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'dry/configurable'
+
+module DComm
+  extend Dry::Configurable
+
+  CONFIG_HOME = ENV.fetch(
+    'XDG_CONFIG_HOME',
+    File.expand_path(File.join(Dir.home, '.config')),
+  ).freeze
+
+  setting :discord_bot_token
+
+  configure do |config|
+    if (token = ENV.fetch('DISCORD_BOT_TOKEN', nil))
+      config.discord_bot_token = token
+      break
+    end
+
+    path = File.join(CONFIG_HOME, 'dcomm', 'config.yml')
+    raise "Error: config file #{path} does not exist" unless File.exist?(path)
+
+    yaml = YAML.safe_load_file(path) || {}
+    unless yaml.fetch('discord_bot_token', nil)
+      raise "Error: config file does not define 'discord_bot_token' field"
+    end
+
+    config.discord_bot_token = yaml['discord_bot_token']
+  end
+end

data/lib/dcomm/discord_api.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+# NOTE: this will probably be its own library eventually, but for now a class
+# works just fine.
+
+require 'http'
+require 'json'
+
+module DComm
+  class DiscordAPI
+    attr_reader :auth_header, :base_uri
+
+    def initialize(auth_header:, base_uri: 'https://discord.com/api/v10')
+      @auth_header = auth_header
+      @base_uri = base_uri
+    end
+
+    def apply_global_app_cmds(app_id:, commands:)
+      put("/applications/#{app_id}/commands", body: commands)
+    end
+
+    def apply_guild_app_cmds(app_id:, guild_id:, commands:)
+      put("/applications/#{app_id}/guilds/#{guild_id}/commands", body: commands)
+    end
+
+    def create_global_app_cmd(app_id:, command:)
+      post("/applications/#{app_id}/commands", body: command)
+    end
+
+    def create_guild_app_cmd(app_id:, guild_id:, command:)
+      post("/applications/#{app_id}/guilds/#{guild_id}/commands", body: command)
+    end
+
+    def delete_global_app_cmd(app_id:, command_id:)
+      delete("/applications/#{app_id}/commands/#{command_id}")
+    end
+
+    def delete_guild_app_cmd(app_id:, guild_id:, command_id:)
+      delete("/applications/#{app_id}/guilds/#{guild_id}/commands/#{command_id}")
+    end
+
+    def list_global_app_cmds(app_id:)
+      get("/applications/#{app_id}/commands")
+    end
+
+    def list_guild_app_cmds(app_id:, guild_id:)
+      get("/applications/#{app_id}/guilds/#{guild_id}/commands")
+    end
+
+    def show_global_app_cmd(app_id:, command_id:)
+      get("/applications/#{app_id}/commands/#{command_id}")
+    end
+
+    def show_guild_app_cmd(app_id:, guild_id:, command_id:)
+      get("/applications/#{app_id}/guilds/#{guild_id}/commands/#{command_id}")
+    end
+
+    def edit_global_app_cmd(app_id:, command_id:, command:)
+      patch("/applications/#{app_id}/commands/#{command_id}", body: command)
+    end
+
+    def edit_guild_app_cmd(app_id:, guild_id:, command_id:, command:)
+      patch(
+        "/applications/#{app_id}/guilds/#{guild_id}/commands/#{command_id}",
+        body: command,
+      )
+    end
+
+    private
+
+    def client
+      HTTP.auth(auth_header).headers(content_type: 'application/json')
+    end
+
+    def request_uri(path)
+      req = base_uri
+      req += '/' unless path.start_with?('/')
+      req += path
+
+      req
+    end
+
+    def get(path)
+      reqstr = request_uri(path)
+      client.get(reqstr).parse
+    end
+
+    # discord responds to application command deletes with `204 No Content`,
+    # meaning there is no body to `#parse` upon return.
+    #
+    # TODO: devise a more elegant solution
+    #
+    # ref:
+    #   - https://discord.com/developers/docs/interactions/application-commands#delete-global-application-command
+    #   - https://discord.com/developers/docs/interactions/application-commands#delete-guild-application-command
+    def delete(path)
+      reqstr = request_uri(path)
+      response = client.delete(reqstr)
+
+      return { 'message' => 'success' } if response.status.success?
+
+      raise 'something went wrong', response
+    end
+
+    def post(path, body:)
+      reqstr = request_uri(path)
+      client.post(reqstr, body: body.to_json).parse
+    end
+
+    def put(path, body:)
+      reqstr = request_uri(path)
+      client.put(reqstr, body: body.to_json).parse
+    end
+
+    def patch(path, body:)
+      reqstr = request_uri(path)
+      client.patch(reqstr, body: body.to_json).parse
+    end
+  end
+end

data/lib/dcomm/renderer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module DComm
+  class Renderer
+    def call(obj)
+      puts obj.to_yaml
+    end
+  end
+end

data/lib/dcomm/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DComm
+  def self.version
+    @version ||= Gem::Version.new('0.1.0')
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: dcomm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Price
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  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: dry-configurable
+  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: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description:
+email:
+- komidore64@gmail.com
+executables:
+- dcomm
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/dcomm
+- lib/dcomm/cli.rb
+- lib/dcomm/cli/apply.rb
+- lib/dcomm/cli/command.rb
+- lib/dcomm/cli/create.rb
+- lib/dcomm/cli/delete.rb
+- lib/dcomm/cli/edit.rb
+- lib/dcomm/cli/guild/apply.rb
+- lib/dcomm/cli/guild/create.rb
+- lib/dcomm/cli/guild/delete.rb
+- lib/dcomm/cli/guild/edit.rb
+- lib/dcomm/cli/guild/list.rb
+- lib/dcomm/cli/guild/show.rb
+- lib/dcomm/cli/guild/update.rb
+- lib/dcomm/cli/list.rb
+- lib/dcomm/cli/show.rb
+- lib/dcomm/cli/update.rb
+- lib/dcomm/cli/version.rb
+- lib/dcomm/config.rb
+- lib/dcomm/discord_api.rb
+- lib/dcomm/renderer.rb
+- lib/dcomm/version.rb
+homepage:
+licenses:
+- AGPL-3.0-only
+metadata:
+  rubygems_mfa_required: 'true'
+  bug_tracker_uri: https://todo.sr.ht/~komidore64/dcomm
+  homepage_uri: https://sr.ht/~komidore64/dlobby.site
+  mailing_list_uri: https://lists.sr.ht/~komidore64/public-inbox
+  source_code_uri: https://git.sr.ht/~komidore64/dcomm
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: Manage your Discord application commands from the command line.
+test_files: []