Fail shouldn't support a message argument

[charlesmulder]

https://labs.omniti.com/labs/jsend

[evangraan]

It does not. 'error' does?

[charlesmulder]

My bad.

[charlesmulder]

The message argument passed to fail() and success() is a bit confusing. If you look at jsend spec you'll see that there is no message argument for success() or fail().

Furthermore, I'm not sure I like the fact that a notifications key is automatically added to the data hash for success(), fail(), success_data() and fail_data(). Especially, when I don't even pass a notification.

> fail(nil, {:key1 => "value1"})
=> {"status"=>"fail", "data"=>{:key1=>"value1", "notifications"=>["fail"]}}
> fail_data({:key1 => 'value1'})
=> {"status"=>"fail", "data"=>{:key1=>"value1", "notifications"=>["fail"]}}
> success(nil, nil)
=> {"status"=>"success", "data"=>{"result"=>nil, "notifications"=>["success"]}}
success_data({:key1 => 'value1'})
=> {"status"=>"success", "data"=>{:key1=>"value1", "notifications"=>["success"]}}

data: Acts as the wrapper for any data returned by the API call. If the call returns no data, data should be set to null.

One last thing, in my opinion, these functions should return a JSON string.

My recommendation is removing the fail_data() and success_data() functions and modifying the fail() , success() and error() function signatures to something like:

> fail()
=> "{\"status\": \"fail\", \"data\": null}"
fail({:key1 => "value1"})
=> "{\"status\":\"fail\",\"data\":{\"key1\":\"value1\"}}"
> success()
=> "{\"status\":\"success\", \"data\": null}"
> success({:key1 => "value1"})
=> "{\"status\":\"success\",\"data\":{\"key1\":\"value1\"}}"
> error()
=> ArgumentError, 'Missing required argument message'
> error('My little error')
=> "{\"status\":\"error\", \"message\":\"My little error\"}"
> error("Another little error", 401, {:key1 => "value1"})
=> "{\"status\":\"error\",\"message\":\"Another little error\",\"code\":401,\"data\":{\"key1\":\"value1\"}}"