boxr 1.22.0 → 1.23.0

data/lib/boxr/files.rb

@@ -1,19 +1,19 @@
+# frozen_string_literal: true
+
 module Boxr
   class Client
-
     def file_from_path(path)
-      if(path.start_with?('/'))
-        path = path.slice(1..-1)
-      end
+      path = path.slice(1..-1) if path.start_with?('/')
 
       path_items = path.split('/')
       file_name = path_items.slice!(-1)
 
       folder = folder_from_path(path_items.join('/'))
 
-      files = folder_items(folder, fields: [:id, :name]).files
-      file = files.select{|f| f.name.casecmp?(file_name) }.first
+      files = folder_items(folder, fields: %i[id name]).files
+      file = files.select { |f| f.name.casecmp?(file_name) }.first
       raise BoxrError.new(boxr_message: "File not found: '#{file_name}'") if file.nil?
+
       file
     end
 
@@ -21,21 +21,21 @@ module Boxr
       file_id = ensure_id(file_id)
       uri = "#{FILES_URI}/#{file_id}"
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
-      file, response = get(uri, query: query)
+      file, = get(uri, query: query)
       file
     end
-    alias :file :file_from_id
+    alias file file_from_id
 
     def embed_url(file, show_download: false, show_annotations: false)
-      file_info = file_from_id(file, fields:[:expiring_embed_link])
-      url = file_info.expiring_embed_link.url + "?showDownload=#{show_download}&showAnnotations=#{show_annotations}"
-      url
+      file_info = file_from_id(file, fields: [:expiring_embed_link])
+      file_info.expiring_embed_link.url + "?showDownload=#{show_download}&showAnnotations=#{show_annotations}"
     end
-    alias :embed_link :embed_url
-    alias :preview_url :embed_url
-    alias :preview_link :embed_url
+    alias embed_link embed_url
+    alias preview_url embed_url
+    alias preview_link embed_url
 
-    def update_file(file, name: nil, description: nil, parent: nil, shared_link: nil, tags: nil, lock: nil, if_match: nil)
+    def update_file(file, name: nil, description: nil, parent: nil, shared_link: nil, tags: nil,
+                    lock: nil, if_match: nil)
       file_id = ensure_id(file)
       parent_id = ensure_id(parent)
       uri = "#{FILES_URI}/#{file_id}"
@@ -43,17 +43,17 @@ module Boxr
       attributes = {}
       attributes[:name] = name unless name.nil?
       attributes[:description] = description unless description.nil?
-      attributes[:parent] = {id: parent_id} unless parent_id.nil?
+      attributes[:parent] = { id: parent_id } unless parent_id.nil?
       attributes[:shared_link] = shared_link unless shared_link.nil?
       attributes[:tags] = tags unless tags.nil?
       attributes[:lock] = lock unless lock.nil?
 
-      updated_file, response = put(uri, attributes, if_match: if_match)
+      updated_file, = put(uri, attributes, if_match: if_match)
       updated_file
     end
 
     def lock_file(file, expires_at: nil, is_download_prevented: false, if_match: nil)
-      lock = {type: "lock"}
+      lock = { type: 'lock' }
       lock[:expires_at] = expires_at.to_datetime.rfc3339 unless expires_at.nil?
       lock[:is_download_prevented] = is_download_prevented unless is_download_prevented.nil?
 
@@ -63,9 +63,9 @@ module Boxr
     def unlock_file(file, if_match: nil)
       file_id = ensure_id(file)
       uri = "#{FILES_URI}/#{file_id}"
-      attributes = {lock: nil}
+      attributes = { lock: nil }
 
-      updated_file, response = put(uri, attributes, if_match: if_match)
+      updated_file, = put(uri, attributes, if_match: if_match)
       updated_file
     end
 
@@ -76,26 +76,26 @@ module Boxr
     def download_file(file, version: nil, follow_redirect: true)
       file_id = ensure_id(file)
 
-      begin
+      loop do
         uri = "#{FILES_URI}/#{file_id}/content"
         query = {}
         query[:version] = version unless version.nil?
