boxr 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 804fcf24570dddff649843b11c9e42d212c6473f5362054dc680cf7bb7fa69eb
-  data.tar.gz: '048b0abbaf9dbb41b5a77a841aacf60fe1d4f50a2688adae1fe15d31a8efd501'
+  metadata.gz: f1c90479b5424ad7460328707aa758fa10738a99db0e76ab2186625ad64e53d5
+  data.tar.gz: 0b961dc8b412f39ea89f1de347b7dd3cce1aac242a7d44087942c60aa8b73f48
 SHA512:
-  metadata.gz: e499df5a49123809dce5515073ac842ec9bfe8e177e4c8b84707c73510da1b3e5c316041bfb95301b5f348f5e8a3ff2ac9597417cc536258eb5ff03326b9e5da
-  data.tar.gz: 61f0fb85cab6cd81029d8e8eabea8b727fafd9eca73126fde3bddf139953806040a2f3c6797d652a70cc69bc9f59166d93ef922a9bc5ee3fc645fd3248204c99
+  metadata.gz: ca107dd177c1b7c4acc6e55967a4d218e75e59290558d875c1a34e78023f92ca07581acd9c573840644152dae4c0f554e11b926023bc2c530900f235d122d72a
+  data.tar.gz: a18e866940e903c941a2a0169acf59ea38a2038701afdd0874bf985b47f956d946c7f465ae3ad1b32bdef0be72676a76c51d88b6bbe37555ad9f5571912194be

data/boxr.gemspec

@@ -25,11 +25,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.1"
   spec.add_development_dependency "simplecov", "~> 0.9"
   spec.add_development_dependency "dotenv", "~> 0.11"
-  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "awesome_print", "~> 1.8"
   spec.add_development_dependency "lru_redux", "~> 0.8"
 
   spec.add_runtime_dependency "httpclient", "~> 2.8"
   spec.add_runtime_dependency "hashie", "~> 3.5"
   spec.add_runtime_dependency "addressable", "~> 2.3"
-  spec.add_runtime_dependency "jwt", "~> 1.4"
+  spec.add_runtime_dependency "jwt", ">= 1.4"
 end

data/lib/boxr/users.rb

@@ -4,7 +4,7 @@ module Boxr
     def current_user(fields: [])
       uri = "#{USERS_URI}/me"
       query = build_fields_query(fields, USER_FIELDS_QUERY)
-      
+
       user, response = get(uri, query: query)
       user
     end
@@ -14,7 +14,7 @@ module Boxr
       user_id = ensure_id(user_id)
       uri = "#{USERS_URI}/#{user_id}"
       query = build_fields_query(fields, USER_FIELDS_QUERY)
-      
+
       user, response = get(uri, query: query)
       user
     end
@@ -30,7 +30,7 @@ module Boxr
       else
         query[:offset] = offset
         query[:limit] = limit
-        
+
         users, response = get(uri, query: query)
         users['entries']
       end
@@ -49,7 +49,7 @@ module Boxr
       attributes[:language] = language unless language.nil?
       attributes[:is_sync_enabled] = is_sync_enabled unless is_sync_enabled.nil?
       attributes[:job_title] = job_title unless job_title.nil?
-      attributes[:phone] = phone unless phone.nil? 
+      attributes[:phone] = phone unless phone.nil?
       attributes[:address] = address unless address.nil?
       attributes[:space_amount] = space_amount unless space_amount.nil?
       attributes[:tracking_codes] = tracking_codes unless tracking_codes.nil?
@@ -57,7 +57,7 @@ module Boxr
       attributes[:is_external_collab_restricted] = is_external_collab_restricted unless is_external_collab_restricted.nil?
       attributes[:status] = status unless status.nil?
       attributes[:timezone] = timezone unless timezone.nil?
-      attributes[:is_exempt_from_device_limits] = is_exempt_from_device_limits unless is_exempt_from_device_limits.nil? 
+      attributes[:is_exempt_from_device_limits] = is_exempt_from_device_limits unless is_exempt_from_device_limits.nil?
       attributes[:is_exempt_from_login_verification] = is_exempt_from_login_verification unless is_exempt_from_login_verification.nil?
       attributes[:is_platform_access_only] = is_platform_access_only unless is_platform_access_only.nil?
 
