Update Replacer and Importurls

thc202 · thc202 · commit 9e327a24e39a · 2019-01-11T21:37:31.000Z
Update Replacer API, per release of version 7.
Add description to Importurls API endpoint.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 sooner if the API request was not successful. This can be enabled when
 instantiating the `ZAPv2` class with the argument `validate_status_code`
 set to `True`.
+- Update Replacer API, per release of version 7.
+- Add description to Importurls API endpoint.
 
 ## [0.0.14] - 2017-12-04
 ### Changed
diff --git a/src/zapv2/importurls.py b/src/zapv2/importurls.py
@@ -29,6 +29,7 @@ def __init__(self, zap):
 
     def importurls(self, filepath, apikey=''):
         """
+        Imports URLs (one per line) from the file with the given file system path.
         This component is optional and therefore the API will only work if it is installed
         """
         return six.next(six.itervalues(self.zap._request(self.zap.base + 'importurls/action/importurls/', {'filePath': filepath, 'apikey': apikey})))
diff --git a/src/zapv2/replacer.py b/src/zapv2/replacer.py
@@ -35,12 +35,14 @@ def rules(self):
         """
         return six.next(six.itervalues(self.zap._request(self.zap.base + 'replacer/view/rules/')))
 
-    def add_rule(self, description, enabled, matchtype, matchregex, matchstring, replacement, initiators=None, apikey=''):
+    def add_rule(self, description, enabled, matchtype, matchregex, matchstring, replacement=None, initiators=None, apikey=''):
         """
         Adds a replacer rule. For the parameters: desc is a user friendly description, enabled is true or false, matchType is one of [REQ_HEADER, REQ_HEADER_STR, REQ_BODY_STR, RESP_HEADER, RESP_HEADER_STR, RESP_BODY_STR], matchRegex should be true if the matchString should be treated as a regex otherwise false, matchString is the string that will be matched against, replacement is the replacement string, initiators may be blank (for all initiators) or a comma separated list of integers as defined in <a href="https://github.com/zaproxy/zaproxy/blob/develop/src/org/parosproxy/paros/network/HttpSender.java">HttpSender</a>  
         This component is optional and therefore the API will only work if it is installed
         """
-        params = {'description': description, 'enabled': enabled, 'matchType': matchtype, 'matchRegex': matchregex, 'matchString': matchstring, 'replacement': replacement, 'apikey': apikey}
+        params = {'description': description, 'enabled': enabled, 'matchType': matchtype, 'matchRegex': matchregex, 'matchString': matchstring, 'apikey': apikey}
+        if replacement is not None:
+            params['replacement'] = replacement
         if initiators is not None:
             params['initiators'] = initiators
         return six.next(six.itervalues(self.zap._request(self.zap.base + 'replacer/action/addRule/', params)))
