Merge pull request #39 from clj-codes/feat/adds-social-dashboards-api

Adds api for latest & top author interactions

Author: rafaeldelboni

docker/docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.7"
-
 services:
   db:
     image: postgres:14

src/codes/clj/docs/backend/adapters/db/postgres.clj

@@ -12,6 +12,15 @@
    :author/avatar-url avatar-url
    :author/created-at created-at})
 
+(defn db->author+interaction
+  {:malli/schema [:=> [:cat [:sequential schemas.db/Author+InteractionsRow]]
+                  [:sequential schemas.model.social/Author+Interactions]]}
+  [db-rows]
+  (map (fn [{:keys [interactions] :as author}]
+         (assoc (db->author author)
+                :author/interactions interactions))
+       db-rows))
+
 (defn db->note
   {:malli/schema [:=> [:cat [:maybe schemas.db/Row]] [:maybe schemas.model.social/Note]]}
   [{:keys [id definition-id body created author-id] :as note}]
@@ -97,3 +106,15 @@
                   [:maybe schemas.model.social/Social]]}
   [db-rows]
   (first (db->socials db-rows)))
+
+(defn db->any-socials
+  {:malli/schema [:=> [:cat [:sequential schemas.db/Row]]
+                  [:maybe [:sequential schemas.model.social/AnySocial]]]}
+  [db-rows]
+  (let [notes (db->notes db-rows)
+        examples (db->examples db-rows)
+        see-alsos (db->see-alsos db-rows)]
+    (concat
+     (seq notes)
+     (seq examples)
+     (seq see-alsos))))

src/codes/clj/docs/backend/adapters/social.clj

@@ -33,6 +33,16 @@
    :avatar-url avatar-url
    :created-at created-at})
 
