qismo 0.1.8 → 0.5.0

data/lib/qismo/client.rb

@@ -1,131 +1,103 @@
 # frozen_string_literal: true
 
-require "http"
-require "qismo/operations"
-
 module Qismo
-  #
-  # Qismo client object
-  #
-  # @!attribute app_id [String]
-  # @!attribute secret_key [String]
-  # @!attribute base_url [String]
-  # @!attribute admin_email [String]
   class Client
-    # @!parse
-    #   include Qismo::Helpers::BaseHelper
-    include Qismo::Helpers::BaseHelper
-
-    # @!parse
-    #   include Qismo::Operations
-    include Qismo::Operations
-
-    # @return [String] default base url constant
-    DEFAULT_BASE_URL = "https://multichannel.qiscus.com"
-
-    attr_accessor :app_id, :secret_key, :base_url, :admin_email, :proxy
-
-    #
-    # Initialize Qismo client
-    #
-    # @param options [Hash]
-    # @option options [String] :app_id
-    # @option options [String] :secret_key
-    # @option options [String] :base_url
-    #
-    def initialize(options = {})
-      options = options.compact
-      options[:base_url] = DEFAULT_BASE_URL if options[:base_url].nil?
-
-      options.each do |key, value|
-        instance_variable_set("@#{key}", value)
-      end
+    include Qismo::Model
+    include Qismo::Api
 
-      if @admin_email.nil? && !@app_id.nil?
-        @admin_email = "#{app_id}_admin@qismo.com"
-      end
+    VALID_OPTIONS = [:app_id, :secret_key, :url, :logger, :instrumentation, :timeout, :proxy]
+
+    attr_accessor(*VALID_OPTIONS)
+
+    def initialize(**opt)
+      @app_id = opt[:app_id] || ENV["QISCUS_APP_ID"]
+      @secret_key = opt[:secret_key] || ENV["QISCUS_SECRET_KEY"]
+      @url = opt[:url] || ENV["QISCUS_OMNICHANNEL_URL"] || "https://qismo.qiscus.com"
+      @logger = opt[:logger]
+      @instrumentation = opt[:instrumentation]
+      @timeout = opt[:timeout]
+      @proxy = opt[:proxy]
     end
 
-    #
-    # Call HTTP request raw
-    #
-    # @param method [String]
-    # @param url [String]
-    # @param options [Hash]
-    # @option options [Hash] :headers
-    # @option options [Hash] :params
-    # @option options [Hash] :json
-    #
-    # @return [Response]
-    #
-    def raw_request(method, url, options = {})
-      resp = if Qismo.client.proxy.nil?
-        HTTP.request(method, url, options)
-      else
-        proxy = Qismo.client.proxy
-        proxy_args = [proxy[:host], proxy[:port], proxy[:username], proxy[:password]]
-
-        HTTP.via(*proxy_args).request(method, url, options)
-      end
+    def post(path, body = {})
+      request(:post, path, json: body)
+    end
 
-      resp = Response.new(resp)
-      resp.raise_for_error
+    def post_upload(path, body = {})
+      request(:post, form: body)
+    end
 
-      resp
+    def get(path, **params)
+      request(:get, path, params)
     end
 
-    #
-    # Do HTTP request
-    #
-    # @param method [String]
-    # @param path [String]
-    # @param options [Hash]
-    # @option options [Hash] :params
-    # @option options [Hash] :json
-    # @options options [Hash] :headers
-    #
-    # @return [Response]
-    #
-    def request(method, path, options = {})
-      url = Qismo.client.base_url + path
-
-      if !options[:headers].nil? && options[:headers].is_a?(Hash) && !options[:headers][:authorization].nil?
-        options[:header].merge({
-          qiscus_app_id: Qismo.client.app_id,
-          qiscus_secret_key: Qismo.client.secret_key,
-        })
-      else
-        options[:headers] = {
-          qiscus_app_id: Qismo.client.app_id,
-          qiscus_secret_key: Qismo.client.secret_key,
-        }
+    def request(method, path, **opt)
+      res = connection.request(method, @url + path, opt.compact)
+      if res.status.success?
+        return JSON.parse(res.to_s, object_class: Data)
       end
 
