Read variables in collection (closes #2)

Author: flashcode

ChangeLog.md

@@ -2,6 +2,7 @@
 
 ## Version 0.2.0 (under dev)
 
+- Read variables in collection (issue #2).
 - Import Postman environment with a collection, add support of variables, add option `impostman-use-variables` (issue #1).
 
 ## Version 0.1.0 (2021-01-11)

README.md

@@ -144,7 +144,7 @@ Function called when the output buffer is created and before parsing the collect
 
 Arguments:
 
-- `variables` (alist): variables from environment.
+- `variables` (alist): variables from collection and environment (in reverse order: latest variable read is the first one in alist).
 
 #### replace-vars
 
@@ -160,7 +160,7 @@ Note: according to the option `impostman-use-variables`, a variable is either re
 Arguments:
 
 - `string` (string): any string
-- `variables` (alist): variables from environment.
+- `variables` (alist): variables from collection and environment (in reverse order: latest variable read is the first one in alist).
 
 #### header
 
@@ -175,7 +175,7 @@ Arguments:
 
 - `name` (string): collection name (`unknown` if not found)
 - `description` (string): collection description
-- `variables` (alist): variables from environment.
+- `variables` (alist): variables from collection and environment (in reverse order: latest variable read is the first one in alist).
 
 #### item
 
@@ -191,7 +191,7 @@ Arguments:
 - `level` (integer): folder level (≥ 2)
 - `name` (string): item name
 - `description` (string): item description
-- `variables` (alist): variables from environment.
+- `variables` (alist): variables from collection and environment (in reverse order: latest variable read is the first one in alist).
 
 #### request
 
@@ -207,9 +207,9 @@ Arguments:
 - `description` (string): request description
 - `method` (string): the HTTP method (`GET`, `POST`, `PUT`, …)
 - `url` (string): request URL
-- `headers` (alist): request headers
+- `headers` (alist): request headers (in reverse order: latest header read is the first one in alist)
 - `body` (string): request body
-- `variables` (alist): variables from environment.
+- `variables` (alist): variables from collection and environment (in reverse order: latest variable read is the first one in alist).
 
 #### footer
 
@@ -223,7 +223,7 @@ Function called at the end of parsing. It must return a string which is inserted
 Arguments:
 
 - `name` (string): collection name (`unknown` if not found)
-- `variables` (alist): variables from environment.
+- `variables` (alist): variables from collection and environment (in reverse order: latest variable read is the first one in alist).
 
 #### end
 
@@ -236,7 +236,7 @@ Function called at the end. It can be used to enable a major or minor mode.
 
 Arguments:
 
-- `variables` (alist): variables from environment.
+- `variables` (alist): variables from collection and environment (in reverse order: latest variable read is the first one in alist).
 
 ## Known limitations
 

impostman.el

@@ -129,7 +129,7 @@ Return nil if the authentication is not Basic or if the base64 is invalid."
   "Replace variables in a string, using verb syntax.
 
 STRING any string that can contain variables with format \"{{variable}}\".
-VARIABLES is a alist with Postman environment variables."
+VARIABLES is a alist with Postman variables."
   (if impostman-use-variables
       (replace-regexp-in-string
        "{{\\([^}]+\\)}}" "{{(verb-var \\1)}}" (or string ""))
@@ -146,7 +146,7 @@ VARIABLES is a alist with Postman environment variables."
 
 NAME is the collection name.
 DESCRIPTION is the collection description.
-VARIABLES is a alist with Postman environment variables."
+VARIABLES is a alist with Postman variables."
   (ignore variables)
   (concat
    "* " name "  :verb:" "\n"
@@ -157,7 +157,8 @@ VARIABLES is a alist with Postman environment variables."
 
 LEVEL is the level.
 NAME is the item name.
-DESCRIPTION is the item description."
+DESCRIPTION is the item description.
+VARIABLES is a alist with Postman variables."
   (ignore variables)
   (concat
    (if (<= level 2) "\n" "")
@@ -171,10 +172,11 @@ DESCRIPTION is the request description.
 METHOD is the HTTP method.
 URL is the URL.
 HEADERS is an alist with HTTP headers.
-BODY is the request body."
+BODY is the request body.
+VARIABLES is a alist with Postman variables."
   (ignore variables)
   (let (list-headers)
-    (dolist (header headers)
+    (dolist (header (nreverse headers))
       (let* ((header-name (car header))
              (header-value (cdr header))
              (new-value header-value))
@@ -199,10 +201,10 @@ BODY is the request body."
   "Format the verb footer.
 
 NAME is the collection name.
-VARIABLES is a alist with Postman environment variables."
+VARIABLES is a alist with Postman variables."
   (let (list-vars)
     (when impostman-use-variables
-      (dolist (var variables)
+      (dolist (var (nreverse variables))
         (push
          (format "# eval: (verb-set-var \"%s\" \"%s\")" (car var) (cdr var))
          list-vars)))
@@ -217,14 +219,16 @@ VARIABLES is a alist with Postman environment variables."
      "# End:\n")))
 
 (defun impostman-output-verb-end (variables)
-  "Function evaluated at the end."
+  "Function evaluated at the end.
+
+VARIABLES is a alist with Postman variables."
   (when (fboundp 'org-mode)
     (org-mode))
   (when (fboundp 'verb-mode)
     (verb-mode))
   ;; evaluate variables now
   (when (and impostman-use-variables (fboundp 'verb-set-var))
-    (dolist (var variables)
+    (dolist (var (nreverse variables))
       (verb-set-var (car var) (cdr var)))))
 
 ;; restclient output
@@ -253,7 +257,7 @@ DESCRIPTION is the collection description.
 VARIABLES is a alist with Postman environment variables."
   (let (list-vars)
     (when impostman-use-variables
-      (dolist (var variables)
+      (dolist (var (nreverse variables))
         (push (format ":%s = %s" (car var) (cdr var)) list-vars)))
     (concat
      "# -*- restclient -*-\n"
@@ -286,7 +290,7 @@ HEADERS is an alist with HTTP headers.
 BODY is the request body."
   (ignore variables)
   (let (list-variables list-headers)
-    (dolist (header headers)
+    (dolist (header (nreverse headers))
       (let* ((header-name (car header))
              (header-value (cdr header))
              (new-value header-value))
@@ -381,7 +385,7 @@ HEADER is a vector with hash tables."
              (key (gethash "key" header-item ""))
              (value (gethash "value" header-item "")))
         (push (cons key value) headers)))
-    (nreverse headers)))
+    headers))
 
 (defun impostman--build-auth-query-string (auth)
   "Return query string parameter to add for authentication as an alist, for
@@ -424,25 +428,28 @@ QUERY-STRING is nil or an alist with query strings to add."
   url)
 
 (defun impostman--build-variables (values)
-  "Return alist with variables using values from Postman environment.
+  "Return alist with variables using values from Postman collection and
+environment.
 
-VALUES is the \"values\" read from environment (vector)."
+VALUES is the \"variable\" read from collection (vector) or \"values\" read
+from environment (vector) (or concatenation of both)."
   (let (variables)
     (dotimes (i (length (or values [])))
       (let* ((item (elt values i))
              (key (gethash "key" item ""))
              (value (gethash "value" item ""))
-             (enabled (equal t (gethash "enabled" item t))))
-        (when enabled
+             (enabled (equal t (gethash "enabled" item t)))
+             (disabled (equal t (gethash "disabled" item nil))))
+        (when (and enabled (not disabled))
           (push (cons key value) variables))))
-    (nreverse variables)))
+    variables))
 
 (defun impostman--parse-item (items level variables output-alist)
   "Parse a Postman collection item.
 
 ITEMS is the \"item\" read from collection (vector).
 LEVEL is the level.
-VARIABLES is a alist with Postman environment variables.
+VARIABLES is a alist with Postman variables.
 OUTPUT-ALIST is an alist with the output callbacks."
   (dotimes (i (length items))
     (let* ((item (elt items i))
@@ -467,7 +474,7 @@ OUTPUT-ALIST is an alist with the output callbacks."
                        (gethash "url" request (make-hash-table)) ""))
                  (auth-headers (impostman--build-auth-headers auth))
                  (other-headers (impostman--build-headers header))
-                 (headers (append auth-headers other-headers))
+                 (headers (append other-headers auth-headers))
                  (replace-vars (alist-get 'replace-vars output-alist)))
             (setq url (impostman--add-query-string-items-to-url
                        url
@@ -496,16 +503,18 @@ OUTPUT-ALIST is an alist with the output callbacks."
                                (gethash "info"
                                         collection (make-hash-table)) ""))
          (item (gethash "item" collection []))
+         (variable (gethash "variable" collection []))
          (values (gethash "values" environment []))
-         (variables (impostman--build-variables values)))
+         (all-variables (impostman--build-variables (vconcat
+                                                     variable values))))
     (pop-to-buffer (generate-new-buffer (concat name ".org")))
-    (funcall (alist-get 'init output-alist) variables)
+    (funcall (alist-get 'init output-alist) all-variables)
     (insert (funcall (alist-get 'header output-alist)
-                     name description variables))
-    (impostman--parse-item item 2 variables output-alist)
-    (insert (funcall (alist-get 'footer output-alist) name variables))
+                     name description all-variables))
+    (impostman--parse-item item 2 all-variables output-alist)
+    (insert (funcall (alist-get 'footer output-alist) name all-variables))
     (goto-char (point-min))
-    (funcall (alist-get 'end output-alist) variables)
+    (funcall (alist-get 'end output-alist) all-variables)
     values))
 
 ;;;###autoload

tests/custom.org

@@ -4,12 +4,14 @@
 # - Authentication
 # - Anything.
 
+VAR(var1) = value1_collection
 VAR(url) = https://httpbin.org
 VAR(variable_delete) = value_delete
 VAR(variable_get) = value_get
 VAR(header-api-key) = x-api-key
 VAR(query-api-key) = key
 VAR(api-key) = my_secret_key
+VAR(var1) = value1_env
 
 ** http_methods
 *** delete
@@ -38,7 +40,8 @@ x-test2: second_value
     "list": [
         "first",
         "second"
-    ]
+    ],
+    "var1": "$(var1)"
 }
 *** put
 # A PUT request.

tests/custom_no_vars.org

@@ -31,7 +31,8 @@ x-test2: second_value
     "list": [
         "first",
         "second"
-    ]
+    ],
+    "var1": "value1_env"
 }
 *** put
 # A PUT request.

tests/httpbin.postman_collection.json

@@ -146,7 +146,7 @@
 						],
 						"body": {
 							"mode": "raw",
-							"raw": "{\n    \"test\": \"value\",\n    \"list\": [\n        \"first\",\n        \"second\"\n    ]\n}"
+							"raw": "{\n    \"test\": \"value\",\n    \"list\": [\n        \"first\",\n        \"second\"\n    ],\n    \"var1\": \"{{var1}}\"\n}"
 						},
 						"url": {
 							"raw": "{{url}}/post?search=test",
@@ -379,5 +379,16 @@
 				]
 			}
 		}
+	],
+	"variable": [
+		{
+			"key": "var1",
+			"value": "value1_collection"
+		},
+		{
+			"key": "var2-not-enabled",
+			"value": "value2_collection",
+			"disabled": true
+		}
 	]
 }

tests/httpbin.postman_environment.json

@@ -32,13 +32,18 @@
 			"value": "my_secret_key",
 			"enabled": true
 		},
+		{
+			"key": "var1",
+			"value": "value1_env",
+			"enabled": true
+		},
 		{
 			"key": "not-enabled",
 			"value": "some_value",
 			"enabled": false
 		}
 	],
 	"_postman_variable_scope": "environment",
-	"_postman_exported_at": "2021-01-17T11:54:06.814Z",
-	"_postman_exported_using": "Postman/7.36.1"
+	"_postman_exported_at": "2021-08-14T10:06:37.886Z",
+	"_postman_exported_using": "Postman/8.10.0"
 }