boxr 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 313b4d35a06c5975bcc0486d8d0099cb74288d53
-  data.tar.gz: b691b2075b1bb74992222aeb945c9e0665ab8378
+  metadata.gz: 4ecd063a6d71a477dc1aa7d50d53b2f649354599
+  data.tar.gz: 16fbb18c677d990d8dba2071226d1ce8f59ee145
 SHA512:
-  metadata.gz: 007e990c0b663e9b1cfd26bc387f4352d75764a462cbbed1ecf5bc41028982189c7507ff1fb87e7ca7d8d58112d45b06a611dd0d2c429cb818bd8fc17a9cc94c
-  data.tar.gz: 39f0c09f87141e9a62780401979c0a76391e4f1109d99f0653b9e81e50a3a968651c09c47b54cc4fcfca229c6d7b1977cedd203b40b6740255ea9bd0fe684c58
+  metadata.gz: 657845370199ea7d468ea248c06038febfa0e58ba126b2bfb35cc6b7140262b0f078485ad4de83cf9b8bf8a8a7944831a498d6315cfc95e71dc706e10259cde7
+  data.tar.gz: 4dd7d41e230f9729cbb9ff2a90ecbca5e31cf7116800e034e9f9e4a3dc1195f15dd4e45aca0d0840c9dbf5e5d66ca13d512bca46a51fbf7533ea9ac52b764dd0

data/README.md

@@ -83,8 +83,8 @@ require 'boxr'
 client = Boxr::Client.new  #using ENV['BOX_DEVELOPER_TOKEN']
 
 folder = client.folder_from_path('/some/directory/structure')