-        body_json, response = get(uri, query: query, success_codes: [302,202], process_response: false, follow_redirect: false) #we don't want httpclient to automatically follow the redirect; we need to grab it
-
-        if(response.status==302)
+        _, response = get(uri, query: query, success_codes: [302, 202], process_response: false, follow_redirect: false) # we don't want httpclient to automatically follow the redirect; we need to grab it
+        if response.status == 302
           location = response.header['Location'][0]
+          return location unless follow_redirect
+
+          file_content, = get(location, process_response: false)
+          return file_content
+
+        # simply return the url
 
-          if(follow_redirect)
-            file_content, response = get(location, process_response: false)
-            return file_content
-          else
-            return location #simply return the url
-          end
-        elsif(response.status==202)
+        elsif response.status == 202
           retry_after_seconds = response.header['Retry-After'][0]
           sleep retry_after_seconds.to_i
         end
-      end until file_content
+        break if file_content
+      end
     end
 
     def download_url(file, version: nil)
@@ -104,14 +104,16 @@ module Boxr
 
     def upload_file(path_to_file, parent, name: nil, content_created_at: nil, content_modified_at: nil,
                     preflight_check: true, send_content_md5: true)
-      filename = name ? name : File.basename(path_to_file)
+      filename = name || File.basename(path_to_file)
 
       File.open(path_to_file) do |file|
-        upload_file_from_io(file, parent, name: filename, content_created_at: content_created_at, content_modified_at: content_modified_at, preflight_check: preflight_check, send_content_md5: send_content_md5)
+        upload_file_from_io(file, parent, name: filename, content_created_at: content_created_at,
+                                          content_modified_at: content_modified_at, preflight_check: preflight_check, send_content_md5: send_content_md5)
       end
     end
 
-    def upload_file_from_io(io, parent, name:, content_created_at: nil, content_modified_at: nil, preflight_check: true, send_content_md5: true)
+    def upload_file_from_io(io, parent, name:, content_created_at: nil, content_modified_at: nil,
+                            preflight_check: true, send_content_md5: true)
       parent_id = ensure_id(parent)
 
       preflight_check(io, name, parent_id) if preflight_check
@@ -121,49 +123,58 @@ module Boxr
         io.rewind
       end
 
-      attributes = {name: name, parent: {id: parent_id}}
-      attributes[:content_created_at] = content_created_at.to_datetime.rfc3339 unless content_created_at.nil?
-      attributes[:content_modified_at] = content_modified_at.to_datetime.rfc3339 unless content_modified_at.nil?
+      attributes = { name: name, parent: { id: parent_id } }
+      unless content_created_at.nil?
+        attributes[:content_created_at] =
+          content_created_at.to_datetime.rfc3339
+      end
+      unless content_modified_at.nil?
+        attributes[:content_modified_at] =
+          content_modified_at.to_datetime.rfc3339
+      end
 
-      body = {attributes: JSON.dump(attributes), file: io}
+      body = { attributes: JSON.dump(attributes), file: io }
 
-      file_info, response = post(FILES_UPLOAD_URI, body, process_body: false, content_md5: content_md5)
+      file_info, = post(FILES_UPLOAD_URI, body, process_body: false,
+                                                content_md5: content_md5)
 
       file_info.entries[0]
     end
 
     def upload_new_version_of_file(path_to_file, file, content_modified_at: nil, send_content_md5: true,
-                                    preflight_check: true, if_match: nil, name: nil)
-      filename = name ? name : File.basename(path_to_file)
+                                   preflight_check: true, if_match: nil, name: nil)
+      filename = name || File.basename(path_to_file)
 
       File.open(path_to_file) do |io|
-        upload_new_version_of_file_from_io(io, file, name: filename, content_modified_at: content_modified_at, preflight_check: preflight_check, send_content_md5: send_content_md5, if_match: if_match)
+        upload_new_version_of_file_from_io(io, file, name: filename,
+                                                     content_modified_at: content_modified_at, preflight_check: preflight_check, send_content_md5: send_content_md5, if_match: if_match)
       end
     end
 
     def upload_new_version_of_file_from_io(io, file, name: nil, content_modified_at: nil, send_content_md5: true,
-                                    preflight_check: true, if_match: nil)
-
-      filename = name ? name : file.name
+                                           preflight_check: true, if_match: nil)
+      name || file.name
 
       file_id = ensure_id(file)
       preflight_check_new_version_of_file(io, file_id) if preflight_check
 
       uri = "#{UPLOAD_URI}/files/#{file_id}/content"
