vox 0.2.0

data/lib/vox/http/routes/webhook.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require 'vox/http/route'
+require 'vox/http/util'
+
+module Vox
+  module HTTP
+    module Routes
+      # Mixin for webhook routes.
+      module Webhook
+        include Util
+
+        # Create a new webhook.
+        # @param channel_id [String, Integer] The ID of the channel to create this webhook in.
+        # @param name [String] The name for the webhook.
+        # @param avatar [UploadIO] Image for the default webhook avatar.
+        # @return [Hash<Symbol, Object>] The created [webhook](https://discord.com/developers/docs/resources/webhook#webhook-object)
+        #   object.
+        # @vox.permissions MANAGE_WEBHOOKS
+        # @vox.api_docs https://discord.com/developers/docs/resources/webhook#create-webhook
+        def create_webhook(channel_id, name: :undef, avatar: :undef)
+          avatar_data = if avatar != :undef && !avatar.nil?
+                          "data:#{avatar.content_type};base64,#{Base64.encode64(avatar.io.read)}"
+                        else
+                          :undef
+                        end
+          json = filter_undef({ name: name, avatar: avatar_data })
+          route = Route.new(:POST, '/channels/%{channel_id}/webhooks', channel_id: channel_id)
+          request(route, json: json)
+        end
+
+        # Get webhooks associated with a channel.
+        # @param channel_id [String, Integer] The channel to list webhooks for.
+        # @return [Array<Hash<Symbol, Object>>] An array of [webhook](https://discord.com/developers/docs/resources/webhook#webhook-object)
+        #   objects.
+        # @vox.permissions MANAGE_WEBHOOKS
+        # @vox.api_docs https://discord.com/developers/docs/resources/webhook#get-channel-webhooks
+        def get_channel_webhooks(channel_id)
+          request(Route.new(:GET, '/channels/%{channel_id}/webhooks', channel_id: channel_id))
+        end
+
+        # Get webhooks associated with a guild.
+        # @param guild_id [String, Integer] The guild to list webhooks for.
+        # @return [Array<Hash<Symbol, Object>>] An array of [webhook](https://discord.com/developers/docs/resources/webhook#webhook-object)
+        #   objects.
+        # @vox.permissions MANAGE_WEBHOOKS
+        # @vox.api_docs https://discord.com/developers/docs/resources/webhook#get-guild-webhooks
+        def get_guild_webhooks(guild_id)
+          request(Route.new(:GET, '/guilds/%{guild_id}/webhooks', guild_id: guild_id))
+        end
+
+        # Get a webhook by ID.
+        # @param webhook_id [String, Integer] The ID of the desired webhook.
+        # @return [Hash<Symbol, Object>] The [webhook](https://discord.com/developers/docs/resources/webhook#webhook-object)
+        #   object.
+        # @vox.permissions MANAGE_WEBHOOKS
+        # @vox.api_docs
+        def get_webhook(webhook_id)
+          request(Route.new(:GET, '/webhooks/%{webhook_id}', webhook_id: webhook_id))
+        end
+
+        # Get a webhook by ID and token. This does not require authentication.
+        # @param webhook_id [String, Integer]
+        # @param webhook_token [String]
+        # @return [Hash<Symbol, Object>] The [webhook](https://discord.com/developers/docs/resources/webhook#webhook-object)
+        #   object.
+        # @vox.api_docs https://discord.com/developers/docs/resources/webhook#get-webhook-with-token
+        def get_webhook_with_token(webhook_id, webhook_token)
+          route = Route.new(:GET, '/webhooks/%{webhook_id}/%{webhook_token}',
+                            webhook_id: webhook_id, webhook_token: webhook_token)
+          request(route)
+        end
+
+        # Modify a webhook's properties.
+        # @param webhook_id [String, Integer] The ID of the target webhook.
+        # @param name [String] The new name for the webhook.
+        # @param avatar [UploadIO]  The new avatar for the webhook.
+        # @param channel_id [String, Integer] The new channel for this webhook to use.
+        # @return [Hash<Symbol, Object>] The modified [webhook](https://discord.com/developers/docs/resources/webhook#webhook-object)
+        #   object.
+        # @vox.permissions MANAGE_WEBHOOKS
+        # @vox.api_docs https://discord.com/developers/docs/resources/webhook#modify-webhook
+        def modify_webhook(webhook_id, name: :undef, avatar: :undef, channel_id: :undef)
+          avatar_data = if avatar != :undef && !avatar.nil?
+                          "data:#{avatar.content_type};base64,#{Base64.encode64(avatar.io.read)}"
+                        else
+                          :undef
+                        end
+          json = filter_undef({ name: name, avatar: avatar_data, channel_id: channel_id })
+          route = Route.new(:PATCH, '/webhooks/%{webhook_id}', webhook_id: webhook_id)
+          request(route, json: json)
+        end
+
+        # Modify a webhook's properties with a token. This endpoint does not require authorization.
+        # @param webhook_id [String, Integer] The ID of the target webhook.
+        # @param webhook_token [String] The token of the target webhook.
+        # @param name [String] The new name for the webhook.
+        # @param avatar [UploadIO]  The new avatar for the webhook.
+        # @param channel_id [String, Integer] The new channel for this webhook to use.
+        # @return [Hash<Symbol, Object>] The modified [webhook](https://discord.com/developers/docs/resources/webhook#webhook-object)
+        #   object.
+        # @vox.api_docs https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token
+        def modify_webhook_with_token(webhook_id, webhook_token, name: :undef, avatar: :undef, channel_id: :undef)
+          avatar_data = if avatar != :undef && !avatar.nil?
+                          "data:#{avatar.content_type};base64,#{Base64.encode64(avatar.io.read)}"
+                        else
+                          :undef
+                        end
+          json = filter_undef({ name: name, avatar: avatar_data, channel_id: channel_id })
+          route = Route.new(:PATCH, '/webhooks/%{webhook_id}/%{webhook_token}',
+                            webhook_id: webhook_id, webhook_token: webhook_token)
+          request(route, json: json)
+        end
+
+        # Delete a webhook.
+        # @param webhook_id [String, Integer] The ID of the webhook to be deleted.
+        # @return [nil] Returns `nil` on success.
+        # @vox.permissions MANAGE_WEBHOOKS
+        # @vox.api_docs https://discord.com/developers/docs/resources/webhook#delete-webhook
+        def delete_webhook(webhook_id)
+          request(Route.new(:DELETE, '/webhooks/%{webhook_id}', webhook_id: webhook_id))
+        end
+
+        # Delete a webhook with a token. This endpoint does not require authorization.
+        # @param webhook_id [String, Integer] The ID of the webhook to be deleted.
+        # @param webhook_token [String] The token for the target webhook/
+        # @return [nil] Returns `nil` on success.
+        # @vox.api_docs https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token
+        def delete_webhook_with_token(webhook_id, webhook_token)
+          route = Route.new(:DELETE, '/webhooks/%{webhook_id}/%{webhook_token}',
+                            webhook_id: webhook_id, webhook_token: webhook_token)
+          request(route)
+        end
+
+        # Post content to a webhook.
+        # @param webhook_id [String, Integer] The ID of the webhook to post to.
+        # @param webhook_token [String] The token for the target webhook.
+        # @param wait [true, false] Waits for server confirmation of message send before response,
+        #   and returns the created message body.
+        # @param content [String] The message contents.
+        # @param username [String] Override the default avatar of the webhook.
+        # @param avatar_url [String] Override the default avatar of the webhook.
+        # @param tts [true, false] If this message is TTS.
+        # @param file [UploadIO] The file being sent.
+        # @param embeds [Array<Hash<Symbol, Object>>] An array of up to 10 [embed](https://discord.com/developers/docs/resources/channel#embed-object)
+        #   objects.
+        # @param allowed_mentions [Hash<Symbol, Object>] [Allowed mentions](https://discord.com/developers/docs/resources/channel#allowed-mentions-object)
+        #   object for this message.
+        # @param attachments [Hash<String, UploadIO>, Array<UploadIO>] A hash in the form of `filename => upload_io` to
+        #   be referenced in embeds via the `attachment://` URI, or an array of {UploadIO} who's filenames are derived
+        #   from the existing UploadIO object. See [attachment:// docs](https://discord.com/developers/docs/resources/channel#create-message-using-attachments-within-embeds).
+        # @vox.api_docs https://discord.com/developers/docs/resources/webhook#execute-webhook
+        def execute_webhook(webhook_id, webhook_token, wait: :undef, content: :undef, username: :undef,
+                            avatar_url: :undef, tts: :undef, file: :undef, embeds: :undef,
+                            allowed_mentions: :undef, attachments: :undef)
+          params = filter_undef({ wait: wait })
+          json = filter_undef({ content: content, username: username, avatar_url: avatar_url, tts: tts, embeds: embeds,
+                                allowed_mentions: allowed_mentions })
+          route = Route.new(:POST, '/webhooks/%{webhook_id}/%{webhook_token}',
+                            webhook_id: webhook_id, webhook_token: webhook_token)
+
+          if file != :undef
+            data = { file: file, payload_json: MultiJson.dump(json) }
+            request(route, data: data, query: params)
+          elsif attachments != :undef
+            attachments = attachments.collect { |k, v| UploadIO.new(v.io, v.content_type, k) } if attachments.is_a? Hash
+            attach_hash = Array(0...attachments.size).zip(attachments).to_h
+            data = attach_hash.merge(payload_json: MultiJson.dump(json))
+            request(route, data: data, query: params)
+          else
+            request(route, json: json, query: params)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vox/http/upload_io.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'vox/http/util'
+
+module Vox
+  module HTTP
+    # Wrapper to faraday's UploadIO that allows for an optional MIME type
+    class UploadIO < Faraday::UploadIO
+      include Util
+
+      # @param file [File, IO, String] A File, IO, or file path for the upload.
+      # @param mime_type [String] The MIME type for the file, if `nil` it will be
+      #   inferred from the file path, defaulting to 'application/octet-stream'
+      #   if no matching MIME type matches.
+      # @param name [String] File name, this can be omitted if the provided file
+      #   responds to `path`.
+      def initialize(file, mime_type = nil, name = nil)
+        mime_type ||= mime_for_file(file.respond_to?(:path) ? file.path : file)
+        super(file, mime_type, name)
+      end
+    end
+  end
+end

