Add docstrings (#259)

nextjournal · Mar 14, 2024 · d1ae6f5 · d1ae6f5
1 parent 7c1c9bb
commit d1ae6f5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/example/auth_test.clj b/example/auth_test.clj
@@ -11,15 +11,15 @@
       {:status 200 :headers {"content-type" "text/html"}
        :body (garden-id/->html [:div.text-center
                                 [:h2.font-bold.text-white.text-xl.mb-2.text-center
-                                 (format "Hi %s 👋" (or (garden-id/get-user req) "Stranger"))]
+                                 (format "Hi %s 👋" (or (:name (garden-id/get-user req)) "Stranger"))]
                                 [:p.text-white.mb-6.text-center
                                  (format "You have visited %s times" (or (:visits session) "unknown"))]
                                 (if (garden-id/logged-in? req)
                                   (garden-id/render-link-button {:href garden-id/logout-uri :label "Logout"})
                                   (garden-id/render-link-button {:href garden-id/login-uri :label "Login"}))])
        :session session})
 
-    {:status 400 :body "not found"}))
+    {:status 404 :body "not found"}))
 
 (defn start [_]
   (httpkit/run-server (-> consuming-app

diff --git a/src/nextjournal/garden_id.clj b/src/nextjournal/garden_id.clj
@@ -216,6 +216,16 @@
       (app req))))
 
 (defn wrap-auth
+  "Ring middleware to add authentication (and optional authorization)
+
+   To restrict login to members of a GitHub org or team pass `:github` in `opts`
+   `{:github [[\"organization\"]... [\"organization\" \"team\"]...]}`
+
+   To restrict login to people with Apple ID pass `:apple` in `opts`
+   `{:apple []}`
+
+   Request handlers can check if a user is logged in using `logged-in?`
+   and access user details using `get-user`"
   ([app]
    (wrap-auth app {}))
   ([app opts]