https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 Lari Taskula <lari.taskula@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |lari.taskula@jns.fi |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=17505 Mike <black23@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- QA Contact|testopia@bugs.koha-communit | |y.org | Assignee|lari.taskula@jns.fi |mail@jkozlovsky.cz CC| |black23@gmail.com Jiri Kozlovsky <mail@jkozlovsky.cz> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |In Discussion --- Comment #1 from Jiri Kozlovsky <mail@jkozlovsky.cz> --- Just to be clear about the implementation details .. For messaging preferences to work, there must be set EnhancedMessagingPreferences to Allow in order to let anyone change anything. This will ensure only staff can edit messaging preferences. For regular users to allow them editing those, EnhancedMessagingPreferencesOPAC must be also enabled. If is EnhancedMessagingPreferencesOPAC enabled, but EnhancedMessagingPreferences is not, no editing is allowed to anyone. API URL will be in this format: /api/v1/messaging_preferences/{borrowernumber} Next, I suppose, there will be GET & POST methods. No else. GET method only returns user's messaging prefs. User can view only it's own prefs, unless he has 'borrowers' rights. POST method updates user's messaging pref. User can update only it's own prefs, unless he has 'borrowers' rights. Both, GET & POST methods will send / receive JSON in this format: { item_due: { email: 0/1, digest_only: 0/1, do_not_notify: 0/1 } advance_notice: { days_in_advance: 0-30, email: 0/1, digest_only: 0/1, do_not_notify: 0/1 } hold_filled: { email: 0/1, do_not_notify: 0/1 } item_checkin: { email: 0/1, do_not_notify: 0/1 } item_checkout: { email: 0/1, do_not_notify: 0/1 } } Please someone take a look at this concept, if it is okay to implement this feature in this way. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 --- Comment #3 from Jiri Kozlovsky <mail@jkozlovsky.cz> --- (In reply to Lari Taskula from comment #2)

Hey. Any update on this? I will start working on it if you haven't already. I attached Koha-objects to Bug 17499 which could be useful for this one.

