qismo 0.1.0

data/lib/qismo/models/base.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Qismo
+  #
+  # Base object of Qismo object
+  #
+  class Base
+    #
+    # Transform object to hash
+    #
+    # @return [Hash]
+    #
+    def as_json
+      hash = {}
+      instance_variables.each { |var| hash[var.to_s.delete("@")] = instance_variable_get(var) }
+
+      hash
+    end
+
+    # @return [Array<Object>]
+    def self.descendants
+      ObjectSpace.each_object(Class).select { |klass| klass < self }
+    end
+
+    private
+
+    #
+    # Initialize object
+    #
+    # @param attrs [Hash] Attributes of object
+    #
+    def initialize(attrs = {})
+      attrs.each do |key, value|
+        initiate_object(key, value)
+      end
+    end
+
+    #
+    # Dynamically tranform hash to class attributes
+    #
+    # @param key [String,Symbol]
+    # @param value [String,Integer,TrueClass,FalseClass,Hash,Array]
+    #
+    #
+    def initiate_object(key, value)
+      if value.is_a?(TrueClass) || value.is_a?(FalseClass)
+        key_s = key.to_s
+        method_name = key_s.start_with?("is_") ? key_s.gsub("is_", "") : key_s
+        method_name += "?"
+
+        self.class.define_method(method_name) do
+          value
+        end
+      end
+
+      instance_variable_set("@#{key}", value)
+      self.class.class_eval { attr_reader(key.to_sym) }
+    end
+  end
+end

data/lib/qismo/models/bot.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Qismo
+  #
+  # Qismo bot object
+  #
+  class Bot
+    # @!parse
+    #   extend Resources::BotResource
+    extend Resources::BotResource
+  end
+end

data/lib/qismo/models/null_object.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Qismo
+  #
+  # Class to handle nil value
+  #
+  class NullObject
+    #
+    # @return [TrueClass,FalseClass]
+    #
+    def !
+      true
+    end
+
+    #
+    # @return [TrueClass,FalseClass]
+    #
+    def respond_to?(*)
+      true
+    end
+
+    #
+    # @return [TrueClass,FalseClass]
+    #
+    def instance_of?(klass)
+      raise(TypeError, "class or module required") unless klass.is_a?(Class)
+
+      self.class == klass
+    end
+
+    #
+    # @return [TrueClass,FalseClass]
+    #
+    def kind_of?(mod)
+      raise(TypeError, "class or module required") unless mod.is_a?(Module)
+
+      self.class.ancestors.include?(mod)
+    end
+
+    alias_method :is_a?, :kind_of?
+
+    #
+    # @return [Integer]
+    #
+    def <=>(other)
+      if other.is_a?(self.class)
+        0
+      else
+        -1
+      end
+    end
+
+    #
+    # @return [TrueClass,FalseClass]
+    #
+    def nil?
+      true
+    end
+
+    #
+    # @return [String]
+    #
+    def as_json(*)
+      "null"
+    end
+
+    #
+    # @return [String]
+    #
+    def to_json(*args)
+      nil.to_json(*args)
+    end
+
+    #
+    # @return [nil]
+    #
+    def presence
+      nil
+    end
+
+    #
+    # @return [TrueClass,FalseClass]
+    #
+    def blank?
+      true
+    end
+
+    #
+    # @return [TrueClass,FalseClass]
+    #
+    def present?
+      false
+    end
+
+    #
+    # @return [NullObject]
+    #
+    def method_missing(m, *args, &block)
+      self
+    end
+
+    #
+    # @return [TrueClass,FalseClass]
+    #
+    def respond_to_missing?(method_name, *args)
+      false
+    end
+  end
+end

data/lib/qismo/models/office_hour.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Qismo
+  #
+  # Office hour model
+  #
+  # @!attribute day [Integer]
+  # @!attribute starttime [String]
+  # @!attribute endtime [String]
+  #
+  class OfficeHour < Base
+  end
+end

data/lib/qismo/models/office_setting.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Qismo
+  #
+  # Office setting model
+  #
+  # @!attribute online_message [String]
+  # @!attribute offline_message [String]
+  # @!attribute timezone [String]
+  # @!attribute send_online_if_resolved [TrueClass, FalseClass]
+  # @!attribute send_offline_each_message [TrueClass, FalseClass]
+  # @!attribute is_in_office_hour [TrueClass, FalseClass]
+  # @!attribute office_hours [Array<OfficeHour>]
+  class OfficeSetting < Base
+    # @!parse
+    #   extend Resources::OfficeSettingResource
+    extend Resources::OfficeSettingResource
+  end
+end

