Utils

Overview

CaidoUtils provides utility functions for building GraphQL query components and protecting against injection attacks.

String Escaping

.escape_graphql_string

CaidoUtils.escape_graphql_string(input : String) : String

Escapes special characters in a string to prevent GraphQL injection. Always use this when incorporating user-supplied strings into queries.

safe = CaidoUtils.escape_graphql_string("user \"input\" here\n")
# => "user \\\"input\\\" here\\n"

Pagination

.build_pagination

CaidoUtils.build_pagination(first : Int32, after : String = "") : String

Constructs a pagination clause for GraphQL queries.

CaidoUtils.build_pagination(first: 10)
# => "first: 10"

CaidoUtils.build_pagination(first: 10, after: "abc123")
# => "first: 10, after: \"abc123\""

Filtering

.build_filter_clause

CaidoUtils.build_filter_clause(filter : String) : String

Constructs a filter clause for GraphQL queries. Returns an empty string if the filter is empty.

CaidoUtils.build_filter_clause(filter: "host:example.com")
# => ", filter: \"host:example.com\""

CaidoUtils.build_filter_clause(filter: "")
# => ""

Array Building

.build_string_array

CaidoUtils.build_string_array(items : Array(String)) : String

Converts a Crystal string array into a GraphQL string array literal.

CaidoUtils.build_string_array(["*.example.com", "api.test.com"])
# => "[\"*.example.com\", \"api.test.com\"]"

Optional Strings

.build_optional_string

CaidoUtils.build_optional_string(value : String) : String

Creates an optional quoted string argument. Returns an empty string if the value is empty.

CaidoUtils.build_optional_string("my-value")
# => "\"my-value\""

CaidoUtils.build_optional_string("")
# => ""