boxr 0.0.1

data/lib/boxr/comments.rb

@@ -0,0 +1,45 @@
+module Boxr
+	class Client
+
+		def add_comment_to_file(file_id, message: nil, tagged_message: nil)
+			add_comment(:file, file_id, message, tagged_message)
+		end
+
+		def reply_to_comment(comment_id, message: nil, tagged_message: nil)
+			add_comment(:comment, comment_id, message, tagged_message)
+		end
+
+		def change_comment(comment_id, message)
+			uri = "#{COMMENTS_URI}/#{comment_id}"
+			attributes = {message: message}
+			updated_comment, response = put uri, attributes
+			updated_comment
+		end
+
+		def comment_info(comment_id, fields: [])
+			uri ="#{COMMENTS_URI}/#{comment_id}"
+			comment, response = get uri
+			comment
+		end
+
+		def delete_comment(comment_id)
+			uri = "#{COMMENTS_URI}/#{comment_id}"
+			result, response = delete uri
+			result
+		end
+
+
+		private
+
+		def add_comment(type, id, message, tagged_message)
+			uri = COMMENTS_URI
+			attributes = {item: {type: type, id: id}}
+			attributes[:message] = message unless message.nil?
+			attributes[:tagged_message] = tagged_message unless tagged_message.nil?
+
+			new_comment, response = post uri, attributes
+			new_comment
+		end
+
+	end
+end

data/lib/boxr/exceptions.rb

@@ -0,0 +1,39 @@
+module Boxr
+
+	class BoxrException < Exception
+
+		attr_reader :response_body, :type, :status, :code, :help_uri, :box_message, :request_id
+
+		def initialize(status,body,header)
+			@status = status
+			@response_body = body
+			@header = header
+
+			body_json = Oj.load(body)
+			if body_json
+				@type = body_json["type"]
+				@box_status = body_json["status"]
+				@code = body_json["code"]
+				@help_uri = body_json["help_uri"]
+				@box_message = body_json["message"]
+				@request_id = body_json["request_id"]
+			end
+		end
+
+		def message
+			auth_header = @header['WWW-Authenticate']
+			if(auth_header)
+				"#{@status}: #{auth_header}"
+			elsif(!@box_message.blank?)
+				"#{@status}: #{@box_message}"
+			else
+				"#{@status}: #{@response_body}"
+			end
+		end
+
+		def to_s
+			message
+		end
+	end
+
+end

data/lib/boxr/files.rb

