ruby_odata 0.0.7 → 0.0.8

data/features/support/env.rb

@@ -1,4 +1,14 @@
-require 'lib/ruby_odata'
-require 'machinist/object'
-require 'sham'
-require 'faker'
+lib = File.expand_path(File.join(File.dirname(__FILE__), "../..", "lib"))
+
+require lib + '/ruby_odata'
+require 'machinist/object'
+require 'sham'
+require 'faker'
+
+require 'fileutils'
+root_dir = File.expand_path(File.join(File.dirname(__FILE__), "../..", "test/SampleService/App_Data"))
+
+if !File.exists?("#{root_dir}/TestDB.mdf")
+  FileUtils.copy("#{root_dir}/_TestDB.mdf", "#{root_dir}/TestDB.mdf")
+  FileUtils.copy("#{root_dir}/_TestDB_Log.ldf", "#{root_dir}/TestDB_Log.ldf")
+end

data/features/support/hooks.rb

@@ -1,4 +1,4 @@
-Before do
-	Sham.reset
-	RestClient.post "http://localhost:8888/SampleService/Entities.svc/CleanDatabaseForTesting", {}
+Before do
+  Sham.reset
+  RestClient.post "http://localhost:8888/SampleService/Entities.svc/CleanDatabaseForTesting", {}
 end

data/features/type_conversion.feature

@@ -1,45 +1,53 @@
-Feature: Type conversion
-  In order to accurately perform operations
-  As a user of the API 
-  I want types returned to be accurately represented
-
-Background:
-  Given an ODataService exists with uri: "http://localhost:8888/SampleService/Entities.svc"
-  And blueprints exist for the service
-
-Scenario: Integers should be Fixnums
-  Given I call "AddToProducts" on the service with a new "Product" object
-	And I save changes
-  When I call "Products" on the service
-  And I run the query
-  Then the "Id" method should return a Fixnum 
-  
-Scenario: Decimals should be BigDecimals
-	Given I call "AddToProducts" on the service with a new "Product" object
-  And I save changes
-	When I call "Products" on the service
-  And I run the query
-  Then the "Price" method should return a BigDecimal
-
-Scenario: DateTimes should be Times
-	Given I call "AddToProducts" on the service with a new "Product" object
-  And I save changes
-	When I call "Products" on the service
-  And I run the query
-	Then the "AuditFields.CreateDate" method should return a Time
- 
-Scenario: Verify that DateTimes don't change if not modified on an update
-	Given I call "AddToProducts" on the service with a new "Product" object with Name: "Test Product"
-	When I save changes
-	And I call "Products" on the service with args: "1"
-  And I run the query
-  Then I store the last query result for comparison
-  When I set "Name" on the result to "Changed Test Product"
-  Then the method "Name" on the result should equal: "Changed Test Product"
-  And I call "update_object" on the service with the last query result
-  And I save changes
-  Then the save result should equal: "true"
-  When I call "Products" on the service with args: "1"
-  And I run the query
-  Then the new query result's time "AuditFields.CreateDate" should equal the saved query result
-
+Feature: Type conversion
+  In order to accurately perform operations
+  As a user of the API 
+  I want types returned to be accurately represented
+
+Background:
+  Given an ODataService exists with uri: "http://localhost:8888/SampleService/Entities.svc"
+  And blueprints exist for the service
+
+Scenario: Integers should be Fixnums
+  Given I call "AddToProducts" on the service with a new "Product" object
+	And I save changes
+  When I call "Products" on the service
+  And I run the query
+  Then the "Id" method should return a Fixnum 
+  
+Scenario: Decimals should be BigDecimals
+	Given I call "AddToProducts" on the service with a new "Product" object
+  And I save changes
+	When I call "Products" on the service
+  And I run the query
+  Then the "Price" method should return a BigDecimal
+
+Scenario: DateTimes should be Times
+	Given I call "AddToProducts" on the service with a new "Product" object
+  And I save changes
+	When I call "Products" on the service
+  And I run the query
+	Then the "AuditFields.CreateDate" method should return a Time
+ 
+Scenario: Verify that DateTimes don't change if not modified on an update
+	Given I call "AddToProducts" on the service with a new "Product" object with Name: "Test Product"
+	When I save changes
+	And I call "Products" on the service with args: "1"
+  And I run the query
+  Then I store the last query result for comparison
+  When I set "Name" on the result to "Changed Test Product"
+  Then the method "Name" on the result should equal: "Changed Test Product"
+  And I call "update_object" on the service with the last query result
+  And I save changes
+  Then the save result should equal: "true"
+  When I call "Products" on the service with args: "1"
+  And I run the query
+  Then the new query result's time "AuditFields.CreateDate" should equal the saved query result
+
+Scenario: DateTimes should be able to be null
+	Given I call "AddToProducts" on the service with a new "Product" object
+  And I save changes
+	When I call "Products" on the service
+  And I run the query
+  Then the "DiscontinuedDate" method should return a NilClass
+
+

