discord_api 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87a86b36af7da2e67a7cf1b5ba61abbb3cb3d44132c8b3d4ecc63871090d40a0
-  data.tar.gz: aee120202417f73ddbcfba36568d15fe3146bd54776c2ee1e95ca4ca880544e8
+  metadata.gz: f5b44836b278c5d28cd0a2c6fe4009eae2957b0c6bc803fa9cfcc277b7eb794b
+  data.tar.gz: 6b7b1de20d49ba721cdd56409e06ce854973951d0dec7a1e38ca44046dd52da3
 SHA512:
-  metadata.gz: 3b9df969d355386214e50684381f991aecdf1e71d02ffe90a0496b78a2d731b5e433ebfdf8cc136602e4e3214f182cd49744a087973736fb3ca2778c43f91e5a
-  data.tar.gz: 0b04d785a62f2ce440077cb448898816028bd0cc52ecb0e0287306c0f4520b43f9053f6ed07175c29adaa6f347e95aa14f0d99c0acad9de42ef233501f270b4f
+  metadata.gz: 5f32b3a7c6103ceedf3455e10ee7ec02d89522b34031c5d8fe546bf31d02103e3afdbf422f9c5876a0d9735f5ae005876015b033e24e448826caa1e004950cb5
+  data.tar.gz: 3f14957f832318e5a7c590830fbc0e7ac7f45a32c1299db78d70d8f98a9e764f614410896f41bb5eaa5de6fac8ee2fc5891300b8efda6f8b6386bb8a3bf80f5f

data/README.md

@@ -1,6 +1,6 @@
 # Discord API
 
-This is a Ruby wrapper for the Discord API. It is currently in development and is not ready for use.
+This is a Ruby library for the Discord HTTP API. **Currently in development**
 
 ## Installation
 
@@ -28,5 +28,79 @@ Firstly you'll need to set either a user token or bot token. Some endpoints are
 
 ```ruby
 # Get the current user
+# Required scope: identify
+# Required scopes if you want the user's email: identify email
 @client.users.me
+
+# Get the user's guilds
+# Required scope: guilds
+@client.users.guilds
+```
+
+### Channels
+
+These endpoints are only accessible using a bot token.
+
+```ruby
+# Retrieve a Channel
+@client.channels.retrieve(id: 123123)
+
+# Update a Channel's details
+# https://discord.com/developers/docs/resources/channel#modify-channel
+@client.channels.update(id: 123123, name: "new-channel-name")
+```
+
+### Messages
+
+These endpoints are only accessible using a bot token.
+
+```ruby
+# List messages for a channel
+@client.messages.list(channel_id: 123123)
+
+# Get a message
+@client.messages.retrieve(channel_id: 123123, message_id: 123123)
+
+# Create a message
+# https://discord.com/developers/docs/resources/channel#create-message
+@client.messages.create(channel_id: 123123, content: "Hello World")
+
+# Update a message
+# https://discord.com/developers/docs/resources/channel#edit-message
+@client.messages.update(channel_id: 123123, message_id: 123123, content: "Hello World")
+
+# Delete a message
+@client.messages.delete(channel_id: 123123, message_id: 123123)
+
+# Bulk delete messages
+@client.messages.bulk_delete(channel_id: 123123, ids: [123123, 321321])
 ```
