www-delicious 0.1.0 → 0.2.0

data/lib/www/delicious/bundle.rb

@@ -14,41 +14,60 @@
 #++
 
 
-module WWW #:nodoc:
+require 'www/delicious/element'
+
+
+module WWW
   class Delicious
 
-    class Bundle
+    #
+    # = Delicious Bundle
+    # 
+    # Represents a single Bundle element.
+    #
+    class Bundle < Element
       
-      # The name of the bundle
+      # The name of the bundle.
       attr_accessor :name
       
-      # The collection of <tt>WWW::Delicious::Tags</tt>
+      # The collection of <tt>WWW::Delicious::Tags</tt>.
       attr_accessor :tags
       
-      public
-      #
-      # Creates a new <tt>WWW::Delicious::Bundle</tt> with given +name+
-      # and adds given array of +tags+ to current tags collection.
-      #
-      def initialize(name, tags = [], &block) #  :yields: bundle
-        raise ArgumentError, '`tags` expected to be an Array' unless tags.kind_of?(Array)
-        
-        self.name = name.to_s()
-        self.tags = tags
-        yield(self) if block_given?
-        self
+      
+      # Returns value for <tt>name</tt> attribute.
+      # Value is always normalized as lower string.
+      def name
+        @name.to_s.strip unless @name.nil?
       end
       
-      public
       #
-      # Creates a new <tt>WWW::Delicious::Bundle</tt> from a REXML fragment.
+      # Returns a string representation of this Bundle.
+      # In case name is nil this method will return an empty string.
       #
-      def self.from_rexml(element)
-        return new(element.attribute_value(:name) { |v| v.to_s() },
-                   element.attribute_value(:tags) { |v| v.to_s().split(' ') })
+      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,72 @@
+# 
+# = WWW::Delicious
+#
+# Ruby client for del.icio.us API.
+# 
+#
+# Category::   WWW
+# Package::    WWW::Delicious
+# Subpackage:: WWW::Delicious::Post
+# Author::     Simone Carletti <weppos@weppos.net>
+#
+#--
+# SVN: $Id$
+#++
+
+
+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

@@ -13,7 +13,7 @@
 #++
 
 
-module WWW #:nodoc:
+module WWW
   class Delicious
 
     
@@ -39,7 +39,7 @@ module WWW #:nodoc:
     # Usually raised in case of a malformed, invalid or empty XML response.
     #
     class ResponseError < Error; end
-
+    
     
   end
 end

data/lib/www/delicious/post.rb

@@ -14,82 +14,68 @@
 #++
 
 
-module WWW #:nodoc:
-  class Delicious
+require 'www/delicious/element'
+
 
-    class Post
+module WWW
+  class Delicious
+    
+    class Post < Element
       
-      # TODO: filter and validate
-      attr_accessor :url, :title, :notes, :others, :uid, :tags, :time
-      attr_accessor :replace, :shared
+      # The Post URL
+      attr_accessor :url
       
-      public
-      #
-      # Creates a new <tt>WWW::Delicious::Post</tt> with given values.
-      # If +values_or_rexml+ is a REXML element, the element is parsed
-      # and all values assigned to this instance attributes.
-      #
-      def initialize(values_or_rexml, &block) #  :yields: post
-        case values_or_rexml
-          when Hash
-            initialize_from_hash(values_or_rexml)
-          when REXML::Element
-            initialize_from_rexml(values_or_rexml)
-          else
-            raise ArgumentError, 'Expected `values_or_rexml` to be `Hash` or `REXML::Element`'
-        end
-        
-        yield(self) if block_given?
-        self
-      end
+      # The title of the Post
+      attr_accessor :title
       
-      public
-      #
-      # Initializes <tt>WWW::Delicious::Post</tt> from an +Hash+.
-      #
-      def initialize_from_hash(values)
-        %w(url title notes others udi tags time shared replace).each do |v|
-          self.instance_variable_set("@#{v}".to_sym(), values[v.to_sym()])
-        end
-        self.shared  = true    if self.shared.nil?
-        self.replace = true    if self.replace.nil?
+      # The extended description for the Post
+      attr_accessor :notes
+      
+      # The number of other users who saved this Post
+      attr_accessor :others
+      
+      # The unique Id for this Post
+      attr_accessor :uid
+      
+      # Tags for this Post
+      attr_accessor :tags
+      
+      # Timestamp this Post was last saved at
+      attr_accessor :time
+      
+      # Whether this Post must replace previous version of the same Post.
+      attr_accessor :replace
+      
+      # Whether this Post is private
+      attr_accessor :shared
+      
+      
+      # Returns the value for <tt>shared</tt> attribute.
+      def shared
+        !(@shared == false)
       end
       
-      public
-      #
-      # Initializes <tt>WWW::Delicious::Post</tt> from a REXML fragment.
-      #
-      def initialize_from_rexml(element)
-        self.url    = element.attribute_value(:href) { |v| URI.parse(v) }
-        self.title  = element.attribute_value(:description)
-        self.notes  = element.attribute_value(:extended)
-        self.others = element.attribute_value(:others).to_i() # cast nil to 0
-        self.uid    = element.attribute_value(:hash)
-        self.tags   = element.attribute_value(:tag)  { |v| v.split(' ') }.to_a()
-        self.time   = element.attribute_value(:time) { |v| Time.parse(v) }
-        self.shared = element.attribute_value(:shared) { |v| v == 'no' ? false : true }
+      # Returns the value for <tt>replace</tt> attribute.
+      def replace
+        !(@replace == false)
       end
       
