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

atom-tools 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

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/HTTP.html ADDED Viewed

@@ -0,0 +1,374 @@
+<?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::HTTP</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::HTTP</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/atom/collection_rb.html">
+                lib/atom/collection.rb
+                </a>
+        <br />
+                <a href="../../files/lib/atom/http_rb.html">
+                lib/atom/http.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+An object which handles the details of <a href="HTTP.html">HTTP</a> -
+particularly authentication and caching (neither of which are fully
+implemented).
+</p>
+<p>
+This object can be used on its own, or passed to an <a
+href="App.html">Atom::App</a>, <a
+href="Collection.html">Atom::Collection</a> or <a
+href="Feed.html">Atom::Feed</a>, where it will be used for requests.
+</p>
+<p>
+All its <a href="HTTP.html">HTTP</a> methods return a Net::HTTPResponse
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000024">delete</a>&nbsp;&nbsp;
+      <a href="#M000021">get</a>&nbsp;&nbsp;
+      <a href="#M000019">get_atom_entry</a>&nbsp;&nbsp;
+      <a href="#M000022">post</a>&nbsp;&nbsp;
+      <a href="#M000023">put</a>&nbsp;&nbsp;
+      <a href="#M000020">put_atom_entry</a>&nbsp;&nbsp;
+      <a href="#M000025">when_auth</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">pass</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc">
+used by the default <a href="HTTP.html#M000025">when_auth</a>
+</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">user</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc">
+used by the default <a href="HTTP.html#M000025">when_auth</a>
+</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000024" class="method-detail">
+        <a name="M000024"></a>
+        <div class="method-heading">
+          <a href="#M000024" class="method-signature">
+          <span class="method-name">delete</span><span class="method-args">(url, body = nil, headers = {})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+DELETEs to url
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000024-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000024-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/atom/http.rb, line 54</span>
+54:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete</span> <span class="ruby-identifier">url</span>, <span class="ruby-identifier">body</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">headers</span> = {}
+55:       <span class="ruby-identifier">http_request</span>(<span class="ruby-identifier">url</span>, <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Delete</span>, <span class="ruby-identifier">body</span>, <span class="ruby-identifier">headers</span>)
+56:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000021" class="method-detail">
+        <a name="M000021"></a>
+        <div class="method-heading">
+          <a href="#M000021" class="method-signature">
+          <span class="method-name">get</span><span class="method-args">(url, headers = {})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+GETs an url
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000021-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/atom/http.rb, line 39</span>
+39:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span> <span class="ruby-identifier">url</span>, <span class="ruby-identifier">headers</span> = {}
+40:       <span class="ruby-identifier">http_request</span>(<span class="ruby-identifier">url</span>, <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">headers</span>)
+41:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000019" class="method-detail">
+        <a name="M000019"></a>
+        <div class="method-heading">
+          <a href="#M000019" class="method-signature">
+          <span class="method-name">get_atom_entry</span><span class="method-args">(url)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+GET a URL and turn it into an <a href="Entry.html">Atom::Entry</a>
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000019-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/atom/collection.rb, line 57</span>
+57:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_atom_entry</span>(<span class="ruby-identifier">url</span>)
+58:       <span class="ruby-identifier">res</span> = <span class="ruby-identifier">get</span>(<span class="ruby-identifier">url</span>)
+59:
+60:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">!=</span> <span class="ruby-value str">&quot;200&quot;</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">content_type</span> <span class="ruby-operator">!=</span> <span class="ruby-value str">&quot;application/atom+xml&quot;</span>
+61:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">Atom</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPException</span>, <span class="ruby-value str">&quot;expected Atom::Entry, didn't get it&quot;</span>
+62:       <span class="ruby-keyword kw">end</span>
+63:
+64:       <span class="ruby-constant">Atom</span><span class="ruby-operator">::</span><span class="ruby-constant">Entry</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">res</span>.<span class="ruby-identifier">body</span>, <span class="ruby-identifier">url</span>)
+65:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000022" class="method-detail">
+        <a name="M000022"></a>
+        <div class="method-heading">
+          <a href="#M000022" class="method-signature">
+          <span class="method-name">post</span><span class="method-args">(url, body, headers = {})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+POSTs body to an url
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000022-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000022-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/atom/http.rb, line 44</span>
+44:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">post</span> <span class="ruby-identifier">url</span>, <span class="ruby-identifier">body</span>, <span class="ruby-identifier">headers</span> = {}
+45:       <span class="ruby-identifier">http_request</span>(<span class="ruby-identifier">url</span>, <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Post</span>, <span class="ruby-identifier">body</span>, <span class="ruby-identifier">headers</span>)
+46:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000023" class="method-detail">
+        <a name="M000023"></a>
+        <div class="method-heading">
+          <a href="#M000023" class="method-signature">
+          <span class="method-name">put</span><span class="method-args">(url, body, headers = {})</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+PUTs body to an url
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000023-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000023-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/atom/http.rb, line 49</span>
+49:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">put</span> <span class="ruby-identifier">url</span>, <span class="ruby-identifier">body</span>, <span class="ruby-identifier">headers</span> = {}
+50:       <span class="ruby-identifier">http_request</span>(<span class="ruby-identifier">url</span>, <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Put</span>, <span class="ruby-identifier">body</span>, <span class="ruby-identifier">headers</span>)
+51:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000020" class="method-detail">
+        <a name="M000020"></a>
+        <div class="method-heading">
+          <a href="#M000020" class="method-signature">
+          <span class="method-name">put_atom_entry</span><span class="method-args">(entry, url = entry.edit_url)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+PUT an <a href="Entry.html">Atom::Entry</a> to a URL
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000020-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/atom/collection.rb, line 68</span>
+68:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">put_atom_entry</span>(<span class="ruby-identifier">entry</span>, <span class="ruby-identifier">url</span> = <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">edit_url</span>)
+69:       <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Cowardly refusing to PUT a non-Atom::Entry (#{entry.class})&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Atom</span><span class="ruby-operator">::</span><span class="ruby-constant">Entry</span>
+70:       <span class="ruby-identifier">headers</span> = {<span class="ruby-value str">&quot;Content-Type&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;application/atom+xml&quot;</span> }
+71:
+72:       <span class="ruby-identifier">put</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">headers</span>)
+73:     <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000025" class="method-detail">
+        <a name="M000025"></a>
+        <div class="method-heading">
+          <a href="#M000025" class="method-signature">
+          <span class="method-name">when_auth</span><span class="method-args">(&amp;block)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+a block that will be called when a remote server responds with 401
+Unauthorized, so that your application can prompt for authentication
+details
+</p>
+<p>
+it will be called with the base URL of the requested URL, and the realm
+used in the WWW-Authenticate header.
+</p>
+<p>
+it should return a value of the form [username, password]
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000025-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000025-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/atom/http.rb, line 65</span>
+65:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">when_auth</span> <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>
+66:       <span class="ruby-ivar">@get_auth_details</span> = <span class="ruby-identifier">block</span>
+67:     <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/Atom/Link.html ADDED Viewed

@@ -0,0 +1,137 @@
+<?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::Link</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::Link</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/atom/element_rb.html">
+                lib/atom/element.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Atom::AttrEl
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+A link has the following attributes:
+</p>
+<table>
+<tr><td valign="top">href (required):</td><td>the link&#8217;s IRI
+</td></tr>
+<tr><td valign="top">rel:</td><td>the relationship of the linked item to the current item
+</td></tr>
+<tr><td valign="top">type:</td><td>a hint about the media type of the linked item
+</td></tr>
+<tr><td valign="top">hreflang:</td><td>the language of the linked item (RFC3066)
+</td></tr>
+<tr><td valign="top">title:</td><td>human-readable information about the link
+</td></tr>
+<tr><td valign="top">length:</td><td>a hint about the length (in octets) of the linked item
+</td></tr>
+</table>
+    </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>