onlyoffice_api 0.10.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58536681a16a0e9cd5d20506a8d6549f87747914d0252cd5c6fed30165eaa022
-  data.tar.gz: 1ea712d7ee0f71a79f1a8390dd6ce31e06f1ad250ac044ada511562ccbb4b746
+  metadata.gz: c892bbb1d17d3dc5973b02ff35819d2ac24c25562128e34a511b85f2a853b765
+  data.tar.gz: 3370a41ebc3b2b591836eaf2b4cc5d49fa4f5bd05665016a07e7fad2a20d654c
 SHA512:
-  metadata.gz: 5c835194dba1d3d8edb26e3559065fcabed8698a4242ed825ecbf2119447af11f59705315e11cf03c295f8d7e2ab8449b61a18822f8a237ce8d8ef31ce90d950
-  data.tar.gz: 2ff09f5ab0e21ee974ecb7b5dedee3c929ac620686ed47bf02c6aa4fbcdd454a8c97562ffdbf9ec61f084a8f7364faba7565c599da0385fff7d1b12953c71ab2
+  metadata.gz: 27bd8ba09090aaa9220498757d732dcc37037d34fc4cb42eb14a82995dbbf93eee528535f0a8750f27ac019d3df1650827423fe18de4054e13579d16c64a31ba
+  data.tar.gz: 9ff12209da0b8d4316470f1f71653ce2d31574d2359c1d21e05ece096fd3345f4606e07373a909ac8abffaab49a4f62c2b4b92eaf2194adcb94e5966fe606099

data/lib/onlyoffice_api/onlyoffice_api_instance.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative '../teamlab/config'
+
+module Teamlab
+  # Class for multiuser instance
+  class OnlyofficeApiInstance
+    def initialize(params = {})
+      @config = Config.new(params)
+      auth_response = Teamlab::Request.new(@config, 'authentication').post('', userName: @config.username, password: @config.password).body
+      raise "Cannot get response token for #{auth_response}" if auth_response['response'].nil? || auth_response['response']['token'].nil?
+
+      @config.token = auth_response['response']['token']
+      @config.headers = { 'authorization' => @config.token }
+    end
+
+    def people
+      @people ||= Teamlab::People.new(@config)
+    end
+
+    def group
+      @group ||= Teamlab::Group.new(@config)
+    end
+
+    def settings
+      @settings ||= Teamlab::Settings.new(@config)
+    end
+
+    def files
+      @files ||= Teamlab::Files.new(@config)
+    end
+
+    def project
+      @project ||= Teamlab::Project.new(@config)
+    end
+
+    def portal
+      @portal ||= Teamlab::Portal.new(@config)
+    end
+
+    def crm
+      @crm ||= Teamlab::Crm.new(@config)
+    end
+
+    def community
+      @community ||= Teamlab::Community.new(@config)
+    end
+
+    def calendar
+      @calendar ||= Teamlab::Calendar.new(@config)
+    end
+
+    def mail
+      @mail ||= Teamlab::Mail.new(@config)
+    end
+
+    def mailserver
+      @mailserver ||= Teamlab::MailServer.new(@config)
+    end
+
+    def feed
+      @feed ||= Teamlab::Feed.new(@config)
+    end
+  end
+end

data/lib/onlyoffice_api.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'onlyoffice_api/onlyoffice_api_instance'
 require_relative 'teamlab/version'
 require_relative 'teamlab/config'
 require_relative 'teamlab/request'

data/lib/teamlab/config.rb

@@ -8,7 +8,7 @@ module Teamlab
   def self.configure(&block)
     @config ||= Config.new
     yield @config if block
-    auth_response = Teamlab::Request.new('authentication').post('', userName: @config.username, password: @config.password).body
+    auth_response = Teamlab::Request.new(nil, 'authentication').post('', userName: @config.username, password: @config.password).body
     raise "Cannot get response token for #{auth_response}" if auth_response['response'].nil? || auth_response['response']['token'].nil?
 
     @config.token = auth_response['response']['token']
@@ -24,8 +24,11 @@ module Teamlab
     # @return [Net::HTTP::Proxy] connection proxy
     attr_accessor :proxy
 
-    def initialize
+    def initialize(params = {})
       default_configuration
+      @server = params[:server]
+      @username = params[:username]
+      @password = params[:password]
     end
 
     def default_configuration

data/lib/teamlab/modules/calendar.rb

@@ -2,8 +2,8 @@
 
 module Teamlab
   class Calendar
-    def initialize
-      @request = Teamlab::Request.new('calendar')
+    def initialize(config = nil)
+      @request = Teamlab::Request.new(config, 'calendar')
     end
 
     def get_default_access

data/lib/teamlab/modules/community.rb

