lib_discord 0.1.2 → 1.0.0

data/lib/lib_discord/permissions.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module LibDiscord
+  # @api private
+  PERMISSIONS = {
+    CREATE_INSTANT_INVITE: 1 << 0,
+    KICK_MEMBERS: 1 << 1,
+    BAN_MEMBERS: 1 << 2,
+    ADMINISTRATOR: 1 << 3,
+    MANAGE_CHANNELS: 1 << 4,
+    MANAGE_GUILD: 1 << 5,
+    ADD_REACTIONS: 1 << 6,
+    VIEW_AUDIT_LOG: 1 << 7,
+    PRIORITY_SPEAKER: 1 << 8,
+    STREAM: 1 << 9,
+    VIEW_CHANNEL: 1 << 10,
+    SEND_MESSAGES: 1 << 11,
+    SEND_TTS_MESSAGES: 1 << 12,
+    MANAGE_MESSAGES: 1 << 13,
+    EMBED_LINKS: 1 << 14,
+    ATTACH_FILES: 1 << 15,
+    READ_MESSAGE_HISTORY: 1 << 16,
+    MENTION_EVERYONE: 1 << 17,
+    USE_EXTERNAL_EMOJIS: 1 << 18,
+    VIEW_GUILD_INSIGHTS: 1 << 19,
+    CONNECT: 1 << 20,
+    SPEAK: 1 << 21,
+    MUTE_MEMBERS: 1 << 22,
+    DEAFEN_MEMBERS: 1 << 23,
+    MOVE_MEMBERS: 1 << 24,
+    USE_VAD: 1 << 25,
+    CHANGE_NICKNAME: 1 << 26,
+    MANAGE_NICKNAMES: 1 << 27,
+    MANAGE_ROLES: 1 << 28,
+    MANAGE_WEBHOOKS: 1 << 29,
+    MANAGE_GUILD_EXPRESSIONS: 1 << 30,
+    USE_APPLICATION_COMMANDS: 1 << 31,
+    REQUEST_TO_SPEAK: 1 << 32,
+    MANAGE_EVENTS: 1 << 33,
+    MANAGE_THREADS: 1 << 34,
+    CREATE_PUBLIC_THREADS: 1 << 35,
+    CREATE_PRIVATE_THREADS: 1 << 36,
+    USE_EXTERNAL_STICKERS: 1 << 37,
+    SEND_MESSAGES_IN_THREADS: 1 << 38,
+    USE_EMBEDDED_ACTIVITIES: 1 << 39,
+    MODERATE_MEMBERS: 1 << 40,
+    VIEW_CREATOR_MONETIZATION_ANALYTICS: 1 << 41,
+    USE_SOUNDBOARD: 1 << 42,
+    CREATE_GUILD_EXPRESSIONS: 1 << 43,
+    CREATE_EVENTS: 1 << 44,
+    USE_EXTERNAL_SOUNDS: 1 << 45,
+    SEND_VOICE_MESSAGES: 1 << 46,
+    SEND_POLLS: 1 << 49,
+    USE_EXTERNAL_APPS: 1 << 50
+  }.freeze
+
+  ##
+  # Get the data structure for Discord permissions. Use this data structure for
+  # permissions calculations, permissions comparisons, and to help reduce magic
+  # numbers in your code when making requests to Discord and parsing Discord
+  # responses.
+  #
+  # @return [Hash{Symbol => Integer}]
+  #
+  # @example
+  #   p = LibDiscord.permissions
+  #   p[:ADD_REACTIONS] # => 64
+  #
+  # @example Permissions value that can SEND_MESSAGES and ADD_REACTIONS
+  #   my_perms = p[:SEND_MESSAGES] + p[:ADD_REACTIONS] # => 2112
+  #
+  # @example Check for permission flags that are set.
+  #   my_perms & p[:ADD_REACTIONS] == p[:ADD_REACTIONS] # => true
+  #
+  # @example Check for permission flags that are not set.
+  #   my_perms & p[:KICK_MEMBERS] == p[:KICK_MEMBERS] # => false
+  #
+  # @see https://docs.ruby-lang.org/en/3.3/Integer.html#method-i-26 Integer
+  #   bitwise AND
+  # @see https://en.wikipedia.org/wiki/Magic_number_(programming) Wikipedia -
+  #   Magic number (programming)
+  # @see https://discord.com/developers/docs/topics/permissions Discord
+  #   documentation "Permissions"
+  def self.permissions = PERMISSIONS
+end