-      file_info = nil
-      response = nil
 
       if send_content_md5
         content_md5 = Digest::SHA1.hexdigest(io.read)
         io.rewind
       end
 
-      attributes = {name: name}
-      attributes[:content_modified_at] = content_modified_at.to_datetime.rfc3339 unless content_modified_at.nil?
+      attributes = { name: name }
+      unless content_modified_at.nil?
+        attributes[:content_modified_at] =
+          content_modified_at.to_datetime.rfc3339
+      end
 
-      body = {attributes: JSON.dump(attributes), file: io}
+      body = { attributes: JSON.dump(attributes), file: io }
 
-      file_info, response = post(uri, body, process_body: false, content_md5: content_md5, if_match: if_match)
+      file_info, = post(uri, body, process_body: false, content_md5: content_md5,
+                                   if_match: if_match)
 
       file_info.entries[0]
     end
@@ -171,7 +182,7 @@ module Boxr
     def versions_of_file(file)
       file_id = ensure_id(file)
       uri = "#{FILES_URI}/#{file_id}/versions"
-      versions, response = get(uri)
+      versions, = get(uri)
       versions.entries
     end
 
@@ -180,15 +191,15 @@ module Boxr
       file_version_id = ensure_id(file_version)
 
       uri = "#{FILES_URI}/#{file_id}/versions/current"
-      attributes = {:type => 'file_version', :id => file_version_id}
-      new_version, res = post(uri, attributes)
+      attributes = { type: 'file_version', id: file_version_id }
+      new_version, = post(uri, attributes)
       new_version
     end
 
     def delete_file(file, if_match: nil)
       file_id = ensure_id(file)
       uri = "#{FILES_URI}/#{file_id}"
-      result, response = delete(uri, if_match: if_match)
+      result, = delete(uri, if_match: if_match)
       result
     end
 
@@ -197,18 +208,20 @@ module Boxr
       file_version_id = ensure_id(file_version)
 
       uri = "#{FILES_URI}/#{file_id}/versions/#{file_version_id}"
-      result, response = delete(uri, if_match: if_match)
+      result, = delete(uri, if_match: if_match)
       result
     end
 
-    def copy_file(file, parent, name: nil)
+    def copy_file(file, parent, name: nil, version: nil)
       file_id = ensure_id(file)
       parent_id = ensure_id(parent)
+      version_id = ensure_id(version) unless version.nil?
 
       uri = "#{FILES_URI}/#{file_id}/copy"
-      attributes = {:parent => {:id => parent_id}}
+      attributes = { parent: { id: parent_id } }
       attributes[:name] = name unless name.nil?
-      new_file, res = post(uri, attributes)
+      attributes[:version] = version_id unless version_id.nil?
+      new_file, = post(uri, attributes)
       new_file
     end
 
@@ -220,19 +233,21 @@ module Boxr
       query[:min_width] = min_width unless min_width.nil?
       query[:max_height] = max_height unless max_height.nil?
       query[:max_width] = max_width unless max_width.nil?
-      body, response = get(uri, query: query, success_codes: [302,202,200], process_response: false)
+      body, response = get(uri, query: query, success_codes: [302, 202, 200],
+                                process_response: false)
 
-      if(response.status==202 || response.status==302)
+      if [202, 302].include?(response.status)
         location = response.header['Location'][0]
-        thumbnail, response = get(location, process_response: false)
-      else #200
+        thumbnail, = get(location, process_response: false)
+      else # 200
         thumbnail = body
       end
 
       thumbnail
     end
 
-    def create_shared_link_for_file(file, access: nil, unshared_at: nil, can_download: nil, can_preview: nil, password: nil)
+    def create_shared_link_for_file(file, access: nil, unshared_at: nil, can_download: nil,
+                                    can_preview: nil, password: nil)
       file_id = ensure_id(file)
       uri = "#{FILES_URI}/#{file_id}"
       create_shared_link(uri, file_id, access, unshared_at, can_download, can_preview, password)