@@ -13,8 +13,8 @@ module Teamlab
     include CommunityForums
     include CommunityWiki
 
-    def initialize
-      @request = Teamlab::Request.new('community')
+    def initialize(config = nil)
+      @request = Teamlab::Request.new(config, 'community')
     end
   end
 end

data/lib/teamlab/modules/crm/crm_common.rb

@@ -23,7 +23,7 @@ module Teamlab
       @request.get(%w[currency rates], {})
     end
 
-    def set_currency_rate(from = 'EUR', to = 'USD', rate = '1.0')
+    def create_currency_rate(from = 'EUR', to = 'USD', rate = '1.0')
       @request.post(%w[currency rates], fromCurrency: from, toCurrency: to, rate: rate)
     end
 
@@ -31,6 +31,14 @@ module Teamlab
       @request.get(['currency', 'rates', id.to_s], {})
     end
 
+    # Get currency rate by currencies
+    # @param from_currency [String] rate from currency
+    # @param to_currency [String] rate to currency
+    # @return [Hash] currency rate data
+    def get_currency_rate_by_currency(from_currency, to_currency)
+      @request.get(['currency', 'rates', from_currency.to_s, to_currency.to_s])
+    end
+
     def delete_currency_rate_by_id(id)
       @request.delete(['currency', 'rates', id.to_s], {})
     end
@@ -38,5 +46,15 @@ module Teamlab
     def set_is_portal_configured(options = {})
       @request.put(%w[settings], options)
     end
+
+    # Update currency rate object
+    # @param id [String] id of rate currency
+    # @param from [String] rate from currency
+    # @param to [String] rate to currency
+    # @param rate [String] currency rate
+    # @return [Hash] currency and rate data
+    def update_currency_rate(id, from, to, rate)
+      @request.put(['currency', 'rates', id.to_s], fromCurrency: from, toCurrency: to, rate: rate)
+    end
   end
 end

data/lib/teamlab/modules/crm/crm_contacts.rb

@@ -139,6 +139,13 @@ module Teamlab
       @request.get(['contact', 'company', company_id.to_s, 'person'])
     end
 
+    # Returns the detailed information about the contacts Email, Phone, Web Site/Social Networks and Address information with the ID
+    # @param contact_id [String] Contact ID
+    # @return [Hash] Contact information
+    def get_contact_information(contact_id)
+      @request.get(['contact', contact_id.to_s, 'data'])
+    end
+
     def get_contact_information_by_type(contact_id, info_type)
       @request.get(['contact', contact_id.to_s, 'data', info_type.to_s])
     end
@@ -192,6 +199,13 @@ module Teamlab
       @request.put(['contact', contact_id.to_s, 'access'], options)
     end
 
+    # Returns access rights to the contact with the ID specified in the request
+    # @param contact_id [String] Contact ID
+    # @return [Array] List of contacts
+    def get_contact_access_rights(contact_id)
+      @request.get(['contact', contact_id.to_s, 'access'])
+    end
+
     def update_company(company_id, company_name, options = {})
       @request.put(['contact', 'company', company_id.to_s], { companyName: company_name.to_s }.merge(options))
     end
@@ -239,5 +253,22 @@ module Teamlab
     def remove_contact_from_project(contact_id, project_id)
       @request.delete(['contact', contact_id.to_s, 'project', project_id.to_s])
     end
+
+    # Adds the address information to the contact with the selected ID
+    # @param contact_id [String] Contact ID
+    # @param address [Hash] Contact address parameters: street, city, state, zip, country, isPrimary
+    # @return [Hash] Contact information
+    def add_address_info(contact_id, address = {})
+      @request.post(['contact', contact_id.to_s, 'addressdata'], { address: address })
+    end
+
+    # Updates the address information with the parameters specified in the request for the contact with the selected ID
+    # @param contact_id [String] Contact ID
+    # @param info_id [String] Contact information record ID
+    # @param address [Hash] Contact address parameters: street, city, state, zip, country, isPrimary
+    # @return [Hash] Contact information
+    def update_address_info(contact_id, info_id, address = {})
+      @request.put(['contact', contact_id.to_s, 'addressdata', info_id.to_s], { address: address })
+    end
   end
 end

data/lib/teamlab/modules/crm/crm_invoices.rb

@@ -117,5 +117,19 @@ module Teamlab
     def get_invoice_item_by_id(invoice_item_id)
       @request.get(['invoiceitem', invoice_item_id])
     end
+
+    # Returns the existence of an invoice with the number specified in the request
+    # @param number [String] Invoice number
+    # @return [Boolean] Invoice existence
+    def check_invoice_existence_by_number(number)
+      @request.get(%w[invoice bynumber exist], number: number)
+    end
+
+    # Returns the detailed information about an invoice with the number specified in the request
+    # @param number [String] Invoice number
+    # @return [Hash] Invoice data
+    def get_invoice_by_number(number)
+      @request.get(%w[invoice bynumber], number: number)
+    end
   end
 end