@@ -73,9 +73,9 @@ module Boxr
       user_id = ensure_id(user)
       uri = "#{USERS_URI}/#{user_id}"
       query = {notify: notify} unless notify.nil?
-      
+
       attributes = {}
-      attributes[:enterprise] = nil if enterprise.nil? #this is a special condition where setting this to nil means to roll this user out of the enterprise 
+      attributes[:enterprise] = nil if enterprise.nil? #this is a special condition where setting this to nil means to roll this user out of the enterprise
       attributes[:name] = name unless name.nil?
       attributes[:role] = role unless role.nil?
       attributes[:language] = language unless language.nil?
@@ -108,6 +108,18 @@ module Boxr
       result
     end
 
+    # As of writing, API only supports a root source folder (0)
+    def move_users_folder(user, source_folder = 0, destination_user)
+      user_id = ensure_id(user)
+      destination_user_id = ensure_id(destination_user)
+      source_folder_id = ensure_id(source_folder)
+      uri = "#{USERS_URI}/#{user_id}/folders/#{source_folder_id}"
+      attributes = {owned_by: {id: destination_user_id}}
+
+      folder, response = put(uri, attributes)
+      folder
+    end
+
     def email_aliases_for_user(user)
       user_id = ensure_id(user)
       uri = "#{USERS_URI}/#{user_id}/email_aliases"
@@ -135,4 +147,4 @@ module Boxr
     end
 
   end
-end
+end

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "1.6.0"
+  VERSION = "1.7.0"
 end

data/spec/boxr/collaborations_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+#rake spec SPEC_OPTS="-e \"invokes collaborations operations"\"
+describe 'collaborations operations' do
+  it "invokes collaborations operations" do
+    puts "add collaboration"
+    collaboration = BOX_CLIENT.add_collaboration(@test_folder, {id: @test_user.id, type: :user}, :viewer_uploader)
+    expect(collaboration.accessible_by.id).to eq(@test_user.id)
+    COLLABORATION = collaboration
+
+    puts "inspect collaboration"
+    collaboration = BOX_CLIENT.collaboration(COLLABORATION)
+    expect(collaboration.id).to eq(COLLABORATION.id)
+
+    puts "edit collaboration"
+    collaboration = BOX_CLIENT.edit_collaboration(COLLABORATION, role: "viewer uploader")
+    expect(collaboration.role).to eq("viewer uploader")
+
+    puts "inspect folder collaborations"
+    collaborations = BOX_CLIENT.folder_collaborations(@test_folder)
+    expect(collaborations.count).to eq(1)
+    expect(collaborations[0].id).to eq(COLLABORATION.id)
+
+    puts "remove collaboration"
+    result = BOX_CLIENT.remove_collaboration(COLLABORATION)
+    expect(result).to eq({})
+    collaborations = BOX_CLIENT.folder_collaborations(@test_folder)
+    expect(collaborations.count).to eq(0)
+
+    puts "inspect pending collaborations"
+    pending_collaborations = BOX_CLIENT.pending_collaborations
+    expect(pending_collaborations).to eq([])
+
+    puts "add invalid collaboration"
+    expect { BOX_CLIENT.add_collaboration(@test_folder, {id: @test_user.id, type: :user}, :invalid_role)}.to raise_error
+  end
+end

data/spec/boxr/comments_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+#rake spec SPEC_OPTS="-e \"invokes comment operations"\"
+describe 'comment operations' do
+  it "invokes comment operations" do
+    new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder)
+    test_file = new_file
+
+    puts "add comment to file"
+    comment = BOX_CLIENT.add_comment_to_file(test_file, message: COMMENT_MESSAGE)
+    expect(comment.message).to eq(COMMENT_MESSAGE)
+    COMMENT = comment
+
+    puts "reply to comment"
+    reply = BOX_CLIENT.reply_to_comment(COMMENT, message: REPLY_MESSAGE)
+    expect(reply.message).to eq(REPLY_MESSAGE)
+
+    puts "get file comments"
+    comments = BOX_CLIENT.file_comments(test_file)
+    expect(comments.count).to eq(2)
+
+    puts "update a comment"
+    comment = BOX_CLIENT.change_comment(COMMENT, CHANGED_COMMENT_MESSAGE)
+    expect(comment.message).to eq(CHANGED_COMMENT_MESSAGE)
+
+    puts "get comment info"
+    comment = BOX_CLIENT.comment(COMMENT)
+    expect(comment.id).to eq(COMMENT.id)
+
+    puts "delete comment"
+    result = BOX_CLIENT.delete_comment(COMMENT)
+    expect(result).to eq({})
+  end
+end

