ruby_odata 0.0.1 → 0.0.2

data/.gitignore

@@ -6,4 +6,5 @@ tmp/*
 .eprj
 test/SampleService/App_Data/TestDB.mdf
 test/SampleService/App_Data/TestDB_Log.ldf
-pkg/*
+pkg/*
+doc/*

data/CHANGELOG.rdoc

@@ -0,0 +1,10 @@
+= ruby_odata Change Log
+
+== 0.0.1 
+	* Basic CRUD Operations
+	* Query: Filters
+	* Query: Expands
+
+== 0.0.2
+	* Query: Order By
+	

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/features/query_builder.feature

@@ -0,0 +1,96 @@
+Feature: Query Builder
+  In order to query OData services
+  As a user
+  I want to be able to perform valid OData protocol operations 
+
+Background:
+  Given an ODataService exists with uri: "http://localhost:8888/SampleService/Entities.svc"
+	And blueprints exist for the service
+
+# Expand	
+Scenario: Navigation Properties should be able to be eager loaded
+  Given I call "AddToCategories" on the service with a new "Category" object with Name: "Test Category"
+	And I save changes
+	And I call "AddToProducts" on the service with a new "Product" object with Category: "@@LastSave"
+	And I save changes	
+  And I call "Products" on the service with args: "1"
+  And I expand the query to include "Category"
+  When I run the query
+  Then the method "Category" on the result should be of type "Category"
+  And the method "Name" on the result's method "Category" should equal: "Test Category"
+	And the method "Id" on the result's method "Category" should equal: "1"
+
+
+# Filter
+Scenario: Filters should be allowed on the root level entity
+  Given I call "AddToProducts" on the service with a new "Product" object with Name: "Test Product"
+  When I save changes
+  When I call "Products" on the service
+  And I filter the query with: "Name eq 'Test Product'"
+  And I run the query
+  Then the method "Name" on the result should equal: "Test Product"
+
+
+# Order By
+Scenario: Order by should be allowed on the root level entity
+  Given the following Products exist:
+  | Name      |
+  | Product 2 |
+  | Product 4 |
+  | Product 5 |
+  | Product 1 |
+  | Product 3 |
+  When I call "Products" on the service
+  And I order by: "Name"
+  And I run the query
+  Then the result should be:
+  | Name      |
+  | Product 1 |
+  | Product 2 |
+  | Product 3 |
+  | Product 4 |
+  | Product 5 |
+
+Scenario: Order by should accept sorting descending
+  Given the following Products exist:
+  | Name      |
+  | Product 2 |
+  | Product 4 |
+  | Product 5 |
+  | Product 1 |
+  | Product 3 |
+  When I call "Products" on the service
+  And I order by: "Name desc"
+  And I run the query
+  Then the result should be:
+  | Name      |
+  | Product 5 |
+  | Product 4 |
+  | Product 3 |
+  | Product 2 |
+  | Product 1 |
+
+Scenario: Order by should access sorting acsending
+  Given the following Products exist:
+  | Name      |
+  | Product 2 |
+  | Product 4 |
+  | Product 5 |
+  | Product 1 |
+  | Product 3 |
+  When I call "Products" on the service
+  And I order by: "Name asc"
+  And I run the query
+  Then the result should be:
+  | Name      |
+  | Product 1 |
+  | Product 2 |
+  | Product 3 |
+  | Product 4 |
+  | Product 5 |
+
+
+
+  
+
+

data/features/service.feature

@@ -47,36 +47,3 @@ Scenario: Navigation Properties should be included in results
   Then the result should have a method: "Category"
   And the method "Category" on the result should be nil
 
-Scenario: Navigation Properties should be able to be eager loaded
-  Given I call "AddToCategories" on the service with a new "Category" object with Name: "Test Category"
-	And I save changes
-	And I call "AddToProducts" on the service with a new "Product" object with Category: "@@LastSave"
-	And I save changes	
-  And I call "Products" on the service with args: "1"
-  And I expand the query to include "Category"
-  When I run the query
-  Then the method "Category" on the result should be of type "Category"
-  And the method "Name" on the result's method "Category" should equal: "Test Category"
-	And the method "Id" on the result's method "Category" should equal: "1"
-
-Scenario: Filters should be allowed on the root level entity
-  Given I call "AddToProducts" on the service with a new "Product" object with Name: "Test Product"
-  When I save changes
-  When I call "Products" on the service
-  And I filter the query with: "Name eq 'Test Product'"
-  And I run the query
-  Then the method "Name" on the result should equal: "Test Product"
-  
-
-
-
-
-
-
-
-
-
-
-
-
-

data/features/step_definitions/service_steps.rb

@@ -58,6 +58,10 @@ When /^I filter the query with: "([^\"]*)"$/ do |filter|
   @service_query.filter(filter)
 end
 
+When /^I order by: "([^\"]*)"$/ do |order|
+  @service_query.order_by(order)
+end
+
 
 Then /^the method "([^\"]*)" on the result should be of type "([^\"]*)"$/ do |method, type|
   result = @service_result.send(method.to_sym) 
@@ -126,6 +130,37 @@ Then /^no "([^\"]*)" should exist$/ do |collection|
 	results.should == []
 end
 
+Given /^the following (.*) exist:$/ do |plural_factory, table|
+  # table is a Cucumber::Ast::Table
+	factory = plural_factory.singularize
+	table.hashes.map do |hash|
+		obj = factory.constantize.send(:make, hash)
+  	@service.send("AddTo#{plural_factory}", obj)
+  	@service.save_changes
+	end
+end
+
+Then /^the result should be:$/ do |table|
+  # table is a Cucumber::Ast::Table
+  
+  fields = table.hashes[0].keys
+  
+  # Build an array of hashes so that we can compare tables
+  results = []
+  
+  @service_result.each do |result|
+  	obj_hash = Hash.new
+  	fields.each do |field|
+  		obj_hash[field] = result.send(field)
+		end
+		results << obj_hash
+	end
+	
+	result_table = Cucumber::Ast::Table.new(results)
+	
+	table.diff!(result_table) 	
+end
+
 Then /^the method "([^\"]*)" on the result's method "([^\"]*)" should equal: "([^\"]*)"$/ do |method, result_method, value|
   obj = @service_result.send(result_method.to_sym)
   obj.send(method.to_sym).should == value

data/lib/odata_ruby/query_builder.rb

@@ -14,6 +14,7 @@ class QueryBuilder
 		@root = root.to_s
 		@expands = []
 		@filters = []
+		@order_bys = []
 	end
 	
 	# Used to eagerly-load data for nested objects, for example, obtaining a Category for a Product within one call to the server
@@ -39,12 +40,24 @@ class QueryBuilder
 	#
 	# ==== Example	
 	# 	svc.Products.filter("Name eq 'Product 2'")
-	# 	prod = svc.execute
+	# 	products = svc.execute
 	def filter(filter)
 		@filters << CGI.escape(filter)
 		self
 	end
 	
+	# Used to order the data being returned
+	# ==== Required Attributes
+	# - order_by: The order by statement.  Note to specify direction, use "desc" or "asc"; must be lowercase 
+	#
+	# ==== Example	
+	# 	svc.Products.order_by("Name")
+	# 	products = svc.execute
+	def order_by(order_by)
+		@order_bys << CGI.escape(order_by)
+		self
+	end
+	
 	# Builds the query URI (path, not including root) incorporating expands, filters, etc.
 	# This is used internally when the execute method is called on the service
 	def query
@@ -52,6 +65,7 @@ class QueryBuilder
 		query_options = []
 		query_options << "$expand=#{@expands.join(',')}" unless @expands.empty?
 		query_options << "$filter=#{@filters.join('+and+')}" unless @filters.empty?
+		query_options << "$orderby=#{@order_bys.join(',')}" unless @order_bys.empty?
 		if !query_options.empty?
 			q << "?"
 			q << query_options.join('&')	

data/ruby_odata.gemspec

@@ -5,41 +5,27 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby_odata}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Damien White"]
-  s.date = %q{2010-06-11}
+  s.date = %q{2010-06-12}
   s.description = %q{An OData Client Library for Ruby.  Use this to interact with OData services}
   s.email = %q{damien.white@visoftinc.com}
   s.extra_rdoc_files = [
-    "LICENSE",
+    "CHANGELOG.rdoc",
+     "LICENSE",
      "README.rdoc"
   ]
   s.files = [
     ".gitignore",
+     "CHANGELOG.rdoc",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",
      "config/cucumber.yml",
-     "doc/classes/OData.html",
-     "doc/classes/OData/ClassBuilder.html",
-     "doc/classes/OData/Operation.html",
-     "doc/classes/OData/QueryBuilder.html",
-     "doc/classes/OData/Service.html",
-     "doc/created.rid",
-     "doc/files/README_rdoc.html",
-     "doc/files/lib/odata_ruby/class_builder_rb.html",
-     "doc/files/lib/odata_ruby/operation_rb.html",
-     "doc/files/lib/odata_ruby/query_builder_rb.html",
-     "doc/files/lib/odata_ruby/service_rb.html",
-     "doc/files/lib/odata_ruby_rb.html",
-     "doc/fr_class_index.html",
-     "doc/fr_file_index.html",
-     "doc/fr_method_index.html",
-     "doc/index.html",
-     "doc/rdoc-style.css",
+     "features/query_builder.feature",
      "features/service.feature",
      "features/service_manage.feature",
      "features/step_definitions/service_steps.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_odata
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Damien White
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-11 00:00:00 -04:00
+date: 2010-06-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,32 +73,18 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- CHANGELOG.rdoc
 - LICENSE
 - README.rdoc
 files: 
 - .gitignore
+- CHANGELOG.rdoc
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
 - config/cucumber.yml
-- doc/classes/OData.html
-- doc/classes/OData/ClassBuilder.html
-- doc/classes/OData/Operation.html
-- doc/classes/OData/QueryBuilder.html
-- doc/classes/OData/Service.html
-- doc/created.rid
-- doc/files/README_rdoc.html
-- doc/files/lib/odata_ruby/class_builder_rb.html
-- doc/files/lib/odata_ruby/operation_rb.html
-- doc/files/lib/odata_ruby/query_builder_rb.html
-- doc/files/lib/odata_ruby/service_rb.html
-- doc/files/lib/odata_ruby_rb.html
-- doc/fr_class_index.html
-- doc/fr_file_index.html
-- doc/fr_method_index.html
-- doc/index.html
-- doc/rdoc-style.css
+- features/query_builder.feature
 - features/service.feature
 - features/service_manage.feature
 - features/step_definitions/service_steps.rb

data/doc/classes/OData.html

@@ -1,126 +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>Module: OData</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">OData</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 />
-                <a href="../files/lib/odata_ruby/operation_rb.html">
-                lib/odata_ruby/operation.rb
-                </a>
-        <br />
-                <a href="../files/lib/odata_ruby/query_builder_rb.html">
-                lib/odata_ruby/query_builder.rb
-                </a>
-        <br />
-                <a href="../files/lib/odata_ruby/service_rb.html">
-                lib/odata_ruby/service.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-
-
-   </div>
-
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-    <div id="class-list">
-      <h3 class="section-bar">Classes and Modules</h3>
-
-      Class <a href="OData/ClassBuilder.html" class="link">OData::ClassBuilder</a><br />
-Class <a href="OData/Operation.html" class="link">OData::Operation</a><br />
-Class <a href="OData/QueryBuilder.html" class="link">OData::QueryBuilder</a><br />
-Class <a href="OData/Service.html" class="link">OData::Service</a><br />
-
-    </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>