ruby_odata 0.0.10 → 0.1.0

data/features/support/constants.rb

@@ -0,0 +1,3 @@
+HTTP_PORT_NUMBER = ENV.include?("ODATA_PORT") ? ENV["ODATA_PORT"] : 8989
+HTTPS_PORT_NUMBER = ENV.include?("ODATA_SSL_PORT") ? ENV["ODATA_SSL_PORT"] : 44300
+WEBSERVER = ENV.include?("ODATA_SERVER") ? ENV["ODATA_SERVER"] : 'localhost'

data/features/support/custom_helpers.rb

@@ -0,0 +1,54 @@
+module CustomHelpers
+  # Used to access the first result of a query
+  def first_result
+    @service_result = @service_result.first if @service_result.is_a? Enumerable
+  end
+  
+  # Used to access the first save result
+  def first_save
+    @saved_result = @saved_result.first if @saved_result.is_a? Enumerable
+  end
+  
+  # Allows the string @@LastSave to be used when checking results
+  def handle_last_save_fields(val)
+    if val =~ /^@@LastSave.first$/
+      val = @saved_result.first
+    end
+    if val =~ /^@@LastSave$/
+      val = @saved_result
+    end
+    val
+  end
+
+  # Takes in comma-delimited fields string (like key: "value") and parses it into a hash
+  def parse_fields_string(fields)
+    fields_hash = {}
+
+    if !fields.nil?
+      fields.split(', ').each do |field|
+        if field =~ /^(?:(\w+): "(.*)")$/
+          key = $1
+          val = handle_last_save_fields($2)
+
+          fields_hash.merge!({key => val})
+        end
+      end
+    end
+    fields_hash
+  end
+  
+  # Takes in a hash and convert special values (like @@LastSave) into the appropriate values
+  def parse_fields_hash(fields)
+    fields_hash = {}
+
+    if !fields.nil?
+      fields.each do |key, val|        
+        val = handle_last_save_fields(val)
+        fields_hash.merge!({key => val})
+      end
+    end
+    fields_hash
+  end
+  
+end
+World(CustomHelpers)

data/features/support/env.rb

@@ -4,13 +4,3 @@ 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
-
-HTTP_PORT_NUMBER = 8989

data/features/support/hooks.rb

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

data/features/support/pickle.rb

@@ -0,0 +1,82 @@
+require 'pickle/world'
+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"
+    
+    # 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
+    end
+    
+    # get a list of column names for a given class
+    def self.column_names(klass)
+      klass.properties.keys
+    end
+
+    # 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
+
+      if expand then
+        # Expand all navigation properties
+        navigation_properties = klass.properties.select { |k, v| v.nav_prop }
+        # Ruby 1.9 Hash.select returns a Hash, 1.8 returns an Array, so normalize the return type
+        props = (navigation_properties.is_a? Hash) ? navigation_properties : Hash[*navigation_properties.flatten]
+        props.keys.each do |prop|
+          query.expand(prop)
+        end
+      end
+
+      @@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
+      q.filter(conditions)
+      q.take(1)
+      @@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
+      q.filter(conditions)
+      @@service.execute
+    end
+
+    # Create a model using attributes
+    def self.create_model(klass, attributes)
+      instance = klass.send :make, attributes
+
+      collection = klass.to_s.split('::').last.pluralize
+      @@service.send "AddTo#{collection}", instance
+      @@service.save_changes.first
+    end
+    
+  end
+end
+
+module Pickle
+  module Session
+    # return a newly selected model with the navigation properties expanded
+    def model_with_associations(name)
+      model = created_model(name)
+      return nil unless model
+      OData::PickleAdapter.get_model(model.class, model.id, true)
+    end
+  end
+end

data/features/type_conversion.feature

@@ -4,7 +4,7 @@ Feature: Type conversion
   I want types returned to be accurately represented
 
 Background:
-  Given a sample HTTP ODataService exists
+  Given a HTTP ODataService exists
   And blueprints exist for the service
 
 Scenario: Integers should be Fixnums
@@ -12,42 +12,42 @@ Scenario: Integers should be Fixnums
 	And I save changes
   When I call "Products" on the service
   And I run the query
-  Then the "Id" method 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
   And I save changes
 	When I call "Products" on the service
   And I run the query
-  Then the "Price" method should return a BigDecimal
+  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
   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
+	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"
   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
+  Then I store the first last query result for comparison
+  When I set "Name" on the first result to "Changed Test Product"
+  Then the method "Name" on the first result should equal: "Changed Test Product"
+  And I call "update_object" on the service with the first 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
+  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
   And I save changes
 	When I call "Products" on the service
   And I run the query
