ruby_odata 0.1.0 → 0.1.1

data/features/support/pickle.rb

@@ -1,23 +1,28 @@
-require 'pickle/world'
-require File.expand_path('../../../lib/ruby_odata', __FILE__)
+require "pickle/world"
+require "vcr"
+require File.expand_path("../../../lib/ruby_odata", __FILE__)
 
 module OData
-
   module PickleAdapter
     include Pickle::Adapter::Base
-    
-    @@service = OData::Service.new "http://#{WEBSERVER}:#{HTTP_PORT_NUMBER}/SampleService/RubyOData.svc"
-    
+    @@service = nil
+    def self.get_service
+      return @@service if @@service
+      VCR.use_cassette("unsecured_metadata") do
+        return OData::Service.new "http://#{WEBSERVER}:#{HTTP_PORT_NUMBER}/SampleService/RubyOData.svc"
+      end
+    end
+
     # Do not consider these to be part of the class list
     def self.except_classes
       @@except_classes ||= []
     end
-    
+
     # Gets a list of the available models for this adapter
     def self.model_classes
-      @@service.classes.values
+      self.get_service.classes.values
     end
-    
+
     # get a list of column names for a given class
     def self.column_names(klass)
       klass.properties.keys
@@ -26,7 +31,9 @@ module OData
     # Get an instance by id of the model
     def self.get_model(klass, id, expand = false)
       collection = klass.to_s.split('::').last.pluralize
-      query = @@service.send collection, id
+      service = self.get_service
+
+      query = service.send collection, id
 
       if expand then
         # Expand all navigation properties
@@ -38,24 +45,28 @@ module OData
         end
       end
 
-      @@service.execute.first
+      service.execute.first
     end
 
     # Find the first instance matching conditions
     def self.find_first_model(klass, conditions)
       collection = klass.to_s.split('::').last.pluralize
-      q = @@service.send collection
+      service = self.get_service
+
+      q = service.send collection
       q.filter(conditions)
       q.take(1)
-      @@service.execute.first
+      service.execute.first
     end
 
     # Find all models matching conditions
     def self.find_all_models(klass, conditions)
       collection = klass.to_s.split('::').last.pluralize
-      q = @@service.send collection
+      service = self.get_service
+
+      q = service.send collection
       q.filter(conditions)
-      @@service.execute
+      service.execute
     end
 
     # Create a model using attributes
@@ -63,10 +74,10 @@ module OData
       instance = klass.send :make, attributes
 
       collection = klass.to_s.split('::').last.pluralize
-      @@service.send "AddTo#{collection}", instance
-      @@service.save_changes.first
+      service = self.get_service
+      service.send "AddTo#{collection}", instance
+      service.save_changes.first
     end
-    
   end
 end
 

data/features/support/vcr.rb

@@ -0,0 +1,24 @@
+require "vcr"
+require File.expand_path("../../../spec/support/sample_service_matcher",  __FILE__)
+
+VCR.configure do |c|
+  c.hook_into :webmock
+  c.cassette_library_dir     = "features/cassettes"
+  c.default_cassette_options = {
+    :record => :none,
+    :match_requests_on => [:method, OData::Support::SampleServiceMatcher]
+  }
+end
+
+VCR.cucumber_tags do |t|
+  t.tags  "@basic_auth",
+          "@batch_request",
+          "@complex_types",
+          "@error_handling",
+          "@query_builder",
+          "@service",
+          "@service_manage",
+          "@service_methods",
+          "@ssl",
+          "@type_conversion"
+end

data/features/type_conversion.feature

@@ -1,6 +1,7 @@
+@type_conversion
 Feature: Type conversion
   In order to accurately perform operations
-  As a user of the API 
+  As a user of the API
   I want types returned to be accurately represented
 
 Background:
@@ -9,29 +10,29 @@ Background:
 
 Scenario: Integers should be Fixnums
   Given I call "AddToProducts" on the service with a new "Product" object
-	And I save changes
+  And I save changes
   When I call "Products" on the service
   And I run the query
-  Then the "Id" method on the object should return a Fixnum 
-  
+  Then the "Id" method on the object should return a Fixnum
+
 Scenario: Decimals should be BigDecimals
-	Given I call "AddToProducts" on the service with a new "Product" object
+  Given I call "AddToProducts" on the service with a new "Product" object
   And I save changes
-	When I call "Products" on the service
+  When I call "Products" on the service
   And I run the query
   Then the "Price" method on the object should return a BigDecimal
 
 Scenario: DateTimes should be Times
-	Given I call "AddToProducts" on the service with a new "Product" object
+  Given I call "AddToProducts" on the service with a new "Product" object
   And I save changes
-	When I call "Products" on the service
+  When I call "Products" on the service
   And I run the query
-	Then the "AuditFields.CreateDate" method on the object should return a Time
- 
+  Then the "AuditFields.CreateDate" method on the object 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"
+  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 first last query result for comparison
   When I set "Name" on the first result to "Changed Test Product"
@@ -44,10 +45,8 @@ Scenario: Verify that DateTimes don't change if not modified on an update
   Then the new query first 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
+  Given I call "AddToProducts" on the service with a new "Product" object
   And I save changes
-	When I call "Products" on the service
+  When I call "Products" on the service
   And I run the query
   Then the "DiscontinuedDate" method on the object should return a NilClass
-
-

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

data/lib/ruby_odata/exceptions.rb

@@ -0,0 +1,4 @@
+module OData
+  # Raised when a user attempts to do something that is not supported
+  class NotSupportedError < StandardError; 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,15 @@ 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
   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,13 +15,12 @@ module OData
     attr_reader :nav_prop
     # Applies only to navigation properties; the association corresponding to the property
     attr_accessor :association
-    
+
     # 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

data/lib/ruby_odata/query_builder.rb

@@ -1,117 +1,152 @@
 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
   # 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 = []
     @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
+    @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
+    @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
+
   # 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 << "$expand=#{@expands.join(',')}" unless @expands.empty?
     query_options << "$filter=#{@filters.join('+and+')}" unless @filters.empty?
@@ -121,7 +156,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