crisp_client 0.2.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 426656a67b63a73e2fbc15c28c35ee244983df3e
-  data.tar.gz: 10879af766740e19f775569636327c91c6efbc1d
+  metadata.gz: f7324c527da45bbaa55dd5e8a5671d9bf314c6ee
+  data.tar.gz: 13b01632fc5e79bc8b4834e60e3e8a4f5bba85b3
 SHA512:
-  metadata.gz: 8e7a17a0ef57fc87a87b4dc5586d8025a4ace11348064fb21f0e2b1cfe31ec1cdc3669a9c4e9c1a4deb8b5eb4e7aa494c2b63e989eeb7b7a9b70e68a16f055c6
-  data.tar.gz: cce3e3343dd4f58f1c597670f792c057249e9bb296b9d66e8bd24bbff38bc66216cd0e6484879647fa5f16ad7cc94a6cb7b8f0ba28c829d96c61314db137cd8e
+  metadata.gz: 216d6562b683178df0e60f1b7c8d67f2be2d2a6ea8e62032d6352739b6d256a3d7a2d986f093c67a121825a506a9f141106168a57dfe9e9a5068e40e26264877
+  data.tar.gz: 874868efdf1fc092f613e15a99549ccb664df377fe9d7f6276971582bae817dc4447f5a126edbf64111286b45936cf8f2535a24c2fb3a07c2234332a4b38b95f

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.rbenv-vars

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/README.md

@@ -27,9 +27,26 @@ cc.remove_people_profile(website_id: website_id, people_id: person_id)
 
 cc.list_people_profiles(website_id: website_id)
 #=> will return the first 20 users by default
-cc.list_people_profiles(website_id: website_id, page_number: 2)
+cc.list_people_profiles(website_id: website_id, page_number: 2, search_filter: "test@email.com")
 #=> will return the next 20 users
 # Other parameters you can use include: sort_field, sort_order, search_operator, search_filter
