khl 1.0.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c3438ba02ff5739b31b529cd0b1c217f91c4f24dc45a0692c267fa4bce4991f
-  data.tar.gz: 7785960928430e73a7ab9c8091868bc7f951884ff1a0ccd680d5fc836a5fd9ba
+  metadata.gz: 5b3ff60071d40b884b84c71573ec653fe5234c849e70adfa9d3527c8b790eb2e
+  data.tar.gz: cc54276f09718288a23b72b8f55e49cc12a19b20f15680af4f6478dffbe5153d
 SHA512:
-  metadata.gz: 92d7bfdfd6e71ca3e6f082badd5c54072d47084b0befc4dfdf628e90d02b637a19b4522055127645bffc504018266b20701cc8ca6b0f345369d7171b2f3eee54
-  data.tar.gz: 0a30f6b6f64cf0c16d3e7f353ee558f4f95d98ed3377eaa4addac0b6c3c78873227aa6f5d4e8b4a7ec41d5120139c56c1b0abdaf5bb5e8c6664e1873cc354ed6
+  metadata.gz: 7f83216e039d7b3c3c088ab07d0900ecdd60b6b2f70a360933d05d41265ec6c43160c895bca64add54529dc026f5cbfdd0c8084e12afffb62b6681f87ef5fec6
+  data.tar.gz: 8e4558eab997c80038df0385ce67141797980c74358276dcc58ec7e56b3f5842f1d3d31eff73c8f71bb9c9a6fb86eaf13aac26075888bdd0b8bdabb9019e020f

data/CHANGELOG.md

@@ -1,9 +1,22 @@
-### 1.0.0 - 2022-03-29
+### 1.2.1 - 2022-04-18
 
-* Add 开黑啦 HTTP API
-* Add 开黑啦 WebSocket API
-* Add GitHub CI
+* Add hash support for KHL::Message.parse
+
+### 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
+* Add 开黑啦 WebSocket API
+* Add GitHub CI

data/README.md

@@ -40,13 +40,19 @@ 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 = raw.is_a?(String) ? JSON.parse(raw) : raw
+      data = ActiveSupport::HashWithIndifferentAccess.new(data)
+
+      Message.new(
+        type: TYPES[data[:s]],
+        data: data[:d],
+        sn: data[:sn]
+      )
+    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.1"
+  VERSION = "1.2.1"
 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
@@ -24,7 +24,7 @@ module KHL
       # @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.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Dounx
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-04-18 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.11
 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