atom 0.1

data/lib/atom.rb

@@ -0,0 +1,171 @@
+#
+# Copyright (c) 2006 Martin Traverso
+#
+# 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.
+# 
+
+require 'xmlmapping'
+require 'time'
+
+module Atom
+	NAMESPACE = 'http://www.w3.org/2005/Atom' 
+
+	class Person
+		include XMLMapping
+
+		namespace NAMESPACE
+
+		has_one :name
+		has_one :email
+		has_one :uri
+
+		def to_s
+			name
+		end
+	end
+
+	class Generator
+		include XMLMapping
+
+		namespace NAMESPACE
+
+		has_attribute :uri
+		has_attribute :version
+		text :value
+
+		def to_s
+			value
+		end
+	end
+
+	class Link
+		include XMLMapping
+
+		namespace NAMESPACE
+
+		has_attribute :href
+		has_attribute :rel
+		has_attribute :type
+		has_attribute :hreflang
+		has_attribute :title
+		has_attribute :length
+
+		def to_s
+			href
+		end
+	end
+
+	class Category
+		include XMLMapping
+
+		namespace NAMESPACE
+
+		has_attribute :term
+		has_attribute :scheme
+		has_attribute :label
+
+		def to_s
+			term
+		end
+	end
+
+	class Content
+		include XMLMapping
+
+		namespace NAMESPACE
+
+		has_attribute :type
+		has_attribute :src
+		text :value
+
+		def to_s
+			value || src
+		end
+	end
+
+	class Source
+		include XMLMapping
+
+		namespace NAMESPACE
+
+		has_many :authors, :name => 'author', :type => Person
+		has_many :categories, :name => 'category', :type => Category
+		has_one :generator, :type => Generator
+		has_one :icon
+		has_many :links, :name => 'link', :type => Link
+		has_one :logo
+		has_one :rights
+		has_one :subtitle
+		has_one :title
+		has_one :updated, :transform => lambda { |t| Time.iso8601(t) }
+	end
+
+	class Entry
+		include XMLMapping
+
+		namespace NAMESPACE
+
+		has_one :id
+		has_one :title
+		has_one :summary
+		has_many :authors, :name => 'author', :type => Person 
+		has_many :contributors, :name => 'contributor', :type => Person 
+		has_one :published, :transform => lambda { |t| Time.iso8601(t) }
+		has_one :updated, :transform => lambda { |t| Time.iso8601(t) }
+		has_many :links, :name => 'link', :type => Link
+		has_many :category, :name => 'category', :type => Category
+		has_one :content, :type => Content
+		has_one :source, :type => Source
+	end
+
+	class Feed 
+		include XMLMapping
+
+		namespace NAMESPACE
+
+		has_one :id
+		has_one :title
+		has_one :subtitle
+		has_many :authors, :name => 'author', :type => Person
+		has_many :contributors, :name => 'contributor', :type => Person
+		has_many :entries, :name => 'entry', :type => Entry
+		has_one :generator, :type => Generator
+		has_many :links, :name => 'link', :type => Link
+		has_one :updated, :transform => lambda { |t| Time.iso8601(t) }
+
+		has_one :rights
+		has_one :icon
+		has_one :logo
+		has_many :categories, :name => 'category', :type => Category
+	end
+end
+		
+
+if $0 == __FILE__ 
+	require 'net/http'
+	require 'uri'
+
+	str = Net::HTTP::get(URI::parse('http://blog.ning.com/atom.xml'))
+	feed = Atom::Feed.new(str)
+
+	feed.entries.each { |entry|
+		puts "'#{entry.title}' by #{entry.authors[0].name} on #{entry.published.strftime('%m/%d/%Y')}"
+	}
+end

data/lib/xmlmapping.rb

@@ -0,0 +1,156 @@
+#
+# Copyright (c) 2006 Martin Traverso
+#
+# 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.
+#
+
+require 'rexml/document'
+
+module XMLMapping
+	def self.included(mod)
+		mod.extend(ClassMethods)
+		mod.instance_variable_set("@attributes", {})
+		mod.instance_variable_set("@elements", {})
+		mod.instance_variable_set("@text_attribute", nil)
+	end
+
+	def initialize(input)
+		if input.respond_to? :to_str
+			root = REXML::Document.new(input).root
+		elsif input.respond_to?(:node_type) && input.node_type == :document
+			root = input.root
+		elsif input.respond_to?(:node_type) && input.node_type == :element
+			root = input
+		else 
+			raise "Invalid input: #{input}"
+		end
+
+		namespace = self.class.default_namespace
+		attributes = self.class.attributes
+		elements = self.class.elements
+		text_attribute = self.class.text_attribute
+
+		if !text_attribute.nil?
+			name = text_attribute[0]
+			options = text_attribute[1]
+			value = root.text
+
+			if options.has_key? :transform
+				value = options[:transform].call(value)
+			end
+
+			instance_variable_set("@#{name}", value)
+		else
+			# initialize :many attributes
+			elements.select { |k, v|
+				v[:cardinality] == :many
+			}.each { |k, v|
+				instance_variable_set("@#{v[:attribute]}", [])
+			}
+
+			root.each_element { |e| 
+				if e.namespace == namespace && elements.has_key?(e.name.to_sym)
+					options = elements[e.name.to_sym]
+
+					if options.has_key? :type
+							value = options[:type].new(e)	
+					else
+							value = e.text
+					end
+
+					if options.has_key? :transform
+						value = options[:transform].call(value)
+					end
+
+					attribute = options[:attribute]
+
+					existing = instance_variable_get("@#{attribute}")
+					case options[:cardinality]
+						when :one 
+							raise "Found more than one #{e.name}" if !existing.nil?
+							instance_variable_set("@#{attribute}", value)
+						when :many 
+							existing << value
+					end		
+				end
+			}
+		end
+
+		root.attributes.each_attribute { |a|
+			if a.namespace == namespace && attributes.has_key?(a.name.to_sym)
+				options = attributes[a.name.to_sym]
+
+				value = a.value
+				if options.has_key? :transform
+					value = options[:transform].call(value)
+				end
+
+				instance_variable_set("@#{a.name}", value)
+			end
+		}
+	end
+
+	module ClassMethods
+		attr :attributes
+		attr :elements
+		attr :text_attribute
+		attr :default_namespace
+
+		def namespace(namespace)
+			@default_namespace = namespace
+		end
+
+		def has_one(attribute, options = {})
+			attr attribute
+			options[:cardinality] = :one
+			options[:attribute] = attribute
+			
+			name = attribute
+			if options.has_key? :name
+				name = options[:name].to_sym
+			end
+
+			@elements[name] = options
+		end
+
+		def has_many(attribute, options = {})
+			attr attribute
+			options[:cardinality] = :many
+			options[:attribute] = attribute
+
+			name = attribute
+			if options.has_key? :name
+				name = options[:name].to_sym
+			end
+
+			@elements[name] = options
+		end
+
+		def has_attribute(attribute, options = {})
+			attr attribute
+			@attributes[attribute] = options
+		end	
+
+		def text(attribute, options = {})
+			attr attribute
+			@text_attribute = [attribute, options]
+		end
+	end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: atom
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2006-04-06 00:00:00 -07:00
+summary: Ruby library for working with the Atom syndication format
+require_paths: 
+- lib
+email: mtraverso@acm.org
+homepage: http://http://rubyforge.org/projects/atom/
+rubyforge_project: 
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Martin Traverso
+files: 
+- lib/atom.rb
+- lib/xmlmapping.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+