henry-sarabia / kanka Goto Github PK

As soon as this project reaches v1.0.0, it will become its own Go module.

Custom error types should only be exported for a specific reason. This repository does not have any reason to export it.

Write and add a README explaining the following aspects of the package:

• Installation
• Usage
• Examples

Create a .travis.yml file to the repository.

The Kanka API allows 30 request per minute (increased to 90 for Patreons). Kanka will throttle a user's requests if they exceed this limit.

A retry option should be implemented into the Client so a user can opt into automatically retrying their requests in the event of receiving a 421 or 429 HTTP response code.

Endpoint's methods do not need to be exported.

For the EntityNote service, the IsPrivate field is member to EntityNote instead of SimpleEntityNote.

I plan to maintain the project as open source under the MIT license.

The license needs to be added to the repository.

The type field has been moved from Family to SimpleFamily. FamilyService tests do not reflect this change at the moment.

The EntityNote endpoint does allow for the retrieval of a single EntityNote. This functionality should be supported by the associated service.

One case (Status OK, valid response, invalid entID) from two service functions (Create and Update) are not correctly testing for an invalid entID.

The following services are affected from the same or similar bug:

• Attributes
• EntityEvents
• EntityInventories
• EntityNotes
• EntityTags
• Relations

Every test file needs to be formatted with the gofmt simplify tag.

After some testing in Postman, I have found users have access to more fields than are listed in the documentation. The code should reflect this.

Services with names comprised of compound words have grammatical errors in their type's documentation.

The following services are affected with the same or similar errors:

• EntityEvent
• EntityInventory
• EntityNote
• EntityTag
• MapPoint
• QuestCharacter