shiny-sdk 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 56f3aaede8a828302d70b50a9d08195e5cde3047
-  data.tar.gz: e5512e3ec167d8c0a23ae907e3317d1813f7d3d9
+SHA256:
+  metadata.gz: a6e8b4f3ec25fb2c30b0dcc9b8255d1c5d3d372b02cfe882deac9b376d4d4281
+  data.tar.gz: 28aa69a85ef6a4dd6cd3f98a8ab8f7fdac212ba67c5f265488927d430b31675e
 SHA512:
-  metadata.gz: 54fe92825571f5e7c1a95dc0cce93879127f513a9e0d8fefa1e342e07d0dcd3e4711bb6755cafda9879a4b1b563d876e7e0d0840fd4085ab1da767e5326567de
-  data.tar.gz: 83ef04ef5ae4f71663d77e18995339db3b946fd02e6b17084b2436546da32deb05cb0d0f1955a44087cc27462a9327418630041297d96bd8f5e5ebb6c8d45aeb
+  metadata.gz: 3b4d3eb499dea9119c4a5792063247bd2e2e70629bbc8c526d1ae9bfcfc9d00d2c3f14b8c653cd3bdbd6c31a6b9bc685bb2dcc425adaa0ce081290b95fa44a37
+  data.tar.gz: 27773500cbe7fb9aeceaf6c8c3650e385c1317366e2c7da111a73af4a28854b78a828865d3f77f29596c0efb8e5fdb071a246572b3e1f8f29d7e13b7b1df814d

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 Shiny
+Copyright (c) 2016-2018 Shiny
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,4 +1,5 @@
 # Shiny Ruby SDK
+Shiny 的 Ruby SDK，基于 Python 版构建。
 
 ## 安装
 ```bash
@@ -9,13 +10,13 @@ gem install shiny-sdk
 ```ruby
 require 'shiny-sdk'
 
-shiny = Shiny.new('apikey', 'api_secret_key', 'api_host')
+shiny = Shiny.new('apikey', 'api_secret_key', 'api_host') # apikey 和 api_secret_key 必须填写，api_host 不填写会使用默认值。
 
-# 获取最新项目
-shiny.recent
+# 获取最新的消息
+shiny.recent(page) # page 选填，不填写默认为 1。
 
 # 添加数据
