lib_discord 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee336f29f9c16524420b8b087cd245de9cc80f35ee27c1d0036c0983b2042d18
-  data.tar.gz: bca8789409c439b82d3bec3b69122c992672b89f35318ee91a1e173fd3ce8589
+  metadata.gz: c1a0beb8d0144d659fc3dbfc1f33edb87d7fdfc771e36980b42e43c78ed4de32
+  data.tar.gz: fefe8a73bf5e0dac39f00fa071f4dfb6e68b465cdf4c51d009483de458b646b3
 SHA512:
-  metadata.gz: 0d3c5d14694598880a30b2b061079dedba3ce3911bc64b1c58f340ab8812e97651d25bff73b62c358ad7501203d6d3c1d0394c89f939c3e6a50cd6fbf6db6da7
-  data.tar.gz: b4c989d2ded1f3a95bd037f7ca111cb3258e54df90eac9de3342d4d348546ca2ef63a503dc1c35895f63af382669d3eb967eb5a4db80a8659cdaa09f166d31ec
+  metadata.gz: a0a767f10119c2a8b0904fc9ae4e1323ac336de28f5d7b2cfb37adc01bf5770f860152fcfd24677ed476a9d4e1dec77a17978a7bd62f7196d95b0e752fc30e5f
+  data.tar.gz: 94ef92b3286e644d5e5f810968fe1c2a31a8c1a9c6dd99e24edcdacd1928c5ca519134fd231a2dda337a285966a284d63b3149e4fbf89a71d456ba4588c39c43

data/CONTRIBUTING.md