data/lib/vox/http/util.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'mime/types'
+
+module Vox
+  module HTTP
+    # @!visibility private
+    module Util
+      # Remove members from a hash that have `:undef` as values
+      # @example
+      #   ```ruby
+      #   hash = { foo: 1, bar: :undef, baz: 2 }
+      #   filter_hash(hash)
+      #   # => { foo: 1, baz: 2 }
+      #   ```
+      # @param hash [Hash] The hash to filter `:undef` members from.
+      # @return [Hash] The given hash with all members with an `:undef` value removed.
+      # @!visibility private
+      def filter_undef(hash)
+        hash.reject { |_, v| v == :undef }
+      end
+
+      # Get the MIME type from a File object or path for UploadIO purposes
+      # @!visibility private
+      # @param file [File, String] File object or String for a file path.
+      # @return [String] Returns the MIME type for a file if any. Defaults to application/octet-stream
+      def mime_for_file(file)
+        path = file.is_a?(File) ? file.path : file
+        MIME::Types.type_for(path)[0] || 'application/octet-stream'
+      end
+    end
+  end
+end

data/lib/vox/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Vox
+  # Overall gem version, each component also contains its own version
+  VERSION = '0.2.0'
+end

data/vox.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'lib/vox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vox'
+  spec.version       = Vox::VERSION
+  spec.authors       = ['Matthew Carey']
+  spec.email         = ['matthew.b.carey@gmail.com']
+
+  spec.summary       = 'Discord library'
+  spec.description   = 'Discord library'
+  spec.homepage      = 'http://swarley.github.io/vox/'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/swarley/vox'
+  spec.metadata['changelog_uri'] = 'https://github.com/swarley/vox/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday', '~> 1.0.1'
+  spec.add_runtime_dependency 'logging', '~> 2.3.0'
+  spec.add_runtime_dependency 'mime-types', '~> 3.3.1'
+  spec.add_runtime_dependency 'multi_json', '~> 1.15.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.89.1'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.7.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.42.0'
+  spec.add_development_dependency 'simplecov', '~> 0.19.0'
+  spec.add_development_dependency 'yard', '~> 0.9.25'
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: vox
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Matthew Carey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.42.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.42.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+description: Discord library
+email:
+- matthew.b.carey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/deploy_docs.yml"
+- ".github/workflows/rspec.yml"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/yard.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/vox.rb
+- lib/vox/http/client.rb
+- lib/vox/http/error.rb
+- lib/vox/http/middleware.rb
+- lib/vox/http/middleware/log_formatter.rb
+- lib/vox/http/middleware/rate_limiter.rb
+- lib/vox/http/route.rb
+- lib/vox/http/routes.rb
+- lib/vox/http/routes/audit_log.rb
+- lib/vox/http/routes/channel.rb
+- lib/vox/http/routes/emoji.rb
+- lib/vox/http/routes/guild.rb
+- lib/vox/http/routes/invite.rb
+- lib/vox/http/routes/user.rb
+- lib/vox/http/routes/voice.rb
+- lib/vox/http/routes/webhook.rb
+- lib/vox/http/upload_io.rb
+- lib/vox/http/util.rb
+- lib/vox/version.rb
+- vox.gemspec
+homepage: http://swarley.github.io/vox/
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://swarley.github.io/vox/
+  source_code_uri: https://github.com/swarley/vox
+  changelog_uri: https://github.com/swarley/vox/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Discord library
+test_files: []