qismo 0.13.0 → 0.15.0

data/lib/qismo/client.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Qismo
+  # Qismo ruby client
+  #
   class Client
     include Qismo::Api
 
@@ -42,9 +44,9 @@ module Qismo
     #
     # @param path [String]
     # @param body [Hash]
-    # @return [Qismo::SingleObject]
+    # @return [Qismo::ObjectifiedHash]
     def post(path, body = {})
-      request(:post, path, json: body)
+      request(:post, path, json: body.compact)
     end
 
     # Send HTTP request with post method to upload file
@@ -53,25 +55,25 @@ module Qismo
     # @param body [Hash]
     # @return [Qismo::SingleObject]
     def post_upload(path, body = {})
-      request(:post, form: body)
+      request(:post, path, form: body.compact)
     end
 
     # Send HTTP request with get method
     #
     # @param path [String]
     # @param params [Hash]
-    # @return [Qismo::SingleObject]
+    # @return [Qismo::ObjectifiedHash]
     def get(path, params = {})
-      request(:get, path, params: params)
+      request(:get, path, params: params.compact)
     end
 
     # Send HTTP request with delete method
     #
     # @param path [String]
     # @param params [Hash]
-    # @return [Qismo::SingleObject]
+    # @return [Qismo::ObjectifiedHash]
     def delete(path, params = {})
-      request(:delete, path, params: params)
+      request(:delete, path, params: params.compact)
     end
 
     # Send HTTP request
@@ -81,16 +83,16 @@ module Qismo
     # @param headers [Hash]
     # @param params [Hash]
     # @param json [Hash]
-    # @return [Qismo::SingleObject]
-    def request(method, path, headers: {}, params: {}, json: {})
-      res = connection.request(method, @url + path, {
-        headers: headers,
-        params: params,
-        json: json
-      })
+    # @return [Qismo::ObjectifiedHash]
+    def request(method, path, options = {})
+      res = connection.request(method, @url + path, options.compact)
 
       if res.status.success?
-        return SingleObject.new(JSON.parse(res.to_s))
+        begin
+          return JSON.parse(res.to_s, object_class: Qismo::ObjectifiedHash)
+        rescue JSON::ParserError
+          return res.to_s
+        end
       end
 
       if res.status.server_error?
@@ -98,10 +100,10 @@ module Qismo
       end
 
       if res.status.client_error?
-        body = SingleObject.new(JSON.parse(res.to_s))
+        body = JSON.parse(res.to_s, object_class: Qismo::ObjectifiedHash)
 
         error = body.errors