data/lib/lib_discord/urls.rb

@@ -1,27 +1,18 @@
 # frozen_string_literal: true
 
 module LibDiscord
-  ##
-  # Project URL
-  #
+  # @api private
+  DISCORD_BASE_URL = "https://discord.com"
+
   # @api private
   PROJECT_URL = "https://sr.ht/~komidore64/lib_discord"
 
-  ##
-  # Source code URL
-  #
   # @api private
   SOURCE_URL = "https://git.sr.ht/~komidore64/lib_discord"
 
-  ##
-  # Bug tracker URL
-  #
   # @api private
   BUG_TRACKER_URL = "https://todo.sr.ht/~komidore64/lib_discord"
 
-  ##
-  # Mailing list URLs
-  #
   # @api private
   MAILING_LIST_URL = "https://sr.ht/~komidore64/lib_discord/lists"
 end

data/lib/lib_discord/version.rb

@@ -1,11 +1,8 @@
 # frozen_string_literal: true
 
 module LibDiscord
-  ##
-  # Get the rubygem's version.
-  #
   # @api private
   def self.version
-    @version ||= Gem::Version.new("0.1.2")
+    @version ||= Gem::Version.new("1.0.0")
   end
 end

data/lib/lib_discord.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-##
-# Module to namespace all LibDiscord classes, constants, types, etc.
-module LibDiscord; end
-
 require "lib_discord/client"
-require "lib_discord/mappers"
+require "lib_discord/formatter"
+require "lib_discord/maps"
+require "lib_discord/permissions"

metadata

@@ -1,31 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: lib_discord
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Adam Price
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2025-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: dry-container
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-- !ruby/object:Gem::Dependency
-  name: dry-struct
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -38,115 +23,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: dry-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !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: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSES/AGPL-3.0-only.txt
 - README.md
 - lib/lib_discord.rb
-- lib/lib_discord/application.rb
-- lib/lib_discord/application_command.rb
-- lib/lib_discord/application_role_connection_metadata.rb
-- lib/lib_discord/audit_log.rb
-- lib/lib_discord/auto_moderation.rb
-- lib/lib_discord/channel.rb
 - lib/lib_discord/client.rb
