[asterisk-commits] dlee: branch dlee/ASTERISK-22451-ari-subscribe r398796 - in /team/dlee/ASTERI...
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Tue Sep 10 13:32:17 CDT 2013
Author: dlee
Date: Tue Sep 10 13:32:15 2013
New Revision: 398796
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=398796
Log:
Application centric API
Added:
team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.c (with props)
team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.h (with props)
team/dlee/ASTERISK-22451-ari-subscribe/res/res_ari_applications.c (with props)
team/dlee/ASTERISK-22451-ari-subscribe/rest-api/api-docs/applications.json (with props)
Modified:
team/dlee/ASTERISK-22451-ari-subscribe/res/ari.make
team/dlee/ASTERISK-22451-ari-subscribe/res/ari/ari_model_validators.c
team/dlee/ASTERISK-22451-ari-subscribe/res/ari/ari_model_validators.h
team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_endpoints.h
team/dlee/ASTERISK-22451-ari-subscribe/rest-api/api-docs/endpoints.json
team/dlee/ASTERISK-22451-ari-subscribe/rest-api/resources.json
Modified: team/dlee/ASTERISK-22451-ari-subscribe/res/ari.make
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ASTERISK-22451-ari-subscribe/res/ari.make?view=diff&rev=398796&r1=398795&r2=398796
==============================================================================
--- team/dlee/ASTERISK-22451-ari-subscribe/res/ari.make (original)
+++ team/dlee/ASTERISK-22451-ari-subscribe/res/ari.make Tue Sep 10 13:32:15 2013
@@ -49,3 +49,7 @@
ari/resource_events.o: _ASTCFLAGS+=$(call MOD_ASTCFLAGS,res_ari_events)
+res_ari_applications.so: ari/resource_applications.o
+
+ari/resource_applications.o: _ASTCFLAGS+=$(call MOD_ASTCFLAGS,res_ari_applications)
+
Modified: team/dlee/ASTERISK-22451-ari-subscribe/res/ari/ari_model_validators.c
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ASTERISK-22451-ari-subscribe/res/ari/ari_model_validators.c?view=diff&rev=398796&r1=398795&r2=398796
==============================================================================
--- team/dlee/ASTERISK-22451-ari-subscribe/res/ari/ari_model_validators.c (original)
+++ team/dlee/ASTERISK-22451-ari-subscribe/res/ari/ari_model_validators.c Tue Sep 10 13:32:15 2013
@@ -3361,3 +3361,76 @@
{
return ast_ari_validate_stasis_start;
}
+
+int ast_ari_validate_application(struct ast_json *json)
+{
+ int res = 1;
+ struct ast_json_iter *iter;
+ int has_bridge_ids = 0;
+ int has_channel_ids = 0;
+ int has_endpoint_ids = 0;
+
+ for (iter = ast_json_object_iter(json); iter; iter = ast_json_object_iter_next(json, iter)) {
+ if (strcmp("bridge_ids", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_bridge_ids = 1;
+ prop_is_valid = ast_ari_validate_list(
+ ast_json_object_iter_value(iter),
+ ast_ari_validate_string);
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI Application field bridge_ids failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("channel_ids", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_channel_ids = 1;
+ prop_is_valid = ast_ari_validate_list(
+ ast_json_object_iter_value(iter),
+ ast_ari_validate_string);
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI Application field channel_ids failed validation\n");
+ res = 0;
+ }
+ } else
+ if (strcmp("endpoint_ids", ast_json_object_iter_key(iter)) == 0) {
+ int prop_is_valid;
+ has_endpoint_ids = 1;
+ prop_is_valid = ast_ari_validate_list(
+ ast_json_object_iter_value(iter),
+ ast_ari_validate_string);
+ if (!prop_is_valid) {
+ ast_log(LOG_ERROR, "ARI Application field endpoint_ids failed validation\n");
+ res = 0;
+ }
+ } else
+ {
+ ast_log(LOG_ERROR,
+ "ARI Application has undocumented field %s\n",
+ ast_json_object_iter_key(iter));
+ res = 0;
+ }
+ }
+
+ if (!has_bridge_ids) {
+ ast_log(LOG_ERROR, "ARI Application missing required field bridge_ids\n");
+ res = 0;
+ }
+
+ if (!has_channel_ids) {
+ ast_log(LOG_ERROR, "ARI Application missing required field channel_ids\n");
+ res = 0;
+ }
+
+ if (!has_endpoint_ids) {
+ ast_log(LOG_ERROR, "ARI Application missing required field endpoint_ids\n");
+ res = 0;
+ }
+
+ return res;
+}
+
+ari_validator ast_ari_validate_application_fn(void)
+{
+ return ast_ari_validate_application;
+}
Modified: team/dlee/ASTERISK-22451-ari-subscribe/res/ari/ari_model_validators.h
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ASTERISK-22451-ari-subscribe/res/ari/ari_model_validators.h?view=diff&rev=398796&r1=398795&r2=398796
==============================================================================
--- team/dlee/ASTERISK-22451-ari-subscribe/res/ari/ari_model_validators.h (original)
+++ team/dlee/ASTERISK-22451-ari-subscribe/res/ari/ari_model_validators.h Tue Sep 10 13:32:15 2013
@@ -870,6 +870,24 @@
* See \ref ast_ari_model_validators.h for more details.
*/
ari_validator ast_ari_validate_stasis_start_fn(void);
+
+/*!
+ * \brief Validator for Application.
+ *
+ * Details of a Stasis application
+ *
+ * \param json JSON object to validate.
+ * \returns True (non-zero) if valid.
+ * \returns False (zero) if invalid.
+ */
+int ast_ari_validate_application(struct ast_json *json);
+
+/*!
+ * \brief Function pointer to ast_ari_validate_application().
+ *
+ * See \ref ast_ari_model_validators.h for more details.
+ */
+ari_validator ast_ari_validate_application_fn(void);
/*
* JSON models
@@ -1072,6 +1090,10 @@
* - timestamp: Date
* - args: List[string] (required)
* - channel: Channel (required)
+ * Application
+ * - bridge_ids: List[string] (required)
+ * - channel_ids: List[string] (required)
+ * - endpoint_ids: List[string] (required)
*/
#endif /* _ASTERISK_ARI_MODEL_H */
Added: team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.c
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.c?view=auto&rev=398796
==============================================================================
--- team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.c (added)
+++ team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.c Tue Sep 10 13:32:15 2013
@@ -1,0 +1,56 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2013, Digium, Inc.
+ *
+ * David M. Lee, II <dlee at digium.com>
+ *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*! \file
+ *
+ * \brief /api-docs/applications.{format} implementation - Stasis application
+ * resources
+ *
+ * \author David M. Lee, II <dlee at digium.com>
+ */
+
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
+#include "resource_applications.h"
+
+void ast_ari_get_applications(struct ast_variable *headers,
+ struct ast_get_applications_args *args,
+ struct ast_ari_response *response)
+{
+ ast_log(LOG_ERROR, "TODO: ast_ari_get_applications\n");
+}
+void ast_ari_get_application(struct ast_variable *headers,
+ struct ast_get_application_args *args,
+ struct ast_ari_response *response)
+{
+ ast_log(LOG_ERROR, "TODO: ast_ari_get_application\n");
+}
+void ast_ari_application_subscribe(struct ast_variable *headers,
+ struct ast_application_subscribe_args *args,
+ struct ast_ari_response *response)
+{
+ ast_log(LOG_ERROR, "TODO: ast_ari_application_subscribe\n");
+}
+void ast_ari_application_unsubscribe(struct ast_variable *headers,
+ struct ast_application_unsubscribe_args *args,
+ struct ast_ari_response *response)
+{
+ ast_log(LOG_ERROR, "TODO: ast_ari_application_unsubscribe\n");
+}
Propchange: team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.c
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.c
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.c
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.h
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.h?view=auto&rev=398796
==============================================================================
--- team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.h (added)
+++ team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.h Tue Sep 10 13:32:15 2013
@@ -1,0 +1,109 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2013, Digium, Inc.
+ *
+ * David M. Lee, II <dlee at digium.com>
+ *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*! \file
+ *
+ * \brief Generated file - declares stubs to be implemented in
+ * res/ari/resource_applications.c
+ *
+ * Stasis application resources
+ *
+ * \author David M. Lee, II <dlee at digium.com>
+ */
+
+/*
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ * !!!!! DO NOT EDIT !!!!!
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ * This file is generated by a mustache template. Please see the original
+ * template in rest-api-templates/ari_resource.h.mustache
+ */
+
+#ifndef _ASTERISK_RESOURCE_APPLICATIONS_H
+#define _ASTERISK_RESOURCE_APPLICATIONS_H
+
+#include "asterisk/ari.h"
+
+/*! \brief Argument struct for ast_ari_get_applications() */
+struct ast_get_applications_args {
+};
+/*!
+ * \brief List all applications.
+ *
+ * \param headers HTTP headers
+ * \param args Swagger parameters
+ * \param[out] response HTTP response
+ */
+void ast_ari_get_applications(struct ast_variable *headers, struct ast_get_applications_args *args, struct ast_ari_response *response);
+/*! \brief Argument struct for ast_ari_get_application() */
+struct ast_get_application_args {
+ /*! \brief Application's name */
+ const char *application_name;
+};
+/*!
+ * \brief Get details of an application.
+ *
+ * \param headers HTTP headers
+ * \param args Swagger parameters
+ * \param[out] response HTTP response
+ */
+void ast_ari_get_application(struct ast_variable *headers, struct ast_get_application_args *args, struct ast_ari_response *response);
+/*! \brief Argument struct for ast_ari_application_subscribe() */
+struct ast_application_subscribe_args {
+ /*! \brief Application's name */
+ const char *application_name;
+ /*! \brief Array of URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource} */
+ const char **event_source;
+ /*! \brief Length of event_source array. */
+ size_t event_source_count;
+ /*! \brief Parsing context for event_source. */
+ char *event_source_parse;
+};
+/*!
+ * \brief Subscribe an application to a event source.
+ *
+ * Returns the state of the application after the subscriptions have changed
+ *
+ * \param headers HTTP headers
+ * \param args Swagger parameters
+ * \param[out] response HTTP response
+ */
+void ast_ari_application_subscribe(struct ast_variable *headers, struct ast_application_subscribe_args *args, struct ast_ari_response *response);
+/*! \brief Argument struct for ast_ari_application_unsubscribe() */
+struct ast_application_unsubscribe_args {
+ /*! \brief Application's name */
+ const char *application_name;
+ /*! \brief Array of URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource} */
+ const char **event_source;
+ /*! \brief Length of event_source array. */
+ size_t event_source_count;
+ /*! \brief Parsing context for event_source. */
+ char *event_source_parse;
+};
+/*!
+ * \brief Unsubscribe an application from an event source.
+ *
+ * Returns the state of the application after the subscriptions have changed
+ *
+ * \param headers HTTP headers
+ * \param args Swagger parameters
+ * \param[out] response HTTP response
+ */
+void ast_ari_application_unsubscribe(struct ast_variable *headers, struct ast_application_unsubscribe_args *args, struct ast_ari_response *response);
+
+#endif /* _ASTERISK_RESOURCE_APPLICATIONS_H */
Propchange: team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.h
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.h
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_applications.h
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_endpoints.h
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_endpoints.h?view=diff&rev=398796&r1=398795&r2=398796
==============================================================================
--- team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_endpoints.h (original)
+++ team/dlee/ASTERISK-22451-ari-subscribe/res/ari/resource_endpoints.h Tue Sep 10 13:32:15 2013
@@ -43,7 +43,7 @@
struct ast_get_endpoints_args {
};
/*!
- * \brief List all endoints.
+ * \brief List all endpoints.
*
* \param headers HTTP headers
* \param args Swagger parameters
Added: team/dlee/ASTERISK-22451-ari-subscribe/res/res_ari_applications.c
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ASTERISK-22451-ari-subscribe/res/res_ari_applications.c?view=auto&rev=398796
==============================================================================
--- team/dlee/ASTERISK-22451-ari-subscribe/res/res_ari_applications.c (added)
+++ team/dlee/ASTERISK-22451-ari-subscribe/res/res_ari_applications.c Tue Sep 10 13:32:15 2013
@@ -1,0 +1,425 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2013, Digium, Inc.
+ *
+ * David M. Lee, II <dlee at digium.com>
+ *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ * !!!!! DO NOT EDIT !!!!!
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ * This file is generated by a mustache template. Please see the original
+ * template in rest-api-templates/res_ari_resource.c.mustache
+ */
+
+/*! \file
+ *
+ * \brief Stasis application resources
+ *
+ * \author David M. Lee, II <dlee at digium.com>
+ */
+
+/*** MODULEINFO
+ <depend type="module">res_ari</depend>
+ <depend type="module">res_stasis</depend>
+ <support_level>core</support_level>
+ ***/
+
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
+#include "asterisk/app.h"
+#include "asterisk/module.h"
+#include "asterisk/stasis_app.h"
+#include "ari/resource_applications.h"
+#if defined(AST_DEVMODE)
+#include "ari/ari_model_validators.h"
+#endif
+
+#define MAX_VALS 128
+
+/*!
+ * \brief Parameter parsing callback for /applications.
+ * \param get_params GET parameters in the HTTP request.
+ * \param path_vars Path variables extracted from the request.
+ * \param headers HTTP headers.
+ * \param[out] response Response to the HTTP request.
+ */
+static void ast_ari_get_applications_cb(
+ struct ast_variable *get_params, struct ast_variable *path_vars,
+ struct ast_variable *headers, struct ast_ari_response *response)
+{
+ struct ast_get_applications_args args = {};
+#if defined(AST_DEVMODE)
+ int is_valid;
+ int code;
+#endif /* AST_DEVMODE */
+
+ ast_ari_get_applications(headers, &args, response);
+#if defined(AST_DEVMODE)
+ code = response->response_code;
+
+ switch (code) {
+ case 0: /* Implementation is still a stub, or the code wasn't set */
+ is_valid = response->message == NULL;
+ break;
+ case 500: /* Internal Server Error */
+ case 501: /* Not Implemented */
+ is_valid = 1;
+ break;
+ default:
+ if (200 <= code && code <= 299) {
+ is_valid = ast_ari_validate_application(
+ response->message);
+ } else {
+ ast_log(LOG_ERROR, "Invalid error response %d for /applications\n", code);
+ is_valid = 0;
+ }
+ }
+
+ if (!is_valid) {
+ ast_log(LOG_ERROR, "Response validation failed for /applications\n");
+ ast_ari_response_error(response, 500,
+ "Internal Server Error", "Response validation failed");
+ }
+#endif /* AST_DEVMODE */
+
+fin: __attribute__((unused))
+ return;
+}
+/*!
+ * \brief Parameter parsing callback for /applications/{applicationName}.
+ * \param get_params GET parameters in the HTTP request.
+ * \param path_vars Path variables extracted from the request.
+ * \param headers HTTP headers.
+ * \param[out] response Response to the HTTP request.
+ */
+static void ast_ari_get_application_cb(
+ struct ast_variable *get_params, struct ast_variable *path_vars,
+ struct ast_variable *headers, struct ast_ari_response *response)
+{
+ struct ast_get_application_args args = {};
+ struct ast_variable *i;
+#if defined(AST_DEVMODE)
+ int is_valid;
+ int code;
+#endif /* AST_DEVMODE */
+
+ for (i = path_vars; i; i = i->next) {
+ if (strcmp(i->name, "applicationName") == 0) {
+ args.application_name = (i->value);
+ } else
+ {}
+ }
+ ast_ari_get_application(headers, &args, response);
+#if defined(AST_DEVMODE)
+ code = response->response_code;
+
+ switch (code) {
+ case 0: /* Implementation is still a stub, or the code wasn't set */
+ is_valid = response->message == NULL;
+ break;
+ case 500: /* Internal Server Error */
+ case 501: /* Not Implemented */
+ case 404: /* Application does not exist. */
+ is_valid = 1;
+ break;
+ default:
+ if (200 <= code && code <= 299) {
+ is_valid = ast_ari_validate_application(
+ response->message);
+ } else {
+ ast_log(LOG_ERROR, "Invalid error response %d for /applications/{applicationName}\n", code);
+ is_valid = 0;
+ }
+ }
+
+ if (!is_valid) {
+ ast_log(LOG_ERROR, "Response validation failed for /applications/{applicationName}\n");
+ ast_ari_response_error(response, 500,
+ "Internal Server Error", "Response validation failed");
+ }
+#endif /* AST_DEVMODE */
+
+fin: __attribute__((unused))
+ return;
+}
+/*!
+ * \brief Parameter parsing callback for /applications/{applicationName}/subscription.
+ * \param get_params GET parameters in the HTTP request.
+ * \param path_vars Path variables extracted from the request.
+ * \param headers HTTP headers.
+ * \param[out] response Response to the HTTP request.
+ */
+static void ast_ari_application_subscribe_cb(
+ struct ast_variable *get_params, struct ast_variable *path_vars,
+ struct ast_variable *headers, struct ast_ari_response *response)
+{
+ struct ast_application_subscribe_args args = {};
+ struct ast_variable *i;
+#if defined(AST_DEVMODE)
+ int is_valid;
+ int code;
+#endif /* AST_DEVMODE */
+
+ for (i = get_params; i; i = i->next) {
+ if (strcmp(i->name, "eventSource") == 0) {
+ /* Parse comma separated list */
+ char *vals[MAX_VALS];
+ size_t j;
+
+ args.event_source_parse = ast_strdup(i->value);
+ if (!args.event_source_parse) {
+ ast_ari_response_alloc_failed(response);
+ goto fin;
+ }
+
+ if (strlen(args.event_source_parse) == 0) {
+ /* ast_app_separate_args can't handle "" */
+ args.event_source_count = 1;
+ vals[0] = args.event_source_parse;
+ } else {
+ args.event_source_count = ast_app_separate_args(
+ args.event_source_parse, ',', vals,
+ ARRAY_LEN(vals));
+ }
+
+ if (args.event_source_count == 0) {
+ ast_ari_response_alloc_failed(response);
+ goto fin;
+ }
+
+ if (args.event_source_count >= MAX_VALS) {
+ ast_ari_response_error(response, 400,
+ "Bad Request",
+ "Too many values for event_source");
+ goto fin;
+ }
+
+ args.event_source = ast_malloc(sizeof(*args.event_source) * args.event_source_count);
+ if (!args.event_source) {
+ ast_ari_response_alloc_failed(response);
+ goto fin;
+ }
+
+ for (j = 0; j < args.event_source_count; ++j) {
+ args.event_source[j] = (vals[j]);
+ }
+ } else
+ {}
+ }
+ for (i = path_vars; i; i = i->next) {
+ if (strcmp(i->name, "applicationName") == 0) {
+ args.application_name = (i->value);
+ } else
+ {}
+ }
+ ast_ari_application_subscribe(headers, &args, response);
+#if defined(AST_DEVMODE)
+ code = response->response_code;
+
+ switch (code) {
+ case 0: /* Implementation is still a stub, or the code wasn't set */
+ is_valid = response->message == NULL;
+ break;
+ case 500: /* Internal Server Error */
+ case 501: /* Not Implemented */
+ case 400: /* Missing parameter. */
+ case 404: /* Application does not exist. */
+ case 422: /* Event source does not exist. */
+ is_valid = 1;
+ break;
+ default:
+ if (200 <= code && code <= 299) {
+ is_valid = ast_ari_validate_application(
+ response->message);
+ } else {
+ ast_log(LOG_ERROR, "Invalid error response %d for /applications/{applicationName}/subscription\n", code);
+ is_valid = 0;
+ }
+ }
+
+ if (!is_valid) {
+ ast_log(LOG_ERROR, "Response validation failed for /applications/{applicationName}/subscription\n");
+ ast_ari_response_error(response, 500,
+ "Internal Server Error", "Response validation failed");
+ }
+#endif /* AST_DEVMODE */
+
+fin: __attribute__((unused))
+ ast_free(args.event_source_parse);
+ ast_free(args.event_source);
+ return;
+}
+/*!
+ * \brief Parameter parsing callback for /applications/{applicationName}/subscription.
+ * \param get_params GET parameters in the HTTP request.
+ * \param path_vars Path variables extracted from the request.
+ * \param headers HTTP headers.
+ * \param[out] response Response to the HTTP request.
+ */
+static void ast_ari_application_unsubscribe_cb(
+ struct ast_variable *get_params, struct ast_variable *path_vars,
+ struct ast_variable *headers, struct ast_ari_response *response)
+{
+ struct ast_application_unsubscribe_args args = {};
+ struct ast_variable *i;
+#if defined(AST_DEVMODE)
+ int is_valid;
+ int code;
+#endif /* AST_DEVMODE */
+
+ for (i = get_params; i; i = i->next) {
+ if (strcmp(i->name, "eventSource") == 0) {
+ /* Parse comma separated list */
+ char *vals[MAX_VALS];
+ size_t j;
+
+ args.event_source_parse = ast_strdup(i->value);
+ if (!args.event_source_parse) {
+ ast_ari_response_alloc_failed(response);
+ goto fin;
+ }
+
+ if (strlen(args.event_source_parse) == 0) {
+ /* ast_app_separate_args can't handle "" */
+ args.event_source_count = 1;
+ vals[0] = args.event_source_parse;
+ } else {
+ args.event_source_count = ast_app_separate_args(
+ args.event_source_parse, ',', vals,
+ ARRAY_LEN(vals));
+ }
+
+ if (args.event_source_count == 0) {
+ ast_ari_response_alloc_failed(response);
+ goto fin;
+ }
+
+ if (args.event_source_count >= MAX_VALS) {
+ ast_ari_response_error(response, 400,
+ "Bad Request",
+ "Too many values for event_source");
+ goto fin;
+ }
+
+ args.event_source = ast_malloc(sizeof(*args.event_source) * args.event_source_count);
+ if (!args.event_source) {
+ ast_ari_response_alloc_failed(response);
+ goto fin;
+ }
+
+ for (j = 0; j < args.event_source_count; ++j) {
+ args.event_source[j] = (vals[j]);
+ }
+ } else
+ {}
+ }
+ for (i = path_vars; i; i = i->next) {
+ if (strcmp(i->name, "applicationName") == 0) {
+ args.application_name = (i->value);
+ } else
+ {}
+ }
+ ast_ari_application_unsubscribe(headers, &args, response);
+#if defined(AST_DEVMODE)
+ code = response->response_code;
+
+ switch (code) {
+ case 0: /* Implementation is still a stub, or the code wasn't set */
+ is_valid = response->message == NULL;
+ break;
+ case 500: /* Internal Server Error */
+ case 501: /* Not Implemented */
+ case 400: /* Missing parameter; event source scheme not recognized. */
+ case 404: /* Application does not exist. */
+ case 409: /* Application not subscribed to event source. */
+ case 422: /* Event source does not exist. */
+ is_valid = 1;
+ break;
+ default:
+ if (200 <= code && code <= 299) {
+ is_valid = ast_ari_validate_application(
+ response->message);
+ } else {
+ ast_log(LOG_ERROR, "Invalid error response %d for /applications/{applicationName}/subscription\n", code);
+ is_valid = 0;
+ }
+ }
+
+ if (!is_valid) {
+ ast_log(LOG_ERROR, "Response validation failed for /applications/{applicationName}/subscription\n");
+ ast_ari_response_error(response, 500,
+ "Internal Server Error", "Response validation failed");
+ }
+#endif /* AST_DEVMODE */
+
+fin: __attribute__((unused))
+ ast_free(args.event_source_parse);
+ ast_free(args.event_source);
+ return;
+}
+
+/*! \brief REST handler for /api-docs/applications.{format} */
+static struct stasis_rest_handlers applications_applicationName_subscription = {
+ .path_segment = "subscription",
+ .callbacks = {
+ [AST_HTTP_POST] = ast_ari_application_subscribe_cb,
+ [AST_HTTP_Delete] = ast_ari_application_unsubscribe_cb,
+ },
+ .num_children = 0,
+ .children = { }
+};
+/*! \brief REST handler for /api-docs/applications.{format} */
+static struct stasis_rest_handlers applications_applicationName = {
+ .path_segment = "applicationName",
+ .is_wildcard = 1,
+ .callbacks = {
+ [AST_HTTP_GET] = ast_ari_get_application_cb,
+ },
+ .num_children = 1,
+ .children = { &applications_applicationName_subscription, }
+};
+/*! \brief REST handler for /api-docs/applications.{format} */
+static struct stasis_rest_handlers applications = {
+ .path_segment = "applications",
+ .callbacks = {
+ [AST_HTTP_GET] = ast_ari_get_applications_cb,
+ },
+ .num_children = 1,
+ .children = { &applications_applicationName, }
+};
+
+static int load_module(void)
+{
+ int res = 0;
+ stasis_app_ref();
+ res |= ast_ari_add_handler(&applications);
+ return res;
+}
+
+static int unload_module(void)
+{
+ ast_ari_remove_handler(&applications);
+ stasis_app_unref();
+ return 0;
+}
+
+AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "RESTful API module - Stasis application resources",
+ .load = load_module,
+ .unload = unload_module,
+ .nonoptreq = "res_ari,res_stasis",
+ );
Propchange: team/dlee/ASTERISK-22451-ari-subscribe/res/res_ari_applications.c
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: team/dlee/ASTERISK-22451-ari-subscribe/res/res_ari_applications.c
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: team/dlee/ASTERISK-22451-ari-subscribe/res/res_ari_applications.c
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: team/dlee/ASTERISK-22451-ari-subscribe/rest-api/api-docs/applications.json
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ASTERISK-22451-ari-subscribe/rest-api/api-docs/applications.json?view=auto&rev=398796
==============================================================================
--- team/dlee/ASTERISK-22451-ari-subscribe/rest-api/api-docs/applications.json (added)
+++ team/dlee/ASTERISK-22451-ari-subscribe/rest-api/api-docs/applications.json Tue Sep 10 13:32:15 2013
@@ -1,0 +1,162 @@
+{
+ "_copyright": "Copyright (C) 2013, Digium, Inc.",
+ "_author": "David M. Lee, II <dlee at digium.com>",
+ "_svn_revision": "$Revision$",
+ "apiVersion": "0.0.1",
+ "swaggerVersion": "1.1",
+ "basePath": "http://localhost:8088/stasis",
+ "resourcePath": "/api-docs/applications.{format}",
+ "apis": [
+ {
+ "path": "/applications",
+ "description": "Stasis applications",
+ "operations": [
+ {
+ "httpMethod": "GET",
+ "summary": "List all applications.",
+ "nickname": "getApplications",
+ "responseClass": "Application"
+ }
+ ]
+ },
+ {
+ "path": "/applications/{applicationName}",
+ "description": "Stasis application",
+ "operations": [
+ {
+ "httpMethod": "GET",
+ "summary": "Get details of an application.",
+ "nickname": "getApplication",
+ "responseClass": "Application",
+ "parameters": [
+ {
+ "name": "applicationName",
+ "description": "Application's name",
+ "paramType": "path",
+ "required": true,
+ "allowMultiple": false,
+ "dataType": "string"
+ }
+ ],
+ "errorResponses": [
+ {
+ "code": 404,
+ "reason": "Application does not exist."
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "path": "/applications/{applicationName}/subscription",
+ "description": "Stasis application",
+ "operations": [
+ {
+ "httpMethod": "POST",
+ "summary": "Subscribe an application to a event source.",
+ "notes": "Returns the state of the application after the subscriptions have changed",
+ "nickname": "applicationSubscribe",
+ "responseClass": "Application",
+ "parameters": [
+ {
+ "name": "applicationName",
+ "description": "Application's name",
+ "paramType": "path",
+ "required": true,
+ "allowMultiple": false,
+ "dataType": "string"
+ },
+ {
+ "name": "eventSource",
+ "description": "URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}",
+ "paramType": "query",
+ "required": true,
+ "allowMultiple": true,
+ "dataType": "string"
+ }
+ ],
+ "errorResponses": [
+ {
+ "code": 400,
+ "reason": "Missing parameter."
+ },
+ {
+ "code": 404,
+ "reason": "Application does not exist."
+ },
+ {
+ "code": 422,
+ "reason": "Event source does not exist."
+ }
+ ]
+ },
+ {
+ "httpMethod": "Delete",
+ "summary": "Unsubscribe an application from an event source.",
+ "notes": "Returns the state of the application after the subscriptions have changed",
+ "nickname": "applicationUnsubscribe",
+ "responseClass": "Application",
+ "parameters": [
+ {
+ "name": "applicationName",
+ "description": "Application's name",
+ "paramType": "path",
+ "required": true,
+ "allowMultiple": false,
+ "dataType": "string"
+ },
+ {
+ "name": "eventSource",
+ "description": "URI for event source (channel:{channelId}, bridge:{bridgeId}, endpoint:{tech}/{resource}",
+ "paramType": "query",
+ "required": true,
+ "allowMultiple": true,
+ "dataType": "string"
+ }
+ ],
+ "errorResponses": [
+ {
+ "code": 400,
+ "reason": "Missing parameter; event source scheme not recognized."
+ },
+ {
+ "code": 404,
+ "reason": "Application does not exist."
+ },
+ {
+ "code": 409,
+ "reason": "Application not subscribed to event source."
+ },
+ {
+ "code": 422,
+ "reason": "Event source does not exist."
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "models": {
+ "Application": {
+ "id": "Application",
+ "description": "Details of a Stasis application",
+ "properties": {
+ "channel_ids": {
+ "type": "List[string]",
+ "description": "Id's of channels subscribed to.",
+ "required": true
+ },
+ "bridge_ids": {
+ "type": "List[string]",
+ "description": "Id's of bridges subscribed to.",
+ "required": true
+ },
+ "endpoint_ids": {
+ "type": "List[string]",
+ "description": "Tech/resource of endpoints subscribed to",
+ "required": true
+ }
+ }
+ }
+ }
+}
Propchange: team/dlee/ASTERISK-22451-ari-subscribe/rest-api/api-docs/applications.json
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: team/dlee/ASTERISK-22451-ari-subscribe/rest-api/api-docs/applications.json
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: team/dlee/ASTERISK-22451-ari-subscribe/rest-api/api-docs/applications.json
------------------------------------------------------------------------------
svn:mime-type = text/plain
Modified: team/dlee/ASTERISK-22451-ari-subscribe/rest-api/api-docs/endpoints.json
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ASTERISK-22451-ari-subscribe/rest-api/api-docs/endpoints.json?view=diff&rev=398796&r1=398795&r2=398796
==============================================================================
--- team/dlee/ASTERISK-22451-ari-subscribe/rest-api/api-docs/endpoints.json (original)
+++ team/dlee/ASTERISK-22451-ari-subscribe/rest-api/api-docs/endpoints.json Tue Sep 10 13:32:15 2013
@@ -13,7 +13,7 @@
"operations": [
{
"httpMethod": "GET",
- "summary": "List all endoints.",
+ "summary": "List all endpoints.",
"nickname": "getEndpoints",
"responseClass": "List[Endpoint]"
}
Modified: team/dlee/ASTERISK-22451-ari-subscribe/rest-api/resources.json
URL: http://svnview.digium.com/svn/asterisk/team/dlee/ASTERISK-22451-ari-subscribe/rest-api/resources.json?view=diff&rev=398796&r1=398795&r2=398796
==============================================================================
--- team/dlee/ASTERISK-22451-ari-subscribe/rest-api/resources.json (original)
+++ team/dlee/ASTERISK-22451-ari-subscribe/rest-api/resources.json Tue Sep 10 13:32:15 2013
@@ -37,6 +37,10 @@
{
"path": "/api-docs/events.{format}",
"description": "WebSocket resource"
+ },
+ {
+ "path": "/api-docs/applications.{format}",
+ "description": "Stasis application resources"
}
]
}
More information about the asterisk-commits
mailing list