crisp-api 1.0.5 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 17b745dc91f065e520e1472be2cd5db9e2fad8d8
-  data.tar.gz: c124127cdef5d9261a1371609f948cf5cd60bb88
+SHA256:
+  metadata.gz: 53c7728a4e3a7dfd54454fda7525cdaf6ba0b6fa51e722b7a9c9d5d289dd0236
+  data.tar.gz: 8e35a4746ca4e8279b6cee485abd2a9a9411efae6a02358a7f5d6d17fd3905f0
 SHA512:
-  metadata.gz: a8e64e5600e34654095b3c12c6e45e9306508d9d0a2bf309477f8132488e9d5b76f1dd70c1835b344f237c6bab587bad88a49bc6bbfcdcae8ffd5b94ab72287f
-  data.tar.gz: 4718da28ce65e7f850302d957bec58d676a030e71d33f6a5fd7c7c7c18b38fc8c01646e4c4d1ddcde680dcfc1973af610378b3b9df847615be6bcccc58c14caa
+  metadata.gz: 54a6816c31343e8edabf31b24653eaec00d97cefaea05863b9e30bec1a781452cdd90a9b4b57168f434fbdbfe2353d2a66f0a5951374d381bb079e5588af58ed
+  data.tar.gz: 2b7b0ce22ce1f4eeb5471e800735f70926e50909260606644badca667c1d678bb288f297fe3b3ef393882b23e7d37f18f96666bb13f69edf1e3a850c9cfefcbb

data/README.md

@@ -2,7 +2,7 @@
 
 The Crisp API Ruby wrapper. Authenticate, send messages, fetch conversations, access your agent accounts from your Ruby code.
 
