(Objective-C) Inspect the Complete Set of Defined Variables

See more CURL Examples

Note: This example requires Chilkat v11.5.0 or greater.

For more information, see https://www.chilkatsoft.com/curl_dependency_engine.asp

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoHttpCurl.h>
#import <NSString.h>
#import <CkoJsonObject.h>

BOOL success = NO;

// 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.

CkoHttpCurl *httpCurl = [[CkoHttpCurl alloc] init];

// The final curl command we want to execute.
// It depends on {{drive_id}}, which is not yet known.
NSString *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}}.
NSString *fnName = @"getDrives";
[httpCurl AddFunction: fnName curl: @"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.
NSString *jsonPath = @"value[0].id";
[httpCurl AddOutput: fnName jsonPath: jsonPath varName: @"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 AddFunction: fnName curl: @"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 AddOutput: fnName jsonPath: jsonPath varName: @"site_id"];

// Provide the initial known input.
// site_name is the starting value that allows the dependency chain to be resolved.
[httpCurl SetVar: @"site_name" varValue: @"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.
CkoJsonObject *jsonOAuth2 = [[CkoJsonObject alloc] init];
jsonOAuth2.EnableSecrets = YES;
[jsonOAuth2 UpdateString: @"oauth2.client_id" value: @"!!sharepoint|oauth2|client_id"];
[jsonOAuth2 UpdateString: @"oauth2.client_secret" value: @"!!sharepoint|oauth2|client_secret"];
[jsonOAuth2 UpdateString: @"oauth2.scope" value: @"https://graph.microsoft.com/.default"];
[jsonOAuth2 UpdateString: @"oauth2.token_endpoint" value: @"!!sharepoint|oauth2|token_endpoint"];
[httpCurl SetAuth: 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)
success = [httpCurl DoYourThing: targetCurl];
if (success == NO) {
    NSLog(@"%@",httpCurl.LastErrorText);
    return;
}

// Retrieve and display the HTTP response status code.
int statusCode = [httpCurl.StatusCode intValue];
NSLog(@"%@%d",@"response status code: ",statusCode);

// Load and display the JSON response from the final curl command.
CkoJsonObject *responseJson = [[CkoJsonObject alloc] init];
responseJson.EmitCompact = NO;
[httpCurl GetResponseJson: responseJson];
NSLog(@"%@",[responseJson Emit]);

// ----------------------------------
// Examine all defined variables.
// ----------------------------------
CkoJsonObject *definedVarsJson = [[CkoJsonObject alloc] init];
definedVarsJson.EmitCompact = NO;

[httpCurl GetAllVars: definedVarsJson];
NSLog(@"%@",[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.
int i = 0;
int numVars = [[definedVarsJson SizeOfArray: @"vars"] intValue];
while (i < numVars) {
    definedVarsJson.I = [NSNumber numberWithInt: i];
    NSLog(@"%@%@",@"name: ",[definedVarsJson StringOf: @"vars[i].name"]);
    NSLog(@"%@%@",@"value: ",[definedVarsJson StringOf: @"vars[i].value"]);
    i = i + 1;
}