ruby_odata 0.0.7 → 0.0.8

data/.gitignore

@@ -7,4 +7,8 @@ tmp/*
 test/SampleService/App_Data/TestDB.mdf
 test/SampleService/App_Data/TestDB_Log.ldf
 pkg/*
-doc/*
+doc/*
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/CHANGELOG.rdoc

@@ -1,38 +1,46 @@
-= ruby_odata Change Log
-
-=== 0.0.1 
-* New Features
-  * Basic CRUD Operations
-  * Query Enhancement: Filters
-  * Query Enhancement: Expands
-
-=== 0.0.2
-* New Features
-  * Query Enhancement: Order By (both desc and asc)
-
-=== 0.0.3
-* Bug Fixes
-  * Rearranged code to match the gem name.  Things were mismatched between odata_ruby and ruby_odata.
-
-=== 0.0.4
-* New Features
-  * Query Enhancement: skip
-  * Query Enhancement: top
-  * Ability to perform paging using skip and top together
-  * Updated README with examples for order_by, skip, and top
-  
-=== 0.0.5
-* Bug Fixes
-  * Works with Ruby 1.9.1
-  * 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
-
-=== 0.0.7
-* New Features
-  * Complex Types are now supported
-  * Support for Edm.Int16, Edm.Int32, Edm.Int64
-  * Support for Edm.Decimal
-  * Support for Edm.DateTime
+= ruby_odata Change Log
+
+=== 0.0.1 
+* New Features
+  * Basic CRUD Operations
+  * Query Enhancement: Filters
+  * Query Enhancement: Expands
+
+=== 0.0.2
+* New Features
+  * Query Enhancement: Order By (both desc and asc)
+
+=== 0.0.3
+* Bug Fixes
+  * Rearranged code to match the gem name.  Things were mismatched between odata_ruby and ruby_odata.
+
+=== 0.0.4
+* New Features
+  * Query Enhancement: skip
+  * Query Enhancement: top
+  * Ability to perform paging using skip and top together
+  * Updated README with examples for order_by, skip, and top
+  
+=== 0.0.5
+* Bug Fixes
+  * Works with Ruby 1.9.1
+  * 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
+
+=== 0.0.7
+* New Features
+  * Complex Types are now supported
+  * Support for Edm.Int16, Edm.Int32, Edm.Int64
+  * Support for Edm.Decimal
+  * Support for Edm.DateTime
+  
+=== 0.0.8
+* New Features
+  * Basic HTTP Authentication (thanks J.D. Mullin)\
+  * Modified cucumber tests to setup the test database so you no longer need to copy them yourself
+* Bug Fixes
+  * ActiveSupport 2.3.x (tested 2.3.11) and 3.0.x (tested 3.0.4) are now supported
+  * Works with Ruby 1.9.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ruby_odata.gemspec
+gemspec

data/LICENSE

@@ -1,24 +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.
+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

@@ -1,153 +1,179 @@
-= ruby_odata
-
-The <b>Open Data Protocol</b> (OData) is a fantastic way to query and update data over standard Web technologies.  The ruby_odata library acts as a consumer of OData services.
-
-== Resources
-
-* Source Code (hosted on GitHub): http://github.com/visoft/ruby_odata 
-* Documentation (hosted on rdoc.info): http://rdoc.info/projects/visoft/ruby_odata 
-* Issue tracking (hosted on Lighthouse): http://visoft.lighthouseapp.com/projects/54309/home 
-* Wiki (hosted on GitHub): http://wiki.github.com/visoft/ruby_odata/
-* Gem (hosted on Gemcutter): http://gemcutter.org/gems/ruby_odata
-* Blog articles: {Introducing a Ruby OData Client Library}[http://bit.ly/IntroRubyOData]
-
-== Installation
-You can install ruby_odata as a gem using:
-	gem install ruby_odata
-
-== Usage
-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:
-
-	require 'lib/ruby_odata'
-	
-	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/ruby_odata'
-		
-	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/ruby_odata'
-	
-	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/ruby_odata'
-	
-	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, add filters, order, skip records, and take only the top X records to the query before executing it.  For example:
-
-=== Expanding
-Expanding allows you to eagerly load other objects that are children of the root.
-You can use more than one expand on a query.  
-For expanding grandchild and lower entities, you must pass in the full path from the root, for example +Products.expand('Orders').expand('Orders/LineItems')+
-
-	# 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
-The syntax for filtering can be found on the {OData Protocol URI Conventions}[http://www.odata.org/developers/protocols/uri-conventions#FilterSystemQueryOption] page.
-You can use more than one filter, if you call the filter method multiple times it will before an AND.
-
-	# 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
-The query operations follow a {fluent interface}[http://en.wikipedia.org/wiki/Fluent_interface], although they can be added by themselves as well as chained
-
-	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}"
-
-=== Order By
-You can order the results by properties of your choice, either ascending or descending.
-Order by are similar to +expand+s in that you can use more than one of them on a query.
-For expanding grandchild and lower entities, you must pass in the full path from the root like would do on an +expand+
-
-	svc.Products.order_by("Name")
-	products = svc.execute
-
-	# Specifically requesting descending
-	svc.Products.order_by("Name desc")
-	products = svc.execute
-	
-	# Specifically requesting ascending
-	svc.Products.order_by("Name asc")
-	products = svc.execute
-	
-=== Skip
-Skip allows you to skip a number of records when querying.  This is often used for paging along with +top+.
-	
-	svc.Products.skip(5)
-	products = svc.execute # => skips the first 5 items 
-	
-=== Top
-Top allows you only retrieve the top X number of records when querying.  This is often used for paging along with +skip+.
-	
-	svc.Products.top(5)
-	products = svc.execute # => returns only the first 5 items	
-
-== Tests
-===DATABASE SETUP - DO THIS FIRST
-Within /test/SampleService/App_Data/ rename _TestDB*.* to TestDB*.*. This file is just the initial 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
-
-
+= ruby_odata
+
+The <b>Open Data Protocol</b> (OData) is a fantastic way to query and update data over standard Web technologies.  The ruby_odata library acts as a consumer of OData services.
+
+== Resources
+
+* Source Code (hosted on GitHub): http://github.com/visoft/ruby_odata 
+* Documentation (hosted on rdoc.info): http://rdoc.info/projects/visoft/ruby_odata 
+* Issue tracking (hosted on Lighthouse): http://visoft.lighthouseapp.com/projects/54309/home 
+* Wiki (hosted on GitHub): http://wiki.github.com/visoft/ruby_odata/
+* Gem (hosted on Gemcutter): http://gemcutter.org/gems/ruby_odata
+* Blog articles: {Introducing a Ruby OData Client Library}[http://bit.ly/IntroRubyOData]
+
+== Installation
+You can install ruby_odata as a gem using:
+  gem install ruby_odata
+
+== Usage
+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:
+
+  require 'lib/ruby_odata'
+  
+  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/ruby_odata'
+    
+  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/ruby_odata'
+  
+  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/ruby_odata'
+  
+  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, add filters, order, skip records, and take only the top X records to the query before executing it.  For example:
+
+=== Authentication
+Basic HTTP Authentication is supported via sending a username and password as service constructor arguments:
+
+  require 'lib/ruby_odata'
+  
+  svc = OData::Service.new "http://127.0.0.1:8888/SampleService/Entities.svc", { :username => "bob", :password=> "12345" }
+
+=== Expanding
+Expanding allows you to eagerly load other objects that are children of the root.
+You can use more than one expand on a query.  
+For expanding grandchild and lower entities, you must pass in the full path from the root, for example +Products.expand('Orders').expand('Orders/LineItems')+
+
+  # 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
+The syntax for filtering can be found on the {OData Protocol URI Conventions}[http://www.odata.org/developers/protocols/uri-conventions#FilterSystemQueryOption] page.
+You can use more than one filter, if you call the filter method multiple times it will before an AND.
+
+  # 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}"
+  
+Note you can pass more than one filter in the string, for example (querying Netflix): 
+
+  svc.Titles.filter("Rating eq 'PG' and ReleaseYear eq 1980")
+
+Filters can also be chained, by doing this you will create an "and" filter (just like the last example) when it is passed to the server.
+
+  svc.Titles.filter("Rating eq 'PG'").filter("ReleaseYear eq 1980")
+
+  
+=== Combining Expanding and Filtering
+The query operations follow a {fluent interface}[http://en.wikipedia.org/wiki/Fluent_interface], although they can be added by themselves as well as chained
+
+  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}"
+
+=== Order By
+You can order the results by properties of your choice, either ascending or descending.
+Order by are similar to +expand+s in that you can use more than one of them on a query.
+For expanding grandchild and lower entities, you must pass in the full path from the root like would do on an +expand+
+
+  svc.Products.order_by("Name")
+  products = svc.execute
+
+  # Specifically requesting descending
+  svc.Products.order_by("Name desc")
+  products = svc.execute
+  
+  # Specifically requesting ascending
+  svc.Products.order_by("Name asc")
+  products = svc.execute
+  
+Like the fiter method, order_by statements can also be chained like so:
+
+  svc.Products.order_by("Name asc").order_by("Price desc")
+
+
+=== Skip
+Skip allows you to skip a number of records when querying.  This is often used for paging along with +top+.
+  
+  svc.Products.skip(5)
+  products = svc.execute # => skips the first 5 items 
+  
+=== Top
+Top allows you only retrieve the top X number of records when querying.  This is often used for paging along with +skip+.
+  
+  svc.Products.top(5)
+  products = svc.execute # => returns only the first 5 items	
+
+== Tests
+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 (must use IIS instead of development web server in order for basic auth tests to pass, however).  Another option is to use IIS Express. It is a free download from Microsoft. Once installed, there is a batch file found in /test called "iisExpress x64.bat", you can run the batch file and just close the command window. There is a also an "iisExpress x86.bat" file for those of you running a 32-bit machine.  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.
+
+Note there are also Cassini batch files that you can use as well, but the basic auth tests will fail if using this server (which doesn't support basic http authentication).
+
+If you are testing on a Windows machine, you may encounter a problem with using cucumber and Ruby 1.9.2.  You will get a message when you fire up cucumber about missing msvcrt-ruby18.dll.  The fix for this is to make sure you have the {RubyInstaller DevKit}[https://github.com/oneclick/rubyinstaller/wiki/Development-Kit] installed, then do the following:
+  gem uninstall json
+  gem install json --platform=ruby -v 1.4.6
+
+From the BASE ruby_odata directory, run cucumber, which will execute all of the tests.
+