tinyatom 0.1.1 → 0.2.0

data/README.textile

@@ -1,26 +1,79 @@
 Aims to be the smallest, easiest to use ruby Atom feed generator.
 
-Example usage:
+Currently supports only a subset of the most frequently used Atom fields. This
+example shows everything it can do.
 
 <pre>
 <code>
-feed = TinyAtom::Feed.new('http://mysite.com/', 'My Site',
-  'http://mysite.com/atom.xml')
-feed.add_entry(1, 'entry 1', Time.now, 'http://mysite.com/1')
+require 'tinyatom'
+
+feed = TinyAtom::Feed.new(
+  'http://mysite.com/blog/',
+  'My Blog',
+  'http://mysite.com/blog/atom.xml',
+
+  # optional
+
+  :author_name => 'me',
+  :author_email => 'me@mysite.com',
+  :author_uri => 'http://mysite.com/',
+
+  :hubs => ['http://pubsubhubbub.appspot.com/']
+  )
+
+feed.add_entry(
+  1,
+  'post 1',
+  Time.now,
+  'http://mysite.com/blog/1',
+
+  # optional
+
+  :author_name => 'me',
+  :author_email => 'me@mysite.com',
+  :author_uri => 'http://mysite.com/',
+
+  :enclosure_type => 'image/png',
+  :enclosure_href => 'http://mysite.com/image.png',
+  :enclosure_title => 'photo',
+  :enclosure_length => 6227, # optional within enclosure
+
+  :via_type => 'text/html',
+  :via_href => 'http://anotherblog.com/posts/999',
+  :via_title => 'Look at this photo'
+  )
+
 puts feed.make(:indent => 2)
+# open('atom.xml', 'w') { |f| feed.make(:target => f) }
 
 <?xml version="1.0" encoding="UTF-8"?>
 <feed xmlns="http://www.w3.org/2005/Atom">
-  <title>My Site</title>
-  <link href="http://mysite.com/atom.xml" rel="self"/>
-  <updated>2010-05-18T00:19:13-04:00</updated>
-  <id>http://mysite.com/</id>
+  <title>My Blog</title>
+  <link rel="self" href="http://mysite.com/blog/atom.xml"/>
+  <updated>2010-10-06T20:34:49-04:00</updated>
+  <id>http://mysite.com/blog/</id>
+  <author>
+    <name>me</name>
+    <email>me@mysite.com</email>
+    <uri>http://mysite.com/</uri>
+  </author>
+  <link rel="hub" href="http://pubsubhubbub.appspot.com/"/>
   <entry>
-    <title>entry 1</title>
-    <link href="http://mysite.com/1"/>
-    <id>tag:mysite.com,2010-05-18:1</id>
-    <updated>Tue May 18 00:19:13 -0400 2010</updated>
+    <title>post 1</title>
+    <link href="http://mysite.com/blog/1"/>
+    <id>tag:mysite.com,2010-10-06:1</id>
+    <updated>2010-10-06T20:34:49-04:00</updated>
+    <author>
+      <name>me</name>
+      <email>me@mysite.com</email>
+      <uri>http://mysite.com/</uri>
+    </author>
+    <link type="image/png" rel="enclosure" length="6227" title="photo" href="http://mysite.com/image.png"/>
+    <link type="text/html" rel="via" title="Look at this photo" href="http://anotherblog.com/posts/999"/>
   </entry>
 </feed>
+
 </code>
 </pre>
+
+Questions and comments: "matthewm@boedicker.org":mailto:matthewm@boedicker.org

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/tinyatom/feed.rb

@@ -86,11 +86,24 @@ module TinyAtom
     end
   end
 
+  # param name => tag name
+  EnclosureOptionalAttrs = {
+    :enclosure_length => :length,
+    }
+
   # Add enclosure tags if present
   def enclosure(markup, h)
     if h[:enclosure_type] and h[:enclosure_href] and h[:enclosure_title]
+
+      options = {}
+      h.each do |k,v|
+        if EnclosureOptionalAttrs.include?(k)
+          options[EnclosureOptionalAttrs[k]] = v
+        end
+      end
+
       link(markup, 'enclosure', h[:enclosure_type], h[:enclosure_href],
-        h[:enclosure_title])
+        h[:enclosure_title], options)
     end
   end
 
@@ -102,8 +115,13 @@ module TinyAtom
   end
 
   # Create link tag
-  def link(markup, rel, type, href, title)
-    markup.link(:rel => rel, :type => type, :href => href, :title => title)
+  def link(markup, rel, type, href, title, options={})
+    markup.link({
+      :rel => rel,
+      :type => type,
+      :href => href,
+      :title => title
+      }.merge(options))
   end
 
 end

data/tinyatom.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tinyatom}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matthew M. Boedicker"]
-  s.date = %q{2010-05-18}
+  s.date = %q{2010-10-06}
   s.description = %q{Small and easy to use ruby Atom feed generator.}
   s.email = %q{matthewm@boedicker.org}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tinyatom
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Matthew M. Boedicker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-18 00:00:00 -04:00
+date: 2010-10-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency