RubyGems - atom-tools - Versions diffs - 0.9.0 - Mend

atom-tools 0.9.0

Files changed (57) hide show

data/COPYING +18 -0
data/README +103 -0
data/Rakefile +77 -0
data/bin/atom-client.rb +246 -0
data/bin/atom-server.rb~ +71 -0
data/doc/classes/Atom/App.html +217 -0
data/doc/classes/Atom/Author.html +130 -0
data/doc/classes/Atom/Category.html +128 -0
data/doc/classes/Atom/Collection.html +322 -0
data/doc/classes/Atom/Content.html +129 -0
data/doc/classes/Atom/Contributor.html +119 -0
data/doc/classes/Atom/Element.html +325 -0
data/doc/classes/Atom/Entry.html +365 -0
data/doc/classes/Atom/Feed.html +585 -0
data/doc/classes/Atom/HTTP.html +374 -0
data/doc/classes/Atom/Link.html +137 -0
data/doc/classes/Atom/Text.html +229 -0
data/doc/classes/XHTML.html +118 -0
data/doc/created.rid +1 -0
data/doc/files/README.html +213 -0
data/doc/files/lib/atom/app_rb.html +110 -0
data/doc/files/lib/atom/collection_rb.html +110 -0
data/doc/files/lib/atom/element_rb.html +109 -0
data/doc/files/lib/atom/entry_rb.html +111 -0
data/doc/files/lib/atom/feed_rb.html +112 -0
data/doc/files/lib/atom/http_rb.html +109 -0
data/doc/files/lib/atom/text_rb.html +108 -0
data/doc/files/lib/atom/xml_rb.html +110 -0
data/doc/files/lib/atom/yaml_rb.html +109 -0
data/doc/fr_class_index.html +39 -0
data/doc/fr_file_index.html +36 -0
data/doc/fr_method_index.html +62 -0
data/doc/index.html +24 -0
data/doc/rdoc-style.css +208 -0
data/lib/atom/app.rb +87 -0
data/lib/atom/collection.rb +75 -0
data/lib/atom/element.rb +277 -0
data/lib/atom/entry.rb +135 -0
data/lib/atom/feed.rb +229 -0
data/lib/atom/http.rb +132 -0
data/lib/atom/text.rb +163 -0
data/lib/atom/xml.rb +200 -0
data/lib/atom/yaml.rb +101 -0
data/setup.rb +1585 -0
data/test/conformance/order.rb +117 -0
data/test/conformance/title.rb +108 -0
data/test/conformance/updated.rb +33 -0
data/test/conformance/xhtmlcontentdiv.rb +18 -0
data/test/conformance/xmlnamespace.rb +54 -0
data/test/runtests.rb +14 -0
data/test/test_constructs.rb +91 -0
data/test/test_feed.rb +128 -0
data/test/test_general.rb +99 -0
data/test/test_http.rb +86 -0
data/test/test_protocol.rb +69 -0
data/test/test_xml.rb +353 -0
metadata +107 -0

data/doc/classes/Atom/Text.html ADDED Viewed

@@ -0,0 +1,229 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Atom::Text</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Atom::Text</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/atom/yaml_rb.html">
+                lib/atom/yaml.rb
+                </a>
+        <br />
+                <a href="../../files/lib/atom/text_rb.html">
+                lib/atom/text.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="Element.html">
+                Atom::Element
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+An <a href="Element.html">Atom::Element</a> representing a text construct.
+It has a single attribute, &quot;type&quot;, which accepts values
+&quot;text&quot;, &quot;html&quot; and &quot;xhtml&quot;
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000017">html</a>&nbsp;&nbsp;
+      <a href="#M000016">to_s</a>&nbsp;&nbsp;
+      <a href="#M000018">xml</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000017" class="method-detail">
+        <a name="M000017"></a>
+        <div class="method-heading">
+          <a href="#M000017" class="method-signature">
+          <span class="method-name">html</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+returns a string suitable for dumping into an HTML document
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000017-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/atom/text.rb, line 32</span>
+32:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">html</span>
+33:       <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-value str">&quot;type&quot;</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;xhtml&quot;</span> <span class="ruby-keyword kw">or</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-value str">&quot;type&quot;</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;html&quot;</span>
+34:         <span class="ruby-identifier">to_s</span>
+35:       <span class="ruby-keyword kw">elsif</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-value str">&quot;type&quot;</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;text&quot;</span>
+36:         <span class="ruby-constant">REXML</span><span class="ruby-operator">::</span><span class="ruby-constant">Text</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">to_s</span>).<span class="ruby-identifier">to_s</span>
+37:       <span class="ruby-keyword kw">end</span>
+38:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000016" class="method-detail">
+        <a name="M000016"></a>
+        <div class="method-heading">
+          <a href="#M000016" class="method-signature">
+          <span class="method-name">to_s</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000016-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/atom/text.rb, line 23</span>
+23:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
+24:       <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-value str">&quot;type&quot;</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;xhtml&quot;</span>
+25:         <span class="ruby-ivar">@content</span>.<span class="ruby-identifier">children</span>.<span class="ruby-identifier">to_s</span>
+26:       <span class="ruby-keyword kw">else</span>
+27:         <span class="ruby-ivar">@content</span>.<span class="ruby-identifier">to_s</span>
+28:       <span class="ruby-keyword kw">end</span>
+29:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000018" class="method-detail">
+        <a name="M000018"></a>
+        <div class="method-heading">
+          <a href="#M000018" class="method-signature">
+          <span class="method-name">xml</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+attepts to parse the content and return it as an array of REXML::Elements
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000018-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/atom/text.rb, line 41</span>
+41:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">xml</span>
+42:       <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-value str">&quot;type&quot;</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;xhtml&quot;</span>
+43:         <span class="ruby-ivar">@content</span>.<span class="ruby-identifier">children</span>
+44:       <span class="ruby-keyword kw">elsif</span> <span class="ruby-keyword kw">self</span>[<span class="ruby-value str">&quot;type&quot;</span>] <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;text&quot;</span>
+45:         [<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span>]
+46:       <span class="ruby-keyword kw">else</span>
+47:         <span class="ruby-comment cmt"># XXX - hpricot goes here?</span>
+48:         <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;I haven't implemented this yet&quot;</span>
+49:       <span class="ruby-keyword kw">end</span>
+50:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/classes/XHTML.html ADDED Viewed