-Copyright 2018 Crisp IM SARL. See LICENSE for copying information.
+Copyright 2019 Crisp IM SARL. See LICENSE for copying information.
 
 * **📝 Implements**: [Crisp Platform - API ~ v1](https://docs.crisp.chat/api/v1/) at reference revision: 12/31/2017
 * **😘 Maintainer**: [@valeriansaliou](https://github.com/valeriansaliou)
@@ -12,16 +12,16 @@ Copyright 2018 Crisp IM SARL. See LICENSE for copying information.
 Add the library to your `Gemfile`:
 
 ```bash
-gem 'crisp-api', '~> 1.0'
+gem "crisp-api", "~> 1.1.4"
 ```
 
 Then, import it:
 
 ```ruby
-require 'crisp-api'
+require "crisp-api"
 ```
 
-Construct a new authenticated Crisp client with your `identifier` and `key` tokens.
+Build a new authenticated Crisp client with your `identifier` and `key` tokens.
 
 ```ruby
 client = Crisp::Client.new
@@ -33,18 +33,18 @@ Then, your client is ready to be consumed!
 
 ## Authentication
 
-To authenticate against the API, generate your session identifier and session key **once** using the following cURL request in your terminal (replace `YOUR_ACCOUNT_EMAIL` and `YOUR_ACCOUNT_PASSWORD`):
+To authenticate against the API, generate your session identifier and session key **once** using the [Crisp token generation utility](https://go.crisp.chat/account/token/). You'll get a token keypair made of 2 values.
 
-```bash
-curl -H "Content-Type: application/json" -X POST -d '{"email":"YOUR_ACCOUNT_EMAIL","password":"YOUR_ACCOUNT_PASSWORD"}' https://api.crisp.chat/v1/user/session/login
-```
-
-If authentication succeeds, you will get a JSON response containing your authentication keys: `identifier` and `key`. **Keep those 2 values private, and store them safely for long-term use**.
+**Keep your token keypair values private, and store them safely for long-term use.**
 
 Then, add authentication parameters to your `client` instance right after you create it:
 
 ```ruby
-client = Crisp()
+client = Crisp::Client.new
+
+# Make sure to use the correct tier if you are authenticating a plugin
+# eg. with a permanent token generated from Crisp Marketplace
+client.set_tier("plugin")
 
 # Authenticate to API (identifier, key)
 # eg. client.authenticate("5c0595b2-9381-4a76-a2e0-04aa00c1ede7", "3bdb0812d0f5352bf68901ddc731434dade419b98507971905acdd2f967df61c")
@@ -53,7 +53,7 @@ client.authenticate(identifier, key)
 # Now, you can use authenticated API sections.
 ```
 
-**🔴 Important: Be sure to login once, and re-use the same authentication keys (same `identifier` + `key`) in all your subsequent requests to the API. Do not generate new tokens from your code for every new request to the API (you will be heavily rate-limited; that will induce HTTP failures for some of your API calls).**
+**🔴 Important: Make sure to generate your token once, and use the same token keys in all your subsequent requests to the API. Do not generate too many tokens, as we may invalidate your older tokens to make room for newer tokens.**
 
 ## Resource Methods
 
@@ -61,7 +61,7 @@ Most useful available Crisp API resources are implemented. **Programmatic method
 
 Thus, it is straightforward to look for them in the library while reading the [API Reference](https://docs.crisp.chat/api/v1/).
 
-In the following method prototypes, `crisp` is to be replaced with your Crisp API instance. For example, instanciate `client = Crisp()` and then call eg: `client.user.check_session_validity()`.
+In the following method prototypes, `crisp` is to be replaced with your Crisp API instance. For example, instanciate `client = Crisp()` and then call eg: `client.website.list_conversations(website_id, 1)`.
 
 When calling a method that writes data to the API (eg. send a message with: `client.website.send_message_in_conversation()`), you need to submit it this way:
 
@@ -85,9 +85,10 @@ client.website.send_message_in_conversation(
 
 * **Website Conversations**
   * **List Conversations**: `client.website.list_conversations(website_id, page_number)`
+  * **Search Conversations**: `client.website.search_conversations(website_id, page_number, search_query, search_type, search_operator, include_empty, filter_unread, filter_resolved, filter_not_resolved, filter_mention, filter_assigned, filter_unassigned, filter_date_start, filter_date_end, order_date_created", order_date_updated)`
 
 * **Website Conversation**
-  * **Create A New Conversation**: `client.website.create_new_conversation(website_id, data)`
+  * **Create A New Conversation**: `client.website.create_new_conversation(website_id)`
   * **Check If Conversation Exists**: `client.website.check_conversation_exists(website_id, session_id)`
   * **Get A Conversation**: `client.website.get_conversation(website_id, session_id)`
   * **Remove A Conversation**: `client.website.remove_conversation(website_id, session_id)`
@@ -118,7 +119,7 @@ client.website.send_message_in_conversation(
   * **Check If People Profile Exists**: `client.website.check_people_profile_exists(website_id, people_id)`
   * **Get People Profile**: `client.website.get_people_profile(website_id, people_id)`
   * **Save People Profile**: `client.website.save_people_profile(website_id, people_id, data)`
-  * **Find People Profile By Email**: `find_people_profile_by_email(website_id, email)`
+  * **Find People Profile By Email**: `client.website.find_people_profile_by_email(website_id, email)`
   * **Update People Profile**: `client.website.update_people_profile(website_id, people_id, data)`
   * **Remove People Profile**: `client.website.remove_people_profile(website_id, people_id)`
   * **List People Conversations**: `client.website.list_people_conversations(website_id, people_id, page_number)`
@@ -153,34 +154,9 @@ client.website.send_message_in_conversation(
 * **Website Visitors**
   * **Count Visitors**: `client.website.count_visitors(website_id)`
   * **List Visitors**: `client.website.list_visitors(website_id, page_number)`
+  * **Get Session ID**: `client.website.get_session_id_by_token(website_id, token)`
 
 ### Bucket
 
 * **Bucket URL**
   * **Generate Bucket URL**: `client.bucket.generate_bucket_url(data)`
-
-### User
-
-* **User Availability**
-  * **Get User Availability**: `client.user.get_user_availability()`
-  * **Update User Availability**: `client.user.update_user_availability(data)`
-  * **Get User Availability Status**: `client.user.get_user_availability_status()`
-
-* **User Account Base**
-  * **Get User Account**: `client.user.get_user_account()`
-  * **Create User Account**: `client.user.create_user_account(data)`
-
-* **User Account Websites**
-  * **List Websites**: `client.user.list_websites()`
-
-* **User Account Profile**
-  * **Get Profile**: `client.user.get_profile()`
-  * **Update Profile**: `client.user.update_profile(data)`
-
-* **User Session**
-  * **Check Session Validity**: `client.user.check_session_validity()`
-  * **Create A New Session**: `client.user.create_new_session(data)`
-  * **Destroy A Session**: `client.user.destroy_session()`
-
-* **User Statistics**
-  * **Count Total Unread Messages**: `client.user.count_total_unread_messages()`

data/crisp-api.gemspec

@@ -1,17 +1,17 @@
 require File.expand_path("../lib/crisp-api", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name          = 'crisp-api'
-  s.version       = '1.0.5'
+  s.name          = "crisp-api"
+  s.version       = "1.1.4"
   s.date          = Date.today
   s.summary       = "Crisp API Ruby"
   s.description   = "Crisp API Ruby"
   s.authors       = ["Valerian Saliou"]
-  s.email         = 'valerian@valeriansaliou.name'
+  s.email         = "valerian@valeriansaliou.name"
   s.files         = `git ls-files`.split($/)
-  s.homepage      = 'https://github.com/crisp-im/ruby-crisp-api'
-  s.license       = 'MIT'
-  s.require_paths = ['lib']
+  s.homepage      = "https://github.com/crisp-im/ruby-crisp-api"
+  s.license       = "MIT"
+  s.require_paths = ["lib"]
 
-  s.add_dependency 'rest-client', '~> 2.0.0'
+  s.add_dependency "rest-client", "~> 2.0"
 end

data/examples/website_send_message_in_conversation.rb

@@ -5,7 +5,7 @@
 # Author: Valerian Saliou <valerian@valeriansaliou.name>
 ##
 
-require 'crisp-api'
+require "crisp-api"
 
 client = Crisp::Client.new
 

data/lib/crisp-api.rb

@@ -5,13 +5,12 @@
 # Author: Valerian Saliou <valerian@valeriansaliou.name>
 ##
 
-require 'rest-client'
-require 'json'
+require "rest-client"
+require "json"
 
-require_relative 'errors/route'
-require_relative 'resources/bucket'
-require_relative 'resources/user'
-require_relative 'resources/website'
+require_relative "errors/route"
+require_relative "resources/bucket"
+require_relative "resources/website"
 
 module Crisp
   class Client
@@ -19,14 +18,13 @@ module Crisp
     attr_writer :rest_base_path
 
     attr_accessor :bucket
-    attr_accessor :user
     attr_accessor :website
 
     def initialize()
       @auth = {}
+      @tier = "user"
 
       @bucket = Crisp::BucketResource.new(self)
-      @user = Crisp::UserResource.new(self)
       @website = Crisp::WebsiteResource.new(self)
     end
 
@@ -37,6 +35,10 @@ module Crisp
       @auth["key"] = key
     end
 
+    def set_tier(tier)
+      @tier = tier
+    end
+
     def rest_host
       @rest_host || "https://api.crisp.chat"
     end
@@ -89,9 +91,10 @@ module Crisp
           :payload => (data ? data.to_json : nil),
 
           :headers => {
-            :user_agent => "ruby-crisp-api/1.0.5",
+            :user_agent => "ruby-crisp-api/1.1.4",
             :accept => :json,
             :content_type => :json,
+            "X-Crisp-Tier" => @tier,
             :params => query
           }
         )

data/lib/resources/bucket.rb

@@ -5,7 +5,7 @@
 # Author: Valerian Saliou <valerian@valeriansaliou.name>
 ##
 
-require 'rest-client'
+require "rest-client"
 
 module Crisp
   class BucketResource

data/lib/resources/website.rb

@@ -5,25 +5,43 @@
 # Author: Valerian Saliou <valerian@valeriansaliou.name>
 ##
 
-require 'rest-client'
+require "rest-client"
 
 module Crisp
   class WebsiteResource
+    SEARCH_CONVERSATIONS_QUERY_PARAMETERS = [
+      "search_query",
+      "search_type",
+      "search_operator",
+      "include_empty",
+      "filter_unread",
+      "filter_resolved",
+      "filter_not_resolved",
+      "filter_mention",
+      "filter_assigned",
+      "filter_unassigned",
+      "filter_date_start",
+      "filter_date_end",
+      "filter_date_end",
+      "order_date_created",
+      "order_date_updated",
+    ]
+
     def initialize(parent)
       @parent = parent
     end
 
     protected
 
-    def _url_website(website_id, resource)
+    def _url_website(website_id, resource = "")
       return "/website/%s%s" % [website_id, resource]
     end
 
-    def _url_conversation(website_id, session_id, resource)
+    def _url_conversation(website_id, session_id, resource = "")
       return self._url_website(website_id, "/conversation/%s%s" % [session_id, resource])
     end
 
-    def _url_people(kind, website_id, people_id, resource)
+    def _url_people(kind, website_id, people_id, resource = "")
       return self._url_website(website_id, "/people/%s/%s%s" % [kind, people_id, resource])
     end
 
@@ -34,11 +52,11 @@ module Crisp
     end
 
     def get_website(website_id)
-      return @parent.get(self._url_website(website_id, ""))
+      return @parent.get(self._url_website(website_id))
     end
 
     def delete_website(website_id)
-      return @parent.delete(self._url_website(website_id, ""))
+      return @parent.delete(self._url_website(website_id))
     end
 
     def batch_resolve_items(website_id, data)
@@ -81,8 +99,29 @@ module Crisp
       return @parent.get(self._url_website(website_id, "/visitors/list/%d" % page_number))
     end
 
-    def list_conversations(website_id, page_number)
-      return @parent.get(self._url_website(website_id, "/conversations/%d" % page_number))
+    def search_conversations(website_id, page_number = 1, search_query = "", search_type = "", search_operator = "", include_empty = "", filter_unread = "", filter_resolved = "", filter_not_resolved = "", filter_mention = "", filter_assigned = "", filter_unassigned = "", filter_date_start = "", filter_date_end = "", order_date_created = "", order_date_updated = "")
+      resource_url = ""
+      query_parameters = []
+
+      SEARCH_CONVERSATIONS_QUERY_PARAMETERS.each do |parameter|
+        parameter_value = binding.local_variable_get(parameter)
+
+        if parameter_value != ""
+          query_parameters.push("%s=%s" % [parameter, CGI.escape(parameter_value).gsub("+", "%20")])
+        end
+      end
+
+      if query_parameters != []
+        resource_url = self._url_website(website_id, "/conversations/%d?%s" % [page_number, query_parameters.join("&")])
+      else
+        resource_url = self._url_website(website_id, "/conversations/%d" % page_number)
+      end
+
+      return @parent.get(resource_url)
+    end
+
+    def list_conversations(website_id, page_number = 1)
+      return self.search_conversations(website_id, page_number)
     end
 
     def create_new_conversation(website_id, data)
@@ -90,15 +129,15 @@ module Crisp
     end
 
     def check_conversation_exists(website_id, session_id)
-      return @parent.head(self._url_conversation(website_id, session_id, ""))
+      return @parent.head(self._url_conversation(website_id, session_id))
     end
 
     def get_conversation(website_id, session_id)
-      return @parent.get(self._url_conversation(website_id, session_id, ""))
+      return @parent.get(self._url_conversation(website_id, session_id))
     end
 
     def remove_conversation(website_id, session_id)
-      return @parent.delete(self._url_conversation(website_id, session_id, ""))
+      return @parent.remove(self._url_conversation(website_id, session_id))
     end
 
     def initiate_conversation_with_existing_session(website_id, session_id)
@@ -190,30 +229,27 @@ module Crisp
     end
 
     def check_people_profile_exists(website_id, people_id)
-      return @parent.head(self._url_people("profile", website_id, people_id, ""))
+      return @parent.head(self._url_people("profile", website_id, people_id))
     end
 
     def find_people_profile_by_email(website_id, email)
-      filter = [{:model => "people", :criterion => "email", :operator => "eq", query: [email]}]
-      profiles = @parent.get(self._url_website(website_id, "/people/profiles/1?search_filter=%s" % CGI.escape(filter.to_json)))
-
-      return profiles[0]
+      return @parent.get(self._url_people("profile", website_id, email))
     end
 
     def get_people_profile(website_id, people_id)
-      return @parent.get(self._url_people("profile", website_id, people_id, ""))
+      return @parent.get(self._url_people("profile", website_id, people_id))
     end
 
     def save_people_profile(website_id, people_id, data)
-      return @parent.put(self._url_people("profile", website_id, people_id, ""), data: data)
+      return @parent.put(self._url_people("profile", website_id, people_id), data: data)
     end
 
     def update_people_profile(website_id, people_id, data)
-      return @parent.patch(self._url_people("profile", website_id, people_id, ""), data: data)
+      return @parent.patch(self._url_people("profile", website_id, people_id), data: data)
     end
 
     def remove_people_profile(website_id, people_id)
-      return @parent.remove(self._url_people("profile", website_id, people_id, ""))
+      return @parent.remove(self._url_people("profile", website_id, people_id))
     end
 
     def list_people_conversations(website_id, people_id, page_number)
@@ -221,7 +257,7 @@ module Crisp
     end
 
     def add_people_event(website_id, people_id, data)
-      return @parent.post(self._url_people("events", website_id, people_id, ""), data: data)
+      return @parent.post(self._url_people("events", website_id, people_id), data: data)
     end
 
     def list_people_events(website_id, people_id, page_number)
@@ -229,19 +265,23 @@ module Crisp
     end
 
     def get_people_data(website_id, people_id)
-      return @parent.get(self._url_people("data", website_id, people_id, ""))
+      return @parent.get(self._url_people("data", website_id, people_id))
     end
 
     def save_people_data(website_id, people_id, data)
-      return @parent.put(self._url_people("data", website_id, people_id, ""), data: data)
+      return @parent.put(self._url_people("data", website_id, people_id), data: data)
     end
 
     def get_people_subscription_status(website_id, people_id)
-      return @parent.get(self._url_people("subscription", website_id, people_id, ""))
+      return @parent.get(self._url_people("subscription", website_id, people_id))
     end
 
     def update_people_subscription_status(website_id, people_id, data)
-      return @parent.patch(self._url_people("subscription", website_id, people_id, ""), data: data)
+      return @parent.patch(self._url_people("subscription", website_id, people_id), data: data)
+    end
+
+    def get_session_id_by_token(website_id, token)
+      return @parent.get(self._url_website(website_id, "/visitors/token/#{token}"))
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crisp-api
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.4
 platform: ruby
 authors:
 - Valerian Saliou
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
 description: Crisp API Ruby
 email: valerian@valeriansaliou.name
 executables: []
@@ -35,18 +35,16 @@ files:
 - LICENSE
 - README.md
 - crisp-api.gemspec
-- examples/user_get_profile.rb
 - examples/website_send_message_in_conversation.rb
 - lib/crisp-api.rb
 - lib/errors/route.rb
 - lib/resources/bucket.rb
-- lib/resources/user.rb
 - lib/resources/website.rb
 homepage: https://github.com/crisp-im/ruby-crisp-api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -61,9 +59,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Crisp API Ruby
 test_files: []

data/examples/user_get_profile.rb

@@ -1,19 +0,0 @@
-##
-# ruby-crisp-api
-#
-# Copyright 2018, Valerian Saliou
-# Author: Valerian Saliou <valerian@valeriansaliou.name>
-##
-
-require 'crisp-api'
-
-client = Crisp::Client.new
-
-client.authenticate(
-  "5c0595b2-9381-4a76-a2e0-04aa00c1ede7",
-  "3bdb0812d0f5352bf68901ddc731434dade419b98507971905acdd2f967df61c"
-)
-
-data = client.user.get_profile()
-
-puts data.inspect

data/lib/resources/user.rb

@@ -1,72 +0,0 @@
-##
-# ruby-crisp-api
-#
-# Copyright 2018, Valerian Saliou
-# Author: Valerian Saliou <valerian@valeriansaliou.name>
-##
-
-require 'rest-client'
-
-module Crisp
-  class UserResource
-    def initialize(parent)
-      @parent = parent
-    end
-
-    protected
-
-    def _url_user(resource)
-      return "/user%s" % resource
-    end
-
-    public
-
-    def get_user_availability
-      return @parent.get(self._url_user("/availability"))
-    end
-
-    def update_user_availability(data)
-      return @parent.patch(self._url_user("/availability"), data: data)
-    end
-
-    def get_user_availability_status
-      return @parent.get(self._url_user("/availability/status"))
-    end
-
-    def get_user_account
-      return @parent.get(self._url_user("/account"))
-    end
-
-    def create_user_account(data)
-      return @parent.post(self._url_user("/account"), data: data)
-    end
-
-    def list_websites
-      return @parent.get(self._url_user("/account/websites"))
-    end
-
-    def get_profile
-      return @parent.get(self._url_user("/account/profile"))
-    end
-
-    def update_profile(data)
-      return @parent.patch(self._url_user("/account/profile"), data: data)
-    end
-
-    def check_session_validity
-      return @parent.head(self._url_user("/session"))
-    end
-
-    def create_new_session(data)
-      return @parent.post(self._url_user("/session/login"))
-    end
-
-    def destroy_session
-      return @parent.post(self._url_user("/session/logout"))
-    end
-
-    def count_total_unread_messages
-      return @parent.get(self._url_user("/stats/unread"))
-    end
-  end
-end