SDK Gemのはじめに ​

このガイドでは、次の方法について説明します。

• SDK gemをインストールして実行する
• 新しいコネクタープロジェクトを作成する
• コネクターのテストを設定する
• ローカルコネクターをWorkatoワークスペースにプッシュする

前提条件 ​

このチュートリアルを完了するには、次のものが必要です。

• Rubyバージョンマネージャー。 オペレーティングシステムに応じて、RubyのバージョンまたはRubyバージョンマネージャーをインストールする必要があります。

  Macユーザーは、RVM (Ruby Version Manager)または任意の別のマネージャーを使用できます。

  Windowsユーザーは、Ruby Installerを使用できます。

  詳細については、Rubyインストールドキュメントを参照してください。

• サポートされているRubyのバージョン。 2.7.Xを推奨しますが、バージョン3.0.Xまたは3.1.Xを使用できます。 Rubyがインストールされていない場合は、こちらの手順に従ってインストールしてください。

  次のコマンド、またはRubyバージョンマネージャーに適したコマンド（例：rvm current）を実行して、Rubyのバージョンを確認できます。

  shell

  $ ruby -v
  ruby 2.7.X

  このコマンドは、コンピューターに現在インストールされているRubyのバージョンを返します。 この例では、2.7.Xを使用しています。

ステップ1：SDK Gemをインストールして実行する ​

コマンドライン（CLI）を使用してSDK gemをインストールするには、次の手順を完了します。

$ gem install workato-connector-sdk

$ workato

Commands:
  workato edit <PATH>            # Edit encrypted file, e.g. settings.yaml.enc
  workato exec <PATH>            # Execute connector defined block
  workato generate <SUBCOMMAND>  # Generates code from template
  workato help [COMMAND]         # Describe available commands or one specific command
  workato new <CONNECTOR_PATH>   # Inits new connector folder
  workato push <FOLDER>          # Upload and release connector's code

Options:
  [--verbose], [--no-verbose]

$ gem which workato-connector-sdk

ステップ2：新しいコネクタープロジェクトを作成する ​

これでセットアップが完了しました。次は、コネクターの作成に進みましょう。

$ workato new <PATH>

Please select default HTTP mocking behavior suitable for your project?

1 - secure. Cause an error to be raised for any unknown requests, all request recordings are encrypted.
            To record a new cassette you need set VCR_RECORD_MODE environment variable

            Example: VCR_RECORD_MODE=once bundle exec rspec spec/actions/test_action_spec.rb

2 - simple. Record new interaction if it is a new request, requests are stored as plain text and expose secret tokens.

workato newコマンドによって作成されるファイルの詳細については、プロジェクトディレクトリリファレンスを参照してください。

ステップ3：コネクターを構築してテストする ​

この手順では、コネクターを構築してテストします。 何をどのように構築するかはユーザー次第であるため、このセクションではテストのみを扱います。

• テスト認証情報を提供する
• コネクターをテストする

ステップ3.1：テスト認証情報を提供する ​

認証情報は、プロジェクトのsettings.yaml.encまたはsettings.yamlファイルに保存されます。

$ EDITOR="<EDITOR>" workato edit settings.yaml.enc

$ set EDITOR=notepad
$ workato edit settings.yaml.enc

## settings.yaml.enc

api_key: [api_key]
domain: [domain]

ステップ3.2：コネクターをテストする ​

workato execを使用して、コネクターのコネクション、トリガー、またはアクションをテストします。 これにより、指定したPATHにあるコネクターのlambdaブロックが実行されます。

例:

# Executes the execute block of the new_record action
$ workato exec actions.new_record.execute

# Invokes a polling trigger for the updated_record trigger
$ workato exec triggers.updated_record.poll

# Executes the get_record method with parameters from input.json
$ workato exec methods.get_record --args=input.json

CLIでのテストの詳細については、CLIでのテストlambda実行ガイドを確認してください。

ステップ4：Workatoワークスペースにプッシュする ​

準備ができたら、ローカルEnvironmentからWorkatoワークスペースにコネクターコードをプッシュできます。 Workatoワークスペースにプッシュすると、コネクターの機能とUXをテストでき、迅速に反復できることを確認できます。 コネクターコードをWorkatoワークスペースにプッシュするには、次の手順を完了します。

$ workato push

ステップ5：コネクターのRSpecテストを実行する ​

単体テストを使用して、コネクターの各反復が期待どおりに動作していることを確認できます。 コネクターのテスト作成の詳細を確認してください。 RSpecテストを実行するには、次の手順を完了します。

bundle exec rspec

# Runs the test(s) at line 16 of your spec file.
$ bundle exec rspec ./spec/connector_spec.rb:16

5.1 VCRを設定する ​

Workato SDK GemはRSpecおよびVCRと連携し、単体テストを作成し、HTTPインタラクション（リクエストとレスポンス）を保存する方法を提供します。これにより、APIにリクエストを繰り返し送信しなくても、これらの単体テストを引き続き実行できます。 これには、同じレスポンスを再生できるという利点もあるため、Application内の実際のデータの変更を心配する必要がありません。

Workatoを使用してプロジェクトを生成すると、これらの設定はデフォルトのVCR設定とともにspec_helper.rb内に自動的に生成されます。 これらのVCR記録は、プロジェクトを最初にセットアップしたときに選択したセキュリティ設定にも依存します。 secureを選択した場合、VCR記録はmaster.keyを使用して暗号化されます。

VCRの使用の詳細を確認してください。

次の予定 ​

• コネクターのアクション、トリガー、およびメソッドの開発について学ぶ
• GitHubでプロジェクトのCI/CDをセットアップする
• lambdaテストの実行の詳細を確認する