Uploaded image for project: 'DSpace'
  1. DSpace
  2. DS-1109

Incorporate Hedtek Improvements to REST-API

    Details

    • Type: Code Task
    • Status: Closed (View Workflow)
    • Priority: Minor
    • Resolution: Won't Fix
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: REST API
    • Labels:
      None
    • Attachments:
      0
    • Comments:
      10
    • Documentation Status:
      Needed

      Description

      A group of developers at Hedtek contacted the mailing list making us aware of their improvements they have made to the REST-API. Their improvements include tests, and other bug fixes to improve stability of the REST api. Their improvements have been made to their Git repository, which isn't quite a clone of the svn project for the dspace rest project.

      My / PeterDietz's question...
      Shall the dspace-rest project be moved to Github to make it easier for community contributions? Including to merge in these improvements from Hedtek. DSpace is potentially moving all code to GitHub, and if so, it would make sense for modules to move there as well anyways. Tim has recently moved the dspace-replicate module code there.

      If so, then I have no problem stitching together the history of our code history from SVN, and their disjoint work in their github. From then on, hedtek can fork the future consolidated git repository, and continue development as they had been. The next benefit is that DSpace can then merge in their improvements much easier. Merge, cherry-pick, or Pull-Request.

      Subject: [Dspace-devel] Testing the DSpace REST API
      From: Mark van Harmelen

      Hi everyone

      Through Jorum [1] we've been doing some JISC [2] funded work on testing the DSpace REST API. To date we have tested most of the 'read' side of the API, later we may be moving onto the 'write' side.

      You can find out what we have done so far at http://hedtek.com/2011/dspace-rest-api-testing/ including the URL of our github repo (that contains slightly modified code for the API and our tests).
      What we have found out about the API so far appears in the sole/first comment on the blog post.

      I am the sole Hedtek person on this list, if you want to ask questions or comment, I will pick them up, but even better please to cc them to hedtek@googlegroups.com

      Thanks/regards
      mark

      [1] http://www.jorum.ac.uk/
      [2] http://www.jisc.ac.uk/

        Attachments

          Activity

          Hide
          ottenhoffs Samuel Ottenhoff added a comment -

          Yeah, installing the code will cause regressions for anyone depending on write ability. I notice there are already modules on the web using the REST provider (Drupal has a module for example).

          That said, the Hedtek code contains lots of solid tests so may better serve as the foundation to layer new code on top.

          Show
          ottenhoffs Samuel Ottenhoff added a comment - Yeah, installing the code will cause regressions for anyone depending on write ability. I notice there are already modules on the web using the REST provider (Drupal has a module for example). That said, the Hedtek code contains lots of solid tests so may better serve as the foundation to layer new code on top.
          Hide
          bojan Bojan Suzic added a comment -

          I will check that issue in the next several days and see how it could be integrated to keep the PUT/POST functionality. Maybe we could use Samuel's idea.

          Show
          bojan Bojan Suzic added a comment - I will check that issue in the next several days and see how it could be integrated to keep the PUT/POST functionality. Maybe we could use Samuel's idea.
          Hide
          sands Sands Fish added a comment -

          It would be great to add a README to the Github project detailing how to build/integrate the project with an existing DSpace instance, version prerequisites, etc. Maybe this exists already but just hasn't been placed in the conventional Github README location at the top level.

          Show
          sands Sands Fish added a comment - It would be great to add a README to the Github project detailing how to build/integrate the project with an existing DSpace instance, version prerequisites, etc. Maybe this exists already but just hasn't been placed in the conventional Github README location at the top level.
          Hide
          bojan Bojan Suzic added a comment -

          In the meantime I took a look at the code. It seems that Hedtek is actively reworking/refactoring, they pushed commits generally everyday. The contribution improved the code quality significantly. I would suggest to wait for their contribution to be complete.
          Also I noticed an ongoing discussion at Developers Virtual Summits and there are some other proposals related to REST API. Probably it would be a good idea to wait a few days for a general agreement on that side.

          Show
          bojan Bojan Suzic added a comment - In the meantime I took a look at the code. It seems that Hedtek is actively reworking/refactoring, they pushed commits generally everyday. The contribution improved the code quality significantly. I would suggest to wait for their contribution to be complete. Also I noticed an ongoing discussion at Developers Virtual Summits and there are some other proposals related to REST API. Probably it would be a good idea to wait a few days for a general agreement on that side.
          Hide
          tdonohue Tim Donohue added a comment -

          As-is, this ticket is obsolete. It refers to the old Google Summer of Code REST-API project, which is no longer maintained/obsolete itself.

          We're closing this ticket as it is obsolete. However, this does NOT mean we reject HedTek's work. That HedTek REST API is worth utilizing and possibly worth merging into DSpace wholesale. However, HedTek REST API should not be merged into an old codebase (the old REST API).

          As it is, this ticket describes an old idea which is no longer relevant. There is new work around deciding on a stable REST API for DSpace at:
          https://wiki.duraspace.org/display/DSPACE/DSpace+Futures+-+REST+API

          Show
          tdonohue Tim Donohue added a comment - As-is, this ticket is obsolete. It refers to the old Google Summer of Code REST-API project, which is no longer maintained/obsolete itself. We're closing this ticket as it is obsolete. However, this does NOT mean we reject HedTek's work. That HedTek REST API is worth utilizing and possibly worth merging into DSpace wholesale. However, HedTek REST API should not be merged into an old codebase (the old REST API). As it is, this ticket describes an old idea which is no longer relevant. There is new work around deciding on a stable REST API for DSpace at: https://wiki.duraspace.org/display/DSPACE/DSpace+Futures+-+REST+API

            People

            • Assignee:
              Unassigned
              Reporter:
              peterdietz Peter Dietz
              Reviewer:
              Bojan Suzic
            • Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: