Skip to content

Commit fb97f86

Browse files
author
Victor A.M
committed
Regenerate documentation
1 parent be03739 commit fb97f86

5 files changed

+55
-44
lines changed

docs/RailsRanger.html

+14-14
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ <h4 class="name" id="RailsRanger"><span class="type-signature"></span>new RailsR
9999

100100
<dt class="tag-source">Source:</dt>
101101
<dd class="tag-source"><ul class="dummy"><li>
102-
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line11">line 11</a>
102+
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line21">line 21</a>
103103
</li></ul></dd>
104104

105105

@@ -252,7 +252,7 @@ <h4 class="name" id="create"><span class="type-signature"></span>create<span cla
252252

253253
<dt class="tag-source">Source:</dt>
254254
<dd class="tag-source"><ul class="dummy"><li>
255-
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line149">line 149</a>
255+
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line151">line 151</a>
256256
</li></ul></dd>
257257

258258

@@ -443,7 +443,7 @@ <h4 class="name" id="delete"><span class="type-signature"></span>delete<span cla
443443

444444
<dt class="tag-source">Source:</dt>
445445
<dd class="tag-source"><ul class="dummy"><li>
446-
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line87">line 87</a>
446+
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line93">line 93</a>
447447
</li></ul></dd>
448448

449449

@@ -634,7 +634,7 @@ <h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span c
634634

635635
<dt class="tag-source">Source:</dt>
636636
<dd class="tag-source"><ul class="dummy"><li>
637-
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line134">line 134</a>
637+
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line137">line 137</a>
638638
</li></ul></dd>
639639

640640

@@ -879,7 +879,7 @@ <h4 class="name" id="edit"><span class="type-signature"></span>edit<span class="
879879

880880
<dt class="tag-source">Source:</dt>
881881
<dd class="tag-source"><ul class="dummy"><li>
882-
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line196">line 196</a>
882+
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line195">line 195</a>
883883
</li></ul></dd>
884884

885885

@@ -1124,7 +1124,7 @@ <h4 class="name" id="get"><span class="type-signature"></span>get<span class="si
11241124

11251125
<dt class="tag-source">Source:</dt>
11261126
<dd class="tag-source"><ul class="dummy"><li>
1127-
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line27">line 27</a>
1127+
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line37">line 37</a>
11281128
</li></ul></dd>
11291129

11301130

@@ -1315,7 +1315,7 @@ <h4 class="name" id="list"><span class="type-signature"></span>list<span class="
13151315

13161316
<dt class="tag-source">Source:</dt>
13171317
<dd class="tag-source"><ul class="dummy"><li>
1318-
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line102">line 102</a>
1318+
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line107">line 107</a>
13191319
</li></ul></dd>
13201320

13211321

@@ -1451,7 +1451,7 @@ <h5>Returns:</h5>
14511451
<h5>Example</h5>
14521452

14531453
<pre class="prettyprint"><code>let api = new RailsRanger
1454-
api.index('users', { flag: true })
1454+
api.list('users', { flag: true })
14551455
//=> GET request to '/users?flag=true' path</code></pre>
14561456

14571457
</div>
@@ -1697,7 +1697,7 @@ <h4 class="name" id="patch"><span class="type-signature"></span>patch<span class
16971697

16981698
<dt class="tag-source">Source:</dt>
16991699
<dd class="tag-source"><ul class="dummy"><li>
1700-
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line57">line 57</a>
1700+
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line65">line 65</a>
17011701
</li></ul></dd>
17021702

17031703

@@ -1888,7 +1888,7 @@ <h4 class="name" id="post"><span class="type-signature"></span>post<span class="
18881888

18891889
<dt class="tag-source">Source:</dt>
18901890
<dd class="tag-source"><ul class="dummy"><li>
1891-
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line42">line 42</a>
1891+
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line51">line 51</a>
18921892
</li></ul></dd>
18931893

18941894

@@ -2079,7 +2079,7 @@ <h4 class="name" id="put"><span class="type-signature"></span>put<span class="si
20792079

20802080
<dt class="tag-source">Source:</dt>
20812081
<dd class="tag-source"><ul class="dummy"><li>
2082-
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line72">line 72</a>
2082+
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line79">line 79</a>
20832083
</li></ul></dd>
20842084

20852085

@@ -2270,7 +2270,7 @@ <h4 class="name" id="show"><span class="type-signature"></span>show<span class="
22702270

22712271
<dt class="tag-source">Source:</dt>
22722272
<dd class="tag-source"><ul class="dummy"><li>
2273-
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line118">line 118</a>
2273+
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line122">line 122</a>
22742274
</li></ul></dd>
22752275

