safrano 0.8.0 → 0.8.2

data/lib/odata/navigation_attribute.rb

@@ -78,6 +78,10 @@ module Safrano
   # Represents a named but nil-valued navigation-attribute of an Entity
   # (usually resulting from a NULL FK db value)
   class NilNavigationAttribute
+    def initialize
+      @allowed_transitions = ALLOWED_TRANSITIONS
+    end
+
     include Safrano::NavigationInfo
     def odata_get(req)
       if req.walker.media_value
@@ -131,6 +135,8 @@ module Safrano
       def allowed_transitions
         ALLOWED_TRANSITIONS
       end
+
+      include Safrano::Transitions::GetNextTrans::BySimpleDetect
     end
     include Transitions
   end

data/lib/odata/request/json.rb

@@ -35,6 +35,7 @@ module Safrano
       end
     end
   end
+
   # This is used from the Test-suite code !
   # it does recursive / deep symbolize additionally to inbound casting
   module XJSON

data/lib/odata/transition.rb

@@ -4,16 +4,78 @@ require_relative 'error'
 
 # our main namespace
 module Safrano
+  module Transitions
+    module GetNextTrans
+      module BySimpleDetect
+        def get_next_transresult(path_remain)
+          # current url-parsing context
+          # has no ambiguous next match and we dont need to find longest match
+          # but it's sufficient to find the one matching (or nil)
+          tres_next = nil
+          @allowed_transitions.detect { |t| tres_next = t.result(path_remain) }
+          tres_next
+        end
+      end
+
+      module ForJustTransitionEnd
+        def get_next_transresult(path_remain)
+          Safrano::TransitionEnd.result(path_remain)
+        end
+      end
+
+      # Transitions::GetNextTrans::ByLongestMatch
+      module ByLongestMatch
+        def get_next_transresult(path_remain)
+          # current url-parsing context
+          # has  ambiguous next match and we need to find longest match
+          # example: current context is "the top level service" and we have
+          # entity types Race and RaceType
+
+          match_len = -1
+          tres_next = nil
+
+          @allowed_transitions.each { |t|
+            if (res = t.longer_match(path_remain, match_len))
+              tres_next = res
+              match_len = tres_next.match_length
+            end
+          }
+          tres_next
+        end
+      end
+
+      # same as ByLongestMatch but use the getter method allowed_transitions instead of
+      # directly @allowed_transitions
+      module ByLongestMatchDyn
+        def get_next_transresult(path_remain)
+          # current url-parsing context
+          # has  ambiguous next match and we need to find longest match
+          # example: current context is "the top level service" and we have
+          # entity types Race and RaceType
+
+          match_len = -1
+          tres_next = nil
+
+          allowed_transitions.each { |t|
+            if (res = t.longer_match(path_remain, match_len))
+              tres_next = res
+              match_len = tres_next.match_length
+            end
+          }
+          tres_next
+        end
+      end
+    end
+  end
+
   # represents a state transition when navigating/parsing the url path
   # from left to right
   class Transition
-    attr_accessor :trans
-    attr_accessor :match_result
-    attr_accessor :rgx
-    attr_reader :remain_idx
-
-    EMPTYSTR = ''
-    SLASH = '/'
+    # attr_accessor :trans
+    # attr_accessor :match_result
+    # attr_accessor :trans_result
+    # attr_accessor :rgx
+    # attr_reader   :remain_idx
 
     RESULT_BAD_REQ_ERR = [nil, :error, ::Safrano::BadRequestError].freeze
     RESULT_NOT_FOUND_ERR = [nil, :error, ::Safrano::ErrorNotFound].freeze
@@ -25,31 +87,58 @@ module Safrano
                Regexp.new(arg)
              else
                arg
