khl 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed901cab84178a2961285b975bf703bb034b998e0d70e7e8c8e06c5f27187137
-  data.tar.gz: 0447d12135db7697c59aadfd7f358e64982db782af00c2fdb90c4ea1bb2123a7
+  metadata.gz: 3110943f00d66a4139d82f1f13798cde8f4ffddc0462cffeb3c47c5e131a2b47
+  data.tar.gz: bc8cb50c6876fbbc769667525f84bcbda3c2a9aa1d1e76bfdb00a2525a443ea8
 SHA512:
-  metadata.gz: 2b71ec8d6a9f2e46c412a0552f2f6484d37a273ce141386ea9b94c8756ab54d15774d857cc42a25f1b4ea6be32b1a5e03d4544d04b1911dfc121778bed1ef4c5
-  data.tar.gz: 97ee22265dd77c70c3d432418e2a89410b2eb14984a81df83a08206fe1344f6c3479090afcb488e8f43bf9ba363ffaa8c33ff8dbe8804b3ec6932fdd4bb0e05e
+  metadata.gz: 8b4be1d65e2cb54e3d1b1a762253bc2fa3578bf448b056d9905edc7a0823c216802a857122b6904b93484f016585b2c5d5e314500b38ad0839765526ac6f0a43
+  data.tar.gz: 99916625ffb6cb60f9613785167cae2209ad6e0f9f61af09a2f22e4d84605d4041aefaf0d6630612bb45adc22f6cb01881e13debe15cb1be5b4701596e36d480

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+### 1.2.0 - 2022-04-08
+
+* Fix 开黑啦 Webhook API
+
+### 1.1.0 - 2022-04-02
+
+* Add 开黑啦 Webhook API
+* Add Event Wrapper
+
+### 1.0.1 - 2022-03-29
+
+* Fix params type
+
 ### 1.0.0 - 2022-03-29
 
 * Add 开黑啦 HTTP API

data/README.md

@@ -32,21 +32,27 @@ require "khl"
 token = "your_bot_token"
 
 # Call HTTP API
-http_client = KHL::HTTP::Client.new(token)
+http_client = KHL::HTTP::Client.new(token: token)
 http_client.guild.list # Call guild/list API
 
 # Connect to WebSocket API
-ws_client = KHL::WebSocket::Client.new(token)
+ws_client = KHL::WebSocket::Client.new(token: token)
 Thread.new { ws_client.run } # Run WebSocket client
 ws_clinet.state # Get current state
 ws_client.messages.pop # Get message from queue