-file = client.upload_file('test.txt', folder.id)
-file = client.create_shared_link_for_file(file.id, access: :open)
+file = client.upload_file('test.txt', folder)
+file = client.create_shared_link_for_file(file, access: :open)
 puts "Shared Link: #{file.shared_link.url}"
 ```
 

data/lib/boxr/client.rb

@@ -222,6 +222,12 @@ module Boxr
       end
     end
 
+    def ensure_id(item)
+      return item if item.class == String || item.class == Fixnum
+      return item.id if item.respond_to?(:id)
+      raise BoxrException.new(boxr_message: "Expecting an id of class String or Fixnum, or object that responds to :id")
+    end
+
     def restore_trashed_item(uri, name, parent_id)
       attributes = {}
       attributes[:name] = name unless name.nil?

data/lib/boxr/collaborations.rb

@@ -2,6 +2,7 @@ module Boxr
   class Client
 
     def folder_collaborations(folder_id)
+      folder_id = ensure_id(folder_id)
       uri = "#{FOLDERS_URI}/#{folder_id}/collaborations"
       collaborations, response = get(uri)
       collaborations['entries']
@@ -9,6 +10,7 @@ module Boxr
 
     #make sure 'role' value is a string as Box has role values with spaces and dashes; e.g. 'previewer uploader'
     def add_collaboration(folder_id, accessible_by, role, fields: [], notify: nil)
+      folder_id = ensure_id(folder_id)
       query = build_fields_query(fields, COLLABORATION_FIELDS_QUERY)
       query[:notify] = :notify unless notify.nil?
 
@@ -21,6 +23,7 @@ module Boxr
     end
 
     def edit_collaboration(collaboration_id, role: nil, status: nil)
+      collaboration_id = ensure_id(collaboration_id)
       uri = "#{COLLABORATIONS_URI}/#{collaboration_id}"
       attributes = {}
       attributes[:role] = role unless role.nil?
@@ -31,12 +34,14 @@ module Boxr
     end
 
     def remove_collaboration(collaboration_id)
+      collaboration_id = ensure_id(collaboration_id)
       uri = "#{COLLABORATIONS_URI}/#{collaboration_id}"
       result, response = delete(uri)
       result
     end
 
     def collaboration(collaboration_id, fields: [], status: nil)
+      collaboration_id = ensure_id(collaboration_id)
       uri = "#{COLLABORATIONS_URI}/#{collaboration_id}"
 
       query = build_fields_query(fields, COLLABORATION_FIELDS_QUERY)

data/lib/boxr/comments.rb

@@ -2,6 +2,7 @@ module Boxr
   class Client
 
     def file_comments(file_id, fields: [])
+      file_id = ensure_id(file_id)
       uri = "#{FILES_URI}/#{file_id}/comments"
       query = build_fields_query(fields, COMMENT_FIELDS_QUERY)
 
@@ -9,14 +10,17 @@ module Boxr
     end
 
     def add_comment_to_file(file_id, message: nil, tagged_message: nil)
+      file_id = ensure_id(file_id)
       add_comment(:file, file_id, message, tagged_message)
     end
 
     def reply_to_comment(comment_id, message: nil, tagged_message: nil)
+      comment_id = ensure_id(comment_id)
       add_comment(:comment, comment_id, message, tagged_message)
     end
 
     def change_comment(comment_id, message)
+      comment_id = ensure_id(comment_id)
       uri = "#{COMMENTS_URI}/#{comment_id}"
       attributes = {message: message}
       updated_comment, response = put uri, attributes
@@ -24,12 +28,14 @@ module Boxr
     end
 
     def comment(comment_id, fields: [])
+      comment_id = ensure_id(comment_id)
       uri ="#{COMMENTS_URI}/#{comment_id}"
       comment, response = get uri
       comment
     end
 
     def delete_comment(comment_id)
+      comment_id = ensure_id(comment_id)
       uri = "#{COMMENTS_URI}/#{comment_id}"
       result, response = delete uri
       result

data/lib/boxr/files.rb

@@ -18,6 +18,7 @@ module Boxr
     end
 
     def file(file_id, fields: [])
+      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
@@ -25,6 +26,7 @@ module Boxr
     end
 
     def update_file(file_id, name: nil, description: nil, parent_id: nil, shared_link: nil, tags: nil, if_match: nil)
+      file_id = ensure_id(file_id)
       uri = "#{FILES_URI}/#{file_id}"
 
       attributes = {}
@@ -39,6 +41,7 @@ module Boxr
     end
 
     def download_file(file_id, version: nil, follow_redirect: true)
+      file_id = ensure_id(file_id)
       begin
         uri = "#{FILES_URI}/#{file_id}/content"
         query = {}
@@ -69,6 +72,7 @@ module Boxr
     def upload_file(path_to_file, parent_id, content_created_at: nil, content_modified_at: nil, 
                     preflight_check: true, send_content_md5: true)
 
+      parent_id = ensure_id(parent_id)
       preflight_check(path_to_file, parent_id) if preflight_check
 
       file_info = nil
@@ -86,6 +90,7 @@ module Boxr
     end
 
     def delete_file(file_id, if_match: nil)
+      file_id = ensure_id(file_id)
       uri = "#{FILES_URI}/#{file_id}"
       result, response = delete uri, if_match: if_match
       result
@@ -93,7 +98,7 @@ module Boxr
 
     def upload_new_version_of_file(path_to_file, file_id, content_modified_at: nil, send_content_md5: true, 
                                     preflight_check: true, if_match: nil)
-
+      file_id = ensure_id(file_id)
       preflight_check_new_version_of_file(path_to_file, file_id) if preflight_check
 
       uri = "#{UPLOAD_URI}/files/#{file_id}/content"
@@ -111,12 +116,16 @@ module Boxr
     end
 
     def versions_of_file(file_id)
+      file_id = ensure_id(file_id)
       uri = "#{FILES_URI}/#{file_id}/versions"
       versions, response = get uri
       versions["entries"]
     end
 
     def promote_old_version_of_file(file_id, file_version_id)
+      file_id = ensure_id(file_id)
+      file_version_id = ensure_id(file_version_id)
+
       uri = "#{FILES_URI}/#{file_id}/versions/current"
       attributes = {:type => 'file_version', :id => file_version_id}
       new_version, res = post uri, attributes
@@ -124,12 +133,18 @@ module Boxr
     end
 
     def delete_old_version_of_file(file_id, file_version_id, if_match: nil)
+      file_id = ensure_id(file_id)
+      file_version_id = ensure_id(file_version_id)
+      
       uri = "#{FILES_URI}/#{file_id}/versions/#{file_version_id}"
       result, response = delete uri, if_match: if_match
       result
     end
 
     def copy_file(file_id, parent_id, name: nil)
+      file_id = ensure_id(file_id)
+      parent_id = ensure_id(parent_id)
+
       uri = "#{FILES_URI}/#{file_id}/copy"
       attributes = {:parent => {:id => parent_id}}
       attributes[:name] = name unless name.nil?
@@ -138,6 +153,7 @@ module Boxr
     end
 
     def thumbnail(file_id, min_height: nil, min_width: nil, max_height: nil, max_width: nil)
+      file_id = ensure_id(file_id)
       uri = "#{FILES_URI}/#{file_id}/thumbnail.png"
       query = {}
       query[:min_height] = min_height unless min_height.nil?
@@ -157,16 +173,19 @@ module Boxr
     end
 
     def create_shared_link_for_file(file_id, access: nil, unshared_at: nil, can_download: nil, can_preview: nil)
+      file_id = ensure_id(file_id)
       uri = "#{FILES_URI}/#{file_id}"
       create_shared_link(uri, file_id, access, unshared_at, can_download, can_preview)
     end
 
     def disable_shared_link_for_file(file_id)
+      file_id = ensure_id(file_id)
       uri = "#{FILES_URI}/#{file_id}"
       disable_shared_link(uri, file_id)
     end
 
     def trashed_file(file_id, fields: [])
+      file_id = ensure_id(file_id)
       uri = "#{FILES_URI}/#{file_id}/trash"
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
 
@@ -175,6 +194,7 @@ module Boxr
     end
 
     def delete_trashed_file(file_id)
+      file_id = ensure_id(file_id)
       uri = "#{FILES_URI}/#{file_id}/trash"
 
       result, response = delete uri
@@ -182,6 +202,7 @@ module Boxr
     end
 
     def restore_trashed_file(file_id, name: nil, parent_id: nil)
+      file_id = ensure_id(file_id)
       uri = "#{FILES_URI}/#{file_id}"
       restore_trashed_item(uri, name, parent_id)
     end

data/lib/boxr/folders.rb

@@ -18,6 +18,7 @@ module Boxr
     end
 
     def folder_items(folder_id, fields: [])
+      folder_id = ensure_id(folder_id)
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
       uri = "#{FOLDERS_URI}/#{folder_id}/items"
 
@@ -29,6 +30,7 @@ module Boxr
     end
 
     def create_folder(name, parent_id)
+      parent_id = ensure_id(parent_id)
       uri = "#{FOLDERS_URI}"
       attributes = {:name => name, :parent => {:id => parent_id}}
       
@@ -37,6 +39,7 @@ module Boxr
     end
 
     def folder(folder_id, fields: [])
+      folder_id = ensure_id(folder_id)
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
       uri = "#{FOLDERS_URI}/#{folder_id}"
 
@@ -47,6 +50,7 @@ module Boxr
     def update_folder(folder_id, name: nil, description: nil, parent_id: nil, shared_link: nil,
                            folder_upload_email_access: nil, owned_by_id: nil, sync_state: nil, tags: nil,
                            can_non_owners_invite: nil, if_match: nil)
+      folder_id = ensure_id(folder_id)
       uri = "#{FOLDERS_URI}/#{folder_id}"
 
       attributes = {}
@@ -65,6 +69,7 @@ module Boxr
     end
 
     def delete_folder(folder_id, recursive: false, if_match: nil)
+      folder_id = ensure_id(folder_id)
       uri = "#{FOLDERS_URI}/#{folder_id}"
       query = {:recursive => recursive}
 
@@ -73,6 +78,9 @@ module Boxr
     end
 
     def copy_folder(folder_id, dest_folder_id, name: nil)
+      folder_id = ensure_id(folder_id)
+      dest_folder_id = ensure_id(dest_folder_id)
+
       uri = "#{FOLDERS_URI}/#{folder_id}/copy"
       attributes = {:parent => {:id => dest_folder_id}}
       attributes[:name] = name unless name.nil?
@@ -82,11 +90,13 @@ module Boxr
     end
 
     def create_shared_link_for_folder(folder_id, access: nil, unshared_at: nil, can_download: nil, can_preview: nil)
+      folder_id = ensure_id(folder_id)
       uri = "#{FOLDERS_URI}/#{folder_id}"
       create_shared_link(uri, folder_id, access, unshared_at, can_download, can_preview)
     end
 
     def disable_shared_link_for_folder(folder_id)
+      folder_id = ensure_id(folder_id)
       uri = "#{FOLDERS_URI}/#{folder_id}"
       disable_shared_link(uri, folder_id)
     end
@@ -99,6 +109,7 @@ module Boxr
     end
 
     def trashed_folder(folder_id, fields: [])
+      folder_id = ensure_id(folder_id)
       uri = "#{FOLDERS_URI}/#{folder_id}/trash"
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
       
@@ -107,12 +118,14 @@ module Boxr
     end
 
     def delete_trashed_folder(folder_id)
+      folder_id = ensure_id(folder_id)
       uri = "#{FOLDERS_URI}/#{folder_id}/trash"
       result, response = delete uri
       result
     end
 
     def restore_trashed_folder(folder_id, name: nil, parent_id: nil)
+      folder_id = ensure_id(folder_id)
       uri = "#{FOLDERS_URI}/#{folder_id}"
       restore_trashed_item(uri, name, parent_id)
     end

data/lib/boxr/groups.rb

@@ -13,6 +13,7 @@ module Boxr
     end
 
     def update_group(group_id, name)
+      group_id = ensure_id(group_id)
       uri = "#{GROUPS_URI}/#{group_id}"
       attributes = {name: name}
 
@@ -23,17 +24,20 @@ module Boxr
     alias :rename_group :update_group
 
     def delete_group(group_id)
+      group_id = ensure_id(group_id)
       uri = "#{GROUPS_URI}/#{group_id}"
       result, response = delete(uri)
       result
     end
 
     def group_memberships(group_id)
+      group_id = ensure_id(group_id)
       uri = "#{GROUPS_URI}/#{group_id}/memberships"
       memberships = get_with_pagination(uri)
     end
 
     def group_memberships_for_user(user_id)
+      user_id = ensure_id(user_id)
       uri = "#{USERS_URI}/#{user_id}/memberships"
       memberships = get_with_pagination(uri)
     end
@@ -44,12 +48,16 @@ module Boxr
     end
 
     def group_membership(membership_id)
+      membership_id = ensure_id(membership_id)
       uri = "#{GROUP_MEMBERSHIPS_URI}/#{membership_id}"
       membership, response = get(uri)
       membership
     end
 
     def add_user_to_group(user_id, group_id, role: nil)
+      user_id = ensure_id(user_id)
+      group_id = ensure_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)
@@ -57,6 +65,7 @@ module Boxr
     end
 
     def update_group_membership(membership_id, role)
+      membership_id = ensure_id(membership_id)
       uri = "#{GROUP_MEMBERSHIPS_URI}/#{membership_id}"
       attributes = {role: role}
       updated_membership, response = put(uri, attributes)
@@ -64,12 +73,14 @@ module Boxr
     end
 
     def delete_group_membership(membership_id)
+      membership_id = ensure_id(membership_id)
       uri = "#{GROUP_MEMBERSHIPS_URI}/#{membership_id}"
       result, response = delete(uri)
       result
     end
 
     def group_collaborations(group_id)
+      group_id = ensure_id(group_id)
       uri = "#{GROUPS_URI}/#{group_id}/collaborations"
       collaborations = get_with_pagination(uri)
     end

data/lib/boxr/metadata.rb

@@ -2,24 +2,28 @@ module Boxr
   class Client
 
     def create_metadata(file_id, metadata, type: :properties)
+      file_id = ensure_id(file_id)
       uri = "#{METADATA_URI}/#{file_id}/metadata/#{type}"
       metadata, response = post uri, metadata, content_type: "application/json"
       metadata
     end
 
     def metadata(file_id, type: :properties)
+      file_id = ensure_id(file_id)
       uri = "#{METADATA_URI}/#{file_id}/metadata/#{type}"
       metadata, response = get uri
       metadata
     end
 
     def update_metadata(file_id, updates, type: :properties)
+      file_id = ensure_id(file_id)
       uri = "#{METADATA_URI}/#{file_id}/metadata/#{type}"
       metadata, response = put uri, updates, content_type: "application/json-patch+json"
       metadata
     end
 
     def delete_metadata(file_id, type: :properties)
+      file_id = ensure_id(file_id)
       uri = "#{METADATA_URI}/#{file_id}/metadata/#{type}"
       result, response = delete uri
       result

data/lib/boxr/tasks.rb

@@ -2,6 +2,7 @@ module Boxr
   class Client
 
     def file_tasks(file_id, fields: [])
+      file_id = ensure_id(file_id)
       uri = "#{FILES_URI}/#{file_id}/tasks"
       query = build_fields_query(fields, TASK_FIELDS_QUERY)
 
@@ -10,6 +11,7 @@ module Boxr
     end
 
     def create_task(file_id, action: :review, message: nil, due_at: nil)
+      file_id = ensure_id(file_id)
       attributes = {item: {type: :file, id: file_id}}
       attributes[:action] = action unless action.nil?
       attributes[:message] = message unless message.nil?
@@ -20,12 +22,14 @@ module Boxr
     end
 
     def task(task_id)
+      task_id = ensure_id(task_id)
       uri = "#{TASKS_URI}/#{task_id}"
       task, response = get uri
       task
     end
 
     def update_task(task_id, action: :review, message: nil, due_at: nil)
+      task_id = ensure_id(task_id)
       uri = "#{TASKS_URI}/#{task_id}"
       attributes = {}
       attributes[:action] = action unless action.nil?
@@ -37,18 +41,21 @@ module Boxr
     end
 
     def delete_task(task_id)
+      task_id = ensure_id(task_id)
       uri = "#{TASKS_URI}/#{task_id}"
       result, response = delete uri
       result
     end
 
     def task_assignments(task_id)
+      task_id = ensure_id(task_id)
       uri = "#{TASKS_URI}/#{task_id}/assignments"
       assignments, response = get uri
       assignments['entries']
     end
 
     def create_task_assignment(task_id, assign_to_id: nil, assign_to_login: nil)
+      task_id = ensure_id(task_id)
       attributes = {task: {type: :task, id: "#{task_id}"}}
       
       attributes[:assign_to] = {} 
@@ -60,18 +67,21 @@ module Boxr
     end
 
     def task_assignment(task_id)
+      task_id = ensure_id(task_id)
       uri = "#{TASK_ASSIGNMENTS_URI}/#{task_id}"
       task_assignment, response = get uri
       task_assignment
     end
 
     def delete_task_assignment(task_id)
+      task_id = ensure_id(task_id)
       uri = "#{TASK_ASSIGNMENTS_URI}/#{task_id}"
       result, response = delete uri
       result
     end
 
     def update_task_assignment(task_id, message: nil, resolution_state: nil)
+      task_id = ensure_id(task_id)
       uri = "#{TASK_ASSIGNMENTS_URI}/#{task_id}"
       attributes = {}
       attributes[:message] = message unless message.nil?

data/lib/boxr/users.rb

@@ -11,6 +11,7 @@ module Boxr
     alias :me :current_user
 
     def user(user_id, fields: [])
+      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)
@@ -55,6 +56,7 @@ module Boxr
                              can_see_managed_users: nil, status: nil, timezone: nil, is_exempt_from_device_limits: nil,
                              is_exempt_from_login_verification: nil, is_exempt_from_reset_required: nil, is_external_collab_restricted: nil)
 
+      user_id = ensure_id(user_id)
       uri = "#{USERS_URI}/#{user_id}"
       query = {notify: notify} unless notify.nil?
       
@@ -82,6 +84,7 @@ module Boxr
     end
 
     def delete_user(user_id, notify: nil, force: nil)
+      user_id = ensure_id(user_id)
       uri = "#{USERS_URI}/#{user_id}"
       query = {}
       query[:notify] = notify unless notify.nil?

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/boxr_spec.rb

@@ -40,65 +40,65 @@ describe Boxr::Client do
     root_folders = BOX_CLIENT.root_folder_items.folders
     test_folder = root_folders.find{|f| f.name == TEST_FOLDER_NAME}
     if(test_folder)
-      BOX_CLIENT.delete_folder(test_folder.id, recursive: true)
+      BOX_CLIENT.delete_folder(test_folder, recursive: true)
     end
     new_folder = BOX_CLIENT.create_folder(TEST_FOLDER_NAME, Boxr::ROOT)
-    @test_folder_id = new_folder.id
+    @test_folder = new_folder
 
     all_users = BOX_CLIENT.all_users
     test_user = all_users.find{|u| u.name == TEST_USER_NAME}
     if(test_user)
-      BOX_CLIENT.delete_user(test_user.id, force: true)
+      BOX_CLIENT.delete_user(test_user, force: true)
     end
     sleep BOX_SERVER_SLEEP
     test_user = BOX_CLIENT.create_user(TEST_USER_LOGIN, TEST_USER_NAME)
-    @test_user_id = test_user.id
+    @test_user = test_user
 
     all_groups = BOX_CLIENT.groups
     test_group = all_groups.find{|g| g.name == TEST_GROUP_NAME}
     if(test_group)
-      BOX_CLIENT.delete_group(test_group.id)
+      BOX_CLIENT.delete_group(test_group)
     end
   end
 
   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)
+    expect(folder.id).to eq(@test_folder.id)
 
     puts "get folder info"
-    folder = BOX_CLIENT.folder(@test_folder_id)
-    expect(folder.id).to eq(@test_folder_id)
+    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_id)
+    new_folder = BOX_CLIENT.create_folder(SUB_FOLDER_NAME, @test_folder)
     expect(new_folder).to be_a Hashie::Mash
-    SUB_FOLDER_ID = new_folder.id
+    SUB_FOLDER = new_folder
 
     puts "update folder"
-    updated_folder = BOX_CLIENT.update_folder(SUB_FOLDER_ID, description: SUB_FOLDER_DESCRIPTION)
+    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_ID,@test_folder_id, name: 'copy of sub_folder_1')
+    new_folder = BOX_CLIENT.copy_folder(SUB_FOLDER,@test_folder, name: 'copy of sub_folder_1')
     expect(new_folder).to be_a Hashie::Mash
-    SUB_FOLDER_COPY_ID = new_folder.id
+    SUB_FOLDER_COPY = new_folder
 
     puts "create shared link for folder"
-    updated_folder = BOX_CLIENT.create_shared_link_for_folder(@test_folder_id, access: :open)
+    updated_folder = BOX_CLIENT.create_shared_link_for_folder(@test_folder, access: :open)
     expect(updated_folder.shared_link.access).to eq("open")
     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)
+    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_id)
+    updated_folder = BOX_CLIENT.disable_shared_link_for_folder(@test_folder)
     expect(updated_folder.shared_link).to be_nil
 
     puts "delete folder"
-    result = BOX_CLIENT.delete_folder(SUB_FOLDER_COPY_ID, recursive: true)
+    result = BOX_CLIENT.delete_folder(SUB_FOLDER_COPY, recursive: true)
     expect(result).to eq ({})
 
     puts "inspect the trash"
@@ -106,44 +106,44 @@ describe Boxr::Client do
     expect(trash).to be_a Array
 
     puts "inspect trashed folder"
-    trashed_folder = BOX_CLIENT.trashed_folder(SUB_FOLDER_COPY_ID)
+    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_ID)
+    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_ID, recursive: true)
-    result = BOX_CLIENT.delete_trashed_folder(SUB_FOLDER_COPY_ID)
+    BOX_CLIENT.delete_folder(SUB_FOLDER_COPY, recursive: true)
+    result = BOX_CLIENT.delete_trashed_folder(SUB_FOLDER_COPY)
     expect(result).to eq({})
   end
 
   it "invokes file operations" do
     puts "upload a file"
-    new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder_id)
+    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_id = new_file.id
+    test_file = new_file
 
     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)
+    expect(file.id).to eq(test_file.id)
 
     puts "get file download url"
-    download_url = BOX_CLIENT.download_url(test_file_id)
+    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_id)
-    expect(file_info.id).to eq(test_file_id)
+    file_info = BOX_CLIENT.file(test_file)
+    expect(file_info.id).to eq(test_file.id)
 
     puts "update file"
     new_description = 'this file is used to test Boxr'
-    updated_file_info = BOX_CLIENT.update_file(test_file_id, description: new_description)
+    updated_file_info = BOX_CLIENT.update_file(test_file, description: new_description)
     expect(updated_file_info.description).to eq(new_description)
 
     puts "download file"
-    file = BOX_CLIENT.download_file(test_file_id)
+    file = BOX_CLIENT.download_file(test_file)
     f = open("./spec/test_files/#{DOWNLOADED_TEST_FILE_NAME}", 'w+')
     f.write(file)
     f.close
@@ -151,57 +151,57 @@ describe Boxr::Client do
     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_id)
-    expect(new_version.id).to eq(test_file_id)
+    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_id)
+    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_id = versions.first.id
+    v1 = versions.first
 
     puts "promote old version of file"
-    newer_version = BOX_CLIENT.promote_old_version_of_file(test_file_id, v1_id)
-    versions = BOX_CLIENT.versions_of_file(test_file_id)
+    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_id,v1_id)
-    versions = BOX_CLIENT.versions_of_file(test_file_id)
+    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_id)
+    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_id, access: :open)
+    updated_file = BOX_CLIENT.create_shared_link_for_file(test_file, access: :open)
     expect(updated_file.shared_link.access).to eq("open")
 
     puts "disable shared link for file"
-    updated_file = BOX_CLIENT.disable_shared_link_for_file(test_file_id)
+    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_id, @test_folder_id, name: new_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_ID = new_file.id
+    NEW_FILE = new_file
 
     puts "delete file"
-    result = BOX_CLIENT.delete_file(NEW_FILE_ID)
+    result = BOX_CLIENT.delete_file(NEW_FILE)
     expect(result).to eq({})
 
     puts "get trashed file info"
-    trashed_file = BOX_CLIENT.trashed_file(NEW_FILE_ID)
+    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_ID)
+    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_ID)
-    result = BOX_CLIENT.delete_trashed_file(NEW_FILE_ID)
+    BOX_CLIENT.delete_file(NEW_FILE)
+    result = BOX_CLIENT.delete_trashed_file(NEW_FILE)
     expect(result).to eq({})
   end
 
@@ -213,23 +213,23 @@ describe Boxr::Client do
     expect(user.role).to_not be_nil
 
     puts "inspect a user"
-    user = BOX_CLIENT.user(@test_user_id)
-    expect(user.id).to eq(@test_user_id)
+    user = BOX_CLIENT.user(@test_user)
+    expect(user.id).to eq(@test_user.id)
 
     puts "inspect all users"
     all_users = BOX_CLIENT.all_users()
-    test_user = all_users.find{|u| u.id == @test_user_id}
+    test_user = all_users.find{|u| u.id == @test_user.id}
     expect(test_user).to_not be_nil
 
     puts "update user"
     new_name = "Chuck Nevitt"
-    user = BOX_CLIENT.update_user(@test_user_id, name: new_name)
+    user = BOX_CLIENT.update_user(@test_user, name: new_name)
     expect(user.name).to eq(new_name)
 
     #create user is tested in the before method
 
     puts "delete user"
-    result = BOX_CLIENT.delete_user(@test_user_id, force: true)
+    result = BOX_CLIENT.delete_user(@test_user, force: true)
     expect(result).to eq({})
   end
 
@@ -237,7 +237,6 @@ describe Boxr::Client do
     puts "create group"
     group = BOX_CLIENT.create_group(TEST_GROUP_NAME)
     expect(group.name).to eq(TEST_GROUP_NAME)
-    test_group_id = group.id
 
     puts "inspect groups"
     groups = BOX_CLIENT.groups
@@ -246,30 +245,30 @@ describe Boxr::Client do
 
     puts "update group"
     new_name = "Test Boxr Group Renamed"
-    group = BOX_CLIENT.update_group(test_group_id, new_name)
+    group = BOX_CLIENT.update_group(test_group, new_name)
     expect(group.name).to eq(new_name)
-    group = BOX_CLIENT.rename_group(test_group_id,TEST_GROUP_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_id, test_group_id)
-    expect(group_membership.user.id).to eq(@test_user_id)
-    expect(group_membership.group.id).to eq(test_group_id)
-    membership_id = group_membership.id
+    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_id)
-    expect(group_membership.id).to eq(membership_id)
+    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_id)
+    group_memberships = BOX_CLIENT.group_memberships(test_group)
     expect(group_memberships.count).to eq(1)
-    expect(group_memberships.first.id).to eq(membership_id)
+    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_id)
+    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)
+    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
@@ -277,77 +276,77 @@ describe Boxr::Client do
     expect(group_memberships).to be_a(Array)
 
     puts "update group membership"
-    group_membership = BOX_CLIENT.update_group_membership(membership_id, :admin)
+    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_id)
+    result = BOX_CLIENT.delete_group_membership(membership)
     expect(result).to eq({})
-    group_memberships = BOX_CLIENT.group_memberships_for_user(@test_user_id)
+    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, {id: test_group_id, type: :group}, :editor)
-    expect(group_collaboration.accessible_by.id).to eq(test_group_id)
+    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_id)
+    response = BOX_CLIENT.delete_group(test_group)
     expect(response).to eq({})
   end
 
   it "invokes comment operations" do 
-    new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder_id)
-    test_file_id = new_file.id
+    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_id, message: COMMENT_MESSAGE)
+    comment = BOX_CLIENT.add_comment_to_file(test_file, message: COMMENT_MESSAGE)
     expect(comment.message).to eq(COMMENT_MESSAGE)
-    COMMENT_ID = comment.id
+    COMMENT = comment
 
     puts "reply to comment"
-    reply = BOX_CLIENT.reply_to_comment(COMMENT_ID, message: REPLY_MESSAGE)
+    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_id)
+    comments = BOX_CLIENT.file_comments(test_file)
     expect(comments.count).to eq(2)
 
     puts "update a comment"
-    comment = BOX_CLIENT.change_comment(COMMENT_ID, CHANGED_COMMENT_MESSAGE)
+    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_ID)
-    expect(comment.id).to eq(COMMENT_ID)
+    comment = BOX_CLIENT.comment(COMMENT)
+    expect(comment.id).to eq(COMMENT.id)
 
     puts "delete comment"
-    result = BOX_CLIENT.delete_comment(COMMENT_ID)
+    result = BOX_CLIENT.delete_comment(COMMENT)
     expect(result).to eq({})
   end
 
   it "invokes collaborations operations" do
     puts "add collaboration"
-    collaboration = BOX_CLIENT.add_collaboration(@test_folder_id, {id: @test_user_id, type: :user}, :editor)
-    expect(collaboration.accessible_by.id).to eq(@test_user_id)
-    collaboration_id = collaboration.id
+    collaboration = BOX_CLIENT.add_collaboration(@test_folder, {id: @test_user.id, type: :user}, :editor)
+    expect(collaboration.accessible_by.id).to eq(@test_user.id)
+    COLLABORATION = collaboration
 
     puts "inspect collaboration"
-    collaboration = BOX_CLIENT.collaboration(collaboration_id)
-    expect(collaboration.id).to eq(collaboration_id)
+    collaboration = BOX_CLIENT.collaboration(COLLABORATION)
+    expect(collaboration.id).to eq(COLLABORATION.id)
 
     puts "edit collaboration"
-    collaboration = BOX_CLIENT.edit_collaboration(collaboration_id, role: "viewer uploader")
+    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_id)
+    collaborations = BOX_CLIENT.folder_collaborations(@test_folder)
     expect(collaborations.count).to eq(1)
-    expect(collaborations[0].id).to eq(collaboration_id)
+    expect(collaborations[0].id).to eq(COLLABORATION.id)
 
     puts "remove collaboration"
-    result = BOX_CLIENT.remove_collaboration(collaboration_id)
+    result = BOX_CLIENT.remove_collaboration(COLLABORATION)
     expect(result).to eq({})
-    collaborations = BOX_CLIENT.folder_collaborations(@test_folder_id)
+    collaborations = BOX_CLIENT.folder_collaborations(@test_folder)
     expect(collaborations.count).to eq(0)
 
     puts "inspect pending collaborations"
@@ -356,79 +355,78 @@ describe Boxr::Client do
   end
 
   it "invokes task operations" do
-    new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder_id)
-    test_file_id = new_file.id
-    collaboration = BOX_CLIENT.add_collaboration(@test_folder_id, {id: @test_user_id, type: :user}, :editor)
+    test_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder)
+    collaboration = BOX_CLIENT.add_collaboration(@test_folder, {id: @test_user.id, type: :user}, :editor)
 
     puts "create task"
-    new_task = BOX_CLIENT.create_task(test_file_id, message: TEST_TASK_MESSAGE)
+    new_task = BOX_CLIENT.create_task(test_file, message: TEST_TASK_MESSAGE)
     expect(new_task.message).to eq(TEST_TASK_MESSAGE)
-    TEST_TASK_ID = new_task.id
+    TEST_TASK = new_task
 
     puts "inspect file tasks"
-    tasks = BOX_CLIENT.file_tasks(test_file_id)
-    expect(tasks.first.id).to eq(TEST_TASK_ID)
+    tasks = BOX_CLIENT.file_tasks(test_file)
+    expect(tasks.first.id).to eq(TEST_TASK.id)
 
     puts "inspect task"
-    task = BOX_CLIENT.task(TEST_TASK_ID)
-    expect(task.id).to eq(TEST_TASK_ID)
+    task = BOX_CLIENT.task(TEST_TASK)
+    expect(task.id).to eq(TEST_TASK.id)
 
     puts "update task"
     NEW_TASK_MESSAGE = "new task message"
-    updated_task = BOX_CLIENT.update_task(TEST_TASK_ID, message: NEW_TASK_MESSAGE)
+    updated_task = BOX_CLIENT.update_task(TEST_TASK, message: NEW_TASK_MESSAGE)
     expect(updated_task.message).to eq(NEW_TASK_MESSAGE)
 
     puts "create task assignment"
-    task_assignment = BOX_CLIENT.create_task_assignment(TEST_TASK_ID, assign_to_id: @test_user_id)
-    expect(task_assignment.assigned_to.id).to eq(@test_user_id)
-    task_assignment_id = task_assignment.id
+    task_assignment = BOX_CLIENT.create_task_assignment(TEST_TASK, assign_to_id: @test_user.id)
+    expect(task_assignment.assigned_to.id).to eq(@test_user.id)
+    TASK_ASSIGNMENT = task_assignment
 
     puts "inspect task assignment"
-    task_assignment = BOX_CLIENT.task_assignment(task_assignment_id)
-    expect(task_assignment.id).to eq(task_assignment_id)
+    task_assignment = BOX_CLIENT.task_assignment(TASK_ASSIGNMENT)
+    expect(task_assignment.id).to eq(TASK_ASSIGNMENT.id)
 
     puts "inspect task assignments"
-    task_assignments = BOX_CLIENT.task_assignments(TEST_TASK_ID)
+    task_assignments = BOX_CLIENT.task_assignments(TEST_TASK)
     expect(task_assignments.count).to eq(1)
-    expect(task_assignments[0].id).to eq(task_assignment_id)
+    expect(task_assignments[0].id).to eq(TASK_ASSIGNMENT.id)
 
     #TODO: can't do this test yet because the test user needs to confirm their email address before you can do this
     puts "update task assignment"
     expect {
-              box_client_as_test_user = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'], as_user_id: @test_user_id)
+              box_client_as_test_user = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'], as_user_id: @test_user.id)
               new_message = "Updated task message"
-              task_assignment = box_client_as_test_user.update_task_assignment(TEST_TASK_ID, resolution_state: :completed)
+              task_assignment = box_client_as_test_user.update_task_assignment(TEST_TASK, resolution_state: :completed)
               expect(task_assignment.resolution_state).to eq('completed')
             }.to raise_error
 
     puts "delete task assignment"
-    result = BOX_CLIENT.delete_task_assignment(task_assignment_id)
+    result = BOX_CLIENT.delete_task_assignment(TASK_ASSIGNMENT)
     expect(result).to eq({})
 
     puts "delete task"
-    result = BOX_CLIENT.delete_task(TEST_TASK_ID)
+    result = BOX_CLIENT.delete_task(TEST_TASK)
     expect(result).to eq({})
   end
 
   it "invokes metadata operations" do
-    new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder_id)
-    test_file_id = new_file.id
+    test_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder)
+    #test_file_id = new_file.id
 
     puts "create metadata"
     meta = {"a" => "hello", "b" => "world"}
-    metadata = BOX_CLIENT.create_metadata(test_file_id, meta)
+    metadata = BOX_CLIENT.create_metadata(test_file, meta)
     expect(metadata.a).to eq("hello")
 
     puts "update metadata"
-    metadata = BOX_CLIENT.update_metadata(test_file_id, [{op: :replace, path: "/b", value: "there"}])
+    metadata = BOX_CLIENT.update_metadata(test_file, [{op: :replace, path: "/b", value: "there"}])
     expect(metadata.b).to eq("there")
 
     puts "get metadata"
-    metadata = BOX_CLIENT.metadata(test_file_id)
+    metadata = BOX_CLIENT.metadata(test_file)
     expect(metadata.a).to eq("hello")
 
     puts "delete metadata"
-    result = BOX_CLIENT.delete_metadata(test_file_id)
+    result = BOX_CLIENT.delete_metadata(test_file)
     expect(result).to eq({})
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chad Burnette