-  Then the "DiscontinuedDate" method should return a NilClass
+  Then the "DiscontinuedDate" method on the object should return a NilClass
 
 

data/lib/ruby_odata.rb

@@ -10,9 +10,12 @@ require 'rest_client'
 require 'nokogiri'
 require 'bigdecimal'
 require 'bigdecimal/util'
+require 'backports'
 
+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/service'
+require lib + '/ruby_odata/helpers'

data/lib/ruby_odata/association.rb

@@ -0,0 +1,36 @@
+module OData
+  class Association
+    
+    attr_reader :name, :namespace, :relationship, :from_role, :to_role
+    
+    def initialize(nav_prop_element, edmx)
+      @edmx = edmx
+
+      # Get the edm namespace because it varies by version
+      edm_ns = @edmx.xpath("edmx:Edmx/edmx:DataServices/*", "edmx" => "http://schemas.microsoft.com/ado/2007/06/edmx").first.namespaces['xmlns'].to_s
+      @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('.')
+      @name = relationship_parts.pop
+      @namespace = relationship_parts.join('.')
+      @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 => { 
+          :edmx_type => "#{role_element['Type']}",
+          :multiplicity => "#{role_element['Multiplicity']}"
+      }}
+    end
+  end
+end

data/lib/ruby_odata/class_builder.rb

@@ -4,61 +4,99 @@ module OData
     # 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:   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
+    def initialize(klass_name, methods, nav_props, context, namespace = nil)
       @klass_name = klass_name.camelcase
       @methods = methods
       @nav_props = nav_props
+      @context = context
+      @namespace = namespace
     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
+      already_defined = eval("defined?(#{@klass_name}) == 'constant' and #{@klass_name}.class == Class")
+      if already_defined
         @klass = @klass_name.constantize
         return @klass
       end
 
-      Object.const_set(@klass_name, Class.new.extend(ActiveSupport::JSON))
+      if @namespace
+        namespaces = @namespace.split(/\.|::/)
+
+        namespaces.each_with_index do |ns, index|
+          if index == 0
+            next if Object.const_defined? ns
+            Object.const_set(ns, Module.new)
+          else
+            current_ns = namespaces[0..index-1].join '::'
+            next if eval "#{current_ns}.const_defined? '#{ns}'"
+            eval "#{current_ns}.const_set('#{ns}', Module.new)"
+          end
+        end
+
+        klass_constant = @klass_name.split('::').last
+        eval "#{namespaces.join '::'}.const_set('#{klass_constant}', Class.new.extend(ActiveSupport::JSON))"
+      else
+        Object.const_set(@klass_name, Class.new.extend(ActiveSupport::JSON))
+      end
+
       @klass = @klass_name.constantize
       @klass.class_eval do
         include OData
       end
 
+      add_initializer(@klass)
       add_methods(@klass)
       add_nav_props(@klass)
-      
+      add_class_methods(@klass)
+
       return @klass
     end
-    
+
     private
+    def add_initializer(klass)
+      klass.send :define_method, :initialize do |*args|
+        return if args.blank?
+        props = args[0]
+        return unless props.is_a? Hash
+        props.each do |k,v|
+          raise NoMethodError, "undefined method `#{k}'" unless self.respond_to? k.to_sym
+          instance_variable_set("@#{k}", v)
+        end
+      end
+    end
+    
     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)
+        instance_variable_set("@__metadata", value)
       end
       klass.send :define_method, :as_json do |*args|
-        meta = RUBY_VERSION < "1.9" ? '@__metadata' :'@__metadata'.to_sym
+        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)
+        if options[:type] == :add
+          # For adds, we need to get rid of all attributes except __metadata when passing
+          # the object to the server
           vars.each_value do |value|
             if value.is_a? OData
               child_vars = value.instance_variables
@@ -89,6 +127,12 @@ module OData
           vars[t[0]] = sdate
         end
 
+        if options[:type] == :link
+          # For links, delete all of the vars and just add a uri
+          uri = self.__metadata[:uri]
+          vars = { 'uri' => uri }
+        end
+
         vars
       end
 
@@ -101,6 +145,23 @@ 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+)\)$/
+          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.id == other.id &&
+        self.__metadata == other.__metadata
+      end
     end
 
     def add_nav_props(klass)
@@ -113,5 +174,24 @@ module OData
         end
       end
     end
+
+    def add_class_methods(klass)
+      context = @context
+
+      # Retrieves a list of properties defined on a type (standard and navigation properties)
+      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
+        results.count == 0 ? nil : results.first
+      end
+    end
   end
 end # module OData