REST ORM Documentation

REST ORM Documentation

Release 0.1.0 Colton Allen

March 29, 2016

Contents

1 Quick Start

3

1.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2 API Reference

5

2.1 API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

3 Project Info

7

3.1 Why REST ORM? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3.2 License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

4 Indices and tables

9

Python Module Index

11

i

ii

A RESTful object relational mapper.

REST ORM Documentation, Release 0.1.0

Contents

1

REST ORM Documentation, Release 0.1.0

2

Contents

CHAPTER 1

Quick Start

1.1 Installation

Requires Python 2.7. pip install git+git://caxiam/model-api.git

1.2 Getting Started

1.2.1 Models

Defining your model does not require any configuration beyond subclassing the AdaptedModel class. class Model(rest_orm.models.AdaptedModel):

pass However, the above is not very useful and can be extended by adding the following: * Add a field with a valid path. * Add a make_request method that returns a valid JSON string. class Model(rest_orm.models.AdaptedModel):

id = rest_orm.fields.AdaptedInteger('[key]') def make_request(self):

httpClient = CLIENT # you can use whatever you want response = httpClient.get('some/json/endpoint') return response.body You can call this model and use it in your code by executing the following: x = Model().connect() assert x.id == 1 # True You can specify an arbitrary amounts of arguments and keyword arguments on the make_request function which can then be called on the connect method. x = Model().connect(cart_id, product_id)

3

REST ORM Documentation, Release 0.1.0

1.2.2 Fields

Defining a field requires only that the path argument is satisfied. The path argument is a valid string path value or a None type value. Specifying None returns the entire data set as that fields value. The path argument behaves exactly like a normal Python attribute retrieval. You can specify keys as strings and indexes as numbers. For example, the following path is acceptable: obj = {

'key': [{ 'term': [1, 2, 3]

}] } value = rest_orm.fields.AdaptedField('[key][0][term][-1]')

The value variable would then be equal to the key key's first item's term key's last item. In other words, the path specified points to the 3 value in the object defined above it. Optional arguments:

? allow_missing: If the value cannot be found, setting this kwarg to true will raise an error. ? missing: Specifying this kwarg allows missing values to default to the value of your choice. ? validate: Accepts a callable reference and errs if the returned value fails.

1.2.3 Requests

To make a request, you can define a make_request method on your model. The make_request method can accept an arbitrary amount of arguments and keyword arguments. You can do anything you want within this method. The only rule is that you must return a valid json string as the only return value. def make_request(self, a, b=3):

# psuedo code return httpClient.post(url=url.format(a), body={'b': b}).content

1.2.4 Local or Offline Handling

You do not need to make a request to a remote endpoint in order to use this library. You may call the loads or load method on a JSON string or Python dictionary respectively. # Load a JSON string model = Model().loads('{"x": 1}') # model.x == 1

# Load a python dictionary model = Model().load({"x": 1}) # model.x == 1

4

Chapter 1. Quick Start

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download