laco-www-delicious 0.3.2

data/CHANGELOG.rdoc

@@ -0,0 +1,61 @@
+= Changelog
+
+
+== julienXX release 0.3.1
+
+* FIXED: tags are now written in del.icio.us
+
+== master
+
+* FIXED: A trivial bug causes the test `test_request_waits_necessary_time_between_requests` to fail in case the subsequent request is sent exactly 1 second after the prior one.
+
+* FIXED: Object#blank? is always redefined regardless already defined before.
+
+
+== Release 0.3.0
+
+* FIXED: Compatibility fixes for Ruby 1.9. WWW::Delicious is now 100% compatible with 1.9. You should remember to define the proper content encoding with magic comments when working with UTF-8/MultiByte XML or Ruby files, see http://redmine.ruby-lang.org/wiki/ruby-19/ScriptEncoding (closes #142).
+
+* FIXED: Forced Rakefile to require Echoe >= 3.1 to prevent outdated .gemspec files (closes #143).
+
+* CHANGED: Don't use File.dirname(__FILE__) in require statement to prevent recursive inclusions.
+
+
+== Release 0.2.0
+
+* ADDED: :base_uri initialization option allows to create a new instance specifying a custom base_uri for all API calls. This is useful, for example, if you want to use ma.gno.lia Mirror'd APIs (http://wiki.ma.gnolia.com/Mirror%27d_API) instead the del.icio.us one (thanks to Jörg Battermann).
+
+* ADDED: two new REXML::Element core extension elements to enhance interaction with node elements.
+
+* FIXED: a wrong indentation in README file causes all list items to be rendered as source code.
+
+* FIXED: Missing WWW::Delicious::Bundle#to_s method causes a class ID representation to be returned.
+
+* FIXED: Missing unit tests for post_ calls (closes #18).
+
+* FIXED: Added test for `shared` Post attribute and fixed an issue with duplicate `replace` method definition (closes #11).
+
+* CHANGED: improved documentation and added more examples (closes #21).
+
+* CHANGED: REXML::Element#attribute_value core extension has been renamed to REXML::Element#if_attribute_value.
+
+* CHANGED: Renamed TESTCASE_PATH to TESTCASES_PATH.
+
+* CHANGED: WWW::Delicious::Tag, WWW::Delicious::Bundle, WWW::Delicious::Post now extend WWW::Delicious::Element. Simplified classes.
+
+* CHANGED: WWW::Delicious::Tag#to_s always returns a string even if name is nil.
+
+* CHANGED: WWW::Delicious::Tag :count attribute is now stored and returned as Fixnum instead of String.
+
+* CHANGED: Unit test reorganization (closes #22).
+
+* CHANGED: Simplified and tidyfied test system with Mocha (closes #19).
+
+* CHANGED: Various internal API methods have been renamed for coherence with their new scope.
+
+* CHANGED: Integrated Echoe, cleaned Rakefile (closes #23).
+
+
+== Release 0.1.0 (2008-05-11)
+
+* Initial public release.

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://gemcutter.org"
+source "http://gems.github.com"
+
+gem 'rake'
+gem 'echoe', '>= 3.1'
+gem 'mocha'
+gem 'gemcutter'

data/LICENSE.rdoc

@@ -0,0 +1,25 @@
+= License
+
+(The MIT License)
+
+Copyright (c) 2008-2009 Simone Carletti <weppos@weppos.net>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Manifest

@@ -0,0 +1,47 @@
+CHANGELOG.rdoc
+Gemfile
+LICENSE.rdoc
+Manifest
+README.rdoc
+Rakefile
+lib/www/delicious.rb
+lib/www/delicious/bundle.rb
+lib/www/delicious/element.rb
+lib/www/delicious/errors.rb
+lib/www/delicious/post.rb
+lib/www/delicious/tag.rb
+lib/www/delicious/version.rb
+setup.rb
+test/bundle_test.rb
+test/delicious_test.rb
+test/fixtures/net_response_invalid_account.yml
+test/fixtures/net_response_success.yml
+test/online_test.rb
+test/post_test.rb
+test/tag_test.rb
+test/test_all.rb
+test/test_helper.rb
+test/testcases/element/bundle.xml
+test/testcases/element/invalid_root.xml
+test/testcases/element/post.xml
+test/testcases/element/post_unshared.xml
+test/testcases/element/tag.xml
+test/testcases/response/bundles_all.xml
+test/testcases/response/bundles_all_empty.xml
+test/testcases/response/bundles_delete.xml
+test/testcases/response/bundles_set.xml
+test/testcases/response/bundles_set_error.xml
+test/testcases/response/posts_add.xml
+test/testcases/response/posts_all.xml
+test/testcases/response/posts_dates.xml
+test/testcases/response/posts_dates_with_tag.xml
+test/testcases/response/posts_delete.xml
+test/testcases/response/posts_get.xml
+test/testcases/response/posts_get_with_tag.xml
+test/testcases/response/posts_recent.xml
+test/testcases/response/posts_recent_with_tag.xml
+test/testcases/response/tags_get.xml
+test/testcases/response/tags_get_empty.xml
+test/testcases/response/tags_rename.xml
+test/testcases/response/update.delicious1.xml
+test/testcases/response/update.xml

data/README.rdoc

@@ -0,0 +1,201 @@
+= WWW::Delicious
+
+WWW::Delicious is a Ruby client for http://del.icio.us XML API.
+
+It provides both read and write functionality. You can read user Posts, Tags
+and Bundles but you can create new Posts, Tags and Bundles as well.
+
+
+== Overview
+
+WWW::Delicious maps all the original del.icio.us API calls and provides some
+additional convenient methods to perform common tasks.
+Please read the official documentation (http://del.icio.us/help/api/)
+to learn more about del.icio.us API.
+
+WWW::Delicious is 100% compatible with all del.icio.us API constraints,
+including the requirement to set a valid user agent or wait at least
+one second between queries.
+Basically, the main benefit from using this library is that you don't need
+to take care of all these low level details, if you don't want:
+WWW::Delicious will try to give you the most with less efforts.
+
+
+== Dependencies
+
+* Ruby >= 1.8.6 (not tested with previous versions)
+
+As of release 0.3.0, WWW::Delicious is compatible with Ruby 1.9.1.
+
+
+== Download and Installation
+
+RubyGems[http://rubyforge.org/projects/rubygems/] is the preferred install method.
+To get the latest version, simply type the following instruction into your command prompt:
+
+  $ sudo gem install www-delicious
+  
+Depending on your system, you might need su privileges.
+
+To install the library manually, downlad the latest version from 
+navigate to the root library directory and enter:
+
+  $ sudo ruby setup.rb
+
+If you need the latest development version you can download the source code
+from one of the GIT repositories listed above.
+Beware that the code might not be as stable as the official release.
+
+
+== Getting Started
+
+In order to use this library you need a valid del.icio.us account.
+Go to http://del.icio.us and register for a new account if you don't already have one.
+
+Then create a valid instance of WWW::Delicious providing your account credentials.
+
+  require 'www/delicious'
+  
+  # create a new instance with given username and password
+  d = WWW::Delicious.new('username', 'password')
+  
+Now you can use your instance to interact with the API interface.
+
+
+=== Last account update
+
+The following example show you how to get the last account update Time.
+
+  require 'www/delicious'
+  d = WWW::Delicious.new('username', 'password')
+  
+  time = d.update # => Fri May 02 18:02:48 UTC 2008
+
+
+=== Reading Posts
+
+You can fetch your posts in 3 different ways:
+
+  require 'www/delicious'
+  d = WWW::Delicious.new('username', 'password')
+
+  # 1. get all posts
+  posts = d.posts_all
+  
+  # 2. get recent posts
+  posts = d.posts_recent
+  
+  # 3. get a single post (the latest one if no criteria is given)
+  posts = d.posts_get(:tag => 'ruby')
+
+Each post call accepts some options to refine your search.
+For example, you can always search for posts matching a specific tag.
+
+  posts = d.posts_all(:tag => 'ruby')
+  posts = d.posts_recent(:tag => 'ruby')
+  posts = d.posts_get(:tag => 'ruby')
+
+
+=== Creating a new Post
+
+  require 'www/delicious'
+  d = WWW::Delicious.new('username', 'password')
+  
+  # add a post from options
+  d.posts_add(:url => 'http://www.simonecarletti.com/', :title => 'Cool site!')
+  
+  # add a post from WWW::Delicious::Post
+  d.posts_add(WWW::Delicious::Post.new(:url => 'http://www.simonecarletti.com/', :title => 'Cool site!'))
+
+
+=== Deleting a Posts
+
+  require 'www/delicious'
+  d = WWW::Delicious.new('username', 'password')
+  
+  # delete given post (the URL can be either a string or an URI)
+  d.posts_delete('http://www.foobar.com/')
+
+Note. Actually you cannot delete a post from a WWW::Delicious::Post instance.
+It means, the following example doesn't work as some ActiveRecord user might expect.
+
+  post = WWW::Delicious::Post.new(:url => 'http://www.foobar.com/')
+  post.delete
+
+This feature is already in the TODO list. For now, use the following workaround
+to delete a given Post.
+
+  # delete a post from an existing post = WWW::Delicious::Post
+  d.posts_delete(post.url)
+
+
+=== Tags
+
+Working with tags it's really easy. You can get all your tags or rename an existing tag.
+
+  require 'www/delicious'
+  d = WWW::Delicious.new('username', 'password')
+  
+  # get all tags
+  tags = d.tags_get
+  
+  # print all tag names
+  tags.each { |t| puts t.name }
+  
+  # rename the tag gems to gem
+  d.tags_rename('gems', 'gem')
+
+
+=== Bundles
+
+WWW::Delicious enables you to get all bundles from given account.
+
+  require 'www/delicious'
+  d = WWW::Delicious.new('username', 'password')
+  
+  # get all bundles
+  bundles = d.bundles_all
+  
+  # print all bundle names
+  bundles.each { |b| puts b.name } 
+
+You can also create new bundles or delete existing ones.
+
+  require 'www/delicious'
+  d = WWW::Delicious.new('username', 'password')
+  
+  # set a new bundle for tags ruby, rails and gem
+  d.bundles_set('MyBundle', %w(ruby rails gem))
+  
+  # delete the old bundle
+  d.bundles_delete('OldBundle')
+
+
+== Credits
+
+Author:: {Simone Carletti}[http://www.simonecarletti.com/] <weppos@weppos.net>
+
+
+== Resources
+
+* {Homepage}[http://code.simonecarletti.com/www-delicious]
+* {API}[http://www-delicious.rubyforge.org/]
+* {GitHub}[http://github.com/weppos/www-delicious/]
+* {RubyForge}[http://rubyforge.org/projects/www-delicious/]
+
+
+== FeedBack and Bug reports
+
+Feel free to email {Simone Carletti}[mailto:weppos@weppos.net] with any questions or feedback.
+Please use the {Ticket System}[http://code.simonecarletti.com/projects/show/www-delicious] to submit bug reports or feature request.
+
+
+== Changelog
+
+See the CHANGELOG.rdoc file for details.
+
+
+== License
+
+Copyright (c) 2008-2009 Simone Carletti, WWW::Delicious is released under the MIT license. 
+

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+gem     'echoe', '>= 3.1'
+require 'echoe'
+
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'www/delicious'
+
+
+# Common package properties
+PKG_NAME    = ENV['PKG_NAME']    || WWW::Delicious::GEM
+PKG_VERSION = ENV['PKG_VERSION'] || WWW::Delicious::VERSION
+PKG_SUMMARY = "Ruby client for del.icio.us API."
+PKG_FILES   = FileList.new("{lib,test}/**/*.rb") do |files|
+  files.include %w(README.rdoc CHANGELOG.rdoc LICENSE.rdoc)
+  files.include %w(Rakefile setup.rb)
+end
+RUBYFORGE_PROJECT = 'laco-www-delicious'
+
+if ENV['SNAPSHOT'].to_i == 1
+  PKG_VERSION << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
+end
+ 
+ 
+Echoe.new(PKG_NAME, PKG_VERSION) do |p|
+  p.author        = "Simone Carletti"
+  p.email         = "weppos@weppos.net"
+  p.summary       = PKG_SUMMARY
+  p.description   = <<-EOD
+    WWW::Delicious is a del.icio.us API client implemented in Ruby. \
+    It provides access to all available del.icio.us API queries \
+    and returns the original XML response as a friendly Ruby object.
+  EOD
+  p.url           = "http://code.simonecarletti.com/www-delicious"
+  p.project       = RUBYFORGE_PROJECT
+
+  p.need_zip      = true
+  p.rcov_options  = ["--main << README.rdoc -x Rakefile -x mocha -x rcov"]
+  p.rdoc_pattern  = /^(lib|CHANGELOG.rdoc|README.rdoc)/
+
+  p.development_dependencies += ["rake  >=0.8",
+                                 "echoe >=3.1",
+                                 "mocha >=0.9"]
+end
+
+
+begin
+  require 'code_statistics'
+  desc "Show library's code statistics"
+  task :stats do
+    CodeStatistics.new(["WWW::Delicious", "lib"],
+                       ["Tests", "test"]).to_s
+  end
+rescue LoadError
+  puts "CodeStatistics (Rails) is not available"
+end

data/laco-www-delicious.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{laco-www-delicious}
+  s.version = "0.3.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Simone Carletti"]
+  s.date = %q{2010-05-11}
+  s.description = %q{    WWW::Delicious is a del.icio.us API client implemented in Ruby.     It provides access to all available del.icio.us API queries     and returns the original XML response as a friendly Ruby object.
+}
+  s.email = %q{weppos@weppos.net}
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "README.rdoc", "lib/www/delicious.rb", "lib/www/delicious/bundle.rb", "lib/www/delicious/element.rb", "lib/www/delicious/errors.rb", "lib/www/delicious/post.rb", "lib/www/delicious/tag.rb", "lib/www/delicious/version.rb"]
+  s.files = ["CHANGELOG.rdoc", "Gemfile", "LICENSE.rdoc", "Manifest", "README.rdoc", "Rakefile", "lib/www/delicious.rb", "lib/www/delicious/bundle.rb", "lib/www/delicious/element.rb", "lib/www/delicious/errors.rb", "lib/www/delicious/post.rb", "lib/www/delicious/tag.rb", "lib/www/delicious/version.rb", "setup.rb", "test/bundle_test.rb", "test/delicious_test.rb", "test/fixtures/net_response_invalid_account.yml", "test/fixtures/net_response_success.yml", "test/online_test.rb", "test/post_test.rb", "test/tag_test.rb", "test/test_all.rb", "test/test_helper.rb", "test/testcases/element/bundle.xml", "test/testcases/element/invalid_root.xml", "test/testcases/element/post.xml", "test/testcases/element/post_unshared.xml", "test/testcases/element/tag.xml", "test/testcases/response/bundles_all.xml", "test/testcases/response/bundles_all_empty.xml", "test/testcases/response/bundles_delete.xml", "test/testcases/response/bundles_set.xml", "test/testcases/response/bundles_set_error.xml", "test/testcases/response/posts_add.xml", "test/testcases/response/posts_all.xml", "test/testcases/response/posts_dates.xml", "test/testcases/response/posts_dates_with_tag.xml", "test/testcases/response/posts_delete.xml", "test/testcases/response/posts_get.xml", "test/testcases/response/posts_get_with_tag.xml", "test/testcases/response/posts_recent.xml", "test/testcases/response/posts_recent_with_tag.xml", "test/testcases/response/tags_get.xml", "test/testcases/response/tags_get_empty.xml", "test/testcases/response/tags_rename.xml", "test/testcases/response/update.delicious1.xml", "test/testcases/response/update.xml", "laco-www-delicious.gemspec"]
+  s.homepage = %q{http://code.simonecarletti.com/www-delicious}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Laco-www-delicious", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{laco-www-delicious}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby client for del.icio.us API.}
+  s.test_files = ["test/test_all.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, [">= 0.8"])
+      s.add_development_dependency(%q<echoe>, [">= 3.1"])
+      s.add_development_dependency(%q<mocha>, [">= 0.9"])
+    else
+      s.add_dependency(%q<rake>, [">= 0.8"])
+      s.add_dependency(%q<echoe>, [">= 3.1"])
+      s.add_dependency(%q<mocha>, [">= 0.9"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0.8"])
+    s.add_dependency(%q<echoe>, [">= 3.1"])
+    s.add_dependency(%q<mocha>, [">= 0.9"])
+  end
+end

data/lib/www/delicious/bundle.rb

@@ -0,0 +1,73 @@
+# 
+# = WWW::Delicious
+#
+# Ruby client for del.icio.us API.
+# 
+#
+# Category::    WWW
+# Package::     WWW::Delicious
+# Author::      Simone Carletti <weppos@weppos.net>
+# License::     MIT License
+#
+#--
+#
+#++
+
+
+require 'www/delicious/element'
+
+
+module WWW
+  class Delicious
+
+    #
+    # = Delicious Bundle
+    # 
+    # Represents a single Bundle element.
+    #
+    class Bundle < Element
+      
+      # The name of the bundle.
+      attr_accessor :name
+      
+      # The collection of <tt>WWW::Delicious::Tags</tt>.
+      attr_accessor :tags
+      
+      
+      # Returns value for <tt>name</tt> attribute.
+      # Value is always normalized as lower string.
+      def name
+        @name.to_s.strip unless @name.nil?
+      end
+      
+      #
+      # Returns a string representation of this Bundle.
+      # In case name is nil this method will return an empty string.
+      #
+      def to_s
+        name.to_s
+      end
+      
+      
+      class << self
+
+        # 
+        # Creates and returns new instance from a REXML +element+.
+        # 
+        # Implements Element#from_rexml.
+        # 
+        def from_rexml(element)
+          raise ArgumentError, "`element` expected to be a `REXML::Element`" unless element.kind_of? REXML::Element
+          self.new do |instance|
+            instance.name  = element.if_attribute_value(:name)
+            # FIXME: value must be converted to array of Tag
+            instance.tags  = element.if_attribute_value(:tags) { |value| value.split(' ') }
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/www/delicious/element.rb

@@ -0,0 +1,73 @@
+# 
+# = WWW::Delicious
+#
+# Ruby client for del.icio.us API.
+# 
+#
+# Category::    WWW
+# Package::     WWW::Delicious
+# Author::      Simone Carletti <weppos@weppos.net>
+# License::     MIT License
+#
+#--
+#
+#++
+
+
+module WWW
+  class Delicious
+
+    # 
+    # = Abstract structure
+    # 
+    # Represent the most basic structure all Struc(s) must inherith from.
+    # 
+    class Element
+      
+      #
+      # Initializes a new instance and populate attributes from +attrs+.
+      # 
+      #   class User < Element
+      #     attr_accessor :first_name
+      #     attr_accessor :last_name
+      #   end
+      # 
+      #   User.new
+      #   User.new(:first_name => 'foo')
+      #   User.new(:first_name => 'John', :last_name => 'Doe')
+      # 
+      # You can even use a block.
+      # The following statements are equals:
+      # 
+      #   User.new(:first_name => 'John', :last_name => 'Doe')
+      # 
+      #   User.new do |user|
+      #     user.first_name => 'John'
+      #     user.last_name  => 'Doe'
+      #   end
+      # 
+      # Warning. In order to set an attribute a valid attribute writer must be available,
+      # otherwise this method will raise an exception.
+      #
+      def initialize(attrs = {}, &block)
+        attrs.each { |key, value| self.send("#{key}=".to_sym, value) }
+        yield self if block_given?
+        self
+      end
+      
+      
+      class << self
+        
+        # 
+        # Creates and returns new instance from a REXML +element+.
+        # 
+        def from_rexml(element, options)
+          raise NotImplementedError
+        end
+        
+      end
+      
+    end
+    
+  end
+end

data/lib/www/delicious/errors.rb

@@ -0,0 +1,46 @@
+# 
+# = WWW::Delicious
+#
+# Ruby client for del.icio.us API.
+# 
+#
+# Category::    WWW
+# Package::     WWW::Delicious
+# Author::      Simone Carletti <weppos@weppos.net>
+# License::     MIT License
+#
+#--
+#
+#++
+
+
+module WWW
+  class Delicious
+
+    
+    #
+    # = WWW::Delicious::Error
+    # 
+    # Base exception for all WWW::Delicious errors.
+    #
+    class Error < StandardError; end
+
+    #
+    # = WWW::Delicious::HTTPError
+    # 
+    # HTTP connection related error.
+    # Raised when an HTTP request fails or in case of unexpected behavior.
+    #
+    class HTTPError < Error; end
+
+    #
+    # = WWW::Delicious::ResponseError
+    # 
+    # Response related error.
+    # Usually raised in case of a malformed, invalid or empty XML response.
+    #
+    class ResponseError < Error; end
+    
+    
+  end
+end