lib_discord 0.1.2 → 1.0.0

data/lib/lib_discord/poll.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require "lib_discord/resource"
-
-module LibDiscord
-  ##
-  # Poll Resource
-  #
-  # Do not instantiate a {Poll} directly. Instead request one from an instance
-  # of {Client}.
-  #
-  #   client = LibDiscord::Client.new("Bot auth.token")
-  #   p = client["poll"]
-  #
-  # To create a poll, use {Channel#create_message}.
-  #
-  # @see https://discord.com/developers/docs/resources/poll Discord
-  #   documentation "Poll Resource"
-  class Poll < Resource
-    ##
-    # @param channel_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    # @param message_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    # @param answer_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    # @param params [Hash] optional HTTP query parameters
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    # @raise [ConstraintError] if +params+ cannot be coerced into a valid query
-    #   parameters string
-    #
-    # @see https://discord.com/developers/docs/resources/poll#get-answer-voters
-    #   Discord documentation "Get Answer Voters"
-    def get_answer_voters(channel_id:, message_id:, answer_id:, params: {})
-      send_request(:get, "/channels/#{channel_id}/polls/#{message_id}/answers/#{answer_id}", params:)
-    end
-
-    ##
-    # @param channel_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    # @param message_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/poll#end-poll Discord
-    #   documentation "End Poll"
-    def end_poll(channel_id:, message_id:)
-      send_request(:post, "/channels/#{channel_id}/polls/#{message_id}/expire")
-    end
-  end
-end

data/lib/lib_discord/resource.rb

@@ -1,133 +0,0 @@
-# frozen_string_literal: true
-
-require "http"
-require "logger"
-
-require "lib_discord/errors"
-require "lib_discord/response"
-require "lib_discord/types"
-
-module LibDiscord
-  ##
-  # @abstract Do not interact with or instantiate a Resource class. It is the
-  #   parent class for discreet Discord resources.
-  class Resource
-    ##
-    # Initialize a Resource subclass.
-    #
-    # @param auth_header [String] Authorization header
-    # @param base_url [String] Base URL to be prepended on all request
-    #   endpoints.
-    # @param user_agent [String] User-Agent header
-    # @param logger [Logger] Logger to use for output messages
-    #
-    # @raise [Dry::Types::ConstraintError] if +auth_header+, +base_url+, or
-    #   +user_agent+ are not of type String.
-    # @raise [Dry::Types::ConstraintError] if the parameter for +logger+ is not
-    #   an instance of Logger, or an instance that inherits from Logger.
-    #
-    # @api private
-    def initialize(auth_header, base_url, user_agent, logger)
-      @auth_header = Types::Strict::String[auth_header]
-      @base_url = Types::Strict::String[base_url]
-
-      @default_headers = {user_agent: Types::Strict::String[user_agent]}
-      @logger = Types::Logger[logger]
-    end
-
-    private
-
-    ##
-    # Retrieve an HTTP client, with logger attached.
-    #
-    # @api private
-    def client
-      HTTP.use(logging: {logger: @logger})
-    end
-
-    ##
-    # Retrieve an HTTP client, with logger, authorization, and any given
-    # additional headers attached.
-    #
-    # @param additional_headers zero or more keyword arguments to attach to the
-    #   HTTP client as HTTP request headers.
-    #
-    # @return [HTTP::Client] client used to make a request
-    #
-    # @api private
-    def client_with_headers(**additional_headers)
-      headers = @default_headers.merge(
-        Types::ResourceClientHeaders[additional_headers]
-      )
-      client.auth(@auth_header).headers(**headers)
-    end
-
-    ##
-    # Retrieve an HTTP client, all necessary headers and loggers attached, with
-    # its content-type set as +application/json+.
-    #
-    # @return [HTTP::Client] client used to make a request
-    #
-    # @api private
-    def clientjson = client_with_headers(content_type: "application/json")
-
-    ##
-    # Concatenate a request path with the base URL.
-    #
-    # @param path [String] request path to append to +@base_url+.
-    #
-    # @raise [Dry::Types::ConstraintError] if +path+ is not of type String.
-    #
-    # @return [String] concatenated request URL
-    #
-    # @api private
-    def request_url(path)
-      @base_url + Types::Strict::String[path]
-    end
-
-    ##
-    # Make an HTTP request.
-    #
-    # @param verb [Symbol] HTTP action (+:get+, +:post+, +:put+, +:patch+,
-    #   +:delete+)
-    # @param relative_path [String] request path, relative to the base URL
-    # @param http_client [HTTP::Client] client to use for making the request
-    # @param kwargs one or more keyword arguments that get passed to the HTTP
-    #   client
-    #
-    # @raise [Dry::Types::ConstraintError] if +verb+ is not of type Symbol
-    # @raise [Dry::Types::ConstraintError] if +kwargs+ are not of type
-    #   Hash<Symbol, String>
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @return [Response]
-    #
-    # @api private
-    def send_request(verb, relative_path, http_client: clientjson, **kwargs)
-      discord_response = http_client.send(
-        Types::Strict::Symbol[verb],
-        request_url(relative_path),
-        **Types::ResourceHttpKwargs[kwargs]
-      )
-
-      body_parsed = begin
-        discord_response.parse
-      rescue HTTP::Error
-        @logger.debug("lib_discord") do
-          "Could not parse response body with content-type `#{discord_response.headers["Content-Type"]}`."
-        end
-
-        nil
-      end
-
-      Response.new(
-        code: discord_response.code,
-        headers: discord_response.headers.to_h,
-        body_raw: discord_response.to_s,
-        body_parsed:
-      )
-    rescue HTTP::TimeoutError => e
-      raise TimeoutError.new(e.message)
-    end
-  end
-end

