Prototype releases of Philologic, Collocation Table, Concordance and Frequency Table services

Created by Blair Christensen
Last updated: Mar 16, 2012Version comment
2 min read

Prototype releases of the Philologic, Collocation Table, Concordance and Frequency Table services are now available on an external site.  Most of the API defined in the Preliminary API Proposal has been implemented.  The current prototype implementation a) is from an earlier draft of the Philologic v4 specification and b) most of the API methods currently return HTML rather than XML (for ease in prototyping). 

Prototype

The initial prototype code for these services was written in Ruby due to ease of development, testing and deployment.  It consists of the philologic-client Ruby gem and philologic.herokuapp.com prototype site.  Code for both the philologic-client gem and philologic.herokuapp.com prototype site are available from GitHub.

Philologic and Philologic Proxy Service

The Philologic service provides a Bamboo-style API for integrating with one-or-more Philologic endpoints.  The Philologic Proxy service is a subcomponent of the Philologic service that provides a Philologic-style API for integrating with one-or-more Philologic endpoints.

Collocation Table Service

The Collocation Table service provides a generic interface for performing collocation table queries against supported Bamboo services.  The Philologic service will be the first supported service.

Concordance Service

The Concordance service provides a generic interface for performing concordance queries against supported Bamboo services.  The Philologic service will be the first supported service.

Frequency Table Service

The Frequency Table service provides a generic interface for performing frequency table queries against supported Bamboo services.  The Philologic service will be the first supported service.

Status & Next Steps

  1. I am currently updating the philologic-client gem to work with the latest Philologic v4 specification and endpoint, including identifying inconsistencies between the two.  Barring complications, that should be finished by the end of next week (2012-03-23).
  2. After that I will create Philologic and Philologic Proxy services per the Preliminary API Proposal that can be run within a BSP environment, work with Fernando to get these services running with the CI environment and document more details of actual API requests and (XML) responses.  Barring complications, this should be developed and documents (but perhaps not deployed) by the end of April.
  3. Develop, deploy and document the Concordance service.
  4. Develop, deploy and document the Collocation Table service.
  5. Develop, deploy and document the Frequency Table service.