data/lib/qismo/models/room.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Qismo
+  #
+  # Room model
+  #
+  # @!attribute channel_id [Integer]
+  # @!attribute contact_id [Integer]
+  # @!attribute is_handled_by_bot [Truelass, FalseClass]
+  # @!attribute is_resolved [Truelass, FalseClass]
+  # @!attribute is_waiting [Truelass, FalseClass]
+  # @!attribute last_comment_sender [String]
+  # @!attribute last_comment_sender_type [String]
+  # @!attribute last_comment_text [String]
+  # @!attribute last_comment_timestamp [String]
+  # @!attribute last_customer_comment_text [String, nil]
+  # @!attribute last_customer_timestamp [String]
+  # @!attribute name [String]
+  # @!attribute room_badge [String]
+  # @!attribute room_id [String]
+  # @!attribute room_type [String]
+  # @!attribute source [String]
+  # @!attribute user_avatar_url [String]
+  # @!attribute user_id [String]
+  #
+  class Room < Base
+    # @!parse
+    #   extend Resources::RoomResource
+    extend Resources::RoomResource
+  end
+end

data/lib/qismo/models/user.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Qismo
+  #
+  # User model
+  #
+  # @!attribute id [Integer]
+  # @!attribute name [String]
+  # @!attribute authentication_token [String]
+  # @!attribute is_available [TrueClass, FalseClass]
+  # @!attribute direct_login_token [String]
+  # @!attribute long_lived_token [String]
+  #
+  class User < Base
+    # @!parse
+    #   extend Resources::UserResource
+    extend Resources::UserResource
+  end
+end

data/lib/qismo/operations.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Qismo
+  module Operations
+  end
+end

data/lib/qismo/resources/agent_resource.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Qismo
+  module Resources
+    module AgentResource
+      #
+      # List agents
+      #
+      # @param options [Hash]
+      # @option options [Integer] :page Page number
+      # @option options [Integer] :limit Data offset per page
+      # @option options [String] :search Filter agent by query
+      # @option options [String] :scope Scoping search attribute. Can be `division`, `name`, or `email`
+      #
+      # @return [Array<Agent>]
+      #
+      def list(options = {})
+        resp = Qismo.client.get("/api/v2/admin/agents", options)
+        body = resp.http_body
+        agents = body.dig("data", "agents")
+        agents.dig("data", "agents").map { |agent| Agent.new(agent) }
+      end
+
+      #
+      # Get agent by id
+      #
+      # @param id [Integer] Agent's id
+      #
+      # @return [Agent]
+      #
+      def get(id)
+        resp = Qismo.client.call(:get, "/api/v2/admin/agent/#{id}")
+        body = resp.http_body
+        agent = body.dig("data", "agent")
+        Agent.new(agent)
+      end
+    end
+  end
+end

data/lib/qismo/resources/bot_resource.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Qismo
+  module Resources
+    module BotResource
+      #
+      # Send message to room as bot
+      #
+      # @param options [Hash]
+      # @option options [String] :room_id
+      # @option options [String] :message
+      # @option options [String] :type required if type is not `text`
+      # @!attribute payload [Hash] required if type is not `text`
+      #
+      # @return [Response]
+      #
+      def send_message(options = {})
+        options[:sender_email] = Qismo.admin_email
+
+        validate_existence_of!(:sender_email, :message, :room_id, on: options)
+        options[:room_id] = options[:room_id].to_s
+
+        Qismo.client.post("/#{Qismo.client.app_id}/bot", options)
+      end
+
+      #
+      # Notify admin and/or agent that bot need human help
+      #
+      # @param room_id [Integer]
+      # @param roles [Array<Integer>]
+      # @param options [Hash]
+      # @option options [TrueClass] :find_online_agent
+      #
+      # @return [Response]
+      #
+      def handover(room_id, *roles, **options)
+        if roles.empty?
+          Qismo.client.request(:post, "/#{Qismo.client.app_id}/bot/#{room_id}/hand_over", {
+            headers: { authorization: Qismo.client.secret_key },
+          })
+        else
+          int_roles = []
+          roles.each { |role| int_roles.append(role) }
+
+          if roles.size == 1
+            options[:role] = int_roles.first
+          else
+            options[:roles] = int_roles
+          end
+
+          options = options.compact
+
+          Qismo.client.request(:post, "/#{Qismo.client.app_id}/bot/#{room_id}/hand_over_to_role", {
+            json: options,
+            headers: { authorization: Qismo.client.secret_key },
+          })
+        end
+      end
+    end
+  end
+end

