lita-discord_oauth 1.0.0 → 1.1.0.alpha.100

data/README.md

@@ -1,45 +1,45 @@
-# lita-discord
-
-[![Build Status][travis-img]][travis-url]
-[![Gem Version][gem-img]][gem-url]
-[![Gem Downloads][gem-dl-img]][gem-url]
-[![Dependency status][gem-dep-img]][gem-dep-url]
-[![Codacy Badge][codacy-img]][codacy-url]
-
-Discord adapter for Lita, using OAuth tokens.
-
-## Installation
-
-Add lita-discord to your Lita instance's Gemfile:
-
-``` ruby
-gem "lita-discord_oauth"
-```
-
-## Configuration
-
-The adapter exposes two configuration settings:
-
-* `config.adapters.discord_oauth.token = ''`  
-  Bot account token
-* `config.adapters.discord_oauth.client = ''`  
-  Bot client ID
-  
-You can get both these values from [this page](https://discordapp.com/developers/applications/me) - Make sure that the application is a bot user!
-
-![bot user](https://ducohosting.com/screenshots/isaac28fe06147f6a73a1a654433cf2ef3d37.png)
-
-## Usage
-
-This bot includes a custom help command. You must disable the built-in help command to prevent double output.
-
-
-[travis-img]: https://img.shields.io/travis/cascer1/lita-discord_oauth.svg
-[travis-url]: https://travis-ci.org/cascer1/lita-discord_oauth
-[gem-img]: https://img.shields.io/gem/v/lita-discord_oauth.svg
-[gem-url]: https://badge.fury.io/rb/lita-discord_oauth
-[gem-dl-img]: https://img.shields.io/gem/dv/lita-discord_oauth/stable.svg
-[gem-dep-img]: https://img.shields.io/gemnasium/cascer1/lita-discord_oauth.svg
-[gem-dep-url]: https://gemnasium.com/github.com/cascer1/lita-discord_oauth
-[codacy-img]: https://img.shields.io/codacy/grade/a66b558f1d7a4fd89673e5514e437493.svg
+# lita-discord
+
+[![Build Status][travis-img]][travis-url]
+[![Gem Version][gem-img]][gem-url]
+[![Gem Downloads][gem-dl-img]][gem-url]
+[![Dependency status][gem-dep-img]][gem-dep-url]
+[![Codacy Badge][codacy-img]][codacy-url]
+
+Discord adapter for Lita, using OAuth tokens.
+
+## Installation
+
+Add lita-discord to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-discord_oauth"
+```
+
+## Configuration
+
+The adapter exposes two configuration settings:
+
+* `config.adapters.discord_oauth.token = ''`  
+  Bot account token
+* `config.adapters.discord_oauth.client = ''`  
+  Bot client ID
+  
+You can get both these values from [this page](https://discordapp.com/developers/applications/me) - Make sure that the application is a bot user!
+
+![bot user](https://ducohosting.com/screenshots/isaac28fe06147f6a73a1a654433cf2ef3d37.png)
+
+## Usage
+
+This bot overrides the default help provider
+
+
+[travis-img]: https://img.shields.io/travis/cascer1/lita-discord_oauth.svg
+[travis-url]: https://travis-ci.org/cascer1/lita-discord_oauth
+[gem-img]: https://img.shields.io/gem/v/lita-discord_oauth.svg
+[gem-url]: https://badge.fury.io/rb/lita-discord_oauth
+[gem-dl-img]: https://img.shields.io/gem/dv/lita-discord_oauth/stable.svg
+[gem-dep-img]: https://img.shields.io/gemnasium/cascer1/lita-discord_oauth.svg
+[gem-dep-url]: https://gemnasium.com/github.com/cascer1/lita-discord_oauth
+[codacy-img]: https://img.shields.io/codacy/grade/a66b558f1d7a4fd89673e5514e437493.svg
 [codacy-url]: https://www.codacy.com/app/cascer1/lita-discord_oauth?utm_source=github.com&utm_medium=referral&utm_content=cascer1/lita-discord_oauth&utm_campaign=Badge_Grade

data/Rakefile

@@ -1,6 +1,6 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita/adapters/discord_oauth.rb

@@ -1,99 +1,99 @@
-require 'discordrb'
-
-module Lita
-  module Adapters
-    class Discord_oauth < Adapter
-      config :token, type: String, required: true
-      config :client, type: String, required: true
-
-      def initialize(robot)
-        super
-        @client = ::Discordrb::Bot.new token: config.token, client_id: config.client
-      end
-
-      def run
-        Lita.logger.debug('Starting discord_oauth adapter')
-        @client.ready do |e|
-          robot.trigger(:connected)
-
-          version = Gem.loaded_specs['lita-discord_oauth'].version
-
-          @client.game = "Version #{version}"
-
-          @client.message do |event|
-            message = event.message
-            channel = event.channel.id.to_s
-            author_id = message.author.id.to_s
-
-            if event.channel.pm?
-              # We're dealing with a PM
-              author_name = message.author.username.to_s
-            else
-              # We're dealing with a regular (server) message
-              author_name = message.author.display_name.to_s
-            end
-
-
-
-            Lita.logger.debug("Received message from #{author_name}(#{author_id}): #{message.content}")
-            Lita.logger.debug("Finding user #{author_name}")
-
-            user = Lita::User.find_by_name(author_name)
-
-            if user == nil
-              Lita.logger.debug("User #{author_name} not found, trying ID #{author_id}")
-              user = Lita::User.find_by_id(author_id)
-
-              if user != nil
-                Lita.logger.debug("User #{author_id} found, updating name to #{author_name}")
-                user = Lita::User.create(author_id, {name: author_name})
-              end
-
-              Lita.logger.debug("User #{author_id} not found, creating now")
-              user = Lita::User.create(author_id, {name: author_name}) unless user
-            end
-
-            Lita.logger.debug('User ID: ' + user.id)
-            Lita.logger.debug('Channel ID: ' + channel)
-
-            source = Lita::Source.new(user: user, room: channel)
-            msg = Lita::Message.new(robot, message.content, source)
-
-            robot.receive(msg) unless message.from_bot?
-
-          end
-        end
-
-
-        @client.run
-      end
-
-      def shut_down
-        @client.stop
-      end
-
-      def send_messages(target, messages)
-        Lita.logger.debug("Sending message to user #{target.user.id} in channel #{target.room}")
-
-        mention = @client.user(target.user.id).mention
-
-        messages.each do |message|
-          if mention
-            no_mention = message.slice!('|||NOMENTION|||')
-
-            message = mention + ",\n" + message if no_mention != '|||NOMENTION|||'
-
-
-
-            Lita.logger.info('Message is too long') if message.length > 2000
-
-            @client.send_message(target.room, message)
-          end
-        end
-      end
-
-    end
-
-    Lita.register_adapter(:discord_oauth, Discord_oauth)
-  end
-end
+require 'discordrb'
+
+module Lita
+  module Adapters
+    class Discord_oauth < Adapter
+      config :token, type: String, required: true
+      config :client, type: String, required: true
+
+      def initialize(robot)
+        super
+        @client = ::Discordrb::Bot.new token: config.token, client_id: config.client
+      end
+
+      def run
+        Lita.logger.debug('Starting discord_oauth adapter')
+        @client.ready do |e|
+          robot.trigger(:connected)
+
+          version = Gem.loaded_specs['lita-discord_oauth'].version
+
+          @client.game = "Version #{version}"
+
+          @client.message do |event|
+            message = event.message
+            channel = event.channel.id.to_s
+            author_id = message.author.id.to_s
+
+            if event.channel.pm?
+              # We're dealing with a PM
+              author_name = message.author.username.to_s
+            else
+              # We're dealing with a regular (server) message
+              author_name = message.author.display_name.to_s
+            end
+
+
+
+            Lita.logger.debug("Received message from #{author_name}(#{author_id}): #{message.content}")
+            Lita.logger.debug("Finding user #{author_name}")
+
+            user = Lita::User.find_by_name(author_name)
+
+            if user == nil
+              Lita.logger.debug("User #{author_name} not found, trying ID #{author_id}")
+              user = Lita::User.find_by_id(author_id)
+
+              if user != nil
+                Lita.logger.debug("User #{author_id} found, updating name to #{author_name}")
+                user = Lita::User.create(author_id, {name: author_name})
+              end
+
+              Lita.logger.debug("User #{author_id} not found, creating now")
+              user = Lita::User.create(author_id, {name: author_name}) unless user
+            end
+
+            Lita.logger.debug('User ID: ' + user.id)
+            Lita.logger.debug('Channel ID: ' + channel)
+
+            source = Lita::Source.new(user: user, room: channel)
+            msg = Lita::Message.new(robot, message.content, source)
+
+            robot.receive(msg) unless message.from_bot?
+
+          end
+        end
+
+
+        @client.run
+      end
+
+      def shut_down
+        @client.stop
+      end
+
+      def send_messages(target, messages)
+        Lita.logger.debug("Sending message to user #{target.user.id} in channel #{target.room}")
+
+        mention = @client.user(target.user.id).mention
+
+        messages.each do |message|
+          if mention
+            no_mention = message.slice!('|||NOMENTION|||')
+
+            message = mention + ",\n" + message if no_mention != '|||NOMENTION|||'
+
+
+
+            Lita.logger.info('Message is too long') if message.length > 2000
+
+            @client.send_message(target.room, message)
+          end
+        end
+      end
+
+    end
+
+    Lita.register_adapter(:discord_oauth, Discord_oauth)
+  end
+end

data/lib/lita/handlers/discord_help.rb

@@ -1,169 +1,169 @@
-require 'lita/handler/chat_router'
-
-module Lita
-  # A namespace to hold all subclasses of {Handler}.
-  module Handlers
-    # Provides online help about Lita commands for users.
-    class DiscordHelp
-      extend Lita::Handler::ChatRouter
-
-      route(/^help\s*(.+)?/, :help, command: true, help: {
-          'help' => t('help.help_value'),
-          t('help.help_command_key') => t('help.help_command_value')
-      })
-
-      # Outputs help information about Lita commands.
-      # @param response [Lita::Response] The response object.
-      # @return [void]
-      def help(response)
-        output = build_help(response)
-        output = filter_help(output, response)
-        first_message = true
-
-        output = output.join("\n")
-
-        messages = split_message(output)
-
-        Lita.logger.debug(messages)
-
-        messages.each { |message|
-          if first_message
-            response.reply_privately("```\n#{message}\n```")
-            first_message = false
-          else
-            response.reply_privately("|||NOMENTION|||```\n#{message}\n```")
-          end
-        }
-
-        if messages.length > 1
-          response.reply_privately('Sorry for splitting that up in multiple messages, Discord doesn\'t allow me to send responses longer than 2000 characters :(')
-        end
-
-      end
-
-      private
-
-      def split_message(message)
-        max_length = 2000 - 30 # Substract 25 for mention safety
-        messages = Array.new
-
-        if message.length < max_length
-          messages.push(message)
-        else
-          message_copy = message
-
-          loop do
-            Lita.logger.debug("Message copy: #{message_copy}")
-            # part = 'Lorem ipsum, dolor sit amet' # I don't know why we need this, but we do
-
-            part = get_message_part(message_copy, max_length)
-
-            Lita.logger.debug("Part: #{part}")
-            part = message_copy.slice!(part)
-            messages.push(part)
-
-            break if message_copy.length <= 0
-          end
-
-        end
-
-        messages
-      end
-
-      def get_message_part(message, limit)
-        Lita.logger.debug("Getting message part from #{message}")
-
-        Lita.logger.debug('Message was short enough, returning without modifications') if message.length <= limit
-        return message if message.length <= limit # No need to check anything if the message is short enough
-
-        part = message.to_s[0...limit - 1]
-        break_index = part.rindex("\n")
-
-        Lita.logger.debug("Break index: #{break_index}")
-
-        if break_index != nil && break_index != 0
-          message[0, break_index]
-        else
-          message
-        end
-      end
-
-      def table_row(key, value)
-        key_width = 30
-        value_width = 107
-
-        key_text = key.ljust(key_width, ' ')
-
-        value_words = value.split(' ')
-
-        value_text = ''
-        value_line = ''
-
-        value_words.each do |word|
-          new_value_line = "#{value_line} #{word}"
-
-          if new_value_line.length > value_width
-            value_text += "#{value_line}\n" + ''.ljust(key_width + 1, ' ')
-            value_line = word
-          else
-            value_line = "#{value_line} #{word}"
-          end
-
-        end
-
-        if value_line.length > 0
-          value_text = "#{value_text}\n" + ''.ljust(key_width + 1, ' ') + "#{value_line}"
-        end
-
-        key_text + value_text + "\n"
-      end
-
-      # Checks if the user is authorized to at least one of the given groups.
-      def authorized?(user, required_groups)
-        required_groups.nil? || required_groups.any? do |group|
-          robot.auth.user_in_group?(user, group)
-        end
-      end
-
-      # Creates an array of help info for all registered routes.
-      def build_help(response)
-        robot.handlers.map do |handler|
-          next unless handler.respond_to?(:routes)
-
-          handler.routes.map do |route|
-            route.help.map do |command, description|
-              if authorized?(response.user, route.required_groups)
-                help_command(route, command, description)
-              end
-            end
-          end
-        end.flatten.compact
-      end
-
-      # Filters the help output by an optional command.
-      def filter_help(output, response)
-        filter = response.matches[0][0]
-
-        if filter
-          output.select { |line| /(?:@?#{name}[:,]?)?#{filter}/i === line }
-        else
-          output
-        end
-      end
-
-      # Formats an individual command's help message.
-      def help_command(route, command, description)
-        command = "#{name}: #{command}" if route.command?
-
-        table_row(command, description)
-      end
-
-      # The way the bot should be addressed in order to trigger a command.
-      def name
-        robot.config.robot.mention_name || robot.config.robot.name
-      end
-    end
-
-    Lita.register_handler(DiscordHelp)
-  end
-end
+require 'lita/handler/chat_router'
+
+module Lita
+  # A namespace to hold all subclasses of {Handler}.
+  module Handlers
+    # Provides online help about Lita commands for users.
+    class DiscordHelp
+      extend Lita::Handler::ChatRouter
+
+      route(/^help\s*(.+)?/, :help, command: true, help: {
+          'help' => t('help.help_value'),
+          t('help.help_command_key') => t('help.help_command_value')
+      })
+
+      # Outputs help information about Lita commands.
+      # @param response [Lita::Response] The response object.
+      # @return [void]
+      def help(response)
+        output = build_help(response)
+        output = filter_help(output, response)
+        first_message = true
+
+        output = output.join("\n")
+
+        messages = split_message(output)
+
+        Lita.logger.debug(messages)
+
+        messages.each { |message|
+          if first_message
+            response.reply_privately("```\n#{message}\n```")
+            first_message = false
+          else
+            response.reply_privately("|||NOMENTION|||```\n#{message}\n```")
+          end
+        }
+
+        if messages.length > 1
+          response.reply_privately('Sorry for splitting that up in multiple messages, Discord doesn\'t allow me to send responses longer than 2000 characters :(')
+        end
+
+      end
+
+      private
+
+      def split_message(message)
+        max_length = 2000 - 30 # Substract 25 for mention safety
+        messages = Array.new
+
+        if message.length < max_length
+          messages.push(message)
+        else
+          message_copy = message
+
+          loop do
+            Lita.logger.debug("Message copy: #{message_copy}")
+            # part = 'Lorem ipsum, dolor sit amet' # I don't know why we need this, but we do
+
+            part = get_message_part(message_copy, max_length)
+
+            Lita.logger.debug("Part: #{part}")
+            part = message_copy.slice!(part)
+            messages.push(part)
+
+            break if message_copy.length <= 0
+          end
+
+        end
+
+        messages
+      end
+
+      def get_message_part(message, limit)
+        Lita.logger.debug("Getting message part from #{message}")
+
+        Lita.logger.debug('Message was short enough, returning without modifications') if message.length <= limit
+        return message if message.length <= limit # No need to check anything if the message is short enough
+
+        part = message.to_s[0...limit - 1]
+        break_index = part.rindex("\n")
+
+        Lita.logger.debug("Break index: #{break_index}")
+
+        if break_index != nil && break_index != 0
+          message[0, break_index]
+        else
+          message
+        end
+      end
+
+      def table_row(key, value)
+        key_width = 30
+        value_width = 107
+
+        key_text = key.ljust(key_width, ' ')
+
+        value_words = value.split(' ')
+
+        value_text = ''
+        value_line = ''
+
+        value_words.each do |word|
+          new_value_line = "#{value_line} #{word}"
+
+          if new_value_line.length > value_width
+            value_text += "#{value_line}\n" + ''.ljust(key_width + 1, ' ')
+            value_line = word
+          else
+            value_line = "#{value_line} #{word}"
+          end
+
+        end
+
+        if value_line.length > 0
+          value_text = "#{value_text}\n" + ''.ljust(key_width + 1, ' ') + "#{value_line}"
+        end
+
+        key_text + value_text + "\n"
+      end
+
+      # Checks if the user is authorized to at least one of the given groups.
+      def authorized?(user, required_groups)
+        required_groups.nil? || required_groups.any? do |group|
+          robot.auth.user_in_group?(user, group)
+        end
+      end
+
+      # Creates an array of help info for all registered routes.
+      def build_help(response)
+        robot.handlers.map do |handler|
+          next unless handler.respond_to?(:routes)
+
+          handler.routes.map do |route|
+            route.help.map do |command, description|
+              if authorized?(response.user, route.required_groups)
+                help_command(route, command, description)
+              end
+            end
+          end
+        end.flatten.compact
+      end
+
+      # Filters the help output by an optional command.
+      def filter_help(output, response)
+        filter = response.matches[0][0]
+
+        if filter
+          output.select { |line| /(?:@?#{name}[:,]?)?#{filter}/i === line }
+        else
+          output
+        end
+      end
+
+      # Formats an individual command's help message.
+      def help_command(route, command, description)
+        command = "#{name}: #{command}" if route.command?
+
+        table_row(command, description)
+      end
+
+      # The way the bot should be addressed in order to trigger a command.
+      def name
+        robot.config.robot.mention_name || robot.config.robot.name
+      end
+    end
+
+    Lita.register_handler(DiscordHelp)
+  end
+end

data/lib/lita-discord_oauth.rb

@@ -1,8 +1,8 @@
-require 'lita'
-
-Lita.load_locales Dir[File.expand_path(
-    File.join('..', '..', 'locales', '*.yml'), __FILE__
-)]
-
-require 'lita/adapters/discord_oauth'
+require 'lita'
+
+Lita.load_locales Dir[File.expand_path(
+    File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
+require 'lita/adapters/discord_oauth'
 require 'lita/handlers/discord_help'