qismo 0.1.8 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4eaffbee238679bb22787462d15da8eeba47b130485a197f25798f9972df663
-  data.tar.gz: 8503bd0773f35a80cc29d0e2ac28f4eebf0a77856f83f629452b2ee57c1e28bd
+  metadata.gz: 835aca8c69a0b94f348930cefdc3454d2d90c131718bc1d825960e928ca43c3b
+  data.tar.gz: '0240594c5422307db61e8dc208cef8ac06513c76bde7fda0ba649920bf4a400c'
 SHA512:
-  metadata.gz: 4d58a2a88592ff4d8cc65c50afeda3ec153ed1a2abc451827ae670c3eff5c0af8fdcecb837689eb2915de5ebd08c1216913b15c9ef14a75b93cbba4c3ee81f06
-  data.tar.gz: 4ef954fed64bd7e30ee7314524cccc6baa89709c0e3e279fb07df608e6927cb05aee7ef19e7e747c86e1dd499d68037b1d9ad2539ec9da7ab89f47e481a9839f
+  metadata.gz: 57b4ebebb1efea8ea65f47b53cab0d8057864afd45ee5df75a05e0fd9c36ad7d4ee68d591d8e5d5e30d869787d22eb93a90a2da4a973dde5f7f0613215aff99d
+  data.tar.gz: 305fa3917126e9abccdf3ed2c517e8a305675b6ad3aa46d3adb91a42fc0219d38da49bb57a2f391e6ba8b2393982a78d4d3a0022b1211dc46feb71c71e2d726d

data/.rubocop.yml

@@ -1,8 +1,19 @@
 inherit_gem:
   rubocop-shopify: rubocop.yml
 
-Lint/MissingSuper:
-  Enabled: false
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - "bin/**/*"
+    - "examples/*"
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
 
 Layout/LineLength:
   Max: 120

data/Gemfile

@@ -4,6 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in qismo.gemspec
 gemspec
-
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -1,15 +1,23 @@
 PATH
   remote: .
   specs:
-    qismo (0.1.8)
-      http (~> 5.0)
+    qismo (0.1.0)
+      activesupport
+      http
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
@@ -17,24 +25,30 @@ GEM
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    http (5.0.4)
+    http (5.1.0)
       addressable (~> 2.8)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
       llhttp-ffi (~> 0.4.0)
-    http-cookie (1.0.4)
+    http-cookie (1.0.5)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    language_server-protocol (3.17.0.1)
     llhttp-ffi (0.4.0)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
