/usr/share/doc/librubilicious-ruby1.8/doc/classes/Rubilicious.html is in librubilicious-ruby1.8 0.1.4-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 | <?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: Rubilicious</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">Rubilicious</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/rubilicious_rb.html">
rubilicious.rb
</a>
(<a href="http://cvs.pablotron.org/cgi-bin/viewcvs.cgi/rubilicious/rubilicious.rb">CVS</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>
<a href="Rubilicious.html">Rubilicious</a> - Delicious (<a
href="http://del.icio.us">del.icio.us</a>/) bindings for Ruby.
</p>
<p>
You‘ll need to create an account at Delicious (<a
href="http://del.icio.us">del.icio.us</a>/) in order to use this API.
</p>
<p>
Simple Examples:
</p>
<pre>
# connect to delicious and get a list of your recent posts
r = Rubilicious.new('user', 'password')
r.recent.each do |post|
puts "#{post['desc']}: #{post['href']}"
end
# add a new link to delicious
r.add('http://pablotron.org/', 'Pablotron.org')
# save recent funny posts to an XBEL file
File::open('funny_links.xbel', 'w') do |file|
file.puts r.recent('funny').to_xbel
end
</pre>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000009">add</a>
<a href="#M000018">all</a>
<a href="#M000025">all_posts</a>
<a href="#M000005">dates</a>
<a href="#M000010">delete</a>
<a href="#M000012">inbox</a>
<a href="#M000013">inbox_dates</a>
<a href="#M000004">new</a>
<a href="#M000007">posts</a>
<a href="#M000008">recent</a>
<a href="#M000011">rename</a>
<a href="#M000021">rename_tag</a>
<a href="#M000015">sub</a>
<a href="#M000014">subs</a>
<a href="#M000023">subscribe</a>
<a href="#M000022">subscriptions</a>
<a href="#M000006">tags</a>
<a href="#M000019">to_xbel</a>
<a href="#M000016">unsub</a>
<a href="#M000024">unsubscribe</a>
<a href="#M000017">update</a>
<a href="#M000020">user_posts</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="constants-list">
<h3 class="section-bar">Constants</h3>
<div class="name-list">
<table summary="Constants">
<tr class="top-aligned-row context-row">
<td class="context-item-name">VERSION</td>
<td>=</td>
<td class="context-item-value">'0.1.4'</td>
</tr>
</table>
</div>
</div>
<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">base_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">use_proxy</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">user</td>
<td class="context-item-value"> [R] </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-M000004" class="method-detail">
<a name="M000004"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000004.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000004.html');return false;">
<span class="method-name">new</span><span class="method-args">(user, pass)</span>
</a>
</div>
<div class="method-description">
<p>
Connect to del.icio.us with username ‘user’ and password
‘pass’.
</p>
<p>
Note: if the username or password is incorrect, <a
href="Rubilicious.html">Rubilicious</a> will not raise an exception until
you make an actual call.
</p>
<p>
Example:
</p>
<pre>
r = Rubilicious.new('pabs', 'password')
</pre>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000009" class="method-detail">
<a name="M000009"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000009.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000009.html');return false;">
<span class="method-name">add</span><span class="method-args">(url, desc, ext = '', tags = '', time = Time.now)</span>
</a>
</div>
<div class="method-description">
<p>
Post a link to delicious, along with an optional extended description, tags
(as a space-delimited list), and a timestamp.
</p>
<p>
Raises an exception on error.
</p>
<p>
Example:
</p>
<pre>
# add a link to pablotron to delicious
r.add('http://pablotron.org/',
'Pablotron.org : The most popular site on Internet?')
# add a link to paulduncan.org to delicious with an extended
# description
r.add('http://paulduncan.org/', "Paul Duncan", "Damn he's smooth!")
# add a link with an extended description and some tags
r.add('http://raggle.org/',
'Raggle', 'Console RSS Aggregator, written in Ruby.',
'rss programming ruby console xml')
</pre>
</div>
</div>
<div id="method-M000018" class="method-detail">
<a name="M000018"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000018.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000018.html');return false;">
<span class="method-name">all</span><span class="method-args">(tag = nil)</span>
</a>
</div>
<div class="method-description">
<p>
Return an array of all your posts ever, optionally filtered by tag.
</p>
<p>
WARNING: This method can generate a large request to del.icio.us, and
should be used sparingly, and at your own risk.
</p>
<p>
Raises an exception on error.
</p>
<p>
Example:
</p>
<pre>
# save all 'art' posts to file "art_posts.txt"
art_posts = r.all('art')
File::open('art_posts.txt', 'w') do |file|
file.puts art_posts.sort do |a, b|
a['time'] <=> b['time']
end.map { |post| post['href'] }
end
</pre>
</div>
</div>
<div id="method-M000025" class="method-detail">
<a name="M000025"></a>
<div class="method-heading">
<span class="method-name">all_posts</span><span class="method-args">(tag = nil)</span>
</div>
<div class="method-description">
<p>
Alias for <a href="Rubilicious.html#M000018">all</a>
</p>
</div>
</div>
<div id="method-M000005" class="method-detail">
<a name="M000005"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000005.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000005.html');return false;">
<span class="method-name">dates</span><span class="method-args">(tag = nil)</span>
</a>
</div>
<div class="method-description">
<p>
Returns a list of dates with the number of posts at each date. If a tag is
given, return a list of dates with the number of posts with the specified
tag at each date.
</p>
<p>
Raises an exception on error.
</p>
<p>
Examples:
</p>
<pre>
dates = r.dates
puts "date,count"
dates.keys.sort.each do |date|
puts "#{date},#{dates[date]}"
end
# same as above, but only display 'politics' tags
dates = r.dates('politics')
puts "date,count",
dates.map { |args| args.join(',') }.join("\n")
</pre>
</div>
</div>
<div id="method-M000010" class="method-detail">
<a name="M000010"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000010.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000010.html');return false;">
<span class="method-name">delete</span><span class="method-args">(url)</span>
</a>
</div>
<div class="method-description">
<p>
Delete a link from Delicious.
</p>
<p>
Raises an exception on error.
</p>
<p>
Example:
</p>
<pre>
# delete a link to example.com from delicious
r.delete('http://example.com/')
</pre>
</div>
</div>
<div id="method-M000012" class="method-detail">
<a name="M000012"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000012.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000012.html');return false;">
<span class="method-name">inbox</span><span class="method-args">(date = nil)</span>
</a>
</div>
<div class="method-description">
<p>
Returns a array of inbox entries, optionally filtered by date.
</p>
<p>
Raises an exception on error.
</p>
<p>
Example:
</p>
<pre>
# print a list of posts and who posted them
r.inbox.each { |post| puts "#{post['user']},#{post['href']}" }
</pre>
</div>
</div>
<div id="method-M000013" class="method-detail">
<a name="M000013"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000013.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000013.html');return false;">
<span class="method-name">inbox_dates</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns a hash of dates containing inbox entries.
</p>
<p>
Raises an exception on error.
</p>
<p>
Example:
</p>
<pre>
# print out a list of the 10 busiest inbox dates
dates = r.inbox_dates
puts dates.keys.sort { |a, b| dates[b] <=> dates[a] }.slice(0, 10)
</pre>
</div>
</div>
<div id="method-M000007" class="method-detail">
<a name="M000007"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000007.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000007.html');return false;">
<span class="method-name">posts</span><span class="method-args">(date = nil, tag = nil)</span>
</a>
</div>
<div class="method-description">
<p>
Returns an array of posts on a given date, filtered by tag. If no date is
supplied, most recent date will be used.
</p>
<p>
Raises an exception on error.
</p>
<p>
Examples:
</p>
<pre>
# print out a list of recent links from oldest to newest.
posts = r.posts
posts.sort { |a, b| a['time'] <=> b['time'] }.each do |post|
puts post['href']
end
# print out a list of link descriptions from the date '2004-09-22'
posts = r.posts('2004-09-22')
posts.sort { |a, b| a['description'] <=> b['description'] }
posts.each { |post| puts post['description'] }
</pre>
</div>
</div>
<div id="method-M000008" class="method-detail">
<a name="M000008"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000008.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000008.html');return false;">
<span class="method-name">recent</span><span class="method-args">(tag = nil, count = nil)</span>
</a>
</div>
<div class="method-description">
<p>
Returns an array of the most recent posts, optionally filtered by tag.
</p>
<p>
Raises an exception on error.
</p>
<p>
Example:
</p>
<pre>
# get the most recent links
recent_links = r.recent.map { |post| post['href'] }
# get the 10 most recent 'music' links
recent_links = r.recent('music', 10).map { |post| post['href'] }
</pre>
</div>
</div>
<div id="method-M000011" class="method-detail">
<a name="M000011"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000011.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000011.html');return false;">
<span class="method-name">rename</span><span class="method-args">(old, new)</span>
</a>
</div>
<div class="method-description">
<p>
Renames tags across all posts.
</p>
<p>
Note: Delicious has currently disabled this feature, so it will not work
until they reenable it.
</p>
<p>
Raises an exception on error.
</p>
<p>
Example:
</p>
<pre>
# rename tag "rss" to "xml"
r.rename('rss', 'xml')
</pre>
</div>
</div>
<div id="method-M000021" class="method-detail">
<a name="M000021"></a>
<div class="method-heading">
<span class="method-name">rename_tag</span><span class="method-args">(old, new)</span>
</div>
<div class="method-description">
<p>
Alias for <a href="Rubilicious.html#M000011">rename</a>
</p>
</div>
</div>
<div id="method-M000015" class="method-detail">
<a name="M000015"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000015.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000015.html');return false;">
<span class="method-name">sub</span><span class="method-args">(user, tag = nil)</span>
</a>
</div>
<div class="method-description">
<p>
Add a subscription, optionally to a specific tag.
</p>
<p>
Raises an exception on error.
</p>
<p>
Example:
</p>
<pre>
# subscribe to 'humor' links from solarce
r.sub('solarce', 'humor')
</pre>
</div>
</div>
<div id="method-M000014" class="method-detail">
<a name="M000014"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000014.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000014.html');return false;">
<span class="method-name">subs</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns a hash of your subscriptions.
</p>
<p>
Raises an exception on error.
</p>
<p>
Example:
</p>
<pre>
# print out a list of subscriptions
subs = r.subs
puts "user:tags"
subs.keys.sort.each do |sub|
puts "#{sub}:#{subs[sub].join(' ')}"
end
</pre>
</div>
</div>
<div id="method-M000023" class="method-detail">
<a name="M000023"></a>
<div class="method-heading">
<span class="method-name">subscribe</span><span class="method-args">(user, tag = nil)</span>
</div>
<div class="method-description">
<p>
Alias for <a href="Rubilicious.html#M000015">sub</a>
</p>
</div>
</div>
<div id="method-M000022" class="method-detail">
<a name="M000022"></a>
<div class="method-heading">
<span class="method-name">subscriptions</span><span class="method-args">()</span>
</div>
<div class="method-description">
<p>
Alias for <a href="Rubilicious.html#M000014">subs</a>
</p>
</div>
</div>
<div id="method-M000006" class="method-detail">
<a name="M000006"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000006.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000006.html');return false;">
<span class="method-name">tags</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns a hash of tags and the number of times they’ve been used.
</p>
<p>
Raises an exception on error.
</p>
<p>
Example:
</p>
<pre>
tags = r.tags
puts tags.keys.sort.map { |tag| "#{tag},#{tags[tag]}" }.join("\n")
</pre>
</div>
</div>
<div id="method-M000019" class="method-detail">
<a name="M000019"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000019.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000019.html');return false;">
<span class="method-name">to_xbel</span><span class="method-args">(tag = nil)</span>
</a>
</div>
<div class="method-description">
<p>
Return an XBEL string of all your posts, optionally filtered by tag.
</p>
<p>
WARNING: This method can generate a large number of requests to
del.icio.us, and could be construed as abuse. Use sparingly, and at your
own risk.
</p>
<p>
Raises an exception on error.
</p>
<p>
Example:
</p>
<pre>
# save all posts ever in XBEL format to file "delicious.xbel"
File::open('delicious.xbel', 'w') do |file|
file.puts r.to_xbel
end
</pre>
</div>
</div>
<div id="method-M000016" class="method-detail">
<a name="M000016"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000016.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000016.html');return false;">
<span class="method-name">unsub</span><span class="method-args">(user, tag = nil)</span>
</a>
</div>
<div class="method-description">
<p>
Removes a subscription, optionally only a specific tag.
</p>
<p>
Raises an exception on error.
</p>
<p>
Example:
</p>
<pre>
# unsubscribe from all links from giblet
r.unsub('giblet')
</pre>
</div>
</div>
<div id="method-M000024" class="method-detail">
<a name="M000024"></a>
<div class="method-heading">
<span class="method-name">unsubscribe</span><span class="method-args">(user, tag = nil)</span>
</div>
<div class="method-description">
<p>
Alias for <a href="Rubilicious.html#M000016">unsub</a>
</p>
</div>
</div>
<div id="method-M000017" class="method-detail">
<a name="M000017"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000017.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000017.html');return false;">
<span class="method-name">update</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Return the last update time.
</p>
<p>
Note: this method should be used before calling methods like .posts or .all
to conserve on bandwidth.
</p>
<p>
Example:
</p>
<pre>
t = r.update #=> "Fri Mar 11 02:45:51 EST 2005"
</pre>
</div>
</div>
<div id="method-M000020" class="method-detail">
<a name="M000020"></a>
<div class="method-heading">
<a href="Rubilicious.src/M000020.html" target="Code" class="method-signature"
onclick="popupCode('Rubilicious.src/M000020.html');return false;">
<span class="method-name">user_posts</span><span class="method-args">(user, tag = nil)</span>
</a>
</div>
<div class="method-description">
<p>
Return all of a user’s posts, optionally filtered by tag.
</p>
<p>
WARNING: This method can generate a large number of requests to
del.icio.us, and could be construed as abuse. Use sparingly, and at your
own risk.
</p>
<p>
Raises an exception on error.
</p>
<p>
Example:
</p>
<pre>
# save all posts every by 'delineator' to XBEL format to file
# "delineator.xbel"
File::open('delineator.xbel', 'w') do |file|
file.puts r.user_posts('delineator').to_xbel
end
</pre>
</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>
|