onlyoffice_api 0.7

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Teamlab
+  # Module for projects time methods
+  module ProjectsTime
+    def get_time_spent_by_filter(options = {})
+      @request.get(%w[time filter], options)
+    end
+
+    def get_total_time_spent_by_filter(options = {})
+      @request.get(%w[time filter total], options)
+    end
+
+    def get_time_spent(task_id)
+      @request.get(['task', task_id.to_s, 'time'])
+    end
+
+    def add_task_time(task_id, date, person_id, project_id, options = {})
+      @request.post(['task', task_id.to_s, 'time'], { date: date, personId: person_id, projectId: project_id }.merge(options))
+    end
+
+    def update_task_time(time_id, date, person_id, options = {})
+      @request.put(['time', time_id.to_s], { date: date, personId: person_id }.merge(options))
+    end
+
+    def update_time_status_of_payment(time_ids, status)
+      @request.put(%w[time times status], timeids: time_ids, status: status)
+    end
+
+    def delete_time_spents(*time_ids)
+      @request.delete(%w[time times remove], timeIds: time_ids.flatten)
+    end
+  end
+end

data/lib/teamlab/modules/settings.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Teamlab
+  class Settings
+    # @return [String] id of global admin of portal
+    GLOBAL_ADMIN_ID = '00000000-0000-0000-0000-000000000000'
+
+    def initialize
+      @request = Teamlab::Request.new('settings')
+    end
+
+    def get_settings
+      @request.get
+    end
+
+    def get_sso_settings
+      @request.get(%w[ssov2])
+    end
+
+    def get_ldap_settings
+      @request.get(%w[LDAP])
+    end
+
+    def get_logo
+      @request.get(%w[logo])
+    end
+
+    def get_usage_quota
+      @request.get(%w[quota])
+    end
+
+    def get_version
+      @request.get(%w[version])
+    end
+
+    def get_version_build
+      @request.get(%w[version build])
+    end
+
+    def get_security(ids = [])
+      @request.get(%w[security], ids: ids)
+    end
+
+    def get_ip_restrictions
+      @request.get(%w[iprestrictions])
+    end
+
+    def get_white_label_sizes
+      @request.get(%w[whitelabel sizes])
+    end
+
+    def get_admin_security(product_id, user_id)
+      @request.get(%w[security administrator], productid: product_id, userid: user_id)
+    end
+
+    def get_product_admin(product_id)
+      @request.get(['security', 'administrator', product_id.to_s])
+    end
+
+    def sms_settings(enable)
+      @request.put(%w[sms], enable: enable)
+    end
+
+    def update_tips(show)
+      @request.put(%w[tips], show: show)
+    end
+
+    def set_version(version_id)
+      @request.put(%w[version], versionId: version_id)
+    end
+
+    def set_security(id, options = {})
+      @request.put(%w[security], { id: id }.merge(options))
+    end
+
+    def save_ip_restrictions(ips)
+      @request.put(%w[iprestrictions], ips: ips)
+    end
+
+    def set_access(id, enabled = true)
+      @request.put(%w[security access], items: [{ key: id, value: enabled }])
+    end
+
+    def set_product_admin(product_id, user_id, administrator = true)
+      @request.put(%w[security administrator], productid: product_id, userid: user_id, administrator: administrator)
+    end
+
+    def update_ip_restrictions(enable)
+      @request.put(%w[iprestrictions settings], enable: enable)
+    end
+
+    def update_timezone_and_language(timezone, language)
+      @request.put(%w[timeandlanguage], lng: language, timeZoneId: timezone)
+    end
+
+    def update_default_portal_page(portal_page_id)
+      @request.put(%w[defaultpage], defaultProductID: portal_page_id)
+    end
+  end
+end

data/lib/teamlab/name.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Teamlab
+  NAME = 'onlyoffice_api'
+end

data/lib/teamlab/request.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'httparty'
+require_relative 'response'
+
+module Teamlab
+  class Request
+    include HTTParty
+
+    def initialize(api_additive)
+      @api_additive = api_additive.to_s
+    end
+
+    def post(*args)
+      request(:post, args)
+    end
+
+    def get(*args)
+      request(:get, args)
+    end
+
+    def put(*args)
+      request(:put, args)
+    end
+
+    def delete(*args)
+      request(:delete, args)
+    end
+
+    private
+
+    def request(type, args)
+      command, opts = parse_args(args, type)
+      url = generate_request_url(command)
+      attempts = 0
+      begin
+        response = Teamlab::Response.new(HTTParty.send(type, url, opts))
+      rescue Timeout::Error => e
+        attempts += 1
+        retry if attempts < 3
+        raise "Can't #{type} to #{url} because of TimeoutError: #{e}"
+      rescue StandardError => e
+        raise e
+      end
+      raise("Error #{response.code}: #{response.error}") unless response.success
+
+      response
+    end
+
+    def generate_request_url(command)
+      Teamlab.config.server + Teamlab.config.api_path + @api_additive + command
+    end
+
+    def parse_args(args, type)
+      command = args.first.instance_of?(Array) ? '/' + args.shift.join('/') : args.shift.to_s
+      opts = {}
+      opts[:body] = args.last.instance_of?(Hash) ? args.pop : {}
+      opts[:body].delete_if { |_key, value| value == [] }
+      opts[:headers] = Teamlab.config.headers
+      opts = init_proxy(opts)
+      opts[:query] = opts.delete(:body) if type == :get
+      [command, opts]
+    end
+
+    # @param opts [Hash] options to init
+    # @return [Hash] options
+    def init_proxy(opts)
+      return opts unless Teamlab.config.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
+    end
+  end
+end

