scripts/lua/management/routes/subscriptions.lua

--
-- Licensed to the Apache Software Foundation (ASF) under one or more
-- contributor license agreements.  See the NOTICE file distributed with
-- this work for additional information regarding copyright ownership.
-- The ASF licenses this file to You under the Apache License, Version 2.0
-- (the "License"); you may not use this file except in compliance with
-- the License.  You may obtain a copy of the License at
--
--     http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--

--- @module subscriptions
-- Management interface for subscriptions for the gateway

local cjson = require "cjson"
local utils = require "lib/utils"
local request = require "lib/request"
local subscriptions = require "management/lib/subscriptions"

local _M = {}

local function validateSubscriptionBody(dataStore)
  -- Read in the PUT JSON Body
  ngx.req.read_body()
  local args = ngx.req.get_body_data()
  if not args then
    dataStore:close()
    request.err(400, "Missing request body.")
  end
  -- Convert json into Lua table
  local decoded = cjson.decode(args)
  -- Check required fields
  local res, err = utils.tableContainsAll(decoded, {"key", "scope", "tenantId"})
  if res == false then
    dataStore:close()
    request.err(err.statusCode, err.message)
  end
  -- Check if we're using tenant or resource or api
  local resource = decoded.resource
  local apiId = decoded.apiId
  local redisKey
  dataStore:setSnapshotId(decoded.tenantId)
  local prefix = utils.concatStrings({"subscriptions:tenant:", decoded.tenantId})
  if decoded.scope == "tenant" then
    redisKey = prefix
  elseif decoded.scope == "resource" then
    if resource ~= nil then
      redisKey = utils.concatStrings({prefix, ":resource:", resource})
    else
      dataStore:close()
      request.err(400, "\"resource\" missing from request body.")
    end
  elseif decoded.scope == "api" then
    if apiId ~= nil then
      redisKey = utils.concatStrings({prefix, ":api:", apiId})
    else
      dataStore:close()
      request.err(400, "\"apiId\" missing from request body.")
    end
  else
    dataStore:close()
    request.err(400, "Invalid scope")
  end
  redisKey = utils.concatStrings({redisKey, ":key:", decoded.key})
  return redisKey
end

local function addSubscription(dataStore)
  local redisKey = validateSubscriptionBody(dataStore)
  dataStore:createSubscription(redisKey)
  dataStore:close()
  request.success(200, "Subscription created.")
end

local function deleteSubscription(dataStore)
  local redisKey = validateSubscriptionBody(dataStore)
  dataStore:deleteSubscription(redisKey)
  dataStore:close()
  request.success(200, "Subscription deleted.")
end

-- v2 --

local function v2AddSubscription(dataStore)
  ngx.req.read_body()
  local args = ngx.req.get_body_data()
  if not args then
    dataStore:close()
    request.err(400, "Missing request body.")
  end
  local decoded = cjson.decode(args)
  local res, err = utils.tableContainsAll(decoded, {"client_id", "artifact_id"})
  if res == false then
    request.err(err.statusCode, err.message)
  end
  local artifactId = decoded.artifact_id
  local tenantId = ngx.var.tenant_id
  local clientId = decoded.client_id
  local clientSecret = decoded.client_secret
  subscriptions.addSubscription(dataStore, artifactId, tenantId, clientId, clientSecret, utils.hash)
  dataStore:close()
  local result = {
    message = utils.concatStrings({"Subscription '", clientId, "' created for API '", artifactId, "'"})
  }
  ngx.header.content_type = "application/json; charset=utf-8"
  request.success(200, cjson.encode(result))
end

local function v2GetSubscriptions(dataStore)
  local tenantId = ngx.var.tenant_id
  local artifactId = ngx.req.get_uri_args()["artifact_id"]
  if artifactId == nil or artifactId == "" then
    request.err(400, "Missing artifact_id")
  end
  local subscriptionList = subscriptions.getSubscriptions(dataStore, artifactId, tenantId)
  dataStore:close()
  ngx.header.content_type = "application/json; charset=utf-8"
  request.success(200, cjson.encode(subscriptionList))
end

local function v2DeleteSubscription(dataStore)
  local clientId = ngx.var.client_id
  local tenantId = ngx.var.tenant_id
  local artifactId = ngx.req.get_uri_args()["artifact_id"]
  if clientId == nil or clientId == "" then
    request.err(400, "Missing client_id")
  end
  if artifactId == nil or artifactId == "" then
    request.err(400, "Missing artifact_id")
  end
  local res = subscriptions.deleteSubscription(dataStore, artifactId, tenantId, clientId)
  if res == false then
    request.err(404, "Subscription doesn't exist")
  end
  dataStore:close()
  request.success(204)
end

local function v2(dataStore)
  local requestMethod = ngx.req.get_method()
  if requestMethod == "POST" or requestMethod == "PUT" then
    v2AddSubscription(dataStore)
  elseif requestMethod == "GET" then
    v2GetSubscriptions(dataStore)
  elseif requestMethod == "DELETE" then
    v2DeleteSubscription(dataStore)
  else
    dataStore:close()
    request.err(400, "Invalid verb")
  end
end

-- v1 --

local function v1(dataStore)
  local requestMethod = ngx.req.get_method()
  if requestMethod == "POST" or requestMethod == "PUT" then
    addSubscription(dataStore)
  elseif requestMethod == "DELETE" then
    deleteSubscription(dataStore)
  else
    dataStore:close()
    request.err(400, "Invalid verb")
  end
end

function _M.requestHandler(dataStore)
  local version = ngx.var.version
  if version == "v2" then
    v2(dataStore)
  elseif version == "v1" then
    v1(dataStore)
  else
    request.err(404, "404 Not found")
  end
end

return _M