Add details on errors

[GCorbel]

When a follow request with an invalid ID is sent, this body is returned :

{
    "errors" => [
        {
            "parameters" => {
                "target_user_id" => [
                    "1"
                ]
            },
               "message" => "You cannot unfollow an account that is not active."
        }
    ],
     "title" => "Invalid Request",
    "detail" => "One or more parameters to your request was invalid.",
      "type" => "https://api.twitter.com/2/problems/invalid-request"
}

With the gem, X::BadRequest#message gives : "Invalid Request: One or more parameters to your request was invalid.". As it's more accurate, the message should probably be "Invalid Request: You cannot unfollow an account that is not active.".

Maybe HTTPError#message_from_json_response can be changed to take errors attribute before "title" and "detail". ATM, we can retrieve details with JSON.parse(error.response.body) but it's not very convenient. If the error message is not changed, maybe a method "details" can be added.

Not that, if the gem is changed to take "errors" attribute first, a request with an invalid parameter return this payload

{
    "errors" => [
        {
            "parameters" => {
                "$.text" => [
                    "81462"
                ]
            },
               "message" => "$.text: integer found, string expected"
        }
    ],
     "title" => "Invalid Request",
    "detail" => "One or more parameters to your request was invalid.",
      "type" => "https://api.twitter.com/2/problems/invalid-request"
}

So the error message will be "Invalid Request: $.text: integer found, string expected" which is not formatted to be directly displayed to end users.

[sferik]

I'm not sure exactly what you're proposing here. It might be easier if you submit a pull request so we can discuss the code.

[GCorbel]

Honestly, I'm not sure what's the best.

We have 2 choices :

1. Change error messages to always be errors.[].message
2. Have X::HTTPError#details to have those messages

I will try to do a PR soon

[GCorbel]

Sorry but I will have no time to do this soon.

[sferik]

@GCorbel I'm curious if this is still a need/problem for you or whether this issue can be closed. It seems like you have been able to live without it for almost one year. 😉

[GCorbel]

The issue still exists. You can reproduce it with :

> client.post("users/#{twitter_id}/following", JSON.dump(target_user_id: '1'))

# => X::BadRequest: Invalid Request: One or more parameters to your request was invalid.

> _ex_.response.body
# => "{\"errors\":[{\"parameters\":{\"target_user_id\":[\"1\"]},\"message\":\"You cannot follow an account that is not active.\"}],\"title\":\"Invalid Request\",\"detail\":\"One or more parameters to your request was invalid.\",\"type\":\"https://api.twitter.com/2/problems/invalid-request\"}"

The error returned is misleading, but as you said, it's not that much important, and we still have a way to retrieve the data. It's more a "nice to have" that a real issue.