rongcloud-server-sdk-ruby

Rong Cloud Server SDK in Ruby.

Installation

Add this line to your application's Gemfile:

gem 'rongcloud-server-sdk', require: 'rongcloud'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install rongcloud-server-sdk

Usage

require "rongcloud"

rongcloud = RongCloud::Client.new(
  app_key: ENV["RONGCLOUD_APP_KEY"],
  app_secret: ENV["RONGCLOUD_APP_SECRET"],
  host: "api-cn.ronghub.com"
)

rongcloud.api.user.gettoken(
  userId: 'nutzer'
)

The API name is converted from the corresponding URI, E.g.

URI	Call use
/user/getToken.json	api.user.gettoken(...)
/user/token/expire.json	api.user.token_expire(...)
/push.json	api.push.(...)
/push/custom.json	api.push.custom(...)
/stat/getDayPushData.json	api.stat.getdaypushdata(...)
/stat/getPushIdData.json	api.stat.getpushiddata(...)
...	...

Timeout

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: 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

rongcloud = RongCloud::Client.new(
  app_key: ENV["RONGCLOUD_APP_KEY"],
  app_secret: ENV["RONGCLOUD_APP_SECRET"],
  host: "api-cn.ronghub.com",
  http: {
    features: {
      logging: {logger: Logger.new($stdout)}
    }
  }
)

Request ID

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
    }
  }
)

Thread Safe

rongcloud = RongCloud::Client.new(
  app_key: ENV["RONGCLOUD_APP_KEY"],
  app_secret: ENV["RONGCLOUD_APP_SECRET"],
  host: "api-cn.ronghub.com"
)

# RongCloud::Client is thread-safe.
thrs = []
thrs << Thread.new { rongcloud.api.user.gettoken(userId: 'nutzer') }
thrs << Thread.new { rongcloud.api.user.gettoken(userId: 'nutzer') }
thrs << Thread.new { rongcloud.api.user.gettoken(userId: 'nutzer') }
thrs << Thread.new { rongcloud.api.user.gettoken(userId: 'nutzer') }
thrs.each(&:join)

Signature Verify

verified = RongCloud::Signer.verify?(
  app_secret: ENV["RONGCLOUD_APP_SECRET"],
  nonce: params["nonce"],
  timestamp: params["timestamp"],
  signature: params["signature"]
)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/rspec 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/souk4711/rongcloud-server-sdk-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the rongcloud-server-sdk-ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.