-      public
-      #
       # Returns a params-style representation suitable for API calls.
-      #
       def to_params()
         params = {}
-        params[:url] = self.url
-        params[:description] = self.title
-        params[:extended] = self.notes if self.notes
-        params[:shared] = self.shared
-        params[:tags] = self.tags.join(' ') if self.tags
-        params[:replace] = self.replace
-        params[:dt] = WWW::Delicious::TIME_CONVERTER.call(self.time) if self.time
-        return params
+        params[:url]          = url
+        params[:description]  = title
+        params[:extended]     = notes if notes
+        params[:shared]       = shared
+        params[:tags]         = tags.join(' ') if tags.respond_to? :join
+        params[:replace]      = replace
+        params[:dt]           = WWW::Delicious::TIME_CONVERTER.call(time) if time
+        params
       end
       
       
-      public
       #
-      # Returns wheter this object is valid for an API request.
+      # Returns whether this object is valid for an API request.
       # 
       # To be valid +url+ and +title+ must not be empty.
       # 
@@ -107,6 +93,30 @@ module WWW #:nodoc:
         return !(url.nil? or url.empty? or title.nil? or title.empty?)
       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.url    = element.if_attribute_value(:href) { |v| URI.parse(v) }
+            instance.title  = element.if_attribute_value(:description)
+            instance.notes  = element.if_attribute_value(:extended)
+            instance.others = element.if_attribute_value(:others).to_i # cast nil to 0
+            instance.uid    = element.if_attribute_value(:hash)
+            instance.tags   = element.if_attribute_value(:tag)  { |v| v.split(' ') }.to_a
+            instance.time   = element.if_attribute_value(:time) { |v| Time.parse(v) }
+            instance.shared = element.if_attribute_value(:shared) { |v| v == 'no' ? false : true }
+          end
+        end
+        
+      end
+      
     end
     
   end

data/lib/www/delicious/tag.rb

@@ -14,82 +14,45 @@
 #++
 
 
-module WWW #:nodoc:
+require 'www/delicious/element'
+
+
+module WWW
   class Delicious
 
-    class Tag
+    #
+    # = Delicious Tag
+    # 
+    # Represents a single Tag element.
+    #
+    class Tag < Element
       
-      # The name of the tag
-      attr_reader :name
+      # The name of the tag.
+      attr_accessor :name
       
       # The number of links tagged with this tag.
       # It should be set only from an API response.
-      attr_reader :count
-      
-      
-      public
-      #
-      # Creates a new <tt>WWW::Delicious::Tag</tt>.
-      #
-      def initialize(values_or_rexml, &block) # :yields: tag
-        case values_or_rexml
-        when Hash
-          initialize_from_hash(values_or_rexml)
-        when REXML::Element
-          initialize_from_rexml(values_or_rexml)
-        else
-          raise ArgumentError, 'Expected `values_or_rexml` to be `Hash` or `REXML::Element`'
-        end
-        
-        yield(self) if block_given?
-        self
-      end
-      
-      public
-      #
-      # Initializes <tt>WWW::Delicious::Tag</tt> from a REXML fragment.
-      #
-      def initialize_from_rexml(element)
-        self.name  = element.attribute_value(:tag)
-        self.count = element.attribute_value(:count)
-      end
-      
-      public
-      #
-      # Initializes <tt>WWW::Delicious::Tag</tt> from an Hash.
-      #
-      def initialize_from_hash(values)
-        self.name  = values[:name]
-        self.count = values[:count]
-      end
+      attr_accessor :count
       
       
-      public
-      #
-      # Sets +name+ for this instance to given +value+.
-      # +value+ is always cast to a +String+.
-      # 
-      # Leading and trailing whitespaces are stripped.
-      #
-      def name=(value)
-	@name = value.to_s().strip()
+      # Returns value for <tt>name</tt> attribute.
+      # Value is always normalized as lower string.
+      def name
+        @name.to_s.strip unless @name.nil?
       end
       
-      public
-      #
-      # Sets +count+ for this instance to given +value+.
-      # +value+ is always cast to +Integer+.
-      # 
-      def count=(value)
-	@count = value.to_i()
+      # Returns value for <tt>count</tt> attribute.
+      # Value is always normalized to Fixnum.
+      def count
+        @count.to_i
       end
       
-      public
       #
       # Returns a string representation of this Tag.
+      # In case name is nil this method will return an empty string.
       #
-      def to_s()
-	return self.name
+      def to_s
+        name.to_s
       end
       
       
@@ -111,7 +74,25 @@ module WWW #:nodoc:
       #   # => false
       #
       def api_valid?
-	return !name.empty?
+        return !name.empty?
+      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(:tag)
+            instance.count = element.if_attribute_value(:count) { |value| value.to_i }
+          end
+        end
+        
       end
       
     end