qismo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b17d0ba64fc0e678f76fdc720b1f6780efc9324e78a17a5b046a11ca2c20c63
+  data.tar.gz: 2168cf3d3fa3b04ad3fffbe18518fd093a11de22be1fbe6ae04939c3ad8d1ed5
+SHA512:
+  metadata.gz: 937249a7bc7751c3de6f3a1c5cdf735dbacc2a772a447ae0aba852c0a07aa53544cf1239dcd9bd516a450ffffeffe39214a3befc450b24323968ef7d4ecbea1e
+  data.tar.gz: 0bd51e327f166527a15a183441c83a39413ae23a560803643191796af3eab349a3ea32d20b43fb4fd852d3dd5e9a8a3cd2783dce1efe15038865c6d4fe285082

data/.editorconfig

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

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+Lint/MissingSuper:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+2.7.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in qismo.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+gem "http", "~> 4.4"

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    qismo (0.1.0)
+      http (~> 4.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.4)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.24.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.0)
+      parser (>= 3.0.1.1)
+    rubocop-shopify (2.3.0)
+      rubocop (~> 1.22)
+    ruby-progressbar (1.11.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  http (~> 4.4)
+  qismo!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop-shopify (~> 2.3)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+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/README.md

@@ -0,0 +1,120 @@
+# Qismo Ruby
+
+A Ruby API wrapper for Qiscus Multichannel API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "qismo"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+**Example for single app id**
+
+```ruby
+# config/initializers/qismo.rb
+# Initialization
+Qismo.init do |config|
+  config.app_id = ENV["QISCUS_APP_ID"]
+  config.secret_key = ENV["QISCUS_SECRET_KEY"]
+  config.base_url = ENV["QISCUS_MULTICHANNEL_BASE_URL"]
+end
+
+# Get all rooms that have been waiting for a week
+rooms = Room.where(status: "waiting")
+            .where("created_at >= :a_week", a_week: 1.week.ago)
+
+# Resolve the rooms
+rooms.each(Qismo::Room.resolve(&:id))
+```
+
+**Example for multi app id**
+
+```ruby
+# Get all rooms that have been waiting for a week
+rooms = Room.includes(:qiscus_app)
+            .where(status: "waiting")
+            .where("created_at >= :a_week", a_week: 1.week.ago)
+
+# Resolve the rooms
+rooms.each do |room|
+  Qismo.new(app_id: room.qiscus_app.app_id, secret_key: room.qiscus_app.secret_key)
+  Qismo::Room.resolve(room.id)
+end
+```
+
+**Nested operations**
+
+If you prefer to use nested operations, you can also use this package like below
+
+```ruby
+client = Qismo.new(app_id: room.qiscus_app.app_id, secret_key: room.qiscus_app.secret_key)
+client.room.resolve(id)
+```
+
+**Requesting to unhandled API**
+
+Qiscus Multichannel is on fast development mode and at some condition, you might find this library is not handle the new API. If that happen, you can use the operations like below:
+
+```ruby
+Qismo.client.call("post", "/api/v2/api_endpoint", json: {}, params: {})
+```
+
+**Error handling**
+
+```ruby
+begin
+  room = Qismo::Room.resolve(123456) # Not Found
+rescue Qismo::HTTPError => e
+  e.message # return error message
+  e.http_code # return response code
+  e.http_headers # return response headers in hash
+  e.http_body # return response body in hash or string
+  e.http_raw_body # return raw response body in string
+end
+```
+
+## Experience
+
+This  gem leverage YARD to improve text editor autocompletion
+
+Install YARD
+
+```shell
+gem install yard
+```
+
+Change to project directory and expose gem YARD documentation
+
+```shell
+yard gems
+```
+
+For VSCode users, you can use Solargraph gem to improve the autocompletion
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/qismo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/qismo/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Qismo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/qismo/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "qismo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/qismo/client.rb

@@ -0,0 +1,131 @@
+# 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
+
+      if @admin_email.nil? && !@app_id.nil?
+        @admin_email = "#{app_id}_admin@qismo.com"
+      end
+    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
+
+      resp = Response.new(resp)
+      resp.raise_for_error
+
+      resp
+    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,
+        }
+      end
+
+      raw_request(method, url, options)
+    end
+
+    #
+    # Do HTTP request using GET method
+    #
+    # @param path [String]
+    # @param params [Hash]
+    #
+    # @return [Response]
+    #
+    def get(path, params = {})
+      request(:get, path, params: params)
+    end
+
+    #
+    # Do HTTP request using POST method
+    #
+    # @param path [String]
+    # @param body [Hash]
+    #
+    # @return [Response]
+    #
+    def post(path, body = {})
+      request(:post, path, json: body)
+    end
+  end
+end

data/lib/qismo/errors.rb

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

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

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