qismo 0.18.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee4468cc8899fd8ff50f46e1a3b03a486d9535c58e450474624dfa46c9d7888d
-  data.tar.gz: 15d203e201451848742fdbfa7e67e26b2efb434f8ebeb64fc8af48c4dbeda486
+  metadata.gz: 4b5821ce5a3af4f9c2c0b8b2ff1436ee77c8395a4b98f06b3c64c45afc188cbf
+  data.tar.gz: ece73a2396b03a38acbb7e64352d4121988f2e5850018bab9d95c10ba88bc3ce
 SHA512:
-  metadata.gz: 47a01de9e692e3bc0836653702f553049bacada7fb955a9888425dc09dcee79fd99d0f4c3e79da4e32c9c0f8f50919e12ed8b1d2646599a8368cc86bf56e766e
-  data.tar.gz: 856f96e582d66c263c4caef6c71a27d48a894acfa8b51eed4e3279f09bab6c94a9a33219a3c58143359c7009a189bdea9d07f588010b3b162d8f19d9ab8ff9ae
+  metadata.gz: 4c605b2d1f6dd5ba69ff9dab9927dbeb63f9678f2b953364448893d2ac873a0770aa1c89bb7d3b42f7918a6cbd58e701eb3225f85718fcdd49ed97aef0f8a1cc
+  data.tar.gz: 73741ee9f08ccfb8aaaff41993ff91bc2bfa7ba5491e8d078a037ad769e22c802bed26a2e374b079eb539fb23715cf38bf64c21801d8151099e027832bbd015c

data/README.md

@@ -13,7 +13,7 @@ bundle add qismo
 ## Usage
 
 ```ruby
-client = Qismo::Client.new(app_id: "QISCUS_APP_ID", secret_key: "QISCUS_SECRET_KEY")
+qismo = Qismo::Client.new(app_id: "QISCUS_APP_ID", secret_key: "QISCUS_SECRET_KEY")
 
 params = {
   channel: [{ channel_id: 12345, source: "wa" }],
@@ -22,7 +22,7 @@ params = {
   is_handled_by_bot: true,
 }
 
-pp client.list_rooms(params)
+pp qismo.list_rooms(params)
 
 # [
 #   #<Qismo::Objects::CustomerRoom
@@ -57,7 +57,7 @@ Qismo ruby also provide some optional configuration that you can pass, they are:
 Defaultly, Qismo ruby will use your QISCUS_OMNICHANNEL_URL env as base url. If its nil, it will use https://qismo.qiscus.com. If you need to customize URL other than that, you can pass it at client initialization
 
 ```ruby
-client.url = "https://qismo.qiscus.com"
+qismo.url = "https://qismo.qiscus.com"
 ```
 
 **logger**
@@ -67,7 +67,7 @@ You can also log the request and response the any HTTP request you make in Qismo
 ```ruby
 require "logger"
 
-client.logger = Logger.new($stdout)
+qismo.logger = Logger.new($stdout)
 ```
 
 **instrumentation**
@@ -79,13 +79,13 @@ ActiveSupport::Notifications.subscribe('start_request.http') do |name, start, fi
   pp name: name, start: start.to_f, finish: finish.to_f, id: id, payload: payload
 end
 
-client.instrumentation = { instrumenter: ActiveSupport::Notifications.instrumenter }
+qismo.instrumentation = { instrumenter: ActiveSupport::Notifications.instrumenter }
 ```
 
 You can also customize the instrumentation's namespace by using this configuration
 
 ```ruby
-client.instrumentation = { instrumenter: ActiveSupport::Notifications.instrumenter, namespace: "qiscus.http_request" }
+qismo.instrumentation = { instrumenter: ActiveSupport::Notifications.instrumenter, namespace: "qiscus.http_request" }
 ```
 
 **timeout**
@@ -95,13 +95,13 @@ By default, the Qismo ruby gem does not enforce timeout on a request. You can en
 Per operation timeouts are what `Net::HTTP` and the majority of HTTP clients do:
 
 ```ruby
-client.timeout = { connect: 5, write: 2, read: 10 }
+qismo.timeout = { connect: 5, write: 2, read: 10 }
 ```
 
 Global timeouts let you set an upper bound of how long a request can take
 
 ```ruby
-client.timeout = 5 # in seconds
+qismo.timeout = 5 # in seconds
 ```
 
 **proxy**
