ruby_odata 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+.idea
+.idea/*
+rerun.txt
+tmp
+tmp/*
+.eprj
+test/SampleService/App_Data/TestDB.mdf
+test/SampleService/App_Data/TestDB_Log.ldf
+pkg/*

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2010, Visoft, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of Visoft, Inc. nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL VISOFT, INC. BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.rdoc

@@ -0,0 +1,107 @@
+= odata_ruby
+
+The <b>Open Data Protocol</b> (OData) is a fantastic way to query and update data over standard Web technologies.  The odata_ruby library acts as a consumer of OData services.
+
+== Usage
+The API is a work in progress.  Notably, changes can't be bundled (through save_changes, only the last operation before save_changes is persisted).
+
+=== Adding
+When you point at a service, an AddTo<EntityName> 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:
+
+	require 'lib/odata_ruby'
+	
+	svc = OData::Service.new "http://127.0.0.1:8888/SampleService/Entities.svc"
+	new_category = Category.new
+	new_category.Name = "Sample Category"
+	svc.AddToCategories(new_category)
+	category = svc.save_changes
+	puts category.to_json
+
+=== Updating
+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:
+
+	require 'lib/odata_ruby'
+		
+	svc = OData::Service.new "http://127.0.0.1:8888/SampleService/Entities.svc"
+	new_category = Category.new
+	new_category.Name = "Sample Category"
+	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 "Was the category updated? #{result}"
+	
+=== Deleting
+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'll add a category and then delete it.
+
+	require 'lib/odata_ruby'
+	
+	svc = OData::Service.new "http://127.0.0.1:8888/SampleService/Entities.svc"
+	new_category = Category.new
+	new_category.Name = "Sample Category"
+	svc.AddToCategories(new_category)
+	category = svc.save_changes
+	puts category.to_json
+	
+	svc.delete_object(category)
+	result = svc.save_changes
+	puts "Was the category deleted? #{result}"
+
+=== Querying
+Querying is easy, for example to pull all the categories from the SampleService, you simply can run:
+
+	require 'lib/odata_ruby'
+	
+	svc = OData::Service.new "http://127.0.0.1:8888/SampleService/Entities.svc"
+	svc.Categories
+	categories = svc.execute
+	puts categories.to_json
+
+You can also expand and add filters to the query before executing it.  For example:
+
+=== Expanding
+
+	# Without expanding the query
+	svc.Products(1)
+	prod1 = svc.execute
+	puts "Without expanding the query"
+	puts "#{prod1.to_json}\n"
+	
+	# With expanding the query
+	svc.Products(1).expand('Category')
+	prod1 = svc.execute
+	puts "Without expanding the query"
+	puts "#{prod1.to_json}\n"
+
+
+=== Filtering
+
+	# 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("Name eq 'Product 2'")
+	prod = svc.execute
+	puts "Filtering on Name eq 'Product 2'"
+	puts "#{prod.to_json}"
+	
+=== Combining Expanding and Filtering
+
+	svc.Products.filter("Name eq 'Product 2'").expand("Category")
+	prod = svc.execute
+	puts "Filtering on Name eq 'Product 2' and expanding"
+	puts "#{prod.to_json}"
+
+
+
+== Tests
+*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't persisted in source control.
+
+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 (http://localhost:8888/SampleService).  
+
+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 "Cassini x64.bat", you can run the batch file and just close the command window. There is a also a "Cassini x86.bat" file for those of you running a 32-bit machine, however it hasn'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
+
+

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rd|
+	rd.main = "README.rdoc"
+	rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+	rd.rdoc_dir = 'doc'
+end
+
+begin
+	require 'jeweler'
+	Jeweler::Tasks.new do |gemspec|
+		gemspec.name = "ruby_odata"
+		gemspec.summary = "Ruby consumer of OData services."
+		gemspec.description = "An OData Client Library for Ruby.  Use this to interact with OData services"
+		gemspec.email = "damien.white@visoftinc.com"
+		gemspec.homepage = "http://github.com/visoft/ruby_odata"
+		gemspec.authors = ["Damien White"]
+		gemspec.add_dependency('activesupport', '>= 2.3.5')
+		gemspec.add_dependency('rest-client', '>= 1.5.1')
+		gemspec.add_dependency('nokogiri', '>= 1.4.2')
+		gemspec.rubyforge_project = 'ruby-odata'
+	end
+	Jeweler::GemcutterTasks.new
+	Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+	puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/config/cucumber.yml

@@ -0,0 +1,7 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format progress features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "#{rerun_opts} --format rerun --out rerun.txt --strict --tags ~@wip"
+%>
+default: <%= std_opts %>
+wip: --tags @wip:3 --wip features

data/doc/classes/OData/ClassBuilder.html

@@ -0,0 +1,219 @@
+<?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::ClassBuilder</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::ClassBuilder</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/odata_ruby/class_builder_rb.html">
+                lib/odata_ruby/class_builder.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>
+Internally used helper class for building a dynamic class. This class
+shouldn&#8216;t be called directly.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000003">build</a>&nbsp;&nbsp;
+      <a href="#M000002">new</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="#M000002" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(klass_name, methods, nav_props)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Creates a <a href="ClassBuilder.html#M000002">new</a> instance of the <a
+href="ClassBuilder.html">ClassBuilder</a> class
+</p>
+<h4>Required Attributes</h4>
+<ul>
+<li>klass_name: The name/type of the class to create
+
+</li>
+<li>methods: The accessor methods to add to the class
+
+</li>
+<li>nav_props: The accessor methods to add for navigation properties
+
+</li>
+</ul>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000002-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/odata_ruby/class_builder.rb, line 10</span>
+                <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">klass_name</span>, <span class="ruby-identifier">methods</span>, <span class="ruby-identifier">nav_props</span>)
+                        <span class="ruby-ivar">@klass_name</span> = <span class="ruby-identifier">klass_name</span>
+                        <span class="ruby-ivar">@methods</span> = <span class="ruby-identifier">methods</span>
+                        <span class="ruby-ivar">@nav_props</span> = <span class="ruby-identifier">nav_props</span>
+                <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="#M000003" class="method-signature">
+          <span class="method-name">build</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Returns a dynamically generated class definition based on the constructor
+parameters
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000003-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/odata_ruby/class_builder.rb, line 17</span>
+                <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">build</span>
+                        <span class="ruby-comment cmt"># return if already built</span>
+                  <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@klass</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@klass</span>.<span class="ruby-identifier">nil?</span>
+                
+                  <span class="ruby-comment cmt"># need the class name to build class</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">@klass_name</span>.<span class="ruby-identifier">nil?</span>
+                      
+                        <span class="ruby-comment cmt"># return if we can find constant corresponding to class name</span>
+                        <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Object</span>.<span class="ruby-identifier">constants</span>.<span class="ruby-identifier">include?</span> <span class="ruby-ivar">@klass_name</span>
+                                <span class="ruby-ivar">@klass</span> = <span class="ruby-ivar">@klass_name</span>.<span class="ruby-identifier">constantize</span>
+                                <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@klass</span>
+                        <span class="ruby-keyword kw">end</span>
+                      
+                        <span class="ruby-constant">Object</span>.<span class="ruby-identifier">const_set</span>(<span class="ruby-ivar">@klass_name</span>, <span class="ruby-constant">Class</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">extend</span>(<span class="ruby-constant">ActiveSupport</span><span class="ruby-operator">::</span><span class="ruby-constant">JSON</span>))
+                  <span class="ruby-ivar">@klass</span> = <span class="ruby-ivar">@klass_name</span>.<span class="ruby-identifier">constantize</span>
+ 
+                        <span class="ruby-identifier">add_methods</span>(<span class="ruby-ivar">@klass</span>)
+                        <span class="ruby-identifier">add_nav_props</span>(<span class="ruby-ivar">@klass</span>)
+                        
+                  <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@klass</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/classes/OData/Operation.html

@@ -0,0 +1,194 @@
+<?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::Operation</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::Operation</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/odata_ruby/operation_rb.html">
+                lib/odata_ruby/operation.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>
+Internally used helper class for storing operations called against the
+service. This class shouldn&#8216;t be used directly.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">new</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">kind</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">klass</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">klass_name</td>
+          <td class="context-item-value">&nbsp;[RW]&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-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="#M000001" class="method-signature">
+          <span class="method-name">new</span><span class="method-args">(kind, klass_name, klass)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Creates a <a href="Operation.html#M000001">new</a> instance of the <a
+href="Operation.html">Operation</a> class
+</p>
+<h4>Required Attributes</h4>
+<ul>
+<li>kind: The operation type (Add, Update, or Delete)
+
+</li>
+<li>klass_name: The name/type of the class to operate against
+
+</li>
+<li>klass: The actual class
+
+</li>
+</ul>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000001-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/odata_ruby/operation.rb, line 12</span>
+                <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">kind</span>, <span class="ruby-identifier">klass_name</span>, <span class="ruby-identifier">klass</span>)
+                        <span class="ruby-ivar">@kind</span> = <span class="ruby-identifier">kind</span>
+                        <span class="ruby-ivar">@klass_name</span> = <span class="ruby-identifier">klass_name</span>
+                        <span class="ruby-ivar">@klass</span> = <span class="ruby-identifier">klass</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>