crisp_client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed7a3eb065cee30e1639308b0918f14434fafc4b
-  data.tar.gz: 25ba674f8e1184293320313c3f86b309f8241cac
+  metadata.gz: 83dadcd8697550aa3810162d39053d3c0762c726
+  data.tar.gz: fcb2eb0fc094f017102d0edf9afd3cb0acc88eba
 SHA512:
-  metadata.gz: bd0c8e590b9f14fc160dc115e0356c5b64cf2b9a8ab5bbde6f9dfc380f59e3f0b88b1446429fd0663deddb7323b9cb27417d2d78372b06ea664159320cb2b6f8
-  data.tar.gz: f9be35a161b1d313efec22adef35bd7c38b92043766f4dbe21e13da8312ad76d6690442d9fd0f93dc73a443cec554fe794971eff7cffc033c6f269fe7fb620ef
+  metadata.gz: 976158d977afa073bbff555c5ae49c013ce5f291950fb283bc6517ded160892bdcb256c778b05b16e4409effb77e23ff41cce0980f0a6888954dcead4e8c10a4
+  data.tar.gz: c4f66ceb6cab3babe2578ccca3b5c2d26e99e5c6c51432bbf1d215273764ad8ef4e09303b5d93c01e0a127bac82d5b0f6822d5aebd8537175ca399068a40adde

data/README.md

@@ -1,8 +1,29 @@
 # CrispClient
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/crisp_client`. To experiment with that code, run `bin/console` for an interactive prompt.
+:small_red_triangle_down: Ruby Client for Crisp API
 
-TODO: Delete this and the text above, and describe your gem
+## Usage
+
+```ruby
+cc = CrispClient::Base.new(email: ENV['CRISP_EMAIL'], password: ENV['CRISP_PASSWORD']).authenticate
+#=> {"Authorization"=>"Basic MmjjiyAjSLuMmjjiyAjSLuMmjjiyAjSLuMmjjiyAjSLuMmjjiyAiaiIyMGUyYTdjYzA="}
+
+website_id = cc.find_website_id_by_name(website_name: "Touts")
+#=> "8sajk18272-4aab-kjhh-bkjh-8e3chjk5609"
+
+cc.get_people_statistics(website_id: website_id)
+#=> {"total"=>3523}
+
+person_id = cc.add_new_people_profile(website_id: website_id, nickname: "Flavio Wuensche", email: "flavio@touts.com.br")
+#=> "cd71e876-62e4-17hs-b6c2-570f44b3d83b"
+cc.add_new_people_profile(website_id: website_id, nickname: "Flavio Wuensche", email: "flavio@touts.com.br")
+#   RuntimeError: people_exists
+
+cc.remove_people_profile(website_id: website_id, people_id: person_id)
+#=> "deleted"
+cc.remove_people_profile(website_id: website_id, people_id: person_id)
+#=> "people_not_found"
+```
 
 ## Installation
 
@@ -20,10 +41,6 @@ Or install it yourself as:
 
     $ gem install crisp_client
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -34,8 +51,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/crisp_client.
 
+While debugging you might need to reload edited files:
+
+```ruby
+load '/Users/fwuensche/www/crisp_client/lib/crisp_client/website_people.rb'
+```
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/crisp_client.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Flavio Wuensche"]
   spec.email         = ["f.wuensche@gmail.com"]
 
-  spec.summary       = %q{Crisp API Ruby Wrapper}
+  spec.summary       = %q{Ruby Client for Crisp API}
   spec.description   = %q{Use ruby syntax to manipulate your Crisp data}
   spec.homepage      = "https://github.com/fwuensche/crisp_client"
   spec.license       = "MIT"

data/lib/crisp_client/list_websites.rb

@@ -1,17 +1,11 @@
 module ListWebsites
+  # https://docs.crisp.im/api/v1/#user-user-account-websites-get
   def list_websites
     client_get("/user/account/websites")["data"]
   end
 
-  # def list_websites_ids
-  #   list_websites.map{ |website| website["id"] }
-  # end
-  #
-  # def find_website_by_name name
-  #   list_websites.select{ |website| website["name"] == name }.first
-  # end
-
-  def find_website_id_by_name name
-    list_websites.select{ |website| website["name"] == name }.first["id"]
+  # custom method
+  def find_website_id_by_name(website_name:)
+    list_websites.select{ |website| website["name"] == website_name }.first["id"]
   end
 end

data/lib/crisp_client/user_availability.rb

@@ -1,4 +1,5 @@
 module UserAvailability
+  # https://docs.crisp.im/api/v1/#user-user-availability-get
   def get_user_availability
     client_get("/user/availability")["data"]["type"]
   end

data/lib/crisp_client/version.rb

@@ -1,3 +1,3 @@
 module CrispClient
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/crisp_client/website_people.rb

@@ -1,9 +1,32 @@
 module WebsitePeople
-  def get_people_statistics(website_id)
+  # https://docs.crisp.im/api/v1/#website-website-people-get
+  def get_people_statistics(website_id:)
     client_get("/website/#{website_id}/people/stats")["data"]
   end
 
-  def list_people_profiles(website_id, page_number = 1)
-    client_get("/website/#{website_id}/people/profiles/#{page_number}")["data"]
+  # 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"]
+  end
+
+  # https://docs.crisp.im/api/v1/#website-website-people-post
+  def add_new_people_profile(website_id:, nickname:, email:)
+    response = self.class.post("/website/#{website_id}/people/profile",
+      body: { email: email, person: { nickname: nickname } }.to_json,
+      headers: { 'Content-Type' => 'application/json' }.merge(@auth))
+
+    if response["error"] == false
+      return response["data"]["people_id"]
+    else
+      raise response["reason"]
+    end
+  end
+
+  # https://docs.crisp.im/api/v1/#website-website-people-delete
+  def remove_people_profile(website_id:, people_id:)
+    response = self.class.delete("/website/#{website_id}/people/profile/#{people_id}",
+      headers: { 'Content-Type' => 'application/json' }.merge(@auth))
+    return response["reason"]
   end
 end

data/lib/crisp_client.rb

@@ -3,7 +3,6 @@ require "crisp_client/user_availability"
 require "crisp_client/list_websites"
 require "crisp_client/website_people"
 require "httparty"
-# require "byebug"
 
 module CrispClient
   class Base
@@ -14,7 +13,7 @@ module CrispClient
 
     base_uri "https://api.crisp.im/v1"
 
-    def initialize(email, password)
+    def initialize(email:, password:)
       @email = email
       @password = password
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crisp_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Flavio Wuensche
@@ -95,5 +95,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Crisp API Ruby Wrapper
+summary: Ruby Client for Crisp API
 test_files: []