DPMMA-2550 Point Groups API

[patrykgruszka]

Q	A
Bug fix? (use the a.b branch)	[ N ]
New feature/enhancement? (use the a.x branch)	[ Y ]
Deprecations?	[ N ]
BC breaks? (use the c.x branch)	[ N ]
Automated tests included?	[ Y ]
Related user documentation PR URL	mautic/mautic-documentation#...
Related developer documentation PR URL	mautic/developer-documentation-new#185
Issue(s) addressed	Fixes #...

Description:

This PR adds API endpoints for Point Groups management.

mautic_api_pointGroups_getall          GET     /api/points/groups                                                                               
mautic_api_pointGroups_getone          GET     /api/points/groups/{id}                                                                          
mautic_api_pointGroups_new             POST    /api/points/groups/new                                                                                                                                        
mautic_api_pointGroups_editput         PUT     /api/points/groups/{id}/edit                                                                     
mautic_api_pointGroups_editpatch       PATCH   /api/points/groups/{id}/edit                                                                                                                           
mautic_api_pointGroups_delete          DELETE  /api/points/groups/{id}/delete                                                                   
mautic_api_getcontactpointgroups       GET     /api/contacts/{contactId}/points/groups                                                          
mautic_api_getcontactpointgroup        GET     /api/contacts/{contactId}/points/groups/{groupId}                                                
mautic_api_adjustcontactgrouppoints    POST    /api/contacts/{contactId}/points/groups/{groupId}/{operator}/{value} 

Steps to test this PR:

1. Open this PR on Gitpod or pull down for testing locally (see docs on testing PRs here)

2. Create a new point group:

   • Endpoint: POST https://your-api-host.com/api/points/groups/new
   • Payload: JSON payload with the following fields:

     {
         "name": "New Point Group",
         "description": "Description of the new point group"
     }

3. Retrieve all point groups:

   • Endpoint: GET https://your-api-host.com/api/points/groups

4. Update the created point group:

   • Endpoint: PATCH https://your-api-host.com/api/points/groups/{id}/edit
   • Payload: JSON payload with the fields to update:

     {
         "name": "Updated Point Group Name",
         "description": "Updated description of the point group"
     }

5. Delete the created point group:

   • Endpoint: DELETE https://your-api-host.com/api/points/groups/{id}/delete

6. Get contact group points:

   • Endpoint: GET https://your-api-host.com/api/contacts/{leadId}/points/groups

7. Adjust contact group points:

   • Plus operation:
     • Endpoint: POST https://your-api-host.com/api/contacts/{leadId}/points/groups/{groupId}/plus/{value}
   • Minus operation:
     • Endpoint: POST https://your-api-host.com/api/contacts/{leadId}/points/groups/{groupId}/minus/{value}
   • Set operation:
     • Endpoint: POST https://your-api-host.com/api/contacts/{leadId}/points/groups/{groupId}/set/{value}
   • Divide operation:
     • Endpoint: POST https://your-api-host.com/api/contacts/{leadId}/points/groups/{groupId}/divide/{value}
   • Multiply operation:
     • Endpoint: POST https://your-api-host.com/api/contacts/{leadId}/points/groups/{groupId}/times/{value}

When testing these endpoints, ensure that you replace placeholders such as {leadId}, {groupId}, and {value} with actual IDs and values as required for your specific test cases. Additionally, for endpoints that require a request body, provide the appropriate JSON payload with the necessary fields and values.

[codecov]

Codecov Report

Attention: Patch coverage is 90.90909% with 7 lines in your changes are missing coverage. Please review.

Project coverage is 61.50%. Comparing base (6d1027d) to head (11575ef).

Additional details and impacted files

@@             Coverage Diff              @@
##                5.x   #13517      +/-   ##
============================================
+ Coverage     61.43%   61.50%   +0.07%     
- Complexity    34050    34067      +17     
============================================
  Files          2240     2241       +1     
  Lines        101773   101850      +77     
============================================
+ Hits          62520    62639     +119     
+ Misses        39253    39211      -42     

Files	Coverage Δ
app/bundles/PointBundle/Entity/Group.php	100.00% <100.00%> (+38.09%)	⬆️
...p/bundles/PointBundle/Entity/GroupContactScore.php	100.00% <100.00%> (ø)
app/bundles/PointBundle/Entity/GroupRepository.php	100.00% <100.00%> (ø)
app/bundles/PointBundle/Model/PointGroupModel.php	85.24% <100.00%> (+44.56%)	⬆️
...Bundle/Controller/Api/PointGroupsApiController.php	87.93% <87.93%> (ø)

... and 1 file with indirect coverage changes

[RCheesley]

Tested all endpoints (thank you SO MUCH for the awesome documentation in the PR @patrykgruszka it really helps testers when you provide both the path and the snippet!).

All working as expected. Thanks for the great work! 🚀

[escopecz]

The code looks great! I have a few small suggestions. The functional tests are testing the happy paths. It would be great to have tests that check also 404s, xss and similar. But happy path tests are still way better than none 👍

[patrykgruszka]

Thanks! I've updated the code and added some extra tests :)

Would you have some time to look at the related PR in the API library? mautic/api-library#322

[escopecz]

I see no issue in the code. The Point group/score is covered with functional tests 👍