rongcloud-server-sdk 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59cfd97613387ba8f0d9935ee385ea2cd22b63ec3af3cbf9eb0d20621e163607
-  data.tar.gz: 9ad92c2b7ee3326c6785899d5f576d3e1f6a58d436e03e37e90832acc64b11e8
+  metadata.gz: '0898c0d2461a0ecc981eba721cc87642bb26100b9a5af85f0a157d96cdcf9b41'
+  data.tar.gz: 1245cc5bf1ffeefad59cb70076a5ebcbc12726bdecb0cf9e63788155dbfa8a4b
 SHA512:
-  metadata.gz: 519d20363f451a358dba1bd6a01c3a446d82e3bd548f0d61e2d901411092c5e60e29a34f603773ff4d159a2d9b3db91736cef67e553c22ab9cd333c99fe33532
-  data.tar.gz: f233475c85c2d2a1aee92253d6a0661a569fe10ea4b55b3ccad16f2a8b3c17a2b1be72dbccbda89383c3d9bd342c6b9bf1aa5dab21376e7ec3c4331f05594eef
+  metadata.gz: ada95eaf38153ee31309295c2fce303efd8236ba2d3f04599541a0bad90deb7eb8fb32dab8daf1c7a85b676ec69086d954c1dc5fa1f9197dcf55ef9985135622
+  data.tar.gz: 34ee47d12ead0fd583f655a2f1a5b341745e3c9eb92f637e9e34a79b83743cbacf6673c1f7dcc1a83c08289e10ca1ff4597440fa62b4b9c9cfe77e9f515e515c

data/.env.defaults

@@ -0,0 +1,2 @@
+RONGCLOUD_APP_KEY=""
+RONGCLOUD_APP_SECRET=""

data/.overcommit.yml

@@ -15,6 +15,10 @@
 #
 # Uncomment the following lines to make the configuration take effect.
 
+CommitMsg:
+  CapitalizedSubject:
+    enabled: false
+
 PreCommit:
   RuboCop:
     enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rongcloud-server-sdk (1.0.1)
+    rongcloud-server-sdk (1.1.0)
       http (~> 5.0)
 
 GEM
@@ -17,12 +17,12 @@ GEM
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     dotenv (2.8.1)
-    ffi (1.15.5)
+    ffi (1.16.3)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
     hashdiff (1.0.1)
-    http (5.1.0)
+    http (5.1.1)
       addressable (~> 2.8)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)

data/README.md

