Hubot는 여러 플랫폼에서 작동하는 앱을 빌드하는 데 유용한 방법입니다. Google Chat Hubot 어댑터를 사용하면 Google Chat에서 Hubot 앱을 쉽게 활용할 수 있습니다. 어댑터는 메시지를 Hubot으로 피드하고 응답을 제공합니다.
Google Chat Hubot 어댑터는 다음 두 가지 유형의 엔드포인트를 지원합니다.
- HTTP
- Cloud Pub/Sub
이 가이드에서는 두 가지 유형의 엔드포인트를 사용하여 Google Chat에서 Hubot 앱을 실행하는 방법을 설명합니다.
설치
Hubot 시작하기의 안내에 따라 필요한 도구인 Node.js, npm, Hubot generator를 다운로드하고 설치합니다.
내장 셸 어댑터를 사용하는 Hubot의 새 인스턴스를 만들어 Hubot 스크립트를 설치하고 이를 사용해 Hubot 생태계에 대한 느낌을 알아보고 Hubot 앱을 개발할 수 있습니다.
Hubot Google Chat 어댑터 사용하기
이 섹션에서는 Google Chat 어댑터를 사용하는 Hubot 앱을 만들고 AppEngine에 배포하고 Google Chat에 앱을 게시하는 과정을 안내합니다. AppEngine 이외의 원하는 시스템에 앱을 배포할 수도 있습니다.
Google Chat Hubot 어댑터는 HTTP와 Cloud Pub/Sub의 두 가지 모드를 지원합니다. HTTP 모드는 Express 웹 서버를 가동하고 사용자가 지정한 포트에서 이벤트를 수신 대기합니다. Cloud Pub/Sub 모드는 Pub/Sub 구독자를 만들고 사용자가 지정한 구독에서 이벤트를 가져옵니다. Google Chat에서 이벤트를 수신할 때 두 모드 모두 Hubot의 Message 객체 중 하나를 확장하는 행아웃 ChatMessage 객체를 만들어 Hubot 스크립트로 전달합니다. Hubot 스크립트의 응답은 원래 메시지 이벤트가 앱에 게시된 Google Chat의 채팅 스페이스 또는 DM에 게시됩니다.
Hubot 인스턴스 만들기
계속 진행하기 전에 Hubot용 Node.js, npm 패키지 관리자, Yeoman 생성기를 설정했는지 확인하세요.
'myhubot'이라는 앱을 만든다고 가정해 보겠습니다. 먼저 새 디렉터리를 만든 후 이 디렉터리에 Hubot 인스턴스를 만듭니다.
$> mkdir myhubot
$> cd myhubot
$> yo hubot
이 시점에서 여만은 앱을 만드는 사람과 사용할 어댑터를 묻는 질문을 합니다. 어댑터에 google-hangouts-chat를 지정합니다.
또는 다음 명령어를 사용하여 어댑터를 별도로 설치할 수 있습니다.
$> npm install --save hubot-google-hangouts-chat
Hubot에서 실제 앱 동작은 스크립트를 사용하여 구현됩니다. Hubot은 테스트에 사용할 수 있는 샘플 스크립트와 함께 제공됩니다. 모든 설정이 완료되면 자체 스크립트를 맞춤설정하고 추가하여 원하는 앱 동작을 구현할 수 있습니다.
Google Chat 어댑터 옵션 구성하기
옵션은 환경 변수를 사용하여 Google Chat 어댑터에 전달됩니다.
서비스 계정
어댑터를 사용하려면 앱의 서비스 계정을 설정해야 합니다. 서비스 계정 사용 가이드에 따라 서비스 계정을 만들고 키가 포함된 JSON 파일을 다운로드합니다. 그런 다음 환경 변수에서 키 경로를 설정합니다.
# Point to the private key json file of the service account you created. $> export GOOGLE_APPLICATION_CREDENTIALS='Path to the service account key json file'
HTTP 옵션
HTTP 모드에서 어댑터를 실행하기 위해 추가 구성이 필요하지 않습니다. 어댑터는 기본적으로 포트 8080에서 실행되는 Hubot의 익스프레스 서버를 사용합니다. 포트를 변경하려면 PORT 환경 변수를 설정해야 합니다.
# Port number, 8080 by default. $> export PORT=8080
Cloud Pub/Sub 옵션
Pub/Sub 엔드포인트 설정을 참조하여 앱에서 사용할 GCP 프로젝트, Cloud Pub/Sub 주제, 구독, 서비스 계정을 설정합니다. 링크의 샘플 코드를 무시합니다. 아래 단락에서 Google Chat 어댑터를 사용하여 Hubot 앱을 만듭니다.
Pub/Sub 모드에서 Google Chat 어댑터를 사용하려면 다음 옵션을 설정해야 합니다.
# To toggle the adapter to Pub/Sub mode. $> export IS_PUBSUB=true # Set the IDs of the project and subscription you created. $> export PUBSUB_PROJECT_ID='GCP Project ID' $> export PUBSUB_SUBSCRIPTION_ID='GCP Cloud Pub/Sub Subscription ID'
로컬에서 실행
로컬에서 Hubot 인스턴스를 실행하려면 myhubot 디렉터리에서 해당 명령어를 실행합니다.
# For HTTP mode
$> bin/hubot -a google-hangouts-chat
# For Cloud Pub/Sub mode
$> bin/hubot -d -a google-hangouts-chat
Google Chat Hubot 어댑터가 초기화되면 다음 메시지가 콘솔에 표시됩니다.
Hangouts Chat adapter initialized successfully
HTTP 어댑터를 구성했는지 아니면 Cloud Pub/Sub 어댑터를 구성했는지에 따라 다른 관련 정보도 화면에 표시될 수 있습니다.
App Engine에서 배포
App Engine 빠른 시작의 안내에 따라 GCP 프로젝트 및 개발 환경을 설정합니다.
설정이 완료되면 아래 단계에 따라 AppEngine에서 Hubot 인스턴스를 구성하고 배포하세요.
app.yaml 만들기
먼저 Hubot 디렉터리에 app.yaml 파일을 만듭니다. 콘텐츠는 다음 예와 유사합니다.
runtime: nodejs8 env_variables: PORT: 8080
환경 구성
그런 다음 이 페이지의 환경 변수 구성 안내를 확인하세요.
package.json 만들기
마지막으로 node.js 버전과 앱을 실행하는 데 사용되는 스크립트 속성을 지정하는 package.json 파일을 만듭니다.
- package.json 파일에서 engines 속성에 사용할 Node.js 버전을 지정합니다.
- AppEngine은
npm start를 사용하여 애플리케이션을 시작합니다. package.json에서 scripts 속성을 설정하여 npm start Hubot를 호출하도록 구성합니다.
# Sample snippet of package.json file
"dependencies" : {
"hubot": "^3.1.1",
"hubot-google-hangouts-chat": "^3",
# more deps...
}
"scripts": {
"start": "bin/hubot -a google-hangouts-chat"
},
"engines": {
"node": ">=8"
}
# Once you've set up everything, deploy the app in AppEngine
$> gcloud app deploy
Google Chat에 게시
앱 게시 페이지의 안내에 따라 Google Cloud Console을 통해 Google Chat에 앱을 게시합니다. 앱 구성 페이지에서 적절한 엔드포인트 (HTTP 또는 Cloud Pub/Sub)를 구성합니다. 이전 단계에서 App Engine에 Hubot 인스턴스를 배포하기 위해 GCP 프로젝트를 만든 경우 동일한 GCP 프로젝트를 사용하여 앱을 게시할 수 있습니다.
앱 테스트
앱을 게시하면 스페이스에 추가하거나 Google Chat에서 앱으로 채팅 메시지를 시작할 수 있습니다. 앱은 앱으로 전송된 메시지에 응답해야 합니다. Hubot은 scripts 폴더에 샘플 스크립트와 함께 제공됩니다. 'badger'라는 단어가 포함된 메시지에 응답하는 샘플 스크립트의 코드 주석 처리를 삭제하고 앱을 다시 시작합니다.
앱 이름을 'myhubot'으로 지정하고 스페이스에 추가한 경우 아래와 같이 메시지를 보낼 수 있습니다.
@myhubot badger
앱에 다음과 같은 응답이 표시됩니다.
Badgers? BADGERS? WE DON'T NEED NO STINKIN BADGERS
이제 Hubot 스크립트를 맞춤설정하거나 Hubot 인스턴스에 추가하여 앱에 원하는 기능을 구현할 수 있습니다. Google Chat 전용 스크립트 예를 보려면 Google Chat 어댑터 GitHub 저장소를 참고하세요.