@@ -0,0 +1,88 @@
+# CONTRIBUTING
+
+[project]: https://sr.ht/~komidore64/lib_discord
+[sources]: https://sr.ht/~komidore64/lib_discord/sources
+[mailing lists]: https://sr.ht/~komidore64/lib_discord/lists
+[bug tracker]: https://todo.sr.ht/~komidore64/lib_discord
+
+Bug reports and patch submissions are welcome on SourceHut via the [bug
+tracker] and [mailing lists], respectively.
+
+## Code of Conduct
+
+Everyone interacting in the lib_discord project's codebases, bug trackers, chat
+rooms, and mailing lists is expected to follow the [code of
+conduct](https://git.sr.ht/~komidore64/lib_discord/tree/main/item/CODE_OF_CONDUCT.md).
+
+## Necessary Development Tools
+
+### Ruby Runtime
+
+lib_discord is written in Ruby. A Ruby runtime is required. Our recommendation
+is to use [asdf](https://asdf-vm.com/) and
+[asdf-ruby](https://github.com/asdf-vm/asdf-ruby) to manage your local ruby
+installation.
+
+## Code Style
+
+This project adheres to [Standard Ruby](https://github.com/standardrb/standard)
+style rules.
+
+Additionally, we strive for an 80 character line length, but it's not a
+hard-and-fast rule. There are occasions where breaking an expression across
+multiple lines makes it more difficult to understand. In these instances the
+line breaks do nothing more than appease a linter. As such, there is no
+automated tooling to enforce an 80 character line length. Favor readability.
+
+## Submitting Patches
+
+We respect the intellectual property rights of others and want to ensure all
+incoming contributions are attributed and licensed. The DCO is a declaration
+attached to every contribution made by every developer. In the commit message,
+the developer adds a `Signed-off-by` trailer ([`git commit -s`]) to sign that
+they agree to the DCO. The contents of the agreement can be found below, or at
+[DeveloperCertificate.org](https://developercertificate.org/).
+
+[`git commit -s`]: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s
+
+```
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+```
+
+We require that every contribution to lib_discord is signed with a Developer
+Certificate of Origin. Please use your real name or a pseudonym, and an email
+address at which you may be contacted in the future if the (unlikely) need
+arises. Patches submitted without a signed DCO **will not be accepted**.

data/README.md

@@ -5,19 +5,20 @@
 [mailing lists]: https://sr.ht/~komidore64/lib_discord/lists
 [bug tracker]: https://todo.sr.ht/~komidore64/lib_discord
 
-Unfancy Ruby-bindings to interact with Discord's HTTPS/REST web API.
+Straightforward Ruby-bindings to interact with Discord's Web API.
 
 [project] -- [sources] -- [mailing lists] -- [bug tracker]
 
+[![Please don't upload to GitHub](https://nogithub.codeberg.page/badge.svg)](https://nogithub.codeberg.page)
 [![builds.sr.ht status](https://builds.sr.ht/~komidore64/lib_discord/commits/main/.build.yml.svg)](https://builds.sr.ht/~komidore64/lib_discord/commits/main/.build.yml)
 [![Gem Version](https://badge.fury.io/rb/lib_discord.svg)](https://rubygems.org/gems/lib_discord)
 
 ## Installation
 
 `lib_discord` requires an installed [Ruby runtime](https://www.ruby-lang.org/)
-`>= 3.2`.
+`>= 3.3`.
 
-Install the gem and add to the application's Gemfile by executing:
+Install the gem and add it to your application's Gemfile by executing:
 
 ```sh
 bundle add lib_discord
@@ -32,91 +33,64 @@ gem install lib_discord
 
 ## Usage
 
+Use the Client for communicating with Discord's web endpoints
+
 ```ruby
 require "lib_discord"
-client = LibDiscord::Client.new("Bot my.amazing.bot.token")
+
+client = LibDiscord.client("Bot my.amazing.bot.token") # => LibDiscord::Client
+resp = client.create_message("<channel_id>", {content: "Hi, Mom!"}) # => LibDiscord::Response
+resp.success? # => true
 ```
 
-Access resource types with `#[]` syntax:
+Compare permissions:
 
 ```ruby
-client.keys
-# =>
-# ["application",
-#  "application_command",
-#  "application_role_connection_metadata",
-#  "audit_log",
-#  "auto_moderation",
-#  "channel",
-#  "emoji",
-#  "guild",
-#  "guild_scheduled_event",
-#  "guild_template",
-#  "interaction",
-#  "invite",
-#  "poll",
-#  "stage_instance",
-#  "sticker",
-#  "user",
-#  "voice",
-#  "webhook"]
-
-client["application"]
-# => #<LibDiscord::Application: ... >
-```
+p = LibDiscord.permissions # => Hash
 
-Use resources to make requests to Discord's API. LibDiscord resources are
-mapped to the "Resources" described in [Discord's developer documentation].
+my_permissions = p[:SEND_MESSAGES] + p[:ADD_REACTIONS] # => 2112
 
-```ruby
-resp = client["guild"].get_guild_channels(guild_id: "12345678901234567890")
+# Check for permission flags that are set.
+my_permissions & p[:SEND_MESSAGES] == p[:SEND_MESSAGES] # => true
 
-resp.code
-# => 200
+# Check for permission flags that are not set.
+my_permissions & p[:KICK_MEMBERS] == p[:KICK_MEMBERS] # => false
+```
+
+Use maps for Discord's encoded values:
 
-resp.headers
-# => Hash of HTTP response headers
+```ruby
+aco_types = LibDiscord.maps[:ApplicationCommand][:OptionTypes] # => Hash
+aco_types[:CHANNEL] # => 7
+```
 
-resp.body_parsed
-# => JSON body deserialized to a Hash
+Format Discord specific objects to render in messages:
 
-resp.body_raw
-# => raw response body in String form
+```ruby
+fmt = LibDiscord.formatter
+fmt.user(12345678) # => "<@12345678>"
 ```
 
-[Discord's developer documentation]: https://discord.com/developers/docs
+See [documentation](https://rubydoc.info/gems/lib_discord) for more details.
 
 ## Getting help
 
-Please use the [mailing lists] if you have questions or need help.
+Please use the [mailing lists] if you have questions or need assistance.
 
 ## Contributing
 
 Bug reports and patch submissions are welcome on SourceHut via the [bug
 tracker] and [mailing lists], respectively. This project is intended to be a
-safe, welcoming space for collaboration, and contributors are expected to
-adhere to the [code of conduct].
-
-[code of conduct]: https://git.sr.ht/~komidore64/lib_discord/tree/main/item/CODE_OF_CONDUCT.md
-
-### Code style
-
-This project adheres to [Standard Ruby] style rules.
+safe and welcoming space for collaboration. All participants are expected to
+adhere to the [code of
+conduct](https://git.sr.ht/~komidore64/lib_discord/tree/main/item/CODE_OF_CONDUCT.md).
 
-Additionally, we strive for an 80 character line length, but it's not a
-hard-and-fast rule. There are occasions where breaking an expression across
-multiple lines decreases readability for no benefit other than to appease a
-linter. As such, there is no tool to enforce it. 
-
-[Standard Ruby]: https://github.com/standardrb/standard
-
-## Code of Conduct
-
-Everyone interacting in the `lib_discord` project's codebase, bug trackers,
-chat rooms, and mailing lists is expected to follow the [code of conduct].
+See
+[CONTRIBUTING.md](https://git.sr.ht/~komidore64/lib_discord/tree/main/item/CONTRIBUTING.md)
+for more details.
 
 ## Licenses
 
-See files in the [LICENSES] directory.
-
-[LICENSES]: https://git.sr.ht/~komidore64/lib_discord/tree/main/item/LICENSES/
+See files in the
+[LICENSES/](https://git.sr.ht/~komidore64/lib_discord/tree/main/item/LICENSES)
+directory.