data/lib/qismo/resources/office_setting_resource.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Qismo
+  module Resources
+    module OfficeSettingResource
+      #
+      # Get office hours
+      #
+      # @return [OfficeSetting]
+      #
+      def office_hours
+        resp = Qismo.client.get("/api/v1/admin/office_hours")
+        body = resp.http_body
+
+        data = body["data"]
+
+        morfed_data = {}
+        morfed_data["online_message"] = data["online_message"]
+        morfed_data["offline_message"] = data["offline_message"]
+        morfed_data["timezone"] = data["timezone"]
+        morfed_data["send_online_if_resolved"] = data["send_online_if_resolved"]
+        morfed_data["send_offline_each_message"] = data["send_offline_each_message"]
+
+        office_hours = []
+        data["office_hours"].each do |oh|
+          office_hours.append(OfficeHour.new(oh))
+        end
+
+        morfed_data["office_hours"] = office_hours
+        morfed_data["is_in_office_hour"] = check_is_in_office_hour?(
+          morfed_data["timezone"],
+          morfed_data["office_hours"]
+        )
+
+        OfficeSetting.new(morfed_data)
+      end
+
+      private
+
+      #
+      # Check if current timestamp is in office hour
+      #
+      # @param timezone [String,Integer]
+      # @param office_hours [Array<OfficeHour>]
+      #
+      # @return [TrueClass, FalseClass]
+      #
+      def check_is_in_office_hour?(timezone, office_hours)
+        current = Time.now.getlocal(timezone)
+        current_weekday = current.strftime("%u").to_i
+
+        today_oh = office_hours.find { |oh| oh.day == current_weekday }
+        return false if today_oh.nil?
+
+        start_time = Time.parse("#{current.year}-#{current.month}-#{current.day} #{today_oh.starttime} #{timezone}")
+        end_time = Time.parse("#{current.year}-#{current.month}-#{current.day} #{today_oh.endtime} #{timezone}")
+
+        int_start_time = start_time.to_i
+        int_end_time = end_time.to_i
+
+        int_current = current.to_i
+
+        (int_start_time..int_end_time).include?(int_current)
+      end
+    end
+  end
+end