data/lib/ruby_odata.rb

@@ -1,18 +1,18 @@
-lib =  File.dirname(__FILE__)
-
-$: << lib + '/ruby_odata/'
-require 'rubygems'
-require 'active_support' # Used for serializtion to JSON
-require 'active_support/inflector'
-require 'active_support/core_ext'
-require 'cgi'
-require 'open-uri'
-require 'rest_client'
-require 'nokogiri'
-require 'bigdecimal'
-require 'bigdecimal/util'
-
-require lib + '/ruby_odata/query_builder'
-require lib + '/ruby_odata/class_builder'
-require lib + '/ruby_odata/operation'
+lib =  File.dirname(__FILE__)
+
+$: << lib + '/ruby_odata/'
+require 'rubygems'
+require 'active_support' # Used for serializtion to JSON
+require 'active_support/inflector'
+require 'active_support/core_ext'
+require 'cgi'
+require 'open-uri'
+require 'rest_client'
+require 'nokogiri'
+require 'bigdecimal'
+require 'bigdecimal/util'
+
+require lib + '/ruby_odata/query_builder'
+require lib + '/ruby_odata/class_builder'
+require lib + '/ruby_odata/operation'
 require lib + '/ruby_odata/service'

data/lib/ruby_odata/class_builder.rb

