Merge pull request #46 from BidnessForB/refactor-collections

Adding simple request constructor

Author: bryancross

README.md

@@ -41,16 +41,28 @@ Got a [Collection ID](https://support.postman.com/hc/en-us/articles/506378509531
 Collection pmcTest = Collection.pmcFactory(new PostmanID("<your collection id>"));
 ```
 
+NOTE: You must set an environment variable named `POSTMAN_API_KEY` with the value of your Postman API key.  
+
 ### Create Collections from scratch
 
 You can create a new, empty collection as well
 
 ```java
-Collection newColl = PostmanFactory("New collection");
+Collection newColl = Collection.pmcFactory();
+newColl.setName("My new collection");
 ```
 
 then create and add elements to your new collection
 
+### Add requests
+
+You can add a new request just by providing a URL:
+
+```java
+  Collection newColl = Collection.pmcFactory();
+  newColl.addRequest("https://postman-echo.com/get");
+```
+
 ### Edit collections: add, remove, edit and move Collection elements
 
 JPostman allows you to add new Folders and Requests to your Postman Collections.  You can also add variables, Pre-Request and Test Scripts, requests, and responses.  In fact, 
@@ -112,7 +124,7 @@ JPostman allows you to generate JSON for your collections.  You can also write y
  Use the `Collection.validate() method to ensure that the JSON emitted by your instance of Collection conforms with the Postman Collection schema:
 
  ```java
-  boolean isValid = myCollection.validate()
+  boolean isValid = myCollection.validate();
  ```
 
 JPostman uses the NetworkNT [json-schema-validator](https://github.com/networknt/json-schema-validator) to validate JSON against a JSON schema.  

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

@@ -156,6 +156,31 @@ public Request addRequest(RequestBody reqElement, String name, Response response
         return newReq;
     }
 
+       /** 
+     * 
+     * Create and add a new <code>request</code> as a top level child item of this collection.  The request will be named 'New Request'
+     * 
+     * 
+     * @param url The URL for the request.  Cannot be null or non-zero
+     * @return Item The new Request item
+     * @throws RecursiveItemAddException If this collection already include this instance in it's array of items.
+     * @throws DuplicateVariableKeyException If parsing the URL results in the creation of duplicate parameter variables.
+     * @throws IllegalPropertyAccessException 
+     * @throws InvalidCollectionActionExample If a null or zero-length string URL is passed.  
+     *  
+     */
+    public Request addRequest(String url) throws RecursiveItemAddException, IllegalPropertyAccessException, InvalidCollectionActionException, DuplicateVariableKeyException {
+
+        if(url == null || url.length() < 1) {
+            throw new InvalidCollectionActionException("Url must be a non-zero length string");
+        }
+
+        Request newReq = this.addRequest(new RequestBody(enumHTTPRequestMethod.GET, url), "New Request");
+       
+
+        return newReq;
+
+    }
 
     /** 
      * 

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

@@ -1,6 +1,7 @@
 package com.postman.collection;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNotEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
@@ -1155,6 +1156,42 @@ public void TestCollectionRequests() {
     {
         assertTrue("Unexpected duplicate key: " + e.getMessage(), false);
     }
+    Request reqItem3 = null;
+    try {
+       reqItem3 = pmcTest.addRequest("https://postman-echo.com/get");
+    }
+    catch (Exception e) {
+        assertTrue("Exception adding collection", false);
+    }
+    
+    assertEquals(reqItem3.getRequestBody().getUrl().getRaw(), "https://postman-echo.com/get");
+
+    try {
+        reqItem3 = pmcTest.addRequest("https://postman-echo.com/get?foo=bar&bat={{boo}}");
+    }
+    catch(Exception e) {
+        assertTrue("Exception adding collection", false);
+    }
+
+    assertEquals(reqItem3.getRequestBody().getUrl().getRaw(), "https://postman-echo.com/get?foo=bar&bat={{boo}}");
+    
+
+    try {
+        //should trigger a duplicate key exception?
+        reqItem3 = pmcTest.addRequest("https://postman-echo.com/:pathvar1/get?foo=bar&bat={{boo}}");
+    }
+    catch(Exception e) {
+        assertTrue("Exception adding collection", false);
+    }
+
+    assertEquals(reqItem3.getRequestBody().getUrl().getRaw(), "https://postman-echo.com/:pathvar1/get?foo=bar&bat={{boo}}");
+
+    assertEquals(reqItem3.getRequestBody().getUrl().getPathVariables().size(), 1);
+    assertNotNull(reqItem3.getRequestBody().getUrl().getPathVariable("pathvar1"));
+
+
+
+
 
 
 
@@ -1169,7 +1206,7 @@ public void TestCollectionRequests() {
 
 
 
-       assertEquals(2, pmcTest.getItems(enumItemType.REQUEST).size());
+       assertEquals(5, pmcTest.getItems(enumItemType.REQUEST).size());
 
         try {
         newFolder = pmcTest.addFolder("New Folder");
@@ -1182,7 +1219,7 @@ public void TestCollectionRequests() {
        try {
         pmcTest.moveItem(reqItem1, newFolder);
         assertEquals("New Folder", pmcTest.getRequest("GET echo").getParent().getName());
-        assertEquals(2, pmcTest.getItems().size());
+        assertEquals(5, pmcTest.getItems().size());
        }
        catch(Exception e)
        {
@@ -1196,9 +1233,25 @@ public void TestCollectionRequests() {
 
 
        pmcTest.removeItem("POST echo");
-       assertEquals(1, pmcTest.getItems(enumItemType.REQUEST).size());
+       assertEquals(4, pmcTest.getItems(enumItemType.REQUEST).size());
        assertNotNull(pmcTest.getItem("GET echo"));
 
+       //Should trigger duplicate variable key exception
+       try {
+           reqItem3 = pmcTest.addRequest("https://postman-echo.com/:pathvar1/:pathvar1/get?foo=bar&bat={{boo}}");
+       }
+       catch(DuplicateVariableKeyException e) {
+            assertTrue("Duplicate variable key exception expected", true);
+       }
+       catch(Exception e) {
+        assertTrue("Unexpected exception: " + e.getMessage(), false);
+       }
+
+
+       validateAndWriteToFile(pmcTest, new Throwable().getStackTrace()[0]);
+
+
+
 
     }