@@ -0,0 +1,200 @@
+module Boxr
+	class Client
+
+		def file_info(file_id, fields: [])
+			uri = "#{FILES_URI}/#{file_id}"
+			query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
+			file, response = get uri, query: query
+			file
+		end
+
+		def update_file_info(file_id, name: nil, description: nil, parent_id: nil, shared_link: nil, tags: nil, if_match: nil)
+			uri = "#{FILES_URI}/#{file_id}"
+
+			attributes = {}
+			attributes[:name] = name unless name.nil?
+			attributes[:description] = description unless description.nil?
+			attributes[:parent_id] = {id: parent_id} unless parent_id.nil?
+			attributes[:shared_link] = shared_link unless shared_link.nil?
+			attributes[:tags] = tags unless tags.nil? 
+
+			updated_file, response = put uri, attributes, if_match: if_match
+			updated_file
+		end
+
+		def download_file(file_id, version: nil)
+			begin
+				uri = "#{FILES_URI}/#{file_id}/content"
+				query = {}
+				query[:version] = version unless version.nil?
+				body_json, response = get uri, query: query, success_codes: [302,202]
+
+				if(response.status==302)
+					location = response.header['Location'][0]
+					file, response = get location, process_response: false
+				elsif(response.status==202)
+					retry_after_seconds = response.header['Retry-After'][0]
+					sleep retry_after_seconds.to_i
+				end
+			end until file
+
+			file
+		end
+
+		def upload_file(path_to_file, parent_id, content_created_at: nil, content_modified_at: nil, 
+										preflight_check: true, send_content_md5: true)
+
+			preflight_check(path_to_file, parent_id) if preflight_check
+
+			file_info = nil
+			response = nil
+
+			File.open(path_to_file) do |file|
+				content_md5 = send_content_md5 ? Digest::SHA1.file(file).hexdigest : nil
+				attributes = {filename: file, 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?
+				file_info, response = post FILES_UPLOAD_URI, attributes, process_body: false, content_md5: content_md5
+			end
+
+			file_info["entries"][0]
+		end
+
+		def delete_file(file_id, if_match: nil)
+			uri = "#{FILES_URI}/#{file_id}"
+			result, response = delete uri, if_match: if_match
+			result
+		end
+
+		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)
+
+			preflight_check_new_version_of_file(path_to_file, file_id) if preflight_check
+
+			uri = "#{UPLOAD_URI}/files/#{file_id}/content"
+			file_info = nil
+			response = nil
+
+			File.open(path_to_file) do |file|
+				content_md5 = send_content_md5 ? Digest::SHA1.file(file).hexdigest : nil
+				attributes = {filename: file}
+				attributes[:content_modified_at] = content_modified_at.to_datetime.rfc3339 unless content_modified_at.nil?
+				file_info, response = post uri, attributes, process_body: false, content_md5: content_md5, if_match: if_match
+			end
+
+			file_info["entries"][0]
+		end
+
+		def versions_of_file(file_id)
+			uri = "#{FILES_URI}/#{file_id}/versions"
+			versions, response = get uri
+			versions["entries"]
+		end
+
+		def download_old_version_of_file
+
+		end
+
+		def promote_old_version_of_file(file_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
+			new_version
+		end
+
+		def delete_old_version_of_file(file_id, file_version_id, if_match: nil)
+			uri = "#{FILES_URI}/#{file_id}/versions/#{file_version_id}"
+			body_json, res = delete uri, if_match: if_match
+			body_json
+		end
+
+		def copy_file(file_id, parent_id, name: nil)
+			uri = "#{FILES_URI}/#{file_id}/copy"
+			attributes = {:parent => {:id => parent_id}}
+			attributes[:name] = name unless name.nil?
+			new_file, res = post uri, attributes
+			new_file
+		end
+
+		def thumbnail(file_id, min_height: nil, min_width: nil, max_height: nil, max_width: nil)
+			uri = "#{FILES_URI}/#{file_id}/thumbnail.png"
+			query = {}
+			query[:min_height] = min_height unless min_height.nil?
+			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
+
+			if(response.status==202 || response.status==302)
+				location = response.header['Location'][0]
+				thumbnail, response = get location, process_response: false
+			else #200
+				thumbnail = body
+			end
+
+			thumbnail
+		end
+
+		def create_shared_link_for_file(file_id, access: nil, unshared_at: nil, can_download: nil, can_preview: nil)
+			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)
+			uri = "#{FILES_URI}/#{file_id}"
+			disable_shared_link(uri, file_id)
+		end
+
+		def trashed_file(file_id)
+			uri = "#{FILES_URI}/#{file_id}/trash"
+			trashed_file, response = get uri
+			trashed_file
+		end
+
+		def delete_trashed_file(file_id)
+			uri = "#{FILES_URI}/#{file_id}/trash"
+
+			result, response = delete uri
+			result
+		end
+
+		def restore_trashed_file(file_id, name: nil, parent_id: nil)
+			uri = "#{FILES_URI}/#{file_id}"
+			restore_trashed_item(uri, name, parent_id)
+		end
+
+		def file_comments(file_id, fields: [])
+			uri = "#{FILES_URI}/#{file_id}/comments"
+			query = build_fields_query(fields, COMMENT_FIELDS_QUERY)
+
+			comments = get_with_pagination uri, query: query
+		end
+
+		def file_tasks(file_id, fields: [])
+			uri = "#{FILES_URI}/#{file_id}/tasks"
+			query = build_fields_query(fields, TASK_FIELDS_QUERY)
+
+			tasks, response = get uri, query: query
+			tasks["entries"]
+		end
+
+
+		private
+
+		def preflight_check(path_to_file, parent_id)
+			size = File.size(path_to_file)
+			
+			#TODO: need to make sure that figuring out the filename from the path_to_file works for people using Winblows
+			filename = File.basename(path_to_file)
+			attributes = {"name" => filename, "parent" => {"id" => "#{parent_id}"}, "size" => size}
+			body_json, res = options "#{FILES_URI}/content", attributes
+		end
+
+		def preflight_check_new_version_of_file(path_to_file, file_id)
+			size = File.size(path_to_file)
+			attributes = {"size" => size}
+			body_json, res = options "#{FILES_URI}/#{file_id}/content", attributes
+		end
+
+	end
+end

data/lib/boxr/folders.rb

