| -- Copyright (c) 2016 IBM. All rights reserved. |
| -- |
| -- Permission is hereby granted, free of charge, to any person obtaining a |
| -- copy of this software and associated documentation files (the "Software"), |
| -- to deal in the Software without restriction, including without limitation |
| -- the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| -- and/or sell copies of the Software, and to permit persons to whom the |
| -- Software is furnished to do so, subject to the following conditions: |
| -- |
| -- The above copyright notice and this permission notice shall be included in |
| -- all copies or substantial portions of the Software. |
| -- |
| -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| -- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| -- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| -- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| -- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
| -- FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
| -- DEALINGS IN THE SOFTWARE. |
| |
| --- @module utils |
| -- Holds the common supporting functions in one file to be referenced elsewhere |
| |
| local _Utils = {} |
| |
| --- Concatenate a list of strings into a single string. This is more efficient than concatenating |
| -- strings together with "..", which creates a new string every time |
| -- @param list List of strings to concatenate |
| -- @return concatenated string |
| function _Utils.concatStrings(list) |
| local t = {} |
| for k,v in ipairs(list) do |
| t[#t+1] = tostring(v) |
| end |
| return table.concat(t) |
| end |
| |
| --- Serializes a lua table, returning a string representation of the table. |
| -- Recursively calls itself it |
| -- Useful for saving a lua table to a file, as if not serialized it will save as "Table x35252" |
| -- @param t The lua table |
| -- @return String representing the serialized lua table |
| function _Utils.serializeTable(t) |
| local first = true |
| local tt = { '{' } |
| for k, v in pairs(t) do |
| if first == false then |
| tt[#tt+1] = ', ' |
| else |
| first = false |
| end |
| if type(k) == 'string' then |
| tt[#tt+1] = _Utils.concatStrings({tostring(k), ' = '}) |
| end |
| if type(v) == 'table' then |
| tt[#tt+1] = _Utils.serializeTable(v) |
| elseif type(v) == 'string' then |
| tt[#tt+1] = _Utils.concatStrings({'"', tostring(v), '"'}) |
| else |
| tt[#tt+1] = tostring(v) |
| end |
| end |
| tt[#tt+1] = '}' |
| return table.concat(tt) |
| end |
| |
| --- Concatenate the path param name into string variable to be replaced by the path param value |
| -- at time of being called by the user |
| -- @param m where m is the string "{pathParam}" |
| -- @return concatenated string of (?<path_pathParam>(\\w+)) |
| function _Utils.convertTemplatedPathParam(m) |
| local x = m:gsub("{", ""):gsub("}", "") |
| return concatStrings({"(?<path_" , x , ">([a-zA-Z0-9\\-\\s\\_\\%]*))"}) |
| end |
| |
| --- Generate random uuid |
| function _Utils.uuid() |
| local template ='xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx' |
| math.randomseed(os.clock()) |
| return string.gsub(template, '[xy]', function (c) |
| local v = (c == 'x') and math.random(0, 0xf) or math.random(8, 0xb) |
| return string.format('%x', v) |
| end) |
| end |
| |
| --- Check if element exists in table as value |
| -- @param table table to check |
| -- @param element element to check in table |
| function _Utils.tableContains(table, element) |
| for i, value in pairs(table) do |
| if value == element then |
| return true |
| end |
| end |
| return false |
| end |
| |
| --- Check if all required fields exist in the table |
| -- @param table table to check |
| -- @param requiredFields list of required fields |
| function _Utils.tableContainsAll(table, requiredFields) |
| for i, field in ipairs(requiredFields) do |
| if not table[field] then |
| return false, { statusCode = 400, message = _Utils.concatStrings({"\"", field, "\" missing from request body."}) } |
| end |
| end |
| return true |
| end |
| |
| return _Utils |
| |