qismo 0.12.1 → 0.14.0

data/lib/qismo/webhook_requests/on_new_session_initiated.rb

@@ -0,0 +1,170 @@
+module Qismo
+  module WebhookRequests
+    # @!attribute [r] is_new_session
+    #   @return [TrueClass,FalseClass]
+    # @!attribute [r] payload
+    #   @return [Payload]
+    # @!attribute [r] room_log
+    #   @return [RoomLog]
+    class OnNewSessionInitiated < Qismo::Object
+      # @!attribute [r] avatar_url
+      #   @return [String]
+      # @!attribute [r] email
+      #   @return [String]
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] name
+      #   @return [String]
+      class From < Qismo::Object
+        attribute? :avatar_url, Types::String.optional
+        attribute? :email, Types::String.optional
+        attribute? :id, Types::Int.optional
+        attribute? :name, Types::String.optional
+      end
+
+      # @!attribute [r] comment_before_id
+      #   @return [Integer]
+      # @!attribute [r] created_at
+      #   @return [String]
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] payload
+      #   @return [Hash]
+      # @!attribute [r] text
+      #   @return [String]
+      # @!attribute [r] timestamp
+      #   @return [String]
+      # @!attribute [r] type
+      #   @return [String]
+      # @!attribute [r] unique_temp_id
+      #   @return [String]
+      # @!attribute [r] unix_nano_timestamp
+      #   @return [String]
+      # @!attribute [r] unix_timestamp
+      #   @return [String]
+      class Message < Qismo::Object
+        attribute? :comment_before_id, Types::Int.optional
+        attribute? :created_at, Types::String.optional
+        attribute? :id, Types::Int.optional
+        attribute? :payload, Types::Hash.optional
+        attribute? :text, Types::String.optional
+        attribute? :timestamp, Types::String.optional
+        attribute? :type, Types::String.optional
+        attribute? :unique_temp_id, Types::String.optional
+        attribute? :unix_nano_timestamp, Types::String.optional
+        attribute? :unix_timestamp, Types::String.optional
+      end
+
+      # @!attribute [r] email
+      #   @return [String]
+      class Participant < Qismo::Object
+        attribute? :email, Types::String.optional
+      end
+
+      # @!attribute [r] id
+      #   @return [String]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] options
+      #   @return [String]
+      # @!attribute [r] participants
+      #   @return [Array<Participant>]
+      # @!attribute [r] room_avatar
+      #   @return [String]
+      class Room < Qismo::Object
+        attribute? :id, Types::String.optional
+        attribute? :name, Types::String.optional
+        attribute? :options, Types::String.optional
+        attribute? :participants, Types.Array(Participant.optional).optional
+        attribute? :room_avatar, Types::String.optional
+      end
+
+      # @!attribute [r] from
+      #   @return [From]
+      # @!attribute [r] message
+      #   @return [Message]
+      # @!attribute [r] room
+      #   @return [Room]
+      # @!attribute [r] type
+      #   @return [String]
+      class Payload < Qismo::Object
+        attribute? :from, From.optional
+        attribute? :message, Message.optional
+        attribute? :room, Room.optional
+      end
+
+      # @!attribute [r] key
+      #   @return [String]
+      # @!attribute [r] value
+      #   @return [String,Integer,TrueClass,FalseClass]
+      class UserProperty < Qismo::Object
+        attribute? :key, Types::String.optional
+        attribute? :value, (Types::String.optional | Types::Int.optional | Types::Params::Bool.optional)
+      end
+
+      # @!attribute [r] timezone_offset
+      #   @return [String]
+      class AdditionalExtras < Qismo::Object
+        attribute? :timezone_offset, Types::String
+      end
+
+      # @!attribute [r] additional_extras
+      #   @return [AdditionalExtras]
+      # @!attribute [r] notes
+      #   @return [String]
+      # @!attribute [r] timezone_offset
+      #   @return [String]
+      # @!attribute [r] user_properties
+      #   @return [Array<UserProperty>]
+      class Extras < Qismo::Object
+        attribute? :additional_extras, AdditionalExtras.optional
+        attribute? :notes, Types::String
+        attribute? :timezone_offset, Types::String
+        attribute? :user_properties, Types.Array(UserProperty.optional).optional
+      end
+
+      # @!attribute [r] channel_id
+      #   @return [Integer]
+      # @!attribute [r] created_at
+      #   @return [String]
+      # @!attribute [r] extras
+      #   @return [String]
+      # @!attribute [r] has_no_message
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] is_waiting
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] resolved
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] room_badge
+      #   @return [String]
+      # @!attribute [r] room_id
+      #   @return [String]
+      # @!attribute [r] source
+      #   @return [String]
+      # @!attribute [r] user_avatar_url
+      #   @return [String]
+      # @!attribute [r] user_id
+      #   @return [String]
+      class RoomLog < Qismo::Object
+        attribute? :channel_id, Types::Int
+        attribute? :created_at, Types::String
+        attribute? :extras, Extras
+        attribute? :has_no_message, Types::Bool
+        attribute? :is_waiting, Types::Nil
+        attribute? :name, Types::String
+        attribute? :resolved, Types::Bool
+        attribute? :room_badge, Types::String
+        attribute? :room_id, Types::String
+        attribute? :source, Types::String
+        attribute? :user_avatar_url, Types::String
+        attribute? :user_id, Types::String
+      end
+
+      attribute? :is_new_session, Types::Bool
+      attribute? :payload, Payload
+      attribute? :room_log, RoomLog
+    end
+  end
+end