data/spec/boxr/files_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+
+#rake spec SPEC_OPTS="-e \"invokes file operations"\"
+describe "file operations" do
+  it "invokes file operations" do
+    puts "upload a file"
+    new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder)
+    expect(new_file.name).to eq(TEST_FILE_NAME)
+    test_file = new_file
+
+    puts "upload a file with custom name"
+    new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder, name: TEST_FILE_NAME_CUSTOM)
+    expect(new_file.name).to eq(TEST_FILE_NAME_CUSTOM)
+
+    puts "get file using path"
+    file = BOX_CLIENT.file_from_path("/#{TEST_FOLDER_NAME}/#{TEST_FILE_NAME}")
+    expect(file.id).to eq(test_file.id)
+
+    puts "get file download url"
+    download_url = BOX_CLIENT.download_url(test_file)
+    expect(download_url).to start_with("https://")
+
+    puts "get file info"
+    file_info = BOX_CLIENT.file(test_file)
+    expect(file_info.id).to eq(test_file.id)
+
+    puts "get file preview link"
+    preview_url = BOX_CLIENT.preview_url(test_file)
+    expect(preview_url).to start_with("https://")
+
+    puts "update file"
+    new_description = 'this file is used to test Boxr'
+    tags = ['tag one','tag two']
+    updated_file_info = BOX_CLIENT.update_file(test_file, description: new_description, tags: tags)
+    expect(updated_file_info.description).to eq(new_description)
+    tag_file_info = BOX_CLIENT.file(updated_file_info, fields: [:tags])
+    expect(tag_file_info.tags.length).to eq(2)
+
+    puts "lock file"
+    expires_at_utc = Time.now.utc + (60*60*24) #one day from now
+    locked_file = BOX_CLIENT.lock_file(test_file, expires_at: expires_at_utc, is_download_prevented: true)
+    locked_file = BOX_CLIENT.file(locked_file, fields: [:lock])
+    expect(locked_file.lock.type).to eq('lock')
+    expect(locked_file.lock.expires_at).to_not be_nil
+    expect(locked_file.lock.is_download_prevented).to eq(true)
+
+    puts "unlock file"
+    unlocked_file = BOX_CLIENT.unlock_file(locked_file)
+    unlocked_file = BOX_CLIENT.file(unlocked_file, fields: [:lock])
+    expect(unlocked_file.lock).to be_nil
+
+    puts "download file"
+    file = BOX_CLIENT.download_file(test_file)
+    f = File.open("./spec/test_files/#{DOWNLOADED_TEST_FILE_NAME}", 'w+')
+    f.write(file)
+    f.close
+    expect(FileUtils.identical?("./spec/test_files/#{TEST_FILE_NAME}","./spec/test_files/#{DOWNLOADED_TEST_FILE_NAME}")).to eq(true)
+    File.delete("./spec/test_files/#{DOWNLOADED_TEST_FILE_NAME}")
+
+    puts "upload new version of file"
+    new_version = BOX_CLIENT.upload_new_version_of_file("./spec/test_files/#{TEST_FILE_NAME}", test_file)
+    expect(new_version.id).to eq(test_file.id)
+
+    puts "inspect versions of file"
+    versions = BOX_CLIENT.versions_of_file(test_file)
+    expect(versions.count).to eq(1) #the reason this is 1 instead of 2 is that Box considers 'versions' to be a versions other than 'current'
+    v1 = versions.first
+
+    puts "promote old version of file"
+    newer_version = BOX_CLIENT.promote_old_version_of_file(test_file, v1)
+    versions = BOX_CLIENT.versions_of_file(test_file)
+    expect(versions.count).to eq(2)
+
+    puts "delete old version of file"
+    result = BOX_CLIENT.delete_old_version_of_file(test_file,v1)
+    versions = BOX_CLIENT.versions_of_file(test_file)
+    expect(versions.count).to eq(2) #this is still 2 because with Box you can restore a trashed old version
+
+    puts "get file thumbnail"
+    thumb = BOX_CLIENT.thumbnail(test_file)
+    expect(thumb).not_to be_nil
+
+    puts "create shared link for file"
+    updated_file = BOX_CLIENT.create_shared_link_for_file(test_file, access: :open)
+    expect(updated_file.shared_link.access).to eq("open")
+
+    puts "create password-protected shared link for file"
+    updated_file = BOX_CLIENT.create_shared_link_for_file(test_file, password: 'password')
+    expect(updated_file.shared_link.is_password_enabled).to eq(true)
+
+    puts "disable shared link for file"
+    updated_file = BOX_CLIENT.disable_shared_link_for_file(test_file)
+    expect(updated_file.shared_link).to be_nil
+
+    puts "copy file"
+    new_file_name = "copy of #{TEST_FILE_NAME}"
+    new_file = BOX_CLIENT.copy_file(test_file, @test_folder, name: new_file_name)
+    expect(new_file.name).to eq(new_file_name)
+    NEW_FILE = new_file
+
+    puts "move file"
+    new_folder = BOX_CLIENT.create_folder(SUB_FOLDER_NAME, @test_folder)
+    test_file = BOX_CLIENT.move_file(test_file, new_folder.id)
+    expect(test_file.parent.id).to eq(new_folder.id)
+
+    puts "delete file"
+    result = BOX_CLIENT.delete_file(NEW_FILE)
+    expect(result).to eq({})
+
+    puts "get trashed file info"
+    trashed_file = BOX_CLIENT.trashed_file(NEW_FILE)
+    expect(trashed_file.item_status).to eq("trashed")
+
+    puts "restore trashed file"
+    restored_file = BOX_CLIENT.restore_trashed_file(NEW_FILE)
+    expect(restored_file.item_status).to eq("active")
+
+    puts "trash and permanently delete file"
+    BOX_CLIENT.delete_file(NEW_FILE)
+    result = BOX_CLIENT.delete_trashed_file(NEW_FILE)
+    expect(result).to eq({})
+  end
+end