-    parallel (1.21.0)
-    parser (3.1.1.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
-    public_suffix (4.0.6)
+    prettier_print (1.1.0)
+    public_suffix (5.0.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.6.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -45,37 +59,49 @@ GEM
     rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.25.1)
+    rubocop (1.36.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
-    rubocop-shopify (2.4.0)
-      rubocop (~> 1.24)
+    rubocop-shopify (2.10.1)
+      rubocop (~> 1.35)
+    ruby-lsp (0.3.6)
+      language_server-protocol (~> 3.17.0)
+      sorbet-runtime
+      syntax_tree (>= 4.0.2, < 5.0.0)
     ruby-progressbar (1.11.0)
+    sorbet-runtime (0.5.10564)
+    syntax_tree (4.3.0)
+      prettier_print (>= 1.0.2)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.8)
-    unicode-display_width (2.1.0)
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
+  byebug
   qismo!
-  rake (~> 13.0)
+  rake
   rspec (~> 3.0)
-  rubocop-shopify (~> 2.3)
+  rubocop-shopify
+  ruby-lsp
 
 BUNDLED WITH
-   2.1.4
+   2.3.12

data/README.md

@@ -1,120 +1,160 @@
 # Qismo Ruby
 
-A Ruby API wrapper for Qiscus Multichannel API
+A Ruby API wrapper for Qiscus Omnichannel API
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem "qismo"
-```
-
-And then execute:
+Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle install
+bundle add qismo
 ```
 
 ## Usage
 
-**Example for single app id**
+### Initialize and make request
+
+To start using Qismo ruby, you must get your account's `App ID` and `Qiscus Secret Key` which can be checked in your admin dashboard's [settings page](https://omnichannel.qiscus.com/settings). After getting these data, you can start initialize the client.
 
 ```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"]
+Qismo.configure do |client|
+  client.app_id           = "YOU_ACCOUNT_APP_ID"
+  client.secret_key       = "YOUR_ACCOUNT_SECRET_KEY"
+
+  ## Optional
+  client.url              = "https://qismo.qiscus.com"
+  client.logger           = { logger: Logger.new($stdout) }
+  client.instrumentation  = { instrumenter: ActiveSupport::Notifications.instrumenter }
+  client.timeout          = { connect: 5, write: 2, read: 5 }
+  client.proxy            = ["proxy-hostname.local", 8080, "username", "password"]
 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)
+Then, start requesting to any endpoint yg want
 
-# Resolve the rooms
-rooms.each(Qismo::Room.resolve(&:id))
+```ruby
+params = {
+  channel: { id: 12345, source: "wa" },
+  status: "unresolved",
+  serve_status: "served",
+  is_handled_by_bot: false,
+}
+
+rooms = Qismo.rooms(params)
 ```
 
-**Example for multi app id**
+If your app manage multiple app id, you initialize the client like below
 
 ```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
+client = Qismo::Client.new(app_id: "YOUR_ACCOUNT_APP_ID", secret_key: "YOUR_ACCOUNT_SECRET_KEY")
+```
+
+Then, start requesting to an endpoint using that `client` variable
+
+```ruby
+params = {
+  channel: { id: 12345, source: "wa" },
+  status: "unresolved",
+  serve_status: "served",
+  is_handled_by_bot: false,
+}
+
+rooms = client.rooms(params)
 ```
 
-**Nested operations**
+### Client configuration
 
-If you prefer to use nested operations, you can also use this package like below
+**url**
+
+Defaultly, Qismo ruby will use your QISCUS_OMNICHANNEL_URL env as base url. If its nil, it will use https://qismo.qiscus.com. If you need to customize URL other than that, you can pass it at client initialization
 
 ```ruby
-client = Qismo.new(app_id: room.qiscus_app.app_id, secret_key: room.qiscus_app.secret_key)
-client.room.resolve(id)
+client.url = "https://qismo.qiscus.com"
 ```
 
-**Requesting to unhandled API**
+**logger**
 
-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:
+You can also log the request and response the any HTTP request you make in Qismo ruby by using this configuration
 
 ```ruby
-Qismo.client.call("post", "/api/v2/api_endpoint", json: {}, params: {})
+require "logger"
+
+client.logger = Logger.new($stdout)
 ```
 
-**Error handling**
+**instrumentation**
+
+For advanced logging, you can also use laverage ActiveSupport instrumentation. If you are using Rails, you can use ActiveSupport without installing the gem by your self.
 
 ```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
+ActiveSupport::Notifications.subscribe('start_request.http') d |name, start, finish, id, payload|
+  pp :name => name, :start => start.to_f, :finish => finish.to_f, :id => id, :payload => payload
 end
+
+client.instrumentation = { instrumenter: ActiveSupport::Notifications.instrumenter }client.instrumentation = { instrumenter: ActiveSupport::Notifications.instrumenter }client.instrumentation = { instrumenter: ActiveSupport::Notifications.instrumenter }
+```
+
+You can also customize the instrumentation's namespace by using this configuration
+
+```ruby
+client.instrumentation = { instrumenter: ActiveSupport::Notifications.instrumenter, namespace: "qiscus.http_request" }
 ```
 
-## Experience
+**timeout**
 
-This  gem leverage YARD to improve text editor autocompletion
+By default, the Qismo ruby gem does not enforce timeout on a request. You can enable per operation timeouts (each read/write/connect call) or global timeouts (sum of all read/write/connect calls) by configuring them through the chaining API.
 
-Install YARD
+Per operation timeouts are what `Net::HTTP` and the majority of HTTP clients do:
 
-```shell
-gem install yard
+```ruby
+client.timeout = { connect: 5, write: 2, read: 10 }
 ```
 
-Change to project directory and expose gem YARD documentation
+Global timeouts let you set an upper bound of how long a request can take
 
-```shell
-yard gems
+```ruby
+client.timeout = 5 # in seconds
 ```
 
-For VSCode users, you can use Solargraph gem to improve the autocompletion
+**proxy**
+
+Making request behind proxy is as simple as making them directly. Just specify hostname (or IP address) of your proxy server and its port, and here you go
+
+```ruby
+client.proxy = ["proxy-hostname.local", 8080]
+```
 
-## Development
+Proxy needs authentication?
 
-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.
+```ruby
+client.proxy = ["proxy-hostname.local", 8080, "username", "password"]
+```
 
-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).
+### Handling pagination
 
-## Contributing
+Some of the Qiscus Omnichannel API will return list of data with pagination. To handle the pagination, you can to that like this example:
 
-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).
+```ruby
+all_rooms = []
+rooms = client.rooms
+all_rooms.append(rooms)
 
-## License
+while rooms.has_next_page?
+  rooms = rooms.next_page
+  all_rooms.append(rooms)
+end
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+### Handling error
 
-## Code of Conduct
+Qismo ruby raise error while getting non successful http code from Qiscus Omnichannel API. To handle it, you follow this example:
 
-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).
+```ruby
+begin
+  client.rooms
+rescue Qismo::HTTPRequestError => e
+  e.message
+  e.status_code
+  e.response_body
+end
+```

data/Rakefile

@@ -1,6 +1,12 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/qismo/api.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+module Qismo
+  module Api
+    include Qismo::Model
+
+    def rooms(**opt)
+      body = post("/api/v2/customer_rooms", opt)
+      Collection.new(
+        body.data.customer_rooms,
+        prev_page: body.meta.cursor_before,
+        next_page: body.meta.cursor_after,
+        prev_func: -> do
+          if body.meta.cursor_before.nil? || body.meta.cursor_before.empty?
+            Collection.new([])
+          else
+            rooms(opt.merge(cursor_before: body.meta.cursor_before))
+          end
+        end,
+        next_func: -> do
+          if body.meta.cursor_after.nil? || body.meta.cursor_after.empty?
+            Collection.new([])
+          else
+            rooms(opt.merge(cursor_after: body.meta.cursor_after))
+          end
+        end,
+      )
+    end
+
+    def room(room_id)
+      body = get("/api/v2/customer_rooms/#{room_id}")
+      body.data.customer_room
+    end
+
+    def room_additional_info(room_id)
+      body = get("/api/v1/qiscus/room/#{room_id}/user_info")
+      body.data.extras.user_properties
+    end
+
+    def set_room_additional_info(room_id, *additional_info)
+      body = post("/api/v1/qiscus/room/#{room_id}/user_info", user_properties: additional_info)
+      body.data.extras.user_properties
+    end
+
+    def update_room_additional_info(room_id, *additional_info)
+      old_additional_info = room_additional_info(room_id)
+      new_additional_info = (additional_info + old_additional_info).uniq { |h| h.values_at("key") }
+      set_room_additional_info(room_id, *new_additional_info)
+    end
+
+    def room_broadcast_history(room_id, **opt)
+      body = get("/api/v2/customer_rooms/#{room_id}/broadcast_history", opt)
+      Collection.new(body.data.broadcast_logs, body.data.meta)
+    end
+
+    def assign_agent(room_id, agent_id, **opt)
+      body = post("/api/v1/admin/service/assign_agent", opt.merge(room_id: room_id.to_s, agent_id: agent_id))
+      body.data.added_agent
+    end
+
+    def remove_agent(room_id, agent_id)
+      post("/api/v1/admin/service/remove_agent", room_id: room_id.to_s, agent_id: agent_id)
+      true
+    end
+
+    def resolve(room_id, last_comment_id, **opt)
+      body = post("/api/v1/admin/service/mark_as_resolved",
+        opt.merge(room_id: room_id, last_comment_id: last_comment_id))
+      body.data.service
+    end
+
+    def allocate_agent(source, **opt)
+      body = post("/api/v1/admin/service/allocate_agent", opt.merge(source: source))
+      body.data.agent
+    end
+
+    def allocate_and_assign_agent(room_id, **opt)
+      body = post("/api/v1/admin/service/allocate_assign_agent", opt.merge(room_id: room_id))
+      body.data.agent
+    end
+
+    def other_agents(room_id, **opt)
+      body = get("/api/v2/admin/service/other_agents", opt.merge(room_id: room_id))
+      Collection.new(body.data.agents, body.meta)
+    end
+
+    def available_agents(room_id, **opt)
+      body = get("/api/v2/admin/service/available_agents", opt.merge(room_id: room_id))
+      Collection.new(body.data.agents, body.meta)
+    end
+
+    def new_session_webhook
+      get("/api/v2/app/config/new_session_webhook").data.configs
+    end
+
+    def set_new_session_webhook(url, **opt)
+      post("/api/v2/app/config/new_session_webhook", opt.merge(url: url)).data.configs
+    end
+
+    def auth_webhook
+      get("/api/v2/app/config/auth_webhook").data.configs
+    end
+
+    def set_auth_webhook(url, **opt)
+      post("/api/v2/app/config/auth_webhook", opt.merge(url: url)).data.configs
+    end
+
+    def resolve_webhook
+      get("/api/v1/app/webhook/mark_as_resolved").data
+    end
+
+    def set_resolve_webhook(url, **opt)
+      post("/api/v1/app/webhook/mark_as_resolved", opt.merge(url: url)).data
+    end
+
+    def agents(**opt)
+      body = get("/api/v2/admin/agents", opt)
+      [body.data.agents, body.meta]
+    end
+
+    def agents_by_ids(*ids)
+      get("/api/v1/admin/agents/get_by_ids", ids: ids).data
+    end
+
+    def agent_by_divisions(*division_ids, **opt)
+      get("/api/v2/admin/agents/by_division", opt.merge(division_ids: division_ids)).data
+    end
+
+    def agent(agent_id)
+      get("/api/v2/admin/agent/#{agent_id}").data.agent
+    end
+
+    def office_hours
+      get("/api/v1/admin/office_hours").data
+    end
+
+    def wa_broadcast_templates(**opt)
+      body = get("/api/v2/admin/hsm", opt)
+      [body.data.hsm_templates, body.meta]
+    end
+
+    def send_wa_outbound(**opt)
+      post("/api/v3/admin/broadcast/client", opt).data
+    end
+
+    def upload_wa_broadcast_csv(file, template_detail_id)
+      raise ArgumentError, "Invalid file" unless file.is_a?(HTTP::FormData::File)
+
+      post_upload("/api/v3/admin/broadcast/upload_csv", file: file, template_detail_id: template_detail_id)
+    end
+
+    def send_wa_broadcast(**opt)
+      post("/api/v3/admin/broadcast/send_broadcast", opt).data.broadcast_job
+    end
+
+    def wa_broadcast_jobs(**opt)
+      get("/api/v2/admin/broadcast_jobs", opt).data.broadcast_jobs
+    end
+
+    def wa_broadcast_job(broadcast_job_id)
+      get("/api/v2/admin/broadcast_jobs/#{broadcast_job_id}").data.broadcast_job
+    end
+
+    def wa_broadcast_logs(broadcast_job_id, **opt)
+      get("/api/v2/admin/broadcast_logs/#{broadcast_job_id}", opt).data.broadcast_logs
+    end
+
+    def send_bot_message(**opt)
+      post("#{app_id}/bot", opt)
+      true
+    end
+
+    def enable_chatbot_in_room(room_id)
+      post("/bot/#{room_id}/activate", is_active: true)
+      true
+    end
+
+    def disable_chatbot_in_room(room_id)
+      post("/bot/#{room_id}/activate", is_active: false)
+      true
+    end
+
+    def handover_room_from_bot(room_id)
+      post("/#{app_id}/bot/#{room_id}/hand_over")
+      true
+    end
+
+    def handover_room_from_bot_to_division(room_id, *roles, **opt)
+      post("/#{app_id}/bot/#{room_id}/hand_over_to_role", opt.merge(roles: roles))
+      true
+    end
+
+    def initiate_widget_chat(user_id, name, **opt)
+      post("/api/v2/qiscus/initiate_chat", opt.merge(user_id: user_id, name: name)).data.customer_room
+    end
+
+    def send_message_to_custom_channel(identifier_key, user_id, name, **opt)
+      post("/#{app_id}/api/v2/custom_channel/send",
+        opt.merge(identifier_key: identifier_key, user_id: user_id, name: name)).data
+    end
+  end
+end