data/lib/teamlab/modules/crm/crm_opportunities.rb

@@ -23,6 +23,13 @@ module Teamlab
       @request.get(['opportunity', opportunity_id.to_s, 'contact'])
     end
 
+    # Returns a list of all the opportunities for the contact with the ID specified in the request
+    # @param contact_id [String, Integer] Contact ID
+    # @return [Array] List of opportunities
+    def get_contact_opportunities(contact_id)
+      @request.get(['opportunity', 'bycontact', contact_id.to_s])
+    end
+
     def create_opportunity(stage_id, title, responsible_id, options = {})
       options[:bidCurrencyAbbr] ||= 'USD'
       @request.post(%w[opportunity], { stageId: stage_id, title: title, responsibleid: responsible_id }.merge(options))

data/lib/teamlab/modules/crm/crm_tags.rb

@@ -50,5 +50,14 @@ module Teamlab
     def add_contact_tag_to_group(entity_type, entity_id, tag)
       @request.post([entity_type.to_s, entity_id.to_s, 'tag', 'group'], tagName: tag)
     end
+
+    # Deletes the selected tag from the entity (company or person) specified in the request and from all the related contacts
+    # @param entity_type [String, Symbol] Entity type
+    # @param entity_id [String] Entity ID
+    # @param tag [String] Tag name
+    # @return [String] Tag name
+    def delete_contact_tag_of_group(entity_type, entity_id, tag)
+      @request.delete([entity_type.to_s, entity_id, 'tag', 'group'], tagName: tag)
+    end
   end
 end

data/lib/teamlab/modules/crm.rb

@@ -25,8 +25,8 @@ module Teamlab
     include CrmTasks
     include CrmUserFields
 
-    def initialize
-      @request = Teamlab::Request.new('crm')
+    def initialize(config = nil)
+      @request = Teamlab::Request.new(config, 'crm')
     end
   end
 end

data/lib/teamlab/modules/feed.rb

@@ -2,8 +2,8 @@
 
 module Teamlab
   class Feed
-    def initialize
-      @request = Teamlab::Request.new('feed')
+    def initialize(config = nil)
+      @request = Teamlab::Request.new(config, 'feed')
     end
 
     # TODO: find out how it should work api.onlyoffice.com missing documentation

data/lib/teamlab/modules/files.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require 'cgi'
+
 module Teamlab
   class Files
-    def initialize
-      @request = Teamlab::Request.new('files')
+    def initialize(config = nil)
+      @request = Teamlab::Request.new(config, 'files')
     end
 
     # region File Creation
@@ -25,15 +27,15 @@ module Teamlab
     end
 
     def create_txt(folder_id, title, content)
-      @request.post([folder_id.to_s, 'text'], title: title.to_s, content: content.to_s)
+      @request.post([escape_folder_id(folder_id), 'text'], title: title.to_s, content: content.to_s)
     end
 
     def create_html(folder_id, title, content)
-      @request.post([folder_id.to_s, 'html'], title: title.to_s, content: content.to_s)
+      @request.post([escape_folder_id(folder_id), 'html'], title: title.to_s, content: content.to_s)
     end
 
     def create_file(folder_id, title)
-      @request.post([folder_id.to_s, 'file'], title: title.to_s)
+      @request.post([escape_folder_id(folder_id), 'file'], title: title.to_s)
     end
 
     # endregion
@@ -52,13 +54,13 @@ module Teamlab
       @request.get(['file', fileid.to_s, 'checkconversion'])
     end
 
-    def move_to_folder(dest_folder_id, options = {})
-      @request.put(%w[fileops move], { destFolderId: dest_folder_id }.merge(options))
+    def move_to_folder(folder_id, options = {})
+      @request.put(%w[fileops move], { destFolderId: escape_folder_id(folder_id) }.merge(options))
     end
     alias move_files move_to_folder
 
-    def copy_to_folder(dest_folder_id, options = {})
-      @request.put(%w[fileops copy], { destFolderId: dest_folder_id }.merge(options))
+    def copy_to_folder(folder_id, options = {})
+      @request.put(%w[fileops copy], { destFolderId: escape_folder_id(folder_id) }.merge(options))
     end
 
     def delete(options = {})
@@ -135,27 +137,27 @@ module Teamlab
     end
 
     def get_folder(folder_id, options = {})
-      @request.get([folder_id.to_s], options)
+      @request.get([escape_folder_id(folder_id)], options)
     end
 
     def get_folder_info(folder_id)