-- lib/lib_discord/emoji.rb
-- lib/lib_discord/errors.rb
-- lib/lib_discord/guild.rb
-- lib/lib_discord/guild_scheduled_event.rb
-- lib/lib_discord/guild_template.rb
-- lib/lib_discord/interaction.rb
-- lib/lib_discord/invite.rb
-- lib/lib_discord/mappers.rb
-- lib/lib_discord/mappers/application_command_option_types.rb
-- lib/lib_discord/mappers/application_command_permission_types.rb
-- lib/lib_discord/mappers/application_command_types.rb
-- lib/lib_discord/mappers/application_integration_types.rb
-- lib/lib_discord/mappers/application_role_connection_metadata_types.rb
-- lib/lib_discord/mappers/audit_log_events.rb
-- lib/lib_discord/mappers/auto_moderation_action_types.rb
-- lib/lib_discord/mappers/auto_moderation_event_types.rb
-- lib/lib_discord/mappers/auto_moderation_keyword_preset_types.rb
-- lib/lib_discord/mappers/auto_moderation_trigger_types.rb
-- lib/lib_discord/mappers/channel_forum_layout_types.rb
-- lib/lib_discord/mappers/channel_message_activity_types.rb
-- lib/lib_discord/mappers/channel_message_types.rb
-- lib/lib_discord/mappers/channel_sort_order_types.rb
-- lib/lib_discord/mappers/channel_types.rb
-- lib/lib_discord/mappers/channel_video_quality_modes.rb
-- lib/lib_discord/mappers/guild_default_message_notification_levels.rb
-- lib/lib_discord/mappers/guild_explicit_content_filter_levels.rb
-- lib/lib_discord/mappers/guild_integration_expire_behaviors.rb
-- lib/lib_discord/mappers/guild_mfa_levels.rb
-- lib/lib_discord/mappers/guild_nsfw_levels.rb
-- lib/lib_discord/mappers/guild_onboarding_modes.rb
-- lib/lib_discord/mappers/guild_premium_tiers.rb
-- lib/lib_discord/mappers/guild_prompt_types.rb
-- lib/lib_discord/mappers/guild_scheduled_event_entity_types.rb
-- lib/lib_discord/mappers/guild_scheduled_event_privacy_levels.rb
-- lib/lib_discord/mappers/guild_scheduled_event_statuses.rb
-- lib/lib_discord/mappers/guild_verification_levels.rb
-- lib/lib_discord/mappers/interaction_callback_types.rb
-- lib/lib_discord/mappers/interaction_context_types.rb
-- lib/lib_discord/mappers/interaction_types.rb
-- lib/lib_discord/mappers/invite_target_types.rb
-- lib/lib_discord/mappers/message_component_button_styles.rb
-- lib/lib_discord/mappers/message_component_text_input_styles.rb
-- lib/lib_discord/mappers/message_component_types.rb
-- lib/lib_discord/mappers/poll_layout_types.rb
-- lib/lib_discord/mappers/stage_instance_privacy_levels.rb
-- lib/lib_discord/mappers/sticker_format_types.rb
-- lib/lib_discord/mappers/sticker_types.rb
-- lib/lib_discord/mappers/user_premium_types.rb
-- lib/lib_discord/mappers/user_visibility_types.rb
-- lib/lib_discord/mappers/webhooks_types.rb
-- lib/lib_discord/poll.rb
-- lib/lib_discord/resource.rb
-- lib/lib_discord/response.rb
-- lib/lib_discord/stage_instance.rb
-- lib/lib_discord/sticker.rb
-- lib/lib_discord/types.rb
+- lib/lib_discord/formatter.rb
+- lib/lib_discord/maps.rb
+- lib/lib_discord/permissions.rb
 - lib/lib_discord/urls.rb
-- lib/lib_discord/user.rb
 - lib/lib_discord/version.rb
-- lib/lib_discord/voice.rb
-- lib/lib_discord/webhook.rb
-homepage:
 licenses:
 - AGPL-3.0-only
 metadata:
@@ -155,7 +48,6 @@ metadata:
   homepage_uri: https://sr.ht/~komidore64/lib_discord
   mailing_list_uri: https://sr.ht/~komidore64/lib_discord/lists
   source_code_uri: https://git.sr.ht/~komidore64/lib_discord
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,15 +55,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
-summary: Unfancy Discord API Ruby-bindings
+summary: Straightforward Discord Web API bindings
 test_files: []

data/CHANGELOG.md