data/lib/lib_discord/response.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require "dry-struct"
-require "lib_discord/types"
-
-module LibDiscord
-  ##
-  # Response
-  #
-  # {Response} represents an HTTP response from Discord.
-  #
-  # @see https://dry-rb.org/gems/dry-struct dry-struct
-  class Response < Dry::Struct
-    ##
-    # Returns the HTTP response status code.
-    #
-    # @return [Integer]
-    attribute :code, Types::Strict::Integer
-
-    ##
-    # Returns the HTTP response headers.
-    #
-    # @return [Hash{String=>(String, Array(String))}]
-    attribute :headers, Types::ResponseHeaders
-
-    ##
-    # Returns the raw HTTP response body.
-    #
-    # @return [String]
-    attribute :body_raw, Types::Strict::String
-
-    ##
-    # Returns the deserialized HTTP response body, usually parsed from JSON.
-    # The exact structure and content-type differs per Discord API endpoint.
-    # Consult a given endpoint's Discord documentation for details.
-    #
-    # @note If we receive a content-type that we cannot parse/deserialize,
-    #   +body_parsed+ will be nil.
-    #
-    # @return [Hash, Array, nil]
-    attribute :body_parsed, Types::ResponseBody.optional
-  end
-end

data/lib/lib_discord/stage_instance.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-require "lib_discord/resource"
-
-module LibDiscord
-  ##
-  # Stage Instance Resource
-  #
-  # Do not instantiate a {StageInstance} directly. Instead request one from an
-  # instance of {Client}.
-  #
-  #   client = LibDiscord::Client.new("Bot auth.token")
-  #   s = client["stage_instance"]
-  #
-  # @see https://discord.com/developers/docs/resources/stage-instance Discord
-  #   documentation "Stage Instance Resource"
-  class StageInstance < Resource
-    ##
-    # @param json [Hash] JSON serializable payload
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    # @raise [ConstraintError] if +json+ cannot be serialized to JSON
-    #
-    # @see https://discord.com/developers/docs/resources/stage-instance#create-stage-instance
-    #   Discord documentation "Create Stage Instance"
-    def create_stage_instance(json:)
-      send_request(:post, "/stage-instances", json:)
-    end
-
-    ##
-    # @param channel_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/stage-instance#get-stage-instance
-    #   Discord documentation "Get Stage Instance"
-    def get_stage_instance(channel_id:)
-      send_request(:get, "/stage-instances/#{channel_id}")
-    end
-
-    ##
-    # @param channel_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    # @param json [Hash] JSON serializable payload
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    # @raise [ConstraintError] if +json+ cannot be serialized to JSON
-    #
-    # @see https://discord.com/developers/docs/resources/stage-instance#modify-stage-instance
-    #   Discord documentation "Modify Stage Instance"
-    def modify_stage_instance(channel_id:, json:)
-      send_request(:patch, "/stage-instances/#{channel_id}", json:)
-    end
-
-    ##
-    # @param channel_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/stage-instance#delete-stage-instance
-    #   Discord documentation "Delete Stage Instance"
-    def delete_stage_instance(channel_id:)
-      send_request(:delete, "/stage-instances/#{channel_id}")
-    end
-  end
-end

