ruby_odata 0.1.0 → 0.1.6

data/gemfiles/Gemfile.ruby187

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec :path => '../'
+
+gem 'nokogiri', '~> 1.5.10'
+gem 'activesupport',  '~> 3.0'

data/lib/ruby_odata.rb

@@ -1,21 +1,23 @@
 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 'rest_client'
-require 'nokogiri'
-require 'bigdecimal'
-require 'bigdecimal/util'
-require 'backports'
+$: << lib + "/ruby_odata/"
+require "rubygems"
+require "i18n"
+require "active_support" # Used for serializtion to JSON
+require "active_support/inflector"
+require "active_support/core_ext"
+require "cgi"
+require "rest_client"
+require "nokogiri"
+require "bigdecimal"
+require "bigdecimal/util"
+require "addressable/uri"
 
-require lib + '/ruby_odata/association'
-require lib + '/ruby_odata/property_metadata'
-require lib + '/ruby_odata/query_builder'
-require lib + '/ruby_odata/class_builder'
-require lib + '/ruby_odata/operation'
-require lib + '/ruby_odata/service'
-require lib + '/ruby_odata/helpers'
+require lib + "/ruby_odata/exceptions"
+require lib + "/ruby_odata/association"
+require lib + "/ruby_odata/property_metadata"
+require lib + "/ruby_odata/query_builder"
+require lib + "/ruby_odata/class_builder"
+require lib + "/ruby_odata/operation"
+require lib + "/ruby_odata/service"
+require lib + "/ruby_odata/helpers"

data/lib/ruby_odata/association.rb

@@ -1,8 +1,9 @@
 module OData
+  # Internal class used to represent object associations
   class Association
-    
+
     attr_reader :name, :namespace, :relationship, :from_role, :to_role
-    
+
     def initialize(nav_prop_element, edmx)
       @edmx = edmx
 
@@ -11,9 +12,9 @@ module OData
       @edmx_namespaces = { "edmx" => "http://schemas.microsoft.com/ado/2007/06/edmx", "edm" => edm_ns }
       parse_nav_prop(nav_prop_element)
     end
-    
+
     private
-    
+
     def parse_nav_prop(element)
       @relationship = element['Relationship']
       relationship_parts = @relationship.split('.')
@@ -22,12 +23,12 @@ module OData
       @from_role = role_hash(@name, element['FromRole'])
       @to_role = role_hash(@name, element['ToRole'])
     end
-    
+
     def role_hash(association_name, role_name)
       # Find the end role based on the assocation name
       role_xpath = "/edmx:Edmx/edmx:DataServices/edm:Schema[@Namespace='#{@namespace}']/edm:Association[@Name='#{association_name}']/edm:End[@Role='#{role_name}']"
       role_element = @edmx.xpath(role_xpath, @edmx_namespaces).first