@@ -0,0 +1,105 @@
+module Boxr
+	class Client
+
+		def folder_items(folder_id, fields: [])
+			query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
+			uri = "#{FOLDERS_URI}/#{folder_id}/items"
+
+			items = get_with_pagination uri, query: query, limit: FOLDER_ITEMS_LIMIT
+		end
+
+		def create_folder(name, parent_id)
+			uri = "#{FOLDERS_URI}"
+			attributes = {:name => name, :parent => {:id => parent_id}}
+			
+			created_folder, response = post uri, attributes
+			created_folder
+		end
+
+		def folder_info(folder_id, fields: [])
+			query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
+			uri = "#{FOLDERS_URI}/#{folder_id}"
+
+			folder, response = get uri, query: query
+			folder
+		end
+
+		def update_folder_info(folder_id, name: nil, description: nil, parent_id: nil, shared_link: nil,
+													 folder_upload_email: nil, owned_by_id: nil, sync_state: nil, tags: nil,
+													 can_non_owners_invite: nil, if_match: nil)
+			uri = "#{FOLDERS_URI}/#{folder_id}"
+
+			attributes = {}
+			attributes[:name] = name unless name.nil?
+			attributes[:description] = description unless description.nil?
+			attributes[:parent_id] = {id: parent_id} unless parent_id.nil?
+			attributes[:shared_link] = shared_link unless shared_link.nil?
+			attributes[:folder_upload_email] = folder_upload_email unless folder_upload_email.nil?
+			attributes[:owned_by_id] = {owned_by: 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
+		end
+
+		def delete_folder(folder_id, recursive: false, if_match: nil)
+			uri = "#{FOLDERS_URI}/#{folder_id}"
+			query = {:recursive => recursive}
+
+			result, response = delete uri, query, if_match: if_match
+			result
+		end
+
+		def copy_folder(folder_id, dest_folder_id, name: nil)
+			uri = "#{FOLDERS_URI}/#{folder_id}/copy"
+			attributes = {:parent => {:id => dest_folder_id}}
+			attributes[:name] = name unless name.nil?
+
+			new_folder, response = post uri, attributes
+			new_folder
+		end
+
+	  def create_shared_link_for_folder(folder_id, access: nil, unshared_at: nil, can_download: nil, can_preview: nil)
+			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)
+			uri = "#{FOLDERS_URI}/#{folder_id}"
+			disable_shared_link(uri, folder_id)
+		end
+
+		def folder_collaborations(folder_id)
+			uri = "#{FOLDERS_URI}/#{folder_id}/collaborations"
+			collaborations, response = get uri
+			collaborations
+		end
+
+		def trash(fields: [])
+			uri = "#{FOLDERS_URI}/trash/items"
+			query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
+
+			items = get_with_pagination uri, query: query, limit: FOLDER_ITEMS_LIMIT
+		end
+
+		def trashed_folder(folder_id)
+			uri = "#{FOLDERS_URI}/#{folder_id}/trash"
+			item, response = get uri
+			item
+		end
+
+		def delete_trashed_folder(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)
+			uri = "#{FOLDERS_URI}/#{folder_id}"
+			restore_trashed_item(uri, name, parent_id)
+		end
+
+	end
+end

data/lib/boxr/groups.rb

@@ -0,0 +1,76 @@
+module Boxr
+	class Client
+
+		def groups(fields: [])
+			query = build_fields_query(fields, GROUP_FIELDS_QUERY)
+			groups = get_with_pagination(GROUPS_URI, query: query)
+		end
+
+		def create_group(name)
+			attributes = {name: name}
+			new_group, response = post(GROUPS_URI, attributes)
+			new_group 
+		end
+
+		def update_group(group_id, name)
+			uri = "#{GROUPS_URI}/#{group_id}"
+			attributes = {name: name}
+
+			updated_group, response = put(uri, attributes)
+			updated_group
+		end
+
+		def delete_group(group_id)
+			uri = "#{GROUPS_URI}/#{group_id}"
+			result, response = delete(uri)
+			result
+		end
+
+		def group_memberships(group_id)
+			uri = "#{GROUPS_URI}/#{group_id}/memberships"
+			memberships = get_with_pagination(uri)
+		end
+
+		def group_memberships_for_user(user_id)
+			uri = "#{USERS_URI}/#{user_id}/memberships"
+			memberships = get_with_pagination(uri)
+		end
+
+		def group_memberships_for_me
+			uri = "#{USERS_URI}/me/memberships"
+			memberships = get_with_pagination(uri)
+		end
+
+		def group_membership(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)
+			attributes = {user: {id: user_id}, group: {id: group_id}}
+			attributes[:role] = role unless role.nil?
+			membership, response = post(GROUP_MEMBERSHIPS_URI, attributes)
+			membership
+		end
+
+		def update_group_membership(membership_id, role)
+			uri = "#{GROUP_MEMBERSHIPS_URI}/#{membership_id}"
+			attributes = {role: role}
+			updated_membership, response = put(uri, attributes)
+			updated_membership
+		end
+
+		def delete_group_membership(membership_id)
+			uri = "#{GROUP_MEMBERSHIPS_URI}/#{membership_id}"
+			result, response = delete(uri)
+			result
+		end
+
+		def group_collaborations(group_id)
+			uri = "#{GROUPS_URI}/#{group_id}/collaborations"
+			collaborations = get_with_pagination(uri)
+		end
+
+	end
+end