@@ -249,7 +264,7 @@ module Boxr
       uri = "#{FILES_URI}/#{file_id}/trash"
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
 
-      trashed_file, response = get(uri, query: query)
+      trashed_file, = get(uri, query: query)
       trashed_file
     end
 
@@ -257,7 +272,7 @@ module Boxr
       file_id = ensure_id(file)
       uri = "#{FILES_URI}/#{file_id}/trash"
 
-      result, response = delete(uri)
+      result, = delete(uri)
       result
     end
 
@@ -274,16 +289,15 @@ module Boxr
     def preflight_check(io, filename, parent_id)
       size = io.size
 
-      #TODO: need to make sure that figuring out the filename from the path_to_file works for people using Windows
-      attributes = {name: filename, parent: {id: "#{parent_id}"}, size: size}
-      body_json, res = options("#{FILES_URI}/content", attributes)
+      # TODO: need to make sure that figuring out the filename from the path_to_file works for people using Windows
+      attributes = { name: filename, parent: { id: parent_id.to_s }, size: size }
+      options("#{FILES_URI}/content", attributes)
     end
 
     def preflight_check_new_version_of_file(io, file_id)
       size = io.size
-      attributes = {size: size}
-      body_json, res = options("#{FILES_URI}/#{file_id}/content", attributes)
+      attributes = { size: size }
+      options("#{FILES_URI}/#{file_id}/content", attributes)
     end
-
   end
 end

data/lib/boxr/folders.rb

@@ -1,17 +1,17 @@
+# frozen_string_literal: true
+
 module Boxr
   class Client
-
     def folder_from_path(path)
-      if(path.start_with?('/'))
-        path = path.slice(1..-1)
-      end
+      path = path.slice(1..-1) if path.start_with?('/')
 
       path_folders = path.split('/')
 
       folder = path_folders.inject(Boxr::ROOT) do |parent_folder, folder_name|
-        folders = folder_items(parent_folder, fields: [:id, :name]).folders
-        folder = folders.select{|f| f.name.casecmp?(folder_name) }.first
+        folders = folder_items(parent_folder, fields: %i[id name]).folders
+        folder = folders.select { |f| f.name.casecmp?(folder_name) }.first
         raise BoxrError.new(boxr_message: "Folder not found: '#{folder_name}'") if folder.nil?
+
         folder
       end
     end
@@ -21,10 +21,10 @@ module Boxr
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
       uri = "#{FOLDERS_URI}/#{folder_id}"
 
-      folder, response = get(uri, query: query)
+      folder, = get(uri, query: query)
       folder
     end
-    alias :folder :folder_from_id
+    alias folder folder_from_id
 
     def folder_items(folder, fields: [], offset: nil, limit: nil)
       folder_id = ensure_id(folder)
@@ -32,11 +32,11 @@ module Boxr
       uri = "#{FOLDERS_URI}/#{folder_id}/items"
 
       if offset.nil? || limit.nil?
-        items = get_all_with_pagination(uri, query: query, offset: 0, limit: FOLDER_ITEMS_LIMIT)
+        get_all_with_pagination(uri, query: query, offset: 0, limit: FOLDER_ITEMS_LIMIT)
       else
         query[:offset] = offset
         query[:limit] = limit
-        items, response = get(uri, query: query)
+        items, = get(uri, query: query)
         items['entries']
       end
     end
@@ -48,16 +48,16 @@ module Boxr
     def create_folder(name, parent)
       parent_id = ensure_id(parent)
 
-      uri = "#{FOLDERS_URI}"
-      attributes = {:name => name, :parent => {:id => parent_id}}
+      uri = FOLDERS_URI.to_s
+      attributes = { name: name, parent: { id: parent_id } }
 
-      created_folder, response = post(uri, attributes)
+      created_folder, = post(uri, attributes)
       created_folder
     end
 
     def update_folder(folder, name: nil, description: nil, parent: nil, shared_link: nil,
-                           folder_upload_email_access: nil, owned_by: nil, sync_state: nil, tags: nil,
-                           can_non_owners_invite: nil, if_match: nil)
+                      folder_upload_email_access: nil, owned_by: nil, sync_state: nil, tags: nil,
+                      can_non_owners_invite: nil, if_match: nil)
       folder_id = ensure_id(folder)
       parent_id = ensure_id(parent)
       owned_by_id = ensure_id(owned_by)