-      @request.get(['folder', folder_id.to_s])
+      @request.get(['folder', escape_folder_id(folder_id)])
     end
 
     def get_folder_path(folder_id)
-      @request.get(['folder', folder_id.to_s, 'path'])
+      @request.get(['folder', escape_folder_id(folder_id), 'path'])
     end
 
     def new_folder(folder_id, title)
-      @request.post(['folder', folder_id.to_s], title: title)
+      @request.post(['folder', escape_folder_id(folder_id)], title: title)
     end
 
     def rename_folder(folder_id, title)
-      @request.put(['folder', folder_id.to_s], title: title)
+      @request.put(['folder', escape_folder_id(folder_id)], title: title)
     end
 
     def delete_folder(folder_id)
-      @request.delete(['folder', folder_id.to_s])
+      @request.delete(['folder', escape_folder_id(folder_id)])
     end
 
     # endregion
@@ -167,7 +169,7 @@ module Teamlab
     end
 
     def get_folder_sharing(folder_id)
-      @request.get(['folder', folder_id.to_s, 'share'])
+      @request.get(['folder', escape_folder_id(folder_id), 'share'])
     end
 
     def share_file(file_id, user_id, access_type, options = {})
@@ -175,7 +177,7 @@ module Teamlab
     end
 
     def share_folder(folder_id, user_id, access_type, options = {})
-      @request.put(['folder', folder_id.to_s, 'share'], { share: { shareTo: user_id, Access: access_type } }.merge(options))
+      @request.put(['folder', escape_folder_id(folder_id), 'share'], { share: { shareTo: user_id, Access: access_type } }.merge(options))
     end
 
     def removes_sharing_rights(options = {})
@@ -224,15 +226,15 @@ module Teamlab
     end
 
     def upload_to_folder(folder_id, file)
-      @request.post([folder_id.to_s, 'upload'], somefile: File.new(file))
+      @request.post([escape_folder_id(folder_id), 'upload'], somefile: File.new(file))
     end
 
     def insert_file(folder_id, file, title: File.basename(file), keep_convert_status: false)
-      @request.post([folder_id.to_s, 'insert'], file: File.new(file), title: title, keepConvertStatus: keep_convert_status)
+      @request.post([escape_folder_id(folder_id), 'insert'], file: File.new(file), title: title, keepConvertStatus: keep_convert_status)
     end
 
     def chunked_upload(folder_id, filename, file_size)
-      @request.post([folder_id.to_s, 'upload', 'create_session'], fileName: filename, fileSize: file_size)
+      @request.post([escape_folder_id(folder_id), 'upload', 'create_session'], fileName: filename, fileSize: file_size)
     end
 
     # endregion
@@ -252,5 +254,17 @@ module Teamlab
     def check_overwrite(set_value = true)
       @request.put(%w[updateifexist], set: set_value)
     end
+
+    # Sometimes folder id require escaping
+    # Because for example for folders from connected account will have id like this:
+    # ```
+    # sbox-193828-|New_Folder__474b010d-ad5f-49ff-8b3a-5b2583c1fbcc
+    # ```
+    # And this need escaping
+    # @param [Integer, String] id to escape
+    # @return [String] result after escape
+    def escape_folder_id(id)
+      CGI.escape(id.to_s)
+    end
   end
 end

data/lib/teamlab/modules/group.rb

@@ -6,8 +6,8 @@ module Teamlab
   class Group
     include GroupHelper
 
-    def initialize
-      @request = Teamlab::Request.new('group')
+    def initialize(config = nil)
+      @request = Teamlab::Request.new(config, 'group')
     end
 
     def get_groups

data/lib/teamlab/modules/mail.rb

@@ -25,8 +25,8 @@ module Teamlab
     include MailSettings
     include MailTags
 
-    def initialize
-      @request = Teamlab::Request.new('mail')
+    def initialize(config = nil)
+      @request = Teamlab::Request.new(config, 'mail')
     end
 
     # @return [Teamlab::Response] Returns all Mail running operations (only complex)

data/lib/teamlab/modules/mailserver.rb

@@ -11,8 +11,8 @@ module Teamlab
     include MailserverDomains
     include MailserverMailboxes
 
-    def initialize
-      @request = Teamlab::Request.new('mailserver')
+    def initialize(config = nil)
+      @request = Teamlab::Request.new(config, 'mailserver')
     end
   end
 end

data/lib/teamlab/modules/people/people_reassign.rb

@@ -7,18 +7,21 @@ module Teamlab
     # @param from_user_id [String] guid of user from whom reassign
     # @param to_user_id [String] guid of user to whom reassign
     # @param delete_profile [True, False] Delete profile when reassignment will be finished
