burroughs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41b1d09a717f6c1e14cb4ac30fcea0ae131b1cdd9303d6ee60dcaf33bcb675c9
+  data.tar.gz: 3092fa7fcf632ef316c472a1626f1bd025e1fab36899825b29f7c956e68f1f0a
+SHA512:
+  metadata.gz: 6d4eb3978fe044ab3fb6f4c7c80e1040594615861d7fb48dc9d22c2be762fdc92f89d27615d15ded3b46307fe33c87e6ae2b17c9ded2312d4ced2b77ea2675b9
+  data.tar.gz: 591b6c8938244fe0fe39b1d46a123315f064f8101ccfc00d7cb77a93a780002a81ca827a2c9769aa3c895eecbb446cec0a9787c68add30c2c0b33748c4d18a4f

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in burroughs.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "pry-byebug", group: %i[development test]
+gem "solargraph", group: %i[development test]
+
+gem "activerecord", "~> 7.0"
+gem "discordrb", github: "pinecat/discordrb", ref: "4639880" # afcf50e0
+gem "httparty", "~> 0.21"
+
+# gem "discordrb", github: "shardlab/discordrb", branch: "main" # tag: "v3.4.1" # branch: "main"

data/Gemfile.lock

@@ -0,0 +1,165 @@
+GIT
+  remote: https://github.com/pinecat/discordrb.git
+  revision: 4639880cd326dcc7e39816de29294c952502dcdb
+  ref: 4639880
+  specs:
+    discordrb (3.4.2)
+      discordrb-webhooks (~> 3.4.2)
+      ffi (>= 1.9.24)
+      opus-ruby
+      rest-client (>= 2.0.0)
+      websocket-client-simple (>= 0.3.0)
+    discordrb-webhooks (3.4.2)
+      rest-client (>= 2.0.0)
+
+PATH
+  remote: .
+  specs:
+    burroughs (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    e2mmap (0.1.0)
+    event_emitter (0.2.6)
+    ffi (1.15.5)
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.14.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.6)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    method_source (1.0.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2023.0218.1)
+    mini_mime (1.1.2)
+    minitest (5.18.0)
+    multi_xml (0.6.0)
+    netrc (0.11.0)
+    nokogiri (1.15.2-x86_64-darwin)
+      racc (~> 1.4)
+    opus-ruby (1.0.1)
+      ffi
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbs (2.8.4)
+    regexp_parser (2.8.1)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.52.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    solargraph (0.49.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (~> 2.0)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      rbs (~> 2.0)
+      reverse_markdown (~> 2.0)
+      rubocop (~> 1.38)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.2.2)
+    tilt (2.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.4.2)
+    websocket (1.2.9)
+    websocket-client-simple (0.6.1)
+      event_emitter
+      websocket
+    yard (0.9.34)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  activerecord (~> 7.0)
+  burroughs!
+  discordrb!
+  httparty (~> 0.21)
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  solargraph
+
+BUNDLED WITH
+   2.4.7

data/README.md

