zendesk / zendesk/connect_ruby_sdk
Unclear response format
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 2
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
Documentation says Both the identify() and track() methods return an Outbound::Result instance.
But there is Outbound::Result if I call identify with invalid parameters only. If I call identify method with valid parameters - it returns [nil, true]. There is a PR #7 mentioning this problem.
post method returns [err, true] and if there are no errors - it returns not an Outbound::Result instance.
Expected behaviour:
Getting Outbound::Result as result of calling identify method, as it mentioned in documentation
Actual behaviour:
Getting [nil, true] as result of calling identify method, which is not giving any understanding if result success or not
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in lib/outbound.rb at the post method around line 330, then compare the identify and track behavior with the linked documentation. Review PR #7 for the existing discussion. Done means valid identify calls follow the documented Outbound::Result response format instead of returning [nil, true].
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- backend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100