caldera 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dddc27f9f168e2f9269f622c5e1e955f7f184847f4783b9f46b471893720d373
+  data.tar.gz: 187ec6f7659d4539b8fe54bfe2a53375f321152f6c85dccdc1a71209841508b6
+SHA512:
+  metadata.gz: 756487015dd81817229f34e5b849d5e77e9d5ede6916f40f1ac56b560e945ce5b4d112f4873b025bdbd9168d6d235bf4c4ee436d71a43366c6903afb8ca822c9
+  data.tar.gz: 2b93ac69880a1f26c353fb18b34bd07ee7a91e1468752d1c49c76ad9026ba7782d99845d2fd5f7d5a28f152c0413fd1c2ff987d42c60c743ad8bb12d1d45bd4b

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

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 TODO: Write your email address. 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 caldera.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 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 @@
+# Caldera
+
+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/caldera`. 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 'caldera'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install caldera
+
+## 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/caldera. 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/caldera/blob/main/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 Caldera project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/swarley/caldera/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'yard/rake/yardoc_task'
+
+task default: :build
+
+YARD::Rake::YardocTask.new(:yard)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "caldera"
+
+# 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/caldera.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/caldera/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'caldera'
+  spec.version       = Caldera::VERSION
+  spec.authors       = ['Matthew Carey']
+  spec.email         = ['matthew.b.carey@gmailcom']
+
+  spec.summary       = 'Lavalink client'
+  spec.description   = 'Lavalink client for use with Discord libraries.'
+  spec.homepage      = 'https://github.com/swarley/caldera'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/swarley/caldera/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_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rubocop', '~> 0.93.1'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.8'
+  spec.add_development_dependency 'yard', '~> 0.9.25'
+
+  spec.add_dependency 'event_emitter', '~> 0.2.6'
+  spec.add_dependency 'logging', '~> 2.3'
+  spec.add_dependency 'permessage_deflate', '~> 0.1.4'
+  spec.add_dependency 'websocket-driver', '~> 0.7.3'
+end

data/lib/caldera.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'caldera/client'
+require 'caldera/version'

data/lib/caldera/client.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'caldera/node'
+require 'logging'
+require 'timeout'
+
+module Caldera
+  class Client
+    LOGGER = Logging.logger[self]
+
+    # @return [String]
+    attr_reader :num_shards
+
+    # @return [String]
+    attr_reader :user_id
+
+    # @return [Array<Player>]
+    attr_reader :players
+
+    # @return [Array<Node>]
+    attr_reader :nodes
+
+    # @param [Integer, String] num_shards
+    # @param [Integer, String] user_id
+    # @param [Proc<String, String>] connect
+    def initialize(num_shards:, user_id:, connect: nil)
+      @num_shards = num_shards.to_s
+      @user_id = user_id.to_s
+      @players = {}
+      @connect_proc = connect
+      @nodes = []
+      @voice_state_mutex = Mutex.new
+      @voice_states = Hash.new { |h, guild_id| h[guild_id] = {} }
+    end
+
+    # @param [Integer, String] guild_id
+    # @param [Integer, String] channel_id
+    # @param [Number] timeout
+    # @return [Caldera::Player]
+    def connect(guild_id, channel_id, timeout: nil)
+      return Timeout.timeout(timeout) { connect(guild_id, channel_id) } if timeout
+
+      gid = guild_id.to_s
+
+      return @players[gid] if @players[gid]
+
+      @connect_proc.call(gid, channel_id.to_s)
+      sleep 0.05 until @players[gid]
+
+      @players[gid]
+    end
+
+    def update_voice_state(guild_id, session_id: nil, event: nil)
+      guild_id = guild_id.to_s
+      @voice_state_mutex.synchronize do
+        @voice_states[guild_id][:session_id] = session_id if session_id
+        @voice_states[guild_id][:event] = event if event
+      end
+
+      state = @voice_states[guild_id]
+
+      if state[:session_id] && state[:event]
+        LOGGER.info { "Creating player for #{guild_id}" }
+        best_node.create_player(guild_id, state[:session_id], state[:event])
+        @voice_states.delete(guild_id)
+      else
+        LOGGER.debug { "Recieved partial info for creating player for #{guild_id}: #{state}" }
+      end
+    end
+
+    def add_node(authorization:, uri: nil, rest_uri: nil, ws_uri: nil)
+      uri = URI(uri) unless uri.is_a?(URI::Generic)
+      rest_uri ||= uri.clone.tap { |u| u.scheme = 'http' }
+      ws_uri ||= uri.clone.tap { |u| u.scheme = 'ws' }
+
+      new_node = Node.new(rest_uri, ws_uri, authorization, self)
+      new_node.start
+
+      @nodes << new_node
+    end
+
+    def remove_node(node)
+      @nodes.delete(node)
+      node.stop
+    end
+
+    def best_node
+      @nodes.min { |n| n.stats['cpu']['systemLoad'] }
+    end
+
+    def get_player(guild_id)
+      @players[guild_id.to_s]
+    end
+
+    # TODO: load balacing stuff
+  end
+end

data/lib/caldera/events.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'caldera/model'
+
+module Caldera
+  module Events
+    class TrackStart
+      attr_reader :track, :player
+
+      def initialize(data, player)
+        @player = player
+        @track = Caldera::Model::Track.from_b64(data['track'])
+      end
+    end
+
+    class TrackEnd
+      attr_reader :reason, :guild_id, :track, :player
+
+      def initialize(data, player)
+        @player = player
+        @reason = data['reason'].to_sym
+        @guild_id = data['guildId']
+        @track = Caldera::Model::Track.from_b64(data['track'])
+      end
+    end
+
+    class TrackException
+      attr_reader :player, :error, :track
+
+      def initialize(data, player)
+        @player = player
+        @error = data['error']
+        @track = Caldera::Model::Track.from_b64(data['track'])
+      end
+    end
+
+    class TrackStuck
+      attr_reader :player, :threshold, :track
+
+      def initialize(data, player)
+        @player = player
+        @threshold = data['thresholdMs']
+        @track = Caldera::Model::Track.from_b64(data['track'])
+      end
+    end
+
+    class WebSocketClosed
+      # @returns [String]
+      attr_reader :guild_id
+
+      # @returns [Integer]
+      attr_reader :code
+
+      # @returns [String]
+      attr_reader :reason
+
+      # @returns [true, false]
+      attr_reader :by_remote
+      alias by_remote? by_remote
+
+      def initialize(data, _player)
+        @guild_id = data['guildId']
+        @code = data['code']
+        @reason = data['reason']
+        @by_remote = data['byRemote']
+      end
+    end
+
+    class StatsEvent
+      Memory = Struct.new('Memory', :reservable, :used, :free, :allocated, keyword_init: true)
+      Cpu = Struct.new('Cpu', :cores, :system_load, :lavalink_load, :uptime, keyword_init: true)
+
+      attr_reader :playing_players, :memory, :cpu, :uptime
+
+      def initialize(data, _node)
+        @playing_players = data['playingPlayers']
+        @memory = Memory.new(**data['memory'])
+
+        cpu_data = data['cpu']
+        snake_case_data = {
+          cores: cpu_data['cores'],
+          system_load: cpu_data['systemLoad'],
+          lavalink_load: cpu_data['lavalinkLoad']
+        }
+        @cpu = Cpu.new(**snake_case_data)
+        @uptime = data['uptime']
+      end
+    end
+
+    class PlayerUpdateEvent
+      attr_reader :player, :time, :position
+
+      def initialize(data, player)
+        @player = player
+        @time = Time.at(data['time'])
+        @position = data['position']
+      end
+    end
+  end
+end

data/lib/caldera/model.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'caldera/model/load_tracks'
+require 'caldera/model/playlist_info'
+require 'caldera/model/track'

data/lib/caldera/model/load_tracks.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Caldera
+  module Model
+    # Represents the struct returned from {Client#load_tracks}
+    class LoadTracks
+      include Enumerable
+
+      # @return [PlaylistInfo]
+      attr_reader :playlist_info
+
+      # @return [Array<Track>]
+      attr_reader :tracks
+
+      # @return [:TRACK_LOADED, :PLAYLIST_LOADED, :SEARCH_RESULT, :NO_MATCHES, :LOAD_FAILED]
+      attr_reader :load_type
+
+      def initialize(data)
+        playlist_info = data['playlistInfo']
+
+        @playlist_info = PlaylistInfo.new(playlist_info) if playlist_info
+        @tracks = data['tracks'].collect { |track_data| Model::Track.new(track_data) }
+        @load_type = data['loadType'].to_sym
+      end
+
+      # Operate on each track.
+      # @yieldparam [Track]
+      def each(&block)
+        @tracks.each(&block)
+      end
+    end
+  end
+end

data/lib/caldera/model/playlist_info.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Caldera
+  module Model
+    # Information about a playlist loaded through {Client#load_tracks}
+    class PlaylistInfo
+      # @return [String]
+      attr_reader :name
+
+      # @return [Integer]
+      attr_reader :selected_track
+
+      def initialize(data)
+        @selected_track = data['selectedTrack']
+        @name = data['name']
+      end
+    end
+  end
+end

data/lib/caldera/model/track.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module Caldera
+  module Model
+    class Track
+      # @param [String] Base64 representation of the track
+      attr_reader :track_data
+
+      # @param [String] The track identifier
+      attr_reader :identifier
+
+      # @param [true, false]
+      attr_reader :seekable
+
+      # @param [String] The track author.
+      attr_reader :author
+
+      # @param [Integer] Length in milliseconds.
+      attr_reader :length
+
+      # @param [true, false]
+      attr_reader :stream
+
+      # @param [Integer] The current position in milliseconds.
+      attr_reader :position
+
+      # @param [String] The track title.
+      attr_reader :title
+
+      # @param [String] The URI to the track source.
+      attr_reader :uri
+
+      def initialize(data)
+        # track_data could maybe use a better name. It's
+        # a base64 representation of a binary data representation
+        # of a track=
+        @track_data = data['track']
+
+        info = data['info']
+        @identifier = info['identifier']
+        @seekable = info['isSeekable']
+        @author = info['author']
+        @length = info['length']
+        @stream = info['isStream']
+        @position = info['position']
+        @title = info['title']
+        @uri = info['uri']
+        @source = info['source']
+      end
+
+      # Decode a track from base64 track data.
+      # @param [String] b64_data Base64 encoded track data, recieved from the Lavalink server.
+      def self.from_b64(b64_data)
+        data = Base64.decode64(b64_data)
+        flags, version = data.unpack('NC')
+
+        raise 'Unsupported track data' if (flags >> 30) != 1
+
+        # This is gross but it's easier than not doing it
+        case version
+        when 1
+          title, author, length, identifier, is_stream, source = data.unpack('@7Z*xZ*Q>xZ*CxZ*')
+          Track.new(
+            'track' => b64_data,
+            'info' => {
+              'title' => title,
+              'author' => author,
+              'length' => length,
+              'identifier' => identifier,
+              'isStream' => is_stream == 1,
+              'source' => source
+            }
+          )
+        when 2
+          title, author, length, identifier, is_stream, uri, source = data.unpack('@7Z*xZ*Q>xZ*CxxZ*xZ*xZ*')
+          Track.new(
+            'track' => b64_data,
+            'info' => {
+              'title' => title,
+              'author' => author,
+              'length' => length,
+              'identifier' => identifier,
+              'isStream' => is_stream == 1,
+              'source' => source,
+              'uri' => uri
+            }
+          )
+        else
+          raise 'Unsupported track version'
+        end
+      end
+    end
+  end
+end

data/lib/caldera/node.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'caldera/model'
+require 'caldera/player'
+require 'caldera/websocket'
+require 'event_emitter'
+require 'net/http'
+
+module Caldera
+  class Node
+    LOGGER = Logging.logger[self]
+
+    include EventEmitter
+
+    # @return [Caldera::Client]
+    attr_reader :client
+
+    # @return [Caldera::WebSocket]
+    attr_reader :websocket
+
+    # @return [Net::HTTP]
+    attr_reader :http
+
+    # @return [Caldera::Model::Stats]
+    attr_reader :stats
+
+    def initialize(rest_uri, ws_uri, auth, client)
+      @client = client
+      @authorization = auth
+      @websocket = WebSocket.new(ws_uri, auth, @client.num_shards, @client.user_id)
+      register_handlers
+      @stats = nil
+      @available = false
+      @http = Net::HTTP.new(rest_uri.host, rest_uri.port)
+    end
+
+    def start
+      LOGGER.info { "Connecting to #{@websocket.url}" }
+      @websocket.start
+    end
+
+    def stop
+      LOGGER.info { "Disconnecting from #{@websocket.url}" }
+      @websocket.close
+    end
+
+    def create_player(guild_id, session_id, event)
+      LOGGER.info { "Creating player for #{guild_id}" }
+      @websocket.send_json({
+                             op: :voiceUpdate,
+                             guildId: guild_id,
+                             sessionId: session_id,
+                             event: event
+                           })
+
+      player = Player.new(guild_id, self, client)
+      @client.players[guild_id] = player
+    end
+
+    def load_tracks(id)
+      resp = get('/loadtracks', query: { identifier: id })
+      Model::LoadTracks.new(resp)
+    end
+
+    def youtube_search(search_string)
+      load_tracks("ytsearch:#{search_string}")
+    end
+
+    def soundcloud_search(search_string)
+      load_tracks("scsearch:#{search_string}")
+    end
+
+    def send_json(data)
+      @websocket.send_json(data)
+    end
+
+    private
+
+    def register_handlers
+      @websocket.on(:playerUpdate, &method(:handle_player_update))
+      @websocket.on(:stats, &method(:handle_stats))
+      @websocket.on(:event, &method(:handle_event))
+      @websocket.on(:open) { @available = true }
+      @websocket.on(:close) { @available = false }
+    end
+
+    def handle_player_update(data)
+      @client.get_player(data['guildId']).state = data['state']
+    end
+
+    def handle_stats(data)
+      data_without_op = data.clone
+      data_without_op.delete('op')
+      @stats = data_without_op
+
+      emit(:stats_update, Events::StatsEvent.new(data, self))
+    end
+
+    def handle_event(data)
+      type = transform_type(data['type'])
+      emit(type, data)
+    end
+
+    def transform_type(type)
+      (type[0] + type[1..-1].sub(/Event$/, '').gsub(/([A-Z])/, '_\1')).downcase
+    end
+
+    def get(path, query: {})
+      req_path = "#{path}?#{URI.encode_www_form(query)}"
+      resp = @http.get(req_path, { Authorization: @authorization })
+
+      case resp.code.to_i
+      when 200...300
+        JSON.load(resp.body)
+      else
+        # TODO
+        resp.error!
+      end
+    end
+  end
+end

data/lib/caldera/player.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require 'caldera/model'
+require 'caldera/events'
+require 'event_emitter'
+require 'logging'
+
+module Caldera
+  class Player
+    include EventEmitter
+
+    # @visibility private
+    LOGGER = Logging.logger[self]
+
+    # @return [String]
+    attr_reader :guild_id
+
+    # @return [Node] The node that owns this player.
+    attr_reader :node
+
+    # @return [Client]
+    attr_reader :client
+
+    # @return [Integer]
+    attr_reader :volume
+
+    # @return [true, false]
+    attr_reader :paused
+
+    # @return [Integer]
+    attr_reader :position
+
+    # @return [Time]
+    attr_reader :time
+
+    # @return [Track]
+    attr_reader :track
+    alias now_playing track
+    
+    def initialize(guild_id, node, client)
+      @guild_id = guild_id
+      @node = node
+      @client = client
+      @volume = 100
+      @paused = false
+      @position = 0
+      @time = 0
+
+      register_node_handlers
+    end
+
+    # Play a track.
+    # @param [String, Track] Either a base64 encoded track, or a {Track} object.
+    # @param [Integer] start_time The time in milliseconds to begin playback at.
+    # @param [Integer] end_time The time in milliseconds to end at.
+    def play(track, start_time: 0, end_time: 0)      
+      @paused = false
+      @track = track
+      
+      send_packet(:play, {
+         track: track.is_a?(Model::Track) ? track.track_data : track,
+         startTime: start_time,
+         endTime: end_time,
+         noReplace: false
+      })
+    end
+
+    # Pause playback.
+    def pause
+      send_packet(:pause, {
+        pause: true
+      })
+    end
+
+    # Resume the player.
+    def unpause
+      send_packet(:pause, {
+        pause: false
+      })
+    end
+
+    # Seek to a position in the track.
+    # @param [Integer] position The position to seek to, in milliseconds.
+    def seek(position)
+      send_packet(:seek, {
+        position: position
+      })
+    end
+
+    # Set the volume of the player
+    # @param [Integer] level A value between 0 and 1000.
+    def volume(level)
+      send_packet(:volume, {
+        volume: level.clamp(0, 1000)
+      })
+    end
+
+    # Adjust the gain of bands.
+    # @example
+    #   player.equalizer(1 => 0.25, 5 => -0.25, 10 => 0.0)
+    def equalizer(**bands)
+      send_packet(:equalizer, {
+        bands: bands.collect do |band,gain| 
+          { band: band.to_i, gain: gain.to_f }
+        end
+      })
+    end
+
+    # Destroy this player
+    def destroy
+      send_packet(:destroy)
+    end
+
+    # @visibility private
+    def state=(new_state)
+      @time = Time.at(new_state['time'])
+      @position = new_state['position']
+    end
+
+    # See Node#load_tracks
+    def load_tracks(...)
+      @node.load_tracks(...)
+    end
+
+    private
+
+    def send_packet(op, data={})
+    packet = { op: op, guildId: guild_id }.merge(data)
+    LOGGER.debug { "Sending packet to node: #{packet}"}
+      @node.send_json(packet)
+    end
+
+    def register_node_handlers
+      node.on(:track_start, &method(:handle_track_start))
+      node.on(:track_end, &method(:handle_track_end))
+      node.on(:track_exception, &method(:handle_track_exception))
+      node.on(:track_stuck, &method(:handle_track_stuck))
+      node.on(:websocket_closed, &method(:handle_websocket_closed))
+    end
+
+    def handle_track_start(data)
+      LOGGER.debug { "Track started for #{@guild_id}" }
+      emit(:track_start, Events::TrackStart.new(data, self))
+    end
+
+    def handle_track_end(data)
+      LOGGER.debug { "Track ended for #{@guild_id}" }
+
+      @track = nil
+      emit(:track_end, Events::TrackEnd.new(data, self))
+    end
+
+    def handle_track_exception(data)
+      LOGGER.debug { "Track exception for #{@guild_id}" }
+      @track = nil
+      emit(:track_exception, Events::TrackException.new(data, self))
+    end
+
+    def handle_track_stuck(data)
+      LOGGER.debug { "Track stuck for #{@guild_id}" }
+      @track = nil
+      emit(:track_stuck, Events::TrackStuck.new(data, self))
+    end
+
+    def handle_websocket_closed(data)
+      LOGGER.warn { "WebSocket closed for #{@guild_id}" }
+      @track = nil
+      emit(:websocket_closed, Events::WebSocketClosed.new(data, self))
+    end
+  end
+end

data/lib/caldera/version.rb

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

data/lib/caldera/websocket.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'websocket/driver'
+require 'permessage_deflate'
+require 'socket'
+require 'uri'
+require 'logging'
+require 'event_emitter'
+require 'json'
+
+module Caldera
+  class WebSocket
+    include EventEmitter
+
+    attr_reader :thread, :uri
+
+    LOGGER = Logging.logger[self]
+
+    # Create a WebSocket that connects to the Lavalink server.
+    # @param [URI, String] uri The URI to connect with. (ex: `"ws://localhost:8080"`)
+    # @param [String] authorization Password matching the server config.
+    # @param [Integer] num_shards Total number of shards your bot is operating on.
+    # @param [String, Integer] user_id The user ID of the bot you are playing music with.
+    # @caldera.lavalink_docs https://github.com/Frederikam/Lavalink/blob/master/IMPLEMENTATION.md#opening-a-connection
+    def initialize(uri, authorization, num_shards, user_id)
+      @uri = uri.is_a?(URI::Generic) ? uri : URI.parse(uri)
+      @uri.scheme = 'ws'
+
+      create_driver
+      set_headers(authorization, num_shards, user_id)
+      register_handlers
+    end
+
+    # Start the connection to the Lavalink server.
+    def start
+      LOGGER.info { "Opening connection to #{url}" }
+      @tcp  = TCPSocket.new(@uri.host || localhost, @uri.port)
+      @dead = false
+      create_thread
+
+      @driver.start
+      LOGGER.info { 'Driver started' }
+    end
+
+    # Encode a hash to json, and send it over the websocket.
+    # @param [Hash] message
+    def send_json(message)
+      LOGGER.debug { "Sending message: #{message.inspect}" }
+      @driver.text(JSON.dump(message))
+    end
+
+    # Write data to the socket
+    # @param [String] data
+    def write(data)
+      @tcp.write(data)
+    end
+
+    # Send a close frame
+    # @param [String] message The close reason
+    # @param [Integer] code The close code
+    def close(message: nil, code: 1000)
+      LOGGER.debug { "Sending close: (#{message.inspect}, #{code})" }
+      @driver.close(reason, code)
+    end
+
+    def url
+      @uri.to_s
+    end
+
+    private
+
+    # Construct a WebSocket::Driver instance.
+    def create_driver
+      @driver = ::WebSocket::Driver.client(self)
+      @driver.add_extension(PermessageDeflate)
+    end
+
+    # Set the relevant headers for opening a connection.
+    # @param [String] authorization
+    # @param [Integer] num_shards
+    # @param [Integer, String] user_id
+    # @caldera.lavalink_docs [Opening a connection](https://github.com/Frederikam/Lavalink/blob/master/IMPLEMENTATION.md#opening-a-connection)
+    def set_headers(authorization, num_shards, user_id)
+      LOGGER.debug { 'Setting connection headers' }
+      @driver.set_header('Authorization', authorization)
+      @driver.set_header('Num-Shards', num_shards)
+      @driver.set_header('User-Id', user_id)
+    end
+
+    # Register event handlers on the driver.
+    def register_handlers
+      LOGGER.debug { 'Registering driver handlers' }
+      @driver.on(:open, &method(:handle_open))
+      @driver.on(:message, &method(:handle_message))
+      @driver.on(:close, &method(:handle_close))
+    end
+
+    # Begin the thread that feeds messages to the driver.
+    def create_thread
+      LOGGER.debug { 'Creating read thread' }
+      @thread = Thread.new do
+        @driver.parse(read_data) until @dead
+        LOGGER.debug { 'Read loop ending' }
+      end
+    end
+
+    # Fired when the WS handshake has finished
+    def handle_open(_event)
+      LOGGER.info('WebSocket connected')
+      emit(:open)
+    end
+
+    # Fired when a message frame has been received
+    def handle_message(event)
+      LOGGER.info("Received message: #{event.data.inspect}")
+      parsed = JSON.load(event.data)
+      emit(parsed['op'], parsed)
+    end
+
+    # Fired when the WS connection has sent a close frame.
+    def handle_close(event)
+      LOGGER.warn { "Received a close frame: (#{event.reason}, #{event.code})" }
+      @dead = true
+      @thread.kill
+      emit(:close, { reason: event.reason, code: event.code })
+    end
+
+    # Read data from the TCP socket.
+    # @param [Integer] length The maximum length to read at once.
+    def read_data(length = 4096)
+      @tcp.readpartial(length)
+    end
+  end
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: caldera
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Carey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.93.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.93.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+- !ruby/object:Gem::Dependency
+  name: event_emitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: permessage_deflate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: websocket-driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+description: Lavalink client for use with Discord libraries.
+email:
+- matthew.b.carey@gmailcom
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- caldera.gemspec
+- lib/caldera.rb
+- lib/caldera/client.rb
+- lib/caldera/events.rb
+- lib/caldera/model.rb
+- lib/caldera/model/load_tracks.rb
+- lib/caldera/model/playlist_info.rb
+- lib/caldera/model/track.rb
+- lib/caldera/node.rb
+- lib/caldera/player.rb
+- lib/caldera/version.rb
+- lib/caldera/websocket.rb
+homepage: https://github.com/swarley/caldera
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/swarley/caldera
+  source_code_uri: https://github.com/swarley/caldera
+  changelog_uri: https://github.com/swarley/caldera/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: Lavalink client
+test_files: []