+
+# Use Webhook API in Rails
+params = KHL::Webhook.decompress(request.body.string)
+encrypted_data = params[:encrypt]
+raw_json = KHL::Webhook.decode("your_encrypt_key", encrypted_data)
+message = KHL::Message.parse(raw_json)
 ```
 
 ## 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](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, please bump version, 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
 

data/lib/khl/event.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/hash_with_indifferent_access"
+
+module KHL
+  class Event
+    attr_accessor :channel_type, :type, :target_id, :author_id, :content, :msg_id, :msg_timestamp, :nonce, :extra
+
+    def initialize(params = {})
+      params = ActiveSupport::HashWithIndifferentAccess.new(params)
+
+      @channel_type = params[:channel_type]
+      @type = params[:type]
+      @target_id = params[:target_id]
+      @author_id = params[:author_id]
+      @content = params[:content]
+      @msg_id = params[:msg_id]
+      @msg_timestamp = params[:msg_timestamp]
+      @nonce = params[:nonce]
+      @extra = params[:extra]
+    end
+  end
+end

data/lib/khl/http/response.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/hash_with_indifferent_access"
+
 module KHL
   module HTTP
     class Response
@@ -9,16 +12,16 @@ module KHL
       def initialize(raw_response)
         @raw_response = raw_response
         @http_code = raw_response.code.to_i
-        @body = JSON.parse(@raw_response.body)
+        @body = ActiveSupport::HashWithIndifferentAccess.new(JSON.parse(@raw_response.body))
       end
 
       def data
-        @body["data"]
+        @body[:data]
       end
 
       # The code in the response body
       def code
-        @body["code"]
+        @body[:code]
       end
 
       def max_request_limit
@@ -50,19 +53,19 @@ module KHL
       end
 
       def message
-        @body["message"]
+        @body[:message]
       end
 
       def page
-        data.dig("meta", "page") || 0
+        data.dig(:meta, :page) || 0
       end
 
       def page_size
-        data.dig("meta", "page_size") || 0
+        data.dig(:meta, :page_size) || 0
       end
 
       def page_total
-        data.dig("meta", "total") || 0
+        data.dig(:meta, :total) || 0
       end
     end
   end

data/lib/khl/message.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/hash_with_indifferent_access"
+
+require_relative "event"
+
+module KHL
+  class Message
+    TYPES = %i[
+      event
+      hello
+      ping
+      pong
+      resume
+      reconnect
+      resume_ack
+    ].freeze
+
+    attr_accessor :type, :data, :sn
+
+    def self.parse(raw)
+      return unless raw
+
+      data = JSON.parse(raw)
+      data = ActiveSupport::HashWithIndifferentAccess.new(data)
+
+      message = Message.new
+      message.type = TYPES[data[:s]]
+      message.data = data[:d]
+      message.sn = data[:sn]
+      message
+    end
+
+    def initialize(type: nil, data: nil, sn: nil)
+      @type = type
+      @data = data
+      @sn = sn
+    end
+
+    def event
+      return unless event?
+
+      Event.new(@data)
+    end
+
+    def to_h
+      ActiveSupport::HashWithIndifferentAccess.new(
+        s: TYPES.index(type),
+        d: data,
+        sn: sn
+      )
+    end
+
+    def to_json
+      to_h.to_json
+    end
+
+    TYPES.each do |type|
+      define_method("#{type}?") do
+        @type == type
+      end
+    end
+  end
+end

data/lib/khl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KHL
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

data/lib/khl/web_socket/client.rb

@@ -7,7 +7,7 @@ require "json"
 require "uri"
 require "zlib"
 
-require_relative "message"
+require_relative "../message"
 
 module KHL
   module WebSocket
@@ -19,11 +19,12 @@ module KHL
     class Client
       attr_reader :config, :url, :messages, :state
 
-      # @param config [String] :token Bot token
+      # @param config [Hash] :config Config
+      # @option config [String] :token Bot token (required)
       # @option config [String] :token_type Token type
       # @option config [String] :language Language
       # @option config [Boolean] :compress Compress
-      def initialize(config)
+      def initialize(config = {})
         config[:compress] ||= false
 
         @config = config

data/lib/khl/webhook.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module KHL
+  # @example
+  # # Rails Environment
+  # params = KHL::Webhook.decompress(request.body.string)
+  # encrypted_data = params[:encrypt]
+  # raw_json = KHL::Webhook.decode("your_encrypt_key", encrypted_data)
+  # message = KHL::Message.parse(raw_json)
+  module Webhook
+    # Decode the data
+    # @param [String] encrypt_key Encrypt Key
+    # @param [String] encrypted_data Encrypted data
+    # @return [String] Decrypted data
+    def self.decode(encrypt_key, encrypted_data)
+      encrypted_data = Base64.strict_decode64(encrypted_data)
+      cipher = OpenSSL::Cipher.new("aes-256-cbc")
+      cipher.decrypt
+      cipher.iv = encrypted_data[0..15]
+      cipher.key = encrypt_key.ljust(32, "\0")
+      cipher.update(encrypted_data) + cipher.final
+    end
+
+    # Decompress the data
+    # @param [String] data Compressed data
+    # @return [String] Decompressed data
+    def self.decompress(data)
+      Zlib::Inflate.inflate(data)
+    end
+  end
+end

data/lib/khl.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "khl/http/client"
+require_relative "khl/webhook"
 require_relative "khl/web_socket/client"
 
 module KHL; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: khl
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Dounx
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-28 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -54,6 +54,7 @@ files:
 - CHANGELOG.md
 - README.md
 - lib/khl.rb
+- lib/khl/event.rb
 - lib/khl/http/asset.rb
 - lib/khl/http/badge.rb
 - lib/khl/http/base.rb
@@ -75,9 +76,10 @@ files:
 - lib/khl/http/response.rb
 - lib/khl/http/user.rb
 - lib/khl/http/user_chat.rb
+- lib/khl/message.rb
 - lib/khl/version.rb
 - lib/khl/web_socket/client.rb
-- lib/khl/web_socket/message.rb
+- lib/khl/webhook.rb
 homepage: https://github.com/DessertShop/KHL
 licenses:
 - MIT
@@ -101,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.10
 signing_key:
 specification_version: 4
 summary: Ruby SDK for 开黑啦

data/lib/khl/web_socket/message.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module KHL
-  module WebSocket
-    class Message
-      TYPES = %i[
-        event
-        hello
-        ping
-        pong
-        resume
-        reconnect
-        resume_ack
-      ].freeze
-
-      attr_accessor :type, :data, :sn
-
-      def self.parse(raw)
-        return unless raw
-
-        data = JSON.parse(raw)
-        message = Message.new
-        message.type = TYPES[data["s"]]
-        message.data = data["d"]
-        message.sn = data["sn"]
-        message
-      end
-
-      def initialize(type: nil, data: nil, sn: nil)
-        @type = type
-        @data = data
-        @sn = sn
-      end
-
-      def to_h
-        {
-          s: TYPES.index(type),
-          d: data,
-          sn: sn
-        }
-      end
-
-      def to_json
-        to_h.to_json
-      end
-
-      TYPES.each do |type|
-        define_method("#{type}?") do
-          @type == type
-        end
-      end
-    end
-  end
-end