data/lib/lib_discord/sticker.rb

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-require "lib_discord/resource"
-
-module LibDiscord
-  ##
-  # Sticker Resource
-  #
-  # Do not instantiate a {Sticker} directly. Instead request one from an
-  # instance of {Client}.
-  #
-  #   client = LibDiscord::Client.new("Bot auth.token")
-  #   s = client["sticker"]
-  #
-  # @see https://discord.com/developers/docs/resources/sticker Discord
-  #   documentation "Sticker Resource"
-  class Sticker < Resource
-    ##
-    # @param sticker_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/sticker#get-sticker
-    #   Discord documentation "Get Sticker"
-    def get_sticker(sticker_id:)
-      send_request(:get, "/stickers/#{sticker_id}")
-    end
-
-    ##
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/sticker#list-sticker-packs
-    #   Discord documentation "List Sticker Packs"
-    def list_sticker_packs
-      send_request(:get, "/sticker-packs")
-    end
-
-    ##
-    # @param guild_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/sticker#list-guild-stickers
-    #   Discord documentation "List Guild Stickers"
-    def list_guild_stickers(guild_id:)
-      send_request(:get, "/guilds/#{guild_id}/stickers")
-    end
-
-    ##
-    # @param guild_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    # @param sticker_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/sticker#get-guild-sticker
-    #   Discord documentation "Get Guild Sticker"
-    def get_guild_sticker(guild_id:, sticker_id:)
-      send_request(:get, "/guilds/#{guild_id}/stickers/#{sticker_id}")
-    end
-
-    ##
-    # @param guild_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    # @param json [Hash] JSON serializable payload
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    # @raise [ConstraintError] if +json+ cannot be serialized to JSON
-    #
-    # @see https://discord.com/developers/docs/resources/sticker#create-guild-sticker
-    #   Discord documentation "Create Guild Sticker"
-    def create_guild_sticker(guild_id:, json:)
-      send_request(:post, "/guilds/#{guild_id}/stickers", json:)
-    end
-
-    ##
-    # @param guild_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    # @param sticker_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    # @param json [Hash] JSON serializable payload
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    # @raise [ConstraintError] if +json+ cannot be serialized to JSON
-    #
-    # @see https://discord.com/developers/docs/resources/sticker#modify-guild-sticker
-    #   Discord documentation "Modify Guild Sticker"
-    def modify_guild_sticker(guild_id:, sticker_id:, json:)
-      send_request(:patch, "/guilds/#{guild_id}/stickers/#{sticker_id}", json:)
-    end
-
-    ##
-    # @param guild_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    # @param sticker_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/sticker#delete-guild-sticker
-    #   Discord documentation "Delete Guild Sticker"
-    def delete_guild_sticker(guild_id:, sticker_id:)
-      send_request(:delete, "/guilds/#{guild_id}/stickers/#{sticker_id}")
-    end
-  end
-end

data/lib/lib_discord/types.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require "dry/types"
-
-module LibDiscord
-  ##
-  # {LibDiscord}-specific type definitions
-  #
-  # @see https://dry-rb.org/gems/dry-types dry-types
-  #
-  # @api private
-  module Types
-    include Dry.Types()
-
-    ##
-    # Check for a +Logger+-compatible object. It must respond to +#debug()+,
-    # +#info()+, +#warn()+, +#error()+, and +#fatal()+.
-    Logger = Types.Interface(
-      :debug, :info, :warn, :error, :fatal
-    )
-
-    ##
-    # Check Discord response headers.
-    ResponseHeaders = Types::Hash.map(
-      Types::Strict::String,
-      Types::Strict::String | Types::Strict::Array.of(Types::Strict::String)
-    )
-
-    ##
-    # Check Discord response body is JSON-ish.
-    ResponseBody = Types::JSON::Hash | Types::JSON::Array
-
-    ##
-    # Check +params+ and +json+ kwargs before using them in a request.
-    ResourceHttpKwargs = Types::Hash.schema(
-      params?: Types::Params::Hash,
-      json?: Types::JSON::Hash
-    )
-
-    ##
-    # Check +additional_headers+ before handing them to HTTP.
-    ResourceClientHeaders = Types::Hash.map(
-      Types::Strict::Symbol | Types::Strict::String,
-      Types::Strict::String
-    )
-  end
-end

