gnip_api 1.2.2 → 1.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +24 -3
- data/README.md +70 -33
- data/Rakefile +7 -0
- data/doc/rdoc/classes/Gnip/Activity.html +354 -0
- data/doc/rdoc/classes/Gnip/Actor.html +300 -0
- data/doc/rdoc/classes/Gnip/GnipData.html +154 -0
- data/doc/rdoc/classes/Gnip/Message.html +236 -0
- data/doc/rdoc/classes/Gnip/SystemMessage.html +190 -0
- data/doc/rdoc/classes/Gnip/TwitterComplianceMessage.html +194 -0
- data/doc/rdoc/classes/Gnip/UndefinedMessage.html +83 -0
- data/doc/rdoc/classes/Gnip/Url.html +194 -0
- data/doc/rdoc/classes/Gnip.html +95 -0
- data/doc/rdoc/classes/GnipApi/Adapter.html +287 -0
- data/doc/rdoc/classes/GnipApi/Configuration.html +194 -0
- data/doc/rdoc/classes/GnipApi/Endpoints.html +191 -0
- data/doc/rdoc/classes/GnipApi/Errors/Adapter/GnipSoftwareError.html +83 -0
- data/doc/rdoc/classes/GnipApi/Errors/Adapter/RateLimitError.html +83 -0
- data/doc/rdoc/classes/GnipApi/Errors/Adapter/RequestError.html +56 -0
- data/doc/rdoc/classes/GnipApi/Errors/Adapter.html +66 -0
- data/doc/rdoc/classes/GnipApi/Errors/Configuration/InvalidOutputFormat.html +83 -0
- data/doc/rdoc/classes/GnipApi/Errors/Configuration.html +58 -0
- data/doc/rdoc/classes/GnipApi/Errors/JsonParser/ParseError.html +56 -0
- data/doc/rdoc/classes/GnipApi/Errors/JsonParser.html +64 -0
- data/doc/rdoc/classes/GnipApi/Errors/MissingAdapter.html +83 -0
- data/doc/rdoc/classes/GnipApi/Errors/MissingCredentials.html +83 -0
- data/doc/rdoc/classes/GnipApi/Errors/PowerTrack/MissingRules.html +83 -0
- data/doc/rdoc/classes/GnipApi/Errors/PowerTrack/StreamDown.html +56 -0
- data/doc/rdoc/classes/GnipApi/Errors/PowerTrack.html +65 -0
- data/doc/rdoc/classes/GnipApi/Errors/Search/MissingParameters.html +83 -0
- data/doc/rdoc/classes/GnipApi/Errors/Search.html +64 -0
- data/doc/rdoc/classes/GnipApi/Errors.html +79 -0
- data/doc/rdoc/classes/GnipApi/JsonParser.html +101 -0
- data/doc/rdoc/classes/GnipApi/PowerTrack/Buffer.html +237 -0
- data/doc/rdoc/classes/GnipApi/PowerTrack/Rule.html +196 -0
- data/doc/rdoc/classes/GnipApi/PowerTrack/Rules.html +188 -0
- data/doc/rdoc/classes/GnipApi/PowerTrack/Stream.html +359 -0
- data/doc/rdoc/classes/GnipApi/PowerTrack.html +73 -0
- data/doc/rdoc/classes/GnipApi/Request.html +216 -0
- data/doc/rdoc/classes/GnipApi/Response.html +232 -0
- data/doc/rdoc/classes/GnipApi/Search.html +101 -0
- data/doc/rdoc/classes/GnipApi.html +252 -0
- data/doc/rdoc/created.rid +24 -0
- data/doc/rdoc/css/style.css +343 -0
- data/doc/rdoc/files/LICENSE_txt.html +73 -0
- data/doc/rdoc/files/README_md.html +299 -0
- data/doc/rdoc/files/lib/gnip_api/adapter_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/configuration_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/endpoints_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/errors_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/gnip/activity_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/gnip/actor_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/gnip/gnip_data_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/gnip/message_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/gnip/system_message_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/gnip/twitter_compliance_message_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/gnip/url_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/json_parser_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/power_track/buffer_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/power_track/rule_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/power_track/rules_rb.html +55 -0
- data/doc/rdoc/files/lib/gnip_api/power_track/stream_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/request_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/response_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api/search_rb.html +55 -0
- data/doc/rdoc/files/lib/gnip_api/version_rb.html +51 -0
- data/doc/rdoc/files/lib/gnip_api_rb.html +84 -0
- data/doc/rdoc/fr_class_index.html +92 -0
- data/doc/rdoc/fr_file_index.html +41 -0
- data/doc/rdoc/fr_method_index.html +4791 -0
- data/doc/rdoc/index.html +15 -0
- data/gnip_api.gemspec +3 -1
- data/lib/gnip_api/configuration.rb +18 -4
- data/lib/gnip_api/errors.rb +0 -1
- data/lib/gnip_api/power_track/buffer.rb +60 -14
- data/lib/gnip_api/power_track/stream.rb +52 -17
- data/lib/gnip_api/response.rb +3 -2
- data/lib/gnip_api/version.rb +1 -1
- data/spec/gnip_api/power_track/buffer_spec.rb +8 -0
- data/spec/gnip_api/response_spec.rb +16 -0
- data/spec/spec_helper.rb +1 -0
- metadata +97 -2
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
2
|
+
<html lang='en'>
|
|
3
|
+
<head>
|
|
4
|
+
<title>GnipApi::PowerTrack</title>
|
|
5
|
+
<meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
|
|
6
|
+
<link href='../../css/style.css' media='screen' rel='stylesheet' type='text/css'>
|
|
7
|
+
<script type='text/javascript'>
|
|
8
|
+
function popupCode(url) {
|
|
9
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
function toggleCode(id) {
|
|
13
|
+
var code = document.getElementById(id)
|
|
14
|
+
|
|
15
|
+
code.style.display = code.style.display != 'block' ? 'block' : 'none'
|
|
16
|
+
return true
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
// Make codeblocks hidden by default
|
|
20
|
+
document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
|
|
21
|
+
</script>
|
|
22
|
+
</head>
|
|
23
|
+
<body class='page'>
|
|
24
|
+
<div class='class' id='wrapper'>
|
|
25
|
+
<div class='header'>
|
|
26
|
+
<h1 class='name'><span class='type'>module</span>
|
|
27
|
+
GnipApi::PowerTrack
|
|
28
|
+
</h1>
|
|
29
|
+
<ol class='paths'>
|
|
30
|
+
<li>
|
|
31
|
+
<a href="../../files/lib/gnip_api/power_track/buffer_rb.html">lib/gnip_api/power_track/buffer.rb</a>
|
|
32
|
+
</li>
|
|
33
|
+
<li class='other'>
|
|
34
|
+
<a href="../../files/lib/gnip_api/power_track/rule_rb.html">lib/gnip_api/power_track/rule.rb</a>
|
|
35
|
+
</li>
|
|
36
|
+
<li class='other'>
|
|
37
|
+
<a href="../../files/lib/gnip_api/power_track/rules_rb.html">lib/gnip_api/power_track/rules.rb</a>
|
|
38
|
+
</li>
|
|
39
|
+
<li class='other'>
|
|
40
|
+
<a href="../../files/lib/gnip_api/power_track/stream_rb.html">lib/gnip_api/power_track/stream.rb</a>
|
|
41
|
+
</li>
|
|
42
|
+
<li>
|
|
43
|
+
<a class='show' href='#' onclick='this.parentNode.parentNode.className += " expanded"; this.parentNode.removeChild(this); return false'>show all</a>
|
|
44
|
+
</li>
|
|
45
|
+
</ol>
|
|
46
|
+
</div>
|
|
47
|
+
<div id='content'>
|
|
48
|
+
<div id='text'>
|
|
49
|
+
<div id='description'></div>
|
|
50
|
+
<div id='context'>
|
|
51
|
+
</div>
|
|
52
|
+
<div id='class-list'>
|
|
53
|
+
<h2>Classes and Modules</h2>
|
|
54
|
+
<ol>
|
|
55
|
+
<li><a href="PowerTrack/Buffer.html">GnipApi::PowerTrack::Buffer</a></li>
|
|
56
|
+
<li><a href="PowerTrack/Rule.html">GnipApi::PowerTrack::Rule</a></li>
|
|
57
|
+
<li><a href="PowerTrack/Rules.html">GnipApi::PowerTrack::Rules</a></li>
|
|
58
|
+
<li><a href="PowerTrack/Stream.html">GnipApi::PowerTrack::Stream</a></li>
|
|
59
|
+
</ol>
|
|
60
|
+
</div>
|
|
61
|
+
<div id='section'>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
</div>
|
|
65
|
+
</div>
|
|
66
|
+
|
|
67
|
+
<div id='footer-push'></div>
|
|
68
|
+
</div>
|
|
69
|
+
<div id='footer'>
|
|
70
|
+
<a href="https://github.com/rdoc/hanna-nouveau"><strong>Hanna Nouveau</strong> RDoc template</a>
|
|
71
|
+
</div>
|
|
72
|
+
</body>
|
|
73
|
+
</html>
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
2
|
+
<html lang='en'>
|
|
3
|
+
<head>
|
|
4
|
+
<title>GnipApi::Request</title>
|
|
5
|
+
<meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
|
|
6
|
+
<link href='../../css/style.css' media='screen' rel='stylesheet' type='text/css'>
|
|
7
|
+
<script type='text/javascript'>
|
|
8
|
+
function popupCode(url) {
|
|
9
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
function toggleCode(id) {
|
|
13
|
+
var code = document.getElementById(id)
|
|
14
|
+
|
|
15
|
+
code.style.display = code.style.display != 'block' ? 'block' : 'none'
|
|
16
|
+
return true
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
// Make codeblocks hidden by default
|
|
20
|
+
document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
|
|
21
|
+
</script>
|
|
22
|
+
</head>
|
|
23
|
+
<body class='page'>
|
|
24
|
+
<div class='class' id='wrapper'>
|
|
25
|
+
<div class='header'>
|
|
26
|
+
<h1 class='name'><span class='type'>class</span>
|
|
27
|
+
GnipApi::Request
|
|
28
|
+
</h1>
|
|
29
|
+
<ol class='paths'>
|
|
30
|
+
<li>
|
|
31
|
+
<a href="../../files/lib/gnip_api/request_rb.html">lib/gnip_api/request.rb</a>
|
|
32
|
+
</li>
|
|
33
|
+
</ol>
|
|
34
|
+
<div class='parent'>
|
|
35
|
+
Superclass:
|
|
36
|
+
<strong>Object</strong>
|
|
37
|
+
</div>
|
|
38
|
+
</div>
|
|
39
|
+
<div id='content'>
|
|
40
|
+
<div id='text'>
|
|
41
|
+
<div id='description'></div>
|
|
42
|
+
<div id='method-list'>
|
|
43
|
+
<h2>Methods</h2>
|
|
44
|
+
<h3>Public Class</h3>
|
|
45
|
+
<ol>
|
|
46
|
+
<li><a href="#method-c-new">new</a></li>
|
|
47
|
+
<li><a href="#method-c-new_delete">new_delete</a></li>
|
|
48
|
+
<li><a href="#method-c-new_get">new_get</a></li>
|
|
49
|
+
<li><a href="#method-c-new_post">new_post</a></li>
|
|
50
|
+
</ol>
|
|
51
|
+
<h3>Public Instance</h3>
|
|
52
|
+
<ol>
|
|
53
|
+
<li><a href="#method-i-execute-21">execute!</a></li>
|
|
54
|
+
<li><a href="#attribute-i-headers">headers</a></li>
|
|
55
|
+
<li><a href="#method-i-log-21">log!</a></li>
|
|
56
|
+
<li><a href="#attribute-i-payload">payload</a></li>
|
|
57
|
+
<li><a href="#attribute-i-request_method">request_method</a></li>
|
|
58
|
+
<li><a href="#attribute-i-uri">uri</a></li>
|
|
59
|
+
</ol>
|
|
60
|
+
</div>
|
|
61
|
+
<div id='context'>
|
|
62
|
+
</div>
|
|
63
|
+
<div id='section'>
|
|
64
|
+
<div id='attribute-list'>
|
|
65
|
+
<h2 class='section-bar'>Attributes</h2>
|
|
66
|
+
<div class='name-list'>
|
|
67
|
+
<table>
|
|
68
|
+
<tr class='top-aligned-row context-row'>
|
|
69
|
+
<td class='context-item-name'>
|
|
70
|
+
<a name='attribute-i-headers'>headers</a>
|
|
71
|
+
</td>
|
|
72
|
+
<td class='context-item-value'>[R]</td>
|
|
73
|
+
<td class='context-item-desc'></td>
|
|
74
|
+
</tr>
|
|
75
|
+
<tr class='top-aligned-row context-row'>
|
|
76
|
+
<td class='context-item-name'>
|
|
77
|
+
<a name='attribute-i-payload'>payload</a>
|
|
78
|
+
</td>
|
|
79
|
+
<td class='context-item-value'>[R]</td>
|
|
80
|
+
<td class='context-item-desc'></td>
|
|
81
|
+
</tr>
|
|
82
|
+
<tr class='top-aligned-row context-row'>
|
|
83
|
+
<td class='context-item-name'>
|
|
84
|
+
<a name='attribute-i-request_method'>request_method</a>
|
|
85
|
+
</td>
|
|
86
|
+
<td class='context-item-value'>[R]</td>
|
|
87
|
+
<td class='context-item-desc'></td>
|
|
88
|
+
</tr>
|
|
89
|
+
<tr class='top-aligned-row context-row'>
|
|
90
|
+
<td class='context-item-name'>
|
|
91
|
+
<a name='attribute-i-uri'>uri</a>
|
|
92
|
+
</td>
|
|
93
|
+
<td class='context-item-value'>[R]</td>
|
|
94
|
+
<td class='context-item-desc'></td>
|
|
95
|
+
</tr>
|
|
96
|
+
</table>
|
|
97
|
+
</div>
|
|
98
|
+
</div>
|
|
99
|
+
<div id='methods'>
|
|
100
|
+
<h2>Public Class methods</h2>
|
|
101
|
+
<div class='method public-class' id='method-method-c-new'>
|
|
102
|
+
<a name='method-c-new'></a>
|
|
103
|
+
<div class='synopsis'>
|
|
104
|
+
<span class='name'>new</span>
|
|
105
|
+
<span class='arguments'>(params={})</span>
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
<div class='description'>
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
<div class='source'>
|
|
112
|
+
<a class='source-toggle' href='#' onclick='toggleCode('method-c-new-source'); return false'>
|
|
113
|
+
[show source]
|
|
114
|
+
</a>
|
|
115
|
+
<pre id='method-c-new-source'><span class="ruby-comment"># File lib/gnip_api/request.rb, line 19</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-identifier">params</span>={}
 <span class="ruby-ivar">@uri</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:uri</span>]
 <span class="ruby-ivar">@payload</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:payload</span>]
 <span class="ruby-ivar">@headers</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:headers</span>]
 <span class="ruby-ivar">@request_method</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:request_method</span>]
 <span class="ruby-ivar">@adapter</span> = <span class="ruby-constant">GnipApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Adapter</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">end</span></pre>
