crisp-api 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 704987e5c967c926caf8629b2dcc11a6137e80d6
+  data.tar.gz: 60555599bd6529c0c7a619a88214784855148e4f
+SHA512:
+  metadata.gz: 428fb0189315af090ffed1a0505ffcda531ef78dfc74aed8eb41f988c0323710739c32385d8711a55c915f92887c7c30921d93ad7aafe063b6c69b854806b630
+  data.tar.gz: 3d97221cd573e943ca21a89ddb9f08986c117b72d52dae26f3d9c7293e59436621639dff2937ab0a3baa32e36db61e74d0350511d6d51f0b720c83e32f2fffb8

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+*.rbc
+
+/.bundle/
+/vendor/
+
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gem "rest-client"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2018 Crisp IM SARL
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,178 @@
+# ruby-crisp-api
+
+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.
+
+* **📝 Implements**: [Crisp Platform - API ~ v1](https://docs.crisp.chat/api/v1/) at reference revision: 12/31/2017
+* **😘 Maintainer**: [@valeriansaliou](https://github.com/valeriansaliou)
+
+## Usage
+
+Add the library to your `Gemfile`:
+
+```bash
+gem 'crisp-api', '~> 1.0'
+```
+
+Then, import it:
+
+```ruby
+require 'crisp-api'
+```
+
+Construct a new authenticated Crisp client with your `identifier` and `key` tokens.
+
+```ruby
+client = Crisp::Client.new
+
+client.authenticate(identifier, key)
+```
+
+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`):
+
+```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**.
+
+Then, add authentication parameters to your `client` instance right after you create it:
+
+```ruby
+client = Crisp()
+
+# Authenticate to API (identifier, key)
+# eg. client.authenticate("5c0595b2-9381-4a76-a2e0-04aa00c1ede7", "3bdb0812d0f5352bf68901ddc731434dade419b98507971905acdd2f967df61c")
+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).**
+
+## Resource Methods
+
+Most useful available Crisp API resources are implemented. **Programmatic methods names are named after their label name in the [API Reference](https://docs.crisp.chat/api/v1/)**.
+
+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()`.
+
+When calling a method that writes data to the API (eg: `client.user.create_user_account()`), you need to build an account instance and submit it this way:
+
+```ruby
+client.user.create_user_account({
+  "email" => "john@acme-inc.com",
+  "password" => "SecurePassword",
+  "first_name" => "John",
+  "last_name" => "Doe"
+})
+```
+
+### Bucket
+
+* **Bucket URL**
+  * **Generate Bucket URL**: `client.bucket.generate_bucket_url`
+
+### User
+
+* **User Availability**
+  * **Get User Availability**: `client.user.get_user_availability`
+  * **Update User Availability**: `client.user.update_user_availability`
+  * **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`
+
+* **User Account Websites**
+  * **List Websites**: `client.user.list_websites`
+
+* **User Account Profile**
+  * **Get Profile**: `client.user.get_profile`
+  * **Update Profile**: `client.user.update_profile`
+
+* **User Session**
+  * **Check Session Validity**: `client.user.check_session_validity`
+  * **Create A New Session**: `client.user.create_new_session`
+  * **Destroy A Session**: `client.user.destroy_session`
+
+* **User Statistics**
+  * **Count Total Unread Messages**: `client.user.count_total_unread_messages`
+
+### Website
+
+* **Website Base**
+  * **Create Website**: `client.website.create_website`
+  * **Get A Website**: `client.website.get_website`
+  * **Delete A Website**: `client.website.delete_website`
+
+* **Website Batch**
+  * **Batch Resolve Items**: `client.website.batch_resolve_items`
+  * **Batch Read Items**: `client.website.batch_read_items`
+  * **Batch Remove Items**: `client.website.batch_remove_items`
+
+* **Website Availability**
+  * **Get Website Availability Status**: `client.website.get_website_availability_status`
+
+* **Website Operator**
+  * **List Website Operators**: `client.website.list_website_operators`
+  * **List Last Active Website Operators**: `client.website.list_last_active_website_operators`
+
+* **Website Settings**
+  * **Get Website Settings**: `client.website.get_website_settings`
+  * **Update Website Settings**: `client.website.update_website_settings`
+
+* **Website Visitors**
+  * **Count Visitors**: `client.website.count_visitors`
+  * **List Visitors**: `client.website.list_visitors`
+
+* **Website Conversations**
+  * **List Conversations**: `client.website.list_conversations`
+
+* **Website Conversation**
+  * **Create A New Conversation**: `client.website.create_new_conversation`
+  * **Check If Conversation Exists**: `client.website.check_conversation_exists`
+  * **Get A Conversation**: `client.website.get_conversation`
+  * **Remove A Conversation**: `client.website.remove_conversation`
+  * **Initiate A Conversation With Existing Session**: `client.website.initiate_conversation_with_existing_session`
+  * **Get Messages In Conversation**: `client.website.get_messages_in_conversation`
+  * **Send A Message In Conversation**: `client.website.send_message_in_conversation`
+  * **Update A Message In Conversation**: `client.website.update_message_in_conversation`
+  * **Compose A Message In Conversation**: `client.website.compose_message_in_conversation`
+  * **Mark Messages As Read In Conversation**: `client.website.mark_messages_read_in_conversation`
+  * **Mark Messages As Delivered In Conversation**: `client.website.mark_messages_delivered_in_conversation`
+  * **Get Conversation Routing Assign**: `client.website.get_conversation_routing_assign`
+  * **Assign Conversation Routing**: `client.website.assign_conversation_routing`
+  * **Get Conversation Metas**: `client.website.get_conversation_metas`
+  * **Update Conversation Metas**: `client.website.update_conversation_metas`
+  * **List Conversation Pages**: `client.website.list_conversation_pages`
+  * **List Conversation Events**: `client.website.list_conversation_events`
+  * **Get Conversation State**: `client.website.get_conversation_state`
+  * **Change Conversation State**: `client.website.change_conversation_state`
+  * **Get Block Status For Conversation**: `client.website.get_block_status_for_conversation`
+  * **Block Incoming Messages For Conversation**: `client.website.block_incoming_messages_for_conversation`
+  * **Request Email Transcript For Conversation**: `client.website.request_email_transcript_for_conversation`
+
+* **Website People**
+  * **Get People Statistics**: `client.website.get_people_statistics`
+  * **List People Segments**: `client.website.list_people_segments`
+  * **List People Profiles**: `client.website.list_people_profiles`
+  * **Add New People Profile**: `client.website.add_new_people_profile`
+  * **Check If People Profile Exists**: `client.website.check_people_profile_exists`
+  * **Get People Profile**: `client.website.get_people_profile`
+  * **Save People Profile**: `client.website.save_people_profile`
+  * **Update People Profile**: `client.website.update_people_profile`
+  * **Remove People Profile**: `client.website.remove_people_profile`
+  * **List People Conversations**: `client.website.list_people_conversations`
+  + **Add A People Event**: `client.website.add_people_event`
+  + **List People Events**: `client.website.list_people_events`
+  + **Get People Data**: `client.website.get_people_data`
+  + **Save People Data**: `client.website.save_people_data`
+  + **Get People Subscription Status**: `client.website.get_people_subscription_status`
+  + **Update People Subscription Status**: `client.website.update_people_subscription_status`

data/crisp-api.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name          = 'crisp-api'
+  s.version       = '1.0.1'
+  s.date          = Date.today
+  s.summary       = "Crisp API Ruby"
+  s.description   = "Crisp API Ruby"
+  s.authors       = ["Valerian Saliou"]
+  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.add_dependency 'rest-client', '~> 2.0.0'
+end

data/examples/user_get_profile.rb

@@ -0,0 +1,19 @@
+##
+# 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/examples/website_send_message_in_conversation.rb

@@ -0,0 +1,32 @@
+##
+# 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"
+)
+
+# Message routing details
+website_id = "6497e4a4-b17c-41e0-bfea-eea97ba8115a"
+session_id = "session_f32bc993-f7ce-41af-bcd1-110fc147a392"
+
+data = client.website.send_message_in_conversation(
+  website_id, session_id,
+
+  {
+    "type" => "text",
+    "content" => "This message was sent from python-crisp-api! :)",
+    "from" => "operator",
+    "origin" => "chat"
+  }
+)
+
+puts data.inspect

data/lib/crisp.rb

@@ -0,0 +1,124 @@
+##
+# ruby-crisp-api
+#
+# Copyright 2018, Valerian Saliou
+# Author: Valerian Saliou <valerian@valeriansaliou.name>
+##
+
+require 'rest-client'
+require 'json'
+
+require_relative 'errors/route'
+require_relative 'resources/bucket'
+require_relative 'resources/user'
+require_relative 'resources/website'
+
+module Crisp
+  class Client
+    attr_writer :rest_host
+    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
+
+    public
+
+    def authenticate(identifier, key)
+      @auth["identifier"] = identifier
+      @auth["key"] = key
+    end
+
+    def rest_host
+      @rest_host || "https://api.crisp.chat"
+    end
+
+    def rest_base_path
+      @rest_base_path || "/v1"
+    end
+
+    def timeout
+      @timeout || 5
+    end
+
+    def get(resource, query: {})
+      self._do_request(:get, resource, query: query)
+    end
+
+    def head(resource)
+      self._do_request(:head, resource)
+    end
+
+    def remove(resource)
+      self._do_request(:delete, resource)
+    end
+
+    def post(resource, data: {})
+      self._do_request(:post, resource, data: data)
+    end
+
+    def patch(resource, data: {})
+      self._do_request(:patch, resource, data: data)
+    end
+
+    def put(resource, data: {})
+      self._do_request(:put, resource, data: data)
+    end
+
+    protected
+
+    def _do_request(method, resource, query: nil, data: nil)
+      begin
+        response = RestClient::Request.execute(
+          :url => self._prepare_rest_url(resource),
+          :method => method,
+          :timeout => self.timeout,
+          :verify_ssl => OpenSSL::SSL::VERIFY_PEER,
+
+          :user => @auth["identifier"],
+          :password => @auth["key"],
+
+          :payload => (data ? data.to_json : nil),
+
+          :headers => {
+            :user_agent => "ruby-crisp-api/1.0.1",
+            :accept => :json,
+            :content_type => :json,
+            :params => query
+          }
+        )
+      rescue RestClient::ExceptionWithResponse => error
+        response = error.response
+      rescue
+        response = nil
+      end
+
+      if response
+        result = JSON.parse(response)
+      else
+        result = {
+          "error" => true,
+          "reason" => "http_error"
+        }
+      end
+
+      if result["error"] === true
+        raise RouteError, (result["reason"] || "error")
+      end
+
+      return result["data"] || {}
+    end
+
+    def _prepare_rest_url(resource)
+      return self.rest_host + self.rest_base_path + resource
+    end
+  end
+end

data/lib/errors/route.rb

@@ -0,0 +1,18 @@
+##
+# ruby-crisp-api
+#
+# Copyright 2018, Valerian Saliou
+# Author: Valerian Saliou <valerian@valeriansaliou.name>
+##
+
+class RouteError < StandardError
+  def initialize(reason)
+    @reason = reason
+
+    super(reason)
+  end
+
+  def to_s
+    @reason
+  end
+end

data/lib/resources/bucket.rb

@@ -0,0 +1,28 @@
+##
+# ruby-crisp-api
+#
+# Copyright 2018, Valerian Saliou
+# Author: Valerian Saliou <valerian@valeriansaliou.name>
+##
+
+require 'rest-client'
+
+module Crisp
+  class BucketResource
+    def initialize(parent)
+      @parent = parent
+    end
+
+    protected
+
+    def _url_bucket(resource)
+      return "/bucket%s" % resource
+    end
+
+    public
+
+    def generate_bucket_url(data)
+      return @parent.post(self._url_bucket("/url/generate"), data: data)
+    end
+  end
+end

data/lib/resources/user.rb

@@ -0,0 +1,72 @@
+##
+# 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

data/lib/resources/website.rb

@@ -0,0 +1,240 @@
+##
+# ruby-crisp-api
+#
+# Copyright 2018, Valerian Saliou
+# Author: Valerian Saliou <valerian@valeriansaliou.name>
+##
+
+require 'rest-client'
+
+module Crisp
+  class WebsiteResource
+    def initialize(parent)
+      @parent = parent
+    end
+
+    protected
+
+    def _url_website(website_id, resource)
+      return "/website/%s%s" % [website_id, resource]
+    end
+
+    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)
+      return self._url_website(website_id, "/people/%s/%s%s" % [kind, people_id, resource])
+    end
+
+    public
+
+    def create_website(data)
+      return @parent.post("/website", data)
+    end
+
+    def get_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, ""))
+    end
+
+    def batch_resolve_items(website_id, data)
+      return @parent.patch(self._url_website(website_id, "/batch/resolve"), data: data)
+    end
+
+    def batch_read_items(website_id, data)
+      return @parent.patch(self._url_website(website_id, "/batch/read"), data: data)
+    end
+
+    def batch_remove_items(website_id, data)
+      return @parent.patch(self._url_website(website_id, "/batch/remove"), data: data)
+    end
+
+    def get_website_availability_status(website_id)
+      return @parent.get(self._url_website(website_id, "/availability/status"))
+    end
+
+    def list_website_operators(website_id)
+      return @parent.get(self._url_website(website_id, "/operators/list"))
+    end
+
+    def list_last_active_website_operators(website_id)
+      return @parent.get(self._url_website(website_id, "/operators/active"))
+    end
+
+    def get_website_settings(website_id)
+      return @parent.get(self._url_website(website_id, "/settings"))
+    end
+
+    def update_website_settings(website_id, data)
+      return @parent.patch(self._url_website(website_id, "/settings"), data: data)
+    end
+
+    def count_visitors(website_id)
+      return @parent.get(self._url_website(website_id, "/visitors/count"))
+    end
+
+    def list_visitors(website_id, page_number)
+      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))
+    end
+
+    def create_new_conversation(website_id, data)
+      return @parent.post(self._url_website(website_id, "/conversation"), data: data)
+    end
+
+    def check_conversation_exists(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, ""))
+    end
+
+    def remove_conversation(website_id, session_id)
+      return @parent.delete(self._url_conversation(website_id, session_id, ""))
+    end
+
+    def initiate_conversation_with_existing_session(website_id, session_id)
+      return @parent.post(self._url_conversation(website_id, session_id, "/initiate"))
+    end
+
+    def get_messages_in_conversation(website_id, session_id, query)
+      return @parent.get(self._url_conversation(website_id, session_id, "/messages"), query: query)
+    end
+
+    def send_message_in_conversation(website_id, session_id, data)
+      return @parent.post(self._url_conversation(website_id, session_id, "/message"), data: data)
+    end
+
+    def update_message_in_conversation(website_id, session_id, fingerprint, data)
+      return @parent.patch(self._url_conversation(website_id, session_id, "/message/%d" % fingerprint), data: data)
+    end
+
+    def compose_message_in_conversation(website_id, session_id, data)
+      return @parent.patch(self._url_conversation(website_id, session_id, "/compose"), data: data)
+    end
+
+    def mark_messages_read_in_conversation(website_id, session_id, data)
+      return @parent.patch(self._url_conversation(website_id, session_id, "/read"), data: data)
+    end
+
+    def mark_messages_delivered_in_conversation(website_id, session_id, data)
+      return @parent.patch(self._url_conversation(website_id, session_id, "/delivered"), data: data)
+    end
+
+    def get_conversation_routing_assign(website_id, session_id)
+      return @parent.get(self._url_conversation(website_id, session_id, "/routing"))
+    end
+
+    def assign_conversation_routing(website_id, session_id, data)
+      return @parent.patch(self._url_conversation(website_id, session_id, "/routing"), data: data)
+    end
+
+    def get_conversation_metas(website_id, session_id)
+      return @parent.get(self._url_conversation(website_id, session_id, "/meta"))
+    end
+
+    def update_conversation_metas(website_id, session_id, data)
+      return @parent.patch(self._url_conversation(website_id, session_id, "/meta"), data: data)
+    end
+
+    def list_conversation_pages(website_id, session_id, page_number)
+      return @parent.get(self._url_conversation(website_id, session_id, "/pages/%d" % page_number))
+    end
+
+    def list_conversation_events(website_id, session_id, page_number)
+      return @parent.get(self._url_conversation(website_id, session_id, "/events/%d" % page_number))
+    end
+
+    def get_conversation_state(website_id, session_id)
+      return @parent.get(self._url_conversation(website_id, session_id, "/state"))
+    end
+
+    def change_conversation_state(website_id, session_id, data)
+      return @parent.patch(self._url_conversation(website_id, session_id, "/state"), data: data)
+    end
+
+    def get_block_status_for_conversation(website_id, session_id)
+      return @parent.get(self._url_conversation(website_id, session_id, "/block"))
+    end
+
+    def block_incoming_messages_for_conversation(website_id, session_id, data)
+      return @parent.patch(self._url_conversation(website_id, session_id, "/block"), data: data)
+    end
+
+    def request_email_transcript_for_conversation(website_id, session_id, data)
+      return @parent.post(self._url_conversation(website_id, session_id, "/transcript"), data: data)
+    end
+
+    def get_people_statistics(website_id)
+      return @parent.get(self._url_website(website_id, "/people/stats"))
+    end
+
+    def list_people_segments(website_id, page_number)
+      return @parent.get(self._url_website(website_id, "/people/segments/%d" % page_number))
+    end
+
+    def list_people_profiles(website_id, page_number)
+      return @parent.get(self._url_website(website_id, "/people/profiles/%d" % page_number))
+    end
+
+    def add_new_people_profile(website_id, data)
+      return @parent.post(self._url_website(website_id, "/people/profile"))
+    end
+
+    def check_people_profile_exists(website_id, people_id)
+      return @parent.head(self._url_people("profile", website_id, people_id, ""))
+    end
+
+    def get_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)
+    end
+
+    def update_people_profile(website_id, people_id, 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, ""))
+    end
+
+    def list_people_conversations(website_id, people_id, page_number)
+      return @parent.get(self._url_people("conversations", website_id, people_id, "/list/%d" % page_number))
+    end
+
+    def add_people_event(website_id, people_id, 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)
+      return @parent.get(self._url_people("events", website_id, people_id, "/list/%d" % page_number))
+    end
+
+    def get_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)
+    end
+
+    def get_people_subscription_status(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)
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: crisp-api
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Valerian Saliou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Crisp API Ruby
+email: valerian@valeriansaliou.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- crisp-api.gemspec
+- examples/user_get_profile.rb
+- examples/website_send_message_in_conversation.rb
+- lib/crisp.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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Crisp API Ruby
+test_files: []