Lua Requires Chilkat v11.5.0+

Inspect the Complete Set of Defined Variables

See more CURL Examples

This example shows how to inspect the complete set of defined variables after executing the curl dependency plan. The code that enumerates and displays all variables is located at the end of the example. Lua

local chilkat = require("chilkat")

-- This example shows how to inspect the complete set of defined variables
-- after executing the curl dependency plan.
-- The code that enumerates and displays all variables is located at the end of the example.

local httpCurl = chilkat.HttpCurl.new()

-- The final curl command we want to execute.
-- It depends on {{drive_id}}, which is not yet known.
local targetCurl = "curl -X GET https://graph.microsoft.com/v1.0/drives/{{drive_id}}/root/children"

-- Define a helper function that can produce drive_id.
-- This function lists drives for a given site, which requires {{site_id}}.
local fnName = "getDrives"
httpCurl:add_function(fnName, "curl -X GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives")

-- Define the output of getDrives.
-- The JSON response contains an array named "value".
-- We take the first element (value[0]) and extract its "id" as drive_id.
local jsonPath = "value[0].id"
httpCurl:add_output(fnName, jsonPath, "drive_id")

-- drive_id depends on site_id, which is also not yet known.
-- Define another helper function to obtain site_id.
fnName = "getSite"
httpCurl:add_function(fnName, "GET https://graph.microsoft.com/v1.0/sites/root:/sites/{{site_name}}")

-- Map the "id" field from the getSite response to the variable site_id.
jsonPath = "id"
httpCurl:add_output(fnName, jsonPath, "site_id")

-- Provide the initial known input.
-- site_name is the starting value that allows the dependency chain to be resolved.
httpCurl:set_var("site_name", "test")

-- ----------------------------------------------------------------------------------------------------------------------
-- Configure OAuth2 authentication using the client credentials flow.
-- Secrets (client_id, client_secret, token_endpoint) are retrieved from the
-- local secrets manager because EnableSecrets is enabled.
local jsonOAuth2 = chilkat.JsonObject.new()
jsonOAuth2.enable_secrets = true
jsonOAuth2:update_string("oauth2.client_id", "!!sharepoint|oauth2|client_id")
jsonOAuth2:update_string("oauth2.client_secret", "!!sharepoint|oauth2|client_secret")
jsonOAuth2:update_string("oauth2.scope", "https://graph.microsoft.com/.default")
jsonOAuth2:update_string("oauth2.token_endpoint", "!!sharepoint|oauth2|token_endpoint")
httpCurl:set_auth(jsonOAuth2)
-- ----------------------------------------------------------------------------------------------------------------------

-- Execute the target curl command.
-- Internally, the system will:
--
-- 1) Detect that {{drive_id}} is required but not defined.
-- 2) Find that "getDrives" can produce drive_id.
-- 3) Detect that getDrives requires {{site_id}}, which is also not defined.
-- 4) Find that "getSite" can produce site_id.
-- 5) Verify that getSite requires {{site_name}}, which is already known.
-- 6) Build a multi-step execution plan:
--      - First:  run getSite (produces site_id)
--      - Second: run getDrives (produces drive_id)
--      - Third:  run the target curl (uses drive_id)
local success = httpCurl:do_your_thing(targetCurl)
if not success then
    print(httpCurl.last_error_text)
    return
end

-- Retrieve and display the HTTP response status code.
local statusCode = httpCurl.status_code
print("response status code: " .. statusCode)

-- Load and display the JSON response from the final curl command.
local responseJson = chilkat.JsonObject.new()
responseJson.emit_compact = false
httpCurl:get_response_json(responseJson)
print(responseJson:emit())

-- ----------------------------------
-- Examine all defined variables.
-- ----------------------------------
local definedVarsJson = chilkat.JsonObject.new()
definedVarsJson.emit_compact = false

httpCurl:get_all_vars(definedVarsJson)
print(definedVarsJson:emit())

-- Sample output:

-- {
--   "vars": [
--     {
--       "name": "site_name",
--       "value": "test"
--     },
--     {
--       "name": "site_id",
--       "value": "example.sharepoint.com,9b923c5e-5117-44ad-8b03-adbb8e19be85,b2451e19-290f-5f29-9f5d-674c2950a9f7"
--     },
--     {
--       "name": "drive_id",
--       "value": "b!XjySmxdRrrtLA827jhm-nRkeRbIPKSlPn11nTClQqfeVOj5VUvQMQae34rwOHdiP"
--     }
--   ]
-- }

-- Sample code to parse the above JSON.
local i = 0
local numVars = definedVarsJson:size_of_array("vars")
while i < numVars do
    definedVarsJson.i = i
    print("name: " .. definedVarsJson:string_of("vars[i].name"))
    print("value: " .. definedVarsJson:string_of("vars[i].value"))
    i = i + 1
end