|
|
116
|
+
</div>
|
|
117
|
+
</div>
|
|
118
|
+
<div class='method public-class' id='method-method-c-new_delete'>
|
|
119
|
+
<a name='method-c-new_delete'></a>
|
|
120
|
+
<div class='synopsis'>
|
|
121
|
+
<span class='name'>new_delete</span>
|
|
122
|
+
<span class='arguments'>(uri, payload, headers=nil)</span>
|
|
123
|
+
|
|
124
|
+
</div>
|
|
125
|
+
<div class='description'>
|
|
126
|
+
|
|
127
|
+
</div>
|
|
128
|
+
<div class='source'>
|
|
129
|
+
<a class='source-toggle' href='#' onclick='toggleCode('method-c-new_delete-source'); return false'>
|
|
130
|
+
[show source]
|
|
131
|
+
</a>
|
|
132
|
+
<pre id='method-c-new_delete-source'><span class="ruby-comment"># File lib/gnip_api/request.rb, line 14</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">new_delete</span> <span class="ruby-identifier">uri</span>, <span class="ruby-identifier">payload</span>, <span class="ruby-identifier">headers</span>=<span class="ruby-keyword">nil</span>
 <span class="ruby-identifier">new</span>(<span class="ruby-value">:uri</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">uri</span>, <span class="ruby-value">:headers</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">headers</span>, <span class="ruby-value">:payload</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">payload</span>, <span class="ruby-value">:request_method</span> =<span class="ruby-operator">></span> <span class="ruby-constant">GnipApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Adapter</span><span class="ruby-operator">::</span><span class="ruby-constant">POST</span>)
<span class="ruby-keyword">end</span></pre>
|
|
133
|
+
</div>
|
|
134
|
+
</div>
|
|
135
|
+
<div class='method public-class' id='method-method-c-new_get'>
|
|
136
|
+
<a name='method-c-new_get'></a>
|
|
137
|
+
<div class='synopsis'>
|
|
138
|
+
<span class='name'>new_get</span>
|
|
139
|
+
<span class='arguments'>(uri, headers=nil)</span>
|
|
140
|
+
|
|
141
|
+
</div>
|
|
142
|
+
<div class='description'>
|
|
143
|
+
|
|
144
|
+
</div>
|
|
145
|
+
<div class='source'>
|
|
146
|
+
<a class='source-toggle' href='#' onclick='toggleCode('method-c-new_get-source'); return false'>
|
|
147
|
+
[show source]
|
|
148
|
+
</a>
|
|
149
|
+
<pre id='method-c-new_get-source'><span class="ruby-comment"># File lib/gnip_api/request.rb, line 6</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">new_get</span> <span class="ruby-identifier">uri</span>, <span class="ruby-identifier">headers</span>=<span class="ruby-keyword">nil</span>
 <span class="ruby-identifier">new</span>(<span class="ruby-value">:uri</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">uri</span>, <span class="ruby-value">:headers</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">headers</span>, <span class="ruby-value">:request_method</span> =<span class="ruby-operator">></span> <span class="ruby-constant">GnipApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Adapter</span><span class="ruby-operator">::</span><span class="ruby-constant">GET</span>)
<span class="ruby-keyword">end</span></pre>
|
|
150
|
+
</div>
|
|
151
|
+
</div>
|
|
152
|
+
<div class='method public-class' id='method-method-c-new_post'>
|
|
153
|
+
<a name='method-c-new_post'></a>
|
|
154
|
+
<div class='synopsis'>
|
|
155
|
+
<span class='name'>new_post</span>
|
|
156
|
+
<span class='arguments'>(uri, payload, headers=nil)</span>
|
|
157
|
+
|
|
158
|
+
</div>
|
|
159
|
+
<div class='description'>
|
|
160
|
+
|
|
161
|
+
</div>
|
|
162
|
+
<div class='source'>
|
|
163
|
+
<a class='source-toggle' href='#' onclick='toggleCode('method-c-new_post-source'); return false'>
|
|
164
|
+
[show source]
|
|
165
|
+
</a>
|
|
166
|
+
<pre id='method-c-new_post-source'><span class="ruby-comment"># File lib/gnip_api/request.rb, line 10</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">new_post</span> <span class="ruby-identifier">uri</span>, <span class="ruby-identifier">payload</span>, <span class="ruby-identifier">headers</span>=<span class="ruby-keyword">nil</span>
 <span class="ruby-identifier">new</span>(<span class="ruby-value">:uri</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">uri</span>, <span class="ruby-value">:headers</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">headers</span>, <span class="ruby-value">:payload</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">payload</span>, <span class="ruby-value">:request_method</span> =<span class="ruby-operator">></span> <span class="ruby-constant">GnipApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Adapter</span><span class="ruby-operator">::</span><span class="ruby-constant">POST</span>)
<span class="ruby-keyword">end</span></pre>
|
|
167
|
+
</div>
|
|
168
|
+
</div>
|
|
169
|
+
<h2>Public Instance methods</h2>
|
|
170
|
+
<div class='method public-instance' id='method-method-i-execute-21'>
|
|
171
|
+
<a name='method-i-execute-21'></a>
|
|
172
|
+
<div class='synopsis'>
|
|
173
|
+
<span class='name'>execute!</span>
|
|
174
|
+
<span class='arguments'>()</span>
|
|
175
|
+
|
|
176
|
+
</div>
|
|
177
|
+
<div class='description'>
|
|
178
|
+
|
|
179
|
+
</div>
|
|
180
|
+
<div class='source'>
|
|
181
|
+
<a class='source-toggle' href='#' onclick='toggleCode('method-i-execute-21-source'); return false'>
|
|
182
|
+
[show source]
|
|
183
|
+
</a>
|
|
184
|
+
<pre id='method-i-execute-21-source'><span class="ruby-comment"># File lib/gnip_api/request.rb, line 27</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">execute!</span>
 <span class="ruby-identifier">log!</span>
 <span class="ruby-keyword">case</span> <span class="ruby-identifier">request_method</span>
 <span class="ruby-keyword">when</span> <span class="ruby-constant">GnipApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Adapter</span><span class="ruby-operator">::</span><span class="ruby-constant">GET</span>
 <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@adapter</span>.<span class="ruby-identifier">get</span>(<span class="ruby-keyword">self</span>)
 <span class="ruby-keyword">when</span> <span class="ruby-constant">GnipApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Adapter</span><span class="ruby-operator">::</span><span class="ruby-constant">POST</span>
 <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@adapter</span>.<span class="ruby-identifier">post</span>(<span class="ruby-keyword">self</span>)
 <span class="ruby-keyword">when</span> <span class="ruby-constant">GnipApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Adapter</span><span class="ruby-operator">::</span><span class="ruby-constant">DELETE</span>
 <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@adapter</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-keyword">self</span>)
 <span class="ruby-keyword">else</span>
 <span class="ruby-identifier">raise</span> <span class="ruby-string">'RequestNotAllowed'</span>
 <span class="ruby-keyword">end</span>
 <span class="ruby-identifier">response</span>.<span class="ruby-identifier">check_for_errors!</span>
 <span class="ruby-keyword">return</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">empty?</span>
 <span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span></pre>
|
|
185
|
+
</div>
|
|
186
|
+
</div>
|
|
187
|
+
<div class='method public-instance' id='method-method-i-log-21'>
|
|
188
|
+
<a name='method-i-log-21'></a>
|
|
189
|
+
<div class='synopsis'>
|
|
190
|
+
<span class='name'>log!</span>
|
|
191
|
+
<span class='arguments'>()</span>
|
|
192
|
+
|
|
193
|
+
</div>
|
|
194
|
+
<div class='description'>
|
|
195
|
+
|
|
196
|
+
</div>
|
|
197
|
+
<div class='source'>
|
|
198
|
+
<a class='source-toggle' href='#' onclick='toggleCode('method-i-log-21-source'); return false'>
|
|
199
|
+
[show source]
|
|
200
|
+
</a>
|
|
201
|
+
<pre id='method-i-log-21-source'><span class="ruby-comment"># File lib/gnip_api/request.rb, line 44</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">log!</span>
 <span class="ruby-constant">GnipApi</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">info</span> <span class="ruby-node">"Starting #{request_method} request to #{uri}"</span>
 <span class="ruby-constant">GnipApi</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Headers -> #{headers.inspect}"</span>
 <span class="ruby-constant">GnipApi</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Payload -> #{payload.inspect}"</span>
<span class="ruby-keyword">end</span></pre>
|
|
202
|
+
</div>
|
|
203
|
+
</div>
|
|
204
|
+
</div>
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
</div>
|
|
208
|
+
</div>
|
|
209
|
+
|
|
210
|
+
<div id='footer-push'></div>
|
|
211
|
+
</div>
|
|
212
|
+
<div id='footer'>
|
|
213
|
+
<a href="https://github.com/rdoc/hanna-nouveau"><strong>Hanna Nouveau</strong> RDoc template</a>
|
|
214
|
+
</div>
|
|
215
|
+
</body>
|
|
216
|
+
</html>
|
|
@@ -0,0 +1,232 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
2
|
+
<html lang='en'>
|
|
3
|
+
<head>
|
|
4
|
+
<title>GnipApi::Response</title>
|
|
5
|
+
<meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
|
|
6
|
+
<link href='../../css/style.css' media='screen' rel='stylesheet' type='text/css'>
|
|
7
|
+
<script type='text/javascript'>
|
|
8
|
+
function popupCode(url) {
|
|
9
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
function toggleCode(id) {
|
|
13
|
+
var code = document.getElementById(id)
|
|
14
|
+
|
|
15
|
+
code.style.display = code.style.display != 'block' ? 'block' : 'none'
|
|
16
|
+
return true
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
// Make codeblocks hidden by default
|
|
20
|
+
document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
|
|
21
|
+
</script>
|
|
22
|
+
</head>
|
|
23
|
+
<body class='page'>
|
|
24
|
+
<div class='class' id='wrapper'>
|
|
25
|
+
<div class='header'>
|
|
26
|
+
<h1 class='name'><span class='type'>class</span>
|
|
27
|
+
GnipApi::Response
|
|
28
|
+
</h1>
|
|
29
|
+
<ol class='paths'>
|
|
30
|
+
<li>
|
|
31
|
+
<a href="../../files/lib/gnip_api/response_rb.html">lib/gnip_api/response.rb</a>
|
|
32
|
+
</li>
|
|
33
|
+
</ol>
|
|
34
|
+
<div class='parent'>
|
|
35
|
+
Superclass:
|
|
36
|
+
<strong>Object</strong>
|
|
37
|
+
</div>
|
|
38
|
+
</div>
|
|
39
|
+
<div id='content'>
|
|
40
|
+
<div id='text'>
|
|
41
|
+
<div id='description'></div>
|
|
42
|
+
<div id='method-list'>
|
|
43
|
+
<h2>Methods</h2>
|
|
44
|
+
<h3>Public Class</h3>
|
|
45
|
+
<ol>
|
|
46
|
+
<li><a href="#method-c-new">new</a></li>
|
|
47
|
+
</ol>
|
|
48
|
+
<h3>Public Instance</h3>
|
|
49
|
+
<ol>
|
|
50
|
+
<li><a href="#attribute-i-body">body</a></li>
|
|
51
|
+
<li><a href="#method-i-check_for_errors-21">check_for_errors!</a></li>
|
|
52
|
+
<li><a href="#method-i-error_message">error_message</a></li>
|
|
53
|
+
<li><a href="#attribute-i-headers">headers</a></li>
|
|
54
|
+
<li><a href="#method-i-ok-3F">ok?</a></li>
|
|
55
|
+
<li><a href="#attribute-i-request">request</a></li>
|
|
56
|
+
<li><a href="#method-i-request_method">request_method</a></li>
|
|
57
|
+
<li><a href="#method-i-request_uri">request_uri</a></li>
|
|
58
|
+
<li><a href="#attribute-i-status">status</a></li>
|
|
59
|
+
</ol>
|
|
60
|
+
</div>
|
|
61
|
+
<div id='context'>
|
|
62
|
+
</div>
|
|
63
|
+
<div id='section'>
|
|
64
|
+
<div id='constants-list'>
|
|
65
|
+
<h2>Constants</h2>
|
|
66
|
+
<div class='name-list'>
|
|
67
|
+
<table summary='Constants'>
|
|
68
|
+
<tr class='top-aligned-row context-row'>
|
|
69
|
+
<td class='context-item-name'>OK_STATUSES</td>
|
|
70
|
+
<td>=</td>
|
|
71
|
+
<td class='context-item-value'>[200, 201, 202, 203, 204, 205, 206, 207, 208, 226]</td>
|
|
72
|
+
<td> </td>
|
|
73
|
+
<td class='context-item-desc'>
|
|
74
|
+
<p>List of codes that are considered OK</p>
|
|
75
|
+
</td>
|
|
76
|
+
</tr>
|
|
77
|
+
</table>
|
|
78
|
+
</div>
|
|
79
|
+
</div>
|
|
80
|
+
<div id='attribute-list'>
|
|
81
|
+
<h2 class='section-bar'>Attributes</h2>
|
|
82
|
+
<div class='name-list'>
|
|
83
|
+
<table>
|
|
84
|
+
<tr class='top-aligned-row context-row'>
|
|
85
|
+
<td class='context-item-name'>
|
|
86
|
+
<a name='attribute-i-body'>body</a>
|
|
87
|
+
</td>
|
|
88
|
+
<td class='context-item-value'>[R]</td>
|
|
89
|
+
<td class='context-item-desc'></td>
|
|
90
|
+
</tr>
|
|
91
|
+
<tr class='top-aligned-row context-row'>
|
|
92
|
+
<td class='context-item-name'>
|
|
93
|
+
<a name='attribute-i-headers'>headers</a>
|
|
94
|
+
</td>
|
|
95
|
+
<td class='context-item-value'>[R]</td>
|
|
96
|
+
<td class='context-item-desc'></td>
|
|
97
|
+
</tr>
|
|
98
|
+
<tr class='top-aligned-row context-row'>
|
|
99
|
+
<td class='context-item-name'>
|
|
100
|
+
<a name='attribute-i-request'>request</a>
|
|
101
|
+
</td>
|
|
102
|
+
<td class='context-item-value'>[R]</td>
|
|
103
|
+
<td class='context-item-desc'></td>
|
|
104
|
+
</tr>
|
|
105
|
+
<tr class='top-aligned-row context-row'>
|
|
106
|
+
<td class='context-item-name'>
|
|
107
|
+
<a name='attribute-i-status'>status</a>
|
|
108
|
+
</td>
|
|
109
|
+
<td class='context-item-value'>[R]</td>
|
|
110
|
+
<td class='context-item-desc'></td>
|
|
111
|
+
</tr>
|
|
112
|
+
</table>
|
|
113
|
+
</div>
|
|
114
|
+
</div>
|
|
115
|
+
<div id='methods'>
|
|
116
|
+
<h2>Public Class methods</h2>
|
|
117
|
+
<div class='method public-class' id='method-method-c-new'>
|
|
118
|
+
<a name='method-c-new'></a>
|
|
119
|
+
<div class='synopsis'>
|
|
120
|
+
<span class='name'>new</span>
|
|
121
|
+
<span class='arguments'>(request, status, body, headers)</span>
|
|
122
|
+
|
|
123
|
+
</div>
|
|
124
|
+
<div class='description'>
|
|
125
|
+
|
|
126
|
+
</div>
|
|
127
|
+
<div class='source'>
|
|
128
|
+
<a class='source-toggle' href='#' onclick='toggleCode('method-c-new-source'); return false'>
|
|
129
|
+
[show source]
|
|
130
|
+
</a>
|
|
131
|
+
<pre id='method-c-new-source'><span class="ruby-comment"># File lib/gnip_api/response.rb, line 8</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-identifier">request</span>, <span class="ruby-identifier">status</span>, <span class="ruby-identifier">body</span>, <span class="ruby-identifier">headers</span>
 <span class="ruby-ivar">@status</span> = <span class="ruby-identifier">status</span>
 <span class="ruby-ivar">@body</span> = <span class="ruby-identifier">body</span>
 <span class="ruby-ivar">@headers</span> = <span class="ruby-identifier">headers</span>
 <span class="ruby-ivar">@request</span> = <span class="ruby-identifier">request</span>
<span class="ruby-keyword">end</span></pre>
|
|
132
|
+
</div>
|
|
133
|
+
</div>
|
|
134
|
+
<h2>Public Instance methods</h2>
|
|
135
|
+
<div class='method public-instance' id='method-method-i-check_for_errors-21'>
|
|
136
|
+
<a name='method-i-check_for_errors-21'></a>
|
|
137
|
+
<div class='synopsis'>
|
|
138
|
+
<span class='name'>check_for_errors!</span>
|
|
139
|
+
<span class='arguments'>()</span>
|
|
140
|
+
|
|
141
|
+
</div>
|
|
142
|
+
<div class='description'>
|
|
143
|
+
|
|
144
|
+
</div>
|
|
145
|
+
<div class='source'>
|
|
146
|
+
<a class='source-toggle' href='#' onclick='toggleCode('method-i-check_for_errors-21-source'); return false'>
|
|
147
|
+
[show source]
|
|
148
|
+
</a>
|
|
149
|
+
<pre id='method-i-check_for_errors-21-source'><span class="ruby-comment"># File lib/gnip_api/response.rb, line 35</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">check_for_errors!</span>
 <span class="ruby-keyword">if</span> <span class="ruby-identifier">ok?</span>
 <span class="ruby-constant">GnipApi</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">info</span> <span class="ruby-node">"#{request_method} request to #{request_uri} returned with status #{status} OK"</span>
 <span class="ruby-constant">GnipApi</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Headers -> #{headers.inspect}"</span>
 <span class="ruby-constant">GnipApi</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Body -> #{body.inspect}"</span>
 <span class="ruby-constant">GnipApi</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Request headers -> #{request.headers.inspect}"</span>
 <span class="ruby-constant">GnipApi</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Request payload -> #{request.payload.inspect}"</span>
 <span class="ruby-keyword">else</span>
 <span class="ruby-identifier">error_message</span> = <span class="ruby-identifier">error_message</span>
 <span class="ruby-constant">GnipApi</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">error</span> <span class="ruby-node">"#{request_method} request to #{request_uri} returned with status #{status} FAIL"</span>
 <span class="ruby-constant">GnipApi</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Headers -> #{headers.inspect}"</span>
 <span class="ruby-constant">GnipApi</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Body -> #{body.inspect}"</span>
 <span class="ruby-constant">GnipApi</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Request headers -> #{request.headers.inspect}"</span>
 <span class="ruby-constant">GnipApi</span>.<span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Request payload -> #{request.payload.inspect}"</span>
 <span class="ruby-identifier">raise</span> <span class="ruby-constant">GnipApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">Adapter</span><span class="ruby-operator">::</span><span class="ruby-constant">GnipSoftwareError</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">error_message</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">status</span> <span class="ruby-operator">==</span> <span class="ruby-value">503</span>
 <span class="ruby-identifier">raise</span> <span class="ruby-constant">GnipApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">Adapter</span><span class="ruby-operator">::</span><span class="ruby-constant">RateLimitError</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">error_message</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">status</span> <span class="ruby-operator">==</span> <span class="ruby-value">429</span>
 <span class="ruby-identifier">raise</span> <span class="ruby-constant">GnipApi</span><span class="ruby-operator">::</span><span class="ruby-constant">Errors</span><span class="ruby-operator">::</span><span class="ruby-constant">Adapter</span><span class="ruby-operator">::</span><span class="ruby-constant">RequestError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"Status #{status} #{error_message}"</span>)
 <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
|
|
150
|
+
</div>
|
|
151
|
+
</div>
|
|
152
|
+
<div class='method public-instance' id='method-method-i-error_message'>
|
|
153
|
+
<a name='method-i-error_message'></a>
|
|
154
|
+
<div class='synopsis'>
|
|
155
|
+
<span class='name'>error_message</span>
|
|
156
|
+
<span class='arguments'>()</span>
|
|
157
|
+
|
|
158
|
+
</div>
|
|
159
|
+
<div class='description'>
|
|
160
|
+
|
|
161
|
+
</div>
|
|
162
|
+
<div class='source'>
|
|
163
|
+
<a class='source-toggle' href='#' onclick='toggleCode('method-i-error_message-source'); return false'>
|
|
164
|
+
[show source]
|
|
165
|
+
</a>
|
|
166
|
+
<pre id='method-i-error_message-source'><span class="ruby-comment"># File lib/gnip_api/response.rb, line 27</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">error_message</span>
 <span class="ruby-keyword">if</span> <span class="ruby-ivar">@body</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@body</span>.<span class="ruby-identifier">empty?</span>
 <span class="ruby-identifier">parsed</span> = <span class="ruby-constant">GnipApi</span><span class="ruby-operator">::</span><span class="ruby-constant">JsonParser</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-ivar">@body</span>)
 <span class="ruby-keyword">return</span> <span class="ruby-identifier">parsed</span>
 <span class="ruby-keyword">end</span>
 <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
|
|
167
|
+
</div>
|
|
168
|
+
</div>
|
|
169
|
+
<div class='method public-instance' id='method-method-i-ok-3F'>
|
|
170
|
+
<a name='method-i-ok-3F'></a>
|
|
171
|
+
<div class='synopsis'>
|
|
172
|
+
<span class='name'>ok?</span>
|
|
173
|
+
<span class='arguments'>()</span>
|
|
174
|
+
|
|
175
|
+
</div>
|
|
176
|
+
<div class='description'>
|
|
177
|
+
|
|
178
|
+
</div>
|
|
179
|
+
<div class='source'>
|
|
180
|
+
<a class='source-toggle' href='#' onclick='toggleCode('method-i-ok-3F-source'); return false'>
|
|
181
|
+
[show source]
|
|
182
|
+
</a>
|
|
183
|
+
<pre id='method-i-ok-3F-source'><span class="ruby-comment"># File lib/gnip_api/response.rb, line 23</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">ok?</span>
 <span class="ruby-constant">OK_STATUSES</span>.<span class="ruby-identifier">include?</span> <span class="ruby-ivar">@status</span>
<span class="ruby-keyword">end</span></pre>
|
|
184
|
+
</div>
|
|
185
|
+
</div>
|
|
186
|
+
<div class='method public-instance' id='method-method-i-request_method'>
|
|
187
|
+
<a name='method-i-request_method'></a>
|
|
188
|
+
<div class='synopsis'>
|
|
189
|
+
<span class='name'>request_method</span>
|
|
190
|
+
<span class='arguments'>()</span>
|
|
191
|
+
|
|
192
|
+
</div>
|
|
193
|
+
<div class='description'>
|
|
194
|
+
|
|
195
|
+
</div>
|
|
196
|
+
<div class='source'>
|
|
197
|
+
<a class='source-toggle' href='#' onclick='toggleCode('method-i-request_method-source'); return false'>
|
|
198
|
+
[show source]
|
|
199
|
+
</a>
|
|
200
|
+
<pre id='method-i-request_method-source'><span class="ruby-comment"># File lib/gnip_api/response.rb, line 15</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">request_method</span>
 <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">request_method</span>
<span class="ruby-keyword">end</span></pre>
|
|
201
|
+
</div>
|
|
202
|
+
</div>
|
|
203
|
+
<div class='method public-instance' id='method-method-i-request_uri'>
|
|
204
|
+
<a name='method-i-request_uri'></a>
|
|
205
|
+
<div class='synopsis'>
|
|
206
|
+
<span class='name'>request_uri</span>
|
|
207
|
+
<span class='arguments'>()</span>
|
|
208
|
+
|
|
209
|
+
</div>
|
|
210
|
+
<div class='description'>
|
|
211
|
+
|
|
212
|
+
</div>
|
|
213
|
+
<div class='source'>
|
|
214
|
+
<a class='source-toggle' href='#' onclick='toggleCode('method-i-request_uri-source'); return false'>
|
|
215
|
+
[show source]
|
|
216
|
+
</a>
|
|
217
|
+
<pre id='method-i-request_uri-source'><span class="ruby-comment"># File lib/gnip_api/response.rb, line 19</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">request_uri</span>
 <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">uri</span>
<span class="ruby-keyword">end</span></pre>
|
|
218
|
+
</div>
|
|
219
|
+
</div>
|
|
220
|
+
</div>
|
|
221
|
+
</div>
|
|
222
|
+
|
|
223
|
+
</div>
|
|
224
|
+
</div>
|
|
225
|
+
|
|
226
|
+
<div id='footer-push'></div>
|
|
227
|
+
</div>
|
|
228
|
+
<div id='footer'>
|
|
229
|
+
<a href="https://github.com/rdoc/hanna-nouveau"><strong>Hanna Nouveau</strong> RDoc template</a>
|
|
230
|
+
</div>
|
|
231
|
+
</body>
|
|
232
|
+
</html>
|