-             end
+             end.freeze
+      @trans = trans.freeze
+      @remain_idx = remain_idx.freeze
+    end
+
+    def result(str)
+      return unless (mres = @rgx.match(str))
+
+      TransitionResult.new(trans: @trans, match_result: mres, remain_idx: @remain_idx)
+    end
+
+    # return  match-result for str, if longer  as   min_match_length
+    def longer_match(str, min_match_length)
+      return unless (mres = @rgx.match(str))
+      return unless (mres.match_length(1) > min_match_length)
+
+      TransitionResult.new(trans: @trans, match_result: mres, remain_idx: @remain_idx)
+    end
+  end
+
+  class TransitionResult
+    attr_reader :match
+
+    EMPTYSTR = ''
+    SLASH = '/'
+
+    def initialize(trans:, match_result:, remain_idx:)
       @trans = trans
+      @match = match_result
       @remain_idx = remain_idx
     end
 
-    def do_match(str)
-      @match_result = @rgx.match(str)
+    def match_length
+      @match.match_length(1)
     end
 
     # remain_idx is the index of the last match-data. ususally its 2
     # but can be overidden
     def path_remain
-      @match_result[@remain_idx] if @match_result && @match_result[@remain_idx]
+      @match[@remain_idx] if @match && @match[@remain_idx]
     end
 
     def path_done
-      if @match_result
-        @match_result[1] || EMPTYSTR
+      if @match
+        @match[1] || EMPTYSTR
       else
         EMPTYSTR
       end
     end
 
     def do_transition(ctx)
-      ctx.method(@trans).call(@match_result)
+      ctx.__send__(@trans, @match)
     end
   end
 
@@ -59,8 +148,30 @@ module Safrano
       @trans = trans
     end
 
-    def do_match(str)
+    def result(str)
+      @str = str
+      InplaceTransitionResult.new(trans: @trans, match_result: @str)
+    end
+
+    # return  match-result for str, if longer  as   min_match_length
+    def longer_match(str, min_match_length)
       @str = str
+      return unless (@str.size > min_match_length)
+
+      InplaceTransitionResult.new(trans: @trans, match_result: @str)
+    end
+  end
+
+  # Transition that does not move/change the input
+  class InplaceTransitionResult < TransitionResult
+    def initialize(trans:, match_result:)
+      @trans = trans
+      @match = match_result
+      @str = match_result
+    end
+
+    def match_length
+      @str.size
     end
 
     def path_remain
@@ -70,26 +181,22 @@ module Safrano
     def path_done
       EMPTYSTR
     end
-
-    def do_transition(ctx)
-      ctx.method(@trans).call(@str)
-    end
   end
 
-  TransitionEnd = Transition.new('\A(\/?)\z', trans: 'transition_end')
-  TransitionExecuteFunc = InplaceTransition.new(trans: 'transition_execute_func')
+  TransitionEnd = Transition.new('\A(\/?)\z', trans: :transition_end)
+  TransitionExecuteFunc = InplaceTransition.new(trans: :transition_execute_func)
   TransitionMetadata = Transition.new('\A(\/\$metadata)(.*)',
-                                      trans: 'transition_metadata')
+                                      trans: :transition_metadata)
   TransitionBatch = Transition.new('\A(\/\$batch)(.*)',
-                                   trans: 'transition_batch')
+                                   trans: :transition_batch)
   TransitionContentId = Transition.new('\A(\/\$(\d+))(.*)',
-                                       trans: 'transition_content_id',
+                                       trans: :transition_content_id,
                                        remain_idx: 3)
   TransitionCount = Transition.new('(\A\/\$count)(.*)\z',
-                                   trans: 'transition_count')
+                                   trans: :transition_count)
   TransitionValue = Transition.new('(\A\/\$value)(.*)\z',
-                                   trans: 'transition_value')
+                                   trans: :transition_value)
   TransitionLinks = Transition.new('(\A\/\$links)(.*)\z',
-                                   trans: 'transition_links')
+                                   trans: :transition_links)
   attr_accessor :allowed_transitions
 end

data/lib/odata/walker.rb

@@ -65,30 +65,10 @@ module Safrano
       if (prefix == EMPTYSTR) || (prefix == SLASH)
         path
       else
