alxp [alxp] [#771670]

CVS edit link for alxp

I've created an API module that wraps the functionality of the Fedora digital repository software's REST API in PHP functions suitable for Drupal developers to use to access and manage repository content from a Drupal site. The home page for the Fedora software is located at http://fedora-commons.org/ .

The initial release of this API module works on Drupal 6 and contains all of Fedora's functionality as well as a SimpleTest script to test the non-destructive parts of the API.

The intended audience for this code is other module developers in the digital library and museum world who want to provide rich web-based front ends to their existing repositories of digital images, text, videos. etc.

This module will be at the core of several other modules to come which will be aimed at site builders to let them get up and running with fully-functioning web sites that connect to Fedora repositories, but I want to have the core API be its own separate module to ensure compatibility with other projects and as a way to enforce separation of concerns in the development and updating process.

Comment	File	Size	Author
#1	fedora_api.tar_.gz	13.6 KB	alxp

Comments

Comment #1

alxp commented 14 April 2010 at 22:47

Status:

Postponed (maintainer needs more info)

» Active

Status	File	Size
new	fedora_api.tar_.gz	13.6 KB

Drupal Fedora API module README.txt
==============================================================================

This is an API module that provides methods for accessing the Fedora digital
object repository (http://fedora-commons.org/) API-A (access) and API-M
(management) APIs for use by other Drupal modules.

The module provides an admin settings page to specify the location of a Fedora
version 3.3 server and the username and password of a Fedora user with
appropriate permssions to access repository objects. It's up to the site
maintainer to ensure that Fedora is properly installed and running and
accessible from the Drupal server instance.

Developer usage
-----------------------------------------------------------------------------

The module doesn't do anything on its own, but provides a full interface for
developers to easily access the web services provided by the Fedora web app
without having to construct their own HTTP requests.

Note about the Fedora Name
-----------------------------------------------------------------------------
Not to be confused with the Linux distribution of the same name - the Fedora
repository software is a completely separate project and has no connection
whatsoever with the Linux distribution or with Red Hat, Inc.

Comment #2

Anonymous (not verified) commented 15 April 2010 at 06:50

Status:

Active

» Needs review

Comment #3

avpaderno

he/him

Italian

Brescia, 🇮🇹 🇪🇺

commented 15 April 2010 at 16:41

Issue tags:

+Module review

Comment #4

avpaderno

he/him

Italian

Brescia, 🇮🇹 🇪🇺

commented 25 May 2010 at 19:38

Assigned:

Unassigned

» avpaderno

I will review the code tomorrow.

Comment #5

avpaderno

he/him

Italian

Brescia, 🇮🇹 🇪🇺

commented 27 May 2010 at 09:20

Status:

Needs review

» Needs work

See http://drupal.org/coding-standards to understand how a module should be written. In particular see which name should be given to functions, Drupal variables, constants defined from the module, and global variables defined from the module.
License files cannot be committed in Drupal.org repository. The license file is already added from the packaging script, and a CVS script blocks the temptative to commit such files.

    '#title' => 'Feodra User',
    '#default_value' => variable_get('fedora_user', 'fedoraAdmin'),
    '#description' => t('The username to use when ocnnecting to the Fedora server.'),

Strings used in the user interface should be in sentence case. There are some typos in the strings (as Feodra instead of Fedora).