ruby_odata 0.0.5 → 0.0.6

data/CHANGELOG.rdoc

@@ -24,4 +24,9 @@
 === 0.0.5
 * Bug Fixes
 	* Works with Ruby 1.9.1
-	* Works with ActiveSupport 3.0.0.beta4
+	* Works with ActiveSupport 3.0.0.beta4
+	
+=== 0.0.6
+* New Features
+	* Ability to batch saves (Adds, Updates, Deletes); this will help save on network chatter
+	

data/README.rdoc

@@ -16,9 +16,8 @@ You can install ruby_odata as a gem using:
 	gem install ruby_odata
 
 == 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).
-
 As of version 0.0.5, support has been added for ActiveSupport 3.0.0 beta 4 and Ruby 1.9.1
+As of version 0.0.6, support has been added for batch saves
 
 === 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:

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/features/batch_request.feature

@@ -0,0 +1,94 @@
+Feature: Batch request
+  In order to minimize network traffic
+  As a user of the library
+  I want to be able to batch changes (Add/Update/Delete) and persist the batch instead of one at a time
+  
+Background:
+  Given an ODataService exists with uri: "http://localhost:8888/SampleService/Entities.svc"
+  And blueprints exist for the service
+
+Scenario: Save Changes should allow for batch additions
+  Given I call "AddToProducts" on the service with a new "Product" object with Name: "Product 1"
+  And I call "AddToProducts" on the service with a new "Product" object with Name: "Product 2"
+  When I save changes
+  Then the save result should equal: "true"
+  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 |
+
+Scenario: Save Changes should allow for batch updates
+  Given I call "AddToProducts" on the service with a new "Product" object with Name: "Product 1"
+  And I call "AddToProducts" on the service with a new "Product" object with Name: "Product 2"
+  When I save changes
+  When I call "Products" on the service
+  And I filter the query with: "Name eq 'Product 1'"
+  And I run the query
+  And I set "Name" on the result to "Product 1 - Updated"
+  And I call "update_object" on the service with the last query result
+  When I call "Products" on the service
+  And I filter the query with: "Name eq 'Product 2'"
+  And I run the query 
+  And I set "Name" on the result to "Product 2 - Updated"
+  And I call "update_object" on the service with the last query result
+  When I save changes
+  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 - Updated |
+  | Product 2 - Updated |
+
+Scenario: Save Changes should allow for batch deletes
+  Given I call "AddToProducts" on the service with a new "Product" object with Name: "Product 1"
+  And I call "AddToProducts" on the service with a new "Product" object with Name: "Product 2"
+  And I call "AddToProducts" on the service with a new "Product" object with Name: "Product 3"
+  And I call "AddToProducts" on the service with a new "Product" object with Name: "Product 4"
+  When I save changes
+  When I call "Products" on the service
+  And I filter the query with: "Name eq 'Product 2'"
+  And I run the query
+  And I call "delete_object" on the service with the last query result
+  When I call "Products" on the service
+  And I filter the query with: "Name eq 'Product 3'"
+  And I run the query 
+  And I call "delete_object" on the service with the last query result
+  When I save changes
+  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 4 |
+
+Scenario: Save Changes should allow for a mix of adds, updates, and deletes to be batched
+  Given the following Products exist:
+  | Name      |
+  | Product 1 |
+  | Product 2 |
+  And I call "AddToProducts" on the service with a new "Product" object with Name: "Product 3"
+  And I call "AddToProducts" on the service with a new "Product" object with Name: "Product 4"
+  When I call "Products" on the service
+  And I filter the query with: "Name eq 'Product 1'"
+  And I run the query
+  And I set "Name" on the result to "Product 1 - Updated"
+  And I call "update_object" on the service with the last query result
+  When I call "Products" on the service
+  And I filter the query with: "Name eq 'Product 2'"
+  And I run the query
+  And I call "delete_object" on the service with the last query result
+  When I save changes
+  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 - Updated |
+  | Product 3           |
+  | Product 4           |
+

data/features/step_definitions/service_steps.rb

@@ -137,17 +137,38 @@ Then /^no "([^\"]*)" should exist$/ do |collection|
 	results.should == []
 end
 
-Given /^the following (.*) exist:$/ do |plural_factory, table|
+ 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
-	factory = plural_factory.singularize
-	table.hashes.map do |hash|
-		obj = factory.constantize.send(:make, hash)
-  	@service.send("AddTo#{plural_factory}", obj)
-  	@service.save_changes
+  
+  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 result should be:$/ do |table|
+Then /^the save result should be:$/ do |table|
   # table is a Cucumber::Ast::Table
   
   fields = table.hashes[0].keys
@@ -155,7 +176,7 @@ Then /^the result should be:$/ do |table|
   # Build an array of hashes so that we can compare tables
   results = []
   
-  @service_result.each do |result|
+  @saved_result.each do |result|
   	obj_hash = Hash.new
   	fields.each do |field|
   		obj_hash[field] = result.send(field)

data/lib/ruby_odata/service.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 module OData
 	
 class Service
@@ -9,6 +11,7 @@ class Service
 	def initialize(service_uri)		
 		@uri = service_uri
 		@collections = get_collections
+		@save_operations = []
 		build_classes
 	end
 	
@@ -24,7 +27,7 @@ class Service
 		elsif name.to_s =~ /^AddTo(.*)/
 			type = $1
 			if @collections.include?(type)
-				@save_operation = Operation.new("Add", $1, args[0])
+				@save_operations << Operation.new("Add", $1, args[0])
 			else
 				super
 			end
@@ -43,7 +46,7 @@ class Service
 	def delete_object(obj)
 		type = obj.class.to_s
 		if obj.respond_to?(:__metadata) && !obj.send(:__metadata).nil? 
-			@save_operation = Operation.new("Delete", type, obj)
+			@save_operations << Operation.new("Delete", type, obj)
 		else
 			raise "You cannot delete a non-tracked entity"
 		end
@@ -58,7 +61,7 @@ class Service
 	def update_object(obj)
 		type = obj.class.to_s
 		if obj.respond_to?(:__metadata) && !obj.send(:__metadata).nil? 
-			@save_operation = Operation.new("Update", type, obj)
+			@save_operations << Operation.new("Update", type, obj)
 		else
 			raise "You cannot update a non-tracked entity"
 		end		
@@ -66,27 +69,20 @@ class Service
 	
 	# Performs save operations (Create/Update/Delete) against the server
 	def save_changes
-		return nil if @save_operation.nil?
+		return nil if @save_operations.empty?
 
 		result = nil
-
-		if @save_operation.kind == "Add"
-			save_uri = "#{@uri}/#{@save_operation.klass_name}"
-			json_klass = @save_operation.klass.to_json(:type => :add)
-			post_result = RestClient.post save_uri, json_klass, :content_type => :json
-			result = build_classes_from_result(post_result)
-		elsif @save_operation.kind == "Update"
-			update_uri = @save_operation.klass.send(:__metadata)[:uri]
-			json_klass = @save_operation.klass.to_json
-			update_result = RestClient.put update_uri, json_klass, :content_type => :json
-			return (update_result.code == 204)
-		elsif @save_operation.kind == "Delete"
-			delete_uri = @save_operation.klass.send(:__metadata)[:uri]
-			delete_result = RestClient.delete delete_uri
-			return (delete_result.code == 204) 
+		
+		if @save_operations.length == 1
+			result = single_save(@save_operations[0])			
+		else	
+			result = batch_save(@save_operations)			
 		end
-
-		@save_operation = nil # Clear out the last operation
+		
+		# TODO: We should probably perform a check here 
+		# to make sure everything worked before clearing it out
+		@save_operations.clear 
+		
 		return result
 	end
 
@@ -202,6 +198,90 @@ class Service
 		# Add the property
 		klass.send "#{property_name}=", inline_klass
 	end
+	def single_save(operation)
+		if operation.kind == "Add"
+			save_uri = "#{@uri}/#{operation.klass_name}"
+			json_klass = operation.klass.to_json(:type => :add)
+			post_result = RestClient.post save_uri, json_klass, :content_type => :json
+			return build_classes_from_result(post_result)
+		elsif operation.kind == "Update"
+			update_uri = operation.klass.send(:__metadata)[:uri]
+			json_klass = operation.klass.to_json
+			update_result = RestClient.put update_uri, json_klass, :content_type => :json
+			return (update_result.code == 204)
+		elsif operation.kind == "Delete"
+			delete_uri = operation.klass.send(:__metadata)[:uri]
+			delete_result = RestClient.delete delete_uri
+			return (delete_result.code == 204) 
+		end		
+	end
+	def batch_save(operations)	
+		batch_num = generate_guid
+		changeset_num = generate_guid
+		batch_uri = "#{@uri}/$batch"
+		
+		body = build_batch_body(operations, batch_num, changeset_num)
+		
+		result = RestClient.post batch_uri, body, :content_type => "multipart/mixed; boundary=batch_#{batch_num}"
+		
+		# TODO: More result validation needs to be done.  
+		# The result returns HTTP 202 even if there is an error in the batch
+		return (result.code == 202)
+	end
+	def build_batch_body(operations, batch_num, changeset_num)
+		# Header		
+		body = "--batch_#{batch_num}\n"
+		body << "Content-Type: multipart/mixed;boundary=changeset_#{changeset_num}\n\n"
+
+		# Operations
+		operations.each do |operation|
+			body << build_batch_operation(operation, changeset_num)
+			body << "\n"
+		end
+				
+		# Footer		
+		body << "\n\n--changeset_#{changeset_num}--\n"
+		body << "--batch_#{batch_num}--"
+		
+		return body
+	end
+	
+	def build_batch_operation(operation, changeset_num)
+		accept_headers = "Accept-Charset: utf-8\n"
+		accept_headers << "Content-Type: application/json;charset=utf-8\n" unless operation.kind == "Delete"
+		accept_headers << "\n"
+	
+		content = "--changeset_#{changeset_num}\n"
+		content << "Content-Type: application/http\n"
+		content << "Content-Transfer-Encoding: binary\n\n"
+		
+		if operation.kind == "Add"			
+			save_uri = "#{@uri}/#{operation.klass_name}"
+			json_klass = operation.klass.to_json(:type => :add)
+			
+			content << "POST #{save_uri} HTTP/1.1\n"
+			content << accept_headers
+			content << json_klass
+		elsif operation.kind == "Update"
+			update_uri = operation.klass.send(:__metadata)[:uri]
+			json_klass = operation.klass.to_json
+			
+			content << "PUT #{update_uri} HTTP/1.1\n"
+			content << accept_headers
+			content << json_klass
+		elsif operation.kind == "Delete"
+			delete_uri = operation.klass.send(:__metadata)[:uri]
+			
+			content << "DELETE #{delete_uri} HTTP/1.1\n"
+			content << accept_headers
+		end		
+			
+		return content
+	end
+	
+	def generate_guid
+		rand(36**12).to_s(36).insert(4, "-").insert(9, "-")
+	end
 end
 
 end # module OData

data/ruby_odata.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby_odata}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Damien White"]
-  s.date = %q{2010-06-13}
+  s.date = %q{2010-06-17}
   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 = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "config/cucumber.yml",
+     "features/batch_request.feature",
      "features/query_builder.feature",
      "features/service.feature",
      "features/service_manage.feature",

data/test/SampleService/App_Code/Entities.cs

@@ -1,9 +1,11 @@
 using System.Data.Services;
 using System.Data.Services.Common;
+using System.ServiceModel;
 using System.ServiceModel.Web;
 using System.Web;
 using Model;
 
+[ServiceBehavior(IncludeExceptionDetailInFaults = true)]
 public class Entities : DataService< ModelContainer >
 {
     // This method is called only once to initialize service-wide policies.
@@ -12,6 +14,7 @@ public class Entities : DataService< ModelContainer >
         config.SetEntitySetAccessRule("*", EntitySetRights.All);
         config.SetServiceOperationAccessRule("*", ServiceOperationRights.All);
         config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V2;
+        config.UseVerboseErrors = true;
     }
 
     /// <summary>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_odata
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Damien White
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-13 00:00:00 -04:00
+date: 2010-06-17 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,6 +84,7 @@ files:
 - Rakefile
 - VERSION
 - config/cucumber.yml
+- features/batch_request.feature
 - features/query_builder.feature
 - features/service.feature
 - features/service_manage.feature