Hey there Lari. Yes, I've already done some work, but now I'm going to be away from work on Koha until I finish final school exams for bachelor's degree. If you want, you can take a look at the work & finish it ;) All the work is in this single commit: https://github.com/open-source-knihovna/KohaCZ/commit/7bddf4f709fce467296ddc... Basically I made it work for GET request. Feel free to change my coding style as you wish :D -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 --- Comment #5 from Mike <black23@gmail.com> --- Hi Lari, any progress on it? Jiri propably will ready to join us again and do some code on REST. So, we need to know actual state of Your work. Thank You. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 Lari Taskula <lari.taskula@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|In Discussion |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 Lari Taskula <lari.taskula@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on| |18137 --- Comment #8 from Lari Taskula <lari.taskula@jns.fi> --- Depends on Bug 18137 and 17499. These Bugs will conflict in Koha/Exceptions.pm but should be easily fixable. Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18137 [Bug 18137] REST API: Migrate from Mojolicious::Plugin::Swagger2 to Mojolicious::Plugin::OpenAPI -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 --- Comment #10 from Lari Taskula <lari.taskula@jns.fi> --- The only dependencies are Bug 18137 and Bug 17499... Are you sure all patches from Bug 18137 were applied? (Especially the "sort definitions.json"?) Because otherwise I don't see why it has an issue in definitions.json... However Bug 18137 needs a rebase anyway since it conflicts in the Holds controller after Bug 18276 and Bug 18260. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 --- Comment #12 from Jiri Kozlovsky <mail@jkozlovsky.cz> --- To overcome testing problems with missing OpenApi (from bug 18137) one should run: $ sudo cpanm Mojolicious::Plugin::OpenAPI@1.10 .. but that doesn't work for me, here is my output: --> Working on Mojolicious::Plugin::OpenAPI Fetching http://backpan.perl.org/authors/id/J/JH/JHTHORSEN/Mojolicious-Plugin-OpenAPI... ... OK Configuring Mojolicious-Plugin-OpenAPI-1.10 ... OK ==> Found dependencies: JSON::Validator, Mojolicious --> Working on JSON::Validator Fetching http://www.cpan.org/authors/id/J/JH/JHTHORSEN/JSON-Validator-1.00.tar.gz ... OK Configuring JSON-Validator-1.00 ... OK ==> Found dependencies: Mojolicious --> Working on Mojolicious Fetching http://www.cpan.org/authors/id/S/SR/SRI/Mojolicious-7.37.tar.gz ... OK Configuring Mojolicious-7.37 ... OK ==> Found dependencies: IO::Socket::IP --> Working on IO::Socket::IP Fetching http://www.cpan.org/authors/id/P/PE/PEVANS/IO-Socket-IP-0.39.tar.gz ... OK Configuring IO-Socket-IP-0.39 ... OK Building and testing IO-Socket-IP-0.39 ... OK Successfully installed IO-Socket-IP-0.39 (upgraded from 0.29) Building and testing Mojolicious-7.37 ... OK Successfully installed Mojolicious-7.37 (upgraded from 6.15) Building and testing JSON-Validator-1.00 ... OK Successfully installed JSON-Validator-1.00 (upgraded from 0.67) Building and testing Mojolicious-Plugin-OpenAPI-1.10 ... FAIL ! Installing Mojolicious::Plugin::OpenAPI failed. See /root/.cpanm/work/1501423561.19833/build.log for details. Retry with --force to force install it. 3 distributions installed What worked is this process as proposed by Tomás (https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18137#c54): $ sudo cpanm Mojolicious@7.31 $ sudo cpanm JSON::Validator@0.96 $ sudo cpanm Mojolicious::Plugin::OpenAPI@1.13 -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 Jiri Kozlovsky <mail@jkozlovsky.cz> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #64796|0 |1 is obsolete| | --- Comment #13 from Jiri Kozlovsky <mail@jkozlovsky.cz> --- Created attachment 65326 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=65326&action=edit Bug 17505: REST API route for messaging preferences Get patron's / category's messaging preferences: GET /messaging_preferences?borrowernumber=123 - allowed if getting own preferences - otherwise borrowers flag required GET /messaging_preferences?categorycode=K - borrowers flag required Modify patron's / category's messaging preferences: PUT /messaging_preferences?borrowernumber=123 - allowed if modifying own preferences - otherwise borrowers flag required PUT /messaging_preferences?categorycode=K - borrowers flag required Returns the following JSON object (same for PUT except for readOnly values): { "Advanced_Notice": { "days_in_advance": { "configurable": true, "value": 20 }, "digest": { "configurable": true, "value": true }, "transport_types": { "email": true, "sms": false } }, "Another_Message_Name": { "days_in_advance": { "configurable": false, "value": null }, "digest": { ... }, ... } To test: 1. prove t/db_dependent/api/v1/messagingpreferences.t 2. Send GET and PUT requests to /api/v1/messaging_preferences Signed-off-by: Jiri Kozlovsky <mail@jkozlovsky.cz> -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 Bug 17505 depends on bug 18137, which changed state. Bug 18137 Summary: REST API: Migrate from Mojolicious::Plugin::Swagger2 to Mojolicious::Plugin::OpenAPI https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18137 What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to Master |RESOLVED Resolution|--- |FIXED -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |katrin.fischer@bsz-bw.de --- Comment #15 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Tomas, could we get your opinion here, plz? :) Lari, did you see https://wiki.koha-community.org/wiki/REST_api_RFCs? I think it might be good to make some changes to make this endpoint match. For example: borrowernumber > patron_id categorycode > category_id -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 Josef Moravec <josef.moravec@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|mail@jkozlovsky.cz |koha-bugs@lists.koha-commun | |ity.org --- Comment #17 from Josef Moravec <josef.moravec@gmail.com> --- (In reply to Tomás Cohen Arazi from comment #16)

Hi Jiri, all looks good. We agreed new endpoints need to be proposed in the form of an RFC and voted on a dev meeting. This is mostly because (usually) the attribute names might require some tweaks. Could you please add an RFC [1], check the agreed coding guidelines for the REST api [2] and add the RFC for consideration on a dev meeting [3]? It should be (probably straight forward, but a needed step). I will help with the process if needed!

Thanks for your contributions and looking forward to communicate with you about your work on the REST api!

