From 5cce96a68272bab5204b806116be98bee051a97d Mon Sep 17 00:00:00 2001 From: colin Date: Sun, 12 May 2024 09:53:55 -0700 Subject: Add: defendpoint example; Fix: tweak defendpoint docstring --- examples/defendpoint-examples.lisp | 73 ++++++++++++++++++++++++++++++++++++++ examples/dice-roller.lisp | 4 +-- examples/kitchensink.lisp | 4 +-- src/defendpoint.lisp | 26 +++++++------- src/package.lisp | 3 +- weekend.asd | 5 +-- 6 files changed, 96 insertions(+), 19 deletions(-) create mode 100644 examples/defendpoint-examples.lisp diff --git a/examples/defendpoint-examples.lisp b/examples/defendpoint-examples.lisp new file mode 100644 index 0000000..a59d09d --- /dev/null +++ b/examples/defendpoint-examples.lisp @@ -0,0 +1,73 @@ +(defpackage #:weekend.examples.defendpoint + (:use #:cl #:weekend) + (:import-from #:flatbind #:do>)) + +(in-package :weekend.examples.defendpoint) + +;;; The DICE ROLLER example, but this time with DEFENDPOINT: +(defparameter +digits+ "([0-9]+)") + +(defendpoint roller + :get :route "roll" (:rolls +digits+ parse-integer) "d" (:sides +digits+ parse-integer) + :returns "text/plain" + :parameters + (sides integer "The number of sides the die being rolled has.") + (rolls integer "The number of times to roll the die.") + :documentation "Roll a SIDES-sided die ROLLS times, and announce the total." + :handle (format nil "~ad~a = ~a" + rolls sides + (loop :repeat rolls :sum (1+ (random sides))))) + + +;;; EXAMPLE WITH MULTIPLE INTERACTING ENDPOINTS, AND A MIX-IN FOR +;;; AUTHENTICATION + +;; Serves a form used to identify a user +(defendpoint who-are-you + :get :route "who-are-you" + :returns "text/html;charset=utf-8" + :documentation "A form to identify yourself" + :handle (with-output-to-string (*standard-output*) + (princ "") + (princ ""))) + +;;; A mixin meant to grab the name from a cookie, used to authenticate +;;; all requests that need to have identified a user. +;;; If authentication fails, redirects to who-are-you. +(defclass identified () + ((name :accessor name :type string))) + +(defmethod authenticate ((req identified)) + (or + (do> + name :when= (get-cookie "weekend-eg-name") + :when (and (stringp name) (plusp (length name))) + (setf (name req) name)) + (endpoint-redirect 'who-are-you))) + + +;;; Endpoint that extends IDENTIFIED and just greets the identified. +(defendpoint you-seem-to-be + :using identified + :get :route "you-seem-to-be" + :returns "text/html;charset=utf-8" + :documentation "Just says hello to an identified uesr" + :handle (with-output-to-string (*standard-output*) + (princ "") + (princ "

You seem to be ") + (princ name) ; INHERITED FROM IDENTIFIED + (princ ".

"))) + + +;;; POST endpoint that handles setting the name cookie +(defendpoint my-name-is + :post :to "my-name-is" + :parameters + (name string "The name supplied by the user") + :documentation "Set cookie for client's identity." + :handle (progn + (set-cookie "weekend-eg-name" :value name) + (endpoint-redirect 'you-seem-to-be))) diff --git a/examples/dice-roller.lisp b/examples/dice-roller.lisp index 465d252..45e2979 100644 --- a/examples/dice-roller.lisp +++ b/examples/dice-roller.lisp @@ -1,9 +1,9 @@ -(defpackage #:dice-roller +(defpackage #:weekend.examples.dice-roller (:use #:cl) (:local-nicknames (#:wknd #:weekend))) -(in-package #:dice-roller) +(in-package #:weekend.examples.dice-roller) (defconstant +digits+ "([0-9]+)") diff --git a/examples/kitchensink.lisp b/examples/kitchensink.lisp index 7fcf45b..f102de5 100644 --- a/examples/kitchensink.lisp +++ b/examples/kitchensink.lisp @@ -1,9 +1,9 @@ -(defpackage #:kitchensink +(defpackage #:weekend.examples.kitchensink (:use #:cl) (:local-nicknames (#:wknd #:weekend))) -(in-package #:kitchensink) +(in-package #:weekend.examples.kitchensink) (defparameter +fname+ "([^/]+)" "Match any ole character except /") diff --git a/src/defendpoint.lisp b/src/defendpoint.lisp index 872c336..0ac9ec9 100644 --- a/src/defendpoint.lisp +++ b/src/defendpoint.lisp @@ -60,8 +60,9 @@ PART is either (getf kwargs :documentation ""))))) (defun expand-endpoint-class - (name method pathspec handle return + (name method pathspec handle &key + return supers parameters properties @@ -129,9 +130,9 @@ PART is either (:@ supers (:? )) (:@ method ) (:@ pathspec ) - (:@ return (:? )) - (:@ params (:? )) - (:@ props (:? )) + ; (:@ return (:? )) +; (:@ params (:? )) +; (:@ props (:? )) (:@ options (:*