KHL

开黑啦 Ruby SDK

Prerequisites

ruby >= 2.7

Installation

Add this line to your application's Gemfile:

gem 'khl'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install khl

Usage

require "khl"

token = "your_bot_token"

# Call HTTP API
http_client = KHL::HTTP::Client.new(token)
http_client.guild.list # Call guild/list API

# Connect to WebSocket API
ws_client = KHL::WebSocket::Client.new(token)
Thread.new { ws_client.run } # Run WebSocket client
ws_clinet.state # Get current state
ws_client.messages.pop # Get message from queue

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/DessertShop/KHL.