crisp-api 1.1.1 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 73edc201f441670de7a0a5f19f264e9cd63dbdd2
-  data.tar.gz: d9a70ac91e7d86a5a4e37776cadf9257ed18427c
+SHA256:
+  metadata.gz: fe1293fc6504f10040ac4837f78ca211c437e823c6381a962d8f2fd7ffe16067
+  data.tar.gz: c97ef803d68d9c7d7f83c568cc81f9e90118baaff3f16c2e123636b5e14dfe2c
 SHA512:
-  metadata.gz: 06e95d148d771c58a47908bcaf5fedbf61d658e9508b63d134eb92ec324d2efeda2eca1dbb13dff1e6214596f1a3a456683e86d64e3c6ac38fcc4a1ccdb75a5b
-  data.tar.gz: dad99b1c1f8756531d5f6bfef3ce0684b35ac6a475763d9added5c6890829ec842abf6ad3ecbdcefd55b27ccbbff5c4f5402eb9cccfe68ebb8b4e90ecba984cd
+  metadata.gz: 9066fdcc6d9305de0607524f3eb720dd750ce5d517bd95e9eed49ce5101166c2af6aa336bc9d8e7785b1fd2e3e49a55a1402b4c44ac9f0b2777d538deb766c6a
+  data.tar.gz: f9c9ffeb9c607fff2e1888b744ee6df6a168f11f36c7ad3c489050b29c8d117df99aef8804bc9b61929543b033fcf2374450cb207d6bdff4ab83fb782314af13

data/README.md

@@ -2,23 +2,23 @@
 
 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)
+* **😘 Maintainer**: [@valeriansaliou](https://github.com/valeriansaliou), [@eliottvincent](https://github.com/eliottvincent)
 
 ## Usage
 
 Add the library to your `Gemfile`:
 
 ```bash
-gem 'crisp-api', '~> 1.0'
+gem "crisp-api", "~> 1.1.5"
 ```
 
 Then, import it:
 
 ```ruby
-require 'crisp-api'
+require "crisp-api"
 ```
 
 Build a new authenticated Crisp client with your `identifier` and `key` tokens.
@@ -42,6 +42,10 @@ Then, add authentication parameters to your `client` instance right after you cr
 ```ruby
 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")
 client.authenticate(identifier, key)
@@ -81,6 +85,7 @@ 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)`
@@ -114,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)`
@@ -149,6 +154,7 @@ 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
 

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.1.1'
+  s.name          = "crisp-api"
+  s.version       = "1.1.5"
   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,12 +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/website'
+require_relative "errors/route"
+require_relative "resources/bucket"
+require_relative "resources/website"
 
 module Crisp
   class Client
@@ -22,6 +22,7 @@ module Crisp
 
     def initialize()
       @auth = {}
+      @tier = "user"
 
       @bucket = Crisp::BucketResource.new(self)
       @website = Crisp::WebsiteResource.new(self)
@@ -34,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
@@ -86,9 +91,10 @@ module Crisp
           :payload => (data ? data.to_json : nil),
 
           :headers => {
-            :user_agent => "ruby-crisp-api/1.1.1",
+            :user_agent => "ruby-crisp-api/1.1.5",
             :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,24 +99,45 @@ 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)
-      return @parent.post(self._url_website(website_id, "/conversation"), data: data)
+    def create_new_conversation(website_id)
+      return @parent.post(self._url_website(website_id, "/conversation"))
     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.remove(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.1.1
+  version: 1.1.5
 platform: ruby
 authors:
 - Valerian Saliou
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-24 00:00:00.000000000 Z
+date: 2021-07-20 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: []
@@ -44,7 +44,7 @@ homepage: https://github.com/crisp-im/ruby-crisp-api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -59,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: []