API v2: Planning Issue

[stefannibrasil]

@milaaraujo and I worked part-time on the API on our Rails Girls Summer of Code program. We were able to remove some duplicated code and refactor the whole Search feature.

But we couldn't finish it all and to leave a documentation for future work, there are some improvements that can be made:

• Refactor the search.rb Class. It's too coupled with the DocResult class. Besides that, we notice that to create a DocResult, the endpoints have only small differences between them, so that could be abstracted to another service to reduce the duplicated code there.

• Change all endpoints to use a search_criteria. We couldn't work on all the endpoints during our program, but the ones we worked on using a search_criteria valid object to access the params. The ideal would be to have all the endpoints to do the same (more details are given below).

• Add more tests

• Change version from v1 to v2

• API next steps?

[jywarren]

This is great. Could you drop some code links into each item, and an example of using criteria? Thanks!!!

…

On Thu, Sep 27, 2018, 5:35 PM Stefanni ***@***.***> wrote: @milaaraujo <https://github.com/milaaraujo> and I worked part-time on the API on our Rails Girls Summer of Code <https://github.com/publiclab/plots2/projects/5> program. We were able to remove some duplicated code and refactor the whole Search <https://github.com/publiclab/plots2/projects/6> feature. But we couldn't finish it all and to leave a documentation for future work, there are some improvements that can be made: - Refactor the search.rb <https://github.com/publiclab/plots2/blob/master/app/api/srch/search.rb> Class. It's too coupled with the DocResult class. Besides that, we notice that to create a DocResult, the endpoints have only small differencies between them, so that could be abstracted to another service to reduce the duplicated code there. - Change all endpoints to use a search_criteria. We couldn't work on all the endpoints during our program, but the ones we worked on use a search_criteria valid object to access the params. The ideal would be to have all the endpoints to do the same. - Add more tests than the current ones. - API next steps? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#3520>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AABfJ259W6Hj6TO8fpNHbuc8Wf_1laZWks5ufUR9gaJpZM4W9f1C> .

[stefannibrasil]

About the search_criteria and how to explore that part:

right now, the ExecuteSearch can receive a search_criteria object with all the params already validated:

https://github.com/publiclab/plots2/blob/master/app/services/execute_search.rb#L8

Right now only search_all and search_profiles endpoints receive a search_criteria object, so on SearchService we only call the params we want, instead of passing all the params. We could then change the other endpoints to use a search_criteria as well, so they would all follow a standard practice.

It's worth noticing that the SearchCriteria class is the place to add the default options, like the limit and the order_direction options. We can help with anyone is interested on doing this, it's a good way to learn how to refactor :)