foobara-discord-api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39c2e3b6247ea95acf1fd36deebca574371e5c76ae99eb696d41cb558bd1fa18
-  data.tar.gz: ce0bf6aa85517da7945593c9b460ac815cb898198f055529c38362515efa8d43
+  metadata.gz: cbf7b7490f473ebbea634085c46b70fe2d4c6c2442dfd3fb4827fac69f2f67ad
+  data.tar.gz: 1381d836618ce3ab4764f6d655153c19dc98fed3733a1cedd3296a676aad28c4
 SHA512:
-  metadata.gz: 122fbba60610364a00e48d6e3cb9b01b678f0391548d1379a0c94f688fda31b354c148e211bcec2e64e6a327e55a510981cc3f5c060651edba7db4bdd8cfefef
-  data.tar.gz: b5739bd62f61bb8a536b157df436ebcd258daa29b49cfbf5b547a846251956e3ea1ae7b96d70e01c4317993333e878e09718cde5ca035a5e6373c165b74319f4
+  metadata.gz: ae333fa1196dedabf0dbaae3dff3c468234c6aa8bee62dc2da3b3184899116876cb770c50a6742f4b81bde8c4e8999633ad4c9409df6cbba05e13c11187f5b66
+  data.tar.gz: b6ce4e269a46a48a4459a5b499a319ba2261ed8a6546a0a2809d70ea17d9f539fedf6509523c28cb9360d1b39835c3e595eff73d3603cd32f3e40041587e96e7

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.0.3] - 2026-10-09
+
+- Make DiscordApi a Foobara domain
+
 ## [0.0.2] - 2026-09-09
 
 - Make use of ignore_unexpected_attributes to not error when unsupported attributes are added

data/README.md

@@ -1,34 +1,83 @@
-# 
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library
-into a gem. Put your Ruby code in the file `lib/foobara/empty_ruby_project_generator`. To experiment with that code,
-run `bin/console` for an interactive prompt.
+# Foobara::DiscordApi
 
+This Ruby gem provides an easy way to use the Discord API via Foobara commands.
 
 ## Installation
 
-Typical stuff: add `gem "foobara-discord-api"` to your Gemfile or .gemspec file. Or even just
-`gem install foobara-discord-api` if just playing with it directly in scripts.
+Typical stuff: add `gem foobara-discord-api` to your Gemfile or .gemspec file. Or even just
+`gem install foobara-discord-api` if just playing with it directly.
 
 ## Usage
 
-TODO: Write usage instructions here
+### Discord setup and credentials
+
+To run `CreateMessage`, you'll need a Discord bot/Discord API token and a channel ID.
+
+#### How to get Discord bot token
+1) Go to the[Discord developer portal](https://discord.com/developers).
+2) Discord will ask you to log in or create an account.
+3) You need to create a new application.
+4) Choose the option "build a bot for your sever...".
+5) Enter the app name and press **create**.
+6) in the **Token** section, you need to press **Reset token** to generate a new token.
+7) Your Discord bot is ready!.
+
+#### How to add your bot to your Discord server
+1) In [Discord developer portal](https://discord.com/developers) go to your app.
+2) Go to **Installation**.
+3) Under **Guild install**, add **bot** to your scopes and select the permissions your bot needs.
+4) Save the changes.
+5) copy the **install link** and enter the URL in your browser. Then, select the server you want to add the bot to.
+6) Done! Your bot is now added to your server.
+
+#### How get the channel ID
+1) First, go to the Discord server where your bot has the permissions.
+2) Right click on the channel.
+3) you will see the **Copy channel ID** option, check it.
+4) Done! You now have everything you need.
+
+### Send a message
+
+Require the gem and run the command with the destination channel ID and the message content:
 
 ```ruby
-#!/usr/bin/env ruby
+require "foobara/discord_api"
 
-require "foobara/load_dotenv"
-Foobara::LoadDotenv.run!(dir: __dir__)
+outcome = Foobara::DiscordApi::CreateMessage.run(
+  channel_id: "some-channel-id",
+  api_token: "some-api-token",
+  content: "Hello, Discord!"
+)
 
-TODO: some example code
+if outcome.success?
+  message = outcome.result
+  puts "Created message #{message.id} in channel #{message.channel_id}"
+else
+  puts outcome.errors_hash
+end
 ```
+
+The `api_token` input can be omitted and defaults to `ENV["DISCORD_API_TOKEN"]`.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub
-at https://github.com/foobara/discord-api
+Bug reports and pull requests are welcome on Github at https://github.com/foobara/discord-api
+
+To work on an existing issue or submit a PR:
+
+1. Fork the `foobara/discord-api` repository and clone it to your local machine.
+2. Run `bundle install` to install any dependencies.
+3. Run `rake` to ensure that everything works as expected before making any changes.
+4. Implement your changes.
+5. Re-run `rake` to ensure that all tests and RuboCop still pass.
+6. Commit, push to GitHub and open a PR for review.
+
+## Help
+
+If you need help using or contributing to this gem,
+find us on Discord at [https://discord.gg/dDpdFAeCHB](https://discord.gg/dDpdFAeCHB)
+and ask away!
 
 ## License
 
-This project is licensed under the MPL-2.0 license. Please see LICENSE.txt for more info.
+This project is licensed under the MPL-2.0 license. Please see [LICENSE.txt](LICENSE.txt) for more info.

data/lib/foobara/discord_api.rb

@@ -1,3 +1,10 @@
 require "foobara/all"
 require "foobara/http_api_command"
+
+module Foobara
+  module DiscordApi
+    foobara_domain!
+  end
+end
+
 Foobara::Util.require_directory "#{__dir__}/../../src"

data/src/create_message.rb

@@ -4,7 +4,7 @@ module Foobara
       inputs do
         channel_id :string, :required
         content :string, :required
-        api_token :string, :sensitive_exposed, default: -> { ENV["DISCORD_API_TOKEN"] }
+        api_token :string, :sensitive, default: -> { ENV["DISCORD_API_TOKEN"] }
       end
 
       result Message

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara-discord-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Miles Georgi
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.20
 specification_version: 4
 summary: An easy way to use the Discord API as Foobara commands
 test_files: []