GetPrinciple renamed to GetPrincipal * ⎕DFs added/improved

Author: aplteam

APLSource/GitHubAPIv3.aplc

@@ -10,13 +10,18 @@
 
     ∇ r←Version
       :Access Public Shared
-      r←'GitHubAPIv3' '1.2.0' '2024-03-19'
+      r←'GitHubAPIv3' '1.2.0' '2024-04-28'
     ∇
 
     ∇ History
       :Access Public Shared
     ⍝ * 1.2.0
-    ⍝   * Dependencies updated
+    ⍝   * Instances of GitHubAPIv3 now have a useful display format: for a user "foo" it shows GitHubAPIv3[foo]
+    ⍝   * The name of the function `GetPrinciple` was changed to `GetPrincipal`
+    ⍝   * When Assert signals an error not only the message but also the HTTP code is returned as in "Not found (404)"
+    ⍝   * Package dependencies updated
+    ⍝   * Bug fixes
+    ⍝     * The DF of an issue was wrong ("Issues" rather than "Issue"). While on it the issue number was added.
     ⍝ * 1.1.0
     ⍝   Dependencies updated: HttpCommand and APLTreeUtil2
     ⍝ * 1.0.1
@@ -52,6 +57,7 @@
       _regEx←'setup_<repoName>_<version>[.\]*.[0-9]{0,6}\.exe'  ⍝ After version there _might_ be a built number
       A←(⊃⊃⎕CLASS ⎕THIS).##.APLTreeUtils2
       H←(⊃⊃⎕CLASS ⎕THIS).##.HttpCommand
+      ⎕DF'GitHubAPIv3[',owner,']'
     ∇
 
     ∇ ns←GetLatestReleaseInfo repoName;gitPath
@@ -131,16 +137,16 @@
       :Access Public Instance
     ⍝ Returns all issues for a given repository but no pull requests by default.\\
     ⍝ In GitHub, every pull request is an issue, but not all issues are pull requests.
-    ⍝ You can enforce Pull Requests by passing a 1 as left argument.
+    ⍝ You can enforce the addition of Pull Requests by passing a 1 as left argument.
       addPullRequests←{0<⎕NC ⍵:⍎⍵ ⋄ 0}'addPullRequests'
       gitPath←'https://api.github.com/repos/',(_owner),'/',repoName,'/issues'
       ns←GetJson gitPath
       :If ~addPullRequests
           ns←(0=⊃¨ns.⎕NC⊂'pull_request')/ns
       :EndIf
-      ns.{⎕DF'[Issues of repo ',⍵,']'}⊂repoName
+      ns.⎕DF(repoName,' issue ')∘,¨(⍕¨ns.number)
       ns.⎕FX⊂⎕CR'∆List'
-      ns.⎕FX⊂'r←∆Details instance' 'r←∆List' ' :If 0<≢instance' 'r(instance.GetPrinciple)←''assignees'' ''login''' 'r(instance.GetPrinciple)←''labels'' ''name''' ':EndIf'
+      ns.⎕FX⊂'r←∆Details instance' 'r←∆List' ' :If 0<≢instance' 'r(instance.GetPrincipal)←''assignees'' ''login''' 'r(instance.GetPrincipal)←''labels'' ''name''' ':EndIf'
       ns.⎕FX⊂'r←∆QuickView instance;keyWords' 'r←∆Details instance' 'keyWords←''title'' ''number'' ''state'' ''updated_at'' ''labels'' ''assignees''' 'r←(r[;1]∊keyWords)⌿r' 'r←r[⍋keyWords⍳r[;1];]'
     ∇
 
@@ -155,7 +161,7 @@
       ns←GetJson gitPath
       ns.{⎕DF ⍵}'[Issue ',(⍕number),' of repo ',repoName,']'
       ns.⎕FX ⎕CR'∆List'