+# The search_filter parameter is to be used exactly as in the dashboard, as in: "&search_filter="parameter"
+
+cc.update_conversation_metas website_id: website_id, session_id: session_id, 
+									meta: { nickname: "test nickname", email: "test@email.com", phone: "9999-9999", 
+													address: "rua teste 99t", segments: ["segmento 1", "segmento 2"], 
+									data: { teste_data: "data_teste_3", valorArbitrario: "teste arbitrário 3" } }
+# Updates the metadata from a specific conversation, given a session_id
+# Remember that conversation metadata is not equal to profile metadata. Each conversation has their own parameters.
+
+cc.update_people_profile website_id: website_id, people_id: people_id, 
+  								profile_data: { person: { phone: "9999-9999", nickname: "test nickname 2", 
+                                                address: "rua teste 99t", website: "http://teste.com"},
+                                    segments: ["segmento 4", "segmento 3"], 
+                                    company: { name: "Empresa teste" },
+                                    geolocation: { city: "Cidade teste" } }
+# Updates a user's profile data. This is what you see when you click in a specific profile.
+
 ```
 
 ## Installation

data/lib/crisp_client.rb

@@ -2,7 +2,9 @@ require "crisp_client/version"
 require "crisp_client/user_availability"
 require "crisp_client/list_websites"
 require "crisp_client/website_people"
+require "crisp_client/website_conversation.rb"
 require "httparty"
+require "uri"
 
 module CrispClient
   class Base
@@ -10,6 +12,7 @@ module CrispClient
     include UserAvailability
     include ListWebsites
     include WebsitePeople
+    include WebsiteConversation
 
     base_uri "https://api.crisp.im/v1"
 

data/lib/crisp_client/version.rb

@@ -1,3 +1,3 @@
 module CrispClient
-  VERSION = "0.2.1"
+  VERSION = "0.2.5"
 end

data/lib/crisp_client/website_conversation.rb

@@ -0,0 +1,26 @@
+module WebsiteConversation
+  # https://docs.crisp.chat/api/v1/#website-website-conversation-post
+	def create_a_new_conversation(website_id:)
+    response = self.class.post("/website/#{website_id}/conversation",
+      headers: { 'Content-Type' => 'application/json' }.merge(@auth))
+
+    if response["error"] == false
+      return response["data"]
+    else
+      raise response["reason"]
+    end
+	end
+
+	# https://docs.crisp.chat/api/v1/#website-website-conversation-patch-4
+  def update_conversation_metas(website_id:, session_id:, meta:)
+    response = self.class.patch("/website/#{website_id}/conversation/#{session_id}/meta",
+      body: meta.to_json,
+      headers: { 'Content-Type' => 'application/json' }.merge(@auth))
+    
+    unless response.nil? && response["error"] == true
+      return response["data"]
+    else
+      raise response["reason"]
+    end
+  end
+end

data/lib/crisp_client/website_people.rb

@@ -5,9 +5,34 @@ module WebsitePeople
   end
 
   # https://docs.crisp.im/api/v1/#website-website-people-get-2
-  def list_people_profiles(website_id:, page_number: 1, sort_field: "nickname", sort_order: "ascending")
-    # TODO: accept params sort_field, sort_order, search_operator, search_filter
-    client_get("/website/#{website_id}/people/profiles/#{page_number}?sort_order=#{sort_order}")["data"]
+  def list_people_profiles(website_id:, page_number: 1, sort_field: "active", sort_order: "descending", search_operator: "or", search_filter: "")
+    #The way to use the "search_filter" parameter isn't documented in the CRISP docs
+    #i've obtained this information by intercepting the HTTP request made when you use the dashboard to search for profiles
+    #You can view this information by using the "network" section in your devtools of choice. 
+    #The "list_people_profiles" is what's used when you search for something in the dashboard, thus, it makes several requests using your parameter.
+    
+    filter = [{"model":"people","criterion":"email","operator":"has","query":["#{search_filter}"]},
+              {"model":"people","criterion":"segments","operator":"has","query":["#{search_filter}"]},
+              {"model":"people","criterion":"company.name","operator":"has","query":["#{search_filter}"]},
+              {"model":"people","criterion":"company.legal_name","operator":"has","query":["#{search_filter}"]},
+              {"model":"people","criterion":"person.nickname","operator":"has","query":["#{search_filter}"]},
+              {"model":"people","criterion":"person.address","operator":"has","query":["#{search_filter}"]},
+              {"model":"people","criterion":"person.employment.name","operator":"has","query":["#{search_filter}"]},
+              {"model":"people","criterion":"person.geolocation.city","operator":"has","query":["#{search_filter}"]},
+              {"model":"people","criterion":"person.geolocation.country","operator":"has","query":["#{search_filter}"]}]
+    
+    filter = filter.to_json
+    filter = URI.encode(filter.to_s)
+    filter = filter.gsub(/\[/, "%5B").gsub(/\]/, "%5D")
+
+    response = client_get("/website/#{website_id}/people/profiles/#{page_number}?search_filter=#{filter}&search_operator=#{search_operator}&sort_field=#{sort_field}&sort_order=#{sort_order}")
+    if response["data"].empty?
+      return nil 
+    elsif response["error"] == false
+      return response["data"]
+    else
+      raise response["reason"]
+    end
   end
 
   # https://docs.crisp.im/api/v1/#website-website-people-post
@@ -29,4 +54,18 @@ module WebsitePeople
       headers: { 'Content-Type' => 'application/json' }.merge(@auth))
     return response["reason"]
   end
+
+  #https://docs.crisp.chat/api/v1/#website-website-people-patch
+  def update_people_profile(website_id:, people_id:, profile_data:)
+    response = self.class.patch("/website/#{website_id}/people/profile/#{people_id}",
+      body: profile_data.to_json,
+      headers: { 'Content-Type' => 'application/json' }.merge(@auth))
+    
+    unless response.nil? && response["error"] == true
+      return response["data"]
+    else
+      raise response["reason"]
+    end
+  end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crisp_client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.5
 platform: ruby
 authors:
 - Flavio Wuensche
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-09 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -71,6 +72,7 @@ files:
 - lib/crisp_client/list_websites.rb
 - lib/crisp_client/user_availability.rb
 - lib/crisp_client/version.rb
+- lib/crisp_client/website_conversation.rb
 - lib/crisp_client/website_people.rb
 homepage: https://github.com/fwuensche/crisp_client
 licenses:
@@ -92,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby Client for Crisp API