@@ -109,13 +109,13 @@ client.timeout = 5 # in seconds
 Making request behind proxy is as simple as making them directly. Just specify hostname (or IP address) of your proxy server and its port, and here you go
 
 ```ruby
-client.proxy = ["proxy-hostname.local", 8080]
+qismo.proxy = ["proxy-hostname.local", 8080]
 ```
 
 Proxy needs authentication?
 
 ```ruby
-client.proxy = ["proxy-hostname.local", 8080, "username", "password"]
+qismo.proxy = ["proxy-hostname.local", 8080, "username", "password"]
 ```
 
 ## Handling pagination
@@ -126,11 +126,11 @@ Some of the Qiscus Omnichannel API will return list of data with pagination. To
 
 all_rooms = []
 
-rooms = client.list_rooms
+rooms = qismo.list_rooms
 all_rooms.append(rooms)
 
 while rooms.next_page.present?
-  rooms = client.list_rooms(cursor_after: rooms.next_page)
+  rooms = qismo.list_rooms(cursor_after: rooms.next_page)
   all_rooms.append(rooms)
 end
 ```
@@ -141,7 +141,7 @@ Qismo ruby raise error while getting non successful http code from Qiscus Omnich
 
 ```ruby
 begin
-  client.list_rooms
+  qismo.list_rooms
 rescue Qismo::BadRequestError => e
   puts e.message
   puts e.status_code
@@ -186,8 +186,8 @@ class QiscusWebhooksController < ApplicationController
 
     # Do any action you want using payload that has been objectified
     if webhook.candidate_agent.present?
