Allow list of Hyperlinks

[royrusso]

Currently there is no way to create an array/list of hyperlinks, as it expects a dict. A common format for hateoas is as this: https://developer.paypal.com/docs/api/#hateoas-links

"links" : [{
"href" : "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2XR800907F429382MKEBWOSA",
"rel" : "self",
"method" : "GET"
}, {
"href" : "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2XR800907F429382MKEBWOSA/execute",
"rel" : "update",
"method" : "POST"

This format provides standard keys for every link, and is therefore easier to navigate.

[sloria]

I suppose we could support arrays of links with a many param to Hyperlinks. Pull requests welcome for this.

[Kareeeeem]

I figured I'd try and contribute and implement this, but it seems it already works as is. No work needed. I added this test code to start with and it passed.

def test_hyperlinks_field_many(ma, mockauthor):                                    
    field = ma.Hyperlinks([                                                        
        {                                                                          
            'rel': 'self',                                                         
            'method': 'GET',                                                       
            'href': url_for('author', id=mockauthor.id),                           
        },                                                                         
        {                                                                          
            'rel': 'collection',                                                   
            'method': 'GET',                                                       
            'href': url_for('authors'),                                            
        }                                                                          
    ])                                                                             

    result = field.serialize('_links', mockauthor)                                 
    assert result == [                                                             
        {                                                                                     
            'rel': 'self',                                                         
            'method': 'GET',                                                       
            'href': url_for('author', id=mockauthor.id),                           
        },                                                                         
        {                                                                          
            'rel': 'collection',                                                   
            'method': 'GET',                                                       
            'href': url_for('authors'),                                            
        }                                                                          
    ]

[sloria]

@Kareeeeem I believe the problem is that lists containing URLFor fields is not currently supported.

Here is a failing test:

def test_hyperlinks_field_recurses_into_list(ma, mockauthor):
    field = ma.Hyperlinks([
        {'rel': 'self', 'href': ma.URLFor('author', id='<id>')},
        {'rel': 'collection', 'href': ma.URLFor('authors')}
    ])
    result = field.serialize('_links', mockauthor)

    assert result == [
        {'rel': 'self', 'href': url_for('author', id=mockauthor.id)},
        {'rel': 'collection', 'href': url_for('authors')}
    ]

I believe the implementation will be simpler than I originally thought; will add this soon.