RubyGems - ruby_odata - Versions diffs - 0.0.1 → 0.0.2 - Mend

ruby_odata 0.0.1 → 0.0.2

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 (26) hide show

data/.gitignore +2 -1
data/CHANGELOG.rdoc +10 -0
data/VERSION +1 -1
data/features/query_builder.feature +96 -0
data/features/service.feature +0 -33
data/features/step_definitions/service_steps.rb +35 -0
data/lib/odata_ruby/query_builder.rb +15 -1
data/ruby_odata.gemspec +6 -20
metadata +7 -21
data/doc/classes/OData.html +0 -126
data/doc/classes/OData/ClassBuilder.html +0 -219
data/doc/classes/OData/Operation.html +0 -194
data/doc/classes/OData/QueryBuilder.html +0 -305
data/doc/classes/OData/Service.html +0 -420
data/doc/created.rid +0 -1
data/doc/files/README_rdoc.html +0 -252
data/doc/files/lib/odata_ruby/class_builder_rb.html +0 -101
data/doc/files/lib/odata_ruby/operation_rb.html +0 -101
data/doc/files/lib/odata_ruby/query_builder_rb.html +0 -101
data/doc/files/lib/odata_ruby/service_rb.html +0 -101
data/doc/files/lib/odata_ruby_rb.html +0 -114
data/doc/fr_class_index.html +0 -31
data/doc/fr_file_index.html +0 -32
data/doc/fr_method_index.html +0 -40
data/doc/index.html +0 -24
data/doc/rdoc-style.css +0 -208

data/doc/classes/OData/Service.html DELETED Viewed

