khl 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9299dfafd8b0c827311f73bc349ef23f8e8d6e2c87a664dc94c52c8b8fee74de
-  data.tar.gz: 2089da69756876c4d9f5e2afaebdc92e71c381e2fbf6c6f09d50fdac3a476817
+  metadata.gz: 3110943f00d66a4139d82f1f13798cde8f4ffddc0462cffeb3c47c5e131a2b47
+  data.tar.gz: bc8cb50c6876fbbc769667525f84bcbda3c2a9aa1d1e76bfdb00a2525a443ea8
 SHA512:
-  metadata.gz: f1f1607a954fd9ff6f3d0516d79cb79502db44b7c675cc45d68ff4f1c4bcec264f5872b3b7c6b8fceda363787bcf298932a561e5aab39e7e4da401c5ade753a4
-  data.tar.gz: 974ebd1222e12470b06effe666df2aa522c93e53061f4bb8f540826bc2076c9e43b54db4a37245381bb653f7300979b6f9f82f7af6040a7b4f1b64c597e2dfd1
+  metadata.gz: 8b4be1d65e2cb54e3d1b1a762253bc2fa3578bf448b056d9905edc7a0823c216802a857122b6904b93484f016585b2c5d5e314500b38ad0839765526ac6f0a43
+  data.tar.gz: 99916625ffb6cb60f9613785167cae2209ad6e0f9f61af09a2f22e4d84605d4041aefaf0d6630612bb45adc22f6cb01881e13debe15cb1be5b4701596e36d480

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.2.0 - 2022-04-08
+
+* Fix 开黑啦 Webhook API
+
 ### 1.1.0 - 2022-04-02
 
 * Add 开黑啦 Webhook API
@@ -7,9 +11,8 @@
 
 * Fix params type
 
-
 ### 1.0.0 - 2022-03-29
 
 * Add 开黑啦 HTTP API
 * Add 开黑啦 WebSocket API
-* Add GitHub CI
+* Add GitHub CI

data/README.md

@@ -41,19 +41,18 @@ 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")
+# 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/version.rb

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

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,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "khl/http/client"
-require_relative "khl/webhook/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.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Dounx
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-02 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -79,7 +79,7 @@ files:
 - lib/khl/message.rb
 - lib/khl/version.rb
 - lib/khl/web_socket/client.rb
-- lib/khl/webhook/client.rb
+- lib/khl/webhook.rb
 homepage: https://github.com/DessertShop/KHL
 licenses:
 - MIT
@@ -103,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/webhook/client.rb

@@ -1,98 +0,0 @@
-# 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