Vonage Server SDK for Ruby 技术文档

本文档将指导用户如何安装、使用以及详细了解Vonage Server SDK for Ruby。以下是文档的主要内容：

1. 安装指南

使用Rubygems安装

通过以下命令使用Rubygems安装Vonage Server SDK：

gem install vonage

克隆仓库

或者，您可以克隆GitHub仓库：

git clone [e-mail]:Vonage/vonage-ruby-sdk.git

2. 项目使用说明

引入库

首先，需要引入Vonage库：

require 'vonage'

创建客户端对象

然后，使用您的API密钥和密钥创建一个客户端对象：

client = Vonage::Client.new(api_key: 'YOUR-API-KEY', api_secret: 'YOUR-API-SECRET')

现在，您可以使用客户端对象调用Vonage API。例如，发送一条短信：

client.sms.send(from: 'Ruby', to: '447700900000', text: 'Hello world')

在生产环境中，您可以通过设置VONAGE_API_KEY和VONAGE_API_SECRET环境变量来指定密钥和密钥，以避免将凭证存储在源代码控制中。

JWT认证

对于支持JWT认证的新端点（如Voice API和Messages API），您还需要指定application_id和private_key选项。例如：

client = Vonage::Client.new(application_id: application_id, private_key: private_key)

日志记录

使用logger选项来指定日志记录器。例如：

require 'logger'

logger = Logger.new(STDOUT)

client = Vonage::Client.new(logger: logger)

异常处理

当从Vonage API接收到错误响应时（HTTP响应不在2xx或3xx范围内），可以通过Exception对象的http_response getter方法获取Net::HTTPResponse对象。

覆盖默认主机

要覆盖SDK用于HTTP请求的默认主机，需要在客户端配置中指定api_host、rest_host或两者。

HTTP客户端配置

可以在HTTP客户端上设置配置选项。这可以通过在Vonage::Client实例化时使用:http键或在Vonage::Config对象上使用http= setter完成。

3. 项目API使用文档

以下是Vonage Server SDK的一些关键API使用示例：

发送短信

client.sms.send(from: 'Vonage', to: '44700000000', text: 'Hello World!')

开始验证

client.verify2.start_verification(
  brand: 'Acme',
  workflow: [{channel: 'sms', to: '44700000000'}]
)

验证Webhook签名

client.sms.verify_webhook_sig(
  webhook_params: params,
  signature_secret: 'secret',
  signature_method: 'sha512'
)

4. 项目安装方式

请参考“安装指南”部分中的步骤进行安装。

通过本文档，用户应该能够有效地使用Vonage Server SDK for Ruby，并了解其安装和配置方法。