raven/server/AyaNova/Controllers/WidgetController.cs

using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Routing;
using Microsoft.AspNetCore.Authorization;

using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Logging;

using AyaNova.Models;
using AyaNova.Api.ControllerHelpers;
using AyaNova.Biz;


namespace AyaNova.Api.Controllers
{
    //DOCUMENTATING THE API
    //https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/recommended-tags-for-documentation-comments
    //https://github.com/domaindrivendev/Swashbuckle.AspNetCore#include-descriptions-from-xml-comments

    /// <summary>
    /// Sample controller class used during development for testing purposes
    /// </summary>
    [ApiController]
    [ApiVersion("8.0")]
    [Route("api/v{version:apiVersion}/[controller]")]
    [Produces("application/json")]
    [Authorize]
    public class WidgetController : ControllerBase
    {
        private readonly AyContext ct;
        private readonly ILogger<WidgetController> log;
        private readonly ApiServerState serverState;


        /// <summary>
        /// ctor
        /// </summary>
        /// <param name="dbcontext"></param>
        /// <param name="logger"></param>
        /// <param name="apiServerState"></param>  
        public WidgetController(AyContext dbcontext, ILogger<WidgetController> logger, ApiServerState apiServerState)
        {
            ct = dbcontext;
            log = logger;
            serverState = apiServerState;
        }

        // /// <summary>
        // /// Create widget
        // /// </summary>
        // /// <param name="newObject"></param>
        // /// <param name="apiVersion">From route path</param>
        // /// <returns></returns>
        // [HttpPost]
        // public async Task<IActionResult> PostWidget([FromBody] Widget newObject, ApiVersion apiVersion)
        // {
        //     if (!serverState.IsOpen)
        //         return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));

        //     //Instantiate the business object handler
        //     WidgetBiz biz = WidgetBiz.GetBiz(ct, HttpContext);

        //     //If a user has change roles
        //     if (!Authorized.HasCreateRole(HttpContext.Items, biz.BizType))
        //         return StatusCode(403, new ApiNotAuthorizedResponse());

        //     if (!ModelState.IsValid)
        //         return BadRequest(new ApiErrorResponse(ModelState));

        //     //Create and validate
        //     Widget o = await biz.CreateAsync(newObject);
        //     if (o == null)
        //         return BadRequest(new ApiErrorResponse(biz.Errors));
        //     else
        //         return CreatedAtAction(nameof(WidgetController.GetWidget), new { id = o.Id, version = apiVersion.ToString() }, new ApiCreatedResponse(o));
        // }

