Get all topics attached to a repo. (#8)

Author: eamonnsullivan

README.md

@@ -10,6 +10,30 @@ You will need a Github access token with `repo` permissions. This is one way to
 ```clojure
 (def token (System/getenv "GITHUB_ACCESS_TOKEN"))
 ```
+### Core functions
+```clojure
+(require '[eamonnsullivan.github-api-lib.core :as core])
+
+(core/get-repo-id token "https://github.com/eamonnsullivan/github-api-lib")
+;; "MDEwOlJlcG9zaXRvcnkzMDYxMjYwNDY="
+
+(core/get-repo-topics token "eamonnsullivan/github-api-lib")
+;; ["clojure" "clojars" "github-graphql"]
+
+;; make your own graphql query
+(def get-repo-id
+   "query getRepoId ($owner: String!, $name: String!) {
+      repository(owner:$owner, name:$name) {
+        id
+      }
+    }
+   ")
+
+(core/make-graphql-post
+   token
+   get-repo-id
+   {:owner "eamonnsullivan" :name "github-api-lib"})
+```
 ### Pull Requests
 
 ```clojure

pom.xml

@@ -3,7 +3,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>eamonnsullivan</groupId>
   <artifactId>github-api-lib</artifactId>
-  <version>0.1.16</version>
+  <version>0.1.17</version>
   <name>github-api-lib</name>
   <description>Library of Github API calls that I happen to need.</description>
   <url>https://github.com/eamonnsullivan/github-api-lib</url>
@@ -15,7 +15,7 @@
   </licenses>
   <developers>
     <developer>
-      <name>Eamonn</name>
+      <name>Eamonn Sullivan</name>
     </developer>
   </developers>
   <scm>

resources/graphql/repo-topic-query.graphql

@@ -0,0 +1,17 @@
+query RepoTopicQuery ($repoId: ID!, $first: Int!, $after: String) {
+  node(id: $repoId) {
+    ... on Repository {
+      repositoryTopics(first: $first, after: $after) {
+        nodes {
+          topic {
+            name
+          }
+        }
+        pageInfo {
+          hasNextPage
+          endCursor
+        }
+      }
+    }
+  }
+}

src/eamonnsullivan/github_api_lib/core.clj

@@ -3,6 +3,8 @@
             [clojure.data.json :as json]
             [clojure.java.io :as io]))
 
+(def ^:dynamic *default-page-size* 10)
+
 (def github-url "https://api.github.com/graphql")
 
 (defn request-opts
@@ -96,26 +98,26 @@
                  some? some?
                  initk nil}}]
   (reify
-   clojure.lang.Seqable
-   (seq [_]
-        ((fn next [ret]
-           (when (some? ret)
-             (cons (vf ret)
-                   (when-some [k (kf ret)]
-                     (lazy-seq (next (step! k)))))))
-         (step! initk)))
-   clojure.lang.IReduceInit
-   (reduce [_ rf init]
-           (loop [acc init
-                  ret (step! initk)]
-             (if (some? ret)
-               (let [acc (rf acc (vf ret))]
-                 (if (reduced? acc)
-                   @acc
-                   (if-some [k (kf ret)]
-                     (recur acc (step! k))
-                     acc)))
-               acc)))))
+    clojure.lang.Seqable
+    (seq [_]
+      ((fn next [ret]
+         (when (some? ret)
+           (cons (vf ret)
+                 (when-some [k (kf ret)]
+                   (lazy-seq (next (step! k)))))))
+       (step! initk)))
+    clojure.lang.IReduceInit
+    (reduce [_ rf init]
+      (loop [acc init
+             ret (step! initk)]
+        (if (some? ret)
+          (let [acc (rf acc (vf ret))]
+            (if (reduced? acc)
+              @acc
+              (if-some [k (kf ret)]
+                (recur acc (step! k))
+                acc)))
+          acc)))))
 
 (defn get-all-pages
   "Convenience function for getting all of the results from a paged search.
@@ -126,11 +128,57 @@
 
    Returns a flattened, realised sequence with all of the result. Don't
    use this on an infinite or very big sequence."
-  [getter results? valuesfn]
-  (let [get-next (fn [ret] (if (-> ret :data :search :pageInfo :hasNextPage)
-                             (-> ret :data :search :pageInfo :endCursor)
-                             nil))]
-    (vec (reduce
-          (fn [acc page] (concat acc page))
-          []
-          (iteration getter :vf valuesfn :kf get-next :some? results?)))))
+  ([getter results? valuesfn]
+   (let [get-next (fn [ret] (if (-> ret :data :search :pageInfo :hasNextPage)
+                              (-> ret :data :search :pageInfo :endCursor)
+                              nil))]
+     (get-all-pages getter results? valuesfn get-next)))
+  ([getter results? valuesfn get-nextfn]
+   (vec (reduce
+         (fn [acc page] (concat acc page))
+         []
+         (iteration getter :vf valuesfn :kf get-nextfn :some? results?)))))
+
+(defn get-repo-id
+  "Get the unique ID value for a repository."
+  ([access-token url]
+   (let [repo (parse-repo url)
+         owner (:owner repo)
+         name (:name repo)]
+     (when repo
+       (get-repo-id access-token owner name))))
+  ([access-token owner repo-name]
+   (let [variables {:owner owner :name repo-name}]
+     (-> (make-graphql-post
+          access-token
+          (get-graphql "get-repo-id-query")
+          variables)
+         :data
+         :repository
+         :id))))
+
+(defn get-topics
+  [page]
+  (into [] (map #(str (-> % :topic :name))
+                (-> page :data :node :repositoryTopics :nodes))))
+
+(defn get-page-of-topics
+  "Get a page of topics on a repo"
+  [access-token repo-id page-size cursor]
+  (-> (make-graphql-post
+       access-token
+       (get-graphql "repo-topic-query")
+       {:repoId repo-id :first page-size :after cursor})))
+
+(defn get-repo-topics
+  "Get all of the topics attached to a repo."
+  ([access-token url]
+   (get-repo-topics access-token url *default-page-size*))
+  ([access-token url page-size]
+   (let [repo-id (get-repo-id access-token url)
+         get-page (partial get-page-of-topics access-token repo-id page-size)
+         results? (fn [page] (some? (get-topics page)))
+         get-next (fn [ret] (if (-> ret :data :node :repositoryTopics :pageInfo :hasNextPage)
+                              (-> ret :data :node :repositoryTopics :pageInfo :endCursor)
+                              nil))]
+     (get-all-pages get-page results? get-topics get-next))))

src/eamonnsullivan/github_api_lib/pull_requests.clj

@@ -26,24 +26,6 @@
         body (json/read-str (:body response) :key-fn keyword)]
     (:node_id body)))
 
-(defn get-repo-id
-  "Get the unique ID value for a repository."
-  ([access-token url]
-   (let [repo (core/parse-repo url)
-         owner (:owner repo)
-         name (:name repo)]
-     (when repo
-       (get-repo-id access-token owner name))))
-  ([access-token owner repo-name]
-   (let [variables {:owner owner :name repo-name}]
-     (-> (core/make-graphql-post
-          access-token
-          (core/get-graphql "get-repo-id-query")
-          variables)
-         :data
-         :repository
-         :id))))
-
 (defn get-pull-request-id
   "Find the unique ID of a pull request on the repository at the
   provided url. Set must-be-open? to true to filter the pull requests
@@ -135,7 +117,7 @@
           base-branch :base
           merging-branch :branch
           draft :draft} (merge create-pr-defaults pull-request)
-         repo-id (get-repo-id access-token owner repo-name)
+         repo-id (core/get-repo-id access-token owner repo-name)
          variables {:repositoryId repo-id
                     :title title
                     :body body

test/eamonnsullivan/fixtures/repo-topic-response.json

@@ -0,0 +1,44 @@
+{
+  "data": {
+    "node": {
+      "repositoryTopics": {
+        "nodes": [
+          {
+            "topic": {
+              "name": "cps"
+            }
+          },
+          {
+            "topic": {
+              "name": "cam"
+            }
+          },
+          {
+            "topic": {
+              "name": "dpub"
+            }
+          },
+          {
+            "topic": {
+              "name": "node"
+            }
+          },
+          {
+            "topic": {
+              "name": "frontend"
+            }
+          },
+          {
+            "topic": {
+              "name": "optimo"
+            }
+          }
+        ],
+        "pageInfo": {
+          "hasNextPage": false,
+          "endCursor": "Y3Vyc29yOnYyOpHOARzyUg=="
+        }
+      }
+    }
+  }
+}

test/eamonnsullivan/github_api_lib/core_test.clj

@@ -3,6 +3,10 @@
             [clj-http.client :as client]
             [eamonnsullivan.github-api-lib.core :as sut]))
 
+(def repo-id-response-success (slurp "./test/eamonnsullivan/fixtures/repo-response-success.json"))
+(def repo-id-response-failure (slurp "./test/eamonnsullivan/fixtures/repo-response-failure.json"))
+(def repo-topic-response-success (slurp "./test/eamonnsullivan/fixtures/repo-topic-response.json"))
+
 (defn test-args-to-get
   [url opts]
   (is (= "access-token" (:username opts)))
@@ -144,3 +148,63 @@
              :kf #(if (-> % :data :search :pageInfo :hasNextPage)
                     (-> % :data :search :pageInfo :endCursor)
                     nil)))))))
+
+(deftest test-get-repo-id
+  (with-redefs [sut/http-post (fn [_ _ _] {:body repo-id-response-success})]
+    (testing "parses id from successful response"
+      (is (= "MDEwOlJlcG9zaXRvcnkyOTczNzY1NTc=" (sut/get-repo-id "secret-token" "owner" "repo-name"))))
+    (testing "handles url instead of separate owner/repo-name"
+      (is (= "MDEwOlJlcG9zaXRvcnkyOTczNzY1NTc=" (sut/get-repo-id "secret-token" "owner/repo-name")))
+      (is (= "MDEwOlJlcG9zaXRvcnkyOTczNzY1NTc=" (sut/get-repo-id "secret-token" "https://github.com/owner/repo-name")))))
+  (with-redefs [sut/http-post (fn [_ _ _] {:body repo-id-response-failure})]
+    (testing "throws exception on error"
+      (is (thrown-with-msg? RuntimeException
+                            #"Could not resolve to a Repository with the name 'eamonnsullivan/not-there'."
+                            (sut/get-repo-id "secret-token" "owner" "repo-name")))))
+  (with-redefs [sut/parse-repo (fn [_] (throw (ex-info "error" {})))]
+    (testing "passes on thrown exceptions from parse-repo"
+      (is (thrown-with-msg? RuntimeException
+                            #"error"
+                            (sut/get-repo-id "secret-token" "whatever/whatever"))))))
+
+(deftest test-get-page-of-topics
+  (with-redefs [sut/http-post (fn [_ _ _] {:body repo-topic-response-success})]
+    (testing "gets topics from a page"
+      (is (= {:data
+              {:node
+               {:repositoryTopics
+                {:nodes
+                 [{:topic {:name "cps"}}
+                  {:topic {:name "cam"}}
+                  {:topic {:name "dpub"}}
+                  {:topic {:name "node"}}
+                  {:topic {:name "frontend"}}
+                  {:topic {:name "optimo"}}],
+                 :pageInfo
+                 {:hasNextPage false, :endCursor "Y3Vyc29yOnYyOpHOARzyUg=="}}}}}
+             (sut/get-page-of-topics "secret-token" "repo-id" 10 nil))))))
+
+(defn fake-paging-response
+  [_ _ _ cursor]
+  (let [first-page {:data
+                    {:node
+                     {:repositoryTopics
+                      {:nodes
+                       [ {:topic {:name "tag1"}} {:topic {:name "tag2"}}]
+                       :pageInfo {:hasNextPage true, :endCursor "cursor"}}}}}
+        last-page {:data
+                   {:node
+                    {:repositoryTopics
+                     {:nodes
+                      [ {:topic {:name "tag3"}} {:topic {:name "tag4"}}]
+                      :pageInfo {:hasNextPage false, :endCursor "cursor2"}}}}}]
+    (if-not cursor
+      first-page
+      last-page)))
+
+(deftest test-get-repo-topics
+  (with-redefs [sut/get-repo-id (fn[_ _] "some-id")
+                sut/get-page-of-topics fake-paging-response]
+    (testing "follows pages"
+      (is (= ["tag1" "tag2" "tag3" "tag4"]
+             (sut/get-repo-topics "secret-token" "eamonnsullivan/github-api-lib"))))))

test/eamonnsullivan/github_api_lib/pull_requests_test.clj

@@ -30,24 +30,6 @@
   (fn [m]
     (= value (m key))))
 
-(deftest test-get-repo-id
-  (with-redefs [core/http-post (fn [_ _ _] {:body repo-id-response-success})]
-    (testing "parses id from successful response"
-      (is (= "MDEwOlJlcG9zaXRvcnkyOTczNzY1NTc=" (sut/get-repo-id "secret-token" "owner" "repo-name"))))
-    (testing "handles url instead of separate owner/repo-name"
-      (is (= "MDEwOlJlcG9zaXRvcnkyOTczNzY1NTc=" (sut/get-repo-id "secret-token" "owner/repo-name")))
-      (is (= "MDEwOlJlcG9zaXRvcnkyOTczNzY1NTc=" (sut/get-repo-id "secret-token" "https://github.com/owner/repo-name")))))
-  (with-redefs [core/http-post (fn [_ _ _] {:body repo-id-response-failure})]
-    (testing "throws exception on error"
-      (is (thrown-with-msg? RuntimeException
-                            #"Could not resolve to a Repository with the name 'eamonnsullivan/not-there'."
-                            (sut/get-repo-id "secret-token" "owner" "repo-name")))))
-  (with-redefs [core/parse-repo (fn [_] (throw (ex-info "error" {})))]
-    (testing "passes on thrown exceptions from parse-repo"
-      (is (thrown-with-msg? RuntimeException
-                            #"error"
-                            (sut/get-repo-id "secret-token" "whatever/whatever"))))))
-
 (defn make-fake-post
   [query-response mutation-response query-asserts mutation-asserts]
   (fn [_ payload _] (if (string/includes? payload "mutation")