@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: XHTML</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">XHTML</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/atom/text_rb.html">
+                lib/atom/text.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">NS</td>
+          <td>=</td>
+          <td class="context-item-value">&quot;http://www.w3.org/1999/xhtml&quot;</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/created.rid ADDED Viewed

	@@ -0,0 +1 @@
1	+ Fri Nov 10 17:13:31 MST 2006

data/doc/files/README.html ADDED Viewed

@@ -0,0 +1,213 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>File: README</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+  <div id="fileHeader">
+    <h1>README</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>README
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Thu Nov 09 14:53:37 MST 2006</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <h1>atom-tools README</h1>
+<p>
+atom-tools is an all-in-one library for parsing, creating and manipulating
+Atom &lt;<a href="http://www.w3.org/2005/Atom">www.w3.org/2005/Atom</a>&gt;
+feeds and entries. It handles all the nasty XML and HTTP details so that
+you don&#8217;t have to.
+</p>
+<h2>Example</h2>
+<pre>
+  require &quot;atom/feed&quot;
+  require &quot;open-uri&quot;
+  feed = Atom::Feed.new &quot;http://www.tbray.org/ongoing/ongoing.atom&quot;
+    # =&gt; &lt;http://www.tbray.org/ongoing/ongoing.atom entries: 0 title=''&gt;
+  feed.update!
+  feed.entries.length
+    # =&gt; 20
+  feed.title.to_s
+    # =&gt; &quot;ongoing&quot;
+  feed.authors.first.name
+    # =&gt; &quot;Tim Bray&quot;
+  entry = feed.entries.first
+    # =&gt; #&lt;Atom::Entry id:'http://www.tbray.org/ongoing/When/200x/2006/11/07/Munich'&gt;
+  entry.title.to_s
+    # =&gt; &quot;M\303\274nchen&quot;
+  entry.links.last
+    # =&gt; {&quot;href&quot;=&gt;&quot;http://www.tbray.org/ongoing/When/200x/2006/11/07/Munich#comments&quot;, &quot;rel&quot;=&gt;&quot;replies&quot;, &quot;type&quot; =&gt; &quot;application/xhtml+xml&quot;}
+  entry.summary.to_s
+    # =&gt; &quot;That local spelling is nicer than the ugly English [...]&quot;
+</pre>
+<p>
+Things are explained in more detail in the RDoc.
+</p>
+<h2>The Atom Publishing Protocol</h2>
+<pre>
+  require &quot;atom/app&quot;
+  app = Atom::App.new &quot;http://necronomicorp.com/app.xml&quot;
+  coll = app.collections.first
+    # =&gt; &lt;http://necronomicorp.com/testatom?app entries: 0 title='testing: entry endpoint'&gt;
+  coll.update!
+    # =&gt; &lt;http://necronomicorp.com/testatom?app entries: 10 title='testing the APP'&gt;
+  entry = coll.entries.first
+  entry.title
+    # =&gt; 'html entities'#text
+  # modify the title
+  entry.title = &quot;HTML entities&quot;
+  # store the modified entry
+  coll.put! entry
+    # =&gt; #&lt;Net::HTTPOK 200 OK readbody=true&gt;
+  coll.entries.first.title
+    # =&gt; 'HTML entities'#text
+</pre>
+<p>
+For details on authentication, see the documentation for <a
+href="../classes/Atom/HTTP.html">Atom::HTTP</a>
+</p>
+<h2>Advanced Use</h2>
+<h3>Extension Elements</h3>
+<pre>
+  irt = REXML::Element.new(&quot;in-reply-to&quot;)
+  irt.add_namespace &quot;http://purl.org/syndication/thread/1.0&quot;
+  irt.attributes[&quot;ref&quot;] = &quot;tag:entries.com,2005:1&quot;
+  entry.extensions &lt;&lt; irt
+  entry.to_s
+    # =&gt; '&lt;entry xmlns=&quot;http://www.w3.org/2005/Atom&quot;&gt;&lt;in-reply-to ref=&quot;tag:entries.com,2005:1&quot; xmlns=&quot;http://purl.org/syndication/thread/1.0&quot;/&gt;&lt;/entry&gt;'
+</pre>
+<h2>YAML</h2>
+<p>
+if you feel like writing this stuff by hand, atom-tools can slurp an
+atom:entry from YAML:
+</p>
+<pre>
+  require &quot;atom/yaml&quot;
+  yaml = &lt;&lt;END
+    title: Atom-Drunk Pirates Run Amok!
+    tags: tag1 tag2
+    authors:
+    -
+      name: Brendan Taylor
+      email: whateley@gmail.com
+    -
+      name: Harvey
+      uri: http://fake.com/
+    content: |
+      &lt;p&gt;blah blah blah blah&lt;/p&gt;
+      &lt;p&gt;and so on.&lt;/p&gt;
+  END
+  entry = Atom::Entry.from_yaml(yaml)
+</pre>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>