/usr/lib/ruby/1.8/www/delicious.rb is in libwww-delicious-ruby1.8 0.3.0-1.
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 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 | #
# = WWW::Delicious
#
# Ruby client for del.icio.us API.
#
#
# Category:: WWW
# Package:: WWW::Delicious
# Author:: Simone Carletti <weppos@weppos.net>
# License:: MIT License
#
#--
# SVN: $Id$
#++
require 'net/https'
require 'rexml/document'
require 'time'
require 'www/delicious/bundle'
require 'www/delicious/post'
require 'www/delicious/tag'
require 'www/delicious/errors'
require 'www/delicious/version'
module WWW #:nodoc:
#
# = WWW::Delicious
#
# WWW::Delicious is a Ruby client for http://del.icio.us XML API.
#
# It provides both read and write functionalities.
# You can read user Posts, Tags and Bundles
# but you can create new Posts, Tags and Bundles as well.
#
#
# == Basic Usage
#
# The following is just a basic demonstration of the main features.
# See the README file for a deeper explanation about how to get the best
# from WWW::Delicious library.
#
# The examples in this page make the following assumptions
# * you have a valid del.icio.us account
# * +username+ is your account username
# * +password+ is your account password
#
# In order to make a query you first need to create
# a new WWW::Delicious instance as follows:
#
# require 'www/delicious'
#
# username = 'my delicious username'
# password = 'my delicious password'
#
# d = WWW::Delicious.new(username, password)
#
# The constructor accepts some additional options.
# For instance, if you want to customize the user agent:
#
# d = WWW::Delicious.new(username, password, :user_agent => 'FooAgent')
#
# Now you can use any of the API methods available.
#
# For example, you may want to know when your account was last updated
# to check whether someone else made some changes on behalf of you:
#
# datetime = d.update # => Wed Mar 12 08:41:20 UTC 2008
#
# Because the answer is a valid +Time+ instance, you can format it with +strftime+.
#
# datetime = d.update # => Wed Mar 12 08:41:20 UTC 2008
# datetime.strftime('%Y') # => 2008
#
class Delicious
NAME = 'WWW::Delicious'
GEM = 'www-delicious'
AUTHOR = 'Simone Carletti <weppos@weppos.net>'
# del.icio.us account username
attr_reader :username
# del.icio.us account password
attr_reader :password
# base URI for del.icio.us API
attr_reader :base_uri
# API Base URL
API_BASE_URI = 'https://api.del.icio.us'
# API Path Update
API_PATH_UPDATE = '/v1/posts/update';
# API Path All Bundles
API_PATH_BUNDLES_ALL = '/v1/tags/bundles/all';
# API Path Set Bundle
API_PATH_BUNDLES_SET = '/v1/tags/bundles/set';
# API Path Delete Bundle
API_PATH_BUNDLES_DELETE = '/v1/tags/bundles/delete';
# API Path Get Tags
API_PATH_TAGS_GET = '/v1/tags/get';
# API Path Rename Tag
API_PATH_TAGS_RENAME = '/v1/tags/rename';
# API Path Get Posts
API_PATH_POSTS_GET = '/v1/posts/get';
# API Path Recent Posts
API_PATH_POSTS_RECENT = '/v1/posts/recent';
# API Path All Posts
API_PATH_POSTS_ALL = '/v1/posts/all';
# API Path Posts by Dates
API_PATH_POSTS_DATES = '/v1/posts/dates';
# API Path Add Post
API_PATH_POSTS_ADD = '/v1/posts/add';
# API Path Delete Post
API_PATH_POSTS_DELETE = '/v1/posts/delete';
# Time to wait before sending a new request, in seconds
SECONDS_BEFORE_NEW_REQUEST = 1
# Time converter converts a Time instance into the format
# requested by Delicious API
TIME_CONVERTER = lambda { |time| time.iso8601() }
#
# Constructs a new <tt>WWW::Delicious</tt> object
# with given +username+ and +password+.
#
# # create a new object with username 'user' and password 'psw
# obj = WWW::Delicious('user', 'psw')
# # => self
#
# If a block is given, the instance is passed to the block
# but this method always returns the instance itself.
#
# WWW::Delicious('user', 'psw') do |d|
# d.update() # => Fri May 02 18:02:48 UTC 2008
# end
# # => self
#
# You can also specify some additional options, including a custom user agent
# or the base URI for del.icio.us API.
#
# WWW::Delicious('user', 'psw', :base_uri => 'https://ma.gnolia.com/api/mirrord') do |d|
# # the following call is mirrored by ma.gnolia
# d.update() # => Fri May 02 18:02:48 UTC 2008
# end
# # => self
#
# === Options
# This class accepts a Hash with additional options.
# Here's the list of valid keys:
#
# <tt>:user_agent</tt>:: User agent to display in HTTP requests.
# <tt>:base_uri</tt>:: The base URI to del.icio.us API.
#
def initialize(username, password, options = {}, &block) # :yields: delicious
@username, @password = username.to_s, password.to_s
# set API base URI
@base_uri = URI.parse(options[:base_uri] || API_BASE_URI)
init_user_agent(options)
init_http_client(options)
yield self if block_given?
self # ensure to always return self even if block is given
end
#
# Returns the reference to current <tt>@http_client</tt>.
# The http is always valid unless it has been previously set to +nil+.
#
# # nil client
# obj.http_client # => nil
#
# # valid client
# obj.http_client # => Net::HTTP
#
def http_client()
return @http_client
end
#
# Sets the internal <tt>@http_client</tt> to +client+.
#
# # nil client
# obj.http_client = nil
#
# # http client
# obj.http_client = Net::HTTP.new()
#
# # invalid client
# obj.http_client = 'foo' # => ArgumentError
#
def http_client=(client)
unless client.kind_of?(Net::HTTP) or client.nil?
raise ArgumentError, "`client` expected to be a kind of `Net::HTTP`, `#{client.class}` given"
end
@http_client = client
end
# Returns current user agent string.
def user_agent()
return @headers['User-Agent']
end
#
# Returns true if given account credentials are valid.
#
# d = WWW::Delicious.new('username', 'password')
# d.valid_account? # => true
#
# d = WWW::Delicious.new('username', 'invalid_password')
# d.valid_account? # => false
#
# This method is not "exception safe".
# It doesn't return false if an HTTP error or any kind of other error occurs,
# it raises back the exception to the caller instead.
#
#
# Raises:: WWW::Delicious::Error
# Raises:: WWW::Delicious::HTTPError
# Raises:: WWW::Delicious::ResponseError
#
def valid_account?
update()
return true
rescue HTTPError => e
return false if e.message =~ /invalid username or password/i
raise
end
#
# Checks to see when a user last posted an item
# and returns the last update +Time+ for the user.
#
# d.update() # => Fri May 02 18:02:48 UTC 2008
#
#
# Raises:: WWW::Delicious::Error
# Raises:: WWW::Delicious::HTTPError
# Raises:: WWW::Delicious::ResponseError
#
def update()
response = request(API_PATH_UPDATE)
return parse_update_response(response.body)
end
#
# Retrieves all of a user's bundles
# and returns an array of <tt>WWW::Delicious::Bundle</tt>.
#
# d.bundles_all() # => [#<WWW::Delicious::Bundle>, #<WWW::Delicious::Bundle>, ...]
# d.bundles_all() # => []
#
#
# Raises:: WWW::Delicious::Error
# Raises:: WWW::Delicious::HTTPError
# Raises:: WWW::Delicious::ResponseError
#
def bundles_all()
response = request(API_PATH_BUNDLES_ALL)
return parse_bundle_collection(response.body)
end
#
# Assignes a set of tags to a single bundle,
# wipes away previous settings for bundle.
#
# # create from a bundle
# d.bundles_set(WWW::Delicious::Bundle.new('MyBundle'), %w(foo bar))
#
# # create from a string
# d.bundles_set('MyBundle', %w(foo bar))
#
#
# Raises:: WWW::Delicious::Error
# Raises:: WWW::Delicious::HTTPError
# Raises:: WWW::Delicious::ResponseError
#
def bundles_set(bundle_or_name, tags = [])
params = prepare_bundles_set_params(bundle_or_name, tags)
response = request(API_PATH_BUNDLES_SET, params)
return parse_and_eval_execution_response(response.body)
end
#
# Deletes +bundle_or_name+ bundle from del.icio.us.
# +bundle_or_name+ can be either a WWW::Delicious::Bundle instance
# or a string with the name of the bundle.
#
# This method doesn't care whether the exists.
# If not, the execution will silently return without rising any error.
#
# # delete from a bundle
# d.bundles_delete(WWW::Delicious::Bundle.new('MyBundle'))
#
# # delete from a string
# d.bundles_delete('MyBundle', %w(foo bar))
#
#
# Raises:: WWW::Delicious::Error
# Raises:: WWW::Delicious::HTTPError
# Raises:: WWW::Delicious::ResponseError
#
def bundles_delete(bundle_or_name)
params = prepare_bundles_delete_params(bundle_or_name)
response = request(API_PATH_BUNDLES_DELETE, params)
return parse_and_eval_execution_response(response.body)
end
#
# Retrieves the list of tags and number of times used by the user
# and returns an array of <tt>WWW::Delicious::Tag</tt>.
#
# d.tags_get() # => [#<WWW::Delicious::Tag>, #<WWW::Delicious::Tag>, ...]
# d.tags_get() # => []
#
#
# Raises:: WWW::Delicious::Error
# Raises:: WWW::Delicious::HTTPError
# Raises:: WWW::Delicious::ResponseError
#
def tags_get()
response = request(API_PATH_TAGS_GET)
return parse_tag_collection(response.body)
end
#
# Renames an existing tag with a new tag name.
#
# # rename from a tag
# d.bundles_set(WWW::Delicious::Tag.new('old'), WWW::Delicious::Tag.new('new'))
#
# # rename from a string
# d.bundles_set('old', 'new')
#
#
# Raises:: WWW::Delicious::Error
# Raises:: WWW::Delicious::HTTPError
# Raises:: WWW::Delicious::ResponseError
#
def tags_rename(from_name_or_tag, to_name_or_tag)
params = prepare_tags_rename_params(from_name_or_tag, to_name_or_tag)
response = request(API_PATH_TAGS_RENAME, params)
return parse_and_eval_execution_response(response.body)
end
#
# Returns an array of <tt>WWW::Delicious::Post</tt> matching +options+.
# If no option is given, the last post is returned.
# If no date or url is given, most recent date will be used.
#
# d.posts_get() # => [#<WWW::Delicious::Post>, #<WWW::Delicious::Post>, ...]
# d.posts_get() # => []
#
# # get all posts tagged with ruby
# d.posts_get(:tag => WWW::Delicious::Tag.new('ruby))
#
# # get all posts matching URL 'http://www.simonecarletti.com'
# d.posts_get(:url => URI.parse('http://www.simonecarletti.com'))
#
# # get all posts tagged with ruby and matching URL 'http://www.simonecarletti.com'
# d.posts_get(:tag => WWW::Delicious::Tag.new('ruby),
# :url => URI.parse('http://www.simonecarletti.com'))
#
#
# === Options
# <tt>:tag</tt>:: a tag to filter by. It can be either a <tt>WWW::Delicious::Tag</tt> or a +String+.
# <tt>:dt</tt>:: a +Time+ with a date to filter by.
# <tt>:url</tt>:: a valid URI to filter by. It can be either an instance of +URI+ or a +String+.
#
# Raises:: WWW::Delicious::Error
# Raises:: WWW::Delicious::HTTPError
# Raises:: WWW::Delicious::ResponseError
#
def posts_get(options = {})
params = prepare_posts_params(options.clone, [:dt, :tag, :url])
response = request(API_PATH_POSTS_GET, params)
return parse_post_collection(response.body)
end
#
# Returns a list of the most recent posts, filtered by argument.
#
# # get the most recent posts
# d.posts_recent()
#
# # get the 10 most recent posts
# d.posts_recent(:count => 10)
#
#
# === Options
# <tt>:tag</tt>:: a tag to filter by. It can be either a <tt>WWW::Delicious::Tag</tt> or a +String+.
# <tt>:count</tt>:: number of items to retrieve. (default: 15, maximum: 100).
#
def posts_recent(options = {})
params = prepare_posts_params(options.clone, [:count, :tag])
response = request(API_PATH_POSTS_RECENT, params)
return parse_post_collection(response.body)
end
#
# Returns a list of all posts, filtered by argument.
#
# # get all (this is a very expensive query)
# d.posts_all
#
# # get all posts matching ruby
# d.posts_all(:tag => WWW::Delicious::Tag.new('ruby'))
#
#
# === Options
# <tt>:tag</tt>:: a tag to filter by. It can be either a <tt>WWW::Delicious::Tag</tt> or a +String+.
#
def posts_all(options = {})
params = prepare_posts_params(options.clone, [:tag])
response = request(API_PATH_POSTS_ALL, params)
return parse_post_collection(response.body)
end
#
# Returns a list of dates with the number of posts at each date.
#
# # get number of posts per date
# d.posts_dates
# # => { '2008-05-05' => 12, '2008-05-06' => 3, ... }
#
# # get number posts per date tagged as ruby
# d.posts_dates(:tag => WWW::Delicious::Tag.new('ruby'))
# # => { '2008-05-05' => 10, '2008-05-06' => 3, ... }
#
#
# === Options
# <tt>:tag</tt>:: a tag to filter by. It can be either a <tt>WWW::Delicious::Tag</tt> or a +String+.
#
def posts_dates(options = {})
params = prepare_posts_params(options.clone, [:tag])
response = request(API_PATH_POSTS_DATES, params)
return parse_posts_dates_response(response.body)
end
#
# Add a post to del.icio.us.
# +post_or_values+ can be either a +WWW::Delicious::Post+ instance
# or a Hash of params. This method accepts all params available
# to initialize a new +WWW::Delicious::Post+.
#
# # add a post from WWW::Delicious::Post
# d.posts_add(WWW::Delicious::Post.new(:url => 'http://www.foobar.com', :title => 'Hello world!'))
#
# # add a post from values
# d.posts_add(:url => 'http://www.foobar.com', :title => 'Hello world!')
#
#
def posts_add(post_or_values)
params = prepare_param_post(post_or_values).to_params
response = request(API_PATH_POSTS_ADD, params)
return parse_and_eval_execution_response(response.body)
end
#
# Deletes the post matching given +url+ from del.icio.us.
# +url+ can be either an URI instance or a string representation of a valid URL.
#
# This method doesn't care whether a post with given +url+ exists.
# If not, the execution will silently return without rising any error.
#
# # delete a post from URI
# d.post_delete(URI.parse('http://www.foobar.com/'))
#
# # delete a post from a string
# d.post_delete('http://www.foobar.com/')
#
#
def posts_delete(url)
params = prepare_posts_params({:url => url}, [:url])
response = request(API_PATH_POSTS_DELETE, params)
return parse_and_eval_execution_response(response.body)
end
protected
# Initializes the HTTP client.
# It automatically enable +use_ssl+ flag according to +@base_uri+ scheme.
def init_http_client(options)
http = Net::HTTP.new(@base_uri.host, 443)
http.use_ssl = true if @base_uri.scheme == "https"
http.verify_mode = OpenSSL::SSL::VERIFY_NONE # FIXME: not 100% supported
self.http_client = http
end
# Initializes user agent value for HTTP requests.
def init_user_agent(options)
user_agent = options[:user_agent] || default_user_agent()
@headers ||= {}
@headers['User-Agent'] = user_agent
end
#
# Creates and returns the default user agent string.
#
# By default, the user agent is composed by the following schema:
# <tt>NAME/VERSION (Ruby/RUBY_VERSION)</tt>
#
# * +NAME+ is the constant representing this library name
# * +VERSION+ is the constant representing current library version
# * +RUBY_VERSION+ is the version of Ruby interpreter the library is interpreted by
#
# default_user_agent
# # => WWW::Delicious/0.1.0 (Ruby/1.8.6)
#
def default_user_agent
return "#{NAME}/#{VERSION} (Ruby/#{RUBY_VERSION})"
end
#
# Composes an HTTP query string from an hash of +options+.
# The result is URI encoded.
#
# http_build_query(:foo => 'baa', :bar => 'boo')
# # => foo=baa&bar=boo
#
def http_build_query(params = {})
return params.collect do |k,v|
"#{URI.encode(k.to_s)}=#{URI.encode(v.to_s)}" unless v.nil?
end.compact.join('&')
end
#
# Sends an HTTP GET request to +path+ and appends given +params+.
#
# This method is 100% compliant with Delicious API reference.
# It waits at least 1 second between each HTTP request and
# provides an identifiable user agent by default,
# or the custom user agent set by +user_agent+ option
# when this istance has been created.
#
# request('/v1/api/path', :foo => 1, :bar => 2)
# # => sends a GET request to /v1/api/path?foo=1&bar=2
#
def request(path, params = {})
raise Error, 'Invalid HTTP Client' unless http_client
wait_before_new_request
uri = @base_uri.merge(path)
uri.query = http_build_query(params) unless params.empty?
begin
@last_request = Time.now # see #wait_before_new_request
@last_request_uri = uri # useful for debug
response = make_request(uri)
rescue => e # catch EOFError, SocketError and more
raise HTTPError, e.message
end
case response
when Net::HTTPSuccess
return response
when Net::HTTPUnauthorized # 401
raise HTTPError, 'Invalid username or password'
when Net::HTTPServiceUnavailable # 503
raise HTTPError, 'You have been throttled.' +
'Please ensure you are waiting at least one second before each request.'
else
raise HTTPError, "HTTP #{response.code}: #{response.message}"
end
end
# Makes the real HTTP request to given +uri+ and returns the +response+.
# This method exists basically to simplify unit testing with mocha.
def make_request(uri)
http_client.start do |http|
req = Net::HTTP::Get.new(uri.request_uri, @headers)
req.basic_auth(@username, @password)
http.request(req)
end
end
#
# Delicious API reference requests to wait AT LEAST ONE SECOND
# between queries or the client is likely to get automatically throttled.
#
# This method calculates the difference between current time
# and the last request time and wait for the necessary time to meet
# SECONDS_BEFORE_NEW_REQUEST requirement.
#
# The difference is not rounded. If you only have to wait for 0.034 seconds
# then your don't have to wait 0 or 1 seconds, but 0.034 seconds!
#
def wait_before_new_request
return unless @last_request # this is the first request
# puts "Last request at #{TIME_CONVERTER.call(@last_request)}" if debug?
diff = Time.now - @last_request
if diff < SECONDS_BEFORE_NEW_REQUEST
# puts "Sleeping for #{diff} before new request..." if debug?
sleep(SECONDS_BEFORE_NEW_REQUEST - diff)
end
end
#
# Parses the response <tt>body</tt> and runs a common set of validators.
# Returns <tt>body</tt> as parsed REXML::Document on success.
#
# Raises:: WWW::Delicious::ResponseError in case of invalid response.
#
def parse_and_validate_response(body, options = {})
dom = REXML::Document.new(body)
if (value = options[:root_name]) && dom.root.name != value
raise ResponseError, "Invalid response, root node is not `#{value}`"
end
if (value = options[:root_text]) && dom.root.text != value
raise ResponseError, value
end
return dom
end
#
# Parses and evaluates the response returned by an execution,
# usually an update/delete/insert operation.
#
# Raises:: WWW::Delicious::ResponseError in case of invalid response
# Raises:: WWW::Delicious::Error in case of execution error
#
def parse_and_eval_execution_response(body)
dom = parse_and_validate_response(body, :root_name => 'result')
response = dom.root.if_attribute_value(:code)
response = dom.root.text if response.nil?
raise Error, "Invalid response, #{response}" unless %w(done ok).include?(response)
true
end
# Parses the response of an Update request
# and returns the update Timestamp.
def parse_update_response(body)
dom = parse_and_validate_response(body, :root_name => 'update')
dom.root.if_attribute_value(:time) { |v| Time.parse(v) }
end
# Parses a response containing a collection of Bundles
# and returns an array of <tt>WWW::Delicious::Bundle</tt>.
def parse_bundle_collection(body)
dom = parse_and_validate_response(body, :root_name => 'bundles')
dom.root.elements.collect('bundle') { |xml| Bundle.from_rexml(xml) }
end
# Parses a response containing a collection of Tags
# and returns an array of <tt>WWW::Delicious::Tag</tt>.
def parse_tag_collection(body)
dom = parse_and_validate_response(body, :root_name => 'tags')
dom.root.elements.collect('tag') { |xml| Tag.from_rexml(xml) }
end
# Parses a response containing a collection of Posts
# and returns an array of <tt>WWW::Delicious::Post</tt>.
def parse_post_collection(body)
dom = parse_and_validate_response(body, :root_name => 'posts')
dom.root.elements.collect('post') { |xml| Post.from_rexml(xml) }
end
# Parses the response of a <tt>posts_dates</tt> request
# and returns a +Hash+ of date => count.
def parse_posts_dates_response(body)
dom = parse_and_validate_response(body, :root_name => 'dates')
return dom.root.get_elements('date').inject({}) do |collection, xml|
date = xml.if_attribute_value(:date)
count = xml.if_attribute_value(:count)
collection.merge({ date => count })
end
end
#
# Prepares the params for a `bundles_set` call
# and returns a Hash with the params ready for the HTTP request.
#
# Raises:: WWW::Delicious::Error
#
def prepare_bundles_set_params(name_or_bundle, tags = [])
bundle = prepare_param_bundle(name_or_bundle, tags) do |b|
raise Error, "Bundle name is empty" if b.name.empty?
raise Error, "Bundle must contain at least one tag" if b.tags.empty?
end
return { :bundle => bundle.name, :tags => bundle.tags.join(' ') }
end
#
# Prepares the params for a `bundles_set` call
# and returns a Hash with the params ready for the HTTP request.
#
# Raises:: WWW::Delicious::Error
#
def prepare_bundles_delete_params(name_or_bundle)
bundle = prepare_param_bundle(name_or_bundle) do |b|
raise Error, "Bundle name is empty" if b.name.empty?
end
return { :bundle => bundle.name }
end
#
# Prepares the params for a `tags_rename` call
# and returns a Hash with the params ready for the HTTP request.
#
# Raises:: WWW::Delicious::Error
#
def prepare_tags_rename_params(from_name_or_tag, to_name_or_tag)
from, to = [from_name_or_tag, to_name_or_tag].collect do |v|
prepare_param_tag(v)
end
return { :old => from, :new => to }
end
#
# Prepares the params for a `post_*` call
# and returns a Hash with the params ready for the HTTP request.
#
# Raises:: WWW::Delicious::Error
#
def prepare_posts_params(params, allowed_params = [])
compare_params(params, allowed_params)
# we don't need to check whether the following parameters
# are valid for this request because compare_params
# would raise if an invalid param is supplied
params[:tag] = prepare_param_tag(params[:tag]) if params[:tag]
params[:dt] = TIME_CONVERTER.call(params[:dt]) if params[:dt]
params[:url] = URI.parse(params[:url]) if params[:url]
params[:count] = if value = params[:count]
raise Error, 'Expected `count` <= 100' if value.to_i() > 100 # requirement
value.to_i
else
15 # default value
end
return params
end
#
# Prepares the +post+ param for an API request.
#
# Creates and returns a <tt>WWW::Delicious::Post</tt> instance from <tt>post_or_values</tt>.
# <tt>post_or_values</tt> can be either an Hash with post attributes
# or a <tt>WWW::Delicious::Post</tt> instance.
#
def prepare_param_post(post_or_values, &block)
post = case post_or_values
when WWW::Delicious::Post
post_or_values
when Hash
Post.new(post_or_values)
else
raise ArgumentError, 'Expected `args` to be `WWW::Delicious::Post` or `Hash`'
end
yield(post) if block_given?
# TODO: validate post with post.validate!
raise ArgumentError, 'Both `url` and `title` are required' unless post.api_valid?
post
end
#
# Prepares the +bundle+ param for an API request.
#
# Creates and returns a <tt>WWW::Delicious::Bundle</tt> instance from <tt>name_or_bundle</tt>.
# <tt>name_or_bundle</tt> can be either a string holding bundle name
# or a <tt>WWW::Delicious::Bundle</tt> instance.
#
def prepare_param_bundle(name_or_bundle, tags = [], &block) # :yields: bundle
bundle = case name_or_bundle
when WWW::Delicious::Bundle
name_or_bundle
else
Bundle.new(:name => name_or_bundle, :tags => tags)
end
yield(bundle) if block_given?
# TODO: validate bundle with bundle.validate!
bundle
end
#
# Prepares the +tag+ param for an API request.
#
# Creates and returns a <tt>WWW::Delicious::Tag</tt> instance from <tt>name_or_tag</tt>.
# <tt>name_or_tag</tt> can be either a string holding tag name
# or a <tt>WWW::Delicious::Tag</tt> instance.
#
def prepare_param_tag(name_or_tag, &block) # :yields: tag
tag = case name_or_tag
when WWW::Delicious::Tag
name_or_tag
else
Tag.new(:name => name_or_tag.to_s)
end
yield(tag) if block_given?
# TODO: validate tag with tag.validate!
raise "Invalid `tag` value supplied" unless tag.api_valid?
tag
end
#
# Checks whether user given +params+ are valid against a defined collection of +valid_params+.
#
# === Examples
#
# params = {:foo => 1, :bar => 2}
#
# compare_params(params, [:foo, :bar])
# # => valid
#
# compare_params(params, [:foo, :bar, :baz])
# # => raises
#
# compare_params(params, [:foo])
# # => raises
#
# Raises:: WWW::Delicious::Error
#
def compare_params(params, valid_params)
raise ArgumentError, "Expected `params` to be a kind of `Hash`" unless params.kind_of?(Hash)
raise ArgumentError, "Expected `valid_params` to be a kind of `Array`" unless valid_params.kind_of?(Array)
# compute options difference
difference = params.keys - valid_params
raise Error, "Invalid params: `#{difference.join('`, `')}`" unless difference.empty?
end
module XMLUtils #:nodoc:
#
# Returns the +xmlattr+ attribute value for current <tt>REXML::Element</tt>.
#
# If block is given and attribute value is not nil,
# the content of the block is executed.
#
# === Examples
#
# dom = REXML::Document.new('<a name="1"><b>foo</b><b>bar</b></a>')
#
# dom.root.if_attribute_value(:name)
# # => "1"
#
# dom.root.if_attribute_value(:name) { |v| v.to_i }
# # => 1
#
# dom.root.if_attribute_value(:foo)
# # => nil
#
# dom.root.if_attribute_value(:name) { |v| v.to_i }
# # => nil
#
def if_attribute_value(xmlattr, &block) #:nodoc:
value = if attr = self.attribute(xmlattr.to_s)
attr.value
else
nil
end
value = yield value if !value.nil? and block_given?
value
end
#
# Returns the value of +expression+ child of this element, if it exists.
# If blog is given, block is called on +expression+ element value
# and the result is returned.
#
def if_element_value(expression, &block)
if_element(expression) do |element|
value = element.text
value = yield value if block_given?
value
end
end
#
# Executes the content of +block+ on +expression+
# child of this element, if it exists.
# Returns the result or +nil+ if +xmlelement+ doesn't exist.
#
def if_element(expression, &block)
raise LocalJumpError, "no block given" unless block_given?
if element = self.elements[expression.to_s]
yield element
else
nil
end
end
end # XMLUtils
end
end
class Object
# An object is blank if it's false, empty, or a whitespace string.
# For example, "", " ", +nil+, [], and {} are blank.
#
# This simplifies
#
# if !address.nil? && !address.empty?
#
# to
#
# if !address.blank?
#
# Object#blank? comes from the GEM ActiveSupport 2.1.
#
def blank?
respond_to?(:empty?) ? empty? : !self
end unless Object.method_defined? :blanks?
end
module REXML # :nodoc:
class Element < Parent # :nodoc:
include WWW::Delicious::XMLUtils
end
end
|