22762276

@@ -2515,7 +2515,7 @@ <h4 class="name" id="update"><span class="type-signature"></span>update<span cla
25152515

25162516
<dt class="tag-source">Source:</dt>
25172517
<dd class="tag-source"><ul class="dummy"><li>
2518-
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line165">line 165</a>
2518+
<a href="rails-ranger.js.html">rails-ranger.js</a>, <a href="rails-ranger.js.html#line166">line 166</a>
25192519
</li></ul></dd>
25202520

25212521

@@ -2729,7 +2729,7 @@ <h5>Example</h5>
27292729
<br class="clear">
27302730

27312731
<footer>
2732-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sun Jun 04 2017 21:45:38 GMT-0300 (-03) using the Minami theme.
2732+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Jun 14 2017 02:09:44 GMT-0300 (-03) using the Minami theme.
27332733
</footer>
27342734

27352735
<script>prettyPrint();</script>

docs/RailsRouteBuilder.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1805,7 +1805,7 @@ <h5>Example</h5>
18051805
<br class="clear">
18061806

18071807
<footer>
1808-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sun Jun 04 2017 21:45:38 GMT-0300 (-03) using the Minami theme.
1808+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Jun 14 2017 02:09:44 GMT-0300 (-03) using the Minami theme.
18091809
</footer>
18101810

18111811
<script>prettyPrint();</script>

docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ <h2>Usage</h2><pre class="prettyprint source lang-javascript"><code>import Rails
8686
<br class="clear">
8787

8888
<footer>
89-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sun Jun 04 2017 21:45:38 GMT-0300 (-03) using the Minami theme.
89+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Jun 14 2017 02:09:44 GMT-0300 (-03) using the Minami theme.
9090
</footer>
9191

9292
<script>prettyPrint();</script>

docs/rails-ranger.js.html

+38-27
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,16 @@ <h1 class="page-title">rails-ranger.js</h1>
4343
import PathBuilder from './path-builder'
4444
import RailsRouteBuilder from './rails-route-builder'
4545

