rack-discord-interactions 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 435c7c929ceff26f1a4732aa8523f8c2e4a1fcf9778aebe613b8164a6b409fa5
+  data.tar.gz: fddf51ea31325b46541d2458f7fbcbc9159255e88b81f8822051aef20ff2624f
+SHA512:
+  metadata.gz: fa4262c1dcf88ce62d3745bcc03395e22f21bc15df5bfe291dc38a4701e730c4430a88a9e58d1f33fe116b5a1ea4d2909b3189005e64f3525771ec40f9fa6814
+  data.tar.gz: e941cc74240f9defbb678160b2389b3942cd5ce0eecf49721cbf01fa4fed7169f82315a66ae0fdd0536b3272b339ef9ed12330d297648f4edb7988a6e957424b

data/.github/workflows/rspec.yml

@@ -0,0 +1,29 @@
+name: RSpec
+
+on:
+  push:
+    paths-ignore:
+      - "**.md"
+  pull_request:
+    paths-ignore:
+      - "**.md"
+
+jobs:
+  rspec:
+    strategy:
+      matrix:
+        os: [ ubuntu-20.04, macos-10.15, windows-2019 ]
+        ruby: [ 2.5, 2.7, 3.0 ]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run RSpec
+      run: bundle exec rake

data/.github/workflows/rubocop.yml

@@ -0,0 +1,24 @@
+name: Rubocop
+
+on:
+  push:
+    paths-ignore:
+      - "**.md"
+  pull_request:
+    paths-ignore:
+      - "**.md"
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.5.0
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run Rubocop
+      run: bundle exec rubocop -c .rubocop.yml -P

data/.github/workflows/yard.yml

@@ -0,0 +1,32 @@
+ame: YARD
+
+on:
+  push:
+    paths-ignore:
+      - "*.gemspec"
+      - "CHANGELOG.md"
+      - ".rubocop.yml"
+      - ".rspec"
+      - "Rakefile"
+  pull_request:
+    paths-ignore:
+      - "*.gemspec"
+      - "CHANGELOG.md"
+      - ".rubocop.yml"
+      - ".rspec"
+      - "Rakefile"
+
+jobs:
+  yard:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.5.0
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run YARD
+      run: bundle exec yard doc

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+inherit_mode:
+  merge:
+    - AllowedNames
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+
+Naming/FileName:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '*.gemspec'
+    - 'spec/**/*.rb'
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/FilePath:
+  Enabled: false

data/.yardopts

@@ -0,0 +1,3 @@
+--fail-on-warning
+-
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2021-03-12
+### Added
+- Initial release
+
+[Unreleased]: https://github.com/shardlab/rack-discord-interactions/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/shardlab/rack-discord-interactions/releases/tag/v1.0.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at matthew.b.carey@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-slash-commands.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Matthew Carey
+
+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,57 @@
+# Rack::DiscordInteractions
+
+Middleware to handle signature verification for Discord Interaction HTTP requests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-discord-interactions'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rack-discord-interactions
+
+## Usage
+
+```ruby
+require 'sinatra'
+require 'rack/discord-interactions'
+require 'json'
+
+use Rack::DiscordInteractions::Verifier, ENV['INTERACTIONS_PUBLIC_KEY'], path: '/interactions'
+
+post '/interactions' do
+  body = JSON.parse(request.body.read)
+
+  case body['type']
+  when 2 # COMMAND
+    { type: 5 }.to_json
+  else
+    halt 400, 'Invalid type'
+  end
+end
+```
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shardlab/rack-discord-interactions. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/shardlab/rack-discord-interactions/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rack::Slash::Commands project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shardlab/rack-discord-interactions/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rack/slash/commands'
+
+# 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(__FILE__)

data/bin/setup

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

data/example/config.ru

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rack/discord-interactions'
+require 'json'
+
+# App to process interaction requests
+module Interactions
+  def self.call(env)
+    body = JSON.parse(env['rack.input'].read)
+
+    case body['type']
+    when 2 # COMMAND
+      [200, { 'Content-Type' => 'application/json' }, ['{"type": 5}']]
+    else
+      [400, { 'Content-Type' => 'text/plain' }, ['Invalid type']]
+    end
+  end
+end
+
+app = Rack::Builder.app do
+  map '/interactions' do
+    use Rack::DiscordInteractions::Verifier, ENV['INTERACTIONS_PUBLIC_KEY']
+
+    run Interactions
+  end
+end
+
+run app

