pe-gasjot-app

pe-gasjot-app is the REST API endpoint for the Gas Jot system. The Gas Jot system consists of 2 tiers: client applications and the server application. pe-fp-app represents the server application; it exposes a REST API endpoint to client applications.

pe-gasjot-app makes use of the pe-* Clojure library suite. In addition to using the pe-* library suite, it leverages pe-gasjot-rest, which implements the underlying gas purchase-specific resources of the REST API. pe-gasjot-rest is built on top of pe-gasjot-core, which implements the core logic, model and data access functionality of the REST application. These tiers are illustrated in the component layering diagram below.

Table of Contents

• About the Gas Jot System
  • Client Applications
• Component Layering
• Dependency Graph
• pe-* Clojure Library Suite

About the Gas Jot System

The Gas Jot system provides the ability to record and analyze your vehicle's gas usage. It enables you to collect fuel usage statistics with respect to your vehicles. In addition to being fun to use, Gas Jot also exists as a reference implementation for a set of libraries. The Gas Jot system is a client/server one. This repo, pe-gasjot-app, represents the server-side application of the Gas Jot system. It exists as a REST API endpoint for client applications of the system. The libraries are generic, and thus are not coupled to the Gas Jot system.

pe-gasjot-app makes use of the pe-* Clojure library suite, as well as pe-gasjot-rest (which uses pe-gasjot-core).

Client Applications

Currently there exists 2 client applications:

• an iOS app: GasJot-ios
• a web app: gasjot-web

Component Layering

The following diagram attempts to illustrate the layered architecture of the Gas Jot server application. The various core and rest libraries encapsulates the bulk of the application; the core logic, model and data access functionality.

Dependency Graph

The following diagram attempts to illustrates the dependencies among the main components of the Gas Jot server application.

pe-* Clojure Library Suite

The pe-* Clojure library suite is a set of Clojure libraries to aid in the development of Clojure based applications. (Each library is available on Clojars.)

• pe-core-utils: provides a set of various collection-related, date-related and other helpers functions.
• pe-jdbc-utils: provides a set of helper functions for working with JDBC.
• pe-datomic-utils: provides a set of helper functions for working with Datomic.
• pe-datomic-testutils: provides a set of helper functions to aid in unit testing Datomic-enabled functions.
• pe-user-core: provides a set of functions for modeling a generic user, leveraging PostgreSQL as a backend store.
• pe-user-testutils: a set of helper functions to aid in unit testing code that depends on the functionality of the pe-user-* libraries (pe-user-core and pe-user-rest).
• pe-apptxn-core: provides a set of functions implementing the server-side core data layer of the PEAppTransaction Logging Framework.
• pe-rest-utils: provides a set of functions for building easy-to-version hypermedia REST services (built on top of Liberator.
• pe-rest-testutils: provides a set of helper functions for unit testing web services.
• pe-user-rest: provides a set of functions encapsulating an abstraction modeling a user within a REST API and leveraging PostgreSQL.
• pe-apptxn-restsupport: provides a set of functions implementing the server-side REST layer of the PEAppTransaction Logging Framework.