-      ns.⎕FX'r←∆Details instance' 'r←∆List' 'r(instance.GetPrinciple)←''assignees'' ''login''' 'r(instance.GetPrinciple)←''labels'' ''name'''
+      ns.⎕FX'r←∆Details instance' 'r←∆List' 'r(instance.GetPrincipal)←''assignees'' ''login''' 'r(instance.GetPrincipal)←''labels'' ''name'''
       ns.⎕FX'r←∆QuickView instance;keyWords' 'r←∆Details instance' 'keyWords←''title'' ''number'' ''state'' ''updated_at'' ''labels'' ''assignees''' 'r←(r[;1]∊keyWords)⌿r' 'r←r[⍋keyWords⍳r[;1];]'
     ∇
 
@@ -312,7 +318,7 @@
       :EndIf
       h.URL←EncodeBlank gitURL
       r←h.Run
-      r.HttpMessage Assert r.HttpStatus=200
+      (r.HttpMessage,' (',(⍕r.HttpStatus),')')Assert r.HttpStatus=200
       data←⎕JSON r.Data
       noOfPages←GetNoOfPages r.Headers
       :If 0<noOfPages
@@ -321,32 +327,30 @@
           link←2⊃r.Headers[ind;]
           h.URL←{¯1↓1↓⍵↑⍨¯1+⍵⍳';'}link
           r2←h.Run
-          r.HttpMessage Assert r.HttpStatus≠200 Assert 200=r.HttpStatus
+          (r.HttpMessage,' (',(⍕r.HttpStatus),')')Assert r.HttpStatus=200
           data,←⎕JSON r2.Data
           :If 2<noOfPages
               ⍝ Fetch all remaining pages
               links←({¯2↓1↓⍵↑⍨¯1+⍵⍳';'}link)∘{⍺,⍕⍵}¨2↓⍳noOfPages
               :For link :In links
                   h.URL←link
                   r2←h.Run
-                  r.HttpMessage Assert r.HttpStatus=200
+                  (r.HttpMessage,' (',(⍕r.HttpStatus),')')Assert r.HttpStatus=200
                   data,←⎕JSON r2.Data
               :EndFor
           :EndIf
       :EndIf
     ∇
 
-    ∇ data←data GetPrinciple(propName principleName);row;jsonObj;buff
-    ⍝ * `propName` is the name of a variable in a data space that is one or more JSON object(s)
-    ⍝ * `principleName` is the principle name of all the properties of that JSON object\\
+    ∇ data←data GetPrincipal(propName principalName);row;jsonObj;buff
+    ⍝ * `propName` is the name of a variable in `data` holding one or more JSON object(s).\\
+    ⍝ * `principalName` is the principal name of that JSON object or JSON objects.\\
     ⍝   Typical examples are "label" or "name"\\
-    ⍝ The generic names are then replaced but the "real" ones.
-    ⍝ Is concatenated with a comma and a blank, so ('bug' 'question') become:
-    ⍝ 'bug, question'
+    ⍝ The generic names are then replaced but the real data.
       :Access Public instance
       row←data[;1]⍳⊂propName
       :If 0≠≢jsonObj←2⊃data[row;]
-          buff←jsonObj⍎¨⊂principleName
+          buff←jsonObj⍎¨⊂principalName
           data[row;2]←{⍺,', ',⍵}/buff
       :EndIf
     ∇

APLSource/TestCases/Test_GetRelease_008.aplf

@@ -8,7 +8,7 @@
      →T.FailsIf 1
  :Else
      dmx←⎕DMX
-     →T.PassesIf'Not Found'≡dmx.EM
+     →T.PassesIf'Not Found (404)'≡dmx.EM
  :EndTrap
 
  R←T._OK

TestResults/CodeCoverage.cr

@@ -19,5 +19,5 @@
   source: "APLSource/GitHubAPIv3.aplc",
   tags: "github-utilities",
   userCommandScript: "",
-  version: "1.1.0+35",
+  version: "1.2.0+37",
 }