Skip to content

Latest commit

 

History

History
354 lines (262 loc) · 10.3 KB

README.md

File metadata and controls

354 lines (262 loc) · 10.3 KB
Raw

restful_mapper

ORM for consuming RESTful APIs in C++

Build status

Introduction

restful_mapper connects business objects and Representational State Transfer (REST) web services. It implements object-relational mapping for REST web services to provide transparent proxying capabilities between a client (using restful_mapper) and a RESTful web service (that follows the conventions outlined below).

The ideas and design philosophy are directly adopted from Active Resource. However, the API and functionality differ in some areas, where it makes sense.

Design goals

  • Simple: Employ the principle of least surprise -- APIs should be clean and intuitive
  • Portable: Support old compilers -- all code is C++03 and C
  • Robust: Keep the code base small -- rely on proven and stable libraries to provide core functionality
  • Internationalized: Handle timezones and character sets automatically

RESTful web service conventions

RESTful web services come in many different forms, which are not all suitable for an ORM-style mapper such as restful_mapper. In order to be compatible with as many web services as possible, restful_mapper complies with the current best-practice for creating RESTful web services with JSON.

Specifically, restful_mapper is modelled against the Flask-Restless library, which provides full-featured RESTful web services that follow best- practice design methods.

The following basic conventions must be followed by the web service:

  • Uses standard DELETE, GET, POST and PUT requests for CRUD-operations
  • Collection of objects should use objects as the root JSON key
  • Objects in a relationship should be represented as nested JSON structures
  • If authentication is used, it must be HTTP basic authentication

For exact details on expected request and response formats, see Format of requests and responses.

Building

restful_mapper is built using CMake.

Dependencies

The following libraries are required to build restful_mapper.

  • libcurl - used for comminucating with the web service over HTTP
  • yajl - used to parse and emit JSON
  • libiconv - used to convert between character sets
  • googletest - required for tests only

Invoking the following command will download and build these libraries.

make vendor

On UNIX platforms, libcurl and libiconv are typically present on the system, and will not be built by the make command. If they are not present, they should be installed using the system package manager.

Library

After building the dependencies, invoke the following command to build restful_mapper.

make

This will install restful_mapper as a static library in the lib folder.

Tests

The test suite can be built and run using the following command.

make test

Usage

API configuration

Before making any requests to the web service, it must be configured using the following methods.

The root URL of the web service is specified using the set_url method:

Api::set_url("http://localhost:5000/api");

If the web service requires authentication, provide the username and password:

Api::set_username("admin");
Api::set_password("test");

If you are using a proxy server, it can be specified through the HTTP_PROXY environment variable or using the set_proxy method:

Api::set_proxy("http://myproxy");

Mapper configuration

This example illustrates a complete object mapping:

using namespace std;
using namespace restful_mapper;

class User;
class Alert;

class Todo : public Model<Todo>
{
public:
  Primary id;
  Field<string> task;
  Field<int> priority;
  Field<double> time;
  Field<bool> completed;
  Field<time_t> completed_on;
  Foreign<int> user_id;
  BelongsTo<User> user;
  HasOne<Alert> alert;

  virtual void map_set(Mapper &mapper) const
  {
    mapper.set("id", id);
    mapper.set("task", task);
    mapper.set("priority", priority);
    mapper.set("time", time);
    mapper.set("completed", completed);
    mapper.set("completed_on", completed_on);
    mapper.set("user_id", user_id);
    mapper.set("user", user);
    mapper.set("alert", alert);
  }

  virtual void map_get(const Mapper &mapper)
  {
    mapper.get("id", id);
    mapper.get("task", task);
    mapper.get("priority", priority);
    mapper.get("time", time);
    mapper.get("completed", completed);
    mapper.get("completed_on", completed_on);
    mapper.get("user_id", user_id);
    mapper.get("user", user);
    mapper.get("alert", alert);
  }

  virtual std::string endpoint() const
  {
    return "/todo";
  }

  virtual const Primary &primary() const
  {
    return id;
  }
};

class User: public Model<User>
{
public:
  Primary id;
  HasMany<Todo> todos;
  ...
};

An API entity is declared by creating a class that inherits from and follows the interface defined in restful_mapper::Model.