data/lib/qismo/webhook_requests/on_room_resolved.rb

@@ -0,0 +1,81 @@
+module Qismo
+  module WebhookRequests
+    # @!attribute [r] customer
+    #   @return [Customer]
+    # @!attribute [r] resolved_by
+    #   @return [ResolvedBy]
+    # @!attribute [r] service
+    #   @return [Service]
+    class OnRoomResolved < Qismo::Object
+      # @!attribute [r] key
+      #   @return [String]
+      # @!attribute [r] value
+      #   @return [String,Integer,TrueClass,FalseClass]
+      class AdditionalInfo < Qismo::Object
+        attribute? :key, Types::String.optional
+        attribute? :value, (Types::String.optional | Types::Int.optional | Types::Params::Bool.optional)
+      end
+
+      # @!attribute [r] additional_info
+      #   @return [Array<AdditionalInfo>]
+      # @!attribute [r] avatar
+      #   @return [String]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] user_id
+      #   @return [String]
+      class Customer < Qismo::Object
+        attribute? :additional_info, Types.Array(AdditionalInfo.optional).optional
+        attribute? :avatar, Types::String.optional
+        attribute? :name, Types::String.optional
+        attribute? :user_id, Types::String.optional
+      end
+
+      # @!attribute [r] email
+      #   @return [String]
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] is_available
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] type
+      #   @return [String]
+      class ResolvedBy < Qismo::Object
+        attribute? :email, Types::String.optional
+        attribute? :id, Types::Int.optional
+        attribute? :is_available, Types::Bool.optional
+        attribute? :name, Types::String.optional
+        attribute? :type, Types::String.optional
+      end
+
+      # @!attribute [r] first_comment_id
+      #   @return [String]
+      # @!attribute [r] last_comment_id
+      #   @return [String]
+      # @!attribute [r] id
+      #   @return [Integer]
+      # @!attribute [r] is_resolved
+      #   @return [TrueClass,FalseClass]
+      # @!attribute [r] notes
+      #   @return [String]
+      # @!attribute [r] room_id
+      #   @return [String]
+      # @!attribute [r] source
+      #   @return [String]
+      class Service < Qismo::Object
+        attribute? :first_comment_id, Types::String.optional
+        attribute? :last_comment_id, Types::String.optional
+        attribute? :id, Types::Int.optional
+        attribute? :is_resolved, Types::Bool.optional
+        attribute? :notes, Types::String.optional
+        attribute? :room_id, Types::String.optional
+        attribute? :source, Types::String.optional
+      end
+
+      attribute? :customer, Customer
+      attribute? :resolved_by, ResolvedBy
+      attribute? :service, Service
+    end
+  end
+end

