rancour 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42e2f9a65f4402abdd0fa79fa006e76462727a8028c38bc5205feed56204dd55
-  data.tar.gz: 11e03d5d55df794755e9ab12178214aa989927506218ffde8e00d90bcd62cc39
+  metadata.gz: fc3119655a33ebf4adf688f896205fdbffd29f887cb436321b3686a34aa65e7d
+  data.tar.gz: 3640c3ce83ca27e102bde39dd74e2faee510c14532f15ac4af2b562d043cfcba
 SHA512:
-  metadata.gz: a4cc23578a18ecb841a43a45af2bb10967bcbd1c8bbdc93f071bb669cddf478e875c713964074698fef13ffe0574abfe94875c2844156edb48ae140d525aa6e7
-  data.tar.gz: 53f7379a2ef056cf4b4025b92996abc51f0bc83d1c98efa911384494beeb577dab80d138577e401cb04019b53c6376304c67f48e48b58e7b4f402ada469b4b75
+  metadata.gz: 6d864bcd094602c6fdff65f7f32ec4d3e3aa2c830a6c9c745e56028bc0dbc545aada3688201f0b251d1fb72dc9c5927f143345ceb359d264cf9b0b9c771e3e12
+  data.tar.gz: 9b8f84b330a36d3328a363c521e0ed4ebae3c2790df74dcd05e3ab5f22166ba4d8e6ddc467639dbbd400e35f8bc7029ffbd52481fee4ba81d015e67b7f25e28b

data/lib/rancour/application_command.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Rancour
+  class ApplicationCommand
+    SUB_COMMAND	= 1
+    SUB_COMMAND_GROUP =	2
+    STRING = 3
+    INTEGER = 4
+    BOOLEAN = 5
+    USER = 6
+    CHANNEL = 7
+    ROLE = 8
+    MENTIONABLE = 9
+    NUMBER = 10
+    ATTACHMENT = 11
+
+    attr_accessor :id, :guild_id, :name, :value, :options
+
+    def self.from_payload(payload)
+      new(
+        id: payload['id'],
+        guild_id: payload['guild_id'],
+        name: payload['name'],
+        value: payload['value'],
+        options: payload['options']
+      )
+    end
+
+    def initialize(id:, guild_id:, name:, value:, options:)
+      self.id = id
+      self.guild_id = guild_id
+      self.name = name
+      self.value = value
+      self.options = []
+
+      return if options.nil?
+
+      self.options = options.map { |option| Interaction::Data.from_payload(option) }
+    end
+  end
+end

data/lib/rancour/client.rb

@@ -11,34 +11,78 @@ module Rancour
 
       @app_id = app_id
 
-      @bot_token = bot_token if bot_token.present?
-      @bearer_token = bearer_token if bearer_token.present?
+      @bot_token = bot_token unless bot_token.nil?
+      @bearer_token = bearer_token unless bearer_token.nil?
     end
 
-    def register_application_commands(payload:, guild_id: nil)
-      path = '/commands'
-      path = "/guilds/#{guild_id}" + path if guild_id.present?
+    def fetch_application_commands(guild_id: nil)
+      get(commands_path(guild_id: guild_id))
+    end
 
-      response = connection.post(path, json: payload)
-      response.raise_for_status
+    def register_application_commands(payload, guild_id: nil)
+      post(commands_path(guild_id: guild_id), params: payload)
+    end
 
-      response.json
+    def delete_application_command(command_id, guild_id: nil)
+      delete(commands_path(guild_id: guild_id) + "/#{command_id}")
     end
 
     private
 
