discordrb 3.1.1 → 3.4.0

data/Gemfile

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in discordrb.gemspec
-gemspec
+gemspec name: 'discordrb'
+gemspec name: 'discordrb-webhooks', development_group: 'webhooks'

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2016 meew0
+Copyright (c) 2015-2020 meew0
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,83 +1,95 @@
 [![Gem](https://img.shields.io/gem/v/discordrb.svg)](https://rubygems.org/gems/discordrb)
 [![Gem](https://img.shields.io/gem/dt/discordrb.svg)](https://rubygems.org/gems/discordrb)
-[![Build Status](https://travis-ci.org/meew0/discordrb.svg?branch=master)](https://travis-ci.org/meew0/discordrb)
-[![Inline docs](http://inch-ci.org/github/meew0/discordrb.svg?branch=master&style=shields)](http://inch-ci.org/github/meew0/discordrb)
-[![Join Discord](https://img.shields.io/badge/discord-join-7289DA.svg)](https://discord.gg/0SBTUU1wZTWfFQL2)
+[![CircleCI](https://circleci.com/gh/shardlab/discordrb.svg?style=svg)](https://circleci.com/gh/shardlab/discordrb)
+[![Inline docs](http://inch-ci.org/github/shardlab/discordrb.svg?branch=main)](http://inch-ci.org/github/shardlab/discordrb)
+[![Join Discord](https://img.shields.io/badge/discord-join-7289DA.svg)](https://discord.gg/cyK3Hjm)
 # discordrb
 
-An implementation of the [Discord](https://discordapp.com/) API using Ruby.
+An implementation of the [Discord](https://discord.com/) API using Ruby.
 
 ## Quick links to sections
 
-* [Dependencies](https://github.com/meew0/discordrb#dependencies)
-* [Installation](https://github.com/meew0/discordrb#installation)
-* [Usage](https://github.com/meew0/discordrb#usage)
-* [Support](https://github.com/meew0/discordrb#support)
-* [Development](https://github.com/meew0/discordrb#development), [Contributing](https://github.com/meew0/discordrb#contributing)
-* [License](https://github.com/meew0/discordrb#license)
+* [Introduction](https://github.com/shardlab/discordrb#introduction)
+* [Dependencies](https://github.com/shardlab/discordrb#dependencies)
+* [Installation](https://github.com/shardlab/discordrb#installation)
+* [Usage](https://github.com/shardlab/discordrb#usage)
+* [Webhooks Client](https://github.com/shardlab/discordrb#webhooks-client)
+* [Support](https://github.com/shardlab/discordrb#support)
+* [Development](https://github.com/shardlab/discordrb#development), [Contributing](https://github.com/shardlab/discordrb#contributing)
+* [License](https://github.com/shardlab/discordrb#license)
 
-See also: [Documentation](http://www.rubydoc.info/gems/discordrb), [Tutorials](https://github.com/meew0/discordrb/wiki)
+See also: [Documentation](https://www.rubydoc.info/gems/discordrb), [Tutorials](https://github.com/shardlab/discordrb/wiki)
 
-## Dependencies
+## Introduction
 
-* Ruby 2.1+
-* An installed build system for native extensions (on Windows, try the [DevKit](http://rubyinstaller.org/downloads/); installation instructions [here](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit#quick-start) - you only need to do the quick start)
+`discordrb` aims to meet the following design goals:
 
-### Voice dependencies
+1. Full coverage of the public bot API.
+2. Expressive, high level abstractions for rapid development of common applications.
+3. Friendly to Ruby beginners and beginners of open source contribution.
 
-This section only applies to you if you want to use voice functionality.
-* [libsodium](https://github.com/meew0/discordrb/wiki/Installing-libsodium)
-* A compiled libopus distribution for your system, anywhere the script can find it (on Windows, make sure it's named `opus.dll`)
-* [FFmpeg](https://www.ffmpeg.org/download.html) installed and in your PATH
+If you enjoy using the library, consider getting involved with the community to help us improve and meet these goals!
 
-In addition to this, if you're on Windows and want to use voice functionality, your installed Ruby version **needs to be 32 bit**, as otherwise Opus won't work.
+**You should consider using `discordrb` if:**
 
-## Installation
+- You need a bot - and fast - for small or medium sized communities, and don't want to be bogged down with "low level" details. Getting started takes minutes, and utilities like a command parser and tools for modularization make it simple to quickly add or change your bots functionality.
+- You like or want to learn Ruby, or want to contribute to a Ruby project. A lot of our users are new to Ruby, and eventually make their first open source contributions with us. We have an active Discord channel with experienced members who will happily help you get involved, either as a user or contributor.
+- You want to experiment with Discord's API or prototype concepts for Discord bots without too much commitment.
 
-### Linux
+**You should consider other libraries if:**
 
-On Linux, it should be as simple as running:
+- You need to scale to large volumes of servers (>2,500) with lots of members. It's still possible, but it can be difficult to scale Ruby processes, and it requires more in depth knowledge to do so well. Especially if you already have a bot that is on a large amount of servers, porting to Ruby is unlikely to improve your performance in most cases.
+- You want full control over the library that you're using. While we expose some "lower level" interfaces, they are unstable, and only exist to serve the more powerful abstractions in the library.
 
-    gem install discordrb
+## Dependencies
 
-### Windows
+* Ruby >= 2.5 supported
+* An installed build system for native extensions (on Windows, make sure you download the "Ruby+Devkit" version of [RubyInstaller](https://rubyinstaller.org/downloads/))
 
-On Windows, to install discordrb, run this in a shell **(make sure you have the DevKit installed! See the [Dependencies](https://github.com/meew0/discordrb#dependencies) section)**:
+### Voice dependencies
 
-    gem install discordrb --platform=ruby
+This section only applies to you if you want to use voice functionality.
+* [libsodium](https://github.com/shardlab/discordrb/wiki/Installing-libsodium)
+* A compiled libopus distribution for your system, anywhere the script can find it. See [here](https://github.com/shardlab/discordrb/wiki/Installing-libopus) for installation instructions.
+* [FFmpeg](https://www.ffmpeg.org/download.html) installed and in your PATH
 
-Run the [ping example](https://github.com/meew0/discordrb/blob/master/examples/ping.rb) to verify that the installation works (make sure to replace the username and password in there with your own or your bots'!):
+## Installation
 
-    ruby ping.rb
+### With Bundler
+
+Using [Bundler](https://bundler.io/#getting-started), you can add discordrb to your Gemfile:
+
+    gem 'discordrb'
 
-#### Troubleshooting
+And then install via `bundle install`.
 
-**If you get an error like this when installing the gem**:
+Run the [ping example](https://github.com/shardlab/discordrb/blob/master/examples/ping.rb) to verify that the installation works (make sure to replace the token and client ID in there with your bots'!):
 
-    ERROR:  Error installing discordrb:
-            The 'websocket-driver' native gem requires installed build tools.
+To run the bot while using bundler:
 
-You're missing the development kit required to build native extensions. Download the development kit [here](http://rubyinstaller.org/downloads/) (scroll down to "Development Kit", then choose the one for Ruby 2.0 and your system architecture) and extract it somewhere. Open a command prompt in that folder and run:
+    bundle exec ruby ping.rb
 
-    ruby dk.rb init
-    ruby dk.rb install
+### With Gem
 
-Then reinstall discordrb:
+Alternatively, while Bundler is the recommended option, you can also install discordrb without it.
+
+#### Linux / macOS
 
-    gem uninstall discordrb
     gem install discordrb
 
-**If Ruby complains about `ffi_c` not being able to be found:**
+#### Windows
 
-For example
+> **Make sure you have the DevKit installed! See the [Dependencies](https://github.com/shardlab/discordrb#dependencies) section)**
 
-    C:/Ruby23-x64/lib/ruby/2.3.0/rubygems/core_ext/kernel_require.rb:55:in `require': cannot load such file -- ffi_c (LoadError)
+    gem install discordrb --platform=ruby
 
-Your ffi setup is screwed up, first run `gem uninstall ffi` (uninstall all versions if it asks you, say yes to any unmet dependencies), then run `gem install ffi --platform=ruby` to fix it. If it says something about build tools, follow the steps in the first troubleshooting section.
+To run the bot:
 
-**If you're having trouble getting voice playback to work**:
+    ruby ping.rb
 
-Look here: https://github.com/meew0/discordrb/wiki/Voice-sending#troubleshooting
+### Installation Troubleshooting
+
+See https://github.com/shardlab/discordrb/wiki/FAQ#installation for a list of common problems and solutions when installing `discordrb`.
 
 ## Usage
 
@@ -86,7 +98,7 @@ You can make a simple bot like this:
 ```ruby
 require 'discordrb'
 
-bot = Discordrb::Bot.new token: '<token here>', client_id: 168123456789123456
+bot = Discordrb::Bot.new token: '<token here>'
 
 bot.message(with_text: 'Ping!') do |event|
   event.respond 'Pong!'
@@ -97,23 +109,66 @@ bot.run
 
 This bot responds to every "Ping!" with a "Pong!".
 
-## Support
+See [additional examples here](https://github.com/shardlab/discordrb/tree/master/examples).
 
-You can find me (@meew0, ID 66237334693085184) on the unofficial Discord API server - if you have a question, just ask there, I or somebody else will probably answer you: https://discord.gg/0SBTUU1wZTWfFQL2
+You can find examples of projects that use discordrb by [searching for the discordrb topic on GitHub](https://github.com/topics/discordrb).
 
-## Development
+If you've made an open source project on GitHub that uses discordrb, consider adding the `discordrb` topic to your repo!
 
-**This section is for developing discordrb itself! If you just want to make a bot, see the [Installation](https://github.com/meew0/discordrb#installation) section.**
+## Webhooks Client
 
-After checking out the repo, run `bin/setup` to install dependencies. You can then run tests via `bundle exec rspec spec`. Make sure to run rubocop also: `bundle exec rubocop`. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Also included is a webhooks client, which can be used as a separate gem `discordrb-webhooks`. This special client can be used to form requests to Discord webhook URLs in a high-level manner.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- [`discordrb-webhooks` documentation](https://www.rubydoc.info/gems/discordrb-webhooks)
+- [More information about webhooks](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
+- [Embed visualizer tool](https://leovoel.github.io/embed-visualizer/) - Includes a discordrb code generator for forming embeds
+
+### Usage
+
+```ruby
+require 'discordrb/webhooks'
+
+WEBHOOK_URL = 'https://discord.com/api/webhooks/424070213278105610/yByxDncRvHi02mhKQheviQI2erKkfRRwFcEp0MMBfib1ds6ZHN13xhPZNS2-fJo_ApSw'.freeze
+
+client = Discordrb::Webhooks::Client.new(url: WEBHOOK_URL)
+client.execute do |builder|
+  builder.content = 'Hello world!'
+  builder.add_embed do |embed|
+    embed.title = 'Embed title'
+    embed.description = 'Embed description'
+    embed.timestamp = Time.now
+  end
+end
+```
+
+**Note:** The `discordrb` gem relies on `discordrb-webhooks`. If you already have `discordrb` installed, `require 'discordrb/webhooks'` will include all of the `Webhooks` features as well.
+
+## Support
+
+If you need help or have a question, you can:
+
+1. Join our [Discord channel](https://discord.gg/cyK3Hjm). This is the fastest means of getting support.
+2. [Open an issue](https://github.com/shardlab/discordrb/issues). Be sure to read the issue template, and provide as much detail as you can.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/meew0/discordrb.
+Thank you for your interest in contributing!
+Bug reports and pull requests are welcome on GitHub at https://github.com/shardlab/discordrb.
+
+In general, we recommend starting by discussing what you would like to contribute in the [Discord channel](https://discord.gg/cyK3Hjm).
+There are usually a handful of people working on things for the library, and what you're looking for may already be on the way.
+
+Additionally, there is a chance what you are looking for might already exist, or we decided not to pursue it for some reason.
+Be sure to use the search feature on our documentation, GitHub, and Discord to see if this might be the case.
+
+## Development setup
 
+**This section is for developing discordrb itself! If you just want to make a bot, see the [Installation](https://github.com/shardlab/discordrb#installation) section.**
+
+After checking out the repo, run `bin/setup` to install dependencies. You can then run tests via `bundle exec rspec spec`. Make sure to run rubocop also: `bundle exec rubocop`. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,4 +1,17 @@
-require 'bundler/gem_tasks'
+# frozen_string_literal: true
+
+require 'bundler/gem_helper'
+
+namespace :main do
+  Bundler::GemHelper.install_tasks(name: 'discordrb')
+end
+
+namespace :webhooks do
+  Bundler::GemHelper.install_tasks(name: 'discordrb-webhooks')
+end
+
+task build: %i[main:build webhooks:build]
+task release: %i[main:release webhooks:release]
 
 # Make "build" the default task
 task default: :build

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'discordrb'

data/bin/travis_build_docs.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+# Script to build docs for travis usage
+
+set -e
+
+SOURCE_BRANCH=$TRAVIS_BRANCH
+
+if [ -n "$TRAVIS_TAG" ]; then
+    SOURCE_BRANCH=$TRAVIS_TAG
+fi
+
+# Use YARD to build docs
+bundle exec yard
+
+# Move to correct folder
+mkdir -p docs/$SOURCE_BRANCH
+mv doc/* docs/$SOURCE_BRANCH/

data/discordrb-webhooks.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'discordrb/webhooks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'discordrb-webhooks'
+  spec.version       = Discordrb::Webhooks::VERSION
+  spec.authors       = %w[meew0 swarley]
+  spec.email         = ['']
+
+  spec.summary       = 'Webhook client for discordrb'
+  spec.description   = "A client for Discord's webhooks to fit alongside [discordrb](https://rubygems.org/gems/discordrb)."
+  spec.homepage      = 'https://github.com/shardlab/discordrb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z lib/discordrb/webhooks/`.split("\x0") + ['lib/discordrb/webhooks.rb']
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rest-client', '>= 2.0.0'
+
+  spec.required_ruby_version = '>= 2.5'
+end

data/discordrb.gemspec

@@ -1,35 +1,44 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'discordrb/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'discordrb'
   spec.version       = Discordrb::VERSION
-  spec.authors       = ['meew0']
+  spec.authors       = %w[meew0 swarley]
   spec.email         = ['']
 
   spec.summary       = 'Discord API for Ruby'
-  spec.description   = 'A Ruby implementation of the Discord (https://discordapp.com) API.'
-  spec.homepage      = 'https://github.com/meew0/discordrb'
+  spec.description   = 'A Ruby implementation of the Discord (https://discord.com) API.'
+  spec.homepage      = 'https://github.com/shardlab/discordrb'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples|lib/discordrb/webhooks)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.metadata = {
+    'changelog_uri' => 'https://github.com/shardlab/discordrb/blob/master/CHANGELOG.md'
+  }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rest-client'
-  spec.add_dependency 'activesupport'
+  spec.add_dependency 'ffi', '>= 1.9.24'
   spec.add_dependency 'opus-ruby'
+  spec.add_dependency 'rest-client', '>= 2.0.0'
   spec.add_dependency 'websocket-client-simple', '>= 0.3.0'
-  spec.add_dependency 'rbnacl'
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.add_dependency 'discordrb-webhooks', '~> 3.3.0'
+
+  spec.required_ruby_version = '>= 2.5'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'yard', '~> 0.8.7.6'
-  spec.add_development_dependency 'rspec', '~> 3.4.0'
-  spec.add_development_dependency 'rubocop', '0.42.0'
+  spec.add_development_dependency 'bundler', '>= 1.10', '< 3'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.5.0' # YARD markdown formatting
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency 'rspec-prof', '~> 0.0.7'
+  spec.add_development_dependency 'rubocop', '~> 1.4.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.0'
+  spec.add_development_dependency 'simplecov', '~> 0.19.0'
+  spec.add_development_dependency 'yard', '~> 0.9.9'
 end

data/lib/discordrb.rb

@@ -11,11 +11,84 @@ module Discordrb
 
   # The default debug logger used by discordrb.
   LOGGER = Logger.new(ENV['DISCORDRB_FANCY_LOG'])
+
+  # The Unix timestamp Discord IDs are based on
+  DISCORD_EPOCH = 1_420_070_400_000
+
+  # Used to declare what events you wish to recieve from Discord.
+  # @see https://discordapp.com/developers/docs/topics/gateway#gateway-intents
+  INTENTS = {
+    servers: 1 << 0,
+    server_members: 1 << 1,
+    server_bans: 1 << 2,
+    server_emojis: 1 << 3,
+    server_integrations: 1 << 4,
+    server_webhooks: 1 << 5,
+    server_invites: 1 << 6,
+    server_voice_states: 1 << 7,
+    server_presences: 1 << 8,
+    server_messages: 1 << 9,
+    server_message_reactions: 1 << 10,
+    server_message_typing: 1 << 11,
+    direct_messages: 1 << 12,
+    direct_message_reactions: 1 << 13,
+    direct_message_typing: 1 << 14
+  }.freeze
+
+  # @return [Integer] All available intents
+  ALL_INTENTS = INTENTS.values.reduce(&:|)
+
+  # Compares two objects based on IDs - either the objects' IDs are equal, or one object is equal to the other's ID.
+  def self.id_compare(one_id, other)
+    other.respond_to?(:resolve_id) ? (one_id.resolve_id == other.resolve_id) : (one_id == other)
+  end
+
+  # The maximum length a Discord message can have
+  CHARACTER_LIMIT = 2000
+
+  # Splits a message into chunks of 2000 characters. Attempts to split by lines if possible.
+  # @param msg [String] The message to split.
+  # @return [Array<String>] the message split into chunks
+  def self.split_message(msg)
+    # If the messages is empty, return an empty array
+    return [] if msg.empty?
+
+    # Split the message into lines
+    lines = msg.lines
+
+    # Turn the message into a "triangle" of consecutively longer slices, for example the array [1,2,3,4] would become
+    # [
+    #  [1],
+    #  [1, 2],
+    #  [1, 2, 3],
+    #  [1, 2, 3, 4]
+    # ]
+    tri = (0...lines.length).map { |i| lines.combination(i + 1).first }
+
+    # Join the individual elements together to get an array of strings with consecutively more lines
+    joined = tri.map(&:join)
+
+    # Find the largest element that is still below the character limit, or if none such element exists return the first
+    ideal = joined.max_by { |e| e.length > CHARACTER_LIMIT ? -1 : e.length }
+
+    # If it's still larger than the character limit (none was smaller than it) split it into the largest chunk without
+    # cutting words apart, breaking on the nearest space within character limit, otherwise just return an array with one element
+    ideal_ary = ideal.length > CHARACTER_LIMIT ? ideal.split(/(.{1,#{CHARACTER_LIMIT}}\b|.{1,#{CHARACTER_LIMIT}})/o).reject(&:empty?) : [ideal]
+
+    # Slice off the ideal part and strip newlines
+    rest = msg[ideal.length..-1].strip
+
+    # If none remains, return an empty array -> we're done
+    return [] unless rest
+
+    # Otherwise, call the method recursively to split the rest of the string and add it onto the ideal array
+    ideal_ary + split_message(rest)
+  end
 end
 
 # In discordrb, Integer and {String} are monkey-patched to allow for easy resolution of IDs
 class Integer
-  # @return [Integer] The Discord ID represented by this integer, i. e. the integer itself
+  # @return [Integer] The Discord ID represented by this integer, i.e. the integer itself
   def resolve_id
     self
   end
@@ -23,7 +96,7 @@ end
 
 # In discordrb, {Integer} and String are monkey-patched to allow for easy resolution of IDs
 class String
-  # @return [Integer] The Discord ID represented by this string, i. e. the string converted to an integer
+  # @return [Integer] The Discord ID represented by this string, i.e. the string converted to an integer
   def resolve_id
     to_i
   end