data/lib/lib_discord/user.rb

@@ -1,174 +0,0 @@
-# frozen_string_literal: true
-
-require "lib_discord/resource"
-
-module LibDiscord
-  ##
-  # Users Resource
-  #
-  # Do not instantiate a {User} directly. Instead request one from an instance
-  # of {Client}.
-  #
-  #   client = LibDiscord::Client.new("Bot auth.token")
-  #   u = client["user"]
-  #
-  # @see https://discord.com/developers/docs/resources/user Discord
-  #   documentation "Users Resource"
-  class User < Resource
-    ##
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/user#get-current-user
-    #   Discord documentation "Get Current User"
-    def get_current_user
-      send_request(:get, "/users/@me")
-    end
-
-    ##
-    # @param user_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/user#get-user Discord
-    #   documentation "Get User"
-    def get_user(user_id:)
-      send_request(:get, "/users/#{user_id}")
-    end
-
-    ##
-    # @param json [Hash] JSON serializable payload
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    # @raise [ConstraintError] if +json+ cannot be serialized to JSON
-    #
-    # @see https://discord.com/developers/docs/resources/user#modify-current-user
-    #   Discord documentation "Modify Current User"
-    def modify_current_user(json:)
-      send_request(:patch, "/users/@me", json:)
-    end
-
-    ##
-    # @param params [Hash] optional HTTP query parameters
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    # @raise [ConstraintError] if +params+ cannot be coerced into a valid query
-    #   parameters string
-    #
-    # @see https://discord.com/developers/docs/resources/user#get-current-user-guilds
-    #   Discord documentation "Get Current User Guilds"
-    def get_current_user_guilds(params: {})
-      send_request(:get, "/users/@me/guilds", params:)
-    end
-
-    ##
-    # @param guild_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/user#get-current-user-guild-member
-    #   Discord documentation "Get Current User Guild Member"
-    def get_current_user_guild_member(guild_id:)
-      send_request(:get, "/users/@me/guilds/#{guild_id}/member")
-    end
-
-    ##
-    # @param guild_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/user#leave-guild
-    #   Discord documentation "Leave Guild"
-    def leave_guild(guild_id:)
-      send_request(:delete, "/users/@me/guilds/#{guild_id}")
-    end
-
-    ##
-    # @param json [Hash] JSON serializable payload
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    # @raise [ConstraintError] if +json+ cannot be serialized to JSON
-    #
-    # @see https://discord.com/developers/docs/resources/user#create-dm Discord
-    #   documentation "Create DM"
-    def create_dm(json:)
-      send_request(:post, "/users/@me/channels", json:)
-    end
-
-    ##
-    # @param json [Hash] JSON serializable payload
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    # @raise [ConstraintError] if +json+ cannot be serialized to JSON
-    #
-    # @see https://discord.com/developers/docs/resources/user#create-group-dm
-    #   Discord documentation "Create Group DM"
-    def create_group_dm(json:)
-      send_request(:post, "/users/@me/channels", json:)
-    end
-
-    ##
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/user#get-current-user-connections
-    #   Discord documentation "Get Current User Connections"
-    def get_current_user_connections
-      send_request(:get, "/users/@me/connections")
-    end
-
-    ##
-    # @param application_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/user#get-current-user-application-role-connection
-    #   Discord documentation "Get Current User Application Role Connection"
-    def get_current_user_application_role_connection(application_id:)
-      send_request(:get, "/users/@me/applications/#{application_id}/role-connections")
-    end
-
-    ##
-    # @param application_id [#to_s]
-    #   {https://discord.com/developers/docs/reference#snowflakes Discord
-    #   documentation "Snowflakes"}
-    # @param json [Hash] JSON serializable payload
-    #
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    # @raise [ConstraintError] if +json+ cannot be serialized to JSON
-    #
-    # @see https://discord.com/developers/docs/resources/user#update-current-user-application-role-connection
-    #   Discord documentation "Update Current User Application Role Connection"
-    def update_current_user_application_role_connection(application_id:, json:)
-      send_request(:put, "/users/@me/applications/#{application_id}/role-connection", json:)
-    end
-  end
-end