Ruby Requires Chilkat v11.7.0+

Box: Create a Project Folder, Upload, Tag, and Link a Document

See more Box Examples

Run the reusable setup once per HttpCurl object, then select names and execute the operation. The setup is repeated here only to make this published example independently runnable. Resolve the parent documents folder by name, create a new project folder, upload a document, apply pre-existing projectDocument metadata, and create a collaborators-only link. Creation outputs remain cached for subsequent operations; the engine resolves the enterprise scope only when metadata needs it. Multipart formatting and deliberate writes remain explicit.

See the Box API guide for setup and the complete workflow.

Ruby

require 'chilkat'

success = false

#  Requires Chilkat 11.7.0 or later and a previously unlocked Chilkat bundle.
#  See Global Unlock Sample.
#  Guide: Box API Guide.

success = false

#  BEGIN ONE-TIME SETUP
#  This block is repeated so each published example can run on its own.
#  In an application, run the setup example once and pass the SAME curl object
#  to operation code below. Do not recreate it for every operation.
#  See Reusable Box HttpCurl Setup.
curl = Chilkat::CkHttpCurl.new()
curl.SetVar("access_token","BOX_ACCESS_TOKEN")
curl.SetVar("parent_name","/")
#  Box's fixed root ID is an implementation detail; callers supply names.
curl.SetVar("parent_id","0")
setupCommand = Chilkat::CkStringBuilder.new()

#  Register findParent; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.getVar("access_token"))
success = curl.AddFunction("findParent",setupCommand.getAsString())
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

#  Register findFolder; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/folders/{{parent_id}}/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.getVar("access_token"))
success = curl.AddFunction("findFolder",setupCommand.getAsString())
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

#  Register findFile; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/folders/{{folder_id}}/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.getVar("access_token"))
success = curl.AddFunction("findFile",setupCommand.getAsString())
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

#  Register findDestination; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name\" -H \"Authorization: Bearer ACCESS_TOKEN\"")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.getVar("access_token"))
success = curl.AddFunction("findDestination",setupCommand.getAsString())
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

#  Register getFileDetails; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version\" -H \"Authorization: Bearer ACCESS_TOKEN\"")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.getVar("access_token"))
success = curl.AddFunction("getFileDetails",setupCommand.getAsString())
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

#  Register getEnterprise; registration sends no request.
setupCommand.SetString("curl -X GET \"https://api.box.com/2.0/users/me?fields=enterprise\" -H \"Authorization: Bearer ACCESS_TOKEN\"")
setupReplacements = setupCommand.Replace("ACCESS_TOKEN",curl.getVar("access_token"))
success = curl.AddFunction("getEnterprise",setupCommand.getAsString())
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

#  Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
#  when extracting each output, using the current value at that time.
success = curl.AddOutput2("findParent","entries","name","{{parent_name}}",true,"id","parent_id")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

success = curl.AddOutput2("findFolder","entries","name","{{folder_name}}",true,"id","folder_id")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

success = curl.AddOutput2("findFile","entries","name","{{file_name}}",true,"id","file_id")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

success = curl.AddOutput2("findDestination","entries","name","{{destination_name}}",true,"id","destination_id")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

success = curl.AddOutput("getFileDetails","file_version.id","file_version_id")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

success = curl.AddOutput("getFileDetails","sha1","file_sha1")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

success = curl.AddOutput("getEnterprise","enterprise.id","enterprise_id")
if (success != true)
    print curl.lastErrorText() + "\n";
    exit
end

#  END ONE-TIME SETUP
#  The name lookups below assume each listing fits in one page (1000 items).
#  Parent and destination names select root children; folder_name selects a child
#  of parent_name. "/" selects the root parent. These are not arbitrary paths.

#  BEGIN OPERATION -- keep the configured object when reusing it.
#  Inputs are names. Retain cached IDs when the selected names have not changed.
parentName = "documents"
if ((curl.getVar("parent_name") != parentName) or ((parentName == "/") and (curl.VarDefined("parent_id") == false)))
    curl.SetVar("parent_name",parentName)
    curl.ClearVar("parent_id")
    curl.ClearVar("folder_id")
    curl.ClearVar("file_id")
    curl.ClearVar("file_version_id")
    curl.ClearVar("file_sha1")
    if (parentName == "/")
        curl.SetVar("parent_id","0")
    end

end

