[Bug 33690] New: Add ability to send welcome notice when creating patrons using the REST API
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Bug ID: 33690 Summary: Add ability to send welcome notice when creating patrons using the REST API Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: REST API Assignee: koha-bugs@lists.koha-community.org Reporter: kyle@bywatersolutions.com CC: tomascohen@gmail.com As an addition/alternative to Bug 30299, it would be nice to have the ability to send a welcome notice when creating patrons via the API. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |kyle@bywatersolutions.com |ity.org | -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #1 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 150777 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=150777&action=edit Bug 33690: Add ability to send welcome notice when creating patrons using the REST API It would be nice to have the ability to send a welcome notice when creating patrons via the API. Test Plan: 1) Apply this patch 2) Ensure you have a WELCOME notice 3) Create a new patron using the REST API ( api/v1/patrons ) 4) Note no welcome notice is sent to the patron ( you can check the notices tab for the patron ) 5) Repeat step 3, but send the header X-Koha-SendWelcomeEmail with a value of 1 as part of the POST 6) Note the welcome message for the patron is in their notices! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #150777|0 |1 is obsolete| | --- Comment #2 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 150787 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=150787&action=edit Bug 33690: Add ability to send welcome notice when creating patrons using the REST API It would be nice to have the ability to send a welcome notice when creating patrons via the API. Test Plan: 1) Apply this patch 2) Ensure you have a WELCOME notice 3) Create a new patron using the REST API ( api/v1/patrons ) 4) Note no welcome notice is sent to the patron ( you can check the notices tab for the patron ) 5) Repeat step 3, but send the header X-Koha-SendWelcomeEmail with a value of 1 as part of the POST 6) Note the welcome message for the patron is in their notices! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |david@davidnind.com --- Comment #3 from David Nind <david@davidnind.com> --- I'd be happy to test, but don't know enough for step 3. Could you provide an example of the JSON for adding a patron? I can use Postman for basic things.... Otehrwsie, I'll leave for someone else who knows what to do, to test. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #4 from Tomás Cohen Arazi <tomascohen@gmail.com> --- (In reply to David Nind from comment #3)
I'd be happy to test, but don't know enough for step 3.
Could you provide an example of the JSON for adding a patron?
I can use Postman for basic things....
Otehrwsie, I'll leave for someone else who knows what to do, to test.
When you do a GET /API/V1/patrons you can get an idea of how a patron object for POST should look like. I'd suggest you pick a couple attributes like firstname, surname and user id. And see if it tells you you need more. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #150787|0 |1 is obsolete| | --- Comment #5 from David Nind <david@davidnind.com> --- Created attachment 150791 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=150791&action=edit Bug 33690: Add ability to send welcome notice when creating patrons using the REST API It would be nice to have the ability to send a welcome notice when creating patrons via the API. Test Plan: 1) Apply this patch 2) Ensure you have a WELCOME notice 3) Create a new patron using the REST API ( api/v1/patrons ) 4) Note no welcome notice is sent to the patron ( you can check the notices tab for the patron ) 5) Repeat step 3, but send the header X-Koha-SendWelcomeEmail with a value of 1 as part of the POST 6) Note the welcome message for the patron is in their notices! Signed-off-by: David Nind <david@davidnind.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #6 from David Nind <david@davidnind.com> --- (In reply to Tomás Cohen Arazi from comment #4)
(In reply to David Nind from comment #3)
I'd be happy to test, but don't know enough for step 3.
Could you provide an example of the JSON for adding a patron?
I can use Postman for basic things....
Otehrwsie, I'll leave for someone else who knows what to do, to test.
When you do a GET /API/V1/patrons you can get an idea of how a patron object for POST should look like. I'd suggest you pick a couple attributes like firstname, surname and user id. And see if it tells you you need more.
Thanks Tomás! That helped me figure it out. David -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #7 from David Nind <david@davidnind.com> --- Testing notes (using KTD) 1. Enabled RESTBasicAuth system preference. 2. Used Postman to create a new HTTP Request with these values/settings: - POST to http://127.0.0.1:8081/api/v1/patrons - Authorization: Basic Auth with koha as both username password - Headers: added x-koha-welcome with a value of email - Body (raw and JSON selected): { "cardnumber": "987654321", "category_id": "PT", "library_id": "CPL", "email": "email@example.com", "surname": "bz33690", "userid": "bz33690" } 3. Tests pass: prove -v t/db_dependent/api/v1/patrons.t -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |dcook@prosentient.com.au -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Ed Veal <eveal@mckinneytexas.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |eveal@mckinneytexas.org -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #8 from Ed Veal <eveal@mckinneytexas.org> --- This is becoming a major service issue for us. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Nick Clemens <nick@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |nick@bywatersolutions.com See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=30299 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- QA Contact| |tomascohen@gmail.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #9 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 152642 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=152642&action=edit Bug 33690: (QA follow-up) Mock C4::Letters subroutines for unit tests -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Dave <ddaghita@mckinneytexas.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |ddaghita@mckinneytexas.org -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #10 from Tomás Cohen Arazi <tomascohen@gmail.com> --- I like where this is going towards. There's one thing that bugs me: the header. While I agree with using a header for controlling this behavior (to send or not send), I find it weird that the spec says it should contain the word `email`, but there's no check on this. Could you consider for a bit using the 'email' value? And what about other transports? Shouldn't we make the `x-koha-welcome` header be defined as: - name: x-koha-welcome in: header required: false description: The transport to use for sending a WELCOME message. Empty means no message is sent. type: array items: type: string enum: - email - sms - pidgeon collectionFormat: csv -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Failed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Rebecca Coert <rcoert@arlingtonva.us> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |rcoert@arlingtonva.us -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |martin.renvoize@ptfs-europe | |.com --- Comment #11 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Do we even need a header here? All other cases where the WELCOME notice is sent use the value of the system preference to determine whether to send or not. I'd argue perhaps we could support a header optionally to allow locally enabling/disabling send at the API level.. but I don't think we should require the header to trigger the action by default.. default should just adhere to the preference. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #12 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- OK.. I stand corrected.. the csv import tool requires a checkbox be ticked. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #13 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- I still think defaulting to 'AutoEmailNewUser' should be used however. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #150791|0 |1 is obsolete| | --- Comment #14 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Created attachment 155396 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=155396&action=edit Bug 33690: Add ability to send welcome notice when creating patrons using the REST API It would be nice to have the ability to send a welcome notice when creating patrons via the API. Test Plan: 1) Apply this patch 2) Ensure you have a WELCOME notice 3) Create a new patron using the REST API ( api/v1/patrons ) 4) Note no welcome notice is sent to the patron ( you can check the notices tab for the patron ) 5) Repeat step 3, but send the header X-Koha-SendWelcomeEmail with a value of 1 as part of the POST 6) Note the welcome message for the patron is in their notices! Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #152642|0 |1 is obsolete| | --- Comment #15 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Created attachment 155397 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=155397&action=edit Bug 33690: (QA follow-up) Mock C4::Letters subroutines for unit tests Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #16 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Created attachment 155398 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=155398&action=edit Bug 33690: Convert to x-koha-override This patch converts the existing work to use x-koha-override instead of introducing an entirely new header and we default to the system preference value if the override isn't passed. I believe this is more consistent with our approach in other areas of koha to date. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Failed QA |Needs Signoff --- Comment #17 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- The one niggle outstanding for me here is that we're not wrapping the email sending block in an eval like we do with the other WELCOME notice locations.. I'm wondering it we should be doing that and returning some sort of error to the api should it fail? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #155398|0 |1 is obsolete| | --- Comment #18 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Created attachment 155406 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=155406&action=edit Bug 33690: Convert to x-koha-override This patch converts the existing work to use x-koha-override instead of introducing an entirely new header and we default to the system preference value if the override isn't passed. I believe this is more consistent with our approach in other areas of koha to date. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #19 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Created attachment 155407 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=155407&action=edit Bug 33690: Tidy test -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #20 from David Nind <david@davidnind.com> --- Testing notes (using KTD) 1. Enabled RESTBasicAuth system preference. 2. For step 3 of the test plan, header should now be x-koha-override. - If AutoEmailNewUser enabled, header not required - Use x-koha-override to override = welcome_yes or welcome_no - Should work with the various combinations: . AutoEmailNewUser enabled, no header required: welcome message sent . AutoEmailNewUser not enabled, x-koha-override = welcome_yes : welcome message sent . AutoEmailNewUser enabled, x-koha-override = welcome_no : welcome message not sent 3. Used Postman to create a new HTTP Request with these values/settings: - POST to http://127.0.0.1:8081/api/v1/patrons - Authorization: Basic Auth with koha as both username password - Headers: used without x-koha-override and AutoEmailNewUser enabled + various combinations as in testing notes 2 above - Body (raw and JSON selected): { "cardnumber": "987654321", "category_id": "PT", "library_id": "CPL", "email": "email@example.com", "surname": "bz33690", "userid": "bz33690" } 4. Tests pass: prove -v t/db_dependent/api/v1/patrons.t -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Jonathan Druart <jonathan.druart+koha@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart+koha@gmail. | |com --- Comment #21 from Jonathan Druart <jonathan.druart+koha@gmail.com> --- Not considering blocker, but worth raising it: if you pass an invalid header's value ("foobar"), it is ignored. I would have expected swagger's spec validation to raise an error. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Jonathan Druart <jonathan.druart+koha@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Jonathan Druart <jonathan.druart+koha@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #155396|0 |1 is obsolete| | Attachment #155397|0 |1 is obsolete| | Attachment #155406|0 |1 is obsolete| | Attachment #155407|0 |1 is obsolete| | --- Comment #22 from Jonathan Druart <jonathan.druart+koha@gmail.com> --- Created attachment 156544 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=156544&action=edit Bug 33690: Add ability to send welcome notice when creating patrons using the REST API It would be nice to have the ability to send a welcome notice when creating patrons via the API. Test Plan: 1) Apply this patch 2) Ensure you have a WELCOME notice 3) Create a new patron using the REST API ( api/v1/patrons ) 4) Note no welcome notice is sent to the patron ( you can check the notices tab for the patron ) 5) Repeat step 3, but send the header X-Koha-SendWelcomeEmail with a value of 1 as part of the POST 6) Note the welcome message for the patron is in their notices! Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> Bug 33690: Tidy test Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #23 from Jonathan Druart <jonathan.druart+koha@gmail.com> --- Created attachment 156545 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=156545&action=edit Bug 33690: (QA follow-up) Mock C4::Letters subroutines for unit tests Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> JD Amended patch: tidy Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #24 from Jonathan Druart <jonathan.druart+koha@gmail.com> --- Created attachment 156546 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=156546&action=edit Bug 33690: Convert to x-koha-override This patch converts the existing work to use x-koha-override instead of introducing an entirely new header and we default to the system preference value if the override isn't passed. I believe this is more consistent with our approach in other areas of koha to date. Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Pushed to master Version(s)| |23.11.00 released in| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 --- Comment #25 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Pushed to master for 23.11. Nice work everyone, thanks! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Fridolin Somers <fridolin.somers@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |fridolin.somers@biblibre.co | |m --- Comment #26 from Fridolin Somers <fridolin.somers@biblibre.com> --- Enhancement not pushed to 23.05.x -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to master |Needs documenting -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Myranda Fuentes <myranda@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |myranda@bywatersolutions.co | |m -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC|martin.renvoize@ptfs-europe | |.com | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=33690 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Resolution|--- |FIXED Status|Needs documenting |RESOLVED --- Comment #27 from David Nind <david@davidnind.com> --- No updates required to the manual. -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org