@@ -0,0 +1,31 @@
+# Burroughs
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/burroughs`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, 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/[USERNAME]/burroughs.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/burroughs

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "burroughs"
+
+Burroughs.init

data/exe/comp_reset

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require "burroughs"
+require "httparty"
+require "json"
+
+BASE = "https://discord.com/api"
+VERS = "v9"
+
+resp = HTTParty.get("#{BASE}/#{VERS}/applications/#{Burroughs.prefs.appid}/commands",
+                    headers: { Authorization: "Bot #{Burroughs.prefs.token}" })
+if resp.code != 200
+  puts "#{resp.code} #{resp.message}"
+  exit 1
+end
+
+commands = JSON.parse(resp.body)
+
+if commands.size == 0
+  puts "No commands to remove."
+  exit 0
+end
+
+commands.each do |_c|
+  resp = HTTParty.delete("#{BASE}/#{VERS}/applications/#{Burroughs.prefs.appid}/commands/#{_c["id"]}",
+                         headers: { Authorization: "Bot #{Burroughs.prefs.token}" })
+  puts "#{resp.code} #{resp.message} for command #{_c["id"]} (#{_c["name"]})" if resp.code != 204
+end

data/lib/burroughs/commands/commands.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Commands
+  def initialize
+    @cmds = [
+      { name: :ping, desc: "Are you awake?" },
+      { name: :clear, desc: "Clear messages in the current channel (max 100).", params:
+        [
+          { type: "integer", name: "size", desc: "Number of messages to clear.", required: true }
+        ] },
+      { name: :invite, desc: "Generate an invite link.", params:
+        [
+          { type: "string", name: "username", desc: "Automatically PM the invite to the specified user.", required: false }
+        ] }
+    ]
+  end
+
+  def register
+    @cmds.each do |c|
+      if c.params.nil?
+        bot.register_application_command(c.name, c.desc)
+      else
+        bot.register_application_command(c.name, c.desc) do |cmd|
+          c.params.each do |p|
+            cmd.send(type, p.name, p.desc, required: p.required)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/burroughs/util/configurable.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Configurable
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def prefs
+      @prefs ||= Preferences.new
+    end
+
+    def configure
+      yield prefs
+    end
+  end
+
+  class Preferences
+    attr_accessor :token, :appid, :loglevel
+  end
+end

data/lib/burroughs/util/environments.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Environments
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def env
+      @env ||= Environment.new
+    end
+  end
+
+  class Environment
+    attr_reader :type
+
+    def initialize
+      env = ENV.fetch("BURROUGHS_ENV", nil)
+      @type = :development
+
+      @type = if env.nil? || env.empty?
+                :development
+              elsif env == "production"
+                :production
+              elsif env == "test"
+                :test
+              else
+                :development
+              end
+    end
+
+    def production?
+      return true if @type == :production
+
+      false
+    end
+
+    def test?
+      return true if @type == :test
+
+      false
+    end
+
+    def development?
+      return true if @type == :development
+
+      false
+    end
+  end
+end

data/lib/burroughs/version.rb

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

data/lib/burroughs.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "burroughs/version"
+require_relative "burroughs/util/configurable"
+require_relative "burroughs/util/environments"
+
+require "logger"
+require "json"
+require "discordrb"
+
+module Burroughs
+  class Error < StandardError; end
+  include Environments
+  include Configurable
+
+  if env.development? || env.test?
+    require_relative "../preferences"
+  else
+    require_relative "preferences"
+  end
+
+  def self.init
+    Signal.trap("INT") { exit }
+    Signal.trap("TERM") { exit }
+
+    l = Logger.new($stdout)
+    l.level = prefs.loglevel
+    l.debug "hello"
+    l.debug env.type
+
+    bot = Discordrb::Bot.new(token: Burroughs.prefs.token)
+
+    bot.register_application_command(:ping, "Are you awake?")
+    bot.register_application_command(:clear, "Clear messages in the channel (max 100).") do |cmd|
+      cmd.integer("size", "Number of messages to clear.", required: true)
+    end
+
+    bot.application_command(:ping) do |event|
+      travel_time = (Time.now - event.timestamp).round
+      event.respond(content: "I'm awake and only `#{travel_time}ms` away.")
+    end
+
+    bot.application_command(:clear) do |event|
+      n = event.options["size"]
+      messages = event.channel.history(n)
+      # event.channel.prune(n) # TODO: For some reason, this is getting rate limited, but our workaround is fine for now
+
+      messages.each do |m|
+        m.delete
+      end
+
+      n == 1 ? event.respond(content: "Cleared #{n} message.") : event.respond(content: "Cleared #{n} messages.")
+
+      sleep 4
+      event.interaction.delete_response
+    end
+
+    bot.run
+  ensure
+    bot.stop if bot&.connected?
+    l.close
+  end
+end

data/sig/burroughs.rbs

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

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: burroughs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rory Dudley
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-19 00:00:00.000000000 Z
+dependencies: []
+description: Swiss army knife Discord bot for The Sanctuary.
+email:
+- rory.dudley@gmail.com
+executables:
+- burroughs
+- comp_reset
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- exe/burroughs
+- exe/comp_reset
+- lib/burroughs.rb
+- lib/burroughs/commands/commands.rb
+- lib/burroughs/util/configurable.rb
+- lib/burroughs/util/environments.rb
+- lib/burroughs/version.rb
+- sig/burroughs.rbs
+homepage: https://github.com/the-sanctuary/burroughs
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/the-sanctuary/burroughs
+  source_code_uri: https://github.com/the-sanctuary/burroughs
+  changelog_uri: https://github.com/the-sanctuary/burroughs
+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.7
+signing_key:
+specification_version: 4
+summary: Burroughs Discord bot.
+test_files: []