-    def connection
-      @connection ||= HTTPX.with(
+    def commands_path(guild_id: nil)
+      return "/guilds/#{guild_id}/commands" unless guild_id.nil?
+
+      '/commands'
+    end
+
+    def get(endpoint)
+      process_response(http_client.get(endpoint, headers: { 'content-type': 'application/json' }))
+    end
+
+    def post(endpoint, params: {})
+      process_response(http_client.post(endpoint, json: params))
+    end
+
+    def patch(endpoint, params: {})
+      process_response(http_client.put(endpoint, json: params))
+    end
+
+    def delete(endpoint)
+      process_response(http_client.delete(endpoint))
+    end
+
+    def http_client
+      @http_client ||= HTTPX.with(
         origin: 'https://discord.com',
         base_path: "/api/v#{DISCORD_API_VERSION}/applications/#{@app_id}",
         headers: {
-          authorization: authorization_header
+          authorization: authorization_header,
+          'content-type': 'application/json'
         }
       )
     end
 
+    def process_response(response)
+      response.raise_for_status
+      response.json
+    rescue HTTPX::TimeoutError, HTTPX::ResolveError => e
+      raise RequestError, e.message
+    rescue HTTPX::HTTPError => e
+      handle_api_error(e)
+    end
+
+    def handle_api_error(error)
+      klass = case error.response.status
+              when 400..499 then RequestError
+              when 500..599 then ResponseError
+              else Error
+              end
+
+      raise klass || Error, error.response.json['message']
+    end
+
     def authorization_header
-      return "Bearer #{@bearer_token}" if @bearer_token.present?
+      return "Bearer #{@bearer_token}" unless @bearer_token.nil?
 
       "Bot #{@bot_token}"
     end

data/lib/rancour/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Rancour
+  class Error < StandardError; end
+
+  class NetworkError < Error; end
+  class RequestError < Error; end
+  class InvalidParamsError < RequestError; end
+  class RateLimitedError < RequestError; end
+  class AuthenticationError < RequestError; end
+  class ResponseError < Error; end
+end

data/lib/rancour/guild.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Rancour
+  class Guild
+    attr_accessor :id, :locale, :features
+
+    def self.from_payload(payload)
+      new(
+        id: payload['id'],
+        locale: payload['locale'],
+        features: payload['features']
+      )
+    end
+
+    def initialize(id:, locale:, features: [])
+      self.id = id
+      self.locale = locale
+      self.features = features
+    end
+  end
+end

data/lib/rancour/images.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Rancour
+  class Images
+    class << self
+      BASE_URL = 'https://cdn.discordapp.com'
+
+      def image_url(path, format: 'png')
+        "#{BASE_URL}/#{path}.#{format}"
+      end
+
+      def user_avatar_url(user_id, user_avatar, format: 'png')
+        image_url("avatars/#{user_id}/#{user_avatar}", format: format)
+      end
+    end
+  end
+end

data/lib/rancour/interaction/choice.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Rancour
+  module Interaction
+    class Choices < Array
+      def add(name:, value:)
+        self << Choice.new(name: name, value: value)
+      end
+
+      def to_h
+        { choices: map(&:to_h) }
+      end
+    end
+
+    class Choice
+      attr_accessor :name, :value
+
+      def initialize(name:, value:)
+        self.name = name
+        self.value = value
+      end
+
+      def to_h
+        { name: name.to_s, value: value.to_s }
+      end
+    end
+  end
+end

data/lib/rancour/interaction/choices_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Rancour
+  module Interaction
+    class ChoicesResponse < Response
+      def initialize
+        super(type: APPLICATION_COMMAND_AUTOCOMPLETE_RESULT, data: Choices.new)
+      end
+
+      def add_choice(name:, value:)
+        data.add(name: name, value: value)
+      end
+    end
+  end
+end

data/lib/rancour/interaction/data.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Rancour
+  module Interaction
+    class Data
+      attr_accessor :name, :type, :value, :focused, :options
+
+      def self.from_payload(payload)
+        new(
+          name: payload['name'],
+          type: payload['type'],
+          value: payload['value'],
+          focused: payload['focused'],
+          options: payload['options']
+        )
+      end
+
+      def initialize(name:, type:, value:, focused: false, options: [])
+        self.name = name
+        self.type = type
+        self.value = value
+        self.focused = focused
+        self.options = {}
+
+        return if options.nil?
+
+        self.options = options.to_h do |option|
+          entry = self.class.from_payload(option)
+          [entry.name.to_sym, entry]
+        end
+      end
+
+      def focused_option
+        options&.values&.select(&:focused)&.first
+      end
+    end
+  end
+end

data/lib/rancour/interaction/embed.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Rancour
+  module Interaction
+    class Embed
+      RICH = 'rich'
+      IMAGE = 'image'
+      VIDEO = 'video'
+      GIFV = 'gifv'
+      ARTICLE = 'article'
+      LINK = 'link'
+      POLL_RESULT = 'poll_result'
+
+      attr_accessor :title,
+                    :type,
+                    :description,
+                    :url,
+                    :timestamp,
+                    :colour
+
+      def initialize(title: nil, description: nil, url: nil, type: RICH, timestamp: nil)
+        self.title = title
+        self.description = description
+        self.url = url
+        self.type = type
+        self.timestamp = timestamp
+
+        @children = {}
+      end
+
+      %i[image thumbnail video].each do |field|
+        define_method("assign_#{field}") do |url:, proxy_url: nil, width: nil, height: nil|
+          @children[field] = { url: url }
+
+          @children[field][:proxy_url] = proxy_url unless proxy_url.nil?
+          @children[field][:width] = width unless width.nil?
+          @children[field][:height] = height unless height.nil?
+        end
+      end
+
+      def assign_author(name:, url: nil, icon_url: nil)
+        @children[:author] = { name: name }
+        @children[:author][:url] = url unless url.nil?
+        @children[:author][:icon_url] = icon_url unless icon_url.nil?
+      end
+
+      def assign_footer(text:, icon_url: nil)
+        @children[:footer] = { text: text }
+        @children[:footer][:icon_url] = icon_url unless icon_url.nil?
+      end
+
+      def to_h
+        {}.tap do |output|
+          output[:title] = title unless title.nil?
+          output[:description] = description unless description.nil?
+          output[:url] = url unless url.nil?
+          output[:color] = colour unless colour.nil?
+
+          @children&.each { |type, entry| output[type] = entry.to_h }
+        end
+      end
+    end
+  end
+end

data/lib/rancour/interaction/message.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Rancour
+  module Interaction
+    class Message
+      attr_accessor :tts, :content, :embeds
+
+      def initialize(tts: false, content: nil)
+        self.tts = tts
+        self.content = content
+        self.embeds = []
+      end
+
+      def add_embed(embed)
+        raise "A message can't have more than 10 embeds" if embeds.count == 10
+
+        embeds << embed
+      end
+
+      def to_h
+        {}.tap do |output|
+          output[:tts] = tts unless tts.nil?
+          output[:content] = content unless content.nil?
+          output[:embeds] = embeds&.map(&:to_h) unless embeds.nil?
+        end
+      end
+    end
+  end
+end

data/lib/rancour/interaction/message_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Rancour
+  module Interaction
+    class MessageResponse < Response
+      extend Forwardable
+
+      def_delegators :@data, :add_embed
+
+      def initialize
+        super(type: CHANNEL_MESSAGE_WITH_SOURCE, data: Message.new)
+      end
+    end
+  end
+end

data/lib/rancour/interaction/request.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Rancour
+  module Interaction
+    class Request
+      PING = 1
+      APPLICATION_COMMAND = 2
+      MESSAGE_COMPONENT = 3
+      APPLICATION_COMMAND_AUTOCOMPLETE = 4
+      MODAL_SUBMIT = 5
+
+      attr_accessor :application_id,
+                    :context,
+                    :command,
+                    :component,
+                    :modal_submission,
+                    :guild,
+                    :locale,
+                    :token,
+                    :type,
+                    :user,
+                    :version
+
+      def self.from_payload(payload)
+        new.tap do |response|
+          %w[application_id context locale token type version].each do |field|
+            response.send("#{field}=", payload[field])
+          end
+
+          response.guild = Guild.from_payload(payload['guild']) if payload.key?('guild')
+          response.user = User.from_payload(payload.dig('member', 'user')) if payload.key?('member')
+
+          response.send(:process_data, payload['data'])
+        end
+      end
+
+      private
+
+      def process_data(data)
+        return if data.nil?
+
+        case type
+        when APPLICATION_COMMAND, APPLICATION_COMMAND_AUTOCOMPLETE
+          self.command = ApplicationCommand.from_payload(data)
+        end
+      end
+    end
+  end
+end

data/lib/rancour/interaction/response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Rancour
+  module Interaction
+    class Response
+      PONG = 1
+      CHANNEL_MESSAGE_WITH_SOURCE = 4
+      DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE = 5
+      DEFERRED_UPDATE_MESSAGE = 6
+      UPDATE_MESSAGE = 7
+      APPLICATION_COMMAND_AUTOCOMPLETE_RESULT = 8
+      MODAL = 9
+      LAUNCH_ACTIVITY = 12
+
+      attr_accessor :type, :data
+
+      def initialize(type:, data: nil)
+        self.type = type
+        self.data = data
+      end
+
+      def to_h
+        {
+          type: type,
+          data: data&.to_h
+        }
+      end
+    end
+  end
+end

data/lib/rancour/user.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Rancour
+  class User
+    attr_accessor :id,
+                  :username,
+                  :global_name,
+                  :discriminator,
+                  :avatar_url
+
+    def self.from_payload(payload)
+      new.tap do |user|
+        %w[id username global_name discriminator].each do |field|
+          user.send("#{field}=", payload[field])
+        end
+
+        user.avatar_url = Images.user_avatar_url(payload['id'], payload['avatar'])
+      end
+    end
+  end
+end

data/lib/rancour/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rancour
-  VERSION = 0.1
+  VERSION = 0.2
 end

data/lib/rancour/webhook.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'ed25519'
+
+module Rancour
+  class Webhook
+    def self.validate_request(public_key:, body:, signature:, timestamp:)
+      verification_key = Ed25519::VerifyKey.new([public_key].pack('H*'))
+      verification_key.verify([signature].pack('H*'), "#{timestamp}#{body}")
+    rescue Ed25519::VerifyError => e
+      raise InvalidParamsError, e
+    end
+  end
+end

data/lib/rancour.rb

@@ -2,4 +2,21 @@
 
 $LOAD_PATH.unshift(__dir__)
 
+require 'rancour/errors'
+require 'rancour/images'
+require 'rancour/webhook'
+
 require 'rancour/client'
+require 'rancour/guild'
+require 'rancour/user'
+
+require 'rancour/application_command'
+
+require 'rancour/interaction/choice'
+require 'rancour/interaction/data'
+require 'rancour/interaction/embed'
+require 'rancour/interaction/message'
+require 'rancour/interaction/request'
+require 'rancour/interaction/response'
+require 'rancour/interaction/choices_response'
+require 'rancour/interaction/message_response'

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: rancour
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Daniel Bogan
 bindir: bin
 cert_chain: []
-date: 2025-03-02 00:00:00.000000000 Z
+date: 2025-04-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  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: httpx
   requirement: !ruby/object:Gem::Requirement
@@ -31,10 +45,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/rancour.rb
+- lib/rancour/application_command.rb
 - lib/rancour/client.rb
-- lib/rancour/interaction.rb
-- lib/rancour/interaction_response.rb
+- lib/rancour/errors.rb
+- lib/rancour/guild.rb
+- lib/rancour/images.rb
+- lib/rancour/interaction/choice.rb
+- lib/rancour/interaction/choices_response.rb
+- lib/rancour/interaction/data.rb
+- lib/rancour/interaction/embed.rb
+- lib/rancour/interaction/message.rb
+- lib/rancour/interaction/message_response.rb
+- lib/rancour/interaction/request.rb
+- lib/rancour/interaction/response.rb
+- lib/rancour/user.rb
 - lib/rancour/version.rb
+- lib/rancour/webhook.rb
 homepage: http://github.com/waferbaby/rancour
 licenses:
 - MIT