-      raw_request(method, url, options)
+      if res.status.server_error?
+        raise InternalServerError.new("Qiscus Omnichannel server error", status_code: res.code, response_body: res.to_s)
+      end
+
+      if res.status.client_error?
+        body = JSON.parse(res.to_s, object_class: Data)
+        error = body.errors
+        error = error.message if error.is_a?(Hash)
+
+        error_klass_map = {
+          400 => BadRequestError,
+          401 => UnauthorizedError,
+          402 => PaymentRequiredError,
+          403 => ForbiddenError,
+          404 => NotFoundError,
+          429 => TooManyRequestError,
+        }
+
+        error_klass = error_klass_map[res.code] || HTTPRequestError
+        raise error_klass.new(error, status_code: res.code, response_body: res.to_s)
+      end
     end
 
-    #
-    # Do HTTP request using GET method
-    #
-    # @param path [String]
-    # @param params [Hash]
-    #
-    # @return [Response]
-    #
-    def get(path, params = {})
-      request(:get, path, params: params)
+    def connection
+      http = HTTP
+
+      unless @logger.nil?
+        http = http.use(logging: @logger)
+      end
+
+      unless @instrumentation.nil?
+        http = http.use(instrumentation: @instrumentation)
+      end
+
+      unless @timeout.nil?
+        http = if @timeout.is_a?(Hash)
+          http.timeout(**@timeout)
+        else
+          http.timeout(@timeout)
+        end
+      end
+
+      unless @proxy.nil?
+        http = http.via(*@proxy)
+      end
+
+      http.headers({
+        "Qiscus-App-Id": @app_id,
+        "Qiscus-Secret-Key": @secret_key,
+        "User-Agent": user_agent.to_json,
+      })
     end
 
-    #
-    # Do HTTP request using POST method
-    #
-    # @param path [String]
-    # @param body [Hash]
-    #
-    # @return [Response]
-    #
-    def post(path, body = {})
-      request(:post, path, json: body)
+    def user_agent
+      {
+        lib_version: Qismo::VERSION,
+        lang: "ruby",
+        lang_version: RUBY_VERSION,
+        platform: RUBY_PLATFORM,
+        engine: defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
+      }
     end
   end
 end

data/lib/qismo/error.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Qismo
+  class Error < StandardError
+    attr_reader :message
+  end
+
+  class HTTPTimeoutError < Error
+    def initialize(message)
+      super(message)
+    end
+  end
+
+  class HTTPRequestError < Error
+    attr_reader :message, :status_code, :response_body
+
+    def initialize(message, status_code:, response_body:)
+      super(message.to_s)
+
+      @message = message
+      @status_code = status_code
+      @response_body = response_body
+    end
+  end
+
+  class InternalServerError < HTTPRequestError
+  end
+
+  # 400
+  class BadRequestError < HTTPRequestError
+  end
+
+  # 401
+  class UnauthorizedError < HTTPRequestError
+  end
+
+  # 402
+  class PaymentRequiredError < HTTPRequestError
+  end
+
+  # 403
+  class ForbiddenError < HTTPRequestError
+  end
+
+  # 404
+  class NotFoundError < HTTPRequestError
+  end
+
+  # 429
+  class TooManyRequestError < HTTPRequestError
+  end
+end

data/lib/qismo/model.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Qismo
+  module Model
+    class Data < OpenStruct # rubocop:disable Style/OpenStructUse
+    end
+
+    class Collection < Array
+      def initialize(data, prev_page: nil, next_page: nil, prev_func: -> { nil }, next_func: -> { nil })
+        super(data)
+
+        @prev_page = prev_page
+        @next_page = next_page
+        @prev_func = prev_func
+        @next_func = next_func
+      end
+
+      def has_next_page?
+        @next_page != nil
+      end
+
+      alias_method :next_page?, :has_next_page?
+
+      def has_prev_page?
+        @prev_page != nil
+      end
+
+      alias_method :prev_page?, :has_prev_page?
+
+      def next_page
+        @next_func.call
+      end
+
+      def prev_page
+        @prev_func.call
+      end
+    end
+
+    class Response
+      attr_reader :data, :meta
+
+      def initialize(data, meta = {})
+        @data = data
+        @meta = meta
+      end
+    end
+  end
+end

data/lib/qismo/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
 module Qismo
-  # @return [String] gem version constant
-  VERSION = "0.1.8"
+  VERSION = "0.5.0"
 end

