qismo 0.12.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb55e3c23efa55080a8c65449b619f5d1016d9f3ef72b0692413654687e98e38
-  data.tar.gz: 610b16a6507bd54a017602146ce5866111e0bb89a0c36f491ec1898057ffb51d
+  metadata.gz: bbb77849305f7812a453eefbea9e5f288ede162774aadb8f638760ae6349b519
+  data.tar.gz: e5f4fd6c8bbae34bc30707cd08f629ac32932b20f10a73307edd8689707ab532
 SHA512:
-  metadata.gz: 522f77e9e507001a0e6f07834c0e048c88716a93f810a8cdff7dafb38bb31d8faa50d4d2165878468fdbe3ab13bbc7916a63509293e798da99bd4c73582115ae
-  data.tar.gz: 76e9cead4064ad7f28c3b04144976356c1f46d62f11ec71029820d1043c9e728f71980c389e52be4d215cdd36916652de43544bc56f23ca62ce6362d36866e48
+  metadata.gz: 292760f08f8b16bf5093916564ee4ea0e3f641c7e51ca4c0e65aa6a54bbb3e67a83204a1b087a9e60d7fdcfd5dbced2179e6334b783f87e0570fae5f8f762b1d
+  data.tar.gz: 5af35068e56009c635b0e43af48c2b51517095c610e29ea3d353f5519d4ed29935cee99158cf88a896945607f4c215895037e682c06e39dd45ec90863ef1f234

data/Gemfile

@@ -10,6 +10,5 @@ group :development do
   gem "byebug", "~> 11.1"
   gem "rake", "~> 13.0"
   gem "rspec", "~> 3.0"
-  gem "solargraph", "~> 0.47.2"
   gem "standard", ">= 1"
 end

data/README.md

@@ -12,57 +12,73 @@ bundle add qismo
 
 ## Usage
 
