http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #1 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 36700 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=36700&action=edit Bug 13799: REST API proof of concept with Mojolicious/Swagger2 1/ Install Mojolicious Perl module 2/ Launch server with: $ morbo ./rest Actual routes are: /borrowers Return a list of all borrowers in Koha /borrowers/{borrowernumber} Return the borrower identified by {borrowernumber} (eg. /borrowers/1) There is a test file you can run with: $ prove t/db_dependent/rest/borrowers.t -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|gmcharlt@gmail.com |julian.maurice@biblibre.com -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #36700|0 |1 is obsolete| | --- Comment #2 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 36705 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=36705&action=edit Bug 13799: REST API proof of concept with Mojolicious/Swagger2 Fixed patch with added dependency on Swagger2 module -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |benjamin.rokseth@kul.oslo.k | |ommune.no --- Comment #4 from Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no> --- Tested this patch locally on a koha dev setup, and some remarks: * incredibly fast! ~50msec on 50 borrowers...promising! * few deps: apt-get install -y make cpanm cpanm Mojolicious cpanm Swagger2 * clean and little "glue-code" to Koha * self-documenting, in a way, with Swagger I propose that this POC is moved forward to a fully working example covering Borrowers, that can be part of Koha 3.20 if the New_REST_API_RFC (http://wiki.koha-community.org/wiki/New_REST_API_RFC) are fullfilled. What's missing now: - authentication - C4::Borrowers vs Koha::Borrowers? - versioning - content negotiation - full CRUD -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |tomascohen@gmail.com -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #6 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 36938 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=36938&action=edit Bug 13799: Add versioning to API -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #8 from Julian Maurice <julian.maurice@biblibre.com> --- Not sure about the last patch, maybe there's a better way to transform Koha::Object(s) into JSON. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #10 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 37132 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=37132&action=edit Bug 13799: Move and fix unit test file -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #11 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 37172 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=37172&action=edit Bug 13799: Fix Koha::Objects::find when no results are found If we pass undef to Koha::Object::_new_from_dbic, it croaks with message "DBIC result type isn't of the type Borrower at Koha/Objects.pm" (in case we're using Koha::Borrowers->find) -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 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.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |13935 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Heather Braum <hbraum@nekls.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |hbraum@nekls.org -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #13 from Robin Sheat <robin@catalyst.net.nz> --- More comments: * version 6.0 is mandated in the dependencies. That's in no Debian release at all right now. We need to ensure it can work on wheezy. * the httpd conf stuff hasn't been updated in the packages. * the code is woefully underdocumented, some new files having exactly zero comments at all, let alone POD and copyright headers. Now to start looking into getting it actually running... -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #15 from Julian Maurice <julian.maurice@biblibre.com> --- It seems that Swagger2 can't work with Mojolicious versions packaged in Debian wheezy Tested with Mojolicious 2.98 (wheezy): $ perl -MSwagger2 -e '' Can't locate encode_json.pm in @INC (@INC contains: /etc/perl /usr/local/lib/perl/5.14.2 /usr/local/share/perl/5.14.2 /usr/lib/perl5 /usr/share/perl5 /usr/lib/perl/5.14 /usr/share/perl/5.14 /usr /local/lib/site_perl .) at /usr/share/perl5/Mojo/Base.pm line 32. BEGIN failed--compilation aborted at /usr/local/share/perl/5.14.2/Swagger2.pm line 50. Compilation failed in require. BEGIN failed--compilation aborted. and with Mojolicious 3.97 (wheezy-backports) $ perl -MSwagger2 -e '' "encode_json" is not exported by the Mojo::JSON module "decode_json" is not exported by the Mojo::JSON module Can't continue after import errors at /usr/local/share/perl/5.14.2/Swagger2.pm line 50 BEGIN failed--compilation aborted at /usr/local/share/perl/5.14.2/Swagger2.pm line 50. Compilation failed in require. BEGIN failed--compilation aborted. With Mojolicious 5.54 (jessie) it works. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #17 from Robin Sheat <robin@catalyst.net.nz> --- (In reply to Julian Maurice from comment #16)

Created attachment 38246 [details] [review] Bug 13799: Change Mojolicious minimum version required (5.54)

That won't help because the version we need to support is 2.98. I would strongly suggest separating the documentation stuff into another bug, and making the API stuff work with mojolicious 2.98, and deal with the documentation separately and more leisurely. As it is, I can't see it getting in as no one will be able to run it without manually cpanning things, which isn't an option. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #19 from Robin Sheat <robin@catalyst.net.nz> --- (In reply to Julian Maurice from comment #18)

Anyway, Jessie will become the new stable in few days. Should we just wait before integrating this ?

We'd be waiting for a year or three, we're only dropping squeeze support as at 3.20.

