Rubyを使用してPDFから画像を抽出する

はじめに

このチュートリアルでは、ホストされたJPedalクラウドAPIを使用してPDFから画像を抽出する方法を説明します。独自のセルフホスト型JPedalマイクロサービスをセットアップすることもできます。

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

前提条件

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

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

gem install idr_cloud_client

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

bundle install

コード例

以下は、PDFから画像を抽出する基本的なコード例です。設定オプションと高度な機能については、下記をご覧ください。

require 'idr_cloud_client'

client = IDRCloudClient.new('https://my-self-hosted-service.com/' + IDRCloudClient::JPEDAL)

result = client.convert(
    input: IDRCloudClient::UPLOAD, 
    file: 'path/to/exampleFile.pdf',
    , 
    settings: '{"mode":"extractImages","type":"rawImages","format":"png"}')

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

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

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

JPedal Microserviceは、抽出完了時に抽出のステータスを送信するコールバックURLを受け付けます。コールバックURLを使用することで、抽出が完了したかどうかを判断するためにサービスをポーリングする必要がなくなります。
コールバックURLは、以下のようにconvertメソッドに提供できます。

result = client.convert(
    input: IDRCloudClient::UPLOAD,
    callbackUrl: 'http://listener.url',
    file: 'path/to/exampleFile.pdf',
    , 
    settings: '{"mode":"extractImages","type":"rawImages","format":"png"}')

設定オプション

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

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

URLによるアップロード

ローカルファイルをアップロードする以外に、JPedal Microserviceがダウンロードして抽出を実行するURLを提供することもできます。これを行うには、convertメソッドのinputとfileの値を以下のように置き換えます。

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

認証の使用

PDFから画像を抽出するためにユーザー名とパスワードが必要な独自のJPedal Microserviceをデプロイした場合、変換ごとにそれらを提供する必要があります。これらは、以下のようにconvertメソッドにauthという名前の変数を渡すことで提供されます。

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

詳細情報

GitHubのIDRCloudClient
RUBYのIDRCloudClient
JPedal Microservice API
JPedal Microserviceの使用方法