Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/logandk/restful_mapper

ORM for consuming RESTful APIs in C++
https://github.com/logandk/restful_mapper

cpp orm rest restful

Last synced: 2 days ago
JSON representation

ORM for consuming RESTful APIs in C++

Awesome Lists containing this project

README 

        
# restful_mapper #



ORM for consuming RESTful APIs in C++



[![Build status](https://secure.travis-ci.org/logandk/restful_mapper.png)](http://travis-ci.org/logandk/restful_mapper)



# 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][3].

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][4]

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][5].



# Building #



**restful\_mapper** is built using [CMake][6].



## Dependencies ##



The following libraries are required to build **restful_mapper**.



* [libcurl][7] - used for comminucating with the web service over HTTP

* [yajl][8] - used to parse and emit JSON

* [libiconv][9] - used to convert between character sets

* [googletest][10] - required for tests only



Invoking the following command will download and build these libraries.



```shell

make vendor

```



On UNIX platforms, [libcurl][7] and [libiconv][9] 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**.



```shell

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.



```shell

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:



```c++

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

```



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



```c++

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:



```c++

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

```



## Mapper configuration ##



This example illustrates a complete object mapping:



```c++

using namespace std;

using namespace restful_mapper;



class User;

class Alert;



class Todo : public Model

{

public:

  Primary id;

  Field task;

  Field priority;

  Field time;

  Field completed;

  Field completed_on;

  Foreign user_id;

  BelongsTo user;

  HasOne 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

{

public:

  Primary id;

  HasMany 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` -- maps a string literal (represented in locale charset)

* `restful_mapper::Field` -- maps an integer value

* `restful_mapper::Field` -- maps a floating point value

* `restful_mapper::Field` -- maps a boolean value

* `restful_mapper::Field` -- maps a datetime value (represented in the local timezone)

* `restful_mapper::HasOne` -- maps a one-to-one or many-to-one relationship on the referenced side

* `restful_mapper::BelongsTo` -- maps a one-to-one or many-to-one relationship on the foreign key side

* `restful_mapper::HasMany` -- 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 ###



```c++

// 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 ###



```c++

// 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 ###



```c++

// 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][11] by [Flask-Restless][4].



```c++

// 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][7] 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][1] 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][2].

* Update this [`README.md`](http://github.com/logandk/restful_mapper/blob/master/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`](http://github.com/logandk/restful_mapper/blob/master/LICENSE).



[1]: http://github.com/logandk/restful_mapper

[2]: http://travis-ci.org/logandk/restful_mapper

[3]: https://github.com/rails/activeresource

[4]: https://github.com/jfinkels/flask-restless

[5]: https://flask-restless.readthedocs.org/en/latest/requestformat.html

[6]: http://www.cmake.org

[7]: http://curl.haxx.se/libcurl

[8]: http://lloyd.github.io/yajl

[9]: http://www.gnu.org/software/libiconv

[10]: https://code.google.com/p/googletest

[11]: https://flask-restless.readthedocs.org/en/latest/searchformat.html#queryformat