data/lib/qismo/resources/room_resource.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module Qismo
+  module Resources
+    module RoomResource
+      #
+      # List rooms
+      #
+      # @param params [Hash]
+      #
+      # @return [Array<Room>]
+      #
+      def list(params = {})
+        resp = Qismo.client.get("/api/v2/customer_rooms", params)
+
+        body = resp.http_body
+        customer_rooms = body.dig("data", "customer_rooms")
+
+        rooms = []
+        customer_rooms.each do |cr|
+          rooms.append(Room.new(cr))
+        end
+
+        rooms
+      end
+
+      #
+      # Get room by id
+      #
+      # @param id [Integer]
+      #
+      # @return [Room]
+      #
+      def get(id)
+        resp = Qismo.client.get("/api/v2/customer_rooms/#{id}")
+
+        body = resp.http_body
+        room = body.dig("data", "customer_room")
+        if room == {}
+          raise NotFound.new(
+            "Room with id #{id} is not found",
+            http_code: 404,
+            http_headers: resp.http_headers,
+            http_body: body,
+            http_raw_body: resp.http_raw_body
+          )
+        end
+
+        Room.new(room)
+      end
+
+      #
+      # Assign an agent to a room
+      #
+      # @param room_id [String]
+      # @param agent_id [Integer]
+      # @param options [Hash]
+      #
+      # @return [Agent]
+      #
+      def assign_agent(room_id, agent_id, options = {})
+        options[:room_id] = room_id.to_s
+        options[:agent_id] = agent_id
+
+        resp = Qismo.client.post("/api/v1/admin/service/assign_agent", options)
+
+        body = resp.http_body
+        added_agent = body.dig("data", "added_agent")
+
+        Agent.new(added_agent)
+      end
+
+      #
+      # List agents who can be assigned to a room
+      #
+      # @param options [Hash]
+      # @option options [Integer, String] :room_id Required
+      # @option options [Integer, String] :limit Optional. Default: 10. Max: 25
+      # @option options [String] :cursor_before
+      # @option options [String] :cursor_after
+      # @option options [String] :search Filter agents by name or email
+      #
+      # @return [Array<Agent>]
+      #
+      def other_agents(options = {})
+        validate_existence_of!(:room_id)
+
+        resp = Qismo.client.call(:get, "/api/v2/admin/service/other_agents", params: options)
+
+        body = resp.http_body
+        qismo_agents = body.dig("data", "agents")
+
+        agents = []
+        qismo_agents.each do |qismo_agent|
+          agents.append(Agent.new(qismo_agent))
+        end
+
+        agents
+      end
+
+      alias_method :eligible_agents, :other_agents
+
+      #
+      # Resolve room
+      #
+      # @param options [Hash]
+      # @option options room_id [String]
+      # @option options notes [String]
+      # @option options last_comment_id [Integer]
+      # @option options is_send_email [TruClass, FalseClass]
+      # @option options extras optional [Hash]
+      #
+      # @return [Response]
+      #
+      def resolve(options = {})
+        validate_existence_of!(:room_id, on: options)
+
+        fetch_last_comment_id = lambda do
+          resp = Qismo.client.raw_request(:get, "https://api.qiscus.com/api/v2.1/rest/load_comments", {
+            headers: { qiscus_sdk_app_id: Qismo.client.app_id, qiscus_sdk_secret: Qismo.client.secret_key },
+            params: { room_id: options[:room_id], limit: 1 },
+          })
+
+          body = resp.http_body
+          if body.empty?
+            raise BadRequest.new(
+              "There is no message in room #{options[:room_id]}",
+              http_code: 200,
+              http_headers: resp.http_headers,
+              http_body: resp.http_body,
+              http_raw_body: resp.http_raw_body
+            )
+          end
+
+          id = body.dig("results", "comments", 0, "id")
+          if id.nil?
+            raise BadRequest.new(
+              "There is no message in room #{options[:room_id]}",
+              http_code: 200,
+              http_headers: resp.http_headers,
+              http_body: resp.http_body,
+              http_raw_body: resp.http_raw_body
+            )
+          end
+
+          id
+        end
+
+        if falsy?(options[:last_comment_id])
+          options[:last_comment_id] = fetch_last_comment_id.call
+        end
+
+        validate_existence_of!(:last_comment_id, :notes, :is_send_email, :extras, on: options)
+
+        options[:room_id] = options[:room_id].to_i
+        Qismo.client.post(:post, "/api/v1/admin/service/mark_as_resolved", options)
+      end
+
+      #
+      # Activate bot in a room
+      #
+      # @param id [Integer] Room id
+      #
+      # @return [Response]
+      #
+      def activate_bot(id)
+        Qismo.client.post("/bot/#{id}/activate", is_active: true)
+      end
+
+      #
+      # Deactivate bot in a room
+      #
+      # @param id [Integer] Room id
+      #
+      # @return [Response]
+      #
+      def deactivate_bot(id)
+        Qismo.client.post("/bot/#{id}/activate", is_active: true)
+      end
+    end
+  end
+end

data/lib/qismo/resources/user_resource.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Qismo
+  module Resources
+    module UserResource
+      #
+      # Login to Qismo
+      #
+      # @param email [String]
+      # @param password [String]
+      # @param role [String]
+      #
+      # @return [User]
+      #
+      def login(email, password, role: "admin")
+        path = if role == "admin"
+          "/api/v1/auth"
+        else
+          "/api/v1/#{Qismo.client.app_id}/agent_auth"
+        end
+
+        resp = Qismo.client.post(path, email: email, password: password)
+
+        body = resp.http_body
+
+        data = body.fetch("data", {})
+        user = data.fetch("user", {})
+        user[:long_lived_token] = data["long_lived_token"]
+
+        User.new(user)
+      end
+
+      #
+      # Logout from Qismo
+      #
+      # @param access_token [String]
+      #
+      # @return [Response]
+      #
+      def logout(access_token)
+        Qismo.client.request(:post, "/api/v2/auth/logout", headers: { authorization: access_token })
+      end
+    end
+  end
+end