-        error = error.message if error.is_a?(SingleObject)
+        error = error.message if error.is_a?(Hash)
 
         error_klass_map = {
           400 => BadRequestError,
@@ -146,7 +148,7 @@ module Qismo
       http.headers({
         "Qiscus-App-Id": @app_id,
         "Qiscus-Secret-Key": @secret_key,
-        "User-Agent": user_agent.to_json
+        "User-Agent": user_agent
       })
     end
 
@@ -154,13 +156,23 @@ module Qismo
     #
     # @return [Hash]
     def user_agent
-      {
+      format = {
+        lib_name: "Qismo Ruby",
         lib_version: Qismo::VERSION,
         lang: "ruby",
         lang_version: RUBY_VERSION,
         platform: RUBY_PLATFORM,
         engine: defined?(RUBY_ENGINE) ? RUBY_ENGINE : ""
       }
+
+      "#{format[:lib_name]}/#{format[:lib_version]} (#{format[:platform]}; #{format[:lang]}; v#{format[:lang_version]}) app_id:#{@app_id}"
+    end
+
+    # Default broadcast name for using in send broadcast api
+    #
+    # @return [String]
+    def default_broadcast_name
+      Time.current.strftime("%d/%m/%Y, %H:%I %z")
     end
   end
 end

data/lib/qismo/collection.rb

@@ -0,0 +1,21 @@
+module Qismo
+  # Class to handle paginated response from API
+  #
+  class Collection < Array
+    # Collection object
+    #
+    # @param data [Array]
+    # @param prev_page [String,Integer]
+    # @param next_page [String,Integer]
+    # @param pagination_type [String]
+    def initialize(data, prev_page: nil, next_page: nil)
+      super(data)
+
+      @prev_page = prev_page
+      @next_page = next_page
+    end
+
+    attr_reader :next_page
+    attr_reader :prev_page
+  end
+end

data/lib/qismo/object.rb

@@ -0,0 +1,21 @@
+require "dry-struct"
+
+module Qismo
+  # Object interface
+  #
+  class Object < Dry::Struct
+    include Qismo::Types
+
+    transform_keys(&:to_sym)
+
+    class << self
+      # Create object from array of hash
+      #
+      # @param array [Array<Hash>]
+      # @return [Array<Object>]
+      def from_array(array)
+        array.map { |a| new(a) }
+      end
+    end
+  end
+end

data/lib/qismo/objectified_hash.rb

@@ -0,0 +1,30 @@
+module Qismo
+  # Objectified hash interface for accesing hash using dot notation
+  #
+  class ObjectifiedHash < Hash
+    # method missing patch
+    def method_missing(method, *args, &block)
+      return super unless respond_to?(method)
+
+      fetch(method.to_s)
+    end
+
+    # respond to patch
+    def respond_to?(method_name, include_private = false)
+      fetch(method_name.to_s)
+
+      true
+    rescue KeyError
+      super(method_name, include_private)
+    end
+
+    # respond to missing patch
+    def respond_to_missing?(method_name, include_private = false)
+      fetch(method_name.to_s)
+
+      true
+    rescue KeyError
+      super(method_name, include_private)
+    end
+  end
+end

data/lib/qismo/objects/agent_service.rb

@@ -0,0 +1,53 @@
+module Qismo
+  # Objects module to handle schema for API response
+  #
+  module Objects
+    # Agent service object
+    #
+    class AgentService < Qismo::Object
+      # @!attribute [r] created_at
+      #   @return [String]
+      attribute? :created_at, Types::String.optional
+
+      # @!attribute [r] first_comment_id
+      #   @return [String]
+      attribute? :first_comment_id, Types::String.optional
+
+      # @!attribute [r] first_comment_timestamp
+      #   @return [String]
+      attribute? :first_comment_timestamp, Types::String.optional
+
+      # @!attribute [r] is_resolved
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_resolved, Types::Bool.optional
+
+      # @!attribute [r] last_comment_id
+      #   @return [String]
+      attribute? :last_comment_id, Types::String.optional
+
+      # @!attribute [r] notes
+      #   @return [String]
+      attribute? :notes, Types::String.optional
+
+      # @!attribute [r] resolved_at
+      #   @return [String]
+      attribute? :resolved_at, Types::String.optional
+
+      # @!attribute [r] retrieved_at
+      #   @return [String]
+      attribute? :retrieved_at, Types::String.optional
+
+      # @!attribute [r] room_id
+      #   @return [Integer]
+      attribute? :room_id, Types::String.optional
+
+      # @!attribute [r] updated_at
+      #   @return [String]
+      attribute? :updated_at, Types::String.optional
+
+      # @!attribute [r] user_id
+      #   @return [Integer]
+      attribute? :user_id, Types::Int.optional
+    end
+  end
+end

data/lib/qismo/objects/broadcast_job.rb

@@ -0,0 +1,99 @@
+module Qismo
+  module Objects
+    # Broadcast job object
+    #
+    class BroadcastJob < Qismo::Object
+      # Broadcast job user object
+      #
+      class User < Qismo::Object
+        # @!attribute [r] name
+        #   @return [String]
+        attribute? :name, Types::String.optional
+      end
+
+      # @!attribute [r] user
+      #   @return [Qismo::Objects::BroadcastJob::User]
+      attribute? :user, User.optional
+
+      # @!attribute [r] broadcast_job_id
+      #   @return [Integer]
+      attribute? :broadcast_job_id, Types::Int.optional
+
+      # @!attribute [r] broadcast_logs
+      #   @return [Array<Qismo::Objects::BroadcastLog>]
+      attribute? :broadcast_logs, Types.Array(Qismo::Objects::BroadcastLog.optional).optional
+
+      # @!attribute [r] language
+      #   @return [String]
+      attribute? :language, Types::String.optional
+
+      # @!attribute [r] name
+      #   @return [String]
+      attribute? :name, Types::String.optional
+
+      # @!attribute [r] namespace
+      #   @return [String]
+      attribute? :namespace, Types::String.optional
+
+      # @!attribute [r] canceled_at
+      #   @return [String]
+      attribute? :canceled_at, Types::String.optional
+
+      # @!attribute [r] canceled_by
+      #   @return [Integer]
+      attribute? :canceled_by, Types::Int.optional
+
+      # @!attribute [r] channel_id
+      #   @return [Integer]
+      attribute? :channel_id, Types::Int.optional
+
+      # @!attribute [r] channel_name
+      #   @return [String]
+      attribute? :channel_name, Types::String.optional
+
+      # @!attribute [r] created_at
+      #   @return [String]
+      attribute? :created_at, Types::String.optional
+
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int | Types::String
+
+      # @!attribute [r] started_at
+      #   @return [String]
+      attribute? :started_at, Types::String.optional
+
+      # @!attribute [r] status
+      #   @return [String]
+      attribute? :status, Types::String.optional
+
+      # @!attribute [r] template_detail_id
+      #   @return [Integer]
+      attribute? :template_detail_id, Types::Int.optional
+
+      # @!attribute [r] template_id
+      #   @return [Integer]
+      attribute? :template_id, Types::Int.optional
+
+      # @!attribute [r] template_name
+      #   @return [String]
+      attribute? :template_name, Types::String.optional
+
+      # @!attribute [r] total_failed
+      #   @return [Integer]
+      attribute? :total_failed, Types::Int.optional
+
+      # @!attribute [r] total_read
+      #   @return [Integer]
+      attribute? :total_read, Types::Int.optional
+
+      # @!attribute [r] total_received
+      #   @return [Integer]
+      attribute? :total_received, Types::Int.optional
+
+      # @!attribute [r] total_recipient
+      #   @return [Integer]
+      attribute? :total_recipient, Types::Int.optional
+    end
+  end
+end

data/lib/qismo/objects/broadcast_log.rb

@@ -0,0 +1,59 @@
+module Qismo
+  module Objects
+    # Broadcast log object
+    #
+    class BroadcastLog < Qismo::Object
+      # @!attribute [r] button_params
+      #   @return [String]
+      attribute? :button_params, Types::String.optional
+
+      # @!attribute [r] customer_name
+      #   @return [String]
+      attribute? :customer_name, Types::String.optional
+
+      # @!attribute [r] header_value
+      #   @return [String]
+      attribute? :header_value, Types::String.optional
+
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int.optional
+
+      # @!attribute [r] message
+      #   @return [String]
+      attribute? :message, Types::String.optional
+
+      # @!attribute [r] message_id
+      #   @return [String]
+      attribute? :message_id, Types::String.optional
+
+      # @!attribute [r] notes
+      #   @return [String]
+      attribute? :notes, Types::String.optional
+
+      # @!attribute [r] params
+      #   @return [String]
+      attribute? :params, Types::String.optional
+
+      # @!attribute [r] phone_number
+      #   @return [String]
+      attribute? :phone_number, Types::String.optional
+
+      # @!attribute [r] sent_at
+      #   @return [String]
+      attribute? :sent_at, Types::String.optional
+
+      # @!attribute [r] status
+      #   @return [String]
+      attribute? :status, Types::String.optional
+
+      # @!attribute [r] template_name
+      #   @return [String]
+      attribute? :template_name, Types::String.optional
+
+      # @!attribute [r] variables
+      #   @return [String]
+      attribute? :variables, Types::String.optional
+    end
+  end
+end

data/lib/qismo/objects/custom_channel.rb

@@ -0,0 +1,35 @@
+module Qismo
+  module Objects
+    # Custom channel object
+    #
+    class CustomChannel < Qismo::Object
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int.optional
+
+      # @!attribute [r] webhook_url
+      #   @return [String]
+      attribute? :webhook_url, Types::String.optional
+
+      # @!attribute [r] logo_url
+      #   @return [String]
+      attribute? :logo_url, Types::String.optional
+
+      # @!attribute [r] identifier_key
+      #   @return [String]
+      attribute? :identifier_key, Types::String.optional
+
+      # @!attribute [r] name
+      #   @return [String]
+      attribute? :name, Types::String.optional
+
+      # @!attribute [r] is_active
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_active, Types::Bool.optional
+
+      # @!attribute [r] use_channel_responder
+      #   @return [TrueClass,FalseClass]
+      attribute? :use_channel_responder, Types::Bool.optional
+    end
+  end
+end

data/lib/qismo/objects/custom_channel_message_response.rb

@@ -0,0 +1,19 @@
+module Qismo
+  module Objects
+    # Custom channel message response object
+    #
+    class CustomChannelMessageResponse < Qismo::Object
+      # @!attribute [r] agent
+      #   @return [Qismo::Objects::User]
+      attribute? :agent, Qismo::Objects::User.optional
+
+      # @!attribute [r] agent_service
+      #   @return [Qismo::Objects::AgentService]
+      attribute? :agent_service, Qismo::Objects::AgentService.optional
+
+      # @!attribute [r] room_log
+      #   @return [Qismo::Objects::CustomerRoom]
+      attribute? :room_log, Qismo::Objects::CustomerRoom
+    end
+  end
+end

data/lib/qismo/objects/customer_room.rb

@@ -0,0 +1,85 @@
+require "qismo/object"
+
+module Qismo
+  module Objects
+    # Customer room object
+    #
+    class CustomerRoom < Qismo::Object
+      # @!attribute [r] channel_id
+      #   @return [Integer]
+      attribute? :channel_id, Types::Int.optional
+
+      # @!attribute [r] contact_id
+      #   @return [Integer]
+      attribute? :contact_id, Types::Int.optional
+
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int.optional
+
+      # @!attribute [r] is_handled_by_bot
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_handled_by_bot, Types::Bool.optional
+
+      # @!attribute [r] is_resolved
+      #   @return [String]
+      attribute? :is_resolved, Types::Bool
+
+      # @!attribute [r] is_waiting
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_waiting, Types::Bool
+
+      # @!attribute [r] last_comment_sender
+      #   @return [String]
+      attribute? :last_comment_sender, String
+
+      # @!attribute [r] last_comment_sender_type
+      #   @return [String]
+      attribute? :last_comment_sender_type, Types::String.optional
+
+      # @!attribute [r] last_comment_text
+      #   @return [String]
+      attribute? :last_comment_text, Types::String.optional
+
+      # @!attribute [r] last_comment_timestamp
+      #   @return [String]
+      attribute? :last_comment_timestamp, Types::String.optional
+
+      # @!attribute [r] last_customer_comment_text
+      #   @return [String]
+      attribute? :last_customer_comment_text, Types::String.optional
+
+      # @!attribute [r] last_customer_timestamp
+      #   @return [String]
+      attribute? :last_customer_timestamp, Types::String.optional
+
+      # @!attribute [r] name
+      #   @return [String]
+      attribute? :name, Types::String.optional
+
+      # @!attribute [r] room_badge
+      #   @return [String]
+      attribute? :room_badge, Types::String.optional
+
+      # @!attribute [r] room_id
+      #   @return [String]
+      attribute? :room_id, Types::Int.optional
+
+      # @!attribute [r] room_type
+      #   @return [String]
+      attribute? :room_type, Types::String.optional
+
+      # @!attribute [r] source
+      #   @return [String]
+      attribute? :source, Types::String.optional
+
+      # @!attribute [r] user_avatar_url
+      #   @return [String]
+      attribute? :user_avatar_url, Types::String.optional
+
+      # @!attribute [r] user_id
+      #   @return [String]
+      attribute? :user_id, Types::String.optional
+    end
+  end
+end

data/lib/qismo/objects/fb_channel.rb

@@ -0,0 +1,31 @@
+module Qismo
+  module Objects
+    # Fb channel object
+    #
+    class FbChannel < Qismo::Object
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int.optional
+
+      # @!attribute [r] is_active
+      #   @return [TrueClass,FalseClass]
+      attribute? :is_active, Types::Bool.optional
+
+      # @!attribute [r] profile_name
+      #   @return [String]
+      attribute? :profile_name, Types::String.optional
+
+      # @!attribute [r] page_id
+      #   @return [String]
+      attribute? :page_id, Types::String.optional
+
+      # @!attribute [r] badge_url
+      #   @return [String]
+      attribute? :badge_url, Types::String.optional
+
+      # @!attribute [r] use_channel_responder
+      #   @return [TrueClass,FalseClass]
+      attribute :use_channel_responder, Types::Bool.optional
+    end
+  end
+end

data/lib/qismo/objects/hsm_template.rb

@@ -0,0 +1,111 @@
+module Qismo
+  module Objects
+    # HSM template object
+    #
+    class HsmTemplate < Qismo::Object
+      # Hsm detail object
+      #
+      class HsmDetail < Qismo::Object
+        # Hsm detail button object
+        #
+        class Button < Qismo::Object
+          # @!attribute [r] text
+          #   @return [String]
+          attribute? :text, Types::String.optional
+
+          # @!attribute [r] type
+          #   @return [String]
+          attribute? :type, Types::String.optional
+
+          # @!attribute [r] url
+          #   @return [String]
+          attribute? :url, Types::String.optional
+
+          # @!attribute [r] phone_number
+          #   @return [String]
+          attribute? :phone_number, Types::String.optional
+        end
+
+        # @!attribute [r] approval_status
+        #   @return [Integer]
+        attribute? :approval_status, Types::Int.optional
+
+        # @!attribute [r] buttons
+        #   @return [Array<Qismo::Objects::HsmInfo::Button>]
+        attribute? :buttons, Types.Array(Button.optional).optional
+
+        # @!attribute [r] content
+        #   @return [String]
+        attribute? :content, Types::String.optional
+
+        # @!attribute [r] footer
+        #   @return [String]
+        attribute? :footer, Types::String.optional
+
+        # @!attribute [r] header_content
+        #   @return [String]
+        attribute? :header_content, Types::String.optional
+
+        # @!attribute [r] header_default_value
+        #   @return [String]
+        attribute? :header_default_value, Types::String.optional
+
+        # @!attribute [r] header_type
+        #   @return [String]
+        attribute? :header_type, Types::String.optional
+
+        # @!attribute [r] id
+        #   @return [Integer]
+        attribute? :id, Types::Int.optional
+
+        # @!attribute [r] language
+        #   @return [String]
+        attribute? :language, Types::String.optional
+
+        # @!attribute [r] number_of_arguments
+        #   @return [Integer]
+        attribute? :number_of_arguments, Types::Int.optional
+
+        # @!attribute [r] rejection_reason
+        #   @return [String]
+        attribute? :rejection_reason, Types::String.optional
+
+        # @!attribute [r] tested
+        #   @return [TrueClass,FalseClass]
+        attribute? :tested, Types::Bool.optional
+      end
+
+      # @!attribute [r] category
+      #   @return [String]
+      attribute? :category, Types::String.optional
+
+      # @!attribute [r] channel_id
+      #   @return [Integer]
+      attribute? :channel_id, Types::Int.optional
+
+      # @!attribute [r] channel_name
+      #   @return [String]
+      attribute? :channel_name, Types::String.optional
+
+      # @!attribute [r] hsm_details
+      #   @return [Array<Qismo::Objects::HsmInfo::HsmDetail>]
+      attribute? :hsm_details, Types.Array(HsmDetail.optional).optional
+
+      # @!attribute [r] id
+      #   @return [Integer]
+      attribute? :id, Types::Int.optional
+
+      # @!attribute [r] name
+      #   @return [String]
+      attribute? :name, Types::String.optional
+
+      # @!attribute [r] namespace
+      #   @return [String]
+      attribute? :namespace, Types::String.optional
+
+      # @!attribute [r] type
+      #   @return [Integer]
+      attribute? :type, Types::Int.optional
+    end
+  end
+end