Merge pull request #49 from BidnessForB/implement-save-to-postman

Implement save to postman

Author: bryancross

src/main/java/com/postman/collection/Collection.java

@@ -26,6 +26,8 @@
 import java.util.HashMap;
 import java.net.http.HttpClient;
 import java.net.http.HttpRequest;
+import java.net.http.HttpResponse;
+
 
 import java.net.http.HttpResponse.BodyHandlers;
 
@@ -530,7 +532,7 @@ public static Collection pmcFactory(URL collectionURL) throws IOException, Inter
             if(apiToken == null) {
                 throw new IllegalArgumentException("No Postman API Key configured");
             }
-
+            
             // create a request
             var request = HttpRequest.newBuilder(
                 URI.create(collectionURL.toString()))
@@ -694,6 +696,88 @@ public void writeToFile(File outputFile) throws IOException {
             throw(e);
         }
     }
+    public void updateInPostman(PostmanID workspaceID) {
+
+    }
+    /** 
+     * 
+     * Write this collections generated JSON to a file at the specified path.  Note that the order of elements in the resulting file is not guaranteed and may not match 
+     * a corresponding Postman generated file.  However, this does not affect the validity or functionality of the generated JSON.
+     * 
+     * @param outputFile The file into which to write the JSON
+     * @throws IOException If there is an error attempting to create or write to the specified path
+     */
+    public PostmanID upsertToPostman(PostmanID workspaceID) throws IOException, InterruptedException, CollectionNotFoundException, InvalidCollectionActionException {
+        String colData = this.toJson();
+        colData = colData.substring(colData.indexOf("\"item\":"));
+        String apiURL = "https://api.getpostman.com/collections";
+        
+        var client = HttpClient.newHttpClient();
+        String colHeaderJSON = "{\"collection\": { \"info\": {\"name\": \"" + this.getName() + "\", \"schema\": \"https://schema.getpostman.com/json/collection/v2.1.0/collection.json\"},";
+        
+        String bodyJSON = colHeaderJSON + colData + "}";
+
+        String apiToken = System.getenv("POSTMAN_API_KEY");
+            if(apiToken == null) {
+                throw new IllegalArgumentException("No Postman API Key configured");
+            }
+
+        HttpRequest request = null;    
+        if(this.getPostmanID() == null) {
+            //In this case we are creating
+            if(workspaceID != null && workspaceID.getID().length() > 0) 
+                apiURL = apiURL + "?workspace=" + workspaceID.getID();
+
+            request = HttpRequest.newBuilder(
+                URI.create(apiURL))
+            .header("accept", "application/json")
+            .header("x-api-key",apiToken)
+            
+            .POST(HttpRequest.BodyPublishers.ofString(bodyJSON))
+            .build();
+        }
+        else if (this.getPostmanID() != null) {
+            apiURL = apiURL + "/" + this.getPostmanID();
+            request = HttpRequest.newBuilder(
+                URI.create(apiURL))
+            .header("accept", "application/json")
+            .header("x-api-key",apiToken)
+            
+            .PUT(HttpRequest.BodyPublishers.ofString(bodyJSON))
+            .build();
+        }    
+        
+            var response = client.send(request, BodyHandlers.ofString());
+            
+        
+            if(response.statusCode() == 200) {
+                GsonBuilder gsonBuilder = new GsonBuilder();
+                Gson customGson = gsonBuilder.create();
+            
+
+            // use the client to send the request
+            
+            Type hashType = new TypeToken<HashMap<String,HashMap<String, String>>>() {}.getType();  
+            HashMap<String, HashMap<String, String>> respJSON = customGson.fromJson(response.body(), hashType);
+            this.setPostmanID(respJSON.get("collection").get("id").toString());
+            
+            }
+            else if(response.statusCode() == 404) {
+                throw new CollectionNotFoundException("Collection not found or invalid endopint");
+            }
+            else 
+            {
+                throw new InvalidCollectionActionException("An error occurred retrieving the collection" + (response.body() == null ? "[no response info]" : response.body()));
+            }
+            
+            return new PostmanID(this.getPostmanID());            
+            
+            
+            
+       
+    }
+
+
 
 
     /** 

src/main/resources/com/postman/collection/auth.postman_collection.json

@@ -1,6 +1,6 @@
 {
 	"info": {
-		"_postman_id": "024e0a8d-d970-4694-aa41-e23742e5c447",
+		"_postman_id": "23889826-169dff8a-c684-4ccc-b8df-7ad436efda57",
 		"name": "Auth",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
 		"_exporter_id": "23889826"

src/test/java/com/postman/collection/AppTest.java

@@ -15,6 +15,8 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.io.File;
+
+import org.apache.commons.collections4.functors.FalsePredicate;
 import org.junit.Test;
 
 import com.networknt.schema.ValidationMessage;
@@ -25,6 +27,7 @@
 import java.nio.file.DirectoryStream;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.security.Timestamp;
 import java.nio.file.Files;
 import java.io.IOException;
 import java.net.MalformedURLException;
@@ -1519,6 +1522,90 @@ public void testParentChain() {
 
 
 
+    }
+
+    @Test
+    public void testWriteToPostman() {
+        Collection pmcTest = Collection.pmcFactory();
+        Collection pmcTest2 = null;
+        BodyElement body = null;
+        RequestBody req = null;
+        Response resp = null;
+        String colName = new java.sql.Timestamp(System.currentTimeMillis()).toString();
+        //Test creating a new collection
+        try {
+            
+            body = new BodyElement(enumRequestBodyMode.URLENCODED);
+            body.setFormdata("x-field-1", "value 1", "This is value 1");
+            body.setFormdata("x-field-2", "value 2", "This is value 2");
+            req = new RequestBody(enumHTTPRequestMethod.POST, "https://postman-echo.com/post");
+            req.setBody(body);
+            resp = new Response("NORMAL Urlencoded", req, "OK", 200, "this is the expected response body");
+            pmcTest.addRequest(req, "URLEncoded body", resp);
+            pmcTest.setName("UPSERT test " + colName);
+        }
+        catch(Exception eee) {
+            eee.printStackTrace();
+            assertTrue("Exception creating test collection: " + eee.getMessage(), false);
+        }
+        
+        try {
+            assertNull("No postmanID before upsert: ", pmcTest.getPostmanID());
+            pmcTest.upsertToPostman(null);
+            assertNotNull("Postman ID successfully assigned: " , pmcTest.getPostmanID());
+        }
+        catch(Exception e) {
+            e.printStackTrace();
+            assertTrue("Exception upserting new collection to Postman: " + e.getMessage(), false);
+        }
+
+        //Upsert a collection to a workspace
+        try {
+            
+            body = new BodyElement(enumRequestBodyMode.URLENCODED);
+            body.setFormdata("x-field-1", "value 1", "This is value 1");
+            body.setFormdata("x-field-2", "value 2", "This is value 2");
+            req = new RequestBody(enumHTTPRequestMethod.POST, "https://postman-echo.com/post");
+            req.setBody(body);
+            resp = new Response("NORMAL Urlencoded", req, "OK", 200, "this is the expected response body");
+            pmcTest.addRequest(req, "URLEncoded body", resp);
+            pmcTest.setName("UPSERT test to Workspace" + colName);
+            pmcTest.upsertToPostman(new PostmanID("23889826-169dff8a-c684-4ccc-b8df-7ad436efda57"));
+        }
+        catch(Exception eee) {
+            eee.printStackTrace();
+            assertTrue("Exception creating test collection: " + eee.getMessage(), false);
+        }
+
+        //Fetch a known collection from Postman, change the name, then Upsert it
+       try {
+        
+        pmcTest    = Collection.pmcFactory(new PostmanID("23889826-169dff8a-c684-4ccc-b8df-7ad436efda57"));
+        String origName = pmcTest.getName();
+        pmcTest.setName(origName + "- UPSERTED");
+        pmcTest.upsertToPostman(null);
+        pmcTest    = Collection.pmcFactory(new PostmanID("23889826-169dff8a-c684-4ccc-b8df-7ad436efda57"));
+        assertTrue(pmcTest.getName().equals(origName + "- UPSERTED"));
+       }
+       catch(Exception ee) {
+        ee.printStackTrace();
+        assertTrue("Exception writing known collection: " + ee.getMessage(), false);
+       }
+
+
+        try {
+            //read in a collection with an ID
+            pmcTest  = Collection.pmcFactory(new File(filePath + resourcePath + "/auth.postman_collection.json"));
+            pmcTest.setName("Auth renamed again " + new java.sql.Timestamp(System.currentTimeMillis()));
+            pmcTest.upsertToPostman(null);
+        }
+        catch(Exception e)
+        {
+            assertTrue("IOException: " + e.getMessage(), false);
+        }
+
+        
+        
     }
 
 }