@@ -1,109 +1,117 @@
-module OData
-	# Internally used helper class for building a dynamic class.  This class shouldn't be called directly.
-	class ClassBuilder
-		# Creates a new instance of the ClassBuilder class
-		#
-		# ==== Required Attributes
-		# - klass_name: 	The name/type of the class to create
-		# - methods:			The accessor methods to add to the class
-		# - nav_props:		The accessor methods to add for navigation properties
-		def initialize(klass_name, methods, nav_props)
-			@klass_name = klass_name
-			@methods = methods
-			@nav_props = nav_props
-		end
-		
-		# Returns a dynamically generated class definition based on the constructor parameters
-		def build
-			# return if already built
-		  return @klass unless @klass.nil?
-		
-		  # need the class name to build class
-		  return nil    if @klass_name.nil?
-		      
-			# return if we can find constant corresponding to class name
-			if Object.const_defined? @klass_name
-				@klass = @klass_name.constantize
-				return @klass
-			end
-		      
-			Object.const_set(@klass_name, Class.new.extend(ActiveSupport::JSON))
-		  @klass = @klass_name.constantize
- 
-			add_methods(@klass)
-			add_nav_props(@klass)
-			
-		  return @klass
-		end
-		
-		private
-		def add_methods(klass)
-			# Add metadata methods
-			klass.send :define_method, :__metadata do
-				instance_variable_get("@__metadata")
-			end
-			klass.send :define_method, :__metadata= do |value|
-					instance_variable_set("@__metadata", value)
-			end
-		  klass.send :define_method, :as_json do |options|
-				meta = '__metadata'
-
-				options ||= {}
-				options[:type] ||= :unknown
-
-				vars = self.instance_values
-
-				# For adds, we need to get rid of all attributes except __metadata when passing
-				# the object to the server
-				# TODO: There should be a universal way to figure out if we are on an addition
-				#   activesupport 2.3.8 doesn't pass through the :type to all levels, but passes :seen
-				#		activesupport 3.0.0.beta4 doesn't pass :seen in options
-				if (options[:type] == :add || !options[:seen].nil?) && vars.has_key?(meta)
-					vars.delete_if { |k,v| k != meta}
-				else
-					vars.delete(meta)
-				end
-
-				# Convert a BigDecimal to a string for serialization (to match Edm.Decimal)
-				decimals = vars.find_all { |o| o[1].class == BigDecimal } || []
-				decimals.each do |d|
-					vars[d[0]] = d[1].to_s
-				end
-
-				# Convert Time to an RFC3339 string for serialization
-				times = vars.find_all { |o| o[1].class == Time } || []
-				times.each do |t|
-          sdate = t[1].xmlschema(3)
-          # Remove the ending Z (indicating UTC).
-          # If the Z is there when saving, the time is converted to local time on the server
-          sdate.chop! if sdate.match(/Z$/)
-					vars[t[0]] = sdate
-				end
-
-				vars
-			end
-
-
-			# Add the methods that were passed in
-			@methods.each do |method_name|
-				klass.send :define_method, method_name do
-					instance_variable_get("@#{method_name}")
-				end
-				klass.send :define_method, "#{method_name}=" do |value|
-					instance_variable_set("@#{method_name}", value)
-				end
-			end
-		end
-
-		def add_nav_props(klass)
-			@nav_props.each do |method_name|
-				klass.send :define_method, method_name do
-					instance_variable_get("@#{method_name}")
-				end
-				klass.send :define_method, "#{method_name}=" do |value|
-					instance_variable_set("@#{method_name}", value)
-				end
-			end
-		end
-	end
-end # module OData
+module OData
+  # Internally used helper class for building a dynamic class.  This class shouldn't be called directly.
+  class ClassBuilder
+    # Creates a new instance of the ClassBuilder class
+    #
+    # ==== Required Attributes
+    # - klass_name: 	The name/type of the class to create
+    # - methods:			The accessor methods to add to the class
+    # - nav_props:		The accessor methods to add for navigation properties
+    def initialize(klass_name, methods, nav_props)
+      @klass_name = klass_name
+      @methods = methods
+      @nav_props = nav_props
+    end
+    
+    # Returns a dynamically generated class definition based on the constructor parameters
+    def build
+      # return if already built
+      return @klass unless @klass.nil?
+    
+      # need the class name to build class
+      return nil    if @klass_name.nil?
+          
+      # return if we can find constant corresponding to class name
+      if Object.const_defined? @klass_name
+        @klass = @klass_name.constantize
+        return @klass
+      end
+
+      Object.const_set(@klass_name, Class.new.extend(ActiveSupport::JSON))
+      @klass = @klass_name.constantize
+      @klass.class_eval do
+        include OData
+      end
+
+      add_methods(@klass)
+      add_nav_props(@klass)
+      
+      return @klass
+    end
+    
+    private
+    def add_methods(klass)
+      # Add metadata methods
+      klass.send :define_method, :__metadata do
+        instance_variable_get("@__metadata")
+      end
+      klass.send :define_method, :__metadata= do |value|
+          instance_variable_set("@__metadata", value)
+      end
+      klass.send :define_method, :as_json do |*args|
+        meta = RUBY_VERSION < "1.9" ? '@__metadata' :'@__metadata'.to_sym
+
+        options = args[0] || {}
+        options[:type] ||= :unknown
+
+        vars = self.instance_values
+
+        # For adds, we need to get rid of all attributes except __metadata when passing
+        # the object to the server
+        if(options[:type] == :add)
+          vars.each_value do |value|
+            if value.is_a? OData
+              child_vars = value.instance_variables
+              if(child_vars.include?(meta))
+                child_vars.each do |var|
+                  value.send :remove_instance_variable, var if var != meta
+                end
+              else
+                value.send :remove_instance_variable, meta if value.instance_variable_defined? meta
+              end
+            end
+          end
+        end
+
+        # Convert a BigDecimal to a string for serialization (to match Edm.Decimal)
+        decimals = vars.find_all { |o| o[1].class == BigDecimal } || []
+        decimals.each do |d|
+          vars[d[0]] = d[1].to_s
+        end
+
+        # Convert Time to an RFC3339 string for serialization
+        times = vars.find_all { |o| o[1].class == Time } || []
+        times.each do |t|
+          sdate = t[1].xmlschema(3)
+          # Remove the ending Z (indicating UTC).
+          # If the Z is there when saving, the time is converted to local time on the server
+          sdate.chop! if sdate.match(/Z$/)
+          vars[t[0]] = sdate
+        end
+
+        vars
+      end
+
+      # Add the methods that were passed in
+      @methods.each do |method_name|
+        klass.send :define_method, method_name do
+          instance_variable_get("@#{method_name}")
+        end
+        klass.send :define_method, "#{method_name}=" do |value|
+          instance_variable_set("@#{method_name}", value)
+        end
+      end
+    end
+
+    def add_nav_props(klass)
+      @nav_props.each do |method_name|
+        klass.send :define_method, method_name do
+          instance_variable_get("@#{method_name}")
+        end
+        klass.send :define_method, "#{method_name}=" do |value|
+          instance_variable_set("@#{method_name}", value)
+        end
+      end
+    end
+  end
+end # module OData