-        #        path.sub!(/\A#{prefix}/, '')
-        # TODO: check
         path.sub(/\A#{prefix}/, EMPTYSTR)
       end
     end
 
-    def get_next_transition
-      # handle  multiple valid transitions
-      # like when we have attributes that are substring of each other
-      # --> instead of using detect (ie take first transition)
-      # we need to use select and then find the longest match
-
-      valid_tr = @context.allowed_transitions.map(&:dup).select do |t|
-        t.do_match(@path_remain)
-      end
-
-      # HACK: (wanted: a better one) to make attributes that are substrings of each other
-      # work well
-      return unless valid_tr
-      return (@tr_next = nil) if valid_tr.empty?
-
-      @tr_next = valid_tr.size == 1 ? valid_tr.first : valid_tr.max_by { |t| t.match_result[1].size }
-    end
-
     # perform a content-id ($batch changeset ref) transition
     def do_run_with_content_id
       if @content_id_refs.is_a? Hash
@@ -137,7 +117,7 @@ module Safrano
     end
 
     def do_next_transition
-      @context, @status, @error = @tr_next.do_transition(@context)
+      @context, @status, @error = @tres_next.do_transition(@context)
       # little hack's
       case @status
         # we dont have the content-id references data on service level
@@ -151,8 +131,8 @@ module Safrano
       end
 
       @contexts << @context
-      @path_remain = @tr_next.path_remain
-      @path_done << @tr_next.path_done
+      @path_remain = @tres_next.path_remain
+      @path_done << @tres_next.path_done
 
       # little hack's
       state_mappings
@@ -160,8 +140,8 @@ module Safrano
 
     def eo
       while @context
-        get_next_transition
-        if @tr_next
+        @tres_next = @context.get_next_transresult(@path_remain)
+        if @tres_next
           do_next_transition
         else
           @context = nil

data/lib/safrano/rack_app.rb

@@ -22,6 +22,13 @@ module Safrano
       Safrano::Request.new(env, @service_base).process
     end
 
+    #  needed for testing only ? try to remove this
+    def self.copy(other)
+      copy = Class.new(Safrano::ServerApp) # <---- !!!
+      copy.set_servicebase(other.get_service_base.dup)
+      copy
+    end
+
     #  needed for testing only ? try to remove this
     def self.enable_batch
       @service_base.enable_batch
@@ -32,16 +39,22 @@ module Safrano
       @service_base.path_prefix path_pr
     end
 
+    # needed for testing only ? try to remove this
+
+    def self.response_format_options(*args)
+      @service_base.response_format_options(*args)
+    end
+
     # needed for testing only ? try to remove this
     def self.get_service_base
       @service_base
     end
-    
-    # needed for safrano-rack_builder 
+
+    # needed for safrano-rack_builder
     def get_path_prefix
       self.class.get_service_base.xpath_prefix
     end
-    
+
     def self.set_servicebase(sbase)
       @service_base = sbase
       @service_base.enable_v1_service

data/lib/safrano/rack_builder.rb

@@ -7,9 +7,11 @@ module Rack
   module Safrano
     # just a Wrapper to ensure (force?) that mandatory middlewares are acutally
     # used
-    LOCALHOST_ANY_PORT_RGX = /\A(?:https?:\/\/)?localhost(?::\d+)?\z/ 
+    LOCALHOST_ANY_PORT_RGX = /\A(?:https?:\/\/)?localhost(?::\d+)?\z/.freeze
+    CORS_RO_METHODS = %i[get head options].freeze
+    CORS_BATCH_METHODS = %i[post head options].freeze
+    CORS_RW_METHODS = %i[get post put patch delete head options].freeze
     class Builder < ::Rack::Builder
-      
       def initialize(default_app = nil, &block)
         super(default_app) {}
         @middlewares = []
@@ -17,63 +19,61 @@ module Rack
         instance_eval(&block) if block_given?
         prepend_rackcors_ifneeded
       end
-      
+
       def use(middleware, *args, &block)
         @middlewares << middleware
         super(middleware, *args, &block)
       end
-      
+
       def prepend_rackcors_ifneeded
         return if stack_has_rackcors
-        
+
         # get the safrano app path prefix
         # normally @run is a Safrano Server app
         return unless @run.is_a? ::Safrano::ServerApp
-        
-        
+
         service_path_prefix = @run.get_path_prefix.dup
-        
-        # due to a bug in rack-cors 
+
+        # due to a bug in rack-cors
         # we cant use the batch ressource path as
         # a string but need to pass it as a regexp
-        # ( bug fixed in rack-cors git / new release? but still need to workaround it for 
-        # current/old releases ), 
-        batch_path_regexp = if service_path_prefix.empty?   
-          # Ressource /$batch
-          /\A\/\$batch\z/ 
-        else      
-          # Ressource  like  /foo/bar/baz/$batch 
-          service_path_prefix.sub!(::Safrano::TRAILING_SLASH_RGX, '')
-          service_path_prefix.sub!(::Safrano::LEADING_SLASH_RGX, '')
-          # now is  foo/bar/baz 
-          path_prefix_rgx = Regexp.escape("/#{service_path_prefix}/$batch")
-          # now  escaped path regexp /foo/bar/baz/$batch
-          # finaly just add start / end anchors
-          /\A#{path_prefix_rgx}\z/
-        end
+        # ( bug fixed in rack-cors git / new release? but still need to workaround it for
+        # current/old releases ),
+        batch_path_regexp = if service_path_prefix.empty?
+                              # Ressource /$batch
+                              /\A\/\$batch\z/
+                            else
+                              # Ressource  like  /foo/bar/baz/$batch
+                              service_path_prefix.sub!(::Safrano::TRAILING_SLASH_RGX, '')
+                              service_path_prefix.sub!(::Safrano::LEADING_SLASH_RGX, '')
+                              # now is  foo/bar/baz
+                              path_prefix_rgx = Regexp.escape("/#{service_path_prefix}/$batch")
+                              # now  escaped path regexp /foo/bar/baz/$batch
+                              # finaly just add start / end anchors
+                              /\A#{path_prefix_rgx}\z/
+                            end
         # this will append rack-cors mw
-        # per default allow GET * from everywhere 
-        #             allow POST $batch from localhost only  
+        # per default allow GET * from everywhere
+        #             allow POST $batch from localhost only
         use ::Rack::Cors do
           allow do
             origins LOCALHOST_ANY_PORT_RGX
-            resource (batch_path_regexp), headers: :any, methods: [:post, :head, :options]
-            resource '*', headers: :any, methods: [:get,  :post, :put, :patch, :head, :options]
-          end     
+            resource batch_path_regexp, headers: :any, methods: CORS_BATCH_METHODS
+            resource '*', headers: :any, methods: CORS_RW_METHODS
+          end
           allow do
             origins '*'
-            resource '*', headers: :any, methods: [:get,  :head, :options]
-          end         
-       
+            resource '*', headers: :any, methods: CORS_RO_METHODS
+          end
         end
-        
+
         # we need it in first place... move last element to beginin of mw stack
-        rackcors = @use.delete_at(-1)    
-        @use.insert(0, rackcors) 
+        rackcors = @use.delete_at(-1)
+        @use.insert(0, rackcors)
       end
-      
+
       def stack_has_rackcors
-        @middlewares.find{|mw| mw == Rack::Cors }
+        @middlewares.find { |mw| mw == Rack::Cors }
       end
     end
   end

data/lib/safrano/request.rb

@@ -11,12 +11,12 @@ module Safrano
       headers.delete('Content-Type')
       @response.headers.delete('Content-Type')
       @response.headers['Content-Type'] = ''
-      
+
       # we only let rack-cors handle Cors OPTIONS .
       # otherwise dont do it...
-      # see https://www.mnot.net/blog/2012/10/29/NO_OPTIONS 
+      # see https://www.mnot.net/blog/2012/10/29/NO_OPTIONS
       # 501 not implemented
-      [501, EMPTY_HASH, '']  
+      [501, EMPTY_HASH, '']
     end
 
     def odata_delete
@@ -41,7 +41,7 @@ module Safrano
 
     def odata_post
       @walker.finalize.tap_error { |err| return err.odata_get(self) }
-                      .if_valid { |context| context.odata_post(self) }
+             .if_valid { |context| context.odata_post(self) }
     end
 
     def odata_head
@@ -99,6 +99,7 @@ module Safrano
         @type
       end
     end
+
     ## original coding:
     #    # The set of media-types. Requests that do not indicate
     #    # one of the media types presents in this list will not be eligible

data/lib/safrano/service.rb

@@ -12,8 +12,12 @@ require 'set'
 require 'odata/collection'
 
 module Safrano
-  # this module has all methods related to expand/defered output preparation
+  # these modules have all methods related to expand/defered output preparation
   # and will be included in Service class
+
+  METADATA_K = '__metadata'
+  EMPTYH = {}.freeze
+
   module ExpandHandler
     PATH_SPLITTER = %r{\A(\w+)/?(.*)\z}.freeze
     DEFERRED = '__deferred'
@@ -40,14 +44,17 @@ module Safrano
       { uri: entity.uri }
     end
 
-    EMPTYH = {}.freeze
-    METADATA_K = '__metadata'
     def get_entity_odata_h(entity:, template:)
-      # start with metadata
-      hres = { METADATA_K => entity.metadata_h }
+      hres = {}
+      # finalise the template according to options
+      # (eg. skip metadata and or deferred...)
+      @final_template_func.call(template)
 
       template.each do |elmt, arg|
         case elmt
+        when :meta
+          hres[METADATA_K] = entity.metadata_h
+
         when :all_values
           hres.merge! entity.casted_values
 
@@ -110,6 +117,7 @@ module Safrano
   TRAILING_SLASH_RGX = %r{/\z}.freeze
   LEADING_SLASH_RGX = %r{\A/}.freeze
   include XMLNS
+  GENERIC_415_RESP = [415, {}, ['']].freeze
   # Base class for service. Subclass will be for V1, V2 etc...
   class ServiceBase
     include Safrano
@@ -142,6 +150,8 @@ module Safrano
     attr_accessor :function_imports
     attr_accessor :function_import_keys
     attr_accessor :type_mappings
+    attr_accessor :final_template_func
+    attr_accessor :response_format_options
 
     # Instance attributes for specialized Version specific Instances
     attr_accessor :v1
@@ -150,6 +160,12 @@ module Safrano
     # TODO: more elegant design
     attr_reader :data_service_version
 
+    # for response format options
+    FINAL_TEMPLATE_FUNC_DEFAULT = ->(_template) {}
+    FINAL_TEMPLATE_FUNC_SKIP_META = ->(template) { template.delete(:meta) }
+    FINAL_TEMPLATE_FUNC_SKIP_DEFERR = ->(template) { template.delete(:deferr) }
+    FINAL_TEMPLATE_FUNC_SKIP_META_DEFERR = ->(template) { template.delete(:meta); template.delete(:deferr) }
+
     def initialize(&block)
       # Warning: if you add attributes here, you shall need add them
       # in copy_attribs_to as well
@@ -163,6 +179,8 @@ module Safrano
       @function_import_keys = []
       @cmap = {}
       @type_mappings = {}
+      @response_format_options = []
+      @final_template_func = FINAL_TEMPLATE_FUNC_DEFAULT
       # enabled per default starting from 0.6
       @bugfix_create_response = true
       instance_eval(&block) if block_given?
@@ -213,12 +231,42 @@ module Safrano
       (@v2.xserver_url = @xserver_url) if @v2
     end
 
+    VALID_RESP_FORMAT_OPTS = [:skip_deferred, :skip_metadata]
+    def valid_resp_format_options(*args)
+      args.map!(&:to_sym)
+      args.each { |arg|
+        raise API::InvalidRespFormatOption.new(arg) unless VALID_RESP_FORMAT_OPTS.include?(arg)
+      }
+      yield(args)
+    end
+
+    def response_format_options(*args)
+      valid_resp_format_options(*args) do |vargs|
+        @response_format_options = vargs.dup
+        process_response_format_options
+        @v1.response_format_options(*vargs) if @v1
+        @v2.response_format_options(*vargs) if @v2
+      end
+    end
+
     # keep the bug active for now, but allow to de-activate the fix
     def bugfix_create_response(bool)
       @bugfix_create_response = bool
     end
 
     # end public API
+    def process_response_format_options
+      @final_template_func = if (@response_format_options.include?(:skip_metadata) &&
+                                    @response_format_options.include?(:skip_deferred))
+                               FINAL_TEMPLATE_FUNC_SKIP_META_DEFERR
+                             elsif @response_format_options.include?(:skip_metadata)
+                               FINAL_TEMPLATE_FUNC_SKIP_META
+                             elsif @response_format_options.include?(:skip_deferred)
+                               FINAL_TEMPLATE_FUNC_SKIP_DEFERR
+                             else
+                               FINAL_TEMPLATE_FUNC_DEFAULT
+                             end
+    end
 
     def set_uribase
       @uribase = if @xpath_prefix.empty?
@@ -249,6 +297,8 @@ module Safrano
       other.function_imports = @function_imports
       other.function_import_keys = @function_import_keys
       other.type_mappings = @type_mappings
+      other.response_format_options = @response_format_options
+      other.final_template_func = @final_template_func
       other.bugfix_create_response(@bugfix_create_response)
       other
     end
@@ -620,6 +670,8 @@ module Safrano
         Safrano::TransitionContentId
       ].freeze
 