+(defn author-interaction->model->wire
+  {:malli/schema [:=> [:cat [:sequential schemas.model.social/Author+Interactions]]
+                  [:sequential schemas.wire.out.social/Author+Interactions]]}
+  [author+interactions]
+  (->> author+interactions
+       (map (fn [{:author/keys [interactions] :as author}]
+              (assoc (author->model->wire author)
+                     :interactions interactions)))
+       (sort-by :interactions #(compare %2 %1))))
+
 (defn editor->model->wire
   {:malli/schema [:=> [:cat schemas.model.social/Editor] schemas.wire.social/Editor]}
   [{:editor/keys [edited-at] :as author}]
@@ -129,3 +139,22 @@
   (enc/assoc-some
    (author->model->wire author)
    :socials (map social->model->wire socials)))
+
+(defn any-social->model->wire
+  {:malli/schema [:=> [:cat [:sequential schemas.model.social/AnySocial]]
+                  [:maybe [:sequential schemas.wire.out.social/AnySocial]]]}
+  [any-socials]
+  (let [notes (->> any-socials
+                   (filter #(:note/note-id %))
+                   (map note->model->wire))
+        examples (->> any-socials
+                      (filter #(:example/example-id %))
+                      (map example->model->wire))
+        see-alsos (->> any-socials
+                       (filter #(:see-also/see-also-id %))
+                       (map see-also->model->wire))]
+    (->> (concat
+          (seq notes)
+          (seq examples)
+          (seq see-alsos))
+         (sort-by :created-at #(compare %2 %1)))))

src/codes/clj/docs/backend/controllers/social.clj

@@ -86,3 +86,15 @@
                   [:maybe schemas.model.social/Social]]}
   [definition-id {:keys [database]}]
   (db.postgres/get-by-definition definition-id database))
+
+(defn get-top-authors
+  {:malli/schema [:=> [:cat :int schemas.types/Components]
+                  [:maybe [:sequential schemas.model.social/Author+Interactions]]]}
+  [limit {:keys [database]}]
+  (db.postgres/get-top-authors limit database))
+
+(defn get-latest-interactions
+  {:malli/schema [:=> [:cat :int schemas.types/Components]
+                  [:maybe [:sequential schemas.model.social/AnySocial]]]}
+  [limit {:keys [database]}]
+  (db.postgres/get-latest-interactions limit database))

src/codes/clj/docs/backend/db/postgres.clj

@@ -293,3 +293,46 @@
            sql/format)
        (execute! db)
        adapters/db->social-definition))
+
+(defn get-top-authors
+  {:malli/schema [:=> [:cat :int schemas.types/DatabaseComponent]
+                  [:maybe [:sequential schemas.model.social/Author+Interactions]]]}
+  [limit db]
+  (->> (-> (sql.helpers/select
+            :author/*
+            [[:count :social/id] :interactions])
+           (sql.helpers/from [(sql.helpers/union-all
+                               (-> (sql.helpers/select
+                                    [:note/note-id :id]
+                                    [:note/author-id :author-id])
+                                   (sql.helpers/from :note))
+                               (-> (sql.helpers/select
+                                    [:example-edit/example-edit-id :id]
+                                    [:example-edit/author-id :author-id])
+                                   (sql.helpers/from :example-edit))
+                               (-> (sql.helpers/select
+                                    [:see-also/see-also-id :id]
+                                    [:see-also/author-id :author-id])
+                                   (sql.helpers/from :see-also))) :social])
+           (sql.helpers/join :author
+                             [:= :social/author-id :author/author-id])
+           (sql.helpers/group-by :author/author-id)
+           (sql.helpers/order-by [:interactions :desc])
+           (sql.helpers/limit limit)
+           sql/format)
+       (execute! db)
+       adapters/db->author+interaction))
+
+(defn get-latest-interactions
+  {:malli/schema [:=> [:cat :int schemas.types/DatabaseComponent]
+                  [:maybe [:sequential schemas.model.social/AnySocial]]]}
+  [limit db]
+  (->> (-> (sql.helpers/union-all
+            get-note-query
+            get-example-query
+            get-see-also-query)
+           (sql.helpers/order-by [:created :desc])
+           (sql.helpers/limit limit)
+           sql/format)
+       (execute! db)
+       adapters/db->any-socials))

src/codes/clj/docs/backend/ports/http_in/social.clj

@@ -155,3 +155,19 @@
             :notes []
             :examples []
             :see-alsos []})})
+
+(defn get-top-authors
+  [{{{:keys [limit]} :query} :parameters
+    components :components}]
+  {:status 200
+   :body (-> (or limit 10)
+             (controllers.social/get-top-authors components)
+             adapters.social/author-interaction->model->wire)})
+
+(defn get-latest-interactions
+  [{{{:keys [limit]} :query} :parameters
+    components :components}]
+  {:status 200
+   :body (-> (or limit 10)
+             (controllers.social/get-latest-interactions components)
+             adapters.social/any-social->model->wire)})

src/codes/clj/docs/backend/routes.clj

@@ -169,7 +169,24 @@
               :responses {200 {:body schemas.wire.out.social/Social}
                           404 {:body :string}
                           500 {:body :string}}
-              :handler ports.http-in.social/get-by-definition}}]]]
+              :handler ports.http-in.social/get-by-definition}}]]
+
+     ["/query"
+      ["/top-authors"
+       {:get {:summary "get top contributing author list"
+              :parameters {:query [:map [:limit {:optional true} :int]]}
+              :responses {200 {:body [:sequential schemas.wire.out.social/Author+Interactions]}
+                          404 {:body :string}
+                          500 {:body :string}}
+              :handler ports.http-in.social/get-top-authors}}]
+
+      ["/latest-interactions"
+       {:get {:summary "get latest social interactions list"
+              :parameters {:query [:map [:limit {:optional true} :int]]}
+              :responses {200 {:body [:sequential schemas.wire.out.social/AnySocial]}
+                          404 {:body :string}
+                          500 {:body :string}}
+              :handler ports.http-in.social/get-latest-interactions}}]]]
 
     ["/document"
      {:swagger {:tags ["document"]}}

src/codes/clj/docs/backend/schemas/db/postgres.clj

@@ -44,3 +44,6 @@
                        :account-source
                        :avatar-url
                        :created-at]))
+
+(def Author+InteractionsRow
+  (mu/assoc AuthorRow :interactions :int))

src/codes/clj/docs/backend/schemas/model/social.clj

@@ -111,5 +111,11 @@
    [:social/examples [:sequential Example]]
    [:social/see-alsos [:sequential SeeAlso]]])
 
+(def AnySocial
+  [:or Example Note SeeAlso])
+
 (def Author+Socials
   (mu/assoc Author [:author/socials {:optional true}] [:sequential Social]))
+
+(def Author+Interactions
+  (mu/assoc Author :author/interactions :int))

src/codes/clj/docs/backend/schemas/wire/out/social.clj

@@ -33,5 +33,11 @@
    [:examples [:sequential Example]]
    [:see-alsos [:sequential SeeAlso]]])
 
+(def AnySocial
+  [:or Example Note SeeAlso])
+
 (def Author+Socials
   (mu/assoc Author [:socials {:optional true}] [:sequential Social]))
+
+(def Author+Interactions
+  (mu/assoc Author :interactions :int))