data/lib/qismo.rb

@@ -1,44 +1,39 @@
 # frozen_string_literal: true
 
 require "active_support/all"
+require "dry-struct"
 require "http"
 
-require "qismo/util"
 require "qismo/version"
+require "qismo/types"
 require "qismo/error"
-require "qismo/model"
+
+require "qismo/object"
+require "qismo/objectified_hash"
+require "qismo/collection"
+
+require "qismo/objects/customer_room"
+require "qismo/objects/tag"
+require "qismo/objects/room_additional_info"
+require "qismo/objects/broadcast_log"
+require "qismo/objects/user"
+require "qismo/objects/agent_service"
+require "qismo/objects/webhook"
+require "qismo/objects/office_hour"
+require "qismo/objects/hsm_template"
+require "qismo/objects/wa_credit_info"
+require "qismo/objects/broadcast_job"
+require "qismo/objects/custom_channel_message_response"
+
+require "qismo/webhook_requests/on_agent_allocation_needed"
+require "qismo/webhook_requests/on_custom_button_clicked"
+require "qismo/webhook_requests/on_custom_channel_message_sent"
+require "qismo/webhook_requests/on_message_for_bot_sent"
+require "qismo/webhook_requests/on_new_session_initiated"
+require "qismo/webhook_requests/on_room_resolved"
+
 require "qismo/api"
 require "qismo/client"
 
 module Qismo
-  # @!parse extend Qismo::Api
-
-  class << self
-    def configure
-      yield client
-
-      client
-    end
-
-    private
-
-    # @return [Qismo::Client]
-    def client
-      @client ||= Client.new
-    end
-
-    def method_missing(method, *args, &block)
-      return super unless client.respond_to?(method)
-
-      client.send(method, *args, &block)
-    end
-
-    def respond_to?(method_name, include_private = false)
-      client.respond_to?(method_name, include_private) || super(method_name, include_private)
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      client.respond_to?(method_name, include_private) || super(method_name, include_private)
-    end
-  end
 end

data/qismo.gemspec

@@ -43,4 +43,6 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qismo
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Qiscus Integration
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-08 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
@@ -51,10 +79,30 @@ files:
 - lib/qismo.rb
 - lib/qismo/api.rb
 - lib/qismo/client.rb
+- lib/qismo/collection.rb
 - lib/qismo/error.rb
-- lib/qismo/model.rb
-- lib/qismo/util.rb
+- lib/qismo/object.rb
+- lib/qismo/objectified_hash.rb
+- lib/qismo/objects/agent_service.rb
+- lib/qismo/objects/broadcast_job.rb
+- lib/qismo/objects/broadcast_log.rb
+- lib/qismo/objects/custom_channel_message_response.rb
+- lib/qismo/objects/customer_room.rb
+- lib/qismo/objects/hsm_template.rb
+- lib/qismo/objects/office_hour.rb
+- lib/qismo/objects/room_additional_info.rb
+- lib/qismo/objects/tag.rb
+- lib/qismo/objects/user.rb
+- lib/qismo/objects/wa_credit_info.rb
+- lib/qismo/objects/webhook.rb
+- lib/qismo/types.rb
 - lib/qismo/version.rb
+- lib/qismo/webhook_requests/on_agent_allocation_needed.rb
+- lib/qismo/webhook_requests/on_custom_button_clicked.rb
+- lib/qismo/webhook_requests/on_custom_channel_message_sent.rb
+- lib/qismo/webhook_requests/on_message_for_bot_sent.rb
+- lib/qismo/webhook_requests/on_new_session_initiated.rb
+- lib/qismo/webhook_requests/on_room_resolved.rb
 - qismo.gemspec
 homepage: https://bitbucket.org/qiscus/qismo-rb
 licenses:

data/lib/qismo/model.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-module Qismo
-  # Class to handle http response body
-  #
-  class SingleObject
-    # Initiate data object
-    #
-    # @param options [Hash]
-    def initialize(options = {})
-      options.each do |key, value|
-        value = if value.is_a?(Array)
-          CollectionObject.new(handle_array(value))
-        elsif value.is_a?(Hash)
-          self.class.new(value)
-        elsif value.is_a?(TrueClass) || value.is_a?(FalseClass)
-          self.class.define_method("#{key.to_s.delete_prefix("is_")}?".to_sym) { value }
-          value
-        else
-          value
-        end
-
-        self.class.attr_reader(key.to_sym)
-        instance_variable_set("@#{key}", value)
-      end
-    end
-
-    def inspect
-      inspected_func ||= -> do
-        attributes = instance_variables.map do |iv|
-          "#{iv.to_s.delete_prefix("@")}=#{instance_variable_get(iv).inspect}"
-        end
-
-        "#<#{self.class.name} #{attributes.join(", ")}>"
-      end
-
-      inspected_func.call
-    end
-
-    alias_method :to_s, :inspect
-
-    private
-
-    def handle_array(values)
-      values.map do |value|
-        if value.is_a?(Hash)
-          self.class.new(value)
-        else
-          value
-        end
-      end
-    end
-  end
-
-  # Class to handle response body that contain pagination
-  #
-  class CollectionObject < Array
-    # Initiate collection
-    #
-    # @param data [Qismo::SingleObject]
-    # @param prev_page [String, Integer]
-    # @param next_page [String, Integer]
-    # @param prev_func [Proc, NilClass]
-    # @param next_func [Proc, NilClass]
-    def initialize(data = [], prev_page: nil, next_page: nil, prev_func: -> {}, next_func: -> {})
-      super(data)
-
-      @prev_page = prev_page
-      @next_page = next_page
-      @prev_func = prev_func
-      @next_func = next_func
-    end
-
-    # @return [TrueClass, FalseClass]
-    def has_next_page?
-      @next_page != nil
-    end
-
-    alias_method :next_page?, :has_next_page?
-
-    # @return [TrueClass, FalseClass]
-    def has_prev_page?
-      @prev_page != nil
-    end
-
-    alias_method :prev_page?, :has_prev_page?
-
-    # Call api request for next page
-    #
-    # @return [Qismo::SingleObject, Qismo::CollectionObject]
-    def next_page
-      @next_func.call if has_next_page?
-    end
-
-    # Call api request for previous page
-    #
-    # @return [Qismo::SingleObject, Qismo::CollectionObject]
-    def prev_page
-      @prev_func.call if has_prev_page?
-    end
-  end
-end

data/lib/qismo/util.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Qismo
-  class Util
-    class << self
-      # Check if now is in office hour or not
-      #
-      # @param data [Qismo::SingleObject]
-      # @return [TrueClass, FalseClass]
-      def in_office_hour?(data)
-        return false if data.timezone.blank?
-
-        offset = Time.zone_offset(data.timezone)
-        tz_current = Time.current.getlocal(offset)
-
-        today_office_hour = data.office_hours.find { |oh| oh.day == tz_current.strftime("%u").to_i }
-        return false if today_office_hour.nil?
-
-        start_hour = today_office_hour.starttime
-        end_hour = today_office_hour.endtime
-
-        # rubocop:disable Layout/LineLength
-        start_time = Time.parse("#{tz_current.year}-#{tz_current.month}-#{tz_current.day} #{start_hour} #{data.timezone}")
-        end_time = Time.parse("#{tz_current.year}-#{tz_current.month}-#{tz_current.day} #{end_hour} #{data.timezone}")
-        # rubocop:enable Layout/LineLength
-
-        tz_current.between?(start_time, end_time)
-      end
-    end
-  end
-end