But what about swagger2, which is not packaged at all ? It is not the only Perl module that needs to be "cpanned" for Koha. So why should we block for this one ? Koha will continue to work without it.

There are no modules that need to be cpanned for Koha, and if there are, that's a bug (with the exception of some test case things, I think.) I think having a significantly useful feature that can't be readily used isn't good, so I'm trying to get it to a point where it can work.

If really needed, it shouldn't be hard to make a Debian package of it.

At the moment, it's not particularly easy, as it needs a version of mojolicious that isn't packaged at all. I attempted to package that, but ran into https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=748244 which caused it to fail. I'll have another go when I get the chance, but depending on bleeding edge modules is always going to be problematic. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #21 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- I tested this few weeks ago and I had no issues running them? Just installed from cpan. Maybe I missed something? I ran the manual test cases defined. We definetely should use the latest Mojolicious and Swagger2 implementations. No compromise here. Documentation and all in one bundle like it was meant to be. Very strange that the latest Mojolicious would be unavailable via packages. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #23 from Julian Maurice <julian.maurice@biblibre.com> --- (In reply to Robin Sheat from comment #22)

(In reply to Julian Maurice from comment #20)

...

I only used dh-make-perl and debuild to build packages (and dpkg to install them).

That won't result in a package acceptable to Debian.

But it will be acceptable to debian.koha-community.org, won't it ? -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Chris Cormack <chris@bigballofwax.co.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |chris@bigballofwax.co.nz --- Comment #24 from Chris Cormack <chris@bigballofwax.co.nz> --- (In reply to Julian Maurice from comment #23)

(In reply to Robin Sheat from comment #22)

...

(In reply to Julian Maurice from comment #20)

...

I only used dh-make-perl and debuild to build packages (and dpkg to install them).

That won't result in a package acceptable to Debian.

But it will be acceptable to debian.koha-community.org, won't it ?

No, we build proper packages for debian.koha-community.org and upstream them also. eg https://qa.debian.org/developer.php?login=robin@catalyst.net.nz this gets them into debian proper, and from there into ubuntu. Regardless of the packages, I think this should be split into a bunch of bugs, certainly shifting the documentation one off on to its on thing. I don't think we need to build any front end stuff for this. If we do that should be on it's on bug also. To get something like this in, its much better to do what was done with the acquisitions work, seperate bugs that don't mean the entire thing has to pass at once. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #26 from Kyle M Hall <kyle@bywatersolutions.com> --- (In reply to Robin Sheat from comment #19)

(In reply to Julian Maurice from comment #18)

...

Anyway, Jessie will become the new stable in few days. Should we just wait before integrating this ?

We'd be waiting for a year or three, we're only dropping squeeze support as at 3.20.

With 3.20 around the corner is this really an issue? It just means that it wouldn't be backportable to earlier versions of Koha, correct? Considering this is an enhancement I wouldn't expect it to be backported anyway. Are there other considerations I'm missing? -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #28 from Kyle M Hall <kyle@bywatersolutions.com> --- (In reply to Kyle M Hall from comment #26)

(In reply to Robin Sheat from comment #19)

...

(In reply to Julian Maurice from comment #18)

...

Anyway, Jessie will become the new stable in few days. Should we just wait before integrating this ?

We'd be waiting for a year or three, we're only dropping squeeze support as at 3.20.

With 3.20 around the corner is this really an issue? It just means that it wouldn't be backportable to earlier versions of Koha, correct? Considering this is an enhancement I wouldn't expect it to be backported anyway. Are there other considerations I'm missing?

Ignore this comment, I had my versions crossed. Any idea what the possibility of taking the package for Jesse and using it on Wheezy is? -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #30 from Chris Cormack <chris@bigballofwax.co.nz> --- This feels like making work for users and package maintainers, to make something arguably easier for developers. This is something that has made a mess for us a lot in the past. However, we probably should not be worrying about this, as it's missed the window for 3.20 already and be expending energy on testing and fixing bugs. We can argue about adding unnessecary dependencies again after the release. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #32 from Julian Maurice <julian.maurice@biblibre.com> --- (In reply to Robin Sheat from comment #31)

(In reply to Kyle M Hall from comment #28)

...

Ignore this comment, I had my versions crossed. Any idea what the possibility of taking the package for Jesse and using it on Wheezy is?

Dependency packages need to be actually built for the environment, we can't just grab a .deb file and throw it in.

I tried to build Mojolicious package for Wheezy from here: git://git.debian.org/git/pkg-perl/packages/libmojolicious-perl.git I had to install several *build* dependencies from Jessie, but the resulting binary package should work well on wheezy. In Jessie libmojolicious-perl depends on libjs-prettify which is not in Wheezy so I had to also build this package. Building source packages requires much more work, as there is a lot of build dependencies not packaged in wheezy, but do we need them ? (for libjs-prettify I retrieved files from packages.debian.org and built from there) -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #34 from Julian Maurice <julian.maurice@biblibre.com> --- (In reply to Robin Sheat from comment #33)

All this said, I just downgraded tar in my package building VM to the version from squeeze, and uscan succeeds. So there is hope yet.

Yay! \o/ About 5.54 vs 6.0, maybe we could ask the author of Swagger2 to change the required version of Mojolicious (if Swagger2 is proven to work with 5.54 of course). What do you think ? Will that make things easier ? On the other hand, having the latest version of Mojolicious into Debian would be great if this doesn't require extra work. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #36 from Julian Maurice <julian.maurice@biblibre.com> --- Just asked: https://github.com/jhthorsen/swagger2/issues/14 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Version|unspecified |master -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #36705|0 |1 is obsolete| | --- Comment #38 from Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no> --- Created attachment 39156 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=39156&action=edit Bug 13799: REST API proof of concept with Mojolicious/Swagger2 1/ Install Mojolicious Perl module 2/ Launch server with: $ morbo ./rest Actual routes are: /borrowers Return a list of all borrowers in Koha /borrowers/{borrowernumber} Return the borrower identified by {borrowernumber} (eg. /borrowers/1) There is a test file you can run with: $ prove t/db_dependent/rest/borrowers.t -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #36705|1 |0 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #36705|0 |1 is obsolete| | Attachment #36938|0 |1 is obsolete| | Attachment #36941|0 |1 is obsolete| | Attachment #37119|0 |1 is obsolete| | Attachment #37132|0 |1 is obsolete| | Attachment #37172|0 |1 is obsolete| | Attachment #38246|0 |1 is obsolete| | --- Comment #40 from Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no> --- Created attachment 39158 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=39158&action=edit Bug 13799: REST API proof of concept with Mojolicious/Swagger2 1/ Install Mojolicious Perl module 2/ Launch server with: $ morbo ./rest Actual routes are: /borrowers Return a list of all borrowers in Koha /borrowers/{borrowernumber} Return the borrower identified by {borrowernumber} (eg. /borrowers/1) There is a test file you can run with: $ prove t/db_dependent/rest/borrowers.t -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #42 from Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no> --- Created attachment 39160 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=39160&action=edit Bug 13799: Use Koha::Objects This add 'unblessed' subroutines to both Koha::Objects and Koha::Object to be able to pass it to Mojolicious -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #44 from Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no> --- Created attachment 39162 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=39162&action=edit Bug 13799: Move and fix unit test file -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #46 from Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no> --- Created attachment 39164 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=39164&action=edit Bug 13799: Change Mojolicious minimum version required (5.54) -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #47 from Robin Sheat <robin@catalyst.net.nz> --- libmojolicious-perl_5.54+dfsg-1~koha1_all.deb (etc.) and libjs-prettify_2013.03.04+dfsg-4~koha1_all.deb (etc.) are now in the repo. I had to install Java on my build vm to get that last one to build. I hope you're happy! ;) Now to look into swagger2. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #49 from Julian Maurice <julian.maurice@biblibre.com> --- Great! Thanks Robin! -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |katrin.fischer@bsz-bw.de --- Comment #51 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- What are the next steps here? -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #39158|0 |1 is obsolete| | --- Comment #53 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40088 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40088&action=edit Bug 13799: REST API proof of concept with Mojolicious/Swagger2 1/ Install Mojolicious Perl module 2/ Launch server with: $ morbo ./rest Actual routes are: /borrowers Return a list of all borrowers in Koha /borrowers/{borrowernumber} Return the borrower identified by {borrowernumber} (eg. /borrowers/1) There is a test file you can run with: $ prove t/db_dependent/rest/borrowers.t -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #55 from Tomás Cohen Arazi <tomascohen@gmail.com> --- (In reply to Olli-Antti Kivilahti from comment #54)

Comment on attachment 39163 [details] [review] Bug 13799: Fix Koha::Objects::find when no results are found

Bug 13799: Fix Koha::Objects::find when no results are found is obsoleted now by Bug 13967 - System preferences need a package ??

I think so. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #57 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40093 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40093&action=edit Bug 13799 - Nginx reverse proxy config baseline for Koha REST API. Tweaking needed to work with makefile. Uses a self-signed SSL-certificate to service at port 444 by default. Reverse proxies to 127.0.0.1:8080 (expecting hypnotoad to be listening) ¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤ ¤¤ Koha API Nginx configuration ¤¤ ¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤ Deploy the Nginx configuration ------------------------------ Run make to populate the koha-nginx-kohaapi.conf link to the /etc/nginx/sites-available/ -directory ..$ ln -s /home/koha/koha-dev/etc/koha-nginx-kohaapi.conf /etc/nginx/sites-available/kohaapi and enable with command ..$ ln -s /etc/nginx/sites-available/kohaapi /etc/nginx/sites-enabled/kohaapi Disable the default config ..$ rm /etc/nginx/sites-enabled/default Create a openssl self-signed certificate or use your own. --------------------------------------------------------- ..$ cd /etc/nginx ..$ mkdir ssl ..$ chmod 400 ssl ..$ cd ssl ..$ openssl req -x509 -sha256 -newkey rsa:2048 -keyout key.pem.secure -out cert.pem -days 720 ..$ openssl rsa -in key.pem.secure -out key.pem ..$ chmod 400 * Restart nginx ..$ service nginx restart -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #59 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40098 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40098&action=edit Bug 13799 - Set up logging and configuration file reading for Mojolicious. Use environmental values to control some aspects of Mojolicious: This way we can have different settings for different servers running Mojolicious. %%%% Configuration file %%%% $ENV{MOJO_CONFIG} should be set in the system service (init) starting Mojolicious, eg: export MOJO_CONFIG=/home/koha/kohaclone/api/v1/hypnotoad.conf This configuration file read by the Mojolicious::Plugin::Config http://mojolicio.us/perldoc/Mojolicious/Plugin/Config %%%%% Logging %%%%% Log to a filename configured in an environemnt variable $ENV{MOJO_LOGFILE} using loglevel $ENV{MOJO_LOGLEVEL}. Defaults to '/tmp/koha-api.log' and loglevel of 'error' Examples: export MOJO_LOGFILE=/home/koha/koha-dev/var/log/kohaapi.mojo.log export MOJO_LOGLEVEL=debug Logging is done by Mojo::Log http://www.mojolicio.us/perldoc/Mojo/Log -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40092|0 |1 is obsolete| | --- Comment #61 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40099 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40099&action=edit Bug 13799 - Adding the REST API as a Hypnotoad service, koha-api-daemon. After running make, the koha-api-daemon.sh -script should be in ../koha-dev/bin/koha-api-daemon.sh Link it to the init-directory and set up upstart triggers: ..$ ln -s /home/koha/koha-dev/bin/koha-api-daemon.sh /etc/init.d/koha-api-daemon ..$ update-rc.d koha-api-daemon defaults Start hypnotoad: ..$ service koha-api-daemon start Hypnotoad is now listening in 127.0.0.1:8080 and is preconfigured to be production ready. Hypnotoad config is in $KOHA_PATH/api/v1/hypnotoad.conf For more info, read the koha-api-daemon.sh -service -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #63 from Robin Sheat <robin@catalyst.net.nz> --- How will that interact with Plack? Environment variables aren't the easiest thing to pass through to that at this stage. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #64 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- (In reply to Robin Sheat from comment #63)

How will that interact with Plack? Environment variables aren't the easiest thing to pass through to that at this stage.

I think this will be overwritten by plack. I just created this system because there was no other system published in bugzilla for me to start building stuff on top of the Koha REST API. I think the big question is how to pass variables to Mojolicious app, without using env-variables. I don't know and the solution is good enough for me. What I would be worried of, is the redirection of STDERR and STDOUT to /dev/null in Mojo::Server::damonize(). Thus logging those streams from the service-script doesn't work, but it works when running Mojolicious directly from the terminal. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40098|0 |1 is obsolete| | --- Comment #66 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40140 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40140&action=edit Bug 13799 - Set up logging and configuration file reading for Mojolicious. Use environmental values to control some aspects of Mojolicious: This way we can have different settings for different servers running Mojolicious. %%%% Configuration file %%%% $ENV{MOJO_CONFIG} should be set in the system service (init) starting Mojolicious, eg: export MOJO_CONFIG=/home/koha/kohaclone/api/v1/hypnotoad.conf This configuration file read by the Mojolicious::Plugin::Config http://mojolicio.us/perldoc/Mojolicious/Plugin/Config %%%%% Logging %%%%%

NOTE!! There is a "feature" in Mojo::Server disabling STDOUT and STDERR, because such errors are not-suited-for-prod~ This modification in Mojo::Server disables this and preserves the STD* handles for forked server threads in Mojo::Server::daemonize(), comment out the following lines

# Close filehandles # open STDOUT, '>/dev/null'; # open STDERR, '>&STDOUT';

Log to a filename configured in an environemnt variable $ENV{MOJO_LOGFILE} using loglevel $ENV{MOJO_LOGLEVEL}. Defaults to '/tmp/koha-api.log' and loglevel of 'error' Examples: export MOJO_LOGFILE=/home/koha/koha-dev/var/log/kohaapi.mojo.log export MOJO_LOGLEVEL=debug Logging is done by Mojo::Log http://www.mojolicio.us/perldoc/Mojo/Log -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40141|0 |1 is obsolete| | --- Comment #68 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40142 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40142&action=edit Bug 13799 - Adding the REST API as a Hypnotoad service, koha-api-daemon. After running make, the koha-api-daemon.sh -script should be in ../koha-dev/bin/koha-api-daemon.sh Link it to the init-directory and set up upstart triggers: ..$ ln -s /home/koha/koha-dev/bin/koha-api-daemon.sh /etc/init.d/koha-api-daemon ..$ update-rc.d koha-api-daemon defaults Start hypnotoad: ..$ service koha-api-daemon start Hypnotoad is now listening in 127.0.0.1:8080 and is preconfigured to be production ready. Hypnotoad config is in $KOHA_PATH/api/v1/hypnotoad.conf For more info, read the koha-api-daemon.sh -service -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #39159|0 |1 is obsolete| | --- Comment #70 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40464 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40464&action=edit Rebased -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #39161|0 |1 is obsolete| | --- Comment #72 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40466 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40466&action=edit Rebased -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #39164|0 |1 is obsolete| | --- Comment #74 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40468 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40468&action=edit Rebased -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40142|0 |1 is obsolete| | --- Comment #76 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40470 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40470&action=edit Rebased -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #78 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Olli, while I'm not against the idea to moving into nginx and/or hypnotoad, I think putting this patches here just make more confusion. If it is possible, could you please move your integration work into the wiki? So on this bug we discuss the REST patches only? If you have a serious proposal of moving away from Apache, you should definitely put that on a new bug report. AS I see it, your patch(es) aid testing the REST implementation, so they are really useful. Just move them outside this specific bug. Please :-D -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Jonathan Druart <jonathan.druart@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart@biblibre.co | |m --- Comment #80 from Jonathan Druart <jonathan.druart@biblibre.com> --- Julian, 1) This needs a squash, to avoid add/del of the same file/dir in the same patch set and an up-to-date test plan. 2) /v1/doc returns "Page not found... yet!" 3) /v1/borrowers/7853 Check the encoding, I get "address2":"éééصةصةصة" With MariaDB [koha]> select address2 from borrowers where borrowernumber=7874\G *************************** 1. row *************************** address2: éééصةصةصة -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #81 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40551 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40551&action=edit Bug 13799: REST API proof of concept with Mojolicious/Swagger2 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40469|0 |1 is obsolete| | --- Comment #82 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40552 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40552&action=edit Bug 13799: Add versioning to API --- Comment #83 from Julian Maurice <julian.maurice@biblibre.com> --- Comment on attachment 40469 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40469 Rebased Patch moved to new bug 14448 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #85 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40554 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40554&action=edit Bug 13799: Add Swagger UI documentation -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40471|0 |1 is obsolete| | --- Comment #87 from Julian Maurice <julian.maurice@biblibre.com> --- Comment on attachment 40471 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40471 Bug 13799 - Nginx reverse proxy config baseline for Koha REST API. Tweaking needed to work with makefile. Patch moved to new bug 14448 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40464|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40466|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40468|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40552|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40554|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #89 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 40561 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40561&action=edit Bug 13799: Force UTF-8 charset in responses -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #91 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40584 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40584&action=edit Bug 13799: 1. RESTful API with Mojolicious and Swagger2 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #93 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40586 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40586&action=edit Bug 13799: 3. Force UTF-8 charset in responses -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40560|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #95 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- The order of applying these following bugs is as follow: 13799 -> 13895 -> 13903 -> 13920 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |14458 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40585|0 |1 is obsolete| | --- Comment #97 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 40617 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40617&action=edit Bug 13799: 2. Set up logging and configuration file reading for Mojolicious. Use environmental values to control some aspects of Mojolicious: This way we can have different settings for different servers running Mojolicious. %%%% Configuration file %%%% $ENV{MOJO_CONFIG} should be set in the system service (init) starting Mojolicious, eg: export MOJO_CONFIG=/home/koha/kohaclone/api/v1/hypnotoad.conf This configuration file read by the Mojolicious::Plugin::Config http://mojolicio.us/perldoc/Mojolicious/Plugin/Config %%%%% Logging %%%%% NOTE!! There is a "feature" in Mojo::Server disabling STDOUT and STDERR, because such errors are not-suited-for-prod~ This modification in Mojo::Server disables this and preserves the STD* handles for forked server threads in Mojo::Server::daemonize(), comment out the following lines # Close filehandles # open STDOUT, '>/dev/null'; # open STDERR, '>&STDOUT'; Log to a filename configured in an environemnt variable $ENV{MOJO_LOGFILE} using loglevel $ENV{MOJO_LOGLEVEL}. Defaults to '/tmp/koha-api.log' and loglevel of 'error' Examples: export MOJO_LOGFILE=/home/koha/koha-dev/var/log/kohaapi.mojo.log export MOJO_LOGLEVEL=debug Logging is done by Mojo::Log http://www.mojolicio.us/perldoc/Mojo/Log -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40587|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #100 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 40619 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=40619&action=edit Bug 13799 - 4. Add base for building RESTful API - Fix missing character encoding in the index.html -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Depends on| |14455 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40616|0 |1 is obsolete| | --- Comment #101 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 41160 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41160&action=edit Bug 13799: 1. RESTful API with Mojolicious and Swagger2 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #40618|0 |1 is obsolete| | --- Comment #103 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 41162 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41162&action=edit Bug 13799: 3. Force UTF-8 charset in responses -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #41161|0 |1 is obsolete| | --- Comment #105 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 41269 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41269&action=edit Bug 13799 - 2. Set up logging and configuration file reading for Mojolicious. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #107 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 41271 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41271&action=edit Bug 13799: 4. API Authentication, part 1: API keys management in interface Depends on Buugg 14539 and Buugg 7174. This introduces the concept of API keys for use in the new REST API. A key is a string of 32 alphanumerical characters (32 is purely arbitrary, it can be changed easily). A user can have multiple keys (unlimited at the moment) Keys can be generated automatically, and then we have the possibility to delete or revoke each one individually. ApiKeys can be easily accessed using the Koha::ApiKeys-package. Includes unit tests and selenium integration tests for Intra and OPAC. Test plan: 1/ Go to staff interface 2/ Go to a borrower page 3/ In toolbar, click on More -> Manage API keys 4/ Click on "Generate new key" multiple times, check that they are correctly displayed under the button, and they are active by default 5/ Revoke some keys, check that they are not active anymore 6/ Delete some keys, check that they disappear from table 7/ Go to opac interface, log in 8/ In your user account pages, you now have a new tab to the left "your API keys". Click on it. 9/ Repeat steps 4-6 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #109 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 41273 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41273&action=edit Bug 13799 - 6. REST API Testing framework Introduces the Swagger2TestRunner which takes care of authentication and API consumer creation behind the scenes, and makes sure all API endpoints get test coverage. This way the test automator can focus on testing the business logic instead of duplicating authentication and API consumer creation in various test scripts. Run t/db_dependent/Api/V1/testREST.pl and it will tell you what you need to do. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #111 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- *** Bug 13920 has been marked as a duplicate of this bug. *** -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #112 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 41320 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41320&action=edit Bug 13799 - 1.1 RESTful API with reverse proxy configuration without api.host.domain OPTIONAL replacement to the Buugg 13799: 1. RESTful API with Mojolicious and Swagger2 httpd-configuration. Instead of having to go to your dns-provider, you can run the api from your current virtualhost. Use these configurations to reverse proxy www.host.domain/v1/ to the REST API. --------------------------- :INSTALLATION INSTRUCTIONS: --------------------------- You need Buugg 14448 - Adding the REST API as a Hypnotoad service, koha-api-daemon. to deploy the backend Mojolicous application as a FastCGI-daemon. Then add the modifications from etc/koha-httpd.conf to your /etc/apache2/sites-enabled/koha.conf and adjust paths to fit. ..$ a2enmod proxy ..$ a2enmod proxy_http ..$ service apache2 restart Much recommended is Buugg 14458: 5. Add SwaggerUI documentation for RESTful API to browse your API capabilities. Then just go to /v1/doc to see the API autodocumentation. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #41268|0 |1 is obsolete| | --- Comment #114 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 41326 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41326&action=edit Bug 13799: 1. RESTful API with Mojolicious and Swagger2 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #41269|0 |1 is obsolete| | --- Comment #116 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 41328 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41328&action=edit Bug 13799 - 2. Set up logging and configuration file reading for Mojolicious. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #41321|0 |1 is obsolete| | --- Comment #118 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 41330 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41330&action=edit Bug 13799: 4. API Authentication, part 1: API keys management in interface -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |14656 Referenced Bugs: http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14656 [Bug 14656] Delete Bibliographic Records REST API route & permission -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #41327|0 |1 is obsolete| | --- Comment #121 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 41539 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41539&action=edit Bug 13799 - 1.1 RESTful API with reverse proxy configuration without api.host.domain -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #41329|0 |1 is obsolete| | --- Comment #123 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 41541 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41541&action=edit Bug 13799: 3. Force UTF-8 charset in responses -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #41331|0 |1 is obsolete| | --- Comment #125 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 41543 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41543&action=edit Bug 13799: 5. API authentication system - Swagtenticator authentication -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #41538|0 |1 is obsolete| | --- Comment #127 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Created attachment 41554 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41554&action=edit Bug 13799: 1. RESTful API with Mojolicious and Swagger2 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #41540|0 |1 is obsolete| | --- Comment #128 from Julian Maurice <julian.maurice@biblibre.com> --- Comment on attachment 41540 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41540 Bug 13799 - 2. Set up logging and configuration file reading for Mojolicious. Patch moved to bug 14746 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #41539|0 |1 is obsolete| | --- Comment #129 from Julian Maurice <julian.maurice@biblibre.com> --- Comment on attachment 41539 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41539 Bug 13799 - 1.1 RESTful API with reverse proxy configuration without api.host.domain Patch moved to bug 14747 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #41543|0 |1 is obsolete| | --- Comment #131 from Julian Maurice <julian.maurice@biblibre.com> --- Comment on attachment 41543 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41543 Bug 13799: 5. API authentication system - Swagtenticator authentication Patch moved to bug 13920 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #41547|0 |1 is obsolete| | --- Comment #132 from Julian Maurice <julian.maurice@biblibre.com> --- Comment on attachment 41547 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=41547 Bug 13799 - 6. REST API Testing framework Patch moved to bug 14748 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #41274|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |ASSIGNED --- Comment #134 from Julian Maurice <julian.maurice@biblibre.com> --- All patches moved to their own bugs so we have a simple patch that just works (I hope...) and without a huge dependency tree. It should make testing a lot easier. A feature is still missing however: the cookie-based authentication. I'll try to work on that soon. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |14749 Referenced Bugs: http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14749 [Bug 14749] Add API route to get top issues -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Alex Arnaud <alex.arnaud@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42044|0 |1 is obsolete| | --- Comment #136 from Alex Arnaud <alex.arnaud@biblibre.com> --- Created attachment 42085 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42085&action=edit Bug 13799: RESTful API with Mojolicious and Swagger2 Actual routes are: /borrowers Return a list of all borrowers in Koha /borrowers/{borrowernumber} Return the borrower identified by {borrowernumber} (eg. /borrowers/1) There is a test file you can run with: $ prove t/db_dependent/rest/borrowers.t All API stuff is in /api/v1 (except Perl modules) So we have: /api/v1/script.cgi CGI script /api/v1/swagger.json Swagger specification Change both OPAC and Intranet VirtualHosts to access the API, so we have: http://OPAC/api/v1/swagger.json Swagger specification http://OPAC/api/v1/{path} API endpoint http://INTRANET/api/v1/swagger.json Swagger specification http://INTRANET/api/v1/{path} API endpoint Add a (disabled) virtual host in Apache configuration api.HOSTNAME, so we have: http://api.HOSTNAME/api/v1/swagger.json Swagger specification http://api.HOSTNAME/api/v1/{path} API endpoint Add 'unblessed' subroutines to both Koha::Objects and Koha::Object to be able to pass it to Mojolicious Test plan: 1/ Install Perl modules Mojolicious and Swagger2 2/ perl Makefile.PL 3/ make && make install 4/ Change etc/koha-httpd.conf and copy it to the right place if needed 5/ Reload Apache 6/ Check that http://(OPAC|INTRANET)/v1/borrowers and http://(OPAC|INTRANET)/v1/borrowers/{borrowernumber} works Optionally, you could verify that http://(OPAC|INTRANET)/vX/borrowers (where X is an integer greater than 1) returns a 404 error Signed-off-by: Alex Arnaud <alex.arnaud@biblibre.com> -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #138 from Alex Arnaud <alex.arnaud@biblibre.com> --- reattached the patch because i've changed the webservices url in the commit message (http://(OPAC|INTRANET)/api/v1/borrowers instead of http://(OPAC|INTRANET)/v1/borrowers) -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|ASSIGNED |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Zeno Tajoli <z.tajoli@cineca.it> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch complexity|--- |Large patch CC| |z.tajoli@cineca.it --- Comment #141 from Zeno Tajoli <z.tajoli@cineca.it> --- Patch complexity is 'Large' because this change has many architectural connections -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Zeno Tajoli <z.tajoli@cineca.it> changed: What |Removed |Added ---------------------------------------------------------------------------- CC|z.tajoli@cineca.it | -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #143 from Julian Maurice <julian.maurice@biblibre.com> --- Yes, we can, and we should, as we agreed on that during the previous dev meeting. It's better to have a tiny patch in master than a big, full-featured patch that will never be pushed because of its complexity. And the API key authentication system needs some discussion, as some people disagree with it. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #145 from Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi> --- Hi! Had a discussion in IRC with jajm and ashimema about REST API permission checking. And since the author of Mojolicious:Plugin::Swagger2 has kindly improved the plugin per the discussions I have had with him. I decided to utilize the new around-action -hook of the Swagger2-plugin to implement Swagger2-driven permission checking for the REST API authentication mechanism. I really need to start migrating another legacy ILS to Koha, but it would be a real shame to let this great improvement pass. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #147 from Julian Maurice <julian.maurice@biblibre.com> --- I have a few concerns using x-mojo-around feature of Swagger2: 1/ It is marked as experimental (from the POD: "This feature is EXPERIMENTAL and can change without notice.") 2/ It is introduced only in Swagger2 0.45 and thus we'll need to repackage it for Debian (packaged version in debian.koha-community.org is only 0.31) I think these two points will block integration, so I'm wondering if it's not better to include the patch in a new bug. What do you think ? -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #148 from Julian Maurice <julian.maurice@biblibre.com> --- No movement for a week, I'll move the last patch into its own bug. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Julian Maurice <julian.maurice@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42518|0 |1 is obsolete| | --- Comment #149 from Julian Maurice <julian.maurice@biblibre.com> --- Comment on attachment 42518 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42518 Bug 13799 - Swagger2-driven Permission checking Patch moved to its own bug (bug 14868) -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Joonas Kylmälä <j.kylmala@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42766|0 |1 is obsolete| | --- Comment #151 from Joonas Kylmälä <j.kylmala@gmail.com> --- Created attachment 42768 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42768&action=edit Bug 13799: Add missing license notices Signed-off-by: Joonas Kylmälä <j.kylmala@gmail.com> -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #153 from Julian Maurice <julian.maurice@biblibre.com> --- Created attachment 42801 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42801&action=edit Bug 13799: Fix API unit tests They were failing because of the now required 'borrowers' permission -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42086|0 |1 is obsolete| | --- Comment #155 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 42874 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42874&action=edit [SIGNED OFF] Bug 13799: RESTful API with Mojolicious and Swagger2 Actual routes are: /borrowers Return a list of all borrowers in Koha /borrowers/{borrowernumber} Return the borrower identified by {borrowernumber} (eg. /borrowers/1) There is a test file you can run with: $ prove t/db_dependent/rest/borrowers.t All API stuff is in /api/v1 (except Perl modules) So we have: /api/v1/script.cgi CGI script /api/v1/swagger.json Swagger specification Change both OPAC and Intranet VirtualHosts to access the API, so we have: http://OPAC/api/v1/swagger.json Swagger specification http://OPAC/api/v1/{path} API endpoint http://INTRANET/api/v1/swagger.json Swagger specification http://INTRANET/api/v1/{path} API endpoint Add a (disabled) virtual host in Apache configuration api.HOSTNAME, so we have: http://api.HOSTNAME/api/v1/swagger.json Swagger specification http://api.HOSTNAME/api/v1/{path} API endpoint Add 'unblessed' subroutines to both Koha::Objects and Koha::Object to be able to pass it to Mojolicious Test plan: 1/ Install Perl modules Mojolicious and Swagger2 2/ perl Makefile.PL 3/ make && make install 4/ Change etc/koha-httpd.conf and copy it to the right place if needed 5/ Reload Apache 6/ Check that http://(OPAC|INTRANET)/api/v1/borrowers and http://(OPAC|INTRANET)/api/v1/borrowers/{borrowernumber} works Optionally, you could verify that http://(OPAC|INTRANET)/vX/borrowers (where X is an integer greater than 1) returns a 404 error Signed-off-by: Alex Arnaud <alex.arnaud@biblibre.com> Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #42768|0 |1 is obsolete| | --- Comment #157 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 42876 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=42876&action=edit [SIGNED OFF] Bug 13799: Add missing license notices Signed-off-by: Joonas Kylmälä <j.kylmala@gmail.com> Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 Kyle M Hall <kyle.m.hall@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- QA Contact|testopia@bugs.koha-communit |kyle.m.hall@gmail.com |y.org | CC| |kyle.m.hall@gmail.com -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13799 --- Comment #161 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- I have also started QAing this one yesterday. Back today with few comments: 1/ 404 is not documented in the swagger.json file 2/ The properties for "borrowers" are not exhaustive 3/ Wording: borrowers vs patrons? "Patron" should be used now, especially for new code. 4/ this patch set introduces swagger.json but nothing to use it, how is it useful? 5/ We need a way to split this json file, it will be a mess to edit! And something to validate it. We need guidelines. 6/ Koha::Borrowers->find is called in Koha::REST::V1::Borrowers::get_borrower and Koha::REST::V1->startup (?) -- You are receiving this mail because: You are watching all bug changes.