shiny-sdk 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6e8b4f3ec25fb2c30b0dcc9b8255d1c5d3d372b02cfe882deac9b376d4d4281
-  data.tar.gz: 28aa69a85ef6a4dd6cd3f98a8ab8f7fdac212ba67c5f265488927d430b31675e
+  metadata.gz: 8bbc4ff03c35b19c7ea076e103315600e43f7c2888be0f3d4c921ef60ebfa588
+  data.tar.gz: 7b375a311cbcaadaaef8eee4490e53fc41f7a5eb1e5e71e53e7003b155beb166
 SHA512:
-  metadata.gz: 3b4d3eb499dea9119c4a5792063247bd2e2e70629bbc8c526d1ae9bfcfc9d00d2c3f14b8c653cd3bdbd6c31a6b9bc685bb2dcc425adaa0ce081290b95fa44a37
-  data.tar.gz: 27773500cbe7fb9aeceaf6c8c3650e385c1317366e2c7da111a73af4a28854b78a828865d3f77f29596c0efb8e5fdb071a246572b3e1f8f29d7e13b7b1df814d
+  metadata.gz: 5c17b84dbc872a8e32490b97a593e44a28a1494e14accf1ba672871b8c27b4696bf1f6943330c44a3c7b453a9b8bd19e469a6ff269d1be03f2725809e7db923e
+  data.tar.gz: 571e95ad7ebb2835f2e5cb43ccd27909d542786b5162b465bae528745b9d548d5cdc9e0dcb58d4a9f1534581688dbb6ec431bb5c20656a72575a2cb36edf6f35

data/.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }}
+    runs-on: ubuntu-22.04
+    timeout-minutes: 10
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.6', '2.7', '3.0', '3.1', '3.2', '3.3', '3.4', '4.0']
+    steps:
+      - name: Check out source
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Set up Ruby and install dependencies
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec ruby -Itest test/shiny_sdk_test.rb
+
+      - name: Build gem
+        run: bundle exec gem build shiny-sdk.gemspec