+    # @return [Hash] reassign progress data
     def start_reassign_user_data(from_user_id, to_user_id, delete_profile = true)
       @request.post(%w[reassign start], fromUserId: from_user_id, toUserId: to_user_id, deleteProfile: delete_profile)
     end
 
     # Returns the progress of the started reassign process
     # @param from_user_id [String] User ID (guid) whose data is reassigned
-    def get_reassign_progress(from_user_id)
+    # @return [Hash] reassign progress data
+    def reassign_progress(from_user_id)
       @request.get(%w[reassign progress], userId: from_user_id)
     end
 
     # Terminate reassign process
     # @param user_id [String] User ID (guid) whose data is reassigned
+    # @return [Void]
     def terminate_reassign(user_id)
       @request.put(%w[reassign terminate], userId: user_id)
     end

data/lib/teamlab/modules/people/people_remove.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Teamlab
+  # Module for people removing process
+  module PeopleRemove
+    # Start a remove process
+    # @param userId [String] guid of user to remove
+    # @return [Hash] remove progress data
+    def start_remove(user_id)
+      @request.post(%w[remove start], userId: user_id)
+    end
+
+    # Returns the progress of the started remove process
+    # @param userId [String] guid of user to remove
+    # @return [Hash] remove progress data
+    def remove_progress(user_id)
+      @request.get(%w[remove progress], userId: user_id)
+    end
+
+    # Terminate remove process
+    # @param userId [String] guid of user to remove
+    # @return [Void]
+    def terminate_remove(user_id)
+      @request.put(%w[remove terminate], userId: user_id)
+    end
+  end
+end

data/lib/teamlab/modules/people.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require_relative 'people/people_reassign'
+require_relative 'people/people_remove'
 module Teamlab
   class People
     include PeopleReassign
+    include PeopleRemove
 
-    def initialize
-      @request = Teamlab::Request.new('people')
+    def initialize(config = nil)
+      @request = Teamlab::Request.new(config, 'people')
     end
 
     def get_people
@@ -45,10 +47,6 @@ module Teamlab
       @request.post(nil, { isVisitor: is_visitor, email: email, firstname: firstname, lastname: lastname }.merge(options))
     end
 
-    def active(options = {})
-      @request.post(['active'], options) # TODO: need some fixing
-    end
-
     def update_contacts(user_id, contacts = {})
       @request.post([user_id, 'contacts'], contacts)
     end
@@ -100,5 +98,31 @@ module Teamlab
     def unlink_account(provider)
       @request.delete([%w[thirdparty unlinkaccount]], provider: provider)
     end
+
+    # Return the detailed information about the profile of the user with the email specified in the request
+    # @param email [String] User email
+    # @return [Hash] result user search by email
+    def get_user_by_email(email)
+      @request.get(['email'], email: email)
+    end
+
+    # Get user photos
+    # @param userid [String] User ID
+    # @return [Hash] result user photos
+    def get_user_photoes(user_id)
+      @request.get([user_id, 'photo'])
+    end
+
+    # Send instructions for delete user own profile
+    # @return [Void] send `Deletion of your profile` letter
+    def send_delete_instruction
+      @request.put(%w[self delete])
+    end
+
+    # Join to affiliate programme
+    # @return [String] link to affiliate programme
+    def join_to_affiliate_programme
+      @request.put(%w[self joinaffiliate])
+    end
   end
 end

data/lib/teamlab/modules/portals.rb

@@ -2,8 +2,8 @@
 
 module Teamlab
   class Portal
-    def initialize
-      @request = Teamlab::Request.new('portal')
+    def initialize(config = nil)
+      @request = Teamlab::Request.new(config, 'portal')
     end
 
     def invite_user_url
@@ -13,5 +13,11 @@ module Teamlab
     def invite_visitor_url
       @request.get(%w[users invite visitor])
     end
+
+    # Deletes the current portal immediately
+    # WARNING: Do not test this method in specs in this project
+    def delete_portal
+      @request.delete(%w[deleteportalimmediately])
+    end
   end
 end

data/lib/teamlab/modules/project.rb

@@ -30,8 +30,8 @@ module Teamlab
     include ProjectsTemplates
     include ProjectsTime
 
-    def initialize
-      @request = Teamlab::Request.new('project')
+    def initialize(config = nil)
+      @request = Teamlab::Request.new(config, 'project')
     end
   end
 end

data/lib/teamlab/modules/projects/projects_comments.rb

@@ -30,5 +30,21 @@ module Teamlab
     def delete_comment(comment_id)
       @request.delete(['comment', comment_id.to_s])
     end