@@ -1,420 +0,0 @@
-<?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: OData::Service</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">OData::Service</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../files/lib/odata_ruby/service_rb.html">
-                lib/odata_ruby/service.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>
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-      <div class="name-list">
-      <a href="#M000010">delete_object</a>&nbsp;&nbsp;
-      <a href="#M000013">execute</a>&nbsp;&nbsp;
-      <a href="#M000009">method_missing</a>&nbsp;&nbsp;
-      <a href="#M000008">new</a>&nbsp;&nbsp;
-      <a href="#M000014">respond_to?</a>&nbsp;&nbsp;
-      <a href="#M000012">save_changes</a>&nbsp;&nbsp;
-      <a href="#M000011">update_object</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">classes</td>
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        </table>
-      </div>
-    </div>
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Class methods</h3>
-      <div id="method-M000008" class="method-detail">
-        <a name="M000008"></a>
-        <div class="method-heading">
-          <a href="#M000008" class="method-signature">
-          <span class="method-name">new</span><span class="method-args">(service_uri)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Creates a <a href="Service.html#M000008">new</a> instance of the <a
-href="Service.html">Service</a> class
-</p>
-<h4>Required Attributes</h4>
-<ul>
-<li>service_uri: The root URI of the <a href="../OData.html">OData</a> service
-</li>
-</ul>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000008-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/odata_ruby/service.rb, line 9</span>
-        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">service_uri</span>)
-                <span class="ruby-ivar">@uri</span> = <span class="ruby-identifier">service_uri</span>
-                <span class="ruby-ivar">@collections</span> = <span class="ruby-identifier">get_collections</span>
-                <span class="ruby-identifier">build_classes</span>
-        <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <h3 class="section-bar">Public Instance methods</h3>
-      <div id="method-M000010" class="method-detail">
-        <a name="M000010"></a>
-        <div class="method-heading">
-          <a href="#M000010" class="method-signature">
-          <span class="method-name">delete_object</span><span class="method-args">(obj)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Queues an object for deletion. To actually remove it from the server, you
-must call <a href="Service.html#M000012">save_changes</a> as well.
-</p>
-<h4>Required Attributes</h4>
-<ul>
-<li>obj: The object to mark for deletion
-</li>
-</ul>
-<p>
-Note: This method will throw an exception if the <tt>obj</tt> isn&#8216;t a
-tracked entity
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000010-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/odata_ruby/service.rb, line 43</span>
-        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete_object</span>(<span class="ruby-identifier">obj</span>)
-                <span class="ruby-identifier">type</span> = <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>
-                <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:__metadata</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:__metadata</span>).<span class="ruby-identifier">nil?</span>
-                        <span class="ruby-ivar">@save_operation</span> = <span class="ruby-constant">Operation</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">&quot;Delete&quot;</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">obj</span>)
-                <span class="ruby-keyword kw">else</span>
-                        <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;You cannot delete a non-tracked entity&quot;</span>
-                <span class="ruby-keyword kw">end</span>
-        <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000013" class="method-detail">
-        <a name="M000013"></a>
-        <div class="method-heading">
-          <a href="#M000013" class="method-signature">
-          <span class="method-name">execute</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Performs query operations (Read) against the server
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000013-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/odata_ruby/service.rb, line 94</span>
-        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute</span>
-                <span class="ruby-identifier">result</span> = <span class="ruby-constant">RestClient</span>.<span class="ruby-identifier">get</span> <span class="ruby-identifier">build_query_uri</span>
-                <span class="ruby-identifier">build_classes_from_result</span>(<span class="ruby-identifier">result</span>)
-        <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000009" class="method-detail">
-        <a name="M000009"></a>
-        <div class="method-heading">
-          <a href="#M000009" class="method-signature">
-          <span class="method-name">method_missing</span><span class="method-args">(name, *args)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Handles the dynamic AddTo&lt;EntityName&gt; methods as well as the
-collections on the service
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000009-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/odata_ruby/service.rb, line 16</span>
-        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
-                <span class="ruby-comment cmt"># Queries</span>
-                <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@collections</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>)
-                        <span class="ruby-identifier">root</span> = <span class="ruby-node">&quot;/#{name.to_s.camelize}&quot;</span>
-                        <span class="ruby-identifier">root</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;(#{args.join(',')})&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>
-                        <span class="ruby-ivar">@query</span> = <span class="ruby-constant">QueryBuilder</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">root</span>)
-                        <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@query</span>
-                <span class="ruby-comment cmt"># Adds        </span>
-                <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^AddTo(.*)/</span>
-                        <span class="ruby-identifier">type</span> = <span class="ruby-identifier">$1</span>
-                        <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@collections</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">type</span>)
-                                <span class="ruby-ivar">@save_operation</span> = <span class="ruby-constant">Operation</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">&quot;Add&quot;</span>, <span class="ruby-identifier">$1</span>, <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>])
-                        <span class="ruby-keyword kw">else</span>
-                                <span class="ruby-keyword kw">super</span>
-                        <span class="ruby-keyword kw">end</span>
-                <span class="ruby-keyword kw">else</span>
-                        <span class="ruby-keyword kw">super</span>
-                <span class="ruby-keyword kw">end</span>
-        <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000014" class="method-detail">
-        <a name="M000014"></a>
-        <div class="method-heading">
-          <a href="#M000014" class="method-signature">
-          <span class="method-name">respond_to?</span><span class="method-args">(method)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Overridden to identify methods handled by <a
-href="Service.html#M000009">method_missing</a>
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000014-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/odata_ruby/service.rb, line 100</span>
-        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">method</span>)
-                <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@collections</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">method</span>.<span class="ruby-identifier">to_s</span>)
-                        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
-                <span class="ruby-comment cmt"># Adds        </span>
-                <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">method</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^AddTo(.*)/</span>
-                        <span class="ruby-identifier">type</span> = <span class="ruby-identifier">$1</span>
-                        <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@collections</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">type</span>)
-                                <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
-                        <span class="ruby-keyword kw">else</span>
-                                <span class="ruby-keyword kw">super</span>
-                        <span class="ruby-keyword kw">end</span>
-                <span class="ruby-keyword kw">else</span>
-                        <span class="ruby-keyword kw">super</span>
-                <span class="ruby-keyword kw">end</span>
-        <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000012" class="method-detail">
-        <a name="M000012"></a>
-        <div class="method-heading">
-          <a href="#M000012" class="method-signature">
-          <span class="method-name">save_changes</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Performs save operations (Create/Update/Delete) against the server
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000012-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/odata_ruby/service.rb, line 68</span>
-        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">save_changes</span>
-                <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@save_operation</span>.<span class="ruby-identifier">nil?</span>
-                <span class="ruby-identifier">result</span> = <span class="ruby-keyword kw">nil</span>
-                <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@save_operation</span>.<span class="ruby-identifier">kind</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;Add&quot;</span>
-                        <span class="ruby-identifier">save_uri</span> = <span class="ruby-node">&quot;#{@uri}/#{@save_operation.klass_name}&quot;</span>
-                        <span class="ruby-identifier">json_klass</span> = <span class="ruby-ivar">@save_operation</span>.<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_json</span>
-                        <span class="ruby-identifier">post_result</span> = <span class="ruby-constant">RestClient</span>.<span class="ruby-identifier">post</span> <span class="ruby-identifier">save_uri</span>, <span class="ruby-identifier">json_klass</span>, <span class="ruby-identifier">:content_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:json</span>
-                        <span class="ruby-identifier">result</span> = <span class="ruby-identifier">build_classes_from_result</span>(<span class="ruby-identifier">post_result</span>)
-                <span class="ruby-keyword kw">elsif</span> <span class="ruby-ivar">@save_operation</span>.<span class="ruby-identifier">kind</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;Update&quot;</span>
-                        <span class="ruby-identifier">update_uri</span> = <span class="ruby-ivar">@save_operation</span>.<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:__metadata</span>)[<span class="ruby-identifier">:uri</span>]
-                        <span class="ruby-identifier">json_klass</span> = <span class="ruby-ivar">@save_operation</span>.<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">to_json</span>
-                        <span class="ruby-identifier">update_result</span> = <span class="ruby-constant">RestClient</span>.<span class="ruby-identifier">put</span> <span class="ruby-identifier">update_uri</span>, <span class="ruby-identifier">json_klass</span>, <span class="ruby-identifier">:content_type</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">:json</span>
-                        <span class="ruby-keyword kw">return</span> (<span class="ruby-identifier">update_result</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-value">204</span>)
-                <span class="ruby-keyword kw">elsif</span> <span class="ruby-ivar">@save_operation</span>.<span class="ruby-identifier">kind</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;Delete&quot;</span>
-                        <span class="ruby-identifier">delete_uri</span> = <span class="ruby-ivar">@save_operation</span>.<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:__metadata</span>)[<span class="ruby-identifier">:uri</span>]
-                        <span class="ruby-identifier">delete_result</span> = <span class="ruby-constant">RestClient</span>.<span class="ruby-identifier">delete</span> <span class="ruby-identifier">delete_uri</span>
-                        <span class="ruby-keyword kw">return</span> (<span class="ruby-identifier">delete_result</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-value">204</span>)
-                <span class="ruby-keyword kw">end</span>
-                <span class="ruby-ivar">@save_operation</span> = <span class="ruby-keyword kw">nil</span> <span class="ruby-comment cmt"># Clear out the last operation</span>
-                <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">result</span>
-        <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000011" class="method-detail">
-        <a name="M000011"></a>
-        <div class="method-heading">
-          <a href="#M000011" class="method-signature">
-          <span class="method-name">update_object</span><span class="method-args">(obj)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Queues an object for update. To actually update it on the server, you must
-call <a href="Service.html#M000012">save_changes</a> as well.
-</p>
-<h4>Required Attributes</h4>
-<ul>
-<li>obj: The object to queue for update
-</li>
-</ul>
-<p>
-Note: This method will throw an exception if the <tt>obj</tt> isn&#8216;t a
-tracked entity
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000011-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/odata_ruby/service.rb, line 58</span>
-        <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">update_object</span>(<span class="ruby-identifier">obj</span>)
-                <span class="ruby-identifier">type</span> = <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>
-                <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">:__metadata</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:__metadata</span>).<span class="ruby-identifier">nil?</span>
-                        <span class="ruby-ivar">@save_operation</span> = <span class="ruby-constant">Operation</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">&quot;Update&quot;</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">obj</span>)
-                <span class="ruby-keyword kw">else</span>
-                        <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;You cannot update a non-tracked entity&quot;</span>
-                <span class="ruby-keyword kw">end</span>
-        <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/created.rid DELETED Viewed

	@@ -1 +0,0 @@