[1] https://wiki.koha-community.org/wiki/REST_api_RFCs [2] https://wiki.koha-community.org/wiki/Coding_Guidelines_-_API [3] https://wiki.koha-community.org/wiki/Next_IRC_meetings

As I know, Jiri is not working on Koha anymore, I tried to somehow make a first draft of RF for this: https://wiki.koha-community.org/wiki/Patrons_messaging_preferences_endpoint_... I wanted to simplify it, but I have not an idea if it will work ;) Maybe I over-simplify it ;) If you can have a quick look on it, I would really aprecciate it. -- 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=17505 --- Comment #19 from Tomás Cohen Arazi <tomascohen@gmail.com> --- (In reply to Lari Taskula from comment #18)

I'm open to simplifying, but some thoughts behind the current patch that I think should not be forgotten (most handled in the current patch):

For building a selection list client-wise, user should know which messaging transport types they are able to select. * Which transport types are enabled in Koha, and which transport types are available for a particular message type? * Does patron have defined a valid contact information to select the transport type (it does not make sense to provide sms selection as transport type if patron has no smsalertnumber)? * Is digest available for this transport type? What if a library wants to force digest ON for some messages? * Is days in advance available for this message?

Combine above with patron's current settings. Or do you want another endpoint for checking what options are available and another for displaying patron's current selections?

Also consider checking the same restrictions when PUTting data.

Some of these thoughts are probably outside of scope of this Bug but my main point is that we should announce the available configuration options to API consumer, not just the current selections for this patron.

Maybe there's room for a separate endpoint, I'd say. -- 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=17505 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=23718 -- 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=17505 --- Comment #22 from claire.hernandez@biblibre.com <claire.hernandez@biblibre.com> --- *** Bug 23718 has been marked as a duplicate of this bug. *** -- 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=17505 Margaret Hade <margaret@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |margaret@bywatersolutions.c | |om -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #65326|0 |1 is obsolete| | --- Comment #23 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 151912 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=151912&action=edit Bug 17505: REST API route for messaging preferences Get patron's / category's messaging preferences: GET /messaging_preferences?borrowernumber=123 - allowed if getting own preferences - otherwise borrowers flag required GET /messaging_preferences?categorycode=K - borrowers flag required Modify patron's / category's messaging preferences: PUT /messaging_preferences?borrowernumber=123 - allowed if modifying own preferences - otherwise borrowers flag required PUT /messaging_preferences?categorycode=K - borrowers flag required Returns the following JSON object (same for PUT except for readOnly values): { "Advanced_Notice": { "days_in_advance": { "configurable": true, "value": 20 }, "digest": { "configurable": true, "value": true }, "transport_types": { "email": true, "sms": false } }, "Another_Message_Name": { "days_in_advance": { "configurable": false, "value": null }, "digest": { ... }, ... } To test: 1. prove t/db_dependent/api/v1/messagingpreferences.t 2. Send GET and PUT requests to /api/v1/messaging_preferences Signed-off-by: Jiri Kozlovsky <mail@jkozlovsky.cz> -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 Bug 17505 depends on bug 17499, which changed state. Bug 17499 Summary: Koha objects for messaging preferences https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17499 What |Removed |Added ---------------------------------------------------------------------------- Status|Pushed to master |RESOLVED Resolution|--- |FIXED -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on| |26297 --- Comment #26 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Hi, in my opinion this needs to be redone. Besides naming conventions (e.g. borrowernumber) we have moved forward in some things a while back. My thoughts: We need: GET /patron_categories/:patron_category_id/messaging_preferences GET /patrons/:patron_id/messaging_preferences As for CRUD operations, I don't feel comfortable with just doing PUT /patron_categories/:patron_category_id/messaging_preferences with all the message types and transports. We need more fine-grained control. So probably PUT /patrons/:patron_id/messaging_preferences/:message_type And as I said some time ago, I think we also need some endpoint to fetch the valid message types and also transport types. Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26297 [Bug 26297] Add a route to list patron categories -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17505 Bug 17505 depends on bug 26297, which changed state. Bug 26297 Summary: Add a route to list patron categories https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26297 What |Removed |Added ---------------------------------------------------------------------------- Status|Needs documenting |RESOLVED Resolution|--- |FIXED -- 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=17505 Martin Renvoize (ashimema) <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.