Add test helper functions

* `jsonArrayParam`
* `uploadParamMatcher`
* `apiParamMatcher`
* `mockTest`
* `mockPromise`

Author: Amir Tocker

src/utils.coffee

@@ -1027,7 +1027,6 @@ build_eager = (eager)->
   ).join("|")
   ret
 
-
 hashToQuery = (hash)->
   compact(for key, value of hash
     if isArray(value)
@@ -1039,3 +1038,17 @@ hashToQuery = (hash)->
       "#{querystring.escape(key)}=#{querystring.escape(value)}"
   ).sort().join('&')
 
+###*
+# Returns a JSON array as String.
+# Yields the array before it is converted to JSON format
+# @api private
+# @param [Hash|String|Array<Hash>] data
+# @return [String|nil] a JSON array string or `nil` if data is `nil`
+###
+jsonArrayParam = (data, callback)->
+  return unless data
+
+  data = JSON.parse(data) if isString(data)
+  data = [data] unless isArray(data)
+  data = callback(data) if isFunction(callback)
+  JSON.stringify(data)

test/spechelper.coffee

@@ -8,6 +8,10 @@ utils = require("../lib/utils")
 isFunction = require('lodash/isFunction')
 cloneDeep = require('lodash/cloneDeep')
 http = require('http')
+querystring = require('querystring')
+sinon = require('sinon')
+ClientRequest = require('_http_client').ClientRequest
+Q = require('q')
 
 exports.TIMEOUT_SHORT   = 5000
 exports.TIMEOUT_MEDIUM  = 20000
@@ -33,7 +37,7 @@ exports.test_cloudinary_url = (public_id,options,expected_url,expected_options)
 
 expect.Assertion::produceUrl = (url)->
   [public_id, options] = @obj
-  actualOptions = _.cloneDeep(options)
+  actualOptions = cloneDeep(options)
   actual = utils.url(public_id, actualOptions)
   @assert(
     actual.match(url),
@@ -43,17 +47,17 @@ expect.Assertion::produceUrl = (url)->
 
 expect.Assertion::emptyOptions = ()->
   [public_id, options] = @obj
-  actual = _.cloneDeep(options)
+  actual = cloneDeep(options)
   utils.url(public_id,actual)
   @assert(
-    _.isEmpty(actual),
+    isEmpty(actual),
     ()-> "expected '#{public_id}' and #{JSON.stringify(options)} to produce empty options but got #{JSON.stringify(actual)}",
     ()-> "expected '#{public_id}' and #{JSON.stringify(options)} not to produce empty options")
   @
 
 expect.Assertion::beServedByCloudinary = (done)->
   [public_id, options] = @obj
-  actualOptions = _.cloneDeep(options)
+  actualOptions = cloneDeep(options)
   actual = utils.url(public_id, actualOptions)
   http.get actual, (res)=>
     @assert res.statusCode == 200,
@@ -65,7 +69,7 @@ expect.Assertion::beServedByCloudinary = (done)->
 class sharedExamples
   constructor: (name, examples)->
     @allExamples ?= {}
-    if _.isFunction(examples)
+    if isFunction(examples)
       @allExamples[name] = examples
       examples
     else
@@ -82,3 +86,96 @@ exports.itBehavesLike = (name, args...)->
     sharedExamples(name).apply(this, args)
 exports.includeContext = (name, args...)->
   sharedExamples(name).apply(this, args)
+
+###*
+  Create a matcher method for upload parameters
+  @private
+  @function helper.paramMatcher
+  @param {string} name the parameter name
+  @param value {Any} the parameter value
+  @return {(arg)->Boolean} the matcher function
+###
+exports.uploadParamMatcher = (name, value)->
+  (arg)->
+    EncodeFieldPart = (name, value) ->
+    return_part = 'Content-Disposition: form-data; name="' + name+ '"\r\n\r\n'
+    return_part += value
+    new RegExp(return_part).test(arg)
+
+###*
+  Create a matcher method for api parameters
+  @private
+  @function helper.apiParamMatcher
+  @param {string} name the parameter name
+  @param value {Any} the parameter value
+  @return {(arg)->Boolean} the matcher function
+###
+exports.apiParamMatcher = (name, value)->
+  params = {}
+  params[name] = value
+  expected = querystring.stringify(params)
+  (arg)->
+    new RegExp(expected).test(arg)
+
+###*
+  Escape RegExp characters
+  @private
+  @param {string} s the string to escape
+  @return a new escaped string
+###
+exports.escapeRegexp = (s)->
+  s.replace(/[{\[\].*+()}]/g, (c)=>'\\' + c)
+
+###*
+  @function mockTest
+  @nodoc
+  provides a wrapper for mocked tests
+  @return {object} the mocked objects
+###
+exports.mockTest = ()->
+  mock = {}
+  before ()->
+    mock.xhr = sinon.useFakeXMLHttpRequest()
+    mock.writeSpy = sinon.spy(ClientRequest.prototype, 'write')
+    mock.requestSpy = sinon.spy(http, 'request')
+  
+  after ()->
+    mock.requestSpy.restore()
+    mock.writeSpy.restore()
+    mock.xhr.restore()
+
+  mock
+  
+###*
+  @callback mockBlock
+  A test block
+  @param xhr 
+  @param writeSpy 
+  @param requestSpy 
+  @return {*} a promise or a value
+###
+
+###*
+  @function mockPromise
+  Wraps the test to be mocked using a promise
+  @param {mockBlock} the test function
+###
+exports.mockPromise = (mockBlock)->
+  xhr = undefined
+  writeSpy = undefined
+  requestSpy = undefined
+  Q.Promise((resolve, reject, notify)->
+    xhr = sinon.useFakeXMLHttpRequest()
+    writeSpy = sinon.spy(ClientRequest.prototype, 'write')
+    requestSpy = sinon.spy(http, 'request')
+    mock = {xhr, writeSpy, requestSpy }
+    result = mockBlock(xhr, writeSpy, requestSpy)
+    if isFunction(result?.then)
+      result.then(resolve)
+    else
+      resolve(result)
+  ).finally(()->
+    requestSpy.restore()
+    writeSpy.restore()
+    xhr.restore()
+  )