paper-api-client/test.js at master · tybenz/paper-api-client · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
var assert = require( 'assert' );
var apiClient = require( './' );

describe( 'API Client', function() {
    describe( 'urlHelper', function() {
        it( 'class mixin: should return the correct URLs for a given endpoint name', function( done ) {
            var Client = function( host, protocol ) {
                this.setHost( host );
                this.setProtocol( protocol );
                this.setDefaultParams({
                    api_key: 'ApiKey'
                });
            }

            Client.prototype.endPoints = {
                index: '/v1/items',
                item: 'v1/items/:id'
            };

            apiClient.mixin( Client );

            var client = new Client( 'host.com', 'https:' );

            var indexUrl = client.url( 'index' );
            assert( indexUrl === 'https://host.com/v1/items?api_key=ApiKey' );

            var itemUrl = client.url( 'item', undefined, 1 );
            assert( itemUrl === 'https://host.com/v1/items/1?api_key=ApiKey' );

            done();
        });

        it( 'object literal: should return the correct URLs for a given endpoint name', function( done ) {
            var client = apiClient.extend({
                host: 'host.com',
                protocol: 'https:',
                defaultParams: {
                    api_key: 'ApiKey'
                },
                endPoints: {
                    index: '/v1/items',
                    item: 'v1/items/:id'
                },
                getIndex: function( cb ) {
                    return request( this.url( 'index' ), cb );
                }
            });

            var indexUrl = client.url( 'index' );
            assert( indexUrl === 'https://host.com/v1/items?api_key=ApiKey' );

            var itemUrl = client.url( 'item', undefined, 1 );
            assert( itemUrl === 'https://host.com/v1/items/1?api_key=ApiKey' );

            done();
        });

        it( 'should return undefined if endpoint name is invalid', function() {
            var client = apiClient.extend({
                host: 'host.com',
                protocol: 'https:',
                defaultParams: {
                    api_key: 'ApiKey'
                },
                endPoints: {
                    index: '/v1/items',
                    item: 'v1/items/:id'
                },
                getIndex: function( cb ) {
                    return request( this.url( 'index' ), cb );
                }
            });

            assert( client.url( 'foobar' ) === undefined );
        });

        it( 'shouldn\'t modify default params', function() {
            var client = apiClient.extend({
                host: 'host.com',
                protocol: 'https:',
                defaultParams: {
                    api_key: 'ApiKey'
                },
                endPoints: {
                    index: '/v1/items'
                }
            });

            var defaults = client.defaultParams;
            var url = client.url( 'index', { new_param: 'true' } );
            assert( defaults.new_param === undefined );
            assert( url === 'https://host.com/v1/items?api_key=ApiKey&new_param=true' );
        });

        it( 'should throw an error when the args are incorrect', function() {
            var client = apiClient.extend({
                host: 'host.com',
                protocol: 'https:',
                defaultParams: {
                    api_key: 'ApiKey'
                },
                endPoints: {
                    index: '/v1/items',
                    item: 'v1/items/:id'
                },
                getIndex: function( cb ) {
                    return request( this.url( 'index' ), cb );
                }
            });

            try {
                // item requires 1 param
                // should be client.url( 'item', {}, id )
                var url = client.url( 'item' );
            } catch ( err ) {
                assert( err );
            }

            try {
                // must pass only strings or numbers as path params
                var url = client.url( 'item', {}, { foo: 'bar' } );
            } catch( err ) {
                assert( err );
            }
        });
    });
});