data/example/sinatra.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'sinatra'
+require 'rack/discord-interactions'
+require 'json'
+
+use Rack::DiscordInteractions::Verifier, ENV['INTERACTIONS_PUBLIC_KEY'], path: '/interactions'
+
+post '/interactions' do
+  body = JSON.parse(request.body.read)
+
+  case body['type']
+  when 2 # COMMAND
+    { type: 5 }.to_json
+  else
+    halt 400, 'Invalid type'
+  end
+end

data/lib/rack/discord-interactions.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'rack/discord-interactions/verifier'

data/lib/rack/discord-interactions/verifier.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'ed25519'
+require 'json'
+
+module Rack
+  # Discord interaction middleware collection
+  module DiscordInteractions
+    # Middleware to handle verification of interaction signatures
+    class Verifier
+      # @!visibility private
+      MISSING_HEADERS = [400, {}, ['Missing headers']].freeze
+
+      # @!visibility private
+      PONG = [200, { 'Content-Type' => 'application/json' }, ['{"type":1}']].freeze
+
+      # @!visibility private
+      INVALID_SIGNATURE = [401, {}, ['Invalid request signature']].freeze
+
+      # @param app [#call] The rack app, or an object that responds to `#call`.
+      # @param public_key [String] The public key of the application.
+      # @param path [String] Path to verify, will verify all requests if `nil`.
+      # @param handle_pings [true, false] Whether the middleware should automatically handle responding to pings.
+      def initialize(app, public_key, path: nil, handle_pings: true)
+        @app = app
+        @verify_key = Ed25519::VerifyKey.new([public_key].pack('H*'))
+        @path = path
+        @handle_pings = handle_pings
+      end
+
+      # @!visibility private
+      # @param env [Hash]
+      def call(env)
+        if env['PATH_INFO'] == @path || @path.nil?
+          request = Rack::Request.new(env)
+          verify(request)
+        else
+          @app.call(env)
+        end
+      end
+
+      # @!visibility private
+      # @param request [Rack::Request]
+      def verify(request)
+        timestamp = request.get_header('HTTP_X_SIGNATURE_TIMESTAMP')
+        signature = request.get_header('HTTP_X_SIGNATURE_ED25519')
+        body = request.body.read
+
+        return MISSING_HEADERS unless timestamp && signature
+
+        @verify_key.verify([signature].pack('H*'), timestamp + body)
+        request.body.rewind
+
+        return PONG if @handle_pings && JSON.parse(body)['type'] == 1
+
+        @app.call(request.env)
+      rescue ArgumentError, Ed25519::VerifyError
+        INVALID_SIGNATURE
+      end
+    end
+  end
+end

data/lib/rack/discord-interactions/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Rack namespace
+module Rack
+  module DiscordInteractions
+    # @!visibility private
+    VERSION = '1.0.0'
+  end
+end

data/rack-discord-interactions.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rack/discord-interactions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-discord-interactions'
+  spec.version       = Rack::DiscordInteractions::VERSION
+  spec.authors       = ['Matthew Carey']
+  spec.email         = ['matthew.b.carey@gmail.com']
+
+  spec.summary       = 'Rack middleware for Discord Interactions.'
+  spec.description   = 'Rack middleware for Discord Interaction validation.'
+  spec.homepage      = 'https://github.com/shardlab/rack-discord-interactions'
+  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/shardlab/rack-discord-interactions'
+  spec.metadata['changelog_uri'] = 'https://github.com/shardlab/rack-discord-interactions/blob/main/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_dependency 'ed25519', '>= 1.0.0', '< 2.0.0'
+  spec.add_dependency 'rack', '>= 2.0.0', '< 3.0.0'
+  spec.add_development_dependency 'rake', '~> 13.0.3'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency 'rubocop', '~> 1.9.1'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.9.2'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.2.0'
+  spec.add_development_dependency 'yard', '~> 0.9.26'
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: rack-discord-interactions
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthew Carey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+description: Rack middleware for Discord Interaction validation.
+email:
+- matthew.b.carey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".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.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/config.ru
+- example/sinatra.rb
+- lib/rack/discord-interactions.rb
+- lib/rack/discord-interactions/verifier.rb
+- lib/rack/discord-interactions/version.rb
+- rack-discord-interactions.gemspec
+homepage: https://github.com/shardlab/rack-discord-interactions
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shardlab/rack-discord-interactions
+  source_code_uri: https://github.com/shardlab/rack-discord-interactions
+  changelog_uri: https://github.com/shardlab/rack-discord-interactions/blob/main/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.1.4
+signing_key: 
+specification_version: 4
+summary: Rack middleware for Discord Interactions.
+test_files: []