crisp-api 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dcb52c7cd84cfd52cf672db6ba448213a45b21e
-  data.tar.gz: c3ff479712a79c11ca68857e9fc6cff7b86780e8
+  metadata.gz: 73edc201f441670de7a0a5f19f264e9cd63dbdd2
+  data.tar.gz: d9a70ac91e7d86a5a4e37776cadf9257ed18427c
 SHA512:
-  metadata.gz: 20d99c221db89ad90d161b734080f4a1ebf6823b92e23024b775c4e778d982008f161d778dd283d88816ea3b10ac0f1c68b9da06ee015e670e1ec16c63919602
-  data.tar.gz: 91e4207c7e740743955d85b5cdd41b0a48446954e6c8b4a1c83d5ef9c374083a3ed65c321e835a3d8aa383163c49c90db082cd4b78e0f19a3f194e4c685628ef
+  metadata.gz: 06e95d148d771c58a47908bcaf5fedbf61d658e9508b63d134eb92ec324d2efeda2eca1dbb13dff1e6214596f1a3a456683e86d64e3c6ac38fcc4a1ccdb75a5b
+  data.tar.gz: dad99b1c1f8756531d5f6bfef3ce0684b35ac6a475763d9added5c6890829ec842abf6ad3ecbdcefd55b27ccbbff5c4f5402eb9cccfe68ebb8b4e90ecba984cd

data/README.md

@@ -21,7 +21,7 @@ Then, import it:
 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,14 @@ 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
 
 # Authenticate to API (identifier, key)
 # eg. client.authenticate("5c0595b2-9381-4a76-a2e0-04aa00c1ede7", "3bdb0812d0f5352bf68901ddc731434dade419b98507971905acdd2f967df61c")
@@ -53,7 +49,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 +57,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:
 
@@ -87,7 +83,7 @@ client.website.send_message_in_conversation(
   * **List Conversations**: `client.website.list_conversations(website_id, page_number)`
 
 * **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)`
@@ -158,10 +154,3 @@ client.website.send_message_in_conversation(
 
 * **Bucket URL**
   * **Generate Bucket URL**: `client.bucket.generate_bucket_url(data)`
-
-### User
-
-* **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()`

data/crisp-api.gemspec

@@ -2,7 +2,7 @@ require File.expand_path("../lib/crisp-api", __FILE__)
 
 Gem::Specification.new do |s|
   s.name          = 'crisp-api'
-  s.version       = '1.1.0'
+  s.version       = '1.1.1'
   s.date          = Date.today
   s.summary       = "Crisp API Ruby"
   s.description   = "Crisp API Ruby"

data/lib/crisp-api.rb

@@ -10,7 +10,6 @@ require 'json'
 
 require_relative 'errors/route'
 require_relative 'resources/bucket'
-require_relative 'resources/user'
 require_relative 'resources/website'
 
 module Crisp
@@ -19,14 +18,12 @@ module Crisp
     attr_writer :rest_base_path
 
     attr_accessor :bucket
-    attr_accessor :user
     attr_accessor :website
 
     def initialize()
       @auth = {}
 
       @bucket = Crisp::BucketResource.new(self)
-      @user = Crisp::UserResource.new(self)
       @website = Crisp::WebsiteResource.new(self)
     end
 
@@ -89,7 +86,7 @@ module Crisp
           :payload => (data ? data.to_json : nil),
 
           :headers => {
-            :user_agent => "ruby-crisp-api/1.1.0",
+            :user_agent => "ruby-crisp-api/1.1.1",
             :accept => :json,
             :content_type => :json,
             :params => query

data/lib/resources/website.rb

@@ -98,7 +98,7 @@ module Crisp
     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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crisp-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Valerian Saliou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2019-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -39,7 +39,6 @@ files:
 - 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:

data/lib/resources/user.rb

@@ -1,36 +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 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
-  end
-end