vox 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4525b927b8d1067a91aa3062e4d72674958b11c4aa216a290824262a359c21eb
+  data.tar.gz: 7dac51047015695c88c46113cdd78424c483bada9456f068f96169645001381a
+SHA512:
+  metadata.gz: 99abfab082caef047c4e244ef345353f5b98db418b1f1477abaa07c8bceab883e256045e039dd5d9850c2ebe2b8089b7bd9d57386db51c2df9daba1d2b5062f8
+  data.tar.gz: d760f0c0e5df2edc43ea4b17e0e3fabeccfa557cbd69def6963733177a5ab9b68a889a25ff857caaa978ac96cabd649fe00e6ac8428dd9728e593b8c1da1a0c5

data/.github/workflows/deploy_docs.yml

@@ -0,0 +1,39 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - v*
+    paths-ignore:
+      - "vox.gemspec"
+      - "CHANGELOG.md"
+      - ".rubocop.yml"
+      - ".rspec"
+      - "Rakefile"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.0
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Run YARD
+        run: bundle exec yard --output-dir docs
+      - name: Extract branch name
+        shell: bash
+        run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+        id: extract_branch
+      - name: Deploy to gh-pages
+        uses: peaceiris/actions-gh-pages@v3.7.0-8
+        with:
+          personal_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs
+          destination_dir: ${{ steps.extract_branch.outputs.branch }}

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.6.6, 2.7 ]
+    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.7.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 @@
+name: YARD
+
+on:
+  push:
+    paths-ignore:
+      - "vox.gemspec"
+      - "CHANGELOG.md"
+      - ".rubocop.yml"
+      - ".rspec"
+      - "Rakefile"
+  pull_request:
+    paths-ignore:
+      - "vox.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.7.0
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run YARD
+      run: bundle exec yard doc

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - bin/*
+    - vendor/**/*
+  NewCops: enable
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+RSpec/FilePath:
+  SpecSuffixOnly: true
+
+Metrics:
+  Enabled: false

data/.yardopts

@@ -0,0 +1,4 @@
+--tag vox.permissions:"Required Permissions"
+--tag vox.api_docs:"View On Discord's Docs"
+--tag vox.oauth_scope:"Required OAuth2 Scope"
+--main README.md

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 vox.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © `2020` `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,44 @@
+# Vox
+
+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/vox`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vox'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install vox
+
+## 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 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/swarley/vox. 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/swarley/vox/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 Vox project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/swarley/vox/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--format progress'
+  t.verbose = false
+end
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: :spec

data/lib/vox.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'vox/version'
+
+# Parent module containing all component pieces
+module Vox
+  # Catch all error for all Vox error subclasses
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/vox/http/client.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'logging'
+require 'securerandom'
+# require 'vox/http/routes/audit_log'
+# require 'vox/http/routes/channel'
+# require 'vox/http/routes/emoji'
+# require 'vox/http/routes/guild'
+# require 'vox/http/routes/invite'
+# require 'vox/http/routes/user'
+# require 'vox/http/routes/voice'
+# require 'vox/http/routes/webhook'
+require 'vox/http/route'
+require 'vox/http/routes'
+require 'vox/http/error'
+require 'vox/http/middleware'
+
+module Vox
+  # The HTTP component used to interact with the REST portion of the API.
+  # Contains a client, as well as modular paths if you wish to provide your own client
+  # with support for the same `request` method signature.
+  module HTTP
+    # HTTP Client for interacting with the REST portion of the Discord API
+    class Client
+      # include AuditLog
+      # include Channel
+      # include Emoji
+      # include Guild
+      # include Invite
+      # include User
+      # include Voice
+      # include Webhook
+      include Routes
+
+      # @!visibility private
+      attr_reader :conn
+
+      # TODO: Maybe fallback to extrapolating the key from URLs so we
+      # can expose the connection for use outside of our request function?
+
+      # Discord REST API version.
+      API_VERSION = '8'
+
+      # Base URL to base endpoints off of.
+      API_BASE = "https://discord.com/api/v#{API_VERSION}/"
+
+      # Headers that form the base for every request.
+      DEFAULT_HEADERS = {
+        'User-Agent': "DiscordBot (https://github.com/swarley/vox, #{Vox::VERSION})"
+      }.freeze
+
+      def initialize(token)
+        @conn = default_connection
+        @conn.authorization('Bot', token.delete_prefix('Bot '))
+        yield(@conn) if block_given?
+      end
+
+      # Run a request
+      # @param query [Hash<String, String>, nil] Query string parameters.
+      # @param data [Hash<(String, Integer), (String, #content_type)>, String, nil] HTTP body for non-JSON payloads.
+      # @param json [Hash, nil] Object that will be serialized to JSON for requests.
+      # @param raw [true, false] Whether or not the response body should be parsed from
+      #   JSON.
+      # @param reason [String, nil] Reason for use in paths that support audit log reasons.
+      # @return [Hash, nil] The response body serialized to a Hash, or nil when a route returns 204.
+      def request(route, query: nil, data: nil, json: nil, raw: nil, reason: nil)
+        req = @conn.build_request(route.verb) do |r|
+          setup_basic_request(r, route, query: query, reason: reason)
+
+          if json
+            r.body = MultiJson.dump(json)
+            r.headers['Content-Type'] = 'application/json'
+          elsif data
+            r.body = data
+          end
+        end
+
+        begin
+          resp = @conn.builder.build_response(@conn, req)
+          handle_response(resp, raw, req.options.context[:trace])
+        rescue Error::TooManyRequests
+          retry
+        end
+      end
+
+      # @!visibility private
+      # Hide the big instance variables
+      def inspect
+        "#<Vox::HTTP::Client:0x#{object_id.to_s(16).rjust(16, '0')}>"
+      end
+
+      private
+
+      # @param req [Faraday::Request] Request to be executed
+      # @param route [Vox::HTTP::Route]
+      # @param query [Hash<String, String>, nil]
+      # @param reason [String, nil]
+      def setup_basic_request(req, route, query: nil, reason: nil)
+        req.path = route.format.delete_prefix('/')
+        req.params = query unless query.nil? || query.empty?
+        req.headers['X-Audit-Log-Reason'] = reason if reason
+        req.options.context = { rl_key: route.rl_key, trace: SecureRandom.alphanumeric(6) }
+      end
+
+      # @param resp [Faraday::Response] The response to be processed.
+      def handle_response(resp, raw, req_id)
+        raise Error::ServerError.new(req_id) if (500..600).cover? resp.status
+
+        data = raw ? resp.body : MultiJson.load(resp.body, symbolize_keys: true)
+        case resp.status
+        when 200
+          data
+        when 204, 304
+          nil
+        when 400
+          raise Error::BadRequest.new(data, req_id)
+        when 401
+          raise Error::Unauthorized.new(data, req_id)
+        when 403
+          raise Error::Forbidden.new(data, req_id)
+        when 404
+          raise Error::NotFound.new(data, req_id)
+        when 405
+          raise Error::MethodNotAllowed.new(data, req_id)
+        when 429
+          raise Error::TooManyRequests.new(data, req_id)
+        end
+      end
+
+      # A default connection used when you're not passing your own
+      # @return [Faraday::Connection]
+      def default_connection
+        Faraday.new(url: API_BASE, headers: DEFAULT_HEADERS) do |faraday|
+          faraday.use :vox_ratelimiter
+          faraday.request :multipart
+          faraday.response(
+            :logger,
+            Logging.logger['Vox::HTTP'],
+            { formatter: Vox::HTTP::Middleware::LogFormatter }
+          )
+        end
+      end
+    end
+  end
+end