data/lib/qismo.rb

@@ -1,70 +1,44 @@
 # frozen_string_literal: true
 
-# Helpers
-require "qismo/helpers/base_helper"
+require "http"
 
-# Base
 require "qismo/version"
-require "qismo/errors"
-require "qismo/response"
+require "qismo/error"
+require "qismo/model"
+require "qismo/api"
 require "qismo/client"
 
-# Resources
-require "qismo/resources/agent_resource"
-require "qismo/resources/room_resource"
-require "qismo/resources/office_setting_resource"
-require "qismo/resources/user_resource"
-require "qismo/resources/bot_resource"
-
-# Models
-require "qismo/models/base"
-require "qismo/models/agent"
-require "qismo/models/room"
-require "qismo/models/office_setting"
-require "qismo/models/office_hour"
-require "qismo/models/user"
-require "qismo/models/bot"
-
-#
-# Base module of Qismo ruby
-#
+# Qismo
 module Qismo
   class << self
-    attr_writer :client
+    attr_reader(*Qismo::Client::VALID_OPTIONS)
 
-    #
-    # Configure client using block
-    #
-    # @yieldparam [Client]
-    #
-    # @yieldreturn [Client]
-    #
-    def init
-      yield(client)
+    def configure
+      yield client
 
-      client
+      Qismo::Client::VALID_OPTIONS.each do |opt|
+        instance_variable_set("@#{opt}", client.send(opt))
+      end
     end
 
-    alias_method :configure, :init
+    if Gem::Version.new(RUBY_VERSION).release >= Gem::Version.new("3.0.0")
+      def method_missing(method, *args, **kwargs, &block)
+        return super unless client.respond_to?(method)
+
+        client.send(method, *args, **kwargs, &block)
+      end
+    else
+      def method_missing(method, *args, &block)
+        return super unless client.respond_to?(method)
+
+        client.send(method, *args, &block)
+      end
+    end
 
-    #
-    # Configure client
-    #
-    # @param app_id [String]
-    # @param secret_key [String]
-    # @param base_url [String]
-    #
-    # @return [Client]
-    #
-    def new(app_id:, secret_key:, base_url: Client::DEFAULT_BASE_URL)
-      @client = Client.new(app_id: app_id, secret_key: secret_key, base_url: base_url)
+    def respond_to_missing?(method_name, *args)
+      Qismo::Client.instance_methods.include?(method_name)
     end
 
-    #
-    # Qismo ruby client
-    #
-    # @return [Qismo::Client]
-    #
     def client
       @client ||= Client.new
     end

metadata

@@ -1,87 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: qismo
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.5.0
 platform: ruby
 authors:
-- Nurcholis Art
-- Qiscus
+- Qiscus Integration
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-12-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-shopify
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-description: 
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-lsp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for Qiscus Omnichannel public API
 email:
-- nurcholis@qiscus.com
+- developer@qiscus.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/qismo.rb
+- lib/qismo/api.rb
 - lib/qismo/client.rb
-- lib/qismo/errors.rb
-- lib/qismo/helpers/base_helper.rb
-- lib/qismo/models/agent.rb
-- lib/qismo/models/base.rb
-- lib/qismo/models/bot.rb
-- lib/qismo/models/null_object.rb
-- lib/qismo/models/office_hour.rb
-- lib/qismo/models/office_setting.rb
-- lib/qismo/models/room.rb
-- lib/qismo/models/user.rb
-- lib/qismo/operations.rb
-- lib/qismo/resources/agent_resource.rb
-- lib/qismo/resources/bot_resource.rb
-- lib/qismo/resources/office_setting_resource.rb
-- lib/qismo/resources/room_resource.rb
-- lib/qismo/resources/user_resource.rb
-- lib/qismo/response.rb
+- lib/qismo/error.rb
+- lib/qismo/model.rb
 - lib/qismo/version.rb
-- qismo.gemspec
-homepage: https://multichannel.qiscus.com
+homepage: https://qiscus.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://bitbucket.org/qiscus/qismo-rb
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -100,5 +152,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Qiscus Multichannel Ruby Client
+summary: Qiscus Omnichannel Ruby Gem
 test_files: []

data/.editorconfig

@@ -1,9 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-*.gem