        /// <summary>
        /// Create Widget
        /// </summary>
        /// <param name="newObject"></param>
        /// <param name="apiVersion">From route path</param>
        /// <returns></returns>
        [HttpPost]
        public async Task<IActionResult> PostWidget([FromBody] Widget newObject, ApiVersion apiVersion)
        {
            if (!serverState.IsOpen)
                return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));
            WidgetBiz biz = WidgetBiz.GetBiz(ct, HttpContext);
            if (!Authorized.HasCreateRole(HttpContext.Items, biz.BizType))
                return StatusCode(403, new ApiNotAuthorizedResponse());
            if (!ModelState.IsValid)
                return BadRequest(new ApiErrorResponse(ModelState));
            Widget o = await biz.CreateAsync(newObject);
            if (o == null)
                return BadRequest(new ApiErrorResponse(biz.Errors));
            else
                return CreatedAtAction(nameof(WidgetController.GetWidget), new { id = o.Id, version = apiVersion.ToString() }, new ApiCreatedResponse(o));
        }


        // /// <summary>
        // /// Duplicate widget
        // /// </summary>
        // /// <param name="id">Create a duplicate of this items id</param>
        // /// <param name="apiVersion">From route path</param>
        // /// <returns></returns>
        // [HttpPost("duplicate/{id}")]
        // public async Task<IActionResult> DuplicateWidget([FromRoute] long id, ApiVersion apiVersion)
        // {
        //     if (!serverState.IsOpen)
        //         return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));

        //     //Instantiate the business object handler
        //     WidgetBiz biz = WidgetBiz.GetBiz(ct, HttpContext);

        //     //If a user has change roles
        //     if (!Authorized.HasCreateRole(HttpContext.Items, biz.BizType))
        //         return StatusCode(403, new ApiNotAuthorizedResponse());

        //     if (!ModelState.IsValid)
        //         return BadRequest(new ApiErrorResponse(ModelState));

        //     var oSrc = await biz.GetAsync(id, false);
        //     if (oSrc == null)
        //         return NotFound(new ApiErrorResponse(ApiErrorCode.NOT_FOUND));

        //     //Create and validate
        //     Widget o = await biz.DuplicateAsync(oSrc);
        //     if (o == null)
        //         return BadRequest(new ApiErrorResponse(biz.Errors));
        //     else
        //         return CreatedAtAction(nameof(WidgetController.GetWidget), new { id = o.Id, version = apiVersion.ToString() }, new ApiCreatedResponse(o));

        // }

        /// <summary>
        /// Duplicate Widget
        /// (Wiki and Attachments are not duplicated)
        /// </summary>
        /// <param name="id">Source object id</param>
        /// <param name="apiVersion">From route path</param>
        /// <returns>Widget</returns>
        [HttpPost("duplicate/{id}")]
        public async Task<IActionResult> DuplicateWidget([FromRoute] long id, ApiVersion apiVersion)
        {
            if (!serverState.IsOpen)
                return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));
            WidgetBiz biz = WidgetBiz.GetBiz(ct, HttpContext);
            if (!Authorized.HasCreateRole(HttpContext.Items, biz.BizType))
                return StatusCode(403, new ApiNotAuthorizedResponse());
            if (!ModelState.IsValid)
                return BadRequest(new ApiErrorResponse(ModelState));
            Widget o = await biz.DuplicateAsync(id);
            if (o == null)
                return BadRequest(new ApiErrorResponse(biz.Errors));
            else
                return CreatedAtAction(nameof(WidgetController.GetWidget), new { id = o.Id, version = apiVersion.ToString() }, new ApiCreatedResponse(o));
        }


        // /// <summary>
        // /// Get full widget object
        // /// </summary>
        // /// <param name="id"></param>
        // /// <returns>A single widget</returns>
        // [HttpGet("{id}")]
        // public async Task<IActionResult> GetWidget([FromRoute] long id)
        // {
        //     if (!serverState.IsOpen)
        //         return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));

        //     //Instantiate the business object handler
        //     WidgetBiz biz = WidgetBiz.GetBiz(ct, HttpContext);

        //     //NOTE: This is the first check and often the only check but in some cases with some objects this will also need to check biz object rules 
        //     if (!Authorized.HasReadFullRole(HttpContext.Items, biz.BizType))
        //         return StatusCode(403, new ApiNotAuthorizedResponse());

        //     if (!ModelState.IsValid)
        //         return BadRequest(new ApiErrorResponse(ModelState));

        //     var o = await biz.GetAsync(id);
        //     if (o == null)
        //         return NotFound(new ApiErrorResponse(ApiErrorCode.NOT_FOUND));

        //     // NOTE: HERE would be the second check of biz rules before returning the object
        //     // in cases where there is also a business rule to affect retrieval on top of basic rights

        //     return Ok(ApiOkResponse.Response(o, !Authorized.HasModifyRole(HttpContext.Items, biz.BizType)));
        // }
        /// <summary>
        /// Get Widget
        /// </summary>
        /// <param name="id"></param>
        /// <returns>Widget</returns>
        [HttpGet("{id}")]
        public async Task<IActionResult> GetWidget([FromRoute] long id)
        {
            if (!serverState.IsOpen)
                return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));
            WidgetBiz biz = WidgetBiz.GetBiz(ct, HttpContext);
            if (!Authorized.HasReadFullRole(HttpContext.Items, biz.BizType))
                return StatusCode(403, new ApiNotAuthorizedResponse());
            if (!ModelState.IsValid)
                return BadRequest(new ApiErrorResponse(ModelState));
            var o = await biz.GetAsync(id);
            if (o == null) return NotFound(new ApiErrorResponse(ApiErrorCode.NOT_FOUND));
            return Ok(ApiOkResponse.Response(o, !Authorized.HasModifyRole(HttpContext.Items, biz.BizType)));
        }

        // /// <summary>
        // /// Put (update) widget
        // /// </summary>
        // /// <param name="id"></param>
        // /// <param name="inObj"></param>
        // /// <returns></returns>
        // [HttpPut("{id}")]
        // public async Task<IActionResult> PutWidget([FromRoute] long id, [FromBody] Widget inObj)
        // {
        //     if (!serverState.IsOpen)
        //         return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));

        //     if (!ModelState.IsValid)
        //         return BadRequest(new ApiErrorResponse(ModelState));

        //     //Instantiate the business object handler       
        //     WidgetBiz biz = WidgetBiz.GetBiz(ct, HttpContext);

        //     var o = await biz.GetAsync(id, false);
        //     if (o == null)
        //         return NotFound(new ApiErrorResponse(ApiErrorCode.NOT_FOUND));

        //     if (!Authorized.HasModifyRole(HttpContext.Items, biz.BizType))
        //         return StatusCode(403, new ApiNotAuthorizedResponse());

        //     try
        //     {
        //         if (!await biz.PutAsync(o, inObj))
        //             return BadRequest(new ApiErrorResponse(biz.Errors));
        //     }
        //     catch (DbUpdateConcurrencyException)
        //     {
        //         if (!await biz.ExistsAsync(id))
        //             return NotFound(new ApiErrorResponse(ApiErrorCode.NOT_FOUND));
        //         else
        //             return StatusCode(409, new ApiErrorResponse(ApiErrorCode.CONCURRENCY_CONFLICT));
        //     }
        //     return Ok(ApiOkResponse.Response(new { Concurrency = o.Concurrency }, true));
        // }

        /// <summary>
        /// Put (update) Widget
        /// </summary>        
        /// <param name="updatedObject"></param>
        /// <returns></returns>
        [HttpPut]
        public async Task<IActionResult> PutWidget([FromBody] Widget updatedObject)
        {
            if (!serverState.IsOpen)
                return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));
            if (!ModelState.IsValid)
                return BadRequest(new ApiErrorResponse(ModelState));
            WidgetBiz biz = WidgetBiz.GetBiz(ct, HttpContext);
            if (!Authorized.HasModifyRole(HttpContext.Items, biz.BizType))
                return StatusCode(403, new ApiNotAuthorizedResponse());
            var o = await biz.PutAsync(updatedObject);//In future may need to return entire object, for now just concurrency token 
            if (o == null)
            {
                if (biz.Errors.Exists(m => m.Code == ApiErrorCode.CONCURRENCY_CONFLICT))
                    return StatusCode(409, new ApiErrorResponse(biz.Errors));
                else
                    return BadRequest(new ApiErrorResponse(biz.Errors));
            }
            return Ok(ApiOkResponse.Response(new { Concurrency = o.Concurrency }, true)); ;
        }


        // /// <summary>
        // /// Delete widget
        // /// </summary>
        // /// <param name="id"></param>
        // /// <returns>Ok</returns>
        // [HttpDelete("{id}")]
        // public async Task<IActionResult> DeleteWidget([FromRoute] long id)
        // {
        //     if (!serverState.IsOpen)
        //         return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));

        //     if (!ModelState.IsValid)
        //         return BadRequest(new ApiErrorResponse(ModelState));

        //     //Instantiate the business object handler
        //     WidgetBiz biz = WidgetBiz.GetBiz(ct, HttpContext);

        //     var o = await biz.GetAsync(id, false);
        //     if (o == null)
        //         return NotFound(new ApiErrorResponse(ApiErrorCode.NOT_FOUND));

        //     if (!Authorized.HasDeleteRole(HttpContext.Items, biz.BizType))
        //         return StatusCode(403, new ApiNotAuthorizedResponse());

        //     if (!await biz.DeleteAsync(o))
        //         return BadRequest(new ApiErrorResponse(biz.Errors));

        //     return NoContent();
        // }

        /// <summary>
        /// Delete Widget
        /// </summary>
        /// <param name="id"></param>
        /// <returns>NoContent</returns>
        [HttpDelete("{id}")]
        public async Task<IActionResult> DeleteWidget([FromRoute] long id)
        {
            if (!serverState.IsOpen)
                return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));
            if (!ModelState.IsValid)
                return BadRequest(new ApiErrorResponse(ModelState));
            WidgetBiz biz = WidgetBiz.GetBiz(ct, HttpContext);
            if (!Authorized.HasDeleteRole(HttpContext.Items, biz.BizType))
                return StatusCode(403, new ApiNotAuthorizedResponse());
            if (!await biz.DeleteAsync(id))
                return BadRequest(new ApiErrorResponse(biz.Errors));
            return NoContent();
        }


        ///////////////////////////////////////////////
        //TEST ROUTES
        //
        /// <summary>
        /// Get route that triggers exception for testing
        /// </summary>
        /// <returns>Nothing, triggers exception</returns>
        [HttpGet("exception")]
        public ActionResult GetException()
        {
            //log.LogInformation("Widget::getexception-> Test exception and log from controller test");
            if (!serverState.IsOpen)
                return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));
            throw new System.NotSupportedException("Test exception from widget controller");
        }

        /// <summary>
        /// Get route that triggers an alternate type of exception for testing
        /// </summary>
        /// <returns>Nothing, triggers exception</returns>
        [HttpGet("altexception")]
        public ActionResult GetAltException()
        {
            if (!serverState.IsOpen)
                return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));
            throw new System.ArgumentException("Test exception (ALT) from widget controller");
        }


        /// <summary>
        /// Get route that submits a simulated long running operation job for testing
        /// </summary>
        /// <returns>Nothing</returns>
        [HttpGet("TestWidgetJob")]
        public async Task<IActionResult> TestWidgetJob()
        {
            if (!serverState.IsOpen)
                return StatusCode(503, new ApiErrorResponse(serverState.ApiErrorCode, null, serverState.Reason));

            if (!Authorized.HasModifyRole(HttpContext.Items, AyaType.ServerJob))
                return StatusCode(403, new ApiNotAuthorizedResponse());

            //Create the job here
            OpsJob j = new OpsJob();
            j.Name = "TestWidgetJob";
            j.JobType = JobType.TestWidgetJob;
            await JobsBiz.AddJobAsync(j, ct);
            return Accepted(new { JobId = j.GId });//202 accepted
        }

        //------------


    }//eoc
}//eons