onlyoffice_api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f8c8455b783aef58695e2f11ac059804435a6be117b76b453cdebd0a996e41a
-  data.tar.gz: 46cf0de4e5b2a8a8ad1215c7f86f50d182b5b4bcc1f364054c50015a0b522123
+  metadata.gz: c892bbb1d17d3dc5973b02ff35819d2ac24c25562128e34a511b85f2a853b765
+  data.tar.gz: 3370a41ebc3b2b591836eaf2b4cc5d49fa4f5bd05665016a07e7fad2a20d654c
 SHA512:
-  metadata.gz: d88170f761bb8384014573a865dc1e5d2614054bf8e7f4e032f36b043160763ad2d6226cf4151cd145a7b8cfc42a1313fd6a7670e8fa532298cad3c49c32ac00
-  data.tar.gz: ffa186f53c8b0077ca1af6e04495c6a83992a02f02cc861a8a6f26335fc4f022f2a1ecc3a9555a2a5a0ea5537dd6fd710dbeebfa96d92ebf3e3e1281f0a5f6c9
+  metadata.gz: 27bd8ba09090aaa9220498757d732dcc37037d34fc4cb42eb14a82995dbbf93eee528535f0a8750f27ac019d3df1650827423fe18de4054e13579d16c64a31ba
+  data.tar.gz: 9ff12209da0b8d4316470f1f71653ce2d31574d2359c1d21e05ece096fd3345f4606e07373a909ac8abffaab49a4f62c2b4b92eaf2194adcb94e5966fe606099

data/lib/teamlab/modules/files.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'cgi'
+
 module Teamlab
   class Files
     def initialize(config = nil)
@@ -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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-04 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -280,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Ruby gem for OnlyOffice. Formerly known as `teamlab`.