data/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -20,3 +20,12 @@ shiny.add(spider_name:String, level:Integer, data:Hash, hash:String)
 # 其中前三项为必填，hash为选填。
 # 不填写hash 默认把data MD5 一次做hash。
 ```
+
+## 测试
+
+```bash
+bundle install
+bundle exec ruby -Itest test/shiny_sdk_test.rb
+```
+
+测试使用本地模拟请求，不连接真实服务。`test/fixtures/add_compatibility.json` 保存了修复前 `add()` 的 17 组行为基准，用于逐字节比对请求 JSON、签名和表单编码，并检查返回值及异常类型；`ShinyError` 的错误信息也会比对。

data/lib/shiny-sdk.rb

@@ -24,7 +24,7 @@ class Shiny
     Hash[payload.sort].keys.each do |key|
       data += payload[key].to_s
     end
-    data
+    sha1(data)
   end
 
 
@@ -86,10 +86,10 @@ class Shiny
   # 添加多个事件
   def add_many(events)
     payload = {}
-    url = @API_HOST + "Data/add"
+    url = @API_HOST + "/Data/add"
     events.each do |event|
       if event[:hash].nil?
-        if event[:data].nil?
+        unless event[:data].nil?
           if event[:data][:hash]
             event[:hash] = event[:data][:hash]
             event[:data].delete(:hash)
@@ -99,8 +99,8 @@ class Shiny
         else
           raise ShinyError.new("Missing parameters.")
         end
-        event[:level] = event[:level].to_i
       end
+      event[:level] = event[:level].to_i
     end
     payload[:event] = events.to_json
 
@@ -140,7 +140,11 @@ class Shiny
   end
 
   def get_jobs
-    url = @API_HOST + "/Job/query?api_key=#{@API_KEY}&sign=#{sign}"
+    query = URI.encode_www_form(api_key: @API_KEY, sign: sign)
+    url = @API_HOST + "/Job/query?#{query}"
+    uri = URI.parse(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true if uri.scheme == 'https'
     response = http.start {|http| 
       http.request Net::HTTP::Get.new(uri.request_uri)
     }
@@ -152,12 +156,13 @@ class Shiny
   end
 
   def report(job_id, status)
-    url = @API_HOST + "Job/report"
+    url = @API_HOST + "/Job/report"
     payload = {
       "jobId": job_id,
       "status": status
     }
-    payload_sign = sign(payload)
+    payload[:sign] = sign(payload)
+    payload[:api_key] = @API_KEY
     response = Net::HTTP.post_form(URI.parse(url), payload)
     if response.code != '200'
       begin
@@ -171,4 +176,4 @@ class Shiny
       JSON.parse(response.body)
     end
   end
-end
+end

data/shiny-sdk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'shiny-sdk'
-  s.version     = '1.0.0'
+  s.version     = '1.0.2'
   s.date        = `git log --pretty="%ai" -n 1`.split(" ").first
   s.summary     = "Shiny SDK"
   s.description = "Shiny Ruby SDK"
@@ -13,4 +13,5 @@ Gem::Specification.new do |s|
   }
   s.license     = 'MIT'
   s.required_ruby_version = '>= 2.6.0'
-end
+  s.add_development_dependency 'minitest', '~> 5.0'
+end

data/test/fixtures/add_compatibility.json

@@ -0,0 +1,595 @@
+[
+  {
+    "name": "omitted_data",
+    "args": [
+      "test",
+      1
+    ],
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "response": [
+      "200",
+      "{\"ok\":true,\"id\":17,\"nested\":{\"a\":[1,null]}}"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "516a0abd16e1406cc5289ec0f8cd268ff6823e17",
+        "event": "{\"level\":1,\"spiderName\":\"test\",\"hash\":\"99914b932bd37a50b983c5e7c90ae93b\",\"data\":{}}"
+      },
+      "body": "api_key=test-api-key&sign=516a0abd16e1406cc5289ec0f8cd268ff6823e17&event=%7B%22level%22%3A1%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%2299914b932bd37a50b983c5e7c90ae93b%22%2C%22data%22%3A%7B%7D%7D"
+    },
+    "result": {
+      "ok": true,
+      "id": 17,
+      "nested": {
+        "a": [
+          1,
+          null
+        ]
+      }
+    }
+  },
+  {
+    "name": "nil_data",
+    "args": [
+      "test",
+      "2",
+      null
+    ],
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "response": [
+      "200",
+      "{\"ok\":true,\"id\":17,\"nested\":{\"a\":[1,null]}}"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "e6faba95cb4aad55ab58ac870dc8856cc2160683",
+        "event": "{\"level\":2,\"spiderName\":\"test\",\"hash\":\"99914b932bd37a50b983c5e7c90ae93b\",\"data\":{}}"
+      },
+      "body": "api_key=test-api-key&sign=e6faba95cb4aad55ab58ac870dc8856cc2160683&event=%7B%22level%22%3A2%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%2299914b932bd37a50b983c5e7c90ae93b%22%2C%22data%22%3A%7B%7D%7D"
+    },
+    "result": {
+      "ok": true,
+      "id": 17,
+      "nested": {
+        "a": [
+          1,
+          null
+        ]
+      }
+    }
+  },
+  {
+    "name": "nested_unicode_data",
+    "args": [
+      "爬虫",
+      "3",
+      {
+        "z": [
+          true,
+          false,
+          null,
+          1.5
+        ],
+        "a": {
+          "消息": "你好 &+=?/ 😀"
+        }
+      }
+    ],
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "response": [
+      "200",
+      "{\"ok\":true,\"id\":17,\"nested\":{\"a\":[1,null]}}"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "4922c9cc8b952dc02c3f749153552242a505c25e",
+        "event": "{\"level\":3,\"spiderName\":\"爬虫\",\"hash\":\"950f474e0aadaabb0c78f543c059c28b\",\"data\":{\"z\":[true,false,null,1.5],\"a\":{\"消息\":\"你好 &+=?/ 😀\"}}}"
+      },
+      "body": "api_key=test-api-key&sign=4922c9cc8b952dc02c3f749153552242a505c25e&event=%7B%22level%22%3A3%2C%22spiderName%22%3A%22%E7%88%AC%E8%99%AB%22%2C%22hash%22%3A%22950f474e0aadaabb0c78f543c059c28b%22%2C%22data%22%3A%7B%22z%22%3A%5Btrue%2Cfalse%2Cnull%2C1.5%5D%2C%22a%22%3A%7B%22%E6%B6%88%E6%81%AF%22%3A%22%E4%BD%A0%E5%A5%BD+%26%2B%3D%3F%2F+%F0%9F%98%80%22%7D%7D%7D"
+    },
+    "result": {
+      "ok": true,
+      "id": 17,
+      "nested": {
+        "a": [
+          1,
+          null
+        ]
+      }
+    }
+  },
+  {
+    "name": "manual_hash",
+    "args": [
+      "test",
+      1,
+      {
+        "b": 2,
+        "a": 1
+      },
+      "fixed-hash"
+    ],
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "response": [
+      "200",
+      "{\"ok\":true,\"id\":17,\"nested\":{\"a\":[1,null]}}"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "acf3c5cbfef78ab9c7ef0c5502ebedbb0d4aa571",
+        "event": "{\"level\":1,\"spiderName\":\"test\",\"hash\":\"fixed-hash\",\"data\":{\"b\":2,\"a\":1}}"
+      },
+      "body": "api_key=test-api-key&sign=acf3c5cbfef78ab9c7ef0c5502ebedbb0d4aa571&event=%7B%22level%22%3A1%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%22fixed-hash%22%2C%22data%22%3A%7B%22b%22%3A2%2C%22a%22%3A1%7D%7D"
+    },
+    "result": {
+      "ok": true,
+      "id": 17,
+      "nested": {
+        "a": [
+          1,
+          null
+        ]
+      }
+    }
+  },
+  {
+    "name": "false_hash",
+    "args": [
+      "test",
+      1,
+      {
+        "b": 2,
+        "a": 1
+      },
+      false
+    ],
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "response": [
+      "200",
+      "{\"ok\":true,\"id\":17,\"nested\":{\"a\":[1,null]}}"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "26753a8a893344f20135bcfbf667d2ff736fe48c",
+        "event": "{\"level\":1,\"spiderName\":\"test\",\"hash\":\"9915965eb40d343a8fe26e4e341d1a05\",\"data\":{\"b\":2,\"a\":1}}"
+      },
+      "body": "api_key=test-api-key&sign=26753a8a893344f20135bcfbf667d2ff736fe48c&event=%7B%22level%22%3A1%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%229915965eb40d343a8fe26e4e341d1a05%22%2C%22data%22%3A%7B%22b%22%3A2%2C%22a%22%3A1%7D%7D"
+    },
+    "result": {
+      "ok": true,
+      "id": 17,
+      "nested": {
+        "a": [
+          1,
+          null
+        ]
+      }
+    }
+  },
+  {
+    "name": "empty_hash",
+    "args": [
+      "test",
+      1,
+      {},
+      ""
+    ],
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "response": [
+      "200",
+      "{\"ok\":true,\"id\":17,\"nested\":{\"a\":[1,null]}}"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "06f9e44e0dade5ee2a0db6c1445b91734baac875",
+        "event": "{\"level\":1,\"spiderName\":\"test\",\"hash\":\"\",\"data\":{}}"
+      },
+      "body": "api_key=test-api-key&sign=06f9e44e0dade5ee2a0db6c1445b91734baac875&event=%7B%22level%22%3A1%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%22%22%2C%22data%22%3A%7B%7D%7D"
+    },
+    "result": {
+      "ok": true,
+      "id": 17,
+      "nested": {
+        "a": [
+          1,
+          null
+        ]
+      }
+    }
+  },
+  {
+    "name": "channel",
+    "args": [
+      "test",
+      1,
+      {}
+    ],
+    "channel": "邮件 & notifications",
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "response": [
+      "200",
+      "{\"ok\":true,\"id\":17,\"nested\":{\"a\":[1,null]}}"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "fd99bdb351bdccc8eda2f8488b251b342799411b",
+        "event": "{\"level\":1,\"spiderName\":\"test\",\"hash\":\"99914b932bd37a50b983c5e7c90ae93b\",\"data\":{},\"channel\":\"邮件 & notifications\"}"
+      },
+      "body": "api_key=test-api-key&sign=fd99bdb351bdccc8eda2f8488b251b342799411b&event=%7B%22level%22%3A1%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%2299914b932bd37a50b983c5e7c90ae93b%22%2C%22data%22%3A%7B%7D%2C%22channel%22%3A%22%E9%82%AE%E4%BB%B6+%26+notifications%22%7D"
+    },
+    "result": {
+      "ok": true,
+      "id": 17,
+      "nested": {
+        "a": [
+          1,
+          null
+        ]
+      }
+    }
+  },
+  {
+    "name": "false_channel",
+    "args": [
+      "test",
+      1,
+      {}
+    ],
+    "channel": false,
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "response": [
+      "200",
+      "{\"ok\":true,\"id\":17,\"nested\":{\"a\":[1,null]}}"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "170bee1d209d8a376fe28bb11887220cca2bb8f4",
+        "event": "{\"level\":1,\"spiderName\":\"test\",\"hash\":\"99914b932bd37a50b983c5e7c90ae93b\",\"data\":{},\"channel\":false}"
+      },
+      "body": "api_key=test-api-key&sign=170bee1d209d8a376fe28bb11887220cca2bb8f4&event=%7B%22level%22%3A1%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%2299914b932bd37a50b983c5e7c90ae93b%22%2C%22data%22%3A%7B%7D%2C%22channel%22%3Afalse%7D"
+    },
+    "result": {
+      "ok": true,
+      "id": 17,
+      "nested": {
+        "a": [
+          1,
+          null
+        ]
+      }
+    }
+  },
+  {
+    "name": "nil_channel",
+    "args": [
+      "test",
+      1,
+      {}
+    ],
+    "channel": null,
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "response": [
+      "200",
+      "{\"ok\":true,\"id\":17,\"nested\":{\"a\":[1,null]}}"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "516a0abd16e1406cc5289ec0f8cd268ff6823e17",
+        "event": "{\"level\":1,\"spiderName\":\"test\",\"hash\":\"99914b932bd37a50b983c5e7c90ae93b\",\"data\":{}}"
+      },
+      "body": "api_key=test-api-key&sign=516a0abd16e1406cc5289ec0f8cd268ff6823e17&event=%7B%22level%22%3A1%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%2299914b932bd37a50b983c5e7c90ae93b%22%2C%22data%22%3A%7B%7D%7D"
+    },
+    "result": {
+      "ok": true,
+      "id": 17,
+      "nested": {
+        "a": [
+          1,
+          null
+        ]
+      }
+    }
+  },
+  {
+    "name": "invalid_level",
+    "args": [
+      "test",
+      "invalid",
+      {}
+    ],
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "response": [
+      "200",
+      "{\"ok\":true,\"id\":17,\"nested\":{\"a\":[1,null]}}"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "269656dbe7c64f9cce5c56749a26bf7aa08a4abf",
+        "event": "{\"level\":0,\"spiderName\":\"test\",\"hash\":\"99914b932bd37a50b983c5e7c90ae93b\",\"data\":{}}"
+      },
+      "body": "api_key=test-api-key&sign=269656dbe7c64f9cce5c56749a26bf7aa08a4abf&event=%7B%22level%22%3A0%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%2299914b932bd37a50b983c5e7c90ae93b%22%2C%22data%22%3A%7B%7D%7D"
+    },
+    "result": {
+      "ok": true,
+      "id": 17,
+      "nested": {
+        "a": [
+          1,
+          null
+        ]
+      }
+    }
+  },
+  {
+    "name": "string_data",
+    "args": [
+      "test",
+      1,
+      "plain text"
+    ],
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "response": [
+      "200",
+      "{\"ok\":true,\"id\":17,\"nested\":{\"a\":[1,null]}}"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "6a1df1f8cf968cdb4bebc52f307462338f188dd7",
+        "event": "{\"level\":1,\"spiderName\":\"test\",\"hash\":\"a242b30718ba7d56ae982c65c6383976\",\"data\":\"plain text\"}"
+      },
+      "body": "api_key=test-api-key&sign=6a1df1f8cf968cdb4bebc52f307462338f188dd7&event=%7B%22level%22%3A1%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%22a242b30718ba7d56ae982c65c6383976%22%2C%22data%22%3A%22plain+text%22%7D"
+    },
+    "result": {
+      "ok": true,
+      "id": 17,
+      "nested": {
+        "a": [
+          1,
+          null
+        ]
+      }
+    }
+  },
+  {
+    "name": "default_host",
+    "client_args": [
+      "test-api-key",
+      "test-secret"
+    ],
+    "args": [
+      "test",
+      1,
+      {}
+    ],
+    "response": [
+      "200",
+      "{\"ok\":true,\"id\":17,\"nested\":{\"a\":[1,null]}}"
+    ],
+    "request": {
+      "url": "https://shiny.kotori.moe/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "516a0abd16e1406cc5289ec0f8cd268ff6823e17",
+        "event": "{\"level\":1,\"spiderName\":\"test\",\"hash\":\"99914b932bd37a50b983c5e7c90ae93b\",\"data\":{}}"
+      },
+      "body": "api_key=test-api-key&sign=516a0abd16e1406cc5289ec0f8cd268ff6823e17&event=%7B%22level%22%3A1%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%2299914b932bd37a50b983c5e7c90ae93b%22%2C%22data%22%3A%7B%7D%7D"
+    },
+    "result": {
+      "ok": true,
+      "id": 17,
+      "nested": {
+        "a": [
+          1,
+          null
+        ]
+      }
+    }
+  },
+  {
+    "name": "api_error",
+    "args": [
+      "test",
+      1,
+      {}
+    ],
+    "response": [
+      "403",
+      "{\"error\":{\"info\":\"invalid signature\",\"code\":401}}"
+    ],
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "516a0abd16e1406cc5289ec0f8cd268ff6823e17",
+        "event": "{\"level\":1,\"spiderName\":\"test\",\"hash\":\"99914b932bd37a50b983c5e7c90ae93b\",\"data\":{}}"
+      },
+      "body": "api_key=test-api-key&sign=516a0abd16e1406cc5289ec0f8cd268ff6823e17&event=%7B%22level%22%3A1%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%2299914b932bd37a50b983c5e7c90ae93b%22%2C%22data%22%3A%7B%7D%7D"
+    },
+    "error": {
+      "class": "ShinyError",
+      "message": "Shiny error: invalid signature code=401"
+    }
+  },
+  {
+    "name": "non_json_http_error",
+    "args": [
+      "test",
+      1,
+      {}
+    ],
+    "response": [
+      "502",
+      "Bad Gateway"
+    ],
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "516a0abd16e1406cc5289ec0f8cd268ff6823e17",
+        "event": "{\"level\":1,\"spiderName\":\"test\",\"hash\":\"99914b932bd37a50b983c5e7c90ae93b\",\"data\":{}}"
+      },
+      "body": "api_key=test-api-key&sign=516a0abd16e1406cc5289ec0f8cd268ff6823e17&event=%7B%22level%22%3A1%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%2299914b932bd37a50b983c5e7c90ae93b%22%2C%22data%22%3A%7B%7D%7D"
+    },
+    "error": {
+      "class": "ShinyError",
+      "message": "Network error: 502"
+    }
+  },
+  {
+    "name": "invalid_success_json",
+    "args": [
+      "test",
+      1,
+      {}
+    ],
+    "response": [
+      "200",
+      "invalid"
+    ],
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "516a0abd16e1406cc5289ec0f8cd268ff6823e17",
+        "event": "{\"level\":1,\"spiderName\":\"test\",\"hash\":\"99914b932bd37a50b983c5e7c90ae93b\",\"data\":{}}"
+      },
+      "body": "api_key=test-api-key&sign=516a0abd16e1406cc5289ec0f8cd268ff6823e17&event=%7B%22level%22%3A1%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%2299914b932bd37a50b983c5e7c90ae93b%22%2C%22data%22%3A%7B%7D%7D"
+    },
+    "error": {
+      "class": "JSON::ParserError"
+    }
+  },
+  {
+    "name": "malformed_error_json",
+    "args": [
+      "test",
+      1,
+      {}
+    ],
+    "response": [
+      "500",
+      "{}"
+    ],
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "request": {
+      "url": "https://example.invalid/Data/add",
+      "payload": {
+        "api_key": "test-api-key",
+        "sign": "516a0abd16e1406cc5289ec0f8cd268ff6823e17",
+        "event": "{\"level\":1,\"spiderName\":\"test\",\"hash\":\"99914b932bd37a50b983c5e7c90ae93b\",\"data\":{}}"
+      },
+      "body": "api_key=test-api-key&sign=516a0abd16e1406cc5289ec0f8cd268ff6823e17&event=%7B%22level%22%3A1%2C%22spiderName%22%3A%22test%22%2C%22hash%22%3A%2299914b932bd37a50b983c5e7c90ae93b%22%2C%22data%22%3A%7B%7D%7D"
+    },
+    "error": {
+      "class": "NoMethodError"
+    }
+  },
+  {
+    "name": "hash_generation_error",
+    "args": [
+      "test",
+      1,
+      null
+    ],
+    "bad_data": true,
+    "client_args": [
+      "test-api-key",
+      "test-secret",
+      "https://example.invalid"
+    ],
+    "response": [
+      "200",
+      "{\"ok\":true,\"id\":17,\"nested\":{\"a\":[1,null]}}"
+    ],
+    "request": null,
+    "error": {
+      "class": "ShinyError",
+      "message": "Fail to generate hash."
+    }
+  }
+]

data/test/shiny_sdk_test.rb

@@ -0,0 +1,220 @@
+require 'minitest/autorun'
+require 'minitest/mock'
+require_relative '../lib/shiny-sdk'
+
+class ShinySDKTest < Minitest::Test
+  Response = Struct.new(:code, :body)
+
+  class HTTPStub
+    attr_accessor :use_ssl
+    attr_reader :requests
+
+    def initialize(response)
+      @response = response
+      @requests = []
+    end
+
+    def start
+      yield self
+    end
+
+    def request(request)
+      @requests << request
+      @response
+    end
+  end
+
+  def setup
+    @client = Shiny.new('test-api-key', 'test-secret', 'https://example.invalid')
+    @response = Response.new('200', '{"ok":true}')
+  end
+
+  # Captured from the original add method at e2d6c32, before these fixes.
+  # In particular, event JSON and form bodies are byte exact.
+  JSON.parse(File.read(File.join(__dir__, 'fixtures', 'add_compatibility.json'), encoding: 'UTF-8')).each do |example|
+    define_method("test_add_compatibility_#{example.fetch('name')}") do
+      client = Shiny.new(*example.fetch('client_args'))
+      args = example.fetch('args')
+      if example['bad_data']
+        bad_data = Object.new
+        def bad_data.to_json(*)
+          raise ArgumentError, 'cannot serialize'
+        end
+        args[2] = bad_data
+      end
+      response = Response.new(*example.fetch('response'))
+      captured = nil
+      post = lambda do |uri, payload|
+        request = Net::HTTP::Post.new(uri)
+        request.set_form_data(payload)
+        captured = { 'url' => uri.to_s, 'payload' => payload, 'body' => request.body }
+        response
+      end
+      Net::HTTP.stub(:post_form, post) do
+        invoke = lambda do
+          if example.key?('channel')
+            client.add(*args, channel: example['channel'])
+          else
+            client.add(*args)
+          end
+        end
+        if example.key?('error')
+          error = assert_raises(Object.const_get(example['error']['class']), &invoke)
+          assert_equal example['error']['message'], error.message if example['error'].key?('message')
+        else
+          assert_equal example.fetch('result'), invoke.call
+        end
+      end
+      assert_equal example.fetch('request'), captured unless example['request'].nil?
+      assert_nil captured if example['request'].nil?
+    end
+  end
+
+  def test_sign_hashes_sorted_values_without_mutating_payload
+    payload = { status: 'done', jobId: 'job-1' }
+    original = payload.dup
+    assert_equal Digest::SHA1.hexdigest('test-api-keytest-secretjob-1done'), @client.sign(payload)
+    assert_equal original, payload
+    assert_equal @client.sign(payload), @client.sign(payload.to_a.reverse.to_h)
+    refute_includes @client.sign(payload), 'test-secret'
+  end
+
+  def test_sign_without_parameters
+    assert_equal Digest::SHA1.hexdigest('test-api-keytest-secret'), @client.sign
+  end
+
+  def test_add_many_generates_hash_and_normalizes_level
+    events = [{ spiderName: 'test', level: '2', data: { b: 2, a: 1 } }]
+    capture_post(-> { @client.add_many(events) }) do |uri, payload, result|
+      assert_equal 'https://example.invalid/Data/add', uri.to_s
+      assert_equal({ 'ok' => true }, result)
+      event = JSON.parse(payload.fetch(:event)).first
+      assert_equal 2, event.fetch('level')
+      assert_equal({ 'b' => 2, 'a' => 1 }, event.fetch('data'))
+      assert_equal Digest::MD5.hexdigest([['a', 1], ['b', 2]].to_json), event.fetch('hash')
+      assert_equal Digest::SHA1.hexdigest('test-api-keytest-secret' + payload[:event]), payload[:sign]
+      assert_equal 'test-api-key', payload[:api_key]
+      refute_includes payload[:sign], 'test-secret'
+    end
+  end
+
+  def test_add_many_uses_explicit_and_embedded_hashes
+    events = [
+      { spiderName: 'first', level: '1', data: { hash: 'ignored', message: 'one' }, hash: 'explicit' },
+      { spiderName: 'second', level: '2', data: { hash: 'embedded', message: 'two' } }
+    ]
+    capture_post(-> { @client.add_many(events) }) do |_uri, payload, _result|
+      first, second = JSON.parse(payload.fetch(:event))
+      assert_equal 'explicit', first.fetch('hash')
+      assert_equal 1, first.fetch('level')
+      assert_equal 'ignored', first.fetch('data').fetch('hash')
+      assert_equal 'embedded', second.fetch('hash')
+      assert_equal 2, second.fetch('level')
+      assert_equal({ 'message' => 'two' }, second.fetch('data'))
+    end
+  end
+
+  def test_add_many_rejects_missing_data_before_sending
+    [{ spiderName: 'test', level: 1 }, { spiderName: 'test', level: 1, data: nil }].each do |event|
+      Net::HTTP.stub(:post_form, ->(*) { flunk 'must not send invalid events' }) do
+        error = assert_raises(ShinyError) { @client.add_many([event]) }
+        assert_equal 'Missing parameters.', error.message
+      end
+    end
+  end
+
+  def test_add_many_accepts_empty_data
+    events = [{ spiderName: 'test', level: 1, data: {} }]
+    capture_post(-> { @client.add_many(events) }) do |_uri, payload, _result|
+      assert_equal({}, JSON.parse(payload.fetch(:event)).first.fetch('data'))
+    end
+  end
+
+  def test_get_jobs_initializes_https_and_encodes_credentials
+    client = Shiny.new('key+&=? 空', 'test-secret', 'https://example.invalid:8443/api')
+    http = HTTPStub.new(Response.new('200', '[{"jobId":"job-1"}]'))
+    factory = lambda do |host, port|
+      assert_equal 'example.invalid', host
+      assert_equal 8443, port
+      http
+    end
+    Net::HTTP.stub(:new, factory) do
+      assert_equal [{ 'jobId' => 'job-1' }], client.get_jobs
+    end
+    assert_equal true, http.use_ssl
+    request = http.requests.fetch(0)
+    assert_equal 'GET', request.method
+    uri = URI.parse(request.path)
+    assert_equal '/api/Job/query', uri.path
+    assert_equal({ 'api_key' => 'key+&=? 空', 'sign' => Digest::SHA1.hexdigest('key+&=? 空test-secret') }, URI.decode_www_form(uri.query).to_h)
+    refute_includes request.path, 'test-secret'
+  end
+
+  def test_get_jobs_supports_http
+    client = Shiny.new('key', 'secret', 'http://example.invalid:8080')
+    http = HTTPStub.new(@response)
+    factory = lambda do |host, port|
+      assert_equal ['example.invalid', 8080], [host, port]
+      http
+    end
+    Net::HTTP.stub(:new, factory) do
+      assert_equal({ 'ok' => true }, client.get_jobs)
+    end
+    refute http.use_ssl
+  end
+
+  def test_get_jobs_reports_http_errors
+    http = HTTPStub.new(Response.new('503', 'unavailable'))
+    Net::HTTP.stub(:new, http) do
+      error = assert_raises(ShinyError) { @client.get_jobs }
+      assert_equal 'Network error: 503', error.message
+    end
+  end
+
+  def test_report_sends_authentication_and_returns_response
+    capture_post(-> { @client.report('job-1', 'done') }) do |uri, payload, result|
+      assert_equal 'https://example.invalid/Job/report', uri.to_s
+      assert_equal({ 'ok' => true }, result)
+      assert_equal 'job-1', payload.fetch(:jobId)
+      assert_equal 'done', payload.fetch(:status)
+      assert_equal 'test-api-key', payload.fetch(:api_key)
+      assert_equal Digest::SHA1.hexdigest('test-api-keytest-secretjob-1done'), payload.fetch(:sign)
+      refute_includes payload[:sign], 'test-secret'
+    end
+  end
+
+  def test_post_methods_preserve_api_errors
+    @response = Response.new('403', '{"error":{"info":"invalid signature","code":401}}')
+    assert_post_errors 'Shiny error: invalid signature code=401'
+  end
+
+  def test_post_methods_preserve_non_json_http_errors
+    @response = Response.new('502', '<html>Bad Gateway</html>')
+    assert_post_errors 'Network error: 502'
+  end
+
+  private
+
+  def capture_post(operation)
+    captured = nil
+    Net::HTTP.stub(:post_form, ->(uri, payload) { captured = [uri, payload]; @response }) do
+      result = operation.call
+      refute_nil captured
+      yield(*captured, result)
+    end
+  end
+
+  def assert_post_errors(message)
+    operations = [
+      -> { @client.add('test', 1, {}) },
+      -> { @client.add_many([{ spiderName: 'test', level: 1, data: {}, hash: 'fixed' }]) },
+      -> { @client.report('job-1', 'done') }
+    ]
+    Net::HTTP.stub(:post_form, @response) do
+      operations.each do |operation|
+        error = assert_raises(ShinyError, &operation)
+        assert_equal message, error.message
+      end
+    end
+  end
+end

metadata

@@ -1,31 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: shiny-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Koell
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-15 00:00:00.000000000 Z
-dependencies: []
+date: 2026-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: Shiny Ruby SDK
 email: i@wug.moe
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- Gemfile
 - LICENSE
 - README.md
 - lib/shiny-sdk.rb
 - shiny-sdk.gemspec
+- test/fixtures/add_compatibility.json
+- test/shiny_sdk_test.rb
 homepage: https://shiny.kotori.moe
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/Shiny-Project/Shiny-Ruby-SDK/
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -40,8 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Shiny SDK
 test_files: []