+
+    # Adds a project comment with the parameters specified in the request
+    # @param entity_id [String] Entity ID
+    # @param content [String] Comment text
+    # @param type [String, Symbol] Comment type (message or task)
+    # @return [Hash] Comment information
+    def add_project_comment(entity_id, content, type, options = {})
+      @request.post(%w[comment], { entityid: entity_id, content: content, type: type.to_s }.merge(options))
+    end
+
+    # Get a preview of a project comment with the ID specified in the request
+    # @param htmltext [String] Comment text in the HTML format
+    # @return [Hash] Comment information
+    def get_a_comment_preview(htmltext, options = {})
+      @request.post(%w[comment preview], { htmltext: htmltext }.merge(options))
+    end
   end
 end

data/lib/teamlab/modules/projects/projects_discussions.rb

@@ -39,8 +39,22 @@ module Teamlab
       @request.put(['message', message_id.to_s, 'subscribe'])
     end
 
+    # Returns a list of all the subscribers of the discussion with the selected message
+    # @param message_id [Integer, String] Message ID
+    # @return [Array] List of subscibers
+    def discussion_subscribers(message_id)
+      @request.get(['message', message_id.to_s, 'subscribes'])
+    end
+
     def delete_message(message_id)
       @request.delete(['message', message_id.to_s])
     end
+
+    # Returns a preview of the discussion message
+    # @param [String] Message text in the HTML format
+    # @return [Hash] Message preview
+    def preview_of_discussion_message(htmltext)
+      @request.post(%w[message discussion preview], htmltext: htmltext)
+    end
   end
 end

data/lib/teamlab/modules/projects/projects_milestones.rb

@@ -31,6 +31,36 @@ module Teamlab
       @request.get(['milestone', year.to_s, month.to_s, day.to_s])
     end
 
+    # Returns a list of all the milestones within a project with the ID specified in the request
+    # @param project_id [Symbol, String] Project ID
+    # @return [Array] List of milestones
+    def milestones_by_project_id(project_id)
+      @request.get([project_id.to_s, 'milestone'])
+    end
+
+    # Returns a list of all the milestones within a project with the ID and status specified in the request
+    # @param project_id [Symbol, String] Project ID
+    # @param status [Symbol, String] Milestone status
+    # @return [Array] List of milestones
+    def milestones_by_project_id_and_status(project_id, status)
+      @request.get([project_id.to_s, 'milestone', status.to_s])
+    end
+
+    # Adds a new milestone using the parameters (project ID, milestone title, deadline, etc) specified in the request
+    # @param project_id [Symbol, String] Project ID
+    # @param title [String] Milestone title
+    # @param deadline [String] Milestone deadline
+    # @param responsible_id [String] Milestone responsible
+    # @param options [Hash] options to create a Milestone with
+    # @option isKey [Boolean] Specifies if this is a key milestone or not
+    # @option isNotify [Boolean] Reminds me 48 hours before the milestone due date
+    # @option description [String] Milestone description
+    # @option notifyResponsible [Boolean] Notifies the responsible about the milestone actions or not
+    # @return [Hash] Added milestone
+    def add_milestone(project_id, title, deadline, responsible_id, options = {})
+      @request.post([project_id.to_s, 'milestone'], { title: title, deadline: deadline, responsible: responsible_id }.merge(options))
+    end
+
     def update_milestone(id, title, deadline, options = {})
       @request.put(['milestone', id.to_s], { title: title, deadline: deadline }.merge(options))
     end
@@ -42,5 +72,12 @@ module Teamlab
     def delete_milestone(id)
       @request.delete(['milestone', id.to_s])
     end
+
+    # Deletes the milestones with the IDs specified in the request
+    # @param ids [Array] Milestone IDs
+    # @return [Array] Deleted milestones
+    def delete_milestones(ids)
+      @request.delete(['milestone'], { ids: ids })
+    end
   end
 end

data/lib/teamlab/modules/projects/projects_projects.rb

@@ -35,10 +35,6 @@ module Teamlab
       @request.get([project_id.to_s, 'files'])
     end
 
-    def get_milestones(project_id)
-      @request.get([project_id.to_s, 'milestone'])
-    end
-
     def search_all_projects(query)
       @request.get(['@search', query.to_s])
     end
@@ -47,18 +43,10 @@ module Teamlab
       @request.get([project_id.to_s, '@search', query.to_s])
     end
 
-    def get_milestones_with_status(project_id, status)
-      @request.get([project_id.to_s, 'milestone', status.to_s])
-    end
-
     def create_project(title, description, responsible_id, tags, private, options = {})
       @request.post('', { title: title, description: description, responsibleid: responsible_id, tags: tags, private: private }.merge(options))
     end
 
-    def add_milestone(project_id, title, deadline, responsible_id, options = {})
-      @request.post([project_id.to_s, 'milestone'], { title: title, deadline: deadline, responsible: responsible_id }.merge(options))
-    end
-
     def update_project(id, title, responsible_id, options = {})
       @request.put([id.to_s], { title: title, responsibleId: responsible_id }.merge(options))
     end