curl.SetVar("new_folder_name","Project CUST-1001")
#  This workflow creates a new folder. A 409 stops the example; it does not
#  silently reuse a same-named folder. Retain printed IDs if a later step fails.
curl.ClearTargetOutput("*")
curl.ClearVar("folder_id")
curl.AddTargetOutput("id","folder_id")
authorizedCommand1 = Chilkat::CkStringBuilder.new()
authorizedCommand1.SetString("curl -X POST \"https://api.box.com/2.0/folders\" -H \"Authorization: Bearer {{access_token}}\" -H \"Content-Type: application/json\" -d '{\"name\":\"{{new_folder_name}}\",\"parent\":{\"id\":\"{{parent_id}}\"}}'")
headerReplacement1 = authorizedCommand1.Replace("{{access_token}}",curl.getVar("access_token"))
success = curl.DoYourThing(authorizedCommand1.getAsString())
if ((success != true) or (curl.get_StatusCode() != 201))
    print "Box request failed. HTTP status: " + curl.get_StatusCode().to_s() + "\n";
    print "Failure reason: " + curl.get_FailReason().to_s() + "\n";
    print curl.responseBodyStr() + "\n";
    exit
end

if (curl.VarDefined("!") != true)
    print "Expected response fields are missing." + "\n";
    exit
end

print "Created folder: " + curl.getVar("folder_id") + "\n";
#  Resolve the multipart attributes field before passing the command to HttpCurl.
#  Box folder IDs come from configuration or a previous API response.
uploadCommand = Chilkat::CkStringBuilder.new()
authorizedCommand2 = Chilkat::CkStringBuilder.new()
authorizedCommand2.SetString("curl -X POST \"https://upload.box.com/api/2.0/files/content\" -H \"Authorization: Bearer {{access_token}}\" -F 'attributes={\"name\":\"invoice.pdf\",\"parent\":{\"id\":\"{{folder_id}}\"}}' -F \"file=@qa_data/pdf/invoice.pdf;type=application/pdf\"")
headerReplacement2 = authorizedCommand2.Replace("{{access_token}}",curl.getVar("access_token"))
uploadCommand.SetString(authorizedCommand2.getAsString())
replacements = uploadCommand.Replace("{{folder_id}}",curl.getVar("folder_id"))
curl.ClearTargetOutput("*")
curl.ClearVar("file_id")
curl.AddTargetOutput("entries[0].id","file_id")
success = curl.DoYourThing(uploadCommand.getAsString())
if ((success != true) or (curl.get_StatusCode() != 201))
    print "Box request failed. HTTP status: " + curl.get_StatusCode().to_s() + "\n";
    print "Failure reason: " + curl.get_FailReason().to_s() + "\n";
    print curl.responseBodyStr() + "\n";
    exit
end

if (curl.VarDefined("!") != true)
    print "Expected response fields are missing." + "\n";
    exit
end

print "Uploaded file: " + curl.getVar("file_id") + "\n";
curl.ClearTargetOutput("*")
authorizedCommand3 = Chilkat::CkStringBuilder.new()
authorizedCommand3.SetString("curl -X POST \"https://api.box.com/2.0/files/{{file_id}}/metadata/enterprise_{{enterprise_id}}/projectDocument\" -H \"Authorization: Bearer {{access_token}}\" -H \"Content-Type: application/json\" -d '{\"customerId\":\"CUST-1001\",\"status\":\"received\"}'")
headerReplacement3 = authorizedCommand3.Replace("{{access_token}}",curl.getVar("access_token"))
success = curl.DoYourThing(authorizedCommand3.getAsString())
if ((success != true) or (curl.get_StatusCode() != 201))
    print "Box request failed. HTTP status: " + curl.get_StatusCode().to_s() + "\n";
    print "Failure reason: " + curl.get_FailReason().to_s() + "\n";
    print curl.responseBodyStr() + "\n";
    exit
end

curl.ClearTargetOutput("*")
curl.ClearVar("shared_url")
curl.AddTargetOutput("shared_link.url","shared_url")
authorizedCommand4 = Chilkat::CkStringBuilder.new()
authorizedCommand4.SetString("curl -X PUT \"https://api.box.com/2.0/files/{{file_id}}?fields=id,shared_link\" -H \"Authorization: Bearer {{access_token}}\" -H \"Content-Type: application/json\" -d '{\"shared_link\":{\"access\":\"collaborators\"}}'")
headerReplacement4 = authorizedCommand4.Replace("{{access_token}}",curl.getVar("access_token"))
success = curl.DoYourThing(authorizedCommand4.getAsString())
if ((success != true) or (curl.get_StatusCode() != 200))
    print "Box request failed. HTTP status: " + curl.get_StatusCode().to_s() + "\n";
    print "Failure reason: " + curl.get_FailReason().to_s() + "\n";
    print curl.responseBodyStr() + "\n";
    exit
end

if (curl.VarDefined("!") != true)
    print "Expected response fields are missing." + "\n";
    exit
end

print "Document link: " + curl.getVar("shared_url") + "\n";
#  The link is for existing collaborators. Invite users separately when needed.
#  ClearTargetOutput removes old extraction rules; it does not clear existing IDs.
curl.SetVar("folder_name",curl.getVar("new_folder_name"))
curl.SetVar("file_name","invoice.pdf")
curl.ClearVar("file_version_id")
curl.ClearVar("file_sha1")