-      client = Qismo::Client.new(app_id: "", secret_key: "")
-      client.assign_agent(
+      qismo = Qismo::Client.new(app_id: "", secret_key: "")
+      qismo.assign_agent(
         room_id: webhook.room_id,
         agent_id: webhook.candidate_agent.id
       )
@@ -250,11 +250,13 @@ class QiscusWebhooksController < ApplicationController
     bot_message = response.query_result.fulfillment_text
 
     # Send message to Qismo room
-    client = Qismo::Client.new(app_id: "", secret_key: "")
-    client.send_bot_message(
+    qismo = Qismo::Client.new(app_id: "", secret_key: "")
+    qismo.send_bot_message(
       room_id: webhook.payload.room.id,
       message: bot_message
     )
   end
 end
 ```
+## Developer Experience
+> TODO documentation

data/lib/qismo/api.rb

@@ -801,6 +801,8 @@ module Qismo
         email: email
       }.compact
 
+      options[:app_id] = app_id
+
       Qismo::Objects::CustomerRoom.new(post("/api/v2/qiscus/initiate_chat", options).data.customer_room)
     end
 

data/lib/qismo/client.rb

@@ -1,43 +1,90 @@
 # frozen_string_literal: true
 
+require "logger"
+
 module Qismo
   # Qismo ruby client
   #
   class Client
     include Qismo::Api
 
-    # @return [String, NilClass]
+    # @return [String]
     DEFAULT_APP_ID = ENV["QISCUS_APP_ID"]
 
-    # @return [String, NilClass]
+    # @return [String]
     DEFAULT_SECRET_KEY = ENV["QISCUS_SECRET_KEY"]
 
     # @return [String]
-    DEFAULT_URL = ENV["QISCUS_OMNICHANNEL_URL"] || "https://qismo.qiscus.com"
+    DEFAULT_URL = (ENV["QISCUS_OMNICHANNEL_URL"] || "https://multichannel.qiscus.com")
 
-    # @return [Hash]
-    DEFAULT_OPTIONS = {
+    # @return [String]
+    attr_accessor :app_id
+
+    # @return [String]
+    attr_accessor :secret_key
+
+    # @return [Addressable::URI]
+    attr_accessor :url
+
+    # @return [Logger]
+    attr_accessor :logger
+
+    # @return [ActiveSupport::Notifications::Instrumenter]
+    attr_accessor :instrumentation
+
+    # @return [Integer,Hash]
+    attr_accessor :timeout
+
+    # @return [Array<String,Integer>]
+    attr_accessor :proxy
+
+    # @return [String,Proc]
+    attr_accessor :admin_email
+
+    # Initiate Qismo Ruby client
+    #
+    # @param app_id [String]
+    #   Your account's app id. Can be checked in Qiscus Omnichannel dashboard.
+    #   We will use ENV["QISCUS_APP_ID"] value as default value.
+    # @param secret_key [String]
+    #   Your account's secret key. Can be checked in Qiscus Omnichannel dashboard.
+    #   We will use ENV["QISCUS_SECRET_KEY"] value as default value.
+    # @param url [String]
+    #   Custom base url for Qiscus Omnichannel client.
+    #   We will use ENV["QISCUS_OMNICHANNEL_URL"] value as default value.
+    #   If its not provided, we will use https://multichannel.qiscus.com as default value
+    # @param logger [Logger]
+    #   Http client logging. Default is nil
+    # @param instrumentation [ActiveSupport::Notifications::Instrumenter]
+    #   Http client instrumenter. Use ActiveSupport Instrumenter
+    # @param timeout [Integer, Hash]
+    #   Http client timout. Default is 5 seconds
+    # @param proxy [Array<String,Integer>]
+    #   Http client proxy
+    # @param admin_email [String,Proc]
+    #   Your account's admin email. Can be checked in Qiscus Omnichannel dashboard
+    def initialize(
       app_id: DEFAULT_APP_ID,
       secret_key: DEFAULT_SECRET_KEY,
       url: DEFAULT_URL,
-      logger: nil,
+      logger: Logger.new($stdout),
       instrumentation: nil,
-      timeout: nil,
-      proxy: nil
-    }
-
-    attr_accessor(*DEFAULT_OPTIONS.keys)
-    attr_reader :admin_email
-
-    # Initialize client
-    #
-    # @param options [Hash]
-    def initialize(options = {})
-      DEFAULT_OPTIONS.merge(options).each do |key, value|
-        instance_variable_set("@#{key}", value)
-      end
-
-      @admin_email = "#{@app_id}_admin@qismo.com"
+      timeout: 5,
+      proxy: nil,
+      admin_email: nil
+    )
+      @app_id = app_id
+      @secret_key = secret_key
+
+      # @type [Addressable::URI]
+      @url = Addressable::URI.parse(url)
+
+      @logger = logger
+      @instrumentation = instrumentation
+      @timeout = timeout
+      @proxy = proxy
+
+      @admin_email = (admin_email || -> { "#{@app_id}_admin@qismo.com" })
     end
 
     # Send http request with post method
@@ -85,7 +132,7 @@ module Qismo
     # @param json [Hash]
     # @return [Qismo::ObjectifiedHash]
     def request(method, path, options = {})
-      res = connection.request(method, @url + path, options.compact)
+      res = connection.request(method, @url.join(path), options.compact)
 
       if res.status.success?
         begin
@@ -124,16 +171,11 @@ module Qismo
     # @return [HTTP::Chainable]
     def connection
       http = HTTP
+      http = http.use(logging: @logger) if @logger.present?
+      http = http.use(instrumentation: @instrumentation) if @instrumentation.present?
+      http = http.via(*@proxy)
 
-      unless @logger.nil?
-        http = http.use(logging: @logger)
-      end
-
-      unless @instrumentation.nil?
-        http = http.use(instrumentation: @instrumentation)
-      end
-
-      unless @timeout.nil?
+      if @timeout.present?
         http = if @timeout.is_a?(Hash)
           http.timeout(**@timeout)
         else
@@ -141,10 +183,6 @@ module Qismo
         end
       end
 
-      unless @proxy.nil?
-        http = http.via(*@proxy)
-      end
-
       http.headers({
         "Qiscus-App-Id": @app_id,
         "Qiscus-Secret-Key": @secret_key,

data/lib/qismo/version.rb

@@ -2,5 +2,5 @@
 
 module Qismo
   # @return [String]
-  VERSION = "0.18.0"
+  VERSION = "0.18.1"
 end

data/qismo.gemspec

@@ -45,5 +45,4 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency("activesupport")
   spec.add_runtime_dependency("http")
   spec.add_runtime_dependency("dry-struct", "~> 1.6")
-  spec.add_runtime_dependency("dry-validation", "~> 1.10")
 end

data/vscode-snippet/qismo.code-snippets

@@ -1,8 +1,9 @@
 {
   "Initiate Qismo client": {
-    "prefix": "Qismo",
+    "prefix": "Qismo::Client",
+    "scope": "ruby",
     "body": [
-      "client = Qismo::Client.new(",
+      "qismo = Qismo::Client.new(",
       "  app_id: \"${1:app_id}\",",
       "  secret_key: \"${2:secret_key}\",",
       "  url: \"https://qismo.qiscus.com\",",
@@ -14,22 +15,105 @@
     "description": "Initiate Qismo client"
   },
   "List rooms": {
-    "prefix": "client.rooms",
-    "body": [
-      "rooms = client.rooms(",
-      "  channels: [{ source: \"wa\", channel_id: 716171 }],",
-      "  status: \"unresolved\",",
-      "  serve_status: \"served\",",
-      "  is_handled_by_bot: false,",
-      "  name: \"Qiscus\",",
-      "  limit: 50,",
-      "  tag_ids: [1,2,3],",
-      "  user_ids: [5,6,7],",
-      "  order: \"desc\",",
-      "  cursor_before: \"\",",
-      "  cursor_after: \"\"",
+    "prefix": "qismo.list_rooms",
+    "body": [
+      "rooms = qismo.list_rooms(",
+      "  channels: [{ source: \"${1|wa,telegram,qiscus,line,fb|}\", channel_id: 716171 }],",
+      "  status: \"${2|unresolved,resolved,almost_expired,expired|}\",",
+      "  serve_status: \"${3|served,unserved|}\",",
+      "  is_handled_by_bot: ${4|true,false|},",
+      "  name: \"${5:customer_name}\",",
+      "  limit: ${6:limit},",
+      "  tag_ids: [${7:tag_ids}],",
+      "  user_ids: [${8:user_ids}],",
+      "  order: \"${9|desc,asc|}\",",
+      "  cursor_before: \"${10:cursor_before}\",",
+      "  cursor_after: \"${11:cursor_after}\"",
       ")"
     ],
     "description": "List rooms"
+  },
+  "Get room by id": {
+    "scope": "ruby",
+    "prefix": "qismo.get_room",
+    "body": [
+      "room = qismo.get_room(room_id: ${1:room_id})"
+    ],
+    "description": "Get room by id"
+  },
+  "List room tags": {
+    "prefix": "qismo.list_room_tags",
+    "body": [
+      "room_tags = qismo.list_room_tags(room_id: ${1:12345})"
+    ],
+    "description": "List room tags"
+  },
+  "Add room tag": {
+    "prefix": "qismo.add_room_tag",
+    "body": [
+      "room_tag = qismo.add_room_tag(room_id: ${1:12345}, tag: \"${2:tag_name}\")"
+    ],
+    "description": "Add room tag"
+  },
+  "Delete room tag": {
+    "prefix": "qismo.delete_room_tag",
+    "body": [
+      "qismo.delete_room_tag(room_id: ${1:12345}, tag_id: ${2:12345})"
+    ],
+    "description": "Delete room tag"
+  },
+  "List room additional info": {
+    "prefix": "qismo.list_room_info",
+    "body": [
+      "room_info = qismo.list_room_info(room_id: ${1:12345})",
+      "room_info.each do |info|",
+      "  puts info.key",
+      "  puts info.value",
+      "end"
+    ],
+    "description": "List room additional info"
+  },
+  "Create room additional info": {
+    "prefix": "qismo.create_room_info",
+    "body": [
+      "room_info = qismo.create_room_info(room_id: ${1:12345}, info: [{key: \"${2:key}\", value: \"${3:value}\"}])",
+      "room_info.each do |info|",
+      "  puts info.key",
+      "  puts info.value",
+      "end"
+    ],
+    "description": "Create room additional info"
+  },
+  "Update room additional info": {
+    "prefix": "qismo.update_room_info",
+    "body": [
+      "room_info = qismo.create_room_info(room_id: ${1:12345}, info: [{key: \"${2:key}\", value: \"${3:value}\"}])",
+      "room_info.each do |info|",
+      "  puts info.key",
+      "  puts info.value",
+      "end"
+    ],
+    "description": "Update room additional info"
+  },
+  "List wa broadcast in room": {
+    "prefix": "qismo.list_room_broadcasts",
+    "body": [
+      "room_broadcasts = qismo.list_room_broadcasts(room_id: ${1:12345}, page: ${2:1}, limit: ${3:25})"
+    ],
+    "description": "List wa broadcast in room"
+  },
+  "Assign an agent to a room": {
+    "prefix": "qismo.assign_agent",
+    "body": [
+      "qismo.assign_agent(room_id: ${1:12345}, agent_id: ${2:12345}, replace_latest_agent: ${3|false,true|}, max_agent: ${4:1})"
+    ],
+    "description": "Assign an agent to a room"
+  },
+  "Remove an agent from a room": {
+    "prefix": "qismo.remove_agent",
+    "body": [
+      "qismo.remove_agent(room_id: ${1:12345}, agent_id: ${2:12345})"
+    ],
+    "description": "Remove an agent from a room"
   }
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qismo
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.1
 platform: ruby
 authors:
 - Qiscus Integration
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-25 00:00:00.000000000 Z
+date: 2023-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: dry-validation
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
 description: Ruby wrapper for Qiscus Omnichannel public API
 email:
 - developer@qiscus.net
@@ -120,7 +106,7 @@ homepage: https://bitbucket.org/qiscus/qismo-rb
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://bitbucket.org/qiscus/qismo-rb/src/v0.18.0
+  source_code_uri: https://bitbucket.org/qiscus/qismo-rb/src/v0.18.1
   documentation_uri: https://www.rubydoc.info/gems/qismo
   homepage_uri: https://bitbucket.org/qiscus/qismo-rb
   rubygems_mfa_required: 'true'