@@ -78,5 +66,12 @@ module Teamlab
     def delete_project(id)
       @request.delete([id.to_s])
     end
+
+    # Deletes the projects with the IDs specified in the request from the portal
+    # @param ids [Array] List of project IDs
+    # @return [Array] Deleted projects
+    def delete_projects(ids)
+      @request.delete('', { projectids: ids })
+    end
   end
 end

data/lib/teamlab/modules/projects/projects_reports.rb

@@ -11,6 +11,13 @@ module Teamlab
       @request.put(['report', report_id.to_s], { name: name }.merge(options))
     end
 
+    # Returns a project report template with the ID specified in the request
+    # @param report_id [Symbol, String] Report template ID
+    # @return [Hash] Project report template
+    def report_template(report_id)
+      @request.get(['report', report_id.to_s])
+    end
+
     def delete_report_template(report_id)
       @request.delete(['report', report_id.to_s])
     end

data/lib/teamlab/modules/projects/projects_settings.rb

@@ -7,5 +7,16 @@ module Teamlab
     def projects_settings
       @request.get(%w[settings])
     end
+
+    # Updates the project settings with the parameters specified in the request
+    # @param options [Hash] options to change Projects module settings
+    # @option everebodyCanCreate [Boolean] Specifies if all the portal users can create projects or not
+    # @option hideEntitiesInPausedProjects [Boolean] Specifies if the entities will be hidden in the paused projects or not
+    # @option startModule [String] Module type: Projects, Tasks, Discussions, TimeTracking
+    # @option folderId [String] Folder ID
+    # @return [Hash] Updated settings
+    def update_projects_settings(options = {})
+      @request.put(%w[settings], options)
+    end
   end
 end

data/lib/teamlab/modules/settings.rb

@@ -5,8 +5,8 @@ module Teamlab
     # @return [String] id of global admin of portal
     GLOBAL_ADMIN_ID = '00000000-0000-0000-0000-000000000000'
 
-    def initialize
-      @request = Teamlab::Request.new('settings')
+    def initialize(config = nil)
+      @request = Teamlab::Request.new(config, 'settings')
     end
 
     def get_settings

data/lib/teamlab/request.rb

@@ -9,7 +9,8 @@ module Teamlab
   class Request
     include HTTParty
 
-    def initialize(api_additive)
+    def initialize(config, api_additive)
+      @config = config
       @api_additive = api_additive.to_s
     end
 
@@ -49,8 +50,24 @@ module Teamlab
       response
     end
 
+    def server
+      @config&.server || Teamlab.config.server
+    end
+
+    def api_path
+      @config&.api_path || Teamlab.config.api_path
+    end
+
+    def headers
+      @config&.headers || Teamlab.config.headers
+    end
+
+    def proxy
+      @config&.proxy || Teamlab.config.proxy
+    end
+
     def generate_request_url(command)
-      Teamlab.config.server + Teamlab.config.api_path + @api_additive + command
+      server + api_path + @api_additive + command
     end
 
     def parse_args(args, type)
@@ -58,7 +75,7 @@ module Teamlab
       opts = {}
       opts[:body] = args.last.instance_of?(Hash) ? args.pop : {}
       opts[:body].delete_if { |_key, value| value == [] }
-      opts[:headers] = Teamlab.config.headers
+      opts[:headers] = headers
       opts = init_proxy(opts)
       opts[:query] = opts.delete(:body) if type == :get
       [command, opts]
@@ -67,12 +84,12 @@ module Teamlab
     # @param opts [Hash] options to init
     # @return [Hash] options
     def init_proxy(opts)
-      return opts unless Teamlab.config.proxy
+      return opts unless proxy
 
-      opts[:http_proxyaddr] ||= Teamlab.config.proxy.proxy_address
-      opts[:http_proxyport] ||= Teamlab.config.proxy.proxy_port
-      opts[:http_proxyuser] ||= Teamlab.config.proxy.proxy_user
-      opts[:http_proxypass] ||= Teamlab.config.proxy.proxy_pass
+      opts[:http_proxyaddr] ||= proxy.proxy_address
+      opts[:http_proxyport] ||= proxy.proxy_port
+      opts[:http_proxyuser] ||= proxy.proxy_user
+      opts[:http_proxypass] ||= proxy.proxy_pass
       opts
     end
   end

data/lib/teamlab/responce/custom_exceptions.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Teamlab
+  # Exception if in response no JSON body
+  class NoJsonInResponce < StandardError; end
+end

data/lib/teamlab/response.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'responce/custom_exceptions'
+
 module Teamlab
   class Response
     attr_reader :body, :error, :code, :success