@@ -66,15 +66,18 @@ module Boxr
       attributes = {}
       attributes[:name] = name unless name.nil?
       attributes[:description] = description unless description.nil?
-      attributes[:parent] = {id: parent_id} unless parent_id.nil?
+      attributes[:parent] = { id: parent_id } unless parent_id.nil?
       attributes[:shared_link] = shared_link unless shared_link.nil?
-      attributes[:folder_upload_email] = {access: folder_upload_email_access} unless folder_upload_email_access.nil?
-      attributes[:owned_by] = {id: owned_by_id} unless owned_by_id.nil?
+      unless folder_upload_email_access.nil?
+        attributes[:folder_upload_email] =
+          { access: folder_upload_email_access }
+      end
+      attributes[:owned_by] = { id: owned_by_id } unless owned_by_id.nil?
       attributes[:sync_state] = sync_state unless sync_state.nil?
       attributes[:tags] = tags unless tags.nil?
       attributes[:can_non_owners_invite] = can_non_owners_invite unless can_non_owners_invite.nil?
 
-      updated_folder, response = put(uri, attributes, if_match: if_match)
+      updated_folder, = put(uri, attributes, if_match: if_match)
       updated_folder
     end
 
@@ -85,9 +88,9 @@ module Boxr
     def delete_folder(folder, recursive: false, if_match: nil)
       folder_id = ensure_id(folder)
       uri = "#{FOLDERS_URI}/#{folder_id}"
-      query = {:recursive => recursive}
+      query = { recursive: recursive }
 
-      result, response = delete(uri, query: query, if_match: if_match)
+      result, = delete(uri, query: query, if_match: if_match)
       result
     end
 
@@ -96,14 +99,15 @@ module Boxr
       dest_folder_id = ensure_id(dest_folder)
 
       uri = "#{FOLDERS_URI}/#{folder_id}/copy"
-      attributes = {:parent => {:id => dest_folder_id}}
+      attributes = { parent: { id: dest_folder_id } }
       attributes[:name] = name unless name.nil?
 
-      new_folder, response = post(uri, attributes)
+      new_folder, = post(uri, attributes)
       new_folder
     end
 
-    def create_shared_link_for_folder(folder, access: nil, unshared_at: nil, can_download: nil, can_preview: nil, password: nil)
+    def create_shared_link_for_folder(folder, access: nil, unshared_at: nil, can_download: nil,
+                                      can_preview: nil, password: nil)
       folder_id = ensure_id(folder)
       uri = "#{FOLDERS_URI}/#{folder_id}"
       create_shared_link(uri, folder_id, access, unshared_at, can_download, can_preview, password)
@@ -120,11 +124,11 @@ module Boxr
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
 
       if offset.nil? || limit.nil?
-        items = get_all_with_pagination(uri, query: query, offset: 0, limit: FOLDER_ITEMS_LIMIT)
+        get_all_with_pagination(uri, query: query, offset: 0, limit: FOLDER_ITEMS_LIMIT)
       else
         query[:offset] = offset
         query[:limit] = limit
-        items, response = get(uri, query: query)
+        items, = get(uri, query: query)
         items['entries']
       end
     end
@@ -134,14 +138,14 @@ module Boxr
       uri = "#{FOLDERS_URI}/#{folder_id}/trash"
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
 
-      folder, response = get(uri, query: query)
+      folder, = get(uri, query: query)
       folder
     end
 
     def delete_trashed_folder(folder)
       folder_id = ensure_id(folder)
       uri = "#{FOLDERS_URI}/#{folder_id}/trash"
-      result, response = delete(uri)
+      result, = delete(uri)
       result
     end
 
@@ -152,6 +156,5 @@ module Boxr
       uri = "#{FOLDERS_URI}/#{folder_id}"
       restore_trashed_item(uri, name, parent_id)
     end
-
   end
 end