data/spec/boxr/folders_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+# rake spec SPEC_OPTS="-e \"invokes folder operations"\"
+describe "folder operations" do
+  it 'invokes folder operations' do
+    puts "get folder using path"
+    folder = BOX_CLIENT.folder_from_path(TEST_FOLDER_NAME)
+    expect(folder.id).to eq(@test_folder.id)
+
+    puts "get folder info"
+    folder = BOX_CLIENT.folder(@test_folder)
+    expect(folder.id).to eq(@test_folder.id)
+
+    puts "create new folder"
+    new_folder = BOX_CLIENT.create_folder(SUB_FOLDER_NAME, @test_folder)
+    expect(new_folder).to be_a BoxrMash
+    SUB_FOLDER = new_folder
+
+    puts "update folder"
+    updated_folder = BOX_CLIENT.update_folder(SUB_FOLDER, description: SUB_FOLDER_DESCRIPTION)
+    expect(updated_folder.description).to eq(SUB_FOLDER_DESCRIPTION)
+
+    puts "copy folder"
+    new_folder = BOX_CLIENT.copy_folder(SUB_FOLDER,@test_folder, name: "copy of #{SUB_FOLDER_NAME}")
+    expect(new_folder).to be_a BoxrMash
+    SUB_FOLDER_COPY = new_folder
+
+    puts "create shared link for folder"
+    updated_folder = BOX_CLIENT.create_shared_link_for_folder(@test_folder, access: :open)
+    expect(updated_folder.shared_link.access).to eq("open")
+
+    puts "create password-protected shared link for folder"
+    updated_folder = BOX_CLIENT.create_shared_link_for_folder(@test_folder, password: 'password')
+    expect(updated_folder.shared_link.is_password_enabled).to eq(true)
+    shared_link = updated_folder.shared_link.url
+
+    puts "inspect shared link"
+    shared_item = BOX_CLIENT.shared_item(shared_link)
+    expect(shared_item.id).to eq(@test_folder.id)
+
+    puts "disable shared link for folder"
+    updated_folder = BOX_CLIENT.disable_shared_link_for_folder(@test_folder)
+    expect(updated_folder.shared_link).to be_nil
+
+    puts "move folder"
+    folder_to_move = BOX_CLIENT.create_folder("Folder to move", @test_folder)
+    folder_to_move_into = BOX_CLIENT.create_folder("Folder to move into", @test_folder)
+    folder_to_move = BOX_CLIENT.move_folder(folder_to_move, folder_to_move_into)
+    expect(folder_to_move.parent.id).to eq(folder_to_move_into.id)
+
+    puts "delete folder"
+    result = BOX_CLIENT.delete_folder(SUB_FOLDER_COPY, recursive: true)
+    expect(result).to eq ({})
+
+    puts "inspect the trash"
+    trash = BOX_CLIENT.trash()
+    expect(trash).to be_a Array
+
+    puts "inspect trashed folder"
+    trashed_folder = BOX_CLIENT.trashed_folder(SUB_FOLDER_COPY)
+    expect(trashed_folder.item_status).to eq("trashed")
+
+    puts "restore trashed folder"
+    restored_folder = BOX_CLIENT.restore_trashed_folder(SUB_FOLDER_COPY)
+    expect(restored_folder.item_status).to eq("active")
+
+    puts "trash and permanently delete folder"
+    BOX_CLIENT.delete_folder(SUB_FOLDER_COPY, recursive: true)
+    result = BOX_CLIENT.delete_trashed_folder(SUB_FOLDER_COPY)
+    expect(result).to eq({})
+  end
+end

