qismo 0.1.0

data/lib/qismo/response.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module Qismo
+  #
+  # HTTP response handler
+  #
+  # @!attribute http_code [Integer]
+  # @!attribute http_headers [HTTP::Headers]
+  # @!attribute http_body [String]
+  # @!attribute http_raw_body [String]
+  # @!attribute error [Error]
+  class Response
+    include Qismo::Helpers::BaseHelper
+
+    # @return [Integer] bad request constant
+    BAD_REQUEST = 400
+
+    # @return [Integer] unauthorized constant
+    UNAUTHORIZED = 401
+
+    # @return [Integer] payment required constant
+    PAYMENT_REQUIRED = 402
+
+    # @return [Integer] forbidden constant
+    FORBIDDEN = 403
+
+    # @return [Integer] not found constant
+    NOT_FOUND = 404
+
+    # @return [Integer] rate limit exceeded constant
+    RATE_LIMIT_EXCEEDED = 429
+
+    # @return [Integer] internal server error constant
+    INTERNAL_SERVER_ERROR = 500
+
+    attr_reader :http_code, :http_headers, :http_body, :http_raw_body, :error
+
+    #
+    # Response
+    #
+    # @param resp [HTTP::Response]
+    #
+    def initialize(resp)
+      @http_code = resp.code
+      @http_headers = parse_headers(resp)
+      @http_body = parse_body(resp)
+      @http_raw_body = resp.to_s
+
+      @error = parse_error(resp)
+    end
+
+    def ok?
+      (200..299).member?(@http_code)
+    end
+
+    alias_method :success?, :ok?
+
+    def raise_for_error
+      if @error.nil?
+        return
+      end
+
+      raise @error
+    end
+
+    private
+
+    def parse_body(resp)
+      safe_parse_json(resp.to_s)
+    end
+
+    def parse_headers(resp)
+      safe_parse_json(resp.headers.to_h)
+    end
+
+    def parse_error(resp)
+      return nil if resp.status.ok? || resp.status.informational? || resp.status.redirect?
+
+      if resp.status.server_error?
+        return InternalServerError.new(
+          "Qiscus internal server error",
+          http_code: resp.code,
+          http_headers: safe_parse_json(resp.headers.to_h),
+          http_body: safe_parse_json(resp.to_s),
+          http_raw_body: resp.to_s
+        )
+      end
+
+      if resp.status.client_error?
+        code = resp.code
+        headers = safe_parse_json(resp.headers.to_h)
+        raw_body = resp.to_s
+
+        klass = case code
+        when BAD_REQUEST then BadRequest.new
+        when UNAUTHORIZED then Unauthorized.new
+        when PAYMENT_REQUIRED then PaymentRequired.new
+        when FORBIDDEN then Forbidden.new
+        when NOT_FOUND then NotFound.new
+        when RATE_LIMIT_EXCEEDED then RateLimitExceeded.new
+        else
+          ClientError.new
+        end
+
+        if code == BAD_REQUEST && raw_body.downcase.include?("wrong email or password")
+          klass = Unauthorized.new
+        end
+
+        klass.http_code = code
+        klass.http_headers = headers
+        klass.http_raw_body = raw_body
+        klass.http_body = safe_parse_json(raw_body)
+        klass.message = klass.class.to_s
+
+        if klass.http_body.is_a?(Hash)
+          http_body = klass.http_body
+
+          error_message = if http_body["errors"].is_a?(String)
+            http_body["errors"]
+          elsif http_body["errors"].is_a?(Hash) && http_body.dig("errors", "message").is_a?(String)
+            http_body["errors"]["message"]
+          else
+            klass.class.to_s
+          end
+
+          klass.message = error_message
+          klass.message = errors if klass.message.is_a?(String)
+        else
+          klass.message = klass.http_body
+        end
+
+        klass
+      end
+    end
+  end
+end

data/lib/qismo/version.rb

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

data/lib/qismo.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Helpers
+require "qismo/helpers/base_helper"
+
+# Base
+require "qismo/version"
+require "qismo/errors"
+require "qismo/response"
+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
+#
+module Qismo
+  class << self
+    attr_writer :client
+
+    #
+    # Configure client using block
+    #
+    # @yieldparam [Client]
+    #
+    # @yieldreturn [Client]
+    #
+    def init
+      yield(client)
+
+      client
+    end
+
+    alias_method :configure, :init
+
+    #
+    # 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)
+    end
+
+    #
+    # Qismo ruby client
+    #
+    # @return [Qismo::Client]
+    #
+    def client
+      @client ||= Client.new
+    end
+  end
+end

data/qismo.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/qismo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "qismo"
+  spec.version       = Qismo::VERSION
+  spec.authors       = ["Nurcholis Art", "Qiscus"]
+  spec.email         = ["nurcholis@qiscus.com"]
+
+  spec.summary       = "Qiscus Multichannel Ruby Client"
+  spec.homepage      = "https://multichannel.qiscus.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # spec.add_runtime_dependency("activesupport", "~> 7.0")
+  spec.add_runtime_dependency("http", "~> 4.4")
+
+  spec.add_development_dependency("rubocop-shopify", "~> 2.3")
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: qismo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nurcholis Art
+- Qiscus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: 
+email:
+- nurcholis@qiscus.com
+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
+- bin/console
+- bin/setup
+- lib/qismo.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/version.rb
+- qismo.gemspec
+homepage: https://multichannel.qiscus.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Qiscus Multichannel Ruby Client
+test_files: []