@@ -9,7 +11,7 @@ module Teamlab
       @success = @code < 400
       err_msg = generate_err_msg(http_response) if @code >= 400
       if @success
-        @body = http_response.to_hash
+        handle_success_responce(http_response)
       else
         raise TimeoutError, 'Portal is warming up' if http_response.parsed_response.include?('portal is being warmed')
         raise "Error #{@code}\n#{err_msg}" if @code >= 400
@@ -21,10 +23,10 @@ module Teamlab
 
     def generate_err_msg(http_response)
       "API request failed\n\noriginal request:\n"\
-      "#{http_response.request.http_method} #{http_response.request.path}\nbody: "\
-      "#{JSON.pretty_generate(http_response.request.options[:body])}"\
-      "\n\nresponse:\n"\
-      "#{prettify_response(http_response.parsed_response)}"
+        "#{http_response.request.http_method} #{http_response.request.path}\nbody: "\
+        "#{JSON.pretty_generate(http_response.request.options[:body])}"\
+        "\n\nresponse:\n"\
+        "#{prettify_response(http_response.parsed_response)}"
     end
 
     def prettify_response(msg)
@@ -37,5 +39,54 @@ module Teamlab
     def data
       @body['response']
     end
+
+    # Check if responce is succeed, has nil error and has hash body
+    # @param [Symbol] current api method
+    # @return [Boolean] result of responce check
+    def correct?(command)
+      result = @success && @error.nil? && @body.is_a?(Hash)
+      raise("Response should be always successful for #{command}") unless @success
+      raise("Response should not contain errors for #{command}") unless @error.nil?
+      raise("Response should be Hash for #{command}") unless @body.is_a?(Hash)
+
+      result
+    end
+
+    private
+
+    # Sometime in strange situation, like maybe nginx errors
+    # API requests return not JSON, but html or other data
+    # @param [Teamlab::Responce] responce to check
+    # @return [Nil] is body responce correct and raise exception in any other situation
+    def check_responce_body(responce)
+      return if stream_data_request?(responce)
+
+      JSON.parse(responce.body)
+    rescue JSON::ParserError => e
+      request_info = "#{responce.request.http_method} #{responce.request.uri}"
+      raise NoJsonInResponce, "Request `#{request_info}` responce body is not a json\n "\
+                              "Parsing error: \n#{e}\n"
+    end
+
+    # Handle success responce
+    # @param [Teamlab::Responce] responce to handle
+    # @return [nil] if everything is fine or exception
+    def handle_success_responce(responce)
+      check_responce_body(responce)
+      @body = responce.to_hash
+    end
+
+    # Check if request for stream data
+    # Those request has no body, but data stream in responce
+    # @param [Teamlab::Responce] responce to check
+    # @return [Boolean] result of check
+    def stream_data_request?(responce)
+      calendar_ical_request_regexp = %r{.*/calendar/\d*/ical/\S*}
+      uri = responce.request.uri.to_s
+
+      return true if calendar_ical_request_regexp.match?(uri)
+
+      false
+    end
   end
 end

data/lib/teamlab/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Teamlab
-  VERSION = '0.10.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_api
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.1
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -27,20 +27,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
-- !ruby/object:Gem::Dependency
-  name: codecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +83,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +153,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +191,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/onlyoffice_api.rb
+- lib/onlyoffice_api/onlyoffice_api_instance.rb
 - lib/teamlab/config.rb
 - lib/teamlab/modules/calendar.rb
 - lib/teamlab/modules/community.rb
@@ -218,6 +233,7 @@ files:
 - lib/teamlab/modules/mailserver/mailboxes.rb
 - lib/teamlab/modules/people.rb
 - lib/teamlab/modules/people/people_reassign.rb
+- lib/teamlab/modules/people/people_remove.rb
 - lib/teamlab/modules/portals.rb
 - lib/teamlab/modules/project.rb
 - lib/teamlab/modules/projects/projects_comments.rb
@@ -236,6 +252,7 @@ files:
 - lib/teamlab/modules/settings.rb
 - lib/teamlab/name.rb
 - lib/teamlab/request.rb
+- lib/teamlab/responce/custom_exceptions.rb
 - lib/teamlab/response.rb
 - lib/teamlab/version.rb
 homepage: https://github.com/ONLYOFFICE/onlyoffice_api_gem
@@ -247,6 +264,7 @@ metadata:
   documentation_uri: https://www.rubydoc.info/gems/onlyoffice_api
   homepage_uri: https://github.com/ONLYOFFICE/onlyoffice_api_gem
   source_code_uri: https://github.com/ONLYOFFICE/onlyoffice_api_gem
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -262,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Ruby gem for OnlyOffice. Formerly known as `teamlab`.