data/spec/boxr/groups_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+#rake spec SPEC_OPTS="-e \"invokes group operations"\"
+describe 'group operations' do
+  it "invokes group operations" do
+    puts "create group"
+    group = BOX_CLIENT.create_group(TEST_GROUP_NAME)
+    expect(group.name).to eq(TEST_GROUP_NAME)
+
+    puts "inspect groups"
+    groups = BOX_CLIENT.groups
+    test_group = groups.find{|g| g.name == TEST_GROUP_NAME}
+    expect(test_group).to_not be_nil
+
+    puts "update group"
+    new_name = "Test Boxr Group Renamed"
+    group = BOX_CLIENT.update_group(test_group, new_name)
+    expect(group.name).to eq(new_name)
+    group = BOX_CLIENT.rename_group(test_group,TEST_GROUP_NAME)
+    expect(group.name).to eq(TEST_GROUP_NAME)
+
+    puts "add user to group"
+    group_membership = BOX_CLIENT.add_user_to_group(@test_user, test_group)
+    expect(group_membership.user.id).to eq(@test_user.id)
+    expect(group_membership.group.id).to eq(test_group.id)
+    membership = group_membership
+
+    puts "inspect group membership"
+    group_membership = BOX_CLIENT.group_membership(membership)
+    expect(group_membership.id).to eq(membership.id)
+
+    puts "inspect group memberships"
+    group_memberships = BOX_CLIENT.group_memberships(test_group)
+    expect(group_memberships.count).to eq(1)
+    expect(group_memberships.first.id).to eq(membership.id)
+
+    puts "inspect group memberships for a user"
+    group_memberships = BOX_CLIENT.group_memberships_for_user(@test_user)
+    expect(group_memberships.count).to eq(1)
+    expect(group_memberships.first.id).to eq(membership.id)
+
+    puts "inspect group memberships for me"
+    #this is whatever user your developer token is tied to
+    group_memberships = BOX_CLIENT.group_memberships_for_me
+    expect(group_memberships).to be_a(Array)
+
+    puts "update group membership"
+    group_membership = BOX_CLIENT.update_group_membership(membership, :admin)
+    expect(group_membership.role).to eq("admin")
+
+    puts "delete group membership"
+    result = BOX_CLIENT.delete_group_membership(membership)
+    expect(result).to eq({})
+    group_memberships = BOX_CLIENT.group_memberships_for_user(@test_user)
+    expect(group_memberships.count).to eq(0)
+
+    puts "inspect group collaborations"
+    group_collaboration = BOX_CLIENT.add_collaboration(@test_folder, {id: test_group.id, type: :group}, :editor)
+    expect(group_collaboration.accessible_by.id).to eq(test_group.id)
+
+    puts "delete group"
+    response = BOX_CLIENT.delete_group(test_group)
+    expect(response).to eq({})
+  end
+end