-shiny.add(spider_name, level, data, hash)
-# 其中三项为必填，hash为选填。
+shiny.add(spider_name:String, level:Integer, data:Hash, hash:String)
+# 其中前三项为必填，hash为选填。
 # 不填写hash 默认把data MD5 一次做hash。
 ```

data/lib/shiny-sdk.rb

@@ -1,3 +1,4 @@
+# Shiny Ruby SDK
 require 'json'
 require 'digest/md5'
 require 'digest/sha1'
@@ -11,14 +12,34 @@ class ShinyError < StandardError
 end
 
 class Shiny
-  def initialize(api_key, api_secret_key, api_host)
-    @API_KEY = api_key
-    @API_SECRET_KEY = api_secret_key
-    @API_HOST = api_host
+  def initialize(api_key, api_secret_key, api_host='https://shiny.kotori.moe')
+    @API_KEY = api_key.freeze
+    @API_SECRET_KEY = api_secret_key.freeze
+    @API_HOST = api_host.freeze
   end
 
-  def add(spider_name, level, data=nil, hash=false)
-    # 添加数据项
+  # API 请求签名
+  def sign(payload={})
+    data = @API_KEY + @API_SECRET_KEY
+    Hash[payload.sort].keys.each do |key|
+      data += payload[key].to_s
+    end
+    data
+  end
+
+
+  # 计算md5
+  def md5(text)
+    Digest::MD5.hexdigest(text)
+  end
+
+  # 计算sha1
+  def sha1(text)
+    Digest::SHA1.hexdigest(text)
+  end
+
+  # 添加数据项
+  def add(spider_name, level, data=nil, hash=false, channel: nil)
     if data.nil?
       data = {}
     end
@@ -27,43 +48,127 @@ class Shiny
 
     payload = {'api_key' => @API_KEY}
 
-    event = {"level": level, "spiderName": spider_name} 
+    event = {"level": level.to_i, "spiderName": spider_name} 
 
     # 如果没有手动指定Hash，将会把data做一次md5生成hash
     begin
       if hash
         event['hash'] = hash
       else
-        event['hash'] = Digest::MD5.hexdigest(data.to_json)
+        event['hash'] = md5(data.to_json)
       end
     rescue
       raise ShinyError.new('Fail to generate hash.')
     end
 
-    event['data'] = data  
+    event['data'] = data
+
+    event['channel'] = channel unless channel.nil?
 
-    payload['sign'] = Digest::SHA1.hexdigest(@API_KEY + @API_SECRET_KEY + event.to_json)
+    payload['sign'] = sha1(@API_KEY + @API_SECRET_KEY + event.to_json)
 
     payload["event"] = event.to_json
 
     response = Net::HTTP.post_form(URI.parse(url), payload)
-    if response.code == '200'
-      return JSON.parse(response.body)
+    if response.code != '200'
+      begin
+        error = JSON.parse(response.body)
+      rescue
+        raise ShinyError.new("Network error: #{response.code}")
+      end
+
+      raise ShinyError.new("Shiny error: #{error['error']['info']} code=#{error['error']['code']}")
     else
-      raise ShinyError.new('Network error:' + response.code)
+      JSON.parse(response.body)
     end
   end
 
-  def recent
-    # 获取最新项目
-    url = @API_HOST + '/Data/recent'
+  # 添加多个事件
+  def add_many(events)
+    payload = {}
+    url = @API_HOST + "Data/add"
+    events.each do |event|
+      if event[:hash].nil?
+        if event[:data].nil?
+          if event[:data][:hash]
+            event[:hash] = event[:data][:hash]
+            event[:data].delete(:hash)
+          else
+            event[:hash] = md5(Hash[event[:data]].sort.to_json)
+          end
+        else
+          raise ShinyError.new("Missing parameters.")
+        end
+        event[:level] = event[:level].to_i
+      end
+    end
+    payload[:event] = events.to_json
+
+    payload_sign = sign(payload)
+      
+    payload[:sign] = payload_sign
+    payload[:api_key] = @API_KEY
+
+    response = Net::HTTP.post_form(URI.parse(url), payload)
+    if response.code != '200'
+      begin
+        error = JSON.parse(response.body)
+      rescue
+        raise ShinyError.new("Network error: #{response.code}")
+      end
+      
+      raise ShinyError.new("Shiny error: #{error['error']['info']} code=#{error['error']['code']}")
+    else
+      JSON.parse(response.body)
+    end
+  end
+
+  # 获取最新项目
+  def recent(page=1)
+    url = @API_HOST + "/Data/recent?page=#{page}"
     uri = URI.parse(url)
-    req = Net::HTTP::Get.new(uri)
-    response = Net::HTTP.start(uri.host, uri.port) {|http| http.request req }
-    if response.code == '200'
+    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)
+    }
+    if response.code != '200'
+      raise ShinyError.new("Network error: #{response.code}")
+    else
+      return JSON.parse(response.body)
+    end
+  end
+
+  def get_jobs
+    url = @API_HOST + "/Job/query?api_key=#{@API_KEY}&sign=#{sign}"
+    response = http.start {|http| 
+      http.request Net::HTTP::Get.new(uri.request_uri)
+    }
+    if response.code != '200'
+      raise ShinyError.new("Network error: #{response.code}")
+    else
       return JSON.parse(response.body)
+    end
+  end
+
+  def report(job_id, status)
+    url = @API_HOST + "Job/report"
+    payload = {
+      "jobId": job_id,
+      "status": status
+    }
+    payload_sign = sign(payload)
+    response = Net::HTTP.post_form(URI.parse(url), payload)
+    if response.code != '200'
+      begin
+        error = JSON.parse(response.body)
+      rescue
+        raise ShinyError.new("Network error: #{response.code}")
+      end
+      
+      raise ShinyError.new("Shiny error: #{error['error']['info']} code=#{error['error']['code']}")
     else
-      raise ShinyError.new('Network error:' + response.code)
+      JSON.parse(response.body)
     end
   end
 end

data/shiny-sdk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'shiny-sdk'
-  s.version     = '0.2.0'
+  s.version     = '1.0.0'
   s.date        = `git log --pretty="%ai" -n 1`.split(" ").first
   s.summary     = "Shiny SDK"
   s.description = "Shiny Ruby SDK"
@@ -8,6 +8,9 @@ Gem::Specification.new do |s|
   s.email       = 'i@wug.moe'
   s.files       = `git ls-files -z`.split("\0")
   s.homepage    = 'https://shiny.kotori.moe'
+  s.metadata = {
+    "source_code_uri" => "https://github.com/Shiny-Project/Shiny-Ruby-SDK/"
+  }
   s.license     = 'MIT'
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiny-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Koell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-23 00:00:00.000000000 Z
+date: 2021-08-15 00:00:00.000000000 Z
 dependencies: []
 description: Shiny Ruby SDK
 email: i@wug.moe
@@ -23,7 +23,8 @@ files:
 homepage: https://shiny.kotori.moe
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/Shiny-Project/Shiny-Ruby-SDK/
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -32,15 +33,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Shiny SDK