User API implementation into the PHP Client for Makerlog

The Makerlog client can now go slowly to version 1. :-)

As already mentioned in the last posts, I develop the PHP client for Makerlog in my spare time. Makerlog is the dead-simple task log that helps you stay productive and ship faster. There you can meet other makers and share your progress.

The last days I finished the User API, the last puzzle piece to fully utilize the API of Makerlog. In the next days I will bring the documentation up to date but the implementation of the users is now finished.

Repository

• https://github.com/pcsg/pcsg-makerlog-php-client
• Licence: GPL-3.0+

New Features

What feature(s) did you add?

• I implemented the complete user API.
• /users/ GET POST
• /users/{username}/ GET POST PATCH DELETE
• /users/{username}/activity_graph/
• /users/{username}/embed/
• /users/{username}/follow/
• /users/{username}/is_following/
• /users/{username}/products/
• /users/{username}/recent_tasks/
• /users/{username}/stats/
• /users/{username}/stats_embed/
• /users/{username}/unfollow/
• /users/{username}/wrapped/
• /users/{username}/wrapped_image/

How did you implement it/them?

The implementation is done with the following commits:

• 564ec7c
• 2d3a1ff
• 631516b
• 8d8909d
• 7b1fbac

Like in the last posts, I will go into the API a little bit. The complete API documentation is available under:

• https://github.com/pcsg/pcsg-makerlog-php-client/blob/master/docs/users.md
• https://github.com/pcsg/pcsg-makerlog-php-client/blob/master/docs/user.md

The users are the core of the API. Therefore the implementation has become a bit more. Basically I have implemented some optimizations so that the same requests are not executed multiple times unnecessarily.

If a user is now instantiated, there is no performance problem if the products are fetched from this user.

In this way you can now work with users as easily as possible. Because each user object has different methods for accessing the user data, it is easy to read and work with them.

Besides the individual user, the tasks are the heart of Makerlog. For example, you want to automatically vote for some tasks of a user, you are now able to this via the user's Task API.

With the latest update it is now completely possible to change users, access user data and respond to user tasks.

As a little delicacy I also implemented the latest API changes directly. Makerlog has introduced some new features today that address the Streak. Makerlog has set itself the goal to support the productity, but since the streak forces you to do things seven days a week, the streak went against the goal of makerlog.

Today in Makerlog a new functionality were introduced because of this misconception. It is something like rest time and this functionality allows you to set the weekend in such a way, that it is not calculated to the streak.

This was just a small overview of the new User API. Be curious about the documentation, which I will extend more and more in the next days.

GitHub Account

• https://github.com/dehenne

Future

For version 1 a complete documentation of the users is missing now. I did about 50%, so I will write the rest in the next days and will publish the client in version 1.

That was it for today already, I hope I could give a little insight into the PHP client of Makerlog.

Have fun in Makerlog and thanks for reading,
Hen