khl 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c3438ba02ff5739b31b529cd0b1c217f91c4f24dc45a0692c267fa4bce4991f
-  data.tar.gz: 7785960928430e73a7ab9c8091868bc7f951884ff1a0ccd680d5fc836a5fd9ba
+  metadata.gz: 9299dfafd8b0c827311f73bc349ef23f8e8d6e2c87a664dc94c52c8b8fee74de
+  data.tar.gz: 2089da69756876c4d9f5e2afaebdc92e71c381e2fbf6c6f09d50fdac3a476817
 SHA512:
-  metadata.gz: 92d7bfdfd6e71ca3e6f082badd5c54072d47084b0befc4dfdf628e90d02b637a19b4522055127645bffc504018266b20701cc8ca6b0f345369d7171b2f3eee54
-  data.tar.gz: 0a30f6b6f64cf0c16d3e7f353ee558f4f95d98ed3377eaa4addac0b6c3c78873227aa6f5d4e8b4a7ec41d5120139c56c1b0abdaf5bb5e8c6664e1873cc354ed6
+  metadata.gz: f1f1607a954fd9ff6f3d0516d79cb79502db44b7c675cc45d68ff4f1c4bcec264f5872b3b7c6b8fceda363787bcf298932a561e5aab39e7e4da401c5ade753a4
+  data.tar.gz: 974ebd1222e12470b06effe666df2aa522c93e53061f4bb8f540826bc2076c9e43b54db4a37245381bb653f7300979b6f9f82f7af6040a7b4f1b64c597e2dfd1

data/CHANGELOG.md

@@ -1,9 +1,15 @@
-### 1.0.0 - 2022-03-29
+### 1.1.0 - 2022-04-02
 
-* Add 开黑啦 HTTP API
-* Add 开黑啦 WebSocket API
-* Add GitHub CI
+* 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,6 +40,13 @@ 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
+webhook_client = KHL::Webhook::Client.new("webhook_url",  "challenge_token")
+webhook_client.online? # => false
+webhook_client.challenge # Do challenge
+webhook_client.online? # => true
+webhook_client.parse_message("data from webhook")
 ```
 
 ## Development

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.1"
+  VERSION = "1.1.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
@@ -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/client.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module KHL
+  module Webhook
+    # Client for the KHL Webhook API
+    # @example
+    # client = KHL::Webhook::Client.new("https://foo.bar/callback", "your_challenge_token")
+    # client.online? # => false
+    # client.challenge # => true
+    # client.online? # => true
+    # data = client.parse_message(data_from_webhook)
+    class Client
+      attr_reader :key
+
+      # @param [String] challenge_url The source url from the request
+      # @param [String] challenge_token The challenge param from the request
+      # @param [Hash] options Additional options
+      # @option options [Boolean] :compress (true) Enable/disable compression
+      # @option options [encrypt] :encrypt (false) Enable/disable encryption
+      # @option options [String] :key (nil) Encryption key
+      def initialize(challenge_url, challenge_token, options = {})
+        @challenge_url = challenge_url
+        @challenge_token = challenge_token
+
+        @compress = options[:compress] || true
+        @encrypt = options[:encrypt] || false
+        @key = options[:key]
+
+        raise ArgumentError, "key is required" if @encrypt && @key.nil?
+      end
+
+      # Do the challenge
+      # @return [Boolean] The challenge success state
+      def challenge
+        uri = URI.parse(@challenge_url)
+        res = Net::HTTP.post_form(uri, challenge: @challenge_token)
+        if res.code == "200"
+          @online = true
+          return true
+        end
+
+        false
+      end
+
+      def compress?
+        @compress
+      end
+
+      def encrypt?
+        @encrypt
+      end
+
+      def online?
+        @online || false
+      end
+
+      # Parse message from raw data
+      # @param [String] data The raw data from the webhook
+      # @return [KHL::Message] The parsed message
+      def parse_message(data)
+        if encrypt?
+          data = decrypt(data)
+        end
+
+        if compress?
+          data = decompress(data)
+        end
+
+        Message.parse(data)
+      end
+
+      private
+
+      # Decode the data
+      # @param [String] encrypted_data Encrypted data
+      # @return [String] Decrypted data
+      def decode(encrypted_data)
+        return nil unless encrypt?
+
+        encrypted_data = Base64.strict_decode64(encrypted_data)
+        cipher = OpenSSL::Cipher.new("aes-256-cbc")
+        cipher.decrypt
+        cipher.iv = encrypted_data[0..15]
+        cipher.key = key.ljust(32, "\0")
+        cipher.update(encrypted_data) + cipher.final
+      end
+
+      # Decompress the data
+      # @param [String] data Compressed data
+      # @return [String] Decompressed data
+      def decompress(data)
+        return nil unless compress?
+
+        Zlib::Inflate.inflate(data.pack("C*"))
+      end
+    end
+  end
+end

data/lib/khl.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "khl/http/client"
+require_relative "khl/webhook/client"
 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.1.0
 platform: ruby
 authors:
 - Dounx
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-04-02 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/client.rb
 homepage: https://github.com/DessertShop/KHL
 licenses:
 - MIT

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