discordrb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d928acdf371b64591d0438c7bcf45ea0f2bbba1
+  data.tar.gz: b5e0e4847acb2a5624598f19949c6b36e9da1d89
+SHA512:
+  metadata.gz: 81fdfef418a981ed4318b46854b7071565dda588432353bd4b5a4fb0eb1bb01dcda575dfa4b462ee0cc3d74cb9c6454d1e1fc76c90ac39da24fac584c4c01ecd
+  data.tar.gz: 071a0ad1b506297193216409f3a2327e5318b4a0228f6dfe7243738b4f5e33ded817a0315760037de28eff5a5964e4b37b27d18400a0a69c5f1428090301d640

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in discordrb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 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
+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,50 @@
+# discordrb
+
+An implementation of the [Discord](https://discordapp.com/) API using Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'discordrb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install discordrb
+
+## Usage
+
+You can make a simple bot like this:
+
+    require 'discordrb'
+
+    bot = Discordrb::Bot.new "email@example.com", "hunter2"
+
+    bot.message(with_text: "Ping!") do |event|
+      event.respond "Pong!"
+    end
+
+    bot.run
+
+This bot responds to every "Ping!" with a "Pong!".
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/meew0/discordrb.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "discordrb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/discordrb.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$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.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.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faye-websocket"
+  spec.add_dependency "rest-client"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/examples/ping.rb

@@ -0,0 +1,11 @@
+# This simple bot responds to every "Ping!" message with a "Pong!"
+
+require 'discordrb'
+
+bot = Discordrb::Bot.new "email@example.com", "hunter2"
+
+bot.message(with_text: "Ping!") do |event|
+  event.respond "Pong!"
+end
+
+bot.run

data/lib/discordrb.rb

@@ -0,0 +1,6 @@
+require "discordrb/version"
+require "discordrb/bot"
+
+module Discordrb
+  # Your code goes here...
+end

data/lib/discordrb/bot.rb

@@ -0,0 +1,211 @@
+require 'rest-client'
+require 'faye/websocket'
+require 'eventmachine'
+
+require 'discordrb/endpoints/endpoints'
+
+require 'discordrb/events/message'
+require 'discordrb/events/typing'
+require 'discordrb/events/lifetime'
+
+require 'discordrb/exceptions'
+require 'discordrb/data'
+
+module Discordrb
+  class Bot
+    include Discordrb::Events
+    def initialize(email, password)
+      @email = email
+      @password = password
+
+      @token = login
+
+      @event_handlers = {}
+
+      @channels = {}
+      @users = {}
+
+      @debug = false
+    end
+
+    def run
+      # Handle heartbeats
+      @heartbeat_interval = 1
+      @heartbeat_active = false
+      @heartbeat_thread = Thread.new do
+        while true do
+          sleep @heartbeat_interval
+          send_heartbeat if @heartbeat_active
+        end
+      end
+
+      websocket_connect
+    end
+
+    def channel(id)
+      debug("Obtaining data for channel with id #{id}")
+      return @channels[id] if @channels[id]
+
+      response = RestClient.get Discordrb::Endpoints::CHANNELS + "/#{id}", {:Authorization => @token}
+      channel = Channel.new(JSON.parse(response), self)
+      @channels[id] = channel
+    end
+
+    def user(id)
+      @users[id]
+    end
+
+    def send_message(channel_id, content)
+      debug("Sending message to #{channel_id} with content '#{content}'")
+      data = {
+        'content' => content,
+        'mentions' => []
+      }
+
+      RestClient.post Discordrb::Endpoints::CHANNELS + "/#{channel_id}/messages", data.to_json, {:Authorization => @token, :content_type => :json}
+    end
+
+    def debug=(debug)
+      @debug = debug
+    end
+
+    def message(attributes = {}, &block)
+      @event_handlers[MessageEvent] ||= []
+      @event_handlers[MessageEvent] << MessageEventHandler.new(attributes, block)
+    end
+
+    def ready(attributes = {}, &block)
+      @event_handlers[ReadyEvent] ||= []
+      @event_handlers[ReadyEvent] << ReadyEventHandler.new(attributes, block)
+    end
+
+    def disconnected(attributes = {}, &block)
+      @event_handlers[DisconnectEvent] ||= []
+      @event_handlers[DisconnectEvent] << DisconnectEventHandler.new(attributes, block)
+    end
+
+    def typing(attributes = {}, &block)
+      @event_handlers[TypingEvent] ||= []
+      @event_handlers[TypingEvent] << TypingEvent.new(attributes, block)
+    end
+
+    private
+
+    def debug(message)
+      puts "[DEBUG] #{message}" if @debug
+    end
+
+    def login
+      debug("Logging in")
+      # Login
+      login_response = RestClient.post Discordrb::Endpoints::LOGIN, :email => @email, :password => @password
+      raise HTTPStatusException.new(login_response.code) if login_response.code >= 400
+
+      # Parse response
+      login_response_object = JSON.parse(login_response)
+      raise InvalidAuthenticationException unless login_response_object['token']
+
+      login_response_object['token']
+    end
+
+    def websocket_connect
+      EM.run {
+        @ws = Faye::WebSocket::Client.new(Discordrb::Endpoints::WEBSOCKET_HUB)
+
+        @ws.on :open do |event|; websocket_open(event); end
+        @ws.on :message do |event|; websocket_message(event); end
+
+        @ws.on :close do |event|
+          websocket_close(event)
+          @ws = nil
+        end
+      }
+    end
+
+    def websocket_message(event)
+      debug("Received packet #{event.data}")
+
+      # Parse packet
+      packet = JSON.parse(event.data)
+
+      raise "Invalid Packet" unless packet['op'] == 0   # TODO
+
+      data = packet['d']
+      case packet['t']
+      when "READY"
+        # Activate the heartbeats
+        @heartbeat_interval = data['heartbeat_interval'].to_f / 1000.0
+        @heartbeat_active = true
+        debug("Desired heartbeat_interval: #{@heartbeat_interval}")
+
+        # Initialize the bot user
+        @bot_user = User.new(data['user'], self)
+
+        # Initialize servers
+        @servers = {}
+        data['guilds'].each do |element|
+          server = Server.new(element, self)
+          @servers[server.id] = server
+
+          # Initialize users
+          server.members.each do |element|
+            @users[element.id] = element
+          end
+        end
+
+        # Make sure to raise the event
+        raise_event(ReadyEvent.new)
+      when "MESSAGE_CREATE"
+        message = Message.new(data, self)
+        event = MessageEvent.new(message)
+        raise_event(event)
+      when "TYPING_START"
+        event = TypingEvent.new(data, self)
+        raise_event(event)
+      end
+    end
+
+    def websocket_close(event)
+      raise_event(DisconnectEvent.new)
+    end
+
+    def websocket_open(event)
+      # Send the initial packet
+      packet = {
+        "op" => 2,    # Packet identifier
+        "d" => {      # Packet data
+          "v" => 2,   # Another identifier
+          "token" => @token,
+          "properties" => {   # I'm unsure what these values are for exactly, but they don't appear to impact bot functionality in any way.
+            "$os" => "Linux",
+            "$browser" => "Chrome",
+            "$device" => "discordrb",
+            "$referrer" => "",
+            "$referring_domain" => ""
+          }
+        }
+      }
+
+      @ws.send(packet.to_json)
+    end
+
+    def raise_event(event)
+      debug("Raised a #{event.class}")
+      handlers = @event_handlers[event.class]
+      (handlers || []).each do |handler|
+        handler.match(event)
+      end
+    end
+
+    def send_heartbeat
+      millis = Time.now.strftime("%s%L").to_i
+      debug("Sending heartbeat at #{millis}")
+      data = {
+        'op' => 1,
+        'd' => millis
+      }
+
+      @ws.send(data.to_json)
+    end
+  end
+end

data/lib/discordrb/data.rb

@@ -0,0 +1,80 @@
+# These classes hold relevant Discord data, such as messages or channels.
+
+module Discordrb
+  class User
+    attr_reader :username, :id, :discriminator, :avatar
+    alias_method :name, :username
+
+    def initialize(data, bot)
+      @bot = bot
+      @username = data['username']
+      @id = data['id'].to_i
+      @discriminator = data['discriminator']
+      @avatar = data['avatar']
+    end
+
+    # Utility function to mention users in messages
+    def mention
+      "<@#{@id}>"
+    end
+  end
+
+  class Channel
+    attr_reader :name, :server_id, :type, :id, :is_private
+
+    def initialize(data, bot)
+      @bot = bot
+      @name = data['name']
+      @server_id = data['guild_id']
+      @type = data['type']
+      @id = data['id']
+      @is_private = data['is_private']
+    end
+
+    def send_message(content)
+      @bot.send_message(@id, content)
+    end
+
+    alias_method :send, :send_message
+    alias_method :message, :send_message
+  end
+
+  class Message
+    attr_reader :content, :author, :channel, :timestamp, :id, :mentions
+    alias_method :user, :author
+    alias_method :text, :content
+
+    def initialize(data, bot)
+      @bot = bot
+      @content = data['content']
+      @author = User.new(data['author'], bot)
+      @channel = bot.channel(data['channel_id'].to_i)
+      @timestamp = Time.at(data['timestamp'].to_i)
+      @id = data['id'].to_i
+
+      @mentions = []
+
+      data['mentions'].each do |element|
+        @mentions << User.new(element, bot)
+      end
+    end
+  end
+
+  class Server
+    attr_reader :region, :name, :owner_id, :id, :members
+
+    def initialize(data, bot)
+      @bot = bot
+      @region = data['region']
+      @name = data['name']
+      @owner_id = data['owner_id'].to_i
+      @id = data['id'].to_i
+
+      @members = []
+
+      data['members'].each do |element|
+        @members << User.new(element, bot)
+      end
+    end
+  end
+end

data/lib/discordrb/endpoints/endpoints.rb

@@ -0,0 +1,13 @@
+module Discordrb::Endpoints
+  BASE = "https://discordapp.com/"
+  APIBASE = BASE + "api"
+
+  WEBSOCKET_HUB = "wss://discordapp.com/hub"
+
+  LOGIN = APIBASE + "/auth/login"
+  LOGOUT = APIBASE + "/auth/logout"
+
+  SERVERS = APIBASE + "/guilds"
+
+  CHANNELS = APIBASE + "/channels"
+end

data/lib/discordrb/events/generic.rb

@@ -0,0 +1,57 @@
+module Discordrb::Events
+  class Negated
+    attr_reader :object
+    def initialize(object); @object = object; end
+  end
+
+  def self.matches_all(attributes, to_check, &block)
+    # "Zeroth" case: attributes is nil
+    return true unless attributes
+
+    # First case: there's a single negated attribute
+    if attributes.is_a? Negated
+      # The contained object might also be an array, so recursively call matches_all (and negate the result)
+      return !matches_all(attributes.object, to_check, &block)
+    end
+
+    # Second case: there's a single, not-negated attribute
+    unless attributes.is_a? Array
+      return yield(attributes, to_check)
+    end
+
+    # Third case: it's an array of attributes
+    attributes.reduce(false) do |result, element|
+      result || yield(element, to_check)
+    end
+  end
+
+  class EventHandler
+    def initialize(attributes, block)
+      @attributes = attributes
+      @block = block
+    end
+
+    def matches?(event)
+      raise "Attempted to call matches?() from a generic EventHandler"
+    end
+
+    def match(event)
+      @block.call(event) if matches? event
+    end
+
+    def matches_all(attributes, to_check, &block)
+      Discordrb::Events.matches_all(attributes, to_check, &block)
+    end
+  end
+
+  # Event handler that matches all events
+  class TrueEventHandler < EventHandler
+    def matches?(event)
+      true
+    end
+  end
+end
+
+def not!(object)
+  Discordrb::Events::Negated.new(object)
+end

data/lib/discordrb/events/lifetime.rb

@@ -0,0 +1,9 @@
+require 'discordrb/events/generic'
+
+module Discordrb::Events
+  class ReadyEvent; end
+  class ReadyEventHandler < TrueEventHandler; end
+
+  class DisconnectEvent; end
+  class DisconnectEventHandler < TrueEventHandler; end
+end

data/lib/discordrb/events/message.rb

@@ -0,0 +1,57 @@
+require 'discordrb/events/generic'
+
+module Discordrb::Events
+  class MessageEvent
+    attr_reader :message
+
+    def initialize(message)
+      @message = message
+    end
+
+    def author; @message.author; end
+    alias_method :user, :author
+    def channel; @message.channel; end
+    def content; @message.content; end
+    alias_method :text, :content
+    def timestamp; @message.timestamp; end
+
+    def send_message(content); @message.send_message(content); end
+    alias_method :send, :send_message
+    alias_method :message, :send_message
+    alias_method :respond, :send_message
+  end
+
+  class MessageEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? MessageEvent
+
+      return [
+        matches_all(@attributes[:starting_with], event.content) { |a,e| e.start_with? a },
+        matches_all(@attributes[:ending_with], event.content) { |a,e| e.end_with? a },
+        matches_all(@attributes[:containing], event.content) { |a,e| e.include? a },
+        matches_all(@attributes[:in], event.channel) do |a,e|
+          if a.is_a? String
+            a == e.name
+          elsif a.is_a? Fixnum
+            a == e.id
+          else
+            a == e
+          end
+        end,
+        matches_all(@attributes[:from], event.author) do |a,e|
+          if a.is_a? String
+            a == e.name
+          elsif a.is_a? Fixnum
+            a == e.id
+          else
+            a == e
+          end
+        end,
+        matches_all(@attributes[:with_text], event.content) { |a,e| e == a },
+        matches_all(@attributes[:after], event.timestamp) { |a,e| a > e },
+        matches_all(@attributes[:before], event.timestamp) { |a,e| a < e }
+      ].reduce(true, &:&)
+    end
+  end
+end

data/lib/discordrb/events/typing.rb

@@ -0,0 +1,45 @@
+require 'discordrb/events/generic'
+
+module Discordrb::Events
+  class TypingEvent
+    attr_reader :channel, :user, :timestamp
+
+    def initialize(data, bot)
+      @user_id = data['user_id']
+      @user = bot.user(@user_id)
+      @channel_id = data['channel_id']
+      @channel = bot.channel(@channel_id)
+      @timestamp = Time.at(data['timestamp'].to_i)
+    end
+  end
+
+  class TypingEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? TypingEvent
+
+      return [
+        matches_all(@attributes[:in], event.channel) do |a,e|
+          if a.is_a? String
+            a == e.name
+          elsif a.is_a? Fixnum
+            a == e.id
+          else
+            a == e
+          end
+        end,
+        matches_all(@attributes[:from], event.user) do |a,e|
+          if a.is_a? String
+            a == e.name
+          elsif a.is_a? Fixnum
+            a == e.id
+          else
+            a == e
+          end
+        end,
+        matches_all(@attributes[:after], event.timestamp) { |a,e| a > e },
+        matches_all(@attributes[:before], event.timestamp) { |a,e| a < e }
+      ].reduce(true, &:&)
+    end
+  end
+end

data/lib/discordrb/exceptions.rb

@@ -0,0 +1,10 @@
+module Discordrb
+  # Raised when authentication data is invalid or incorrect.
+  class InvalidAuthenticationException < RuntimeError; end
+
+  # Raised when a HTTP status code indicates a failure
+  class HTTPStatusException < RuntimeError
+    attr :status
+    def initialize(status); @status = status; end
+  end
+end

data/lib/discordrb/version.rb

@@ -0,0 +1,3 @@
+module Discordrb
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: discordrb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- meew0
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A Ruby implementation of the Discord (https://discordapp.com) API.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- discordrb.gemspec
+- examples/ping.rb
+- lib/discordrb.rb
+- lib/discordrb/bot.rb
+- lib/discordrb/data.rb
+- lib/discordrb/endpoints/endpoints.rb
+- lib/discordrb/events/generic.rb
+- lib/discordrb/events/lifetime.rb
+- lib/discordrb/events/message.rb
+- lib/discordrb/events/typing.rb
+- lib/discordrb/exceptions.rb
+- lib/discordrb/version.rb
+homepage: https://github.com/meew0/discordrb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Discord API for Ruby
+test_files: []