ballast 2.2.4 → 2.2.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +6 -1
- data/.travis-gemfile +2 -2
- data/.travis.yml +5 -3
- data/.yardopts +1 -1
- data/CHANGELOG.md +9 -0
- data/Gemfile +1 -1
- data/LICENSE.md +21 -0
- data/README.md +22 -17
- data/Rakefile +1 -1
- data/ballast.gemspec +1 -1
- data/{doc → docs}/Ballast.html +19 -21
- data/docs/Ballast/AjaxResponse.html +1470 -0
- data/{doc → docs}/Ballast/Concerns.html +3 -3
- data/{doc → docs}/Ballast/Concerns/AjaxHandling.html +33 -38
- data/{doc → docs}/Ballast/Concerns/Common.html +45 -52
- data/{doc → docs}/Ballast/Concerns/ErrorsHandling.html +13 -14
- data/docs/Ballast/Concerns/JSONApi.html +127 -0
- data/docs/Ballast/Concerns/JSONApi/PaginationHandling.html +617 -0
- data/docs/Ballast/Concerns/JSONApi/RequestHandling.html +775 -0
- data/docs/Ballast/Concerns/JSONApi/ResponseHandling.html +917 -0
- data/{doc → docs}/Ballast/Concerns/View.html +35 -42
- data/{doc → docs}/Ballast/Configuration.html +19 -22
- data/{doc → docs}/Ballast/Emoji.html +1 -1
- data/{doc → docs}/Ballast/Emoji/Character.html +15 -18
- data/docs/Ballast/Emoji/Utils.html +794 -0
- data/{doc → docs}/Ballast/Errors.html +1 -1
- data/{doc → docs}/Ballast/Errors/Base.html +16 -18
- data/{doc → docs}/Ballast/Errors/Failure.html +1 -1
- data/{doc → docs}/Ballast/Errors/InvalidDomain.html +1 -1
- data/{doc → docs}/Ballast/Errors/ValidationFailure.html +1 -1
- data/{doc → docs}/Ballast/Middlewares.html +1 -1
- data/{doc → docs}/Ballast/Middlewares/DefaultHost.html +16 -18
- data/docs/Ballast/RequestDomainMatcher.html +917 -0
- data/docs/Ballast/Service.html +1513 -0
- data/docs/Ballast/Service/Response.html +1270 -0
- data/{doc → docs}/Ballast/Version.html +5 -9
- data/{doc → docs}/_index.html +45 -1
- data/docs/class_list.html +58 -0
- data/{doc → docs}/css/common.css +0 -0
- data/{doc → docs}/css/full_list.css +0 -0
- data/{doc → docs}/css/style.css +0 -0
- data/{doc → docs}/file.README.html +7 -5
- data/{doc → docs}/file_list.html +0 -0
- data/{doc → docs}/frames.html +0 -0
- data/{doc → docs}/index.html +7 -5
- data/{doc → docs}/js/app.js +0 -0
- data/{doc → docs}/js/full_list.js +0 -0
- data/{doc → docs}/js/jquery.js +0 -0
- data/{doc → docs}/method_list.html +150 -36
- data/docs/top-level-namespace.html +149 -0
- data/lib/ballast.rb +1 -1
- data/lib/ballast/ajax_response.rb +1 -1
- data/lib/ballast/concerns/ajax_handling.rb +1 -1
- data/lib/ballast/concerns/common.rb +1 -1
- data/lib/ballast/concerns/errors_handling.rb +1 -1
- data/lib/ballast/concerns/json_api/pagination_handling.rb +83 -0
- data/lib/ballast/concerns/json_api/request_handling.rb +235 -0
- data/lib/ballast/concerns/json_api/response_handling.rb +70 -0
- data/lib/ballast/concerns/view.rb +1 -1
- data/lib/ballast/configuration.rb +1 -1
- data/lib/ballast/emoji.rb +1 -1
- data/lib/ballast/errors.rb +1 -1
- data/lib/ballast/middlewares/default_host.rb +1 -1
- data/lib/ballast/request_domain_matcher.rb +1 -1
- data/lib/ballast/service.rb +1 -1
- data/lib/ballast/version.rb +2 -2
- data/spec/ballast/ajax_response_spec.rb +1 -1
- data/spec/ballast/concerns/ajax_handling_spec.rb +1 -1
- data/spec/ballast/concerns/common_spec.rb +1 -1
- data/spec/ballast/concerns/errors_handling_spec.rb +1 -1
- data/spec/ballast/concerns/view_spec.rb +1 -1
- data/spec/ballast/configuration_spec.rb +1 -1
- data/spec/ballast/errors_spec.rb +1 -1
- data/spec/ballast/middlewares/default_host_spec.rb +1 -1
- data/spec/ballast/request_domain_matcher_spec.rb +1 -1
- data/spec/ballast_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +47 -39
- data/doc/Ballast/AjaxResponse.html +0 -1478
- data/doc/Ballast/Emoji/Utils.html +0 -799
- data/doc/Ballast/RequestDomainMatcher.html +0 -923
- data/doc/Ballast/Service.html +0 -1522
- data/doc/Ballast/Service/Response.html +0 -1278
- data/doc/class_list.html +0 -58
- data/doc/top-level-namespace.html +0 -112
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: be4130d52bc302a4a285496372d9f97013f965ce
|
4
|
+
data.tar.gz: c32e3058c89aa67db7b4a7c243055723e0ff7331
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5e3dd63bc758af8a83ee4da09469d29685ff0ba05a477e8cbb3f4b2796ee23a58b49d0960b9ac335e1af259cfb072ee4307f3e232b2da56c324e8dbe299f7ede
|
7
|
+
data.tar.gz: 02b9b39ef9b91cc10318feba4f02eee9fc085ee068783365abfb78d838c8fa35a650f1997db851beca71ffe99534213e2fdebf055273072d1b17bcf2e76956e2
|
data/.rubocop.yml
CHANGED
@@ -1,3 +1,8 @@
|
|
1
|
+
#
|
2
|
+
# This file is part of the ballast gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
|
3
|
+
# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
|
4
|
+
#
|
5
|
+
|
1
6
|
AllCops:
|
2
7
|
TargetRubyVersion: 2.3
|
3
8
|
Include:
|
@@ -77,4 +82,4 @@ StringReplacement:
|
|
77
82
|
Enabled: false
|
78
83
|
|
79
84
|
WordArray:
|
80
|
-
Enabled: false
|
85
|
+
Enabled: false
|
data/.travis-gemfile
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
#
|
2
2
|
# This file is part of the ballast gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
|
3
|
-
# Licensed under the MIT license, which can be found at
|
3
|
+
# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
|
4
4
|
#
|
5
5
|
|
6
6
|
source "http://rubygems.org"
|
@@ -10,5 +10,5 @@ gemspec
|
|
10
10
|
# Testing gems
|
11
11
|
gem "rspec", "~> 3.4"
|
12
12
|
gem "rake", "~> 11.0"
|
13
|
-
gem "simplecov", "~> 0.
|
13
|
+
gem "simplecov", "~> 0.11"
|
14
14
|
gem "coveralls", "~> 0.8", require: false
|
data/.travis.yml
CHANGED
@@ -1,3 +1,8 @@
|
|
1
|
+
#
|
2
|
+
# This file is part of the ballast gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
|
3
|
+
# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
|
4
|
+
#
|
5
|
+
|
1
6
|
language: ruby
|
2
7
|
rvm:
|
3
8
|
- 2.3.0
|
@@ -5,6 +10,3 @@ script: bundle exec rake spec:ci
|
|
5
10
|
gemfile: .travis-gemfile
|
6
11
|
notifications:
|
7
12
|
email: false
|
8
|
-
addons:
|
9
|
-
code_climate:
|
10
|
-
repo_token: f1f849a73d0b5cee836daa54676bd10662e87e8e726b396f212a99a77797ab4c
|
data/.yardopts
CHANGED
@@ -1 +1 @@
|
|
1
|
-
-m markdown
|
1
|
+
-o ./docs -m markdown
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,12 @@
|
|
1
|
+
### 2018-06-18 / 2.2.5
|
2
|
+
|
3
|
+
* chore: End of development notice.
|
4
|
+
* Updated license links and badges.
|
5
|
+
* Updated docs location.
|
6
|
+
* Updated docs.
|
7
|
+
* Added missing copyright notes.
|
8
|
+
* Updated Travis Gemfile.
|
9
|
+
|
1
10
|
### 2.2.4 / 2016-03-29
|
2
11
|
|
3
12
|
* Update dependencies.
|
data/Gemfile
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
#
|
2
2
|
# This file is part of the ballast gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
|
3
|
-
# Licensed under the MIT license, which can be found at
|
3
|
+
# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
|
4
4
|
#
|
5
5
|
|
6
6
|
source "http://rubygems.org"
|
data/LICENSE.md
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
MIT License
|
2
|
+
|
3
|
+
Copyright (C) 2018 and above Shogun <shogun@cowtech.it>
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
13
|
+
copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
21
|
+
SOFTWARE.
|
data/README.md
CHANGED
@@ -1,16 +1,17 @@
|
|
1
1
|
# ballast
|
2
2
|
|
3
|
-
[![Gem Version](https://
|
4
|
-
[![Dependency Status](https://
|
5
|
-
[![Build Status](https://
|
6
|
-
[![
|
7
|
-
[![Coverage Status](https://coveralls.io/repos/ShogunPanda/ballast/badge.png)](https://coveralls.io/r/ShogunPanda/ballast)
|
3
|
+
[![Gem Version](https://img.shields.io/gem/v/ballast.svg)](https://rubygems.org/gems/ballast)
|
4
|
+
[![Dependency Status](https://img.shields.io/gemnasium/ShogunPanda/ballast.svg)](https://gemnasium.com/ShogunPanda/ballast)
|
5
|
+
[![Build Status](https://img.shields.io/travis/ShogunPanda/ballast.svg)](https://travis-ci.org/ShogunPanda/ballast)
|
6
|
+
[![Coverage Status](https://img.shields.io/coveralls/github/ShogunPanda/ballast.svg)](https://coveralls.io/github/ShogunPanda/ballast)
|
8
7
|
|
9
|
-
|
8
|
+
## END OF DEVELOPMENT NOTICE
|
9
|
+
|
10
|
+
# This gem has been discontinued.
|
10
11
|
|
11
|
-
|
12
|
+
A collection of base utilities for web frameworks.
|
12
13
|
|
13
|
-
|
14
|
+
https://sw.cowtech.it/ballast
|
14
15
|
|
15
16
|
# Description
|
16
17
|
|
@@ -22,18 +23,22 @@ The second issue is handling AJAX actions in a short way. To solve this, ballast
|
|
22
23
|
|
23
24
|
Finally, minor concerns are provided to scope CSS and handling errors.
|
24
25
|
|
26
|
+
## API Documentation
|
27
|
+
|
28
|
+
The API documentation can be found [here](https://sw.cowtech.it/ballast/docs).
|
29
|
+
|
25
30
|
## Contributing to ballast
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
31
|
+
|
32
|
+
- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
|
33
|
+
- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
|
34
|
+
- Fork the project.
|
35
|
+
- Start a feature/bugfix branch.
|
36
|
+
- Commit and push until you are happy with your contribution.
|
37
|
+
- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
|
38
|
+
- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
|
34
39
|
|
35
40
|
## Copyright
|
36
41
|
|
37
42
|
Copyright (C) 2013 and above Shogun (shogun@cowtech.it).
|
38
43
|
|
39
|
-
Licensed under the MIT license, which can be found at
|
44
|
+
Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
|
data/Rakefile
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
#
|
2
2
|
# This file is part of the ballast gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
|
3
|
-
# Licensed under the MIT license, which can be found at
|
3
|
+
# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
|
4
4
|
#
|
5
5
|
|
6
6
|
require "bundler/gem_tasks"
|
data/ballast.gemspec
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
#
|
2
2
|
# This file is part of the ballast gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
|
3
|
-
# Licensed under the MIT license, which can be found at
|
3
|
+
# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
|
4
4
|
#
|
5
5
|
|
6
6
|
require File.expand_path("../lib/ballast/version", __FILE__)
|
data/{doc → docs}/Ballast.html
RENAMED
@@ -80,7 +80,7 @@
|
|
80
80
|
|
81
81
|
<dt class="r1 last">Defined in:</dt>
|
82
82
|
<dd class="r1 last">lib/ballast.rb<span class="defines">,<br />
|
83
|
-
lib/ballast/emoji.rb,<br /> lib/ballast/errors.rb,<br /> lib/ballast/
|
83
|
+
lib/ballast/emoji.rb,<br /> lib/ballast/errors.rb,<br /> lib/ballast/version.rb,<br /> lib/ballast/service.rb,<br /> lib/ballast/configuration.rb,<br /> lib/ballast/concerns/view.rb,<br /> lib/ballast/ajax_response.rb,<br /> lib/ballast/concerns/common.rb,<br /> lib/ballast/request_domain_matcher.rb,<br /> lib/ballast/concerns/ajax_handling.rb,<br /> lib/ballast/middlewares/default_host.rb,<br /> lib/ballast/concerns/errors_handling.rb,<br /> lib/ballast/concerns/json_api/request_handling.rb,<br /> lib/ballast/concerns/json_api/response_handling.rb,<br /> lib/ballast/concerns/json_api/pagination_handling.rb</span>
|
84
84
|
</dd>
|
85
85
|
|
86
86
|
</dl>
|
@@ -256,19 +256,18 @@ Licensed under the MIT license, which can be found at http://www.opensource.org/
|
|
256
256
|
<td>
|
257
257
|
<pre class="code"><span class="info file"># File 'lib/ballast.rb', line 38</span>
|
258
258
|
|
259
|
-
<span class='
|
260
|
-
<span class='
|
261
|
-
<span class='
|
262
|
-
<span class='
|
263
|
-
<span class='
|
264
|
-
<span class='
|
265
|
-
<span class='
|
266
|
-
<span class='
|
267
|
-
<span class='
|
268
|
-
<span class='
|
269
|
-
<span class='
|
270
|
-
<span class='
|
271
|
-
</pre>
|
259
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_in_em_thread'>in_em_thread</span><span class='lparen'>(</span><span class='id identifier rubyid_start_reactor'>start_reactor</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
260
|
+
<span class='kw'>if</span> <span class='const'>EM</span><span class='period'>.</span><span class='id identifier rubyid_reactor_running?'>reactor_running?</span>
|
261
|
+
<span class='id identifier rubyid_run_in_thread'>run_in_thread</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
262
|
+
<span class='kw'>elsif</span> <span class='id identifier rubyid_start_reactor'>start_reactor</span>
|
263
|
+
<span class='const'>EM</span><span class='period'>.</span><span class='id identifier rubyid_synchrony'>synchrony</span> <span class='kw'>do</span>
|
264
|
+
<span class='const'>Ballast</span><span class='period'>.</span><span class='id identifier rubyid_in_em_thread'>in_em_thread</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
265
|
+
<span class='const'>EM</span><span class='period'>.</span><span class='id identifier rubyid_stop'>stop</span>
|
266
|
+
<span class='kw'>end</span>
|
267
|
+
<span class='kw'>else</span>
|
268
|
+
<span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span>
|
269
|
+
<span class='kw'>end</span>
|
270
|
+
<span class='kw'>end</span></pre>
|
272
271
|
</td>
|
273
272
|
</tr>
|
274
273
|
</table>
|
@@ -308,12 +307,11 @@ Licensed under the MIT license, which can be found at http://www.opensource.org/
|
|
308
307
|
<td>
|
309
308
|
<pre class="code"><span class="info file"># File 'lib/ballast.rb', line 52</span>
|
310
309
|
|
311
|
-
<span class='
|
312
|
-
<span class='
|
313
|
-
<span class='
|
314
|
-
<span class='
|
315
|
-
<span class='
|
316
|
-
</pre>
|
310
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_run_in_thread'>run_in_thread</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
311
|
+
<span class='const'>EM</span><span class='op'>::</span><span class='const'>Synchrony</span><span class='period'>.</span><span class='id identifier rubyid_defer'>defer</span> <span class='kw'>do</span>
|
312
|
+
<span class='const'>Fiber</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_block'>block</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_resume'>resume</span>
|
313
|
+
<span class='kw'>end</span>
|
314
|
+
<span class='kw'>end</span></pre>
|
317
315
|
</td>
|
318
316
|
</tr>
|
319
317
|
</table>
|
@@ -324,7 +322,7 @@ Licensed under the MIT license, which can be found at http://www.opensource.org/
|
|
324
322
|
</div>
|
325
323
|
|
326
324
|
<div id="footer">
|
327
|
-
Generated on
|
325
|
+
Generated on Thu Aug 18 15:49:48 2016 by
|
328
326
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
329
327
|
0.8.7.6 (ruby-2.3.0).
|
330
328
|
</div>
|
@@ -0,0 +1,1470 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
<title>
|
7
|
+
Class: Ballast::AjaxResponse
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.7.6
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
19
|
+
relpath = '../';
|
20
|
+
framesUrl = "../frames.html#!Ballast/AjaxResponse.html";
|
21
|
+
</script>
|
22
|
+
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
25
|
+
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
27
|
+
|
28
|
+
|
29
|
+
</head>
|
30
|
+
<body>
|
31
|
+
<div id="header">
|
32
|
+
<div id="menu">
|
33
|
+
|
34
|
+
<a href="../_index.html">Index (A)</a> »
|
35
|
+
<span class='title'><span class='object_link'><a href="../Ballast.html" title="Ballast (module)">Ballast</a></span></span>
|
36
|
+
»
|
37
|
+
<span class="title">AjaxResponse</span>
|
38
|
+
|
39
|
+
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
|
+
</div>
|
42
|
+
|
43
|
+
<div id="search">
|
44
|
+
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
46
|
+
href="../class_list.html">
|
47
|
+
Class List
|
48
|
+
</a>
|
49
|
+
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
51
|
+
href="../method_list.html">
|
52
|
+
Method List
|
53
|
+
</a>
|
54
|
+
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
56
|
+
href="../file_list.html">
|
57
|
+
File List
|
58
|
+
</a>
|
59
|
+
|
60
|
+
</div>
|
61
|
+
<div class="clear"></div>
|
62
|
+
</div>
|
63
|
+
|
64
|
+
<iframe id="search_frame"></iframe>
|
65
|
+
|
66
|
+
<div id="content"><h1>Class: Ballast::AjaxResponse
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
</h1>
|
71
|
+
|
72
|
+
<dl class="box">
|
73
|
+
|
74
|
+
<dt class="r1">Inherits:</dt>
|
75
|
+
<dd class="r1">
|
76
|
+
<span class="inheritName">Object</span>
|
77
|
+
|
78
|
+
<ul class="fullTree">
|
79
|
+
<li>Object</li>
|
80
|
+
|
81
|
+
<li class="next">Ballast::AjaxResponse</li>
|
82
|
+
|
83
|
+
</ul>
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
85
|
+
|
86
|
+
</dd>
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
<dt class="r2 last">Defined in:</dt>
|
97
|
+
<dd class="r2 last">lib/ballast/ajax_response.rb</dd>
|
98
|
+
|
99
|
+
</dl>
|
100
|
+
<div class="clear"></div>
|
101
|
+
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
103
|
+
<div class="discussion">
|
104
|
+
<p>An AJAX response.</p>
|
105
|
+
|
106
|
+
|
107
|
+
</div>
|
108
|
+
</div>
|
109
|
+
<div class="tags">
|
110
|
+
|
111
|
+
|
112
|
+
</div>
|
113
|
+
|
114
|
+
|
115
|
+
|
116
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
117
|
+
<ul class="summary">
|
118
|
+
|
119
|
+
<li class="public ">
|
120
|
+
<span class="summary_signature">
|
121
|
+
|
122
|
+
<a href="#data-instance_method" title="#data (instance method)">- (Object|Hash|NilClass) <strong>data</strong> </a>
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
</span>
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
<span class="summary_desc"><div class='inline'><p>The data to send to the client.</p>
|
140
|
+
</div></span>
|
141
|
+
|
142
|
+
</li>
|
143
|
+
|
144
|
+
|
145
|
+
<li class="public ">
|
146
|
+
<span class="summary_signature">
|
147
|
+
|
148
|
+
<a href="#error-instance_method" title="#error (instance method)">- (Object|NilClass) <strong>error</strong> </a>
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
</span>
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
<span class="summary_desc"><div class='inline'><p>A error message.</p>
|
166
|
+
</div></span>
|
167
|
+
|
168
|
+
</li>
|
169
|
+
|
170
|
+
|
171
|
+
<li class="public ">
|
172
|
+
<span class="summary_signature">
|
173
|
+
|
174
|
+
<a href="#status-instance_method" title="#status (instance method)">- (Symbol|Fixnum) <strong>status</strong> </a>
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
</span>
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
<span class="summary_desc"><div class='inline'><p>The HTTP status of the response.</p>
|
192
|
+
</div></span>
|
193
|
+
|
194
|
+
</li>
|
195
|
+
|
196
|
+
|
197
|
+
<li class="public ">
|
198
|
+
<span class="summary_signature">
|
199
|
+
|
200
|
+
<a href="#transport-instance_method" title="#transport (instance method)">- (Object|NilClass) <strong>transport</strong> </a>
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
</span>
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
<span class="summary_desc"><div class='inline'><p>The transport to use for sending.</p>
|
218
|
+
</div></span>
|
219
|
+
|
220
|
+
</li>
|
221
|
+
|
222
|
+
|
223
|
+
</ul>
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
<h2>
|
230
|
+
Instance Method Summary
|
231
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
232
|
+
</h2>
|
233
|
+
|
234
|
+
<ul class="summary">
|
235
|
+
|
236
|
+
<li class="public ">
|
237
|
+
<span class="summary_signature">
|
238
|
+
|
239
|
+
<a href="#as_json-instance_method" title="#as_json (instance method)">- (Hash) <strong>as_json</strong>(options = {}) </a>
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
</span>
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
<span class="summary_desc"><div class='inline'><p>Returns a JSON representation of the response.</p>
|
254
|
+
</div></span>
|
255
|
+
|
256
|
+
</li>
|
257
|
+
|
258
|
+
|
259
|
+
<li class="public ">
|
260
|
+
<span class="summary_signature">
|
261
|
+
|
262
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (AjaxResponse) <strong>initialize</strong>(status: :ok, data: {}, error: nil, transport: nil) </a>
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
</span>
|
267
|
+
|
268
|
+
|
269
|
+
<span class="note title constructor">constructor</span>
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
<span class="summary_desc"><div class='inline'><p>Creates an AJAX response.</p>
|
279
|
+
</div></span>
|
280
|
+
|
281
|
+
</li>
|
282
|
+
|
283
|
+
|
284
|
+
<li class="public ">
|
285
|
+
<span class="summary_signature">
|
286
|
+
|
287
|
+
<a href="#numeric_status-instance_method" title="#numeric_status (instance method)">- (Fixnum) <strong>numeric_status</strong> </a>
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
</span>
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
|
297
|
+
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
<span class="summary_desc"><div class='inline'><p>Returns the status as a number.</p>
|
302
|
+
</div></span>
|
303
|
+
|
304
|
+
</li>
|
305
|
+
|
306
|
+
|
307
|
+
<li class="public ">
|
308
|
+
<span class="summary_signature">
|
309
|
+
|
310
|
+
<a href="#reply-instance_method" title="#reply (instance method)">- (Object) <strong>reply</strong>(format: :json, pretty_json: false) </a>
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
</span>
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
<span class="summary_desc"><div class='inline'><p>Sends the response using the transport.</p>
|
325
|
+
</div></span>
|
326
|
+
|
327
|
+
</li>
|
328
|
+
|
329
|
+
|
330
|
+
</ul>
|
331
|
+
|
332
|
+
|
333
|
+
<div id="constructor_details" class="method_details_list">
|
334
|
+
<h2>Constructor Details</h2>
|
335
|
+
|
336
|
+
<div class="method_details first">
|
337
|
+
<h3 class="signature first" id="initialize-instance_method">
|
338
|
+
|
339
|
+
- (<tt><span class='object_link'><a href="" title="Ballast::AjaxResponse (class)">AjaxResponse</a></span></tt>) <strong>initialize</strong>(status: :ok, data: {}, error: nil, transport: nil)
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
</h3><div class="docstring">
|
346
|
+
<div class="discussion">
|
347
|
+
<p>Creates an AJAX response.</p>
|
348
|
+
|
349
|
+
|
350
|
+
</div>
|
351
|
+
</div>
|
352
|
+
<div class="tags">
|
353
|
+
<p class="tag_title">Parameters:</p>
|
354
|
+
<ul class="param">
|
355
|
+
|
356
|
+
<li>
|
357
|
+
|
358
|
+
<span class='name'>status</span>
|
359
|
+
|
360
|
+
|
361
|
+
<span class='type'>(<tt>Symbol|Fixnum</tt>)</span>
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
—
|
366
|
+
<div class='inline'><p>The HTTP status of the response.</p>
|
367
|
+
</div>
|
368
|
+
|
369
|
+
</li>
|
370
|
+
|
371
|
+
<li>
|
372
|
+
|
373
|
+
<span class='name'>data</span>
|
374
|
+
|
375
|
+
|
376
|
+
<span class='type'>(<tt>Object|Hash|NilClass</tt>)</span>
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
—
|
381
|
+
<div class='inline'><p>Additional data to append to the response.</p>
|
382
|
+
</div>
|
383
|
+
|
384
|
+
</li>
|
385
|
+
|
386
|
+
<li>
|
387
|
+
|
388
|
+
<span class='name'>error</span>
|
389
|
+
|
390
|
+
|
391
|
+
<span class='type'>(<tt>Object|NilClass</tt>)</span>
|
392
|
+
|
393
|
+
|
394
|
+
|
395
|
+
—
|
396
|
+
<div class='inline'><p>A error to append to the response.</p>
|
397
|
+
</div>
|
398
|
+
|
399
|
+
</li>
|
400
|
+
|
401
|
+
<li>
|
402
|
+
|
403
|
+
<span class='name'>transport</span>
|
404
|
+
|
405
|
+
|
406
|
+
<span class='type'>(<tt>Object|NilClass</tt>)</span>
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
—
|
411
|
+
<div class='inline'><p>The transport to use for sending. Must respond to <code>render</code>, <code>params</code>, <code>request.format</code> and <code>performed?</code>.</p>
|
412
|
+
</div>
|
413
|
+
|
414
|
+
</li>
|
415
|
+
|
416
|
+
</ul>
|
417
|
+
|
418
|
+
|
419
|
+
</div><table class="source_code">
|
420
|
+
<tr>
|
421
|
+
<td>
|
422
|
+
<pre class="lines">
|
423
|
+
|
424
|
+
|
425
|
+
26
|
426
|
+
27
|
427
|
+
28
|
428
|
+
29
|
429
|
+
30
|
430
|
+
31</pre>
|
431
|
+
</td>
|
432
|
+
<td>
|
433
|
+
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 26</span>
|
434
|
+
|
435
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='symbol'>:ok</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>transport:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
436
|
+
<span class='ivar'>@status</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span>
|
437
|
+
<span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
|
438
|
+
<span class='ivar'>@error</span> <span class='op'>=</span> <span class='id identifier rubyid_error'>error</span>
|
439
|
+
<span class='ivar'>@transport</span> <span class='op'>=</span> <span class='id identifier rubyid_transport'>transport</span>
|
440
|
+
<span class='kw'>end</span></pre>
|
441
|
+
</td>
|
442
|
+
</tr>
|
443
|
+
</table>
|
444
|
+
</div>
|
445
|
+
|
446
|
+
</div>
|
447
|
+
|
448
|
+
<div id="instance_attr_details" class="attr_details">
|
449
|
+
<h2>Instance Attribute Details</h2>
|
450
|
+
|
451
|
+
|
452
|
+
<span id="data=-instance_method"></span>
|
453
|
+
<div class="method_details first">
|
454
|
+
<h3 class="signature first" id="data-instance_method">
|
455
|
+
|
456
|
+
- (<tt>Object|Hash|NilClass</tt>) <strong>data</strong>
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
|
462
|
+
</h3><div class="docstring">
|
463
|
+
<div class="discussion">
|
464
|
+
<p>Returns The data to send to the client.</p>
|
465
|
+
|
466
|
+
|
467
|
+
</div>
|
468
|
+
</div>
|
469
|
+
<div class="tags">
|
470
|
+
|
471
|
+
<p class="tag_title">Returns:</p>
|
472
|
+
<ul class="return">
|
473
|
+
|
474
|
+
<li>
|
475
|
+
|
476
|
+
|
477
|
+
<span class='type'>(<tt>Object|Hash|NilClass</tt>)</span>
|
478
|
+
|
479
|
+
|
480
|
+
|
481
|
+
—
|
482
|
+
<div class='inline'><p>The data to send to the client.</p>
|
483
|
+
</div>
|
484
|
+
|
485
|
+
</li>
|
486
|
+
|
487
|
+
</ul>
|
488
|
+
|
489
|
+
</div><table class="source_code">
|
490
|
+
<tr>
|
491
|
+
<td>
|
492
|
+
<pre class="lines">
|
493
|
+
|
494
|
+
|
495
|
+
17
|
496
|
+
18
|
497
|
+
19
|
498
|
+
20
|
499
|
+
21
|
500
|
+
22
|
501
|
+
23
|
502
|
+
24
|
503
|
+
25
|
504
|
+
26
|
505
|
+
27
|
506
|
+
28
|
507
|
+
29
|
508
|
+
30
|
509
|
+
31
|
510
|
+
32
|
511
|
+
33
|
512
|
+
34
|
513
|
+
35
|
514
|
+
36
|
515
|
+
37
|
516
|
+
38
|
517
|
+
39
|
518
|
+
40
|
519
|
+
41
|
520
|
+
42
|
521
|
+
43
|
522
|
+
44
|
523
|
+
45
|
524
|
+
46
|
525
|
+
47
|
526
|
+
48
|
527
|
+
49
|
528
|
+
50
|
529
|
+
51
|
530
|
+
52
|
531
|
+
53
|
532
|
+
54
|
533
|
+
55
|
534
|
+
56
|
535
|
+
57
|
536
|
+
58
|
537
|
+
59
|
538
|
+
60
|
539
|
+
61
|
540
|
+
62
|
541
|
+
63
|
542
|
+
64
|
543
|
+
65
|
544
|
+
66
|
545
|
+
67
|
546
|
+
68
|
547
|
+
69
|
548
|
+
70
|
549
|
+
71
|
550
|
+
72
|
551
|
+
73
|
552
|
+
74
|
553
|
+
75
|
554
|
+
76
|
555
|
+
77
|
556
|
+
78
|
557
|
+
79
|
558
|
+
80
|
559
|
+
81
|
560
|
+
82
|
561
|
+
83
|
562
|
+
84
|
563
|
+
85
|
564
|
+
86</pre>
|
565
|
+
</td>
|
566
|
+
<td>
|
567
|
+
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 17</span>
|
568
|
+
|
569
|
+
<span class='kw'>class</span> <span class='const'>AjaxResponse</span>
|
570
|
+
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:status</span><span class='comma'>,</span> <span class='symbol'>:data</span><span class='comma'>,</span> <span class='symbol'>:error</span><span class='comma'>,</span> <span class='symbol'>:transport</span>
|
571
|
+
|
572
|
+
<span class='comment'># Creates an AJAX response.
|
573
|
+
</span> <span class='comment'>#
|
574
|
+
</span> <span class='comment'># @param status [Symbol|Fixnum] The HTTP status of the response.
|
575
|
+
</span> <span class='comment'># @param data [Object|Hash|NilClass] Additional data to append to the response.
|
576
|
+
</span> <span class='comment'># @param error [Object|NilClass] A error to append to the response.
|
577
|
+
</span> <span class='comment'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.
|
578
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='symbol'>:ok</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>transport:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
579
|
+
<span class='ivar'>@status</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span>
|
580
|
+
<span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
|
581
|
+
<span class='ivar'>@error</span> <span class='op'>=</span> <span class='id identifier rubyid_error'>error</span>
|
582
|
+
<span class='ivar'>@transport</span> <span class='op'>=</span> <span class='id identifier rubyid_transport'>transport</span>
|
583
|
+
<span class='kw'>end</span>
|
584
|
+
|
585
|
+
<span class='comment'># Returns the status as a number.
|
586
|
+
</span> <span class='comment'>#
|
587
|
+
</span> <span class='comment'># @return [Fixnum] The status as a number.
|
588
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span>
|
589
|
+
<span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Fixnum</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Utils</span><span class='period'>.</span><span class='id identifier rubyid_status_code'>status_code</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span>
|
590
|
+
<span class='kw'>end</span>
|
591
|
+
|
592
|
+
<span class='comment'># Returns a JSON representation of the response.
|
593
|
+
</span> <span class='comment'>#
|
594
|
+
</span> <span class='comment'># @param options [Hash] The options to use for serializing. Currently only `original_status` is supported.
|
595
|
+
</span> <span class='comment'># @return [Hash] A JSON representation of the response.
|
596
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
597
|
+
<span class='lbrace'>{</span>
|
598
|
+
<span class='label'>status:</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:original_status</span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span><span class='comma'>,</span>
|
599
|
+
<span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span>
|
600
|
+
<span class='label'>error:</span> <span class='id identifier rubyid_error'>error</span>
|
601
|
+
<span class='rbrace'>}</span>
|
602
|
+
<span class='kw'>end</span>
|
603
|
+
|
604
|
+
<span class='comment'># Sends the response using the transport.
|
605
|
+
</span> <span class='comment'>#
|
606
|
+
</span> <span class='comment'># @param format [Symbol] The content type of the response.
|
607
|
+
</span> <span class='comment'># @param pretty_json [Boolean] If JSON response must be pretty formatted.
|
608
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_reply'>reply</span><span class='lparen'>(</span><span class='label'>format:</span> <span class='symbol'>:json</span><span class='comma'>,</span> <span class='label'>pretty_json:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
609
|
+
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_performed?'>performed?</span>
|
610
|
+
|
611
|
+
<span class='id identifier rubyid_format'>format</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='id identifier rubyid_content_type'>content_type</span> <span class='op'>=</span> <span class='id identifier rubyid_format_reply'>format_reply</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
612
|
+
<span class='id identifier rubyid_content'>content</span> <span class='op'>=</span> <span class='id identifier rubyid_prepare_content'>prepare_content</span>
|
613
|
+
<span class='id identifier rubyid_content'>content</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_pretty_json'>pretty_json</span> <span class='op'>?</span> <span class='const'>Oj</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='const'>ActiveSupport</span><span class='op'>::</span><span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='lbracket'>[</span><span class='symbol'>:json</span><span class='comma'>,</span> <span class='symbol'>:jsonp</span><span class='comma'>,</span> <span class='symbol'>:text</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
614
|
+
|
615
|
+
<span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>=></span> <span class='id identifier rubyid_content'>content</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span><span class='comma'>,</span> <span class='label'>callback:</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='label'>content_type:</span> <span class='id identifier rubyid_content_type'>content_type</span><span class='rparen'>)</span>
|
616
|
+
<span class='kw'>end</span>
|
617
|
+
|
618
|
+
<span class='id identifier rubyid_private'>private</span>
|
619
|
+
|
620
|
+
<span class='comment'># :nodoc:
|
621
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_format_reply'>format_reply</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
622
|
+
<span class='id identifier rubyid_format'>format</span> <span class='op'>=</span> <span class='id identifier rubyid_choose_format'>choose_format</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
623
|
+
<span class='id identifier rubyid_callback'>callback</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:jsonp</span><span class='comma'>,</span> <span class='symbol'>:pretty_jsonp</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='lparen'>(</span><span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:callback</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>jsonp</span><span class='embexpr_beg'>#{</span><span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='op'>:</span> <span class='kw'>nil</span>
|
624
|
+
<span class='id identifier rubyid_content_type'>content_type</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>==</span> <span class='symbol'>:text</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='kw'>nil</span>
|
625
|
+
|
626
|
+
<span class='lbracket'>[</span><span class='id identifier rubyid_format'>format</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='id identifier rubyid_content_type'>content_type</span><span class='rbracket'>]</span>
|
627
|
+
<span class='kw'>end</span>
|
628
|
+
|
629
|
+
<span class='comment'># :nodoc:
|
630
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_choose_format'>choose_format</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
631
|
+
<span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>||</span> <span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_format'>format</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>json</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='op'>||</span> <span class='symbol'>:html</span>
|
632
|
+
<span class='kw'>end</span>
|
633
|
+
|
634
|
+
<span class='comment'># :nodoc:
|
635
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_prepare_content'>prepare_content</span>
|
636
|
+
<span class='lbrace'>{</span><span class='label'>status:</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Utils</span><span class='period'>.</span><span class='id identifier rubyid_status_code'>status_code</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='id identifier rubyid_error'>error</span><span class='rbrace'>}</span>
|
637
|
+
<span class='kw'>end</span>
|
638
|
+
<span class='kw'>end</span></pre>
|
639
|
+
</td>
|
640
|
+
</tr>
|
641
|
+
</table>
|
642
|
+
</div>
|
643
|
+
|
644
|
+
|
645
|
+
<span id="error=-instance_method"></span>
|
646
|
+
<div class="method_details ">
|
647
|
+
<h3 class="signature " id="error-instance_method">
|
648
|
+
|
649
|
+
- (<tt>Object|NilClass</tt>) <strong>error</strong>
|
650
|
+
|
651
|
+
|
652
|
+
|
653
|
+
|
654
|
+
|
655
|
+
</h3><div class="docstring">
|
656
|
+
<div class="discussion">
|
657
|
+
<p>Returns A error message.</p>
|
658
|
+
|
659
|
+
|
660
|
+
</div>
|
661
|
+
</div>
|
662
|
+
<div class="tags">
|
663
|
+
|
664
|
+
<p class="tag_title">Returns:</p>
|
665
|
+
<ul class="return">
|
666
|
+
|
667
|
+
<li>
|
668
|
+
|
669
|
+
|
670
|
+
<span class='type'>(<tt>Object|NilClass</tt>)</span>
|
671
|
+
|
672
|
+
|
673
|
+
|
674
|
+
—
|
675
|
+
<div class='inline'><p>A error message.</p>
|
676
|
+
</div>
|
677
|
+
|
678
|
+
</li>
|
679
|
+
|
680
|
+
</ul>
|
681
|
+
|
682
|
+
</div><table class="source_code">
|
683
|
+
<tr>
|
684
|
+
<td>
|
685
|
+
<pre class="lines">
|
686
|
+
|
687
|
+
|
688
|
+
17
|
689
|
+
18
|
690
|
+
19
|
691
|
+
20
|
692
|
+
21
|
693
|
+
22
|
694
|
+
23
|
695
|
+
24
|
696
|
+
25
|
697
|
+
26
|
698
|
+
27
|
699
|
+
28
|
700
|
+
29
|
701
|
+
30
|
702
|
+
31
|
703
|
+
32
|
704
|
+
33
|
705
|
+
34
|
706
|
+
35
|
707
|
+
36
|
708
|
+
37
|
709
|
+
38
|
710
|
+
39
|
711
|
+
40
|
712
|
+
41
|
713
|
+
42
|
714
|
+
43
|
715
|
+
44
|
716
|
+
45
|
717
|
+
46
|
718
|
+
47
|
719
|
+
48
|
720
|
+
49
|
721
|
+
50
|
722
|
+
51
|
723
|
+
52
|
724
|
+
53
|
725
|
+
54
|
726
|
+
55
|
727
|
+
56
|
728
|
+
57
|
729
|
+
58
|
730
|
+
59
|
731
|
+
60
|
732
|
+
61
|
733
|
+
62
|
734
|
+
63
|
735
|
+
64
|
736
|
+
65
|
737
|
+
66
|
738
|
+
67
|
739
|
+
68
|
740
|
+
69
|
741
|
+
70
|
742
|
+
71
|
743
|
+
72
|
744
|
+
73
|
745
|
+
74
|
746
|
+
75
|
747
|
+
76
|
748
|
+
77
|
749
|
+
78
|
750
|
+
79
|
751
|
+
80
|
752
|
+
81
|
753
|
+
82
|
754
|
+
83
|
755
|
+
84
|
756
|
+
85
|
757
|
+
86</pre>
|
758
|
+
</td>
|
759
|
+
<td>
|
760
|
+
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 17</span>
|
761
|
+
|
762
|
+
<span class='kw'>class</span> <span class='const'>AjaxResponse</span>
|
763
|
+
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:status</span><span class='comma'>,</span> <span class='symbol'>:data</span><span class='comma'>,</span> <span class='symbol'>:error</span><span class='comma'>,</span> <span class='symbol'>:transport</span>
|
764
|
+
|
765
|
+
<span class='comment'># Creates an AJAX response.
|
766
|
+
</span> <span class='comment'>#
|
767
|
+
</span> <span class='comment'># @param status [Symbol|Fixnum] The HTTP status of the response.
|
768
|
+
</span> <span class='comment'># @param data [Object|Hash|NilClass] Additional data to append to the response.
|
769
|
+
</span> <span class='comment'># @param error [Object|NilClass] A error to append to the response.
|
770
|
+
</span> <span class='comment'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.
|
771
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='symbol'>:ok</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>transport:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
772
|
+
<span class='ivar'>@status</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span>
|
773
|
+
<span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
|
774
|
+
<span class='ivar'>@error</span> <span class='op'>=</span> <span class='id identifier rubyid_error'>error</span>
|
775
|
+
<span class='ivar'>@transport</span> <span class='op'>=</span> <span class='id identifier rubyid_transport'>transport</span>
|
776
|
+
<span class='kw'>end</span>
|
777
|
+
|
778
|
+
<span class='comment'># Returns the status as a number.
|
779
|
+
</span> <span class='comment'>#
|
780
|
+
</span> <span class='comment'># @return [Fixnum] The status as a number.
|
781
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span>
|
782
|
+
<span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Fixnum</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Utils</span><span class='period'>.</span><span class='id identifier rubyid_status_code'>status_code</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span>
|
783
|
+
<span class='kw'>end</span>
|
784
|
+
|
785
|
+
<span class='comment'># Returns a JSON representation of the response.
|
786
|
+
</span> <span class='comment'>#
|
787
|
+
</span> <span class='comment'># @param options [Hash] The options to use for serializing. Currently only `original_status` is supported.
|
788
|
+
</span> <span class='comment'># @return [Hash] A JSON representation of the response.
|
789
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
790
|
+
<span class='lbrace'>{</span>
|
791
|
+
<span class='label'>status:</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:original_status</span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span><span class='comma'>,</span>
|
792
|
+
<span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span>
|
793
|
+
<span class='label'>error:</span> <span class='id identifier rubyid_error'>error</span>
|
794
|
+
<span class='rbrace'>}</span>
|
795
|
+
<span class='kw'>end</span>
|
796
|
+
|
797
|
+
<span class='comment'># Sends the response using the transport.
|
798
|
+
</span> <span class='comment'>#
|
799
|
+
</span> <span class='comment'># @param format [Symbol] The content type of the response.
|
800
|
+
</span> <span class='comment'># @param pretty_json [Boolean] If JSON response must be pretty formatted.
|
801
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_reply'>reply</span><span class='lparen'>(</span><span class='label'>format:</span> <span class='symbol'>:json</span><span class='comma'>,</span> <span class='label'>pretty_json:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
802
|
+
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_performed?'>performed?</span>
|
803
|
+
|
804
|
+
<span class='id identifier rubyid_format'>format</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='id identifier rubyid_content_type'>content_type</span> <span class='op'>=</span> <span class='id identifier rubyid_format_reply'>format_reply</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
805
|
+
<span class='id identifier rubyid_content'>content</span> <span class='op'>=</span> <span class='id identifier rubyid_prepare_content'>prepare_content</span>
|
806
|
+
<span class='id identifier rubyid_content'>content</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_pretty_json'>pretty_json</span> <span class='op'>?</span> <span class='const'>Oj</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='const'>ActiveSupport</span><span class='op'>::</span><span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='lbracket'>[</span><span class='symbol'>:json</span><span class='comma'>,</span> <span class='symbol'>:jsonp</span><span class='comma'>,</span> <span class='symbol'>:text</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
807
|
+
|
808
|
+
<span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>=></span> <span class='id identifier rubyid_content'>content</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span><span class='comma'>,</span> <span class='label'>callback:</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='label'>content_type:</span> <span class='id identifier rubyid_content_type'>content_type</span><span class='rparen'>)</span>
|
809
|
+
<span class='kw'>end</span>
|
810
|
+
|
811
|
+
<span class='id identifier rubyid_private'>private</span>
|
812
|
+
|
813
|
+
<span class='comment'># :nodoc:
|
814
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_format_reply'>format_reply</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
815
|
+
<span class='id identifier rubyid_format'>format</span> <span class='op'>=</span> <span class='id identifier rubyid_choose_format'>choose_format</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
816
|
+
<span class='id identifier rubyid_callback'>callback</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:jsonp</span><span class='comma'>,</span> <span class='symbol'>:pretty_jsonp</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='lparen'>(</span><span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:callback</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>jsonp</span><span class='embexpr_beg'>#{</span><span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='op'>:</span> <span class='kw'>nil</span>
|
817
|
+
<span class='id identifier rubyid_content_type'>content_type</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>==</span> <span class='symbol'>:text</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='kw'>nil</span>
|
818
|
+
|
819
|
+
<span class='lbracket'>[</span><span class='id identifier rubyid_format'>format</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='id identifier rubyid_content_type'>content_type</span><span class='rbracket'>]</span>
|
820
|
+
<span class='kw'>end</span>
|
821
|
+
|
822
|
+
<span class='comment'># :nodoc:
|
823
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_choose_format'>choose_format</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
824
|
+
<span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>||</span> <span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_format'>format</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>json</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='op'>||</span> <span class='symbol'>:html</span>
|
825
|
+
<span class='kw'>end</span>
|
826
|
+
|
827
|
+
<span class='comment'># :nodoc:
|
828
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_prepare_content'>prepare_content</span>
|
829
|
+
<span class='lbrace'>{</span><span class='label'>status:</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Utils</span><span class='period'>.</span><span class='id identifier rubyid_status_code'>status_code</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='id identifier rubyid_error'>error</span><span class='rbrace'>}</span>
|
830
|
+
<span class='kw'>end</span>
|
831
|
+
<span class='kw'>end</span></pre>
|
832
|
+
</td>
|
833
|
+
</tr>
|
834
|
+
</table>
|
835
|
+
</div>
|
836
|
+
|
837
|
+
|
838
|
+
<span id="status=-instance_method"></span>
|
839
|
+
<div class="method_details ">
|
840
|
+
<h3 class="signature " id="status-instance_method">
|
841
|
+
|
842
|
+
- (<tt>Symbol|Fixnum</tt>) <strong>status</strong>
|
843
|
+
|
844
|
+
|
845
|
+
|
846
|
+
|
847
|
+
|
848
|
+
</h3><div class="docstring">
|
849
|
+
<div class="discussion">
|
850
|
+
<p>Returns The HTTP status of the response.</p>
|
851
|
+
|
852
|
+
|
853
|
+
</div>
|
854
|
+
</div>
|
855
|
+
<div class="tags">
|
856
|
+
|
857
|
+
<p class="tag_title">Returns:</p>
|
858
|
+
<ul class="return">
|
859
|
+
|
860
|
+
<li>
|
861
|
+
|
862
|
+
|
863
|
+
<span class='type'>(<tt>Symbol|Fixnum</tt>)</span>
|
864
|
+
|
865
|
+
|
866
|
+
|
867
|
+
—
|
868
|
+
<div class='inline'><p>The HTTP status of the response.</p>
|
869
|
+
</div>
|
870
|
+
|
871
|
+
</li>
|
872
|
+
|
873
|
+
</ul>
|
874
|
+
|
875
|
+
</div><table class="source_code">
|
876
|
+
<tr>
|
877
|
+
<td>
|
878
|
+
<pre class="lines">
|
879
|
+
|
880
|
+
|
881
|
+
17
|
882
|
+
18
|
883
|
+
19
|
884
|
+
20
|
885
|
+
21
|
886
|
+
22
|
887
|
+
23
|
888
|
+
24
|
889
|
+
25
|
890
|
+
26
|
891
|
+
27
|
892
|
+
28
|
893
|
+
29
|
894
|
+
30
|
895
|
+
31
|
896
|
+
32
|
897
|
+
33
|
898
|
+
34
|
899
|
+
35
|
900
|
+
36
|
901
|
+
37
|
902
|
+
38
|
903
|
+
39
|
904
|
+
40
|
905
|
+
41
|
906
|
+
42
|
907
|
+
43
|
908
|
+
44
|
909
|
+
45
|
910
|
+
46
|
911
|
+
47
|
912
|
+
48
|
913
|
+
49
|
914
|
+
50
|
915
|
+
51
|
916
|
+
52
|
917
|
+
53
|
918
|
+
54
|
919
|
+
55
|
920
|
+
56
|
921
|
+
57
|
922
|
+
58
|
923
|
+
59
|
924
|
+
60
|
925
|
+
61
|
926
|
+
62
|
927
|
+
63
|
928
|
+
64
|
929
|
+
65
|
930
|
+
66
|
931
|
+
67
|
932
|
+
68
|
933
|
+
69
|
934
|
+
70
|
935
|
+
71
|
936
|
+
72
|
937
|
+
73
|
938
|
+
74
|
939
|
+
75
|
940
|
+
76
|
941
|
+
77
|
942
|
+
78
|
943
|
+
79
|
944
|
+
80
|
945
|
+
81
|
946
|
+
82
|
947
|
+
83
|
948
|
+
84
|
949
|
+
85
|
950
|
+
86</pre>
|
951
|
+
</td>
|
952
|
+
<td>
|
953
|
+
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 17</span>
|
954
|
+
|
955
|
+
<span class='kw'>class</span> <span class='const'>AjaxResponse</span>
|
956
|
+
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:status</span><span class='comma'>,</span> <span class='symbol'>:data</span><span class='comma'>,</span> <span class='symbol'>:error</span><span class='comma'>,</span> <span class='symbol'>:transport</span>
|
957
|
+
|
958
|
+
<span class='comment'># Creates an AJAX response.
|
959
|
+
</span> <span class='comment'>#
|
960
|
+
</span> <span class='comment'># @param status [Symbol|Fixnum] The HTTP status of the response.
|
961
|
+
</span> <span class='comment'># @param data [Object|Hash|NilClass] Additional data to append to the response.
|
962
|
+
</span> <span class='comment'># @param error [Object|NilClass] A error to append to the response.
|
963
|
+
</span> <span class='comment'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.
|
964
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='symbol'>:ok</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>transport:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
965
|
+
<span class='ivar'>@status</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span>
|
966
|
+
<span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
|
967
|
+
<span class='ivar'>@error</span> <span class='op'>=</span> <span class='id identifier rubyid_error'>error</span>
|
968
|
+
<span class='ivar'>@transport</span> <span class='op'>=</span> <span class='id identifier rubyid_transport'>transport</span>
|
969
|
+
<span class='kw'>end</span>
|
970
|
+
|
971
|
+
<span class='comment'># Returns the status as a number.
|
972
|
+
</span> <span class='comment'>#
|
973
|
+
</span> <span class='comment'># @return [Fixnum] The status as a number.
|
974
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span>
|
975
|
+
<span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Fixnum</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Utils</span><span class='period'>.</span><span class='id identifier rubyid_status_code'>status_code</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span>
|
976
|
+
<span class='kw'>end</span>
|
977
|
+
|
978
|
+
<span class='comment'># Returns a JSON representation of the response.
|
979
|
+
</span> <span class='comment'>#
|
980
|
+
</span> <span class='comment'># @param options [Hash] The options to use for serializing. Currently only `original_status` is supported.
|
981
|
+
</span> <span class='comment'># @return [Hash] A JSON representation of the response.
|
982
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
983
|
+
<span class='lbrace'>{</span>
|
984
|
+
<span class='label'>status:</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:original_status</span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span><span class='comma'>,</span>
|
985
|
+
<span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span>
|
986
|
+
<span class='label'>error:</span> <span class='id identifier rubyid_error'>error</span>
|
987
|
+
<span class='rbrace'>}</span>
|
988
|
+
<span class='kw'>end</span>
|
989
|
+
|
990
|
+
<span class='comment'># Sends the response using the transport.
|
991
|
+
</span> <span class='comment'>#
|
992
|
+
</span> <span class='comment'># @param format [Symbol] The content type of the response.
|
993
|
+
</span> <span class='comment'># @param pretty_json [Boolean] If JSON response must be pretty formatted.
|
994
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_reply'>reply</span><span class='lparen'>(</span><span class='label'>format:</span> <span class='symbol'>:json</span><span class='comma'>,</span> <span class='label'>pretty_json:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
995
|
+
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_performed?'>performed?</span>
|
996
|
+
|
997
|
+
<span class='id identifier rubyid_format'>format</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='id identifier rubyid_content_type'>content_type</span> <span class='op'>=</span> <span class='id identifier rubyid_format_reply'>format_reply</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
998
|
+
<span class='id identifier rubyid_content'>content</span> <span class='op'>=</span> <span class='id identifier rubyid_prepare_content'>prepare_content</span>
|
999
|
+
<span class='id identifier rubyid_content'>content</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_pretty_json'>pretty_json</span> <span class='op'>?</span> <span class='const'>Oj</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='const'>ActiveSupport</span><span class='op'>::</span><span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='lbracket'>[</span><span class='symbol'>:json</span><span class='comma'>,</span> <span class='symbol'>:jsonp</span><span class='comma'>,</span> <span class='symbol'>:text</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
1000
|
+
|
1001
|
+
<span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>=></span> <span class='id identifier rubyid_content'>content</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span><span class='comma'>,</span> <span class='label'>callback:</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='label'>content_type:</span> <span class='id identifier rubyid_content_type'>content_type</span><span class='rparen'>)</span>
|
1002
|
+
<span class='kw'>end</span>
|
1003
|
+
|
1004
|
+
<span class='id identifier rubyid_private'>private</span>
|
1005
|
+
|
1006
|
+
<span class='comment'># :nodoc:
|
1007
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_format_reply'>format_reply</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
1008
|
+
<span class='id identifier rubyid_format'>format</span> <span class='op'>=</span> <span class='id identifier rubyid_choose_format'>choose_format</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
1009
|
+
<span class='id identifier rubyid_callback'>callback</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:jsonp</span><span class='comma'>,</span> <span class='symbol'>:pretty_jsonp</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='lparen'>(</span><span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:callback</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>jsonp</span><span class='embexpr_beg'>#{</span><span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='op'>:</span> <span class='kw'>nil</span>
|
1010
|
+
<span class='id identifier rubyid_content_type'>content_type</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>==</span> <span class='symbol'>:text</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='kw'>nil</span>
|
1011
|
+
|
1012
|
+
<span class='lbracket'>[</span><span class='id identifier rubyid_format'>format</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='id identifier rubyid_content_type'>content_type</span><span class='rbracket'>]</span>
|
1013
|
+
<span class='kw'>end</span>
|
1014
|
+
|
1015
|
+
<span class='comment'># :nodoc:
|
1016
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_choose_format'>choose_format</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
1017
|
+
<span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>||</span> <span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_format'>format</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>json</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='op'>||</span> <span class='symbol'>:html</span>
|
1018
|
+
<span class='kw'>end</span>
|
1019
|
+
|
1020
|
+
<span class='comment'># :nodoc:
|
1021
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_prepare_content'>prepare_content</span>
|
1022
|
+
<span class='lbrace'>{</span><span class='label'>status:</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Utils</span><span class='period'>.</span><span class='id identifier rubyid_status_code'>status_code</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='id identifier rubyid_error'>error</span><span class='rbrace'>}</span>
|
1023
|
+
<span class='kw'>end</span>
|
1024
|
+
<span class='kw'>end</span></pre>
|
1025
|
+
</td>
|
1026
|
+
</tr>
|
1027
|
+
</table>
|
1028
|
+
</div>
|
1029
|
+
|
1030
|
+
|
1031
|
+
<span id="transport=-instance_method"></span>
|
1032
|
+
<div class="method_details ">
|
1033
|
+
<h3 class="signature " id="transport-instance_method">
|
1034
|
+
|
1035
|
+
- (<tt>Object|NilClass</tt>) <strong>transport</strong>
|
1036
|
+
|
1037
|
+
|
1038
|
+
|
1039
|
+
|
1040
|
+
|
1041
|
+
</h3><div class="docstring">
|
1042
|
+
<div class="discussion">
|
1043
|
+
<p>Returns The transport to use for sending. Must respond to <code>render</code>, <code>params</code>, <code>request.format</code> and <code>performed?</code>.</p>
|
1044
|
+
|
1045
|
+
|
1046
|
+
</div>
|
1047
|
+
</div>
|
1048
|
+
<div class="tags">
|
1049
|
+
|
1050
|
+
<p class="tag_title">Returns:</p>
|
1051
|
+
<ul class="return">
|
1052
|
+
|
1053
|
+
<li>
|
1054
|
+
|
1055
|
+
|
1056
|
+
<span class='type'>(<tt>Object|NilClass</tt>)</span>
|
1057
|
+
|
1058
|
+
|
1059
|
+
|
1060
|
+
—
|
1061
|
+
<div class='inline'><p>The transport to use for sending. Must respond to <code>render</code>, <code>params</code>, <code>request.format</code> and <code>performed?</code>.</p>
|
1062
|
+
</div>
|
1063
|
+
|
1064
|
+
</li>
|
1065
|
+
|
1066
|
+
</ul>
|
1067
|
+
|
1068
|
+
</div><table class="source_code">
|
1069
|
+
<tr>
|
1070
|
+
<td>
|
1071
|
+
<pre class="lines">
|
1072
|
+
|
1073
|
+
|
1074
|
+
17
|
1075
|
+
18
|
1076
|
+
19
|
1077
|
+
20
|
1078
|
+
21
|
1079
|
+
22
|
1080
|
+
23
|
1081
|
+
24
|
1082
|
+
25
|
1083
|
+
26
|
1084
|
+
27
|
1085
|
+
28
|
1086
|
+
29
|
1087
|
+
30
|
1088
|
+
31
|
1089
|
+
32
|
1090
|
+
33
|
1091
|
+
34
|
1092
|
+
35
|
1093
|
+
36
|
1094
|
+
37
|
1095
|
+
38
|
1096
|
+
39
|
1097
|
+
40
|
1098
|
+
41
|
1099
|
+
42
|
1100
|
+
43
|
1101
|
+
44
|
1102
|
+
45
|
1103
|
+
46
|
1104
|
+
47
|
1105
|
+
48
|
1106
|
+
49
|
1107
|
+
50
|
1108
|
+
51
|
1109
|
+
52
|
1110
|
+
53
|
1111
|
+
54
|
1112
|
+
55
|
1113
|
+
56
|
1114
|
+
57
|
1115
|
+
58
|
1116
|
+
59
|
1117
|
+
60
|
1118
|
+
61
|
1119
|
+
62
|
1120
|
+
63
|
1121
|
+
64
|
1122
|
+
65
|
1123
|
+
66
|
1124
|
+
67
|
1125
|
+
68
|
1126
|
+
69
|
1127
|
+
70
|
1128
|
+
71
|
1129
|
+
72
|
1130
|
+
73
|
1131
|
+
74
|
1132
|
+
75
|
1133
|
+
76
|
1134
|
+
77
|
1135
|
+
78
|
1136
|
+
79
|
1137
|
+
80
|
1138
|
+
81
|
1139
|
+
82
|
1140
|
+
83
|
1141
|
+
84
|
1142
|
+
85
|
1143
|
+
86</pre>
|
1144
|
+
</td>
|
1145
|
+
<td>
|
1146
|
+
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 17</span>
|
1147
|
+
|
1148
|
+
<span class='kw'>class</span> <span class='const'>AjaxResponse</span>
|
1149
|
+
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:status</span><span class='comma'>,</span> <span class='symbol'>:data</span><span class='comma'>,</span> <span class='symbol'>:error</span><span class='comma'>,</span> <span class='symbol'>:transport</span>
|
1150
|
+
|
1151
|
+
<span class='comment'># Creates an AJAX response.
|
1152
|
+
</span> <span class='comment'>#
|
1153
|
+
</span> <span class='comment'># @param status [Symbol|Fixnum] The HTTP status of the response.
|
1154
|
+
</span> <span class='comment'># @param data [Object|Hash|NilClass] Additional data to append to the response.
|
1155
|
+
</span> <span class='comment'># @param error [Object|NilClass] A error to append to the response.
|
1156
|
+
</span> <span class='comment'># @param transport [Object|NilClass] The transport to use for sending. Must respond to `render`, `params`, `request.format` and `performed?`.
|
1157
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>status:</span> <span class='symbol'>:ok</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>transport:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1158
|
+
<span class='ivar'>@status</span> <span class='op'>=</span> <span class='id identifier rubyid_status'>status</span>
|
1159
|
+
<span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
|
1160
|
+
<span class='ivar'>@error</span> <span class='op'>=</span> <span class='id identifier rubyid_error'>error</span>
|
1161
|
+
<span class='ivar'>@transport</span> <span class='op'>=</span> <span class='id identifier rubyid_transport'>transport</span>
|
1162
|
+
<span class='kw'>end</span>
|
1163
|
+
|
1164
|
+
<span class='comment'># Returns the status as a number.
|
1165
|
+
</span> <span class='comment'>#
|
1166
|
+
</span> <span class='comment'># @return [Fixnum] The status as a number.
|
1167
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span>
|
1168
|
+
<span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Fixnum</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Utils</span><span class='period'>.</span><span class='id identifier rubyid_status_code'>status_code</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span>
|
1169
|
+
<span class='kw'>end</span>
|
1170
|
+
|
1171
|
+
<span class='comment'># Returns a JSON representation of the response.
|
1172
|
+
</span> <span class='comment'>#
|
1173
|
+
</span> <span class='comment'># @param options [Hash] The options to use for serializing. Currently only `original_status` is supported.
|
1174
|
+
</span> <span class='comment'># @return [Hash] A JSON representation of the response.
|
1175
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1176
|
+
<span class='lbrace'>{</span>
|
1177
|
+
<span class='label'>status:</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:original_status</span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span><span class='comma'>,</span>
|
1178
|
+
<span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span>
|
1179
|
+
<span class='label'>error:</span> <span class='id identifier rubyid_error'>error</span>
|
1180
|
+
<span class='rbrace'>}</span>
|
1181
|
+
<span class='kw'>end</span>
|
1182
|
+
|
1183
|
+
<span class='comment'># Sends the response using the transport.
|
1184
|
+
</span> <span class='comment'>#
|
1185
|
+
</span> <span class='comment'># @param format [Symbol] The content type of the response.
|
1186
|
+
</span> <span class='comment'># @param pretty_json [Boolean] If JSON response must be pretty formatted.
|
1187
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_reply'>reply</span><span class='lparen'>(</span><span class='label'>format:</span> <span class='symbol'>:json</span><span class='comma'>,</span> <span class='label'>pretty_json:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
1188
|
+
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_performed?'>performed?</span>
|
1189
|
+
|
1190
|
+
<span class='id identifier rubyid_format'>format</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='id identifier rubyid_content_type'>content_type</span> <span class='op'>=</span> <span class='id identifier rubyid_format_reply'>format_reply</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
1191
|
+
<span class='id identifier rubyid_content'>content</span> <span class='op'>=</span> <span class='id identifier rubyid_prepare_content'>prepare_content</span>
|
1192
|
+
<span class='id identifier rubyid_content'>content</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_pretty_json'>pretty_json</span> <span class='op'>?</span> <span class='const'>Oj</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='const'>ActiveSupport</span><span class='op'>::</span><span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='lbracket'>[</span><span class='symbol'>:json</span><span class='comma'>,</span> <span class='symbol'>:jsonp</span><span class='comma'>,</span> <span class='symbol'>:text</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
1193
|
+
|
1194
|
+
<span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>=></span> <span class='id identifier rubyid_content'>content</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span><span class='comma'>,</span> <span class='label'>callback:</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='label'>content_type:</span> <span class='id identifier rubyid_content_type'>content_type</span><span class='rparen'>)</span>
|
1195
|
+
<span class='kw'>end</span>
|
1196
|
+
|
1197
|
+
<span class='id identifier rubyid_private'>private</span>
|
1198
|
+
|
1199
|
+
<span class='comment'># :nodoc:
|
1200
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_format_reply'>format_reply</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
1201
|
+
<span class='id identifier rubyid_format'>format</span> <span class='op'>=</span> <span class='id identifier rubyid_choose_format'>choose_format</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
1202
|
+
<span class='id identifier rubyid_callback'>callback</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='symbol'>:jsonp</span><span class='comma'>,</span> <span class='symbol'>:pretty_jsonp</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='lparen'>(</span><span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:callback</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>jsonp</span><span class='embexpr_beg'>#{</span><span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='op'>:</span> <span class='kw'>nil</span>
|
1203
|
+
<span class='id identifier rubyid_content_type'>content_type</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>==</span> <span class='symbol'>:text</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>"</span></span> <span class='op'>:</span> <span class='kw'>nil</span>
|
1204
|
+
|
1205
|
+
<span class='lbracket'>[</span><span class='id identifier rubyid_format'>format</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='id identifier rubyid_content_type'>content_type</span><span class='rbracket'>]</span>
|
1206
|
+
<span class='kw'>end</span>
|
1207
|
+
|
1208
|
+
<span class='comment'># :nodoc:
|
1209
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_choose_format'>choose_format</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
1210
|
+
<span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>||</span> <span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_format'>format</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>json</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='op'>||</span> <span class='symbol'>:html</span>
|
1211
|
+
<span class='kw'>end</span>
|
1212
|
+
|
1213
|
+
<span class='comment'># :nodoc:
|
1214
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_prepare_content'>prepare_content</span>
|
1215
|
+
<span class='lbrace'>{</span><span class='label'>status:</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Utils</span><span class='period'>.</span><span class='id identifier rubyid_status_code'>status_code</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>error:</span> <span class='id identifier rubyid_error'>error</span><span class='rbrace'>}</span>
|
1216
|
+
<span class='kw'>end</span>
|
1217
|
+
<span class='kw'>end</span></pre>
|
1218
|
+
</td>
|
1219
|
+
</tr>
|
1220
|
+
</table>
|
1221
|
+
</div>
|
1222
|
+
|
1223
|
+
</div>
|
1224
|
+
|
1225
|
+
|
1226
|
+
<div id="instance_method_details" class="method_details_list">
|
1227
|
+
<h2>Instance Method Details</h2>
|
1228
|
+
|
1229
|
+
|
1230
|
+
<div class="method_details first">
|
1231
|
+
<h3 class="signature first" id="as_json-instance_method">
|
1232
|
+
|
1233
|
+
- (<tt>Hash</tt>) <strong>as_json</strong>(options = {})
|
1234
|
+
|
1235
|
+
|
1236
|
+
|
1237
|
+
|
1238
|
+
|
1239
|
+
</h3><div class="docstring">
|
1240
|
+
<div class="discussion">
|
1241
|
+
<p>Returns a JSON representation of the response.</p>
|
1242
|
+
|
1243
|
+
|
1244
|
+
</div>
|
1245
|
+
</div>
|
1246
|
+
<div class="tags">
|
1247
|
+
<p class="tag_title">Parameters:</p>
|
1248
|
+
<ul class="param">
|
1249
|
+
|
1250
|
+
<li>
|
1251
|
+
|
1252
|
+
<span class='name'>options</span>
|
1253
|
+
|
1254
|
+
|
1255
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1256
|
+
|
1257
|
+
|
1258
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
1259
|
+
|
1260
|
+
|
1261
|
+
—
|
1262
|
+
<div class='inline'><p>The options to use for serializing. Currently only <code>original_status</code> is supported.</p>
|
1263
|
+
</div>
|
1264
|
+
|
1265
|
+
</li>
|
1266
|
+
|
1267
|
+
</ul>
|
1268
|
+
|
1269
|
+
<p class="tag_title">Returns:</p>
|
1270
|
+
<ul class="return">
|
1271
|
+
|
1272
|
+
<li>
|
1273
|
+
|
1274
|
+
|
1275
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1276
|
+
|
1277
|
+
|
1278
|
+
|
1279
|
+
—
|
1280
|
+
<div class='inline'><p>A JSON representation of the response.</p>
|
1281
|
+
</div>
|
1282
|
+
|
1283
|
+
</li>
|
1284
|
+
|
1285
|
+
</ul>
|
1286
|
+
|
1287
|
+
</div><table class="source_code">
|
1288
|
+
<tr>
|
1289
|
+
<td>
|
1290
|
+
<pre class="lines">
|
1291
|
+
|
1292
|
+
|
1293
|
+
44
|
1294
|
+
45
|
1295
|
+
46
|
1296
|
+
47
|
1297
|
+
48
|
1298
|
+
49
|
1299
|
+
50</pre>
|
1300
|
+
</td>
|
1301
|
+
<td>
|
1302
|
+
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 44</span>
|
1303
|
+
|
1304
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_as_json'>as_json</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
1305
|
+
<span class='lbrace'>{</span>
|
1306
|
+
<span class='label'>status:</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:original_status</span><span class='rbracket'>]</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span><span class='comma'>,</span>
|
1307
|
+
<span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span>
|
1308
|
+
<span class='label'>error:</span> <span class='id identifier rubyid_error'>error</span>
|
1309
|
+
<span class='rbrace'>}</span>
|
1310
|
+
<span class='kw'>end</span></pre>
|
1311
|
+
</td>
|
1312
|
+
</tr>
|
1313
|
+
</table>
|
1314
|
+
</div>
|
1315
|
+
|
1316
|
+
<div class="method_details ">
|
1317
|
+
<h3 class="signature " id="numeric_status-instance_method">
|
1318
|
+
|
1319
|
+
- (<tt>Fixnum</tt>) <strong>numeric_status</strong>
|
1320
|
+
|
1321
|
+
|
1322
|
+
|
1323
|
+
|
1324
|
+
|
1325
|
+
</h3><div class="docstring">
|
1326
|
+
<div class="discussion">
|
1327
|
+
<p>Returns the status as a number.</p>
|
1328
|
+
|
1329
|
+
|
1330
|
+
</div>
|
1331
|
+
</div>
|
1332
|
+
<div class="tags">
|
1333
|
+
|
1334
|
+
<p class="tag_title">Returns:</p>
|
1335
|
+
<ul class="return">
|
1336
|
+
|
1337
|
+
<li>
|
1338
|
+
|
1339
|
+
|
1340
|
+
<span class='type'>(<tt>Fixnum</tt>)</span>
|
1341
|
+
|
1342
|
+
|
1343
|
+
|
1344
|
+
—
|
1345
|
+
<div class='inline'><p>The status as a number.</p>
|
1346
|
+
</div>
|
1347
|
+
|
1348
|
+
</li>
|
1349
|
+
|
1350
|
+
</ul>
|
1351
|
+
|
1352
|
+
</div><table class="source_code">
|
1353
|
+
<tr>
|
1354
|
+
<td>
|
1355
|
+
<pre class="lines">
|
1356
|
+
|
1357
|
+
|
1358
|
+
36
|
1359
|
+
37
|
1360
|
+
38</pre>
|
1361
|
+
</td>
|
1362
|
+
<td>
|
1363
|
+
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 36</span>
|
1364
|
+
|
1365
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span>
|
1366
|
+
<span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Fixnum</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_status'>status</span> <span class='op'>:</span> <span class='const'>Rack</span><span class='op'>::</span><span class='const'>Utils</span><span class='period'>.</span><span class='id identifier rubyid_status_code'>status_code</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span>
|
1367
|
+
<span class='kw'>end</span></pre>
|
1368
|
+
</td>
|
1369
|
+
</tr>
|
1370
|
+
</table>
|
1371
|
+
</div>
|
1372
|
+
|
1373
|
+
<div class="method_details ">
|
1374
|
+
<h3 class="signature " id="reply-instance_method">
|
1375
|
+
|
1376
|
+
- (<tt>Object</tt>) <strong>reply</strong>(format: :json, pretty_json: false)
|
1377
|
+
|
1378
|
+
|
1379
|
+
|
1380
|
+
|
1381
|
+
|
1382
|
+
</h3><div class="docstring">
|
1383
|
+
<div class="discussion">
|
1384
|
+
<p>Sends the response using the transport.</p>
|
1385
|
+
|
1386
|
+
|
1387
|
+
</div>
|
1388
|
+
</div>
|
1389
|
+
<div class="tags">
|
1390
|
+
<p class="tag_title">Parameters:</p>
|
1391
|
+
<ul class="param">
|
1392
|
+
|
1393
|
+
<li>
|
1394
|
+
|
1395
|
+
<span class='name'>format</span>
|
1396
|
+
|
1397
|
+
|
1398
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
1399
|
+
|
1400
|
+
|
1401
|
+
|
1402
|
+
—
|
1403
|
+
<div class='inline'><p>The content type of the response.</p>
|
1404
|
+
</div>
|
1405
|
+
|
1406
|
+
</li>
|
1407
|
+
|
1408
|
+
<li>
|
1409
|
+
|
1410
|
+
<span class='name'>pretty_json</span>
|
1411
|
+
|
1412
|
+
|
1413
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
1414
|
+
|
1415
|
+
|
1416
|
+
|
1417
|
+
—
|
1418
|
+
<div class='inline'><p>If JSON response must be pretty formatted.</p>
|
1419
|
+
</div>
|
1420
|
+
|
1421
|
+
</li>
|
1422
|
+
|
1423
|
+
</ul>
|
1424
|
+
|
1425
|
+
|
1426
|
+
</div><table class="source_code">
|
1427
|
+
<tr>
|
1428
|
+
<td>
|
1429
|
+
<pre class="lines">
|
1430
|
+
|
1431
|
+
|
1432
|
+
56
|
1433
|
+
57
|
1434
|
+
58
|
1435
|
+
59
|
1436
|
+
60
|
1437
|
+
61
|
1438
|
+
62
|
1439
|
+
63
|
1440
|
+
64</pre>
|
1441
|
+
</td>
|
1442
|
+
<td>
|
1443
|
+
<pre class="code"><span class="info file"># File 'lib/ballast/ajax_response.rb', line 56</span>
|
1444
|
+
|
1445
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_reply'>reply</span><span class='lparen'>(</span><span class='label'>format:</span> <span class='symbol'>:json</span><span class='comma'>,</span> <span class='label'>pretty_json:</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
1446
|
+
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_performed?'>performed?</span>
|
1447
|
+
|
1448
|
+
<span class='id identifier rubyid_format'>format</span><span class='comma'>,</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='id identifier rubyid_content_type'>content_type</span> <span class='op'>=</span> <span class='id identifier rubyid_format_reply'>format_reply</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
1449
|
+
<span class='id identifier rubyid_content'>content</span> <span class='op'>=</span> <span class='id identifier rubyid_prepare_content'>prepare_content</span>
|
1450
|
+
<span class='id identifier rubyid_content'>content</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_pretty_json'>pretty_json</span> <span class='op'>?</span> <span class='const'>Oj</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='const'>ActiveSupport</span><span class='op'>::</span><span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='lbracket'>[</span><span class='symbol'>:json</span><span class='comma'>,</span> <span class='symbol'>:jsonp</span><span class='comma'>,</span> <span class='symbol'>:text</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span><span class='rparen'>)</span>
|
1451
|
+
|
1452
|
+
<span class='id identifier rubyid_transport'>transport</span><span class='period'>.</span><span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='id identifier rubyid_format'>format</span> <span class='op'>=></span> <span class='id identifier rubyid_content'>content</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='id identifier rubyid_numeric_status'>numeric_status</span><span class='comma'>,</span> <span class='label'>callback:</span> <span class='id identifier rubyid_callback'>callback</span><span class='comma'>,</span> <span class='label'>content_type:</span> <span class='id identifier rubyid_content_type'>content_type</span><span class='rparen'>)</span>
|
1453
|
+
<span class='kw'>end</span></pre>
|
1454
|
+
</td>
|
1455
|
+
</tr>
|
1456
|
+
</table>
|
1457
|
+
</div>
|
1458
|
+
|
1459
|
+
</div>
|
1460
|
+
|
1461
|
+
</div>
|
1462
|
+
|
1463
|
+
<div id="footer">
|
1464
|
+
Generated on Thu Aug 18 15:49:49 2016 by
|
1465
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1466
|
+
0.8.7.6 (ruby-2.3.0).
|
1467
|
+
</div>
|
1468
|
+
|
1469
|
+
</body>
|
1470
|
+
</html>
|