data/lib/ruby_odata/operation.rb

@@ -1,18 +1,18 @@
-module OData
-	# Internally used helper class for storing operations called against the service.  This class shouldn't be used directly.
-	class Operation
-		attr_accessor :kind, :klass_name, :klass
-		
-		# Creates a new instance of the Operation class
-		#
-		# ==== Required Attributes
-		# - kind: 				The operation type (Add, Update, or Delete)
-		# - klass_name:		The name/type of the class to operate against
-		# - klass:				The actual class
-		def initialize(kind, klass_name, klass)
-			@kind = kind
-			@klass_name = klass_name
-			@klass = klass
-		end
-	end
+module OData
+  # Internally used helper class for storing operations called against the service.  This class shouldn't be used directly.
+  class Operation
+    attr_accessor :kind, :klass_name, :klass
+    
+    # Creates a new instance of the Operation class
+    #
+    # ==== Required Attributes
+    # - kind: 				The operation type (Add, Update, or Delete)
+    # - klass_name:		The name/type of the class to operate against
+    # - klass:				The actual class
+    def initialize(kind, klass_name, klass)
+      @kind = kind
+      @klass_name = klass_name
+      @klass = klass
+    end
+  end
 end

data/lib/ruby_odata/query_builder.rb

@@ -1,107 +1,107 @@
-module OData
-# The query builder is used to call query operations against the service.  This shouldn't be called directly, but rather it is returned from the dynamic methods created for the specific service that you are calling.
-#
-# For example, given the following code snippet:
-# 		svc = OData::Service.new "http://127.0.0.1:8888/SampleService/Entities.svc"
-# 		svc.Categories
-# The *Categories* method would return a QueryBuilder 
-class QueryBuilder
-	# Creates a new instance of the QueryBuilder class
-	#
-	# ==== Required Attributes
-	# - root: The root entity collection to query against
-	def initialize(root)
-		@root = root.to_s
-		@expands = []
-		@filters = []
-		@order_bys = []
-		@skip = nil
-		@top = nil
-	end
-	
-	# Used to eagerly-load data for nested objects, for example, obtaining a Category for a Product within one call to the server
-	# ==== Required Attributes
-	# - path: The path of the entity to expand relative to the root
-	#
-	# ==== Example
-	# 	# Without expanding the query (no Category will be filled in for the Product)
-	# 	svc.Products(1)
-	# 	prod1 = svc.execute
-	#
-	# 	# With expanding the query (the Category will be filled in)
-	# 	svc.Products(1).expand('Category')
-	# 	prod1 = svc.execute
-	def expand(path)
-		@expands << path
-		self
-	end
-	
-	# Used to filter data being returned
-	# ==== Required Attributes
-	# - filter: The conditions to apply to the query
-	#
-	# ==== Example	
-	# 	svc.Products.filter("Name eq 'Product 2'")
-	# 	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
-	
-	# Used to skip a number of records 
-	# This is typically used for paging, where it would be used along with the +top+ method.
-	# ==== Required Attributes
-	# - num: The number of items to skip
-	#
-	# ==== Example	
-	# 	svc.Products.skip(5)
-	# 	products = svc.execute # => skips the first 5 items	
-	def skip(num)
-		@skip = num
-		self
-	end
-	
-	# Used to take only the top X records 
-	# This is typically used for paging, where it would be used along with the +skip+ method.
-	# ==== Required Attributes
-	# - num: The number of items to return
-	#
-	# ==== Example	
-	# 	svc.Products.top(5)
-	# 	products = svc.execute # => returns only the first 5 items	
-	def top(num)
-		@top = num
-		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
-		q = @root.clone
-		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?
-		query_options << "$skip=#{@skip}" unless @skip.nil?
-		query_options << "$top=#{@top}" unless @top.nil?
-		if !query_options.empty?
-			q << "?"
-			q << query_options.join('&')	
-		end
-		return q	
-	end
-end
-
+module OData
+# The query builder is used to call query operations against the service.  This shouldn't be called directly, but rather it is returned from the dynamic methods created for the specific service that you are calling.
+#
+# For example, given the following code snippet:
+# 		svc = OData::Service.new "http://127.0.0.1:8888/SampleService/Entities.svc"
+# 		svc.Categories
+# The *Categories* method would return a QueryBuilder 
+class QueryBuilder
+  # Creates a new instance of the QueryBuilder class
+  #
+  # ==== Required Attributes
+  # - root: The root entity collection to query against
+  def initialize(root)
+    @root = root.to_s
+    @expands = []
+    @filters = []
+    @order_bys = []
+    @skip = nil
+    @top = nil
+  end
+  
+  # Used to eagerly-load data for nested objects, for example, obtaining a Category for a Product within one call to the server
+  # ==== Required Attributes
+  # - path: The path of the entity to expand relative to the root
+  #
+  # ==== Example
+  # 	# Without expanding the query (no Category will be filled in for the Product)
+  # 	svc.Products(1)
+  # 	prod1 = svc.execute
+  #
+  # 	# With expanding the query (the Category will be filled in)
+  # 	svc.Products(1).expand('Category')
+  # 	prod1 = svc.execute
+  def expand(path)
+    @expands << path
+    self
+  end
+  
+  # Used to filter data being returned
+  # ==== Required Attributes
+  # - filter: The conditions to apply to the query
+  #
+  # ==== Example	
+  # 	svc.Products.filter("Name eq 'Product 2'")
+  # 	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
+  
+  # Used to skip a number of records 
+  # This is typically used for paging, where it would be used along with the +top+ method.
+  # ==== Required Attributes
+  # - num: The number of items to skip
+  #
+  # ==== Example	
+  # 	svc.Products.skip(5)
+  # 	products = svc.execute # => skips the first 5 items	
+  def skip(num)
+    @skip = num
+    self
+  end
+  
+  # Used to take only the top X records 
+  # This is typically used for paging, where it would be used along with the +skip+ method.
+  # ==== Required Attributes
+  # - num: The number of items to return
+  #
+  # ==== Example	
+  # 	svc.Products.top(5)
+  # 	products = svc.execute # => returns only the first 5 items	
+  def top(num)
+    @top = num
+    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
+    q = @root.clone
+    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?
+    query_options << "$skip=#{@skip}" unless @skip.nil?
+    query_options << "$top=#{@top}" unless @top.nil?
+    if !query_options.empty?
+      q << "?"
+      q << query_options.join('&')	
+    end
+    return q	
+  end
+end
+
 end # Module