Karaden Rubyライブラリ

Karaden Rubyライブラリは、Rubyで書かれたアプリケーションからKaraden APIへ簡単にアクセスするための手段を提供します。
それにはAPIレスポンスから動的に初期化するAPIリソースの一連のクラス定義が含まれているため、Karaden APIの幅広いバージョンと互換性があります。

インストール方法

パッケージを変更しないならば、このソースコードは必要ありません。

Gemfile

Gemfileに下記の依存を追加します。

gem 'karaden-prg-ruby'

使い方

このライブラリを使用するには、Karadenでテナントを作成し、プロジェクト毎に発行できるトークンを発行する必要があります。
作成したテナントID（テナントIDはテナント選択画面で表示されています）は、Karaden::Config.tenant_idに、発行したトークンはKaraden::Config.api_keyにそれぞれ設定します。

require 'karaden'

Karaden::Config.api_key = '<トークン>'
Karaden::Config.tenant_id = '<テナントID>'

params = Karaden::Param::Message::MessageCreateParams.new_builder
.with_service_id(1)
.with_to('09012345678')
.with_body('本文')
.build

Karaden::Model::Message.create(params)

リクエスト毎の設定

同一のプロセスで複数のキーを使用する必要がある場合、リクエスト毎にキーやテナントIDを設定することができます。

require 'karaden'

params = Karaden::Param::Message::MessageDetailParams.new_builder
.with_id('<メッセージID>')
.build

request_options = Karaden::RequestOptions.new_builder
.with_api_key('<トークン>')
.with_tenant_id('<テナントID>')
.build

Karaden::Model::Message.detail(params, request_options)

タイムアウトについて

通信をするファイルサイズや実行環境の通信速度によってはHTTP通信時にタイムアウトが発生する可能性があります。
何度も同じような現象が起こる際は、ファイルサイズの調整もしくはRequestOptionsからタイムアウトの時間を増やして、再度実行してください。

request_options = Karaden::RequestOptions.new_builder
.with_api_key('<トークン>')
.with_tenant_id('<テナントID>')
.with_connection_timeout(<秒>)
.with_read_timeout(<秒>)
.build

bulk_message = Karaden::Service::BulkMessageService.create('<ファイルパス>', request_options)