-### Initialize and make request
-
-To start using Qismo ruby, you must get your account's `App ID` and `Qiscus Secret Key` which can be checked in your admin dashboard's [settings page](https://omnichannel.qiscus.com/settings). After getting these data, you can start initialize the client.
-
 ```ruby
+# config/initializers/qismo.rb
+
 Qismo.configure do |client|
-  client.app_id           = "YOU_ACCOUNT_APP_ID"
-  client.secret_key       = "YOUR_ACCOUNT_SECRET_KEY"
-
-  ## Optional
-  client.url              = "https://qismo.qiscus.com"
-  client.logger           = { logger: Logger.new($stdout) }
-  client.instrumentation  = { instrumenter: ActiveSupport::Notifications.instrumenter }
-  client.timeout          = { connect: 5, write: 2, read: 5 }
-  client.proxy            = ["proxy-hostname.local", 8080, "username", "password"]
+  client.app_id           = ENV["QISCUS_APP_ID"]
+  client.secret_key       = ENV["QISCUS_SECRET_KEY"]
 end
 ```
 
-Then, start requesting to any endpoint yg want
+Then, start requesting to available endpoint
 
 ```ruby
 params = {
-  channel: { id: 12345, source: "wa" },
+  channel: { channel_id: 12345, source: "wa" },
   status: "unresolved",
   serve_status: "served",
-  is_handled_by_bot: false,
+  is_handled_by_bot: true,
 }
 
+# List rooms
 rooms = Qismo.rooms(params)
-```
 
-If your app manage multiple app id, you initialize the client like below
-
-```ruby
-client = Qismo::Client.new(app_id: "YOUR_ACCOUNT_APP_ID", secret_key: "YOUR_ACCOUNT_SECRET_KEY")
+puts rooms
+# [
+#   #<Qismo::SingleObject
+#     channel_id=6171,
+#     contact_id=71716,
+#     id=181917,
+#     is_handled_by_bot=true,
+#     is_resolved=false,
+#     is_waiting=false,
+#     last_comment_sender="admin@qismo.com",
+#     last_comment_sender_type="system",
+#     last_comment_text="Agent joined this conversation",
+#     last_comment_timestamp="2022-12-09T04:25:55Z",
+#     last_customer_comment_text=nil,
+#     last_customer_timestamp="2022-11-28T09:03:08Z",
+#     name="Customer - Yogyakarta",
+#     room_badge="https://multichannel.qiscus.com/img/whatsapp_badge.svg",
+#     room_id="8191816171",
+#     room_type="individual",
+#     source="wa",
+#     user_avatar_url="https://multichannel.qiscus.com/img/default_avatar.svg",
+#     user_id="628155555711"
+#   >
+# ]
 ```
 
-Then, start requesting to an endpoint using that `client` variable
+## Multiple app id client initialization
 
 ```ruby
+client = Qismo::Client.new(app_id: "QISCUS_APP_ID", secret_key: "QISCUS_SECRET_KEY")
+
 params = {
-  channel: { id: 12345, source: "wa" },
+  channel: { channel_id: 12345, source: "wa" },
   status: "unresolved",
   serve_status: "served",
-  is_handled_by_bot: false,
+  is_handled_by_bot: true,
 }
 
-rooms = client.rooms(params)
+# This will produce same result as explained before
+client.rooms(params)
 ```
 
-### Client configuration
+## Client optional configuration
+
+Qismo ruby also provide some optional configuration that you can pass, they are:
 
 **url**
 
@@ -130,7 +146,7 @@ Proxy needs authentication?
 client.proxy = ["proxy-hostname.local", 8080, "username", "password"]
 ```
 
-### Handling pagination
+## Handling pagination
 
 Some of the Qiscus Omnichannel API will return list of data with pagination. To handle the pagination, you can to that like this example:
 
@@ -145,7 +161,7 @@ while rooms.has_next_page?
 end
 ```
 
-### Handling error
+## Handling error
 
 Qismo ruby raise error while getting non successful http code from Qiscus Omnichannel API. To handle it, you follow this example:
 
@@ -158,3 +174,87 @@ rescue Qismo::HTTPRequestError => e
   e.response_body
 end
 ```
+
+## Handle incoming webhook request
+
+Qiscus Omnichannel provide webhooks that triggered from various action on your account. Qismo ruby gem provide convenient way to handle the request.
+
+```ruby
+class QiscusWebhooksController < ApplicationController
+  skip_before_action :verify_authenticity_token
+  
+  def handle_agent_allocation_webhook
+    webhook = Qismo::WebhookRequests::OnAgentAllocationNeeded.new(JSON.parse(request.raw_body))
+    
+    # Do any action you want using payload that has been objectified
+    if webhook.candidate_agent.present?
+      Qismo.assign_agent(
+        webhook.room_id,
+        webhook.candidate_agent.id
+      )
+    end
+  end
+
+  def handle_custom_button_webhook
+    webhook = Qismo::WebhookRequests::OnCustomButtonClicked.new(JSON.parse(request.raw_body))
+
+    # Do any action you want using payload that has been objectified. The
+    # following example assuming you want to create Zendesk ticket
+    # everytime your agent click custom button "Create Ticket". We are
+    # assuming, you have setup Zendesk ruby client
+    zendesk_ticket_subject = webhook.additional_info.find do |info|
+      info.key == "Zendesk Ticket Subject"
+    end
+
+    if zendesk_ticket_subject.present?
+      ZendeskAPI::Ticket.create!(
+        zendesk_client,
+        subject: zendesk_ticket_subject.value,
+        submitter_id: webhook.agent.email,
+        priority: "urgent"
+      )
+    end
+  end
+
+  def handle_custom_channel_webhook
+    webhook = Qismo::WebhookRequests::OnCustomChannelMessageSent.new(JSON.parse(request.raw_body))
+
+    # Do any action you want
+    # The following example assuming you want to reply customer's message from Twitter
+    # Assuming that you have installed and setup twitter ruby client
+
+    # Fetch customer from room participants
+    customer = webhook.payload.room.participants.find { |participant| participant.email.start_with?("twitter_customer_") }
+    if customer.present?
+      twitter_rest_client.create_direct_message(webhook.payload.rooms, webhook.payload.message.text)
+    end
+  end
+
+  def handle_bot_webhook
+    webhook = Qismo::WebhookRequests::OnMessageForBotSent.new(JSON.parse(request.raw_body))
+
+    # Do any action you want. The following example assuming you want to use
+    # Dialogflow as bot engine
+
+    # Detect intent for customer's message
+    response = dialogflow_client.detect_intent(
+      session: "session_#{webhook.payload.room.id}",
+      query_input: {
+        text: {
+          text: webhook.payload.message.text,
+          language_code: "en-US"
+        }
+      }
+    )
+
+    # Parse bot message which will be sent back to customer
+    bot_message = response.query_result.fulfillment_text
+
+    # Send message to Qismo room
+    Qismo.send_bot_message(
+      webhook.payload.room.id,
+      message: bot_message
+    )
+  end
+end
+```