-      { role_name => { 
+      { role_name => {
           :edmx_type => "#{role_element['Type']}",
           :multiplicity => "#{role_element['Multiplicity']}"
       }}

data/lib/ruby_odata/class_builder.rb

@@ -1,14 +1,13 @@
 module OData
-  # Internally used helper class for building a dynamic class.  This class shouldn't be called directly.
+  # Internal 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
-    # - context:      The service context that this entity belongs to
-    # - namespaces:   Optional namespace to create the classes in
+    # @param [String] klass_name the name/type of the class to create
+    # @param [Array] methods the accessor methods to add to the class
+    # @param [Array] nav_props the accessor methods to add for navigation properties
+    # @param [Service] context the service context that this entity belongs to
+    # @param [String, nil] namespace optional namespace to create the classes in
     def initialize(klass_name, methods, nav_props, context, namespace = nil)
       @klass_name = klass_name.camelcase
       @methods = methods
@@ -77,7 +76,7 @@ module OData
         end
       end
     end
-    
+
     def add_methods(klass)
       # Add metadata methods
       klass.send :define_method, :__metadata do
@@ -111,6 +110,20 @@ module OData
           end
         end
 
+        props = self.class.properties
+
+        # Convert a Int64 to a string for serialization (to match Edm.Int64)
+        bigints = vars.find_all { |o| props[o[0]] && props[o[0]].type == "Edm.Int64" } || []
+        bigints.each do |i|
+          vars[i[0]] = i[1].to_s
+        end
+
+        # Convert Arrays into proper Collections
+        collections = vars.find_all { |o| o[1].class == Array } || []
+        collections.each do |c|
+          vars[c[0]] = { '__metadata' => { 'type' => props[c[0]].type }, 'results' => c[1] }
+        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|
@@ -145,20 +158,20 @@ module OData
           instance_variable_set("@#{method_name}", value)
         end
       end
-      
+
       # Add an id method pulling out the id from the uri (mainly for Pickle support)
       klass.send :define_method, :id do
         metadata = self.__metadata
         id = nil
-        if metadata && metadata[:uri]  =~ /\((\d+)\)$/
+        if metadata && metadata[:uri]  =~ /\((\d+)L?\)$/
           id = $~[1]
         end
         return (true if Integer(id) rescue false) ? id.to_i : id
       end
-      
+
       # Override equals
       klass.send :define_method, :== do |other|
-        self.class == other.class && 
+        self.class == other.class &&
         self.id == other.id &&
         self.__metadata == other.__metadata
       end
@@ -182,14 +195,18 @@ module OData
       klass.send :define_singleton_method, 'properties' do
         context.class_metadata[klass.to_s] || {}
       end
-      
+
       # Finds a single model by ID
       klass.send :define_singleton_method, 'first' do |id|
         return nil if id.nil?
         # TODO: Instead of just pluralizing the klass name, use the actual collection name
         collection = klass.to_s.pluralize
         context.send "#{collection}", id
-        results = context.execute
+        begin
+          results = context.execute
+        rescue OData::ServiceError => e
+          return nil
+        end
         results.count == 0 ? nil : results.first
       end
     end

data/lib/ruby_odata/exceptions.rb

@@ -0,0 +1,11 @@
+module OData
+  # Raised when a user attempts to do something that is not supported
+  class NotSupportedError < StandardError; end
+  # Raised when the service returns an error
+  class ServiceError < StandardError
+    attr_reader :http_code
+    def initialize(code)
+      @http_code = code
+    end
+  end
+end

data/lib/ruby_odata/helpers.rb

@@ -1,4 +1,5 @@
 module OData
+  # Helper methods
   class Helpers
     # Helper to normalize the results of a select result; Ruby 1.9 Hash.select returns a Hash, 1.8 returns an Array
     # This is for Ruby 1.8 support, but should be removed in the future
@@ -6,5 +7,21 @@ module OData
       return nil if val.nil?
       (val.is_a? Hash) ? val : Hash[*val.flatten]
     end
+
+    # Wrapper for URI escaping that switches between URI::Parser#escape and
+    # URI.escape for 1.9-compatibility (thanks FakeWeb https://github.com/chrisk/fakeweb/blob/master/lib/fake_web/utility.rb#L40)
+    def self.uri_escape(*args)
+      if URI.const_defined?(:Parser)
+        URI::Parser.new.escape(*args)
+      else
+        URI.escape(*args)
+      end
+    end
+
+    # Nokogiri changed how it handles namespaced attributes with v1.5.1, this is for backwards compatibility to >= 1.4.2
+    # Nokogiri now >=1.5.1 requires the namespace prefix is used
+    def self.get_namespaced_attribute(node, attr_name, prefix)
+      return node["#{prefix}:#{attr_name}"] || node[attr_name]
+    end
   end
 end

data/lib/ruby_odata/operation.rb

@@ -2,14 +2,13 @@ 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, :child_klass
-    
+
     # Creates a new instance of the Operation class
     #
-    # ==== Required Attributes
-    # - kind:         The operation type (Standard: Add, Update, or Delete | Links: AddLink)
-    # - klass_name:   The name/type of the class to operate against
-    # - klass:        The actual class
-    # - child_klass:  (Optional) Only used for link operations
+    # @param [String] kind the operation type (Standard: Add, Update, or Delete | Links: AddLink)
+    # @param [String] klass_name the name/type of the class to operate against
+    # @param [Object] klass the actual class
+    # @param [Object, nil] child_klass used for link operations only
     def initialize(kind, klass_name, klass, child_klass = nil)
       @kind = kind
       @klass_name = klass_name

data/lib/ruby_odata/property_metadata.rb

@@ -15,18 +15,20 @@ module OData
     attr_reader :nav_prop
     # Applies only to navigation properties; the association corresponding to the property
     attr_accessor :association
-    
+    # Applies to the primary key(s)
+    attr_accessor :is_key
+
     # Creates a new instance of the Class Property class
     #
-    # ==== Required Attributes
-    # property_element: The property element from the EDMX 
-    
-    def initialize(property_element)      
+    # @param [Nokogiri::XML::Node] property_element from the EDMX
+
+    def initialize(property_element)
       @name =                 property_element['Name']
       @type =                 property_element['Type']
       @nullable =             ((property_element['Nullable'] && property_element['Nullable'] == "true") || property_element.name == 'NavigationProperty') || false
-      @fc_target_path =       property_element['FC_TargetPath']
-      @fc_keep_in_content  =  (property_element['FC_KeepInContent']) ? (property_element['FC_KeepInContent'] == "true") : nil
+      @fc_target_path =       Helpers.get_namespaced_attribute(property_element, 'FC_TargetPath', 'm')
+      keep_in_content =       Helpers.get_namespaced_attribute(property_element, 'FC_KeepInContent', 'm')
+      @fc_keep_in_content  =  (keep_in_content) ? (keep_in_content == "true") : nil
       @nav_prop =             property_element.name == 'NavigationProperty'
     end
   end

data/lib/ruby_odata/query_builder.rb

@@ -1,118 +1,182 @@
 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:8989/SampleService/RubyOData.svc"
-# 		svc.Categories
-# The *Categories* method would return a QueryBuilder 
+# @example For example, given the following code snippet:
+#   svc = OData::Service.new "http://127.0.0.1:8989/SampleService/RubyOData.svc"
+#   svc.Categories
+# The *Categories* method would return a QueryBuilder
 class QueryBuilder
+  attr_accessor :additional_params
+
   # Creates a new instance of the QueryBuilder class
   #
-  # ==== Required Attributes
-  # - root: The root entity collection to query against
-  # ==== Optional 
-  # Hash of additional parameters to use for a query
+  # @param [String] root entity collection to query against
+  # @param [Hash, {}] additional_params hash of additional parameters to use for a query
   def initialize(root, additional_params = {})
-    @root = root.to_s
+    @root = Helpers.uri_escape(root.to_s)
     @expands = []
     @filters = []
     @order_bys = []
+    @navigation_paths = []
+    @select = []
     @skip = nil
     @top = nil
-    @links = nil
+    @count = nil
+    @links_navigation_property = nil
     @additional_params = additional_params
   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
+  # @param [String] 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
+  #   # 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
+  # @param [String] filter 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
+  # @param [String] 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	
+
+  # Used to skip a number of records
+  # This is typically used for paging, where it would be used along with the `top` method.
+  #
+  # @param [Integer] 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	
+
+  # Used to take only the top X records
+  # This is typically used for paging, where it would be used along with the `skip` method.
+  #
+  # @param [Integer] 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
-  
+
   # Used to return links instead of actual objects
-  # ==== Required Attributes
-  # - navigation_property: The NavigationProperty name to retrieve the links for
   #
-  # ==== Example	
-  # 	svc.Categories(1).links("Products")
-  # 	product_links = svc.execute # => returns URIs for the products under the Category with an ID of 1
+  # @param [String] navigation_property the NavigationProperty name to retrieve the links for
+  #
+  # @raise [NotSupportedError] if count has already been called on the query
+  #
+  # @example
+  #   svc.Categories(1).links("Products")
+  #   product_links = svc.execute # => returns URIs for the products under the Category with an ID of 1
   def links(navigation_property)
-    @navigation_property = navigation_property
+    raise OData::NotSupportedError.new("You cannot call both the `links` method and the `count` method in the same query.") if @count
+    raise OData::NotSupportedError.new("You cannot call both the `links` method and the `select` method in the same query.") unless @select.empty?
+    @links_navigation_property = navigation_property
+    self
+  end
+
+  # Used to return a count of objects instead of the objects themselves
+  #
+  # @raise [NotSupportedError] if links has already been called on the query
+  #
+  # @example
+  #   svc.Products
+  #   svc.count
+  #   product_count = svc.execute
+  def count
+    raise OData::NotSupportedError.new("You cannot call both the `links` method and the `count` method in the same query.") if @links_navigation_property
+    raise OData::NotSupportedError.new("You cannot call both the `select` method and the `count` method in the same query.") unless @select.empty?
+
+    @count = true
     self
   end
-  
+
+  # Used to navigate to a child collection, typically used to filter or perform a similar function against the children
+  #
+  # @param [String] navigation_property the NavigationProperty to drill-down into
+  #
+  # @example
+  #   svc.Genres('Horror Movies').navigate("Titles").filter("Name eq 'Halloween'")
+  def navigate(navigation_property)
+    @navigation_paths << Helpers.uri_escape(navigation_property)
+    self
+  end
+
+  # Used to customize the properties that are returned for "ad-hoc" queries
+  #
+  # @param [Array<String>] properties to return
+  #
+  # @example
+  #   svc.Products.select('Price', 'Rating')
+  def select(*fields)
+    raise OData::NotSupportedError.new("You cannot call both the `links` method and the `select` method in the same query.") if @links_navigation_property
+    raise OData::NotSupportedError.new("You cannot call both the `count` method and the `select` method in the same query.") if @count
+
+    @select |= fields
+
+    expands =  fields.find_all { |f| /\// =~ f }
+    expands.each do |e|
+      parts = e.split '/'
+      @expands |= [parts[0...-1].join('/')]
+    end
+
+
+    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
-    
+
+    # Navigation paths come first in the query
+    q << "/" + @navigation_paths.join("/") unless @navigation_paths.empty?
+
     # Handle links queries, this isn't just a standard query option
-    if @navigation_property
-      q << "/$links/#{@navigation_property}"
+    if @links_navigation_property
+      q << "/$links/#{@links_navigation_property}"
     end
-    
+
+    # Handle count queries, this isn't just a standard query option
+    if @count
+      q << "/$count"
+    end
+
     query_options = []
+    query_options << "$select=#{@select.join(',')}" unless @select.empty?
     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?
@@ -121,7 +185,7 @@ class QueryBuilder
     query_options << @additional_params.to_query unless @additional_params.empty?
     if !query_options.empty?
       q << "?"
-      q << query_options.join('&')	
+      q << query_options.join('&')
     end
     return q
   end