+      include Safrano::Transitions::GetNextTrans::ByLongestMatch
+
       def build_allowed_transitions
         @allowed_transitions = if @function_imports.empty?
                                  (ALLOWED_TRANSITIONS_FIXED + [
@@ -679,7 +731,7 @@ module Safrano
         [200, CT_APPXML, [service_xml(req)]]
       else
         # this is returned by http://services.odata.org/V2/OData/Safrano.svc
-        415
+        GENERIC_415_RESP
       end
     end
   end
@@ -748,11 +800,13 @@ module Safrano
       Safrano::Transition::RESULT_END
     end
 
+    include Safrano::Transitions::GetNextTrans::ForJustTransitionEnd
+
     def odata_get(req)
       if req.accept?(APPXML)
         [200, CT_APPXML, [@service.metadata_xml(req)]]
       else
-        415
+        GENERIC_415_RESP
       end
     end
   end

data/lib/safrano/type_mapping.rb

@@ -12,6 +12,7 @@ module Safrano
     attr_reader :castfunc
     attr_reader :edm_type
   end
+
   # Model attribute (column) specific mapping
   class AttributeTypeMapping < TypeMapping
     attr_reader :attr_name
@@ -20,6 +21,7 @@ module Safrano
       @edm_type = builder.xedm_type
       @castfunc = builder.castfunc
     end
+
     # wrapper to handle API
     class Builder
       attr_reader :xedm_type
@@ -82,9 +84,8 @@ module Safrano
       end
 
       def match(curtyp)
-        if @bui2 && (m = @bui2.match(curtyp))
-          m
-        elsif @bui1 && (m = @bui1.match(curtyp))
+        if (@bui2 && (m = @bui2.match(curtyp))) ||
+           (@bui1 && (m = @bui1.match(curtyp)))
           m
         elsif @rgx.match(curtyp)
           type_mapping
@@ -134,6 +135,7 @@ module Safrano
         RgxTypeMapping1Par.new(self)
       end
     end
+
     class Builder2Par < Builder
       def initialize(db_ty_rgx, proc)
         @db_types_rgx = db_ty_rgx
@@ -177,6 +179,7 @@ module Safrano
       @castfunc = builder.castfunc
     end
   end
+
   class RgxTypeMapping2Par < RgxTypeMapping
     def initialize(builder)
       @edm_type = builder.xedm_type