+
+### Guilds/Servers
+
+These endpoints are only accessible using a bot token.
+
+```ruby
+# Retrieve a Guild's details
+@client.guilds.retrieve(id: 123123)
+
+# Update a Guild's details
+# https://discord.com/developers/docs/resources/guild#modify-guild
+@client.guilds.update(id: 123123, name: "new-guild-name")
+
+# Retrieve a list of a Guild's channels
+@client.guilds.channels(guild: 123123)
+
+# Create a Guild channel
+# https://discord.com/developers/docs/resources/guild#create-guild-channel
+@client.guilds.create_channel(guild: 123123, name: "new-channel-name")
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/discord_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -6,7 +6,7 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
 task default: :test

data/lib/discord/client.rb

@@ -14,6 +14,18 @@ module Discord
       UsersResource.new(self)
     end
 
+    def guilds
+      GuildsResource.new(self)
+    end
+
+    def channels
+      ChannelsResource.new(self)
+    end
+
+    def messages
+      MessagesResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new(BASE_URL) do |conn|
         if user_access_token

data/lib/discord/collection.rb

@@ -6,13 +6,13 @@ module Discord
       body = response.body
 
       new(
-        data: body["data"].map { |attrs| type.new(attrs) },
-        total: body["data"].count,
-        cursor: body.dig("pagination", "cursor")
+        data: body.map { |attrs| type.new(attrs) },
+        total: body.count,
+        # cursor: body.dig("pagination", "cursor")
       )
     end
 
-    def initialize(data:, total:, cursor:)
+    def initialize(data:, total:, cursor:nil)
       @data = data
       @total = total
       @cursor = cursor.nil? ? nil : cursor

data/lib/discord/objects/channel.rb

@@ -0,0 +1,4 @@
+module Discord
+  class Channel < Object
+  end
+end

data/lib/discord/objects/guild.rb

@@ -0,0 +1,4 @@
+module Discord
+  class Guild < Object
+  end
+end

data/lib/discord/objects/message.rb

@@ -0,0 +1,4 @@
+module Discord
+  class Message < Object
+  end
+end

data/lib/discord/resources/channels.rb

@@ -0,0 +1,13 @@
+module Discord
+  class ChannelsResource < Resource
+
+    def retrieve(id:)
+      Channel.new get_request("channels/#{id}").body
+    end
+
+    def update(id:, **params)
+      Channel.new patch_request("channels/#{id}", body: params).body
+    end
+
+  end
+end

data/lib/discord/resources/guilds.rb

@@ -0,0 +1,24 @@
+module Discord
+  class GuildsResource < Resource
+
+    def retrieve(id:)
+      Guild.new get_request("guilds/#{id}").body
+    end
+
+    def update(id:, **params)
+      response = patch_request("guilds/#{id}", body: params)
+      Guild.new response.body
+    end
+
+    def channels(guild:)
+      response = get_request("guilds/#{guild}/channels")
+      Collection.from_response(response, type: Channel)
+    end
+
+    def create_channel(guild:, **params)
+      response = post_request("guilds/#{guild}/channels", body: params)
+      Channel.new response.body
+    end
+
+  end
+end

data/lib/discord/resources/messages.rb

@@ -0,0 +1,32 @@
+module Discord
+  class MessagesResource < Resource
+
+    def list(channel:, **params)
+      response = get_request("channels/#{channel}/messages", params: params)
+      Collection.from_response(response, type: Message)
+    end
+
+    def retrieve(channel:, message:)
+      Message.new get_request("channels/#{channel}/messages/#{message}").body
+    end
+
+    def create(channel:, **params)
+      response = post_request("channels/#{channel}/messages", body: params)
+      Message.new response.body
+    end
+
+    def update(channel:, id:, **params)
+      response = patch_request("channels/#{channel}/messages/#{id}", body: params)
+      Message.new response.body
+    end
+
+    def delete(channel:, id:)
+      delete_request("channels/#{channel}/messages/#{id}")
+    end
+
+    def bulk_delete(channel:, messages:)
+      post_request("channels/#{channel}/messages/bulk-delete", body: {messages: messages})
+    end
+
+  end
+end

data/lib/discord/resources/users.rb

@@ -1,10 +1,14 @@
 module Discord
   class UsersResource < Resource
 
-    # Get the currently authenticated user
     def me
       User.new get_request("users/@me").body
     end
 
+    def guilds
+      response = get_request("users/@me/guilds")
+      Collection.from_response(response, type: Guild)
+    end
+
   end
 end

data/lib/discord/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Discord
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/lib/discord.rb

@@ -11,7 +11,13 @@ module Discord
   autoload :Object, "discord/object"
 
   autoload :UsersResource, "discord/resources/users"
+  autoload :ChannelsResource, "discord/resources/channels"
+  autoload :MessagesResource, "discord/resources/messages"
+  autoload :GuildsResource, "discord/resources/guilds"
 
   autoload :User, "discord/objects/user"
+  autoload :Guild, "discord/objects/guild"
+  autoload :Channel, "discord/objects/channel"
+  autoload :Message, "discord/objects/message"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discord_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Dean Perry
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -41,16 +41,24 @@ files:
 - lib/discord/collection.rb
 - lib/discord/error.rb
 - lib/discord/object.rb
+- lib/discord/objects/channel.rb
+- lib/discord/objects/guild.rb
+- lib/discord/objects/message.rb
 - lib/discord/objects/user.rb
 - lib/discord/resource.rb
+- lib/discord/resources/channels.rb
+- lib/discord/resources/guilds.rb
+- lib/discord/resources/messages.rb
 - lib/discord/resources/users.rb
 - lib/discord/version.rb
 - lib/discord_api.rb
 - sig/discord/api.rbs
-homepage:
+homepage: https://github.com/deanpcmad/discord_api
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/deanpcmad/discord_api
+  source_code_uri: https://github.com/deanpcmad/discord_api
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -66,8 +74,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
-summary: A Ruby wrapper for the Discord API
+summary: Ruby library for the Discord HTTP API
 test_files: []