@@ -1,142 +0,0 @@
-# CHANGELOG
-
-## [0.1.2] - 2024-05-13
-
-### chore
-- sort modules alphabetically
-- unified error raising style
-- bump version to 0.1.2
-
-### fix
-- allow for loggers other than Logger descendants
-- forgot how to raise errors :facepalm:
-- arguments for ConstraintError
-- use `#debug()` convenience method rather than `#add()`
-
-## [0.1.1] - 2024-04-24
-
-### chore
-- Revert "fix: remove gem version badge"
-- include additional files for yardoc
-- bump version to 0.1.1
-
-### fix
-- remove gem version badge
-- name dry-container keys correctly
-
-## [0.1.0] - 2024-04-24
-
-### chore
-- generate CHANGELOG.md
-- typo fix
-- use `standard` gem rather than `standardrb` alias
-- shields always make a project cooler
-- move resources into the lib_discord dir
-- add yardoc for application
-- yardoc for application_command
-- yardoc for application_role_connection_metadata
-- yardoc for audit_log
-- yardoc for auto_moderation
-- yardoc for channel
-- yardoc for emoji
-- yardoc for guild
-- yardoc for guild_scheduled_event and guild_template
-- yardoc for stage_instance
-- yardoc for sticker
-- yardoc for user
-- yardoc for voice
-- yardoc for webhook
-- finish yardoc
-- add changelog to generated yardoc
-- note all the parameters that are discord snowflakes
-- reduce line length to 80 columns, where it makes sense
-- application-commands - copy descriptions
-- application - copy descriptions
-- interactions - copy descriptions
-- application-role-connection-metadata - copy descriptions
-- let's leave the endpoint descriptions to Discord
-- use our binstubs
-- document the mappers module
-
-### feat
-- polls came out since i started working on this library!
-- [**breaking**] authorization header for client is now a positional argument
-- account for endpoints that don't require auth
-- add convenience constants for discord integer encodings
-- bump to version 0.1.0
-
-### fix
-- bad yardoc
-- incorrect ruby-object `#inspect` output in documentation
-
-## [0.1.0.pre2] - 2024-04-15
-
-### chore
-- generate CHANGELOG.md
-- bump version to 0.1.0.pre2
-
-### fix
-- let's not leak Discord Bot Tokens to stdout
-
-## [0.1.0.pre] - 2024-04-15
-
-### chore
-- initial rspec scaffold
-- move shared_examples into a single file
-- add code coverage reporting
-- mark development dependencies as such
-- don't test HTTP if we don't need to
-- make sure we can do non-200 responses
-- yard and debug version contraints
-- add standardrb tooling
-- add sourcehut build manifest
-- add coverage reports to builds.sr.ht artifact list
-- remove unused fixture tooling
-
-### feat
-- finish guild
-- add guild_scheduled_event
-- empty files for the rest of the resources
-- add invites
-- add stage instance endpoints
-- add sticker endpoints
-- add user endpoints
-- add voice endpoints
-- add webhook endpoints
-- more rspec scaffolding
-- basic tests for application resource
-- add application_role_connection_metadata_spec
-- add audit_log_spec
-- add auto_moderation_spec
-- more test scaffolding
-- finished channel_spec
-- fill out emoji_spec
-- fill out guild_scheduled_event_spec
-- fill out guild_spec and guild_template_spec
-- fill out invite_spec and stage_instance_spec
-- fill out sticker_spec
-- fill out user_spec and voice_spec
-- fill out webhook_spec
-- make sure the client can access all resources
-- add fixture support
-- expose the container via delegators
-- implement `#send_request` for Resource
-- discord requests that we provide a user-agent
-- introduce type checking for our inputs
-- include query parameters for endpoints
-- add interaction resource and interaction_spec
-- add application_command and application_command_spec
-- use custom matcher for lib_discord/response struct
-- add a logger into the system
-- test resource logging when mime-type is unknown
-- update readme and ancillary documents
-- add git-cliff for changelog generation
-
-### fix
-- i missed a bunch of guild endpoints
-- ensure we're testing all the code
-- contain the abstraction if HTTP throws an error
-
----
-
-generated by [git-cliff](https://git-cliff.org/)

data/lib/lib_discord/application.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require "lib_discord/resource"
-
-module LibDiscord
-  ##
-  # Application Resource
-  #
-  # Do not instantiate an {Application} directly. Instead request one from an
-  # instance of {Client}.
-  #
-  #   client = LibDiscord::Client.new("Bot auth.token")
-  #   a = client["application"]
-  #
-  # @see https://discord.com/developers/docs/resources/application Discord
-  #   documentation "Application Resource"
-  class Application < Resource
-    ##
-    # @return [Response]
-    #
-    # @raise [TimeoutError] if the HTTP request times out
-    #
-    # @see https://discord.com/developers/docs/resources/application#get-current-application
-    #   Discord documentation "Get Current Application"
-    def get_current_application
-      send_request(:get, "/applications/@me")
-    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/application#edit-current-application
-    #   Discord documentation "Edit Current Application"
-    def edit_current_application(json:)
-      send_request(:patch, "/applications/@me", json:)
-    end
-  end
-end