1	- Fri, 11 Jun 2010 18:01:50 -0400

data/doc/files/README_rdoc.html DELETED Viewed

@@ -1,252 +0,0 @@
-<?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.rdoc</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.rdoc</h1>
-    <table class="header-table">
-    <tr class="top-aligned-row">
-      <td><strong>Path:</strong></td>
-      <td>README.rdoc
-      </td>
-    </tr>
-    <tr class="top-aligned-row">
-      <td><strong>Last Update:</strong></td>
-      <td>Wed Jun 09 22:59:40 -0400 2010</td>
-    </tr>
-    </table>
-  </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-    <div id="description">
-      <h1>odata_ruby</h1>
-<p>
-The <b>Open Data Protocol</b> (<a href="../classes/OData.html">OData</a>)
-is a fantastic way to query and update data over standard Web technologies.
-The odata_ruby library acts as a consumer of <a
-href="../classes/OData.html">OData</a> services.
-</p>
-<h2>Usage</h2>
-<p>
-The API is a work in progress. Notably, changes can&#8216;t be bundled
-(through save_changes, only the last operation before save_changes is
-persisted).
-</p>
-<h3>Adding</h3>
-<p>
-When you point at a service, an AddTo&lt;EntityName&gt; method is created
-for you. This method takes in the new entity to create. To commit the
-change, you need to call the save_changes method on the service. To add a
-new category for example, you would simply do the following:
-</p>
-<pre>
-        require 'lib/odata_ruby'
-        svc = OData::Service.new &quot;http://127.0.0.1:8888/SampleService/Entities.svc&quot;
-        new_category = Category.new
-        new_category.Name = &quot;Sample Category&quot;
-        svc.AddToCategories(new_category)
-        category = svc.save_changes
-        puts category.to_json
-</pre>
-<h3>Updating</h3>
-<p>
-To update an object, simply pass the modified object to the update_object
-method on the service. Updating, like adding requires you to call
-save_changes in order to persist the change. For example:
-</p>
-<pre>
-        require 'lib/odata_ruby'
-        svc = OData::Service.new &quot;http://127.0.0.1:8888/SampleService/Entities.svc&quot;
-        new_category = Category.new
-        new_category.Name = &quot;Sample Category&quot;
-        svc.AddToCategories(new_category)
-        category = svc.save_changes
-        puts category.to_json
-        category.Name = 'Updated Category'
-        svc.update_object(category)
-        result = svc.save_changes
-        puts &quot;Was the category updated? #{result}&quot;
-</pre>
-<h3>Deleting</h3>
-<p>
-Deleting an object involves passing the tracked object to the delete_object
-method on the service. Deleting is another function that involves the
-save_changes method (to commit the change back to the server). In this
-example, we&#8216;ll add a category and then delete it.
-</p>
-<pre>
-        require 'lib/odata_ruby'
-        svc = OData::Service.new &quot;http://127.0.0.1:8888/SampleService/Entities.svc&quot;
-        new_category = Category.new
-        new_category.Name = &quot;Sample Category&quot;
-        svc.AddToCategories(new_category)
-        category = svc.save_changes
-        puts category.to_json
-        svc.delete_object(category)
-        result = svc.save_changes
-        puts &quot;Was the category deleted? #{result}&quot;
-</pre>
-<h3>Querying</h3>
-<p>
-Querying is easy, for example to pull all the categories from the
-SampleService, you simply can run:
-</p>
-<pre>
-        require 'lib/odata_ruby'
-        svc = OData::Service.new &quot;http://127.0.0.1:8888/SampleService/Entities.svc&quot;
-        svc.Categories
-        categories = svc.execute
-        puts categories.to_json
-</pre>
-<p>
-You can also expand and add filters to the query before executing it. For
-example:
-</p>
-<h3>Expanding</h3>
-<pre>
-        # Without expanding the query
-        svc.Products(1)
-        prod1 = svc.execute
-        puts &quot;Without expanding the query&quot;
-        puts &quot;#{prod1.to_json}\n&quot;
-        # With expanding the query
-        svc.Products(1).expand('Category')
-        prod1 = svc.execute
-        puts &quot;Without expanding the query&quot;
-        puts &quot;#{prod1.to_json}\n&quot;
-</pre>
-<h3>Filtering</h3>
-<pre>
-        # You can access by ID (but that isn't is a filter)
-        # The syntax is just svc.ENTITYNAME(ID) which is shown in the expanding examples above
-        svc.Products.filter(&quot;Name eq 'Product 2'&quot;)
-        prod = svc.execute
-        puts &quot;Filtering on Name eq 'Product 2'&quot;
-        puts &quot;#{prod.to_json}&quot;
-</pre>
-<h3>Combining Expanding and Filtering</h3>
-<pre>
-        svc.Products.filter(&quot;Name eq 'Product 2'&quot;).expand(&quot;Category&quot;)
-        prod = svc.execute
-        puts &quot;Filtering on Name eq 'Product 2' and expanding&quot;
-        puts &quot;#{prod.to_json}&quot;
-</pre>
-<h2>Tests</h2>
-<p>
-*DATABASE SETUP - DO THIS FIRST* Within /test/SampleService/App_Data/
-rename _TestDB*.* to TestDB*.*. This file is just the inital database, and
-needs to be renamed so that unwanted changes to that DB aren&#8216;t
-persisted in source control.
-</p>
-<p>
-All of the tests are written using Cucumber going against a sample service
-(Found in /test/SampleService/*). The SampleService is an ASP.NET Web Site
-running a SQLEXPRESS 2008 R2 Database (TestDB), as well as the ADO.NET
-Entity Framework and a WCF Data Service. In order to run the tests, you
-need to spin up the SampleService and have it running on port 8888 (<a
-href="http://localhost:8888/SampleService">localhost:8888/SampleService</a>).
-</p>
-<p>
-One way to do this is to open the SampleService within Visual Studio 2010
-and run it from there. Another option is to use Cassini (the built ASP.NET
-Development server that comes with Visual Studio 2010). There is a batch
-file found in /test called &quot;Cassini x64.bat&quot;, you can run the
-batch file and just close the command window. There is a also a
-&quot;Cassini x86.bat&quot; file for those of you running a 32-bit machine,
-however it hasn&#8216;t been tested. The only difference is the path to the
-Program Files directory. Once you run the batch file, the web server will
-spin up and you can find the instance in your systray just like if Visual
-Studio ran it for you. To stop the server, right click on the icon in your
-systray and tell it to stop
-</p>
-    </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>