RubyでBuildVuマイクロサービスにアクセスする

はじめに

このチュートリアルでは、ホストされたBuildVuクラウドAPIを使用してPDFファイルをHTMLまたはSVGに変換する方法を説明します。以下のようなサービスが対象です：

IDRsolutionsトライアルおよびクラウドサブスクリプションサービス
独自のセルフホストBuildVuマイクロサービス

上記のサービスは通常のHTTPリクエストでアクセスできますが、このチュートリアルではオープンソースのRuby IDRCloudClient を使用します。これはREST API のシンプルなRubyラッパーを提供します。

前提条件

プロジェクトでIDRCloudClientを使用するには2つの方法があります。

gemを使用して、以下のコマンドでidr_cloud_client gem をインストールします：

gem install idr_cloud_client

または、アプリケーションのgemfileに"gem ‘idr_cloud_client’“という行を追加してから、以下のコマンドを実行します。

bundle install

コード例

PDFファイルをHTMLまたはSVGに変換するための基本的なコード例を以下に示します。設定オプションと高度な機能については以下を参照してください。

require 'idr_cloud_client'

client = IDRCloudClient.new('https://cloud.idrsolutions.com/cloud/' + IDRCloudClient::BUILDVU)

result = client.convert(
    # token='Token', # IDRsolutionsトライアルおよびクラウドサブスクリプションサービスに接続する場合のみ必須
    input: IDRCloudClient::UPLOAD, 
    file: 'path/to/exampleFile.pdf')

client.download_result(result, 'path/to/output/dir')

puts 'Download URL: ' + result['downloadUrl']

コールバックURLに結果を返す

BuildVuマイクロサービスは、変換完了時に変換のステータスを送信するためのコールバックURLを受け付けます。コールバックURLを使用することで、変換完了を確認するためにサービスをポーリングする必要がなくなります。
コールバックURLは、以下のようにconvertメソッドに提供できます。

result = client.convert(
    # token='Token', # IDRsolutionsトライアルおよびクラウドサブスクリプションサービスに接続する場合のみ必須
    input: IDRCloudClient::UPLOAD,
    callbackUrl: 'http://listener.url',
    file: 'path/to/exampleFile.pdf')

設定オプション

BuildVu APIは、変換をカスタマイズするためのキーと値のペアの設定オプションを含む文字列化されたJSONオブジェクトを受け付けます。設定はconvertメソッドに提供する必要があります。PDFファイルをHTMLまたはSVGに変換するための設定オプションの完全なリストはこちらで確認できます。

settings:'{"key":"value","key":"value"}'

URLによるアップロード

ローカルファイルをアップロードする代わりに、BuildVuマイクロサービスがダウンロードして変換を実行するURLを提供することもできます。これを行うには、convertメソッドのinputとfileの値を以下のように置き換えます。

input:IDRCloudClient.DOWNLOAD
url:'http://exampleURL/exampleFile.pdf'

認証の使用

PDFファイルをHTMLまたはSVGに変換するためにユーザー名とパスワードが必要な独自のBuildVuマイクロサービスをデプロイしている場合、各変換時にそれらを提供する必要があります。これらは、以下のようにconvertメソッドにauthという名前の変数を渡すことで提供されます。

auth:('username', 'password'))

詳細情報

GitHubのIDRCloudClient
RUBYのIDRCloudClient
BuildVuマイクロサービスAPI
BuildVuマイクロサービスの使用