discord_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87a86b36af7da2e67a7cf1b5ba61abbb3cb3d44132c8b3d4ecc63871090d40a0
+  data.tar.gz: aee120202417f73ddbcfba36568d15fe3146bd54776c2ee1e95ca4ca880544e8
+SHA512:
+  metadata.gz: 3b9df969d355386214e50684381f991aecdf1e71d02ffe90a0496b78a2d731b5e433ebfdf8cc136602e4e3214f182cd49744a087973736fb3ca2778c43f91e5a
+  data.tar.gz: 0b04d785a62f2ce440077cb448898816028bd0cc52ecb0e0287306c0f4520b43f9053f6ed07175c29adaa6f347e95aa14f0d99c0acad9de42ef233501f270b4f

data/.env.example

@@ -0,0 +1,2 @@
+DISCORD_USER_ACCESS_TOKEN=
+DISCORD_BOT_ACCESS_TOKEN=

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-10-30
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Dean Perry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# Discord API
+
+This is a Ruby wrapper for the Discord API. It is currently in development and is not ready for use.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "discord_api"
+```
+
+## Usage
+
+### Authentication
+
+Firstly you'll need to set either a user token or bot token. Some endpoints are only accssible with a bot token.
+
+```ruby
+# Set a user token
+@client = Discord::Client.new(user_access_token: "")
+
+# Or set a bot token
+@client = Discord::Client.new(bot_access_token: "")
+```
+
+### Users
+
+```ruby
+# Get the current user
+@client.users.me
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/discord/client.rb

@@ -0,0 +1,40 @@
+module Discord
+  class Client
+    BASE_URL = "https://discord.com/api/v10"
+
+    attr_reader :user_access_token, :bot_access_token, :adapter
+
+    def initialize(user_access_token: nil, bot_access_token: nil, adapter: Faraday.default_adapter)
+      @user_access_token = user_access_token
+      @bot_access_token = bot_access_token
+      @adapter = adapter
+    end
+
+    def users
+      UsersResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        if user_access_token
+          conn.request :authorization, :Bearer, user_access_token
+        elsif bot_access_token
+          conn.request :authorization, :Bot, bot_access_token
+        else
+          raise Error, "You must provide a user or bot access token."
+        end
+
+        conn.headers = {
+          "User-Agent" => "discord_api/v#{VERSION} (github.com/deanpcmad/discord_api)"
+        }
+
+        conn.request :json
+
+        conn.response :json, content_type: "application/json"
+
+        conn.adapter adapter, @stubs
+      end
+    end
+
+  end
+end

data/lib/discord/collection.rb

@@ -0,0 +1,21 @@
+module Discord
+  class Collection
+    attr_reader :data, :total, :cursor
+
+    def self.from_response(response, type:)
+      body = response.body
+
+      new(
+        data: body["data"].map { |attrs| type.new(attrs) },
+        total: body["data"].count,
+        cursor: body.dig("pagination", "cursor")
+      )
+    end
+
+    def initialize(data:, total:, cursor:)
+      @data = data
+      @total = total
+      @cursor = cursor.nil? ? nil : cursor
+    end
+  end
+end

data/lib/discord/error.rb

@@ -0,0 +1,4 @@
+module Discord
+  class Error < StandardError
+  end
+end

data/lib/discord/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module Discord
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/discord/objects/user.rb

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

data/lib/discord/resource.rb

@@ -0,0 +1,58 @@
+module Discord
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Error 400: Your request was malformed. '#{response.body["message"]}'"
+      when 401
+        raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["error"]}'"
+      when 403
+        raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["error"]}'"
+      when 404
+        raise Error, "Error 404: No results were found for your request. '#{response.body["error"]}'"
+      when 409
+        raise Error, "Error 409: Your request was a conflict. '#{response.body["message"]}'"
+      when 422
+        raise Error, "Error 422: Unprocessable Entity. '#{response.body["message"]}"
+      when 429
+        raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["error"]}'"
+      when 500
+        raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["error"]}'"
+      when 503
+        raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["error"]}'"
+      when 204
+        return true
+      end
+
+      response
+    end
+  end
+end

data/lib/discord/resources/users.rb

@@ -0,0 +1,10 @@
+module Discord
+  class UsersResource < Resource
+
+    # Get the currently authenticated user
+    def me
+      User.new get_request("users/@me").body
+    end
+
+  end
+end

data/lib/discord/version.rb

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

data/lib/discord.rb

@@ -0,0 +1,17 @@
+require "faraday"
+require "json"
+require "discord/version"
+
+module Discord
+
+  autoload :Client, "discord/client"
+  autoload :Collection, "discord/collection"
+  autoload :Error, "discord/error"
+  autoload :Resource, "discord/resource"
+  autoload :Object, "discord/object"
+
+  autoload :UsersResource, "discord/resources/users"
+
+  autoload :User, "discord/objects/user"
+
+end

data/lib/discord_api.rb

@@ -0,0 +1 @@
+require "discord"

data/sig/discord/api.rbs

@@ -0,0 +1,6 @@
+module Discord
+  module Api
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: discord_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dean Perry
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
+email:
+- deanperry@fastmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/discord.rb
+- lib/discord/client.rb
+- lib/discord/collection.rb
+- lib/discord/error.rb
+- lib/discord/object.rb
+- lib/discord/objects/user.rb
+- lib/discord/resource.rb
+- lib/discord/resources/users.rb
+- lib/discord/version.rb
+- lib/discord_api.rb
+- sig/discord/api.rbs
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A Ruby wrapper for the Discord API
+test_files: []