@naanlang/naan 1.0.0

package/plugins/serviceGitHub/psm_github.nlg

@@ -0,0 +1,205 @@
+/*
+ * psm_ghub.nlg
+ * serviceGitHub
+ *
+ *     PSM connector for GitHub for browser and NodeJS.
+ *
+ * column positioning:                          //                          //                      !
+ *
+ * Copyright (c) 2021 by Richard C. Zulch
+ *
+ */
+
+
+/*
+ * phubConnector
+ *
+ *     Make a PSM connector for GitHub access.
+ *
+ */
+
+closure phubConnector(psm, local connClassID, connector, watch) {
+    connClassID = "GHUB"
+    require("./gitops.nlg")
+    connector = new(object, this)
+    connector.psm = psm
+    connector.vault = psm.vault(connClassID)
+    connector.label = "GitHub"
+    watch = psm.watchable(connector)
+
+    // uifields
+    //
+    // Report the UI fields we need to add a resource
+    connector.uifields = function uifields() {
+        [{
+            label:          "Username"
+            placeholder:    "GitHub username or email"
+            key:            "userName" },
+        {
+            label:          "Password"
+            placeholder:    "Personal Access Token"
+            key:            "userPat"
+            type:           "password" }
+        ]
+    }
+
+    // findResource
+    //
+    // Find a resource with the specified contents, returning the resID or false. The loose criteria
+    // is: if added, would the specified contents be redundant to an existing resource?
+    connector.findResource = function findResource(resource, local resID, creds) {
+        for resID in listResources().1 {
+            creds = access(resID).1
+            if resource.userName == creds.userName
+                return (resID)
+        }
+        false
+    }
+    
+    // hashResourceID
+    //
+    // Make a stable hash based on the resource credentials that we can persist or share between
+    // different domains accessing the same resource.
+    connector.hashResourceID = function hashResourceID(resource, local ident) {
+        ident = resource.userName
+        if resource.label
+            ident = ident.concat(resource.label)
+        HashSHA256(ident)
+    }
+
+    // addResource
+    //
+    // Add credentials for a named resource. The label is a string. The resource is a dictionary
+    // comprising these keys:
+    //      label       - [optional] label we use for this resource
+    //      userName    - GitHub user name
+    //      userPat     - GitHUB Personal Access Token
+    //      hidden      - [optional] don't enumerate to user
+    //      locked      - [optional] don't allow user delete
+    // The return value is (error, result) tuple. Error, if non-false, is a dictionary of field
+    // keys and error diagnostic strings. The special key "label" refers to the label string.
+    connector.addResource = function addResource(resource, local label, errors, creds, error, resID, data) {
+        function badField(str) { !string(str) || str.trim().length == 0 } 
+        creds = { 
+            userName: resource.userName,
+            userPat: resource.userPat
+        }
+        errors = { }
+        if resource.label
+            creds.label = resource.label
+        else
+            creds.label = resource.region.concat("-", resource.bucketName)
+        if badField(creds.label)
+            errors.label = "invalid label"
+        if badField(resource.userName)
+            errors.userName = "required field"
+        if badField(resource.userPat)
+            errors.userPat = "required field"
+        if length(errors) > 0
+            error = errors
+        else {
+            if resource.hidden
+                creds.hidden = resource.hidden
+            if resource.locked
+                creds.locked = resource.locked
+            resID = hashResourceID(resource)
+            `(error, data) = connector.vault.addResource(resID, creds)
+            if data {
+                watch.notify(connClassID, { added: [resID] })
+                data = resID }
+        }
+        list(error, data)
+    }
+
+    // deleteResource
+    //
+    // Delete credentials for a resource
+    connector.deleteResource = function deleteResource(resID) {
+        connector.vault.deleteResource(resID)
+        watch.notify(connClassID, { deleted: [resID] })
+        list(false, { ok: true})
+    }
+        
+    // listResources
+    //
+    // List saved resources in our database
+    connector.listResources = function listResources() {
+        connector.vault.listResources()
+    }
+    
+    // info
+    //
+    // Return info for a resource.
+    connector.info = function info(resID, local error, creds, info) {
+        info = {
+            classID: "GitHub"
+            type: "GitHub"
+            services: ["GitAPI"]
+        }
+        `(error, creds) = connector.vault.accessResource(resID)
+        if creds {
+            if creds.label
+                info.name = creds.label
+            if creds.locked
+                info.locked = true
+            if creds.hidden
+                info.hidden = true
+            info.where = creds.userName
+        }
+        list(false, info)
+    }
+
+    // access
+    //
+    // Return an S3 access object, which is the credentials to access an ghub S3 bucket.
+
+    connector.access = function access(resID, local error, creds, ghub) {
+        `(error, creds) = connector.vault.accessResource(resID)
+        if error
+            return (list(error))                                            // can't access that resource
+        ghub = {
+            userName:           creds.userName,
+            userPat:            creds.userPat }
+        list(false, ghub)
+    }
+
+    // connect
+    //
+    // Connect to an ghub bucket filesystem, returning a view.
+    
+    connector.connect = function connect(resID, service, args, local error,  ghub, gitremote, table) {
+        `(error, ghub) = connector.access(resID)
+        if !error
+            `(error, gitremote) = GitHubOps(ghub)                           // get GitHub as a git remote
+        if error
+            list(error)
+        else if service == "GitAPI"
+            list(false, gitremote)
+        else
+            list(Error("unsupported service", service))
+    }
+
+    // finis
+    
+    psm.register(connClassID, connector)
+    connector
+};
+
+
+/*
+ * phubInit
+ *
+ *     Initialize the ghub module.
+ *
+ */
+
+function phubInit(local manifest) {
+
+    manifest = `(phubConnector, phubInit)
+
+    Naan.module.build(module.id, "psm_github", function(modobj, compobj) {
+        compobj.manifest = manifest
+        modobj.exports.GitHubConnector = phubConnector
+        Naan.module.require("./serviceGitHub.nlg")
+    })
+} ();

package/plugins/serviceGitHub/serviceGitHub.nlg

@@ -0,0 +1,65 @@
+/*
+ * serviceGitHub.nlg
+ * serviceGitHub
+ *
+ *     GitHub access for browser and NodeJS.
+ *
+ * column positioning:                          //                          //                      !
+ *
+ * Copyright (c) 2021 by Richard C. Zulch
+ *
+ */
+
+
+/*
+ * ghubReload
+ *
+ */
+
+function ghubReload() {
+    jspath = js.r("path")
+    if js.w {
+        hashMD5 = function browserMD5(text) {
+            js.w.SparkMD5.hash(text) }
+        hashMD5_base64 = function browserMD5_base64(text) {
+            js.w.btoa(js.w.SparkMD5.hash(text, true)) }
+        textEncoder = js.w.TextEncoder
+        textDecoder = js.w.TextDecoder
+        atob = js.w.atob
+        btoa = js.w.btoa
+        encodeURIComponent = js.w.encodeURIComponent
+        JSON = js.w.JSON }
+    else if js.g {
+        if !crypto
+            crypto = js.r("crypto")
+        hashMD5 = function nodejsMD5(text) {
+            crypto.createHash("MD5").update(text).digest("hex") }
+        hashMD5_base64 = function nodejsMD5_base64(text) {
+            crypto.createHash("MD5").update(text).digest("base64") }
+        textEncoder = js.g.TextEncoder
+        textDecoder = js.g.TextDecoder
+        atob = js.g.atob
+        btoa = js.g.btoa
+        encodeURIComponent = js.g.encodeURIComponent
+        JSON = js.g.JSON }
+    LoadNotify(ghubReload)
+}();
+
+
+/*
+ * ghubInit
+ *
+ *     Initialize the GitHub module.
+ *
+ */
+
+function ghubInit(local manifest) {
+
+    manifest = `(ghubReload, ghubInit)
+
+    Naan.module.build(module.id, "serviceGitHub", function(modobj, compobj) {
+        compobj.manifest = manifest
+    })
+    require("frameworks/common", { in: naanlib }).LiveImport()
+    require("./psm_github.nlg").GitHubConnector(App.psm)
+} ();