@@ -23,7 +23,9 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-rongcloud = RongCloud::Client::new(
+require "rongcloud"
+
+rongcloud = RongCloud::Client.new(
   app_key: ENV["RONGCLOUD_APP_KEY"],
   app_secret: ENV["RONGCLOUD_APP_SECRET"],
   host: "api-cn.ronghub.com"
@@ -49,21 +51,34 @@ The API name is converted from the corresponding URI, E.g.
 ### Timeout
 
 ```ruby
-rongcloud = RongCloud::Client::new(
+rongcloud = RongCloud::Client.new(
   app_key: ENV["RONGCLOUD_APP_KEY"],
   app_secret: ENV["RONGCLOUD_APP_SECRET"],
   host: "api-cn.ronghub.com",
   http: {
     timeout_class: HTTP::Timeout::Global,
-    timeout_options: {global_timeout: 2}
+    timeout_options: {global_timeout: 5}
   }
 )
+
+# Use the global HTTP timeout options.
+rongcloud.api.user.gettoken({
+  userId: "nutzer", name: "John Doe"
+})
+
+# Override global HTTP timeout options in a specific HTTP request.
+rongcloud.api.user.gettoken({
+  userId: "nutzer", name: "John Doe"
+}, {
+  timeout_class: HTTP::Timeout::Global,
+  timeout_options: {global_timeout: 10}
+})
 ```
 
 ### Logging
 
 ```ruby
-rongcloud = RongCloud::Client::new(
+rongcloud = RongCloud::Client.new(
   app_key: ENV["RONGCLOUD_APP_KEY"],
   app_secret: ENV["RONGCLOUD_APP_SECRET"],
   host: "api-cn.ronghub.com",
@@ -75,6 +90,45 @@ rongcloud = RongCloud::Client::new(
 )
 ```
 
+### Request ID
+
+```ruby
+class RequestID < HTTP::Feature
+  def wrap_request(req)
+    req.headers["X-Request-ID"] = make_request_id
+    req
+  end
+
+  private
+
+  def make_request_id
+    Thread.current[:request_id] || SecureRandom.uuid
+  end
+end
+
+rongcloud = RongCloud::Client.new(
+  app_key: ENV["RONGCLOUD_APP_KEY"],
+  app_secret: ENV["RONGCLOUD_APP_SECRET"],
+  host: "api-cn.ronghub.com",
+  http: {
+    features: {
+      request_id: RequestID.new
+    }
+  }
+)
+```
+
+### Signature Verify
+
+```ruby
+verified = RongCloud::Signer.verify?(
+  app_secret: ENV["RONGCLOUD_APP_SECRET"],
+  nonce: params["nonce"],
+  timestamp: params["timestamp"],
+  signature: params["signature"]
+)
+```
+
 
 ## Development
 

data/lib/rongcloud/api/user.rb

@@ -7,6 +7,9 @@ module RongCloud
       member "/user/token/expire.json"
       member "/user/info.json"
       member "/user/refresh.json"
+      member "/user/tag/set.json", format: :json
+      member "/user/tag/batch/set.json", format: :json
+      member "/user/tags/get.json"
 
       member "/user/block.json"
       member "/user/block/query.json"

data/lib/rongcloud/api.rb

@@ -32,8 +32,8 @@ module RongCloud
           end
 
           format = options[:format] || :form
-          define_method(meth) do |payload|
-            client.post(url, format => payload)
+          define_method(meth) do |payload, opts = {}|
+            client.post(url, opts.merge(format => payload))
           end
         end
       end

data/lib/rongcloud/http.rb

@@ -17,7 +17,7 @@ module RongCloud
 
       nonce = random_str(16)
       timestamp = (Time.now.to_f * 1000).to_i.to_s
-      options[:headers] = {
+      options[:headers] = (options[:headers] || {}).merge({
         "RC-App-Key" => @client.app_key,
         "RC-Nonce" => nonce,
         "RC-Timestamp" => timestamp,
@@ -26,7 +26,7 @@ module RongCloud
           nonce: nonce,
           timestamp: timestamp
         })
-      }
+      })
 
       begin
         response = http(@options).request(verb, uri, options)

data/lib/rongcloud/version.rb

@@ -1,3 +1,3 @@
 module RongCloud
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/rongcloud-server-sdk.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/rongcloud/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rongcloud-server-sdk"
+  spec.version = RongCloud::VERSION
+  spec.authors = ["John Doe"]
+  spec.email = ["johndoe@example.com"]
+
+  spec.summary = "RongCloud Server SDK in Ruby."
+  spec.description = "RongCloud Server SDK in Ruby."
+  spec.homepage = "https://github.com/souk4711/rongcloud-server-sdk-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/souk4711/rongcloud-server-sdk-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/souk4711/rongcloud-server-sdk-ruby"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "http", "~> 5.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rongcloud-server-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - John Doe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-13 00:00:00.000000000 Z
+date: 2023-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -32,9 +32,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".env.defaults"
 - ".overcommit.yml"
 - ".rspec"
-- ".rubocop"
 - ".rubocop.yml"
 - ".ruby-version"
 - ".yardopts"
@@ -62,6 +62,7 @@ files:
 - lib/rongcloud/http.rb
 - lib/rongcloud/signer.rb
 - lib/rongcloud/version.rb
+- rongcloud-server-sdk.gemspec
 homepage: https://github.com/souk4711/rongcloud-server-sdk-ruby
 licenses:
 - MIT