1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: YADIS</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">YADIS</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/yadis/yadis_rb.html">
lib/yadis/yadis.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
High level class for performing the Yadis protocol on a given URL. The <a
href="YADIS.html#M000012">YADIS.discover</a> class method is a good place
to get started in determining which services a URL supports.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000013">ca_path=</a>
<a href="#M000012">discover</a>
<a href="#M000016">filter_services</a>
<a href="#M000014">new</a>
<a href="#M000015">services</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="attribute-list">
<h3 class="section-bar">Attributes</h3>
<div class="name-list">
<table>
<tr class="top-aligned-row context-row">
<td class="context-item-name">uri</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">xrds</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">xrds_uri</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc"></td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000013" class="method-detail">
<a name="M000013"></a>
<div class="method-heading">
<a href="YADIS.src/M000013.html" target="Code" class="method-signature"
onclick="popupCode('YADIS.src/M000013.html');return false;">
<span class="method-name">ca_path=</span><span class="method-args">(ca_path)</span>
</a>
</div>
<div class="method-description">
<p>
Set the path to a certificate authority pem file, for verifying server
certificates of HTTPS pages. If you are interested in verifying certs like
the mozilla web browser, have a look at the files here:
</p>
<p>
<a
href="http://curl.haxx.se/docs/caextract.html">curl.haxx.se/docs/caextract.html</a>
</p>
</div>
</div>
<div id="method-M000012" class="method-detail">
<a name="M000012"></a>
<div class="method-heading">
<a href="YADIS.src/M000012.html" target="Code" class="method-signature"
onclick="popupCode('YADIS.src/M000012.html');return false;">
<span class="method-name">discover</span><span class="method-args">(uri)</span>
</a>
</div>
<div class="method-description">
<p>
Discover services for a given URI. Please note that no normalization will
be done to the passed in URI, it should be a textually valid URI string
before calling discover.
</p>
<p>
Returns nil if no <a href="XRDS.html">XRDS</a> was found, or a <a
href="YADIS.html">YADIS</a> object on success. This method is essentially
the same as <a href="YADIS.html#M000014">YADIS.new</a>, but does not raise
any exceptions.
</p>
</div>
</div>
<div id="method-M000014" class="method-detail">
<a name="M000014"></a>
<div class="method-heading">
<a href="YADIS.src/M000014.html" target="Code" class="method-signature"
onclick="popupCode('YADIS.src/M000014.html');return false;">
<span class="method-name">new</span><span class="method-args">(uri)</span>
</a>
</div>
<div class="method-description">
<p>
Discover services for a URI using the Yadis protocol. <tt>uri</tt> should
be a valid URI represented as a string. This method may raise <a
href="YADISParseError.html">YADISParseError</a> in the case of an invalid
or unparsable <a href="XRDS.html">XRDS</a> file, or <a
href="YADISHTTPError.html">YADISHTTPError</a> is the URI cannot be fetched.
</p>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000016" class="method-detail">
<a name="M000016"></a>
<div class="method-heading">
<a href="YADIS.src/M000016.html" target="Code" class="method-signature"
onclick="popupCode('YADIS.src/M000016.html');return false;">
<span class="method-name">filter_services</span><span class="method-args">(filter)</span>
</a>
</div>
<div class="method-description">
<p>
Returns a list of services, ordered by priority, that match the filter.
filter is a Proc object that produces ServiceEnpoint objects, subclasses of
ServiceEnpoint or nil. This method is useful for extracting several types
of services while maintaining priority, for example you may write a filter
Proc to extract OpenID and LID ServiceEnpoint objects.
</p>
</div>
</div>
<div id="method-M000015" class="method-detail">
<a name="M000015"></a>
<div class="method-heading">
<a href="YADIS.src/M000015.html" target="Code" class="method-signature"
onclick="popupCode('YADIS.src/M000015.html');return false;">
<span class="method-name">services</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns an Array Service objects sorted by priority.
</p>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|