data/lib/teamlab/response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Teamlab
+  class Response
+    attr_reader :body, :error, :code, :success
+
+    def initialize(http_response)
+      @code = http_response.code
+      @success = @code < 400
+      err_msg = generate_err_msg(http_response) if @code >= 400
+      if @success
+        @body = http_response.to_hash
+      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
+
+        @body = http_response.respond_to?(:parsed_response) && http_response.parsed_response.key?('result') ? http_response.parsed_response['result'] : http_response.to_hash
+        @error = @body['error']['message'] if @body.key?('error') && @body['error'].key?('message')
+      end
+    end
+
+    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)}"
+    end
+
+    def prettify_response(msg)
+      JSON.pretty_generate(msg)
+    rescue Encoding::UndefinedConversionError
+      msg.force_encoding(Encoding::UTF_8)
+    end
+
+    # @return [Hash] data of response
+    def data
+      @body['response']
+    end
+  end
+end

data/lib/teamlab/version.rb

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

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: onlyoffice_api
+version: !ruby/object:Gem::Version
+  version: '0.7'
+platform: ruby
+authors:
+- ONLYOFFICE
+- Pavel Lobashov
+- rzagudaev
+- DaftTrick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Ruby Framework to interact with OnlyOffice API 2.0
+email:
+- rzagudaev@gmail.com
+- shockwavenn@gmail.com
+- nazarov90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/onlyoffice_api.rb
+- lib/teamlab/config.rb
+- lib/teamlab/modules/calendar.rb
+- lib/teamlab/modules/community.rb
+- lib/teamlab/modules/community/community_blogs.rb
+- lib/teamlab/modules/community/community_bookmarks.rb
+- lib/teamlab/modules/community/community_events.rb
+- lib/teamlab/modules/community/community_forums.rb
+- lib/teamlab/modules/community/community_wiki.rb
+- lib/teamlab/modules/crm.rb
+- lib/teamlab/modules/crm/crm_cases.rb
+- lib/teamlab/modules/crm/crm_common.rb
+- lib/teamlab/modules/crm/crm_contacts.rb
+- lib/teamlab/modules/crm/crm_files.rb
+- lib/teamlab/modules/crm/crm_history.rb
+- lib/teamlab/modules/crm/crm_invoices.rb
+- lib/teamlab/modules/crm/crm_opportunities.rb
+- lib/teamlab/modules/crm/crm_organisation.rb
+- lib/teamlab/modules/crm/crm_tags.rb
+- lib/teamlab/modules/crm/crm_tasks.rb
+- lib/teamlab/modules/crm/crm_user_fields.rb
+- lib/teamlab/modules/feed.rb
+- lib/teamlab/modules/files.rb
+- lib/teamlab/modules/group.rb
+- lib/teamlab/modules/group/group_helper.rb
+- lib/teamlab/modules/mail.rb
+- lib/teamlab/modules/mail/mail_accounts.rb
+- lib/teamlab/modules/mail/mail_alerts.rb
+- lib/teamlab/modules/mail/mail_contacts.rb
+- lib/teamlab/modules/mail/mail_conversations.rb
+- lib/teamlab/modules/mail/mail_folders.rb
+- lib/teamlab/modules/mail/mail_helpcenter.rb
+- lib/teamlab/modules/mail/mail_images.rb
+- lib/teamlab/modules/mail/mail_messages.rb
+- lib/teamlab/modules/mail/mail_settings.rb
+- lib/teamlab/modules/mail/mail_signature.rb
+- lib/teamlab/modules/mail/mail_tags.rb
+- lib/teamlab/modules/people.rb
+- lib/teamlab/modules/people/people_reassign.rb
+- lib/teamlab/modules/portals.rb
+- lib/teamlab/modules/project.rb
+- lib/teamlab/modules/projects/projects_comments.rb
+- lib/teamlab/modules/projects/projects_contacts.rb
+- lib/teamlab/modules/projects/projects_discussions.rb
+- lib/teamlab/modules/projects/projects_files.rb
+- lib/teamlab/modules/projects/projects_milestones.rb
+- lib/teamlab/modules/projects/projects_projects.rb
+- lib/teamlab/modules/projects/projects_reports.rb
+- lib/teamlab/modules/projects/projects_settings.rb
+- lib/teamlab/modules/projects/projects_tags.rb
+- lib/teamlab/modules/projects/projects_tasks.rb
+- lib/teamlab/modules/projects/projects_team.rb
+- lib/teamlab/modules/projects/projects_templates.rb
+- lib/teamlab/modules/projects/projects_time.rb
+- lib/teamlab/modules/settings.rb
+- lib/teamlab/name.rb
+- lib/teamlab/request.rb
+- lib/teamlab/response.rb
+- lib/teamlab/version.rb
+homepage: https://github.com/ONLYOFFICE/onlyoffice_api
+licenses:
+- AGPL-3.0
+metadata:
+  bug_tracker_uri: https://github.com/ONLYOFFICE/onlyoffice_api/issues
+  changelog_uri: https://github.com/ONLYOFFICE/onlyoffice_api/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/onlyoffice_api
+  homepage_uri: https://github.com/ONLYOFFICE/onlyoffice_api
+  source_code_uri: https://github.com/ONLYOFFICE/onlyoffice_api
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby gem for OnlyOffice. Formerly known as `teamlab`.
+test_files: []