onlyoffice_api 0.12.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdbcfc630b8186f0ce844c741c43a3a80873823d5cd826a4499490c1b07600df
-  data.tar.gz: 51be328e7d6d9a061baf729481d22b498fd84502d4f74d5e898c6820e9cd9516
+  metadata.gz: 9f8c8455b783aef58695e2f11ac059804435a6be117b76b453cdebd0a996e41a
+  data.tar.gz: 46cf0de4e5b2a8a8ad1215c7f86f50d182b5b4bcc1f364054c50015a0b522123
 SHA512:
-  metadata.gz: beddc9c36885235acef44a1b2d2306c18c7d57dd91e94a267d219937e3deadcce2462292409f62dab2a220a5c86629651b997eb30fb996d8766b6c406ec5d960
-  data.tar.gz: 944ac964b667783207b6e95541456f1168c2f216f6041e8e97202c4ea99bcde87fa86345878f6b1a654fd4024bbda735900c9f9064b0cc5dcf0e2e1f1505a6e2
+  metadata.gz: d88170f761bb8384014573a865dc1e5d2614054bf8e7f4e032f36b043160763ad2d6226cf4151cd145a7b8cfc42a1313fd6a7670e8fa532298cad3c49c32ac00
+  data.tar.gz: ffa186f53c8b0077ca1af6e04495c6a83992a02f02cc861a8a6f26335fc4f022f2a1ecc3a9555a2a5a0ea5537dd6fd710dbeebfa96d92ebf3e3e1281f0a5f6c9

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/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,9 +1,11 @@
 # frozen_string_literal: true
 
 require_relative 'people/people_reassign'
+require_relative 'people/people_remove'
 module Teamlab
   class People
     include PeopleReassign
+    include PeopleRemove
 
     def initialize(config = nil)
       @request = Teamlab::Request.new(config, '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

@@ -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/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/response.rb

@@ -40,6 +40,18 @@ module Teamlab
       @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

data/lib/teamlab/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_api
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.0.0
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2022-02-04 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
@@ -219,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
@@ -249,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:
@@ -264,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.21
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: Ruby gem for OnlyOffice. Formerly known as `teamlab`.