46+
const ACTION_METHODS = {
47+
index: 'get',
48+
show: 'get',
49+
new: 'get',
50+
create: 'post',
51+
edit: 'get',
52+
update: 'patch',
53+
destroy: 'delete'
54+
}
55+
4656
class RailsRanger {
4757
/**
4858
* RailsRanger object constructor
@@ -51,7 +61,7 @@ <h1 class="page-title">rails-ranger.js</h1>
5161
*/
5262
constructor (configs = {}) {
5363
this.client = Axios.create(configs)
54-
this.route = new RailsRouteBuilder()
64+
this.routeBuilder = new RailsRouteBuilder()
5565
this.pathBuilder = new PathBuilder()
5666
}
5767

@@ -66,8 +76,7 @@ <h1 class="page-title">rails-ranger.js</h1>
6676
* //=> GET request to '/users/1?flag=true' path
6777
*/
6878
get (path, params) {
69-
let request = this.pathBuilder.get(path, params)
70-
return this.client.get(request.path)
79+
return this._rawRequest({ method: 'get', path, params })
7180
}
7281

7382
/**
@@ -81,8 +90,7 @@ <h1 class="page-title">rails-ranger.js</h1>
8190
* //=> POST request to '/users/1' path with { flag: true } parameters
8291
*/
8392
post (path, params) {
84-
let request = this.pathBuilder.post(path, params)
85-
return this.client.post(request.path, request.params)
93+
return this._rawRequest({ method: 'post', path, params })
8694
}
8795

8896
/**
@@ -96,8 +104,7 @@ <h1 class="page-title">rails-ranger.js</h1>
96104
* //=> PATCH request to '/users/1' path with { flag: true } parameters
97105
*/
98106
patch (path, params) {
99-
let request = this.pathBuilder.patch(path, params)
100-
return this.client.patch(request.path, request.params)
107+
return this._rawRequest({ method: 'patch', path, params })
101108
}
102109

103110
/**
@@ -111,8 +118,7 @@ <h1 class="page-title">rails-ranger.js</h1>
111118
* //=> PUT request to '/users/1' path with { flag: true } parameters
112119
*/
113120
put (path, params) {
114-
let request = this.pathBuilder.put(path, params)
115-
return this.client.put(request.path, request.params)
121+
return this._rawRequest({ method: 'put', path, params })
116122
}
117123

118124
/**
@@ -126,8 +132,7 @@ <h1 class="page-title">rails-ranger.js</h1>
126132
* //=> DELETE request to '/users/1?flag=true' path
127133
*/
128134
delete (path, params) {
129-
let request = this.pathBuilder.delete(path, params)
130-
return this.client.delete(request.path, request.params)
135+
return this._rawRequest({ method: 'delete', path, params })
131136
}
132137

133138
/**
@@ -137,12 +142,11 @@ <h1 class="page-title">rails-ranger.js</h1>
137142
* @returns {Promise}
138143
* @example
139144
* let api = new RailsRanger
140-
* api.index('users', { flag: true })
145+
* api.list('users', { flag: true })
141146
* //=> GET request to '/users?flag=true' path
142147
*/
143148
list (resource, params) {
144-
let request = this.route.index(resource, params)
145-
return this.client.get(request.path)
149+
return this._actionRequest({ action: 'index', resource, params })
146150
}
147151

148152
/**
@@ -157,8 +161,7 @@ <h1 class="page-title">rails-ranger.js</h1>
157161
* //=> GET request to '/users/1?flag=true' path
158162
*/
159163
show (resource, params) {
160-
let request = this.route.show(resource, params)
161-
return this.client.get(request.path)
164+
return this._actionRequest({ action: 'show', resource, params })
162165
}
163166

164167
/**
@@ -173,8 +176,7 @@ <h1 class="page-title">rails-ranger.js</h1>
173176
* //=> DELETE request to '/users/1?flag=true' path
174177
*/
175178
destroy (resource, params) {
176-
let request = this.route.destroy(resource, params)
177-
return this.client.delete(request.path)
179+
return this._actionRequest({ action: 'destroy', resource, params })
178180
}
179181

180182
/**
@@ -188,8 +190,7 @@ <h1 class="page-title">rails-ranger.js</h1>
188190
* //=> POST request to '/users' path with the { email: '[email protected]', password: 123456 } parameters
189191
*/
190192
create (resource, params) {
191-
let request = this.route.create(resource, params)
192-
return this.client.post(request.path, request.params)
193+
return this._actionRequest({ action: 'create', resource, params })
193194
}
194195

195196
/**
@@ -204,8 +205,7 @@ <h1 class="page-title">rails-ranger.js</h1>
204205
* //=> PATCH request to '/users/1' path with the { email: '[email protected]' } parameters
205206
*/
206207
update (resource, params) {
207-
let request = this.route.update(resource, params)
208-
return this.client.patch(request.path, request.params)
208+
return this._actionRequest({ action: 'update', resource, params })
209209
}
210210

211211
/**
@@ -219,8 +219,7 @@ <h1 class="page-title">rails-ranger.js</h1>
219219
* //=> GET request to '/users/new?flag=true' path
220220
*/
221221
new (resource, params) {
222-
let request = this.route.new(resource, params)
223-
return this.client.get(request.path)
222+
return this._actionRequest({ action: 'new', resource, params })
224223
}
225224

226225
/**
@@ -235,8 +234,20 @@ <h1 class="page-title">rails-ranger.js</h1>
235234
* //=> GET request to '/users/1/edit?flag=true' path
236235
*/
237236
edit (resource, params) {
238-
let request = this.route.edit(resource, params)
239-
return this.client.get(request.path)
237+
return this._actionRequest({ action: 'edit', resource, params })
238+
}
239+
240+
_rawRequest ({ method, path, params }) {
241+
const request = this.pathBuilder[method](path, params)
242+
243+
return this.client[method](request.path, request.params)
244+
}
245+
246+
_actionRequest ({ action, resource, params }) {
247+
const request = this.routeBuilder[action](resource, params)
248+
const method = ACTION_METHODS[action]
249+
250+
return this.client[method](request.path, request.params)
240251
}
241252
}
242253

@@ -253,7 +264,7 @@ <h1 class="page-title">rails-ranger.js</h1>
253264
<br class="clear">
254265

255266
<footer>
256-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sun Jun 04 2017 21:45:38 GMT-0300 (-03) using the Minami theme.
267+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Jun 14 2017 02:09:44 GMT-0300 (-03) using the Minami theme.
257268
</footer>
258269

259270
<script>prettyPrint();</script>

docs/rails-route-builder.js.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ <h1 class="page-title">rails-route-builder.js</h1>
182182
<br class="clear">
183183

184184
<footer>
185-
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sun Jun 04 2017 21:45:38 GMT-0300 (-03) using the Minami theme.
185+
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed Jun 14 2017 02:09:44 GMT-0300 (-03) using the Minami theme.
186186
</footer>
187187

188188
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)