qismo 0.1.8 → 0.5.0

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at nurcholisart@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2021 Nurcholis Art
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/lib/qismo/errors.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Qismo
-  #
-  # Qismo generic error
-  # @!attribute message [String]
-  #
-  class Error < StandardError
-  end
-
-  #
-  # Qismo HTTP error
-  #
-  # @attribute message [String]
-  # @attribute http_code [Integer]
-  # @attribute http_headers [Hash]
-  # @attribute http_body [Hash,String]
-  # @attribute http_raw_body [String]
-  #
-  class HTTPError < StandardError
-    attr_accessor :message, :http_code, :http_headers, :http_body, :http_raw_body
-
-    def initialize(message = nil, http_code: nil, http_headers: nil, http_body: nil, http_raw_body: nil)
-      @message = message
-      @http_code = http_code
-      @http_headers = http_headers
-      @http_body = http_body
-      @http_raw_body = http_raw_body
-    end
-  end
-
-  # Error for 5xx status code
-  ServerError = Class.new(HTTPError)
-
-  # Error for 500 status code
-  InternalServerError = Class.new(ServerError)
-
-  # Error for 4xx status code
-  ClientError = Class.new(HTTPError)
-
-  # Error for 400 status code
-  BadRequest = Class.new(ClientError)
-
-  # Error for 401 status code
-  Unauthorized = Class.new(ClientError)
-
-  # Error for 402 status code
-  PaymentRequired = Class.new(ClientError)
-
-  # Error for 403 status code
-  Forbidden = Class.new(ClientError)
-
-  # Error for 404 status code
-  NotFound = Class.new(ClientError)
-
-  # Error for 429 status code
-  RateLimitExceeded = Class.new(ClientError)
-end

data/lib/qismo/helpers/base_helper.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Qismo
-  #
-  # Utilities for Qismo Ruby client
-  #
-  module Helpers
-    module BaseHelper
-      #
-      # Validate the existence of hash attributes
-      #
-      # @param args [Array<Symbol,String>]
-      # @param on [Hash]
-      #
-      #
-      def validate_existence_of!(*args, on:)
-        args.each do |arg|
-          falsy = (on[arg] == {} || on[arg] == [] || on[arg].nil? || on[arg] == "" || on[arg] == 0)
-          raise BadRequest, "#{arg} is required" if falsy
-        end
-      end
-
-      #
-      # Check the argument is false or not
-      #
-      # @param arg [String, Integer, Hash, Array, NilClass]
-      #
-      # @return [TrueClass, FalseClass]
-      #
-      def falsy?(arg)
-        (arg == {} || arg == [] || arg.nil? || arg == "" || arg == 0)
-      end
-
-      #
-      # Safely parse json string
-      #
-      # @param str [String]
-      #
-      # @return [Hash,String]
-      #
-      def safe_parse_json(str, symbolize_names: false)
-        str = str.to_json if str.is_a?(Hash)
-
-        JSON.parse(str, symbolize_names: symbolize_names)
-      rescue JSON::ParserError
-        str
-      end
-    end
-  end
-end

data/lib/qismo/models/agent.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Qismo
-  #
-  # Agent model
-  #
-  # @!attribute id [Integer]
-  # @!attribute email [String]
-  # @!attribute name [String]
-  # @!attribute authentication_token [String]
-  # @!attribute created_at [String]
-  # @!attribute updated_at [String]
-  # @!attribute sdk_email [String]
-  # @!attribute sdk_key [String]
-  # @!attribute is_available [TrueClass, FalseClass]
-  # @!attribute type [Integer]
-  # @!attribute avatar_url [String]
-  # @!attribute app_id [Integer]
-  # @!attribute is_verified [TrueClass, FalseClass]
-  # @!attribute notifications_room_id [String]
-  # @!attribute bubble_color [String, nil]
-  # @!attribute qismo_key [String]
-  # @!attribute direct_login_token [String]
-  # @!attribute last_login [String]
-  # @!attribute force_offline [TrueClass, FalseClass]
-  # @!attribute deleted_at [String, nil]
-  # @!attribute type_as_string [String]
-  # @!attribute assigned_rules [Array<String>]
-  #
-  class Agent < Base
-    # @!parse
-    #   extend Resources::AgentResource
-    extend Resources::AgentResource
-  end
-
-  module Operations
-    # @return [Qismo::Agent::Class]
-    def agent
-      Qismo::Agent
-    end
-  end
-end

data/lib/qismo/models/base.rb

@@ -1,60 +0,0 @@
-# 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

@@ -1,12 +0,0 @@
-# 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

@@ -1,109 +0,0 @@
-# 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

@@ -1,13 +0,0 @@
-# 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

@@ -1,19 +0,0 @@
-# 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

@@ -1,31 +0,0 @@
-# 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

@@ -1,19 +0,0 @@
-# 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

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

data/lib/qismo/resources/agent_resource.rb

@@ -1,39 +0,0 @@
-# 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

@@ -1,61 +0,0 @@
-# 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

@@ -1,67 +0,0 @@
-# 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