Each entity can hold a number of fields and relationships:

  • restful_mapper::Primary -- maps a primary key (integer)
  • restful_mapper::Foreign -- maps a foreign key (integer)
  • restful_mapper::Field<string> -- maps a string literal (represented in locale charset)
  • restful_mapper::Field<int> -- maps an integer value
  • restful_mapper::Field<double> -- maps a floating point value
  • restful_mapper::Field<bool> -- maps a boolean value
  • restful_mapper::Field<time_t> -- maps a datetime value (represented in the local timezone)
  • restful_mapper::HasOne<class> -- maps a one-to-one or many-to-one relationship on the referenced side
  • restful_mapper::BelongsTo<class> -- maps a one-to-one or many-to-one relationship on the foreign key side
  • restful_mapper::HasMany<class> -- maps a one-to-many relationship

The interface specified the following methods, which must be overriden:

  • virtual void restful_mapper::Model::map_set(Mapper &mapper) const
    Invoked upon saving an object to the web service.
  • virtual void restful_mapper::Model::map_get(const Mapper &mapper)
    Invoked upon requesting an object from the web service.
  • virtual std::string restful_mapper::Model::endpoint() const
    Specifies the API endpoint for this particular model. Relative to the web service root URL.
  • virtual const Primary &restful_mapper::Model::primary() const
    Specifies the primary key of the model.

Working with objects

Using the models defined above, the following operations are made available by restful_mapper.

Requesting data

// Find a single item by id
Todo t = Todo::find(2);

// Outputting fields
cout << t.task.get();

// Explicit conversions
cout << (string) t.task;

// Reload data from server
t.reload();

// Get all items in collection
Todo::Collection todos = Todo::find_all();

// Find an item in the collection by id
todos.find(4);

// Find all items in collection where task is "Do something"
todos.find("task", "Do something");

// Find the first item in collection that has been completed
todos.find_first("completed", true);

Saving data

// Create a new item
Todo new_todo;
new_todo.task = "Use restful_mapper";
new_todo.save();

// Update an existing item
Todo old_todo = Todo::find(2);
old_todo.completed = true;
old_todo.save();

// Deleting an item
old_todo.destroy();

// Create a clone with no id set (i.e. a new database object)
Todo todo_clone = old_todo.clone();
todo_clone.save();

Relationships

// Find an item including related items
User u = User::find(1);

// Get a related todo
u.todos[2].task = "Do something else";

// Delete last item
u.todos.pop_back();

// Add a new related item
Todo new_todo;
new_todo.task = "Use restful_mapper";
u.todos.push_back(new_todo);

// Save user including all changes to related todos - will delete one, update one and add one todo
u.save();

// Objects in one-to-one and many-to-one relationships are managed pointers
Todo t = Todo::find(2);
cout << t.user->email.get();

Querying

Supports the query operations specified by Flask-Restless.

// Query a single item
Query q;
q("task").like("Do someth%");
q("completed").eq(true);

Todo todo = Todo::find(q);

// Query a collection of items
Query q;
q("time").gt("1.45").lt("3.0");
q.order_by_asc(q.field("priority"));

Todo::Collection todos = Todo::find_all(q);

Exceptions

Some API errors are caught using custom exceptions.

  • Internal libcurl errors are represented as a restful_mapper::ApiError, which has adds a code() method to std::runtime_error.
  • restful_mapper::AuthenticationError is thrown when authentication fails, and has the same properties as restful_mapper::ApiError.
  • restful_mapper::BadRequestError is thrown when an error occurs on the API side, and has the same properties as restful_mapper::ApiError.
  • restful_mapper::ValidationError is thrown when one or more validation errors are thrown by the API. It has the same properties as restful_mapper::ApiError, but adds an errors() method, which returns a restful_mapper::ValidationError::FieldMap map with field names as keys and error messages as values. This map may also be accessed directly through the overloaded operator[].

Contributing

Pull requests on GitHub are very welcome! Please try to follow these simple rules:

  • Please create a topic branch for every separate change you make.
  • Make sure your patches are well tested. All tests must pass on Travis CI.
  • Update this README.md if applicable.

License

This code is copyright 2013 Logan Raarup, and is released under the revised BSD License.

For more information, see LICENSE.