data/lib/boxr/groups.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 module Boxr
   class Client
-
     def groups(fields: [], offset: 0, limit: DEFAULT_LIMIT)
       query = build_fields_query(fields, GROUP_FIELDS_QUERY)
-      groups = get_all_with_pagination(GROUPS_URI, query: query, offset: offset, limit: limit)
+      get_all_with_pagination(GROUPS_URI, query: query, offset: offset, limit: limit)
     end
 
     def group_from_id(group_id, fields: [])
@@ -11,83 +12,82 @@ module Boxr
       uri = "#{GROUPS_URI}/#{group_id}"
       query = build_fields_query(fields, GROUP_FIELDS_QUERY)
 
-      group, response = get(uri, query: query)
+      group, = get(uri, query: query)
       group
     end
-    alias :group :group_from_id
+    alias group group_from_id
 
     def create_group(name)
-      attributes = {name: name}
-      new_group, response = post(GROUPS_URI, attributes)
-      new_group 
+      attributes = { name: name }
+      new_group, = post(GROUPS_URI, attributes)
+      new_group
     end
 
     def update_group(group, name)
       group_id = ensure_id(group)
       uri = "#{GROUPS_URI}/#{group_id}"
-      attributes = {name: name}
+      attributes = { name: name }
 
-      updated_group, response = put(uri, attributes)
+      updated_group, = put(uri, attributes)
       updated_group
     end
-    alias :rename_group :update_group
+    alias rename_group update_group
 
     def delete_group(group)
       group_id = ensure_id(group)
       uri = "#{GROUPS_URI}/#{group_id}"
-      result, response = delete(uri)
+      result, = delete(uri)
       result
     end
 
     def group_memberships(group, offset: 0, limit: DEFAULT_LIMIT)
       group_id = ensure_id(group)
       uri = "#{GROUPS_URI}/#{group_id}/memberships"
-      memberships = get_all_with_pagination(uri, offset: offset, limit: limit)
+      get_all_with_pagination(uri, offset: offset, limit: limit)
     end
 
     def group_memberships_for_user(user, offset: 0, limit: DEFAULT_LIMIT)
       user_id = ensure_id(user)
       uri = "#{USERS_URI}/#{user_id}/memberships"
-      memberships = get_all_with_pagination(uri, offset: offset, limit: limit)
+      get_all_with_pagination(uri, offset: offset, limit: limit)
     end
 
     def group_memberships_for_me(offset: 0, limit: DEFAULT_LIMIT)
       uri = "#{USERS_URI}/me/memberships"
-      memberships = get_all_with_pagination(uri, offset: offset, limit: limit)
+      get_all_with_pagination(uri, offset: offset, limit: limit)
     end
 
     def group_membership_from_id(membership_id)
       membership_id = ensure_id(membership_id)
       uri = "#{GROUP_MEMBERSHIPS_URI}/#{membership_id}"
-      membership, response = get(uri)
+      membership, = get(uri)
       membership
     end
-    alias :group_membership :group_membership_from_id
+    alias group_membership group_membership_from_id
 
     def add_user_to_group(user, group, role: nil)
       user_id = ensure_id(user)
       group_id = ensure_id(group)
 
-      attributes = {user: {id: user_id}, group: {id: group_id}}
+      attributes = { user: { id: user_id }, group: { id: group_id } }
       attributes[:role] = role unless role.nil?
-      membership, response = post(GROUP_MEMBERSHIPS_URI, attributes)
+      membership, = post(GROUP_MEMBERSHIPS_URI, attributes)
       membership
     end
 
     def update_group_membership(membership, role)
       membership_id = ensure_id(membership)
       uri = "#{GROUP_MEMBERSHIPS_URI}/#{membership_id}"
-      attributes = {role: role}
-      updated_membership, response = put(uri, attributes)
+      attributes = { role: role }
+      updated_membership, = put(uri, attributes)
       updated_membership
     end
 
     def delete_group_membership(membership)
       membership_id = ensure_id(membership)
       uri = "#{GROUP_MEMBERSHIPS_URI}/#{membership_id}"
-      result, response = delete(uri)
+      result, = delete(uri)
       result
     end
-
   end
 end