safrano 0.4.4 → 0.5.2

data/lib/odata/transition.rb

@@ -6,7 +6,7 @@ require_relative 'error'
 module Safrano
   # represents a state transition when navigating/parsing the url path
   # from left to right
-  class Transition < Regexp
+  class Transition 
     attr_accessor :trans
     attr_accessor :match_result
     attr_accessor :rgx
@@ -52,8 +52,28 @@ module Safrano
       ctx.method(@trans).call(@match_result)
     end
   end
-
+    
+  #Transition that does not move/change the input 
+  class InplaceTransition < Transition 
+    def initialize(trans: )
+      @trans = trans
+    end
+    def do_match(str)
+      @str = str
+    end
+    def path_remain
+      @str 
+    end
+    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')
   TransitionMetadata = Transition.new('\A(\/\$metadata)(.*)',
                                       trans: 'transition_metadata')
   TransitionBatch = Transition.new('\A(\/\$batch)(.*)',

data/lib/odata/walker.rb

@@ -29,18 +29,24 @@ module Safrano
 
     # are $links requested ?
     attr_reader :do_links
+    
+    attr_reader :request 
 
-    NIL_SERVICE_FATAL = 'Walker is called with a nil service'.freeze
-    EMPTYSTR = ''.freeze
-    SLASH = '/'.freeze
+    NIL_SERVICE_FATAL = 'Walker is called with a nil service'
+    EMPTYSTR = ''
+    SLASH = '/'
 
-    def initialize(service, path, content_id_refs = nil)
+    def initialize(service, path, request, content_id_refs = nil )
       raise NIL_SERVICE_FATAL unless service
 
       path = URI.decode_www_form_component(path)
       @context = service
       @content_id_refs = content_id_refs
-
+      
+      # needed because for function import we need access to the url parameters (req.params)
+      # who contains the functions params
+      @request = request
+      
       @contexts = [@context]
 
       @path_start = @path_remain = if service
@@ -109,6 +115,16 @@ module Safrano
       end
     end
 
+    # execute function import with request parameters 
+    # input: @context containt the function to exectute,
+    #        @request.params should normally contain the params
+    # result: validate the params for the given function, execute the function and 
+    #          return it's result back into @context,
+    #          and finaly set status :end   (or error if anyting went wrong )
+    def do_run_with_execute_func
+      @context, @status, @error = @context.do_execute_func(@request)
+    end
+   
     # little hacks... depending on returned state, set some attributes
     def state_mappings
       case @status
@@ -137,6 +153,8 @@ module Safrano
         # entity reference here and place it in @context
       when :run_with_content_id
         do_run_with_content_id
+      when :run_with_execute_func
+        do_run_with_execute_func
       end
 
       @contexts << @context

data/lib/safrano/contract.rb

@@ -62,6 +62,8 @@ module Safrano
     # All tap_valid* handlers are executed
     #     tap_error* handlers are not executed
     class Valid
+      attr_reader :result
+
       def initialize(result)
         @result = result
       end
@@ -100,17 +102,13 @@ module Safrano
       def error
         nil
       end
-
-      def result
-        @result
-      end
     end # class Valid
 
-    def Contract.valid(result)
+    def self.valid(result)
       Contract::Valid.new(result)
     end
 
-    def Contract.and(*contracts)
+    def self.and(*contracts)
       # pick the first error if any
       if (ff = contracts.find(&:error))
         return ff
@@ -118,18 +116,18 @@ module Safrano
 
       # return a new one with @result = list of the contracts's results
       # usually this then be reduced again with #collect_result! or #               #if_valid_collect methods
-      Contract.valid(contracts.map(&:result))
+      valid(contracts.map(&:result))
     end
 
     # shortcut for Contract.and(*contracts).collect_result!
-    def Contract.collect_result!(*contracts)
+    def self.collect_result!(*contracts)
       # pick the first error if any
       if (ff = contracts.find(&:error))
         return ff
       end
 
       # return a new one with @result = yield(*list of the contracts's results)
-      Contract.valid(yield(*contracts.map(&:result)))
+      valid(yield(*contracts.map(&:result)))
     end
 
     # generic success return, when return value does not matter

data/lib/safrano/core.rb

@@ -6,22 +6,22 @@ module Safrano
   EMPTY_ARRAY = [].freeze
   EMPTY_HASH = {}.freeze
   EMPTY_HASH_IN_ARY = [EMPTY_HASH].freeze
-  EMPTY_STRING = ''.freeze
+  EMPTY_STRING = ''
   ARY_204_EMPTY_HASH_ARY = [204, EMPTY_HASH, EMPTY_ARRAY].freeze
-  SPACE = ' '.freeze
-  COMMA = ','.freeze
+  SPACE = ' '
+  COMMA = ','
 
   # some prominent constants... probably already defined elsewhere eg in Rack
   # but lets KISS
-  CONTENT_TYPE = 'Content-Type'.freeze
-  CTT_TYPE_LC = 'content-type'.freeze
-  TEXTPLAIN_UTF8 = 'text/plain;charset=utf-8'.freeze
-  APPJSON = 'application/json'.freeze
-  APPXML = 'application/xml'.freeze
-  MP_MIXED = 'multipart/mixed'.freeze
-  APPXML_UTF8 = 'application/xml;charset=utf-8'.freeze
-  APPATOMXML_UTF8 = 'application/atomsvc+xml;charset=utf-8'.freeze
-  APPJSON_UTF8 = 'application/json;charset=utf-8'.freeze
+  CONTENT_TYPE = 'Content-Type'
+  CTT_TYPE_LC = 'content-type'
+  TEXTPLAIN_UTF8 = 'text/plain;charset=utf-8'
+  APPJSON = 'application/json'
+  APPXML = 'application/xml'
+  MP_MIXED = 'multipart/mixed'
+  APPXML_UTF8 = 'application/xml;charset=utf-8'
+  APPATOMXML_UTF8 = 'application/atomsvc+xml;charset=utf-8'
+  APPJSON_UTF8 = 'application/json;charset=utf-8'
 
   CT_JSON = { CONTENT_TYPE => APPJSON_UTF8 }.freeze
   CT_TEXT = { CONTENT_TYPE => TEXTPLAIN_UTF8 }.freeze

data/lib/safrano/deprecation.rb

@@ -22,7 +22,7 @@ module Safrano
   module Deprecation
     @backtrace_filter = false
     @output = $stderr
-    @prefix = "SAFRANO DEPRECATION WARNING: ".freeze
+    @prefix = 'SAFRANO DEPRECATION WARNING: '
 
     class << self
       # How to filter backtraces.  +false+ does not include backtraces, +true+ includes
@@ -64,10 +64,10 @@ module Safrano
     # otherwise do nothing as the ruby implementation does not support constant deprecation.
     def self.deprecate_constant(mod, constant)
       # :nocov:
-      if RUBY_VERSION > '2.3'
-        # :nocov:
-        mod.deprecate_constant(constant)
-      end
+      return unless RUBY_VERSION > '2.3'
+
+      # :nocov:
+      mod.deprecate_constant(constant)
     end
   end
 end

data/lib/safrano/multipart.rb

@@ -4,7 +4,7 @@ CRLF = "\r\n"
 LF = "\n"
 
 require 'securerandom'
-require 'webrick/httpstatus'
+require 'rack/utils'
 
 # Simple multipart support for OData $batch purpose
 module MIME
@@ -110,11 +110,11 @@ module MIME
         @target.ct = @target_ct
         @state = :bmp
       end
-      MPS = 'multipart/'.freeze
+      MPS = 'multipart/'
       MP_RGX1 = %r{^(digest|mixed);\s*boundary="(.*)"}.freeze
       MP_RGX2 = %r{^(digest|mixed);\s*boundary=(.*)}.freeze
       #      APP_HTTP_RGX = %r{^application/http}.freeze
-      APP_HTTP = 'application/http'.freeze
+      APP_HTTP = 'application/http'
       def new_content
         @target =
           if @target_ct.start_with?(MPS) &&
@@ -457,7 +457,7 @@ module MIME
                                "Content-Transfer-Encoding: binary#{CRLF}",
                                'HTTP/1.1 '].join(CRLF).freeze
 
-        StatusMessage = ::WEBrick::HTTPStatus::StatusMessage.freeze
+        StatusMessage = ::Rack::Utils::HTTP_STATUS_CODES.freeze
 
         def initialize
           @hd = {}

data/lib/safrano/rack_app.rb

@@ -56,7 +56,7 @@ module Safrano
     NOCACHE_HDRS = { 'Cache-Control' => 'no-cache',
                      'Expires' => '-1',
                      'Pragma' => 'no-cache' }.freeze
-    DATASERVICEVERSION = 'DataServiceVersion'.freeze
+    DATASERVICEVERSION = 'DataServiceVersion'
     include MethodHandlers
 
     def before

data/lib/safrano/request.rb

@@ -9,7 +9,7 @@ module Safrano
   # is not passed
   class Request < Rack::Request
     HEADER_PARAM = /\s*[\w.]+=(?:[\w.]+|"(?:[^"\\]|\\.)*")?\s*/.freeze
-    HEADER_VAL_RAW = '(?:\w+|\*)\/(?:\w+(?:\.|\-|\+)?|\*)*'.freeze
+    HEADER_VAL_RAW = '(?:\w+|\*)\/(?:\w+(?:\.|\-|\+)?|\*)*'
     HEADER_VAL_WITH_PAR = /(?:#{HEADER_VAL_RAW})\s*(?:;#{HEADER_PARAM})*/.freeze
     ON_CGST_ERROR = (proc { |r| raise(Sequel::Rollback) if r.in_changeset })
 
@@ -99,6 +99,7 @@ module Safrano
     def create_odata_walker
       @env['safrano.walker'] = @walker = Walker.new(@service,
                                                     path_info,
+                                                    self,
                                                     @content_id_references)
     end
 
@@ -194,7 +195,7 @@ module Safrano
       if (rqv = env['HTTP_DATASERVICEVERSION'])
         if (m = DATASERVICEVERSION_RGX.match(rqv))
           # client request an too new version --> 501
-          if ((v = m[1]) > Safrano::MAX_DATASERVICE_VERSION) or
+          if ((v = m[1]) > Safrano::MAX_DATASERVICE_VERSION) ||
              (v < Safrano::MIN_DATASERVICE_VERSION)
             Safrano::VersionNotImplementedError
           else

data/lib/safrano/service.rb

@@ -15,8 +15,8 @@ module Safrano
   # and will be included in Service class
   module ExpandHandler
     PATH_SPLITTER = %r{\A(\w+)/?(.*)\z}.freeze
-    DEFERRED = '__deferred'.freeze
-    URI = 'uri'.freeze
+    DEFERRED = '__deferred'
+    URI = 'uri'
 
     def get_deferred_odata_h(entity_uri:, attrib:)
       { DEFERRED => { URI => "#{entity_uri}/#{attrib}" } }
@@ -24,8 +24,8 @@ module Safrano
 
     # default v2
     # overriden in ServiceV1
-    RESULTS_K = 'results'.freeze
-    COUNT_K = '__count'.freeze
+    RESULTS_K = 'results'
+    COUNT_K = '__count'
     def get_coll_odata_h(array:, template:, icount: nil)
       array.map! do |w|
         get_entity_odata_h(entity: w, template: template)
@@ -40,7 +40,7 @@ module Safrano
     end
 
     EMPTYH = {}.freeze
-    METADATA_K = '__metadata'.freeze
+    METADATA_K = '__metadata'
     def get_entity_odata_h(entity:, template:)
       # start with metadata
       hres = { METADATA_K => entity.metadata_h }
@@ -90,21 +90,20 @@ module Safrano
   # xml namespace constants needed for the output of XML service and
   # and metadata
   module XMLNS
-    MSFT_ADO = 'http://schemas.microsoft.com/ado'.freeze
-    MSFT_ADO_2009_EDM = "#{MSFT_ADO}/2009/11/edm".freeze
-    MSFT_ADO_2007_EDMX = "#{MSFT_ADO}/2007/06/edmx".freeze
-    MSFT_ADO_2007_META = MSFT_ADO + \
-                         '/2007/08/dataservices/metadata'.freeze
-
-    W3_2005_ATOM = 'http://www.w3.org/2005/Atom'.freeze
-    W3_2007_APP = 'http://www.w3.org/2007/app'.freeze
+    MSFT_ADO = 'http://schemas.microsoft.com/ado'
+    MSFT_ADO_2009_EDM = "#{MSFT_ADO}/2009/11/edm"
+    MSFT_ADO_2007_EDMX = "#{MSFT_ADO}/2007/06/edmx"
+    MSFT_ADO_2007_META = "#{MSFT_ADO}/2007/08/dataservices/metadata"
+
+    W3_2005_ATOM = 'http://www.w3.org/2005/Atom'
+    W3_2007_APP = 'http://www.w3.org/2007/app'
   end
 end
 
 # Link to Model
 module Safrano
-  MAX_DATASERVICE_VERSION = '2'.freeze
-  MIN_DATASERVICE_VERSION = '1'.freeze
+  MAX_DATASERVICE_VERSION = '2'
+  MIN_DATASERVICE_VERSION = '1'
   CV_MAX_DATASERVICE_VERSION = Contract.valid(MAX_DATASERVICE_VERSION).freeze
   CV_MIN_DATASERVICE_VERSION = Contract.valid(MIN_DATASERVICE_VERSION).freeze
   include XMLNS
@@ -113,7 +112,7 @@ module Safrano
     include Safrano
     include ExpandHandler
 
-    XML_PREAMBLE = %Q(<?xml version="1.0" encoding="utf-8" standalone="yes"?>\r\n).freeze
+    XML_PREAMBLE = %(<?xml version="1.0" encoding="utf-8" standalone="yes"?>\r\n)
 
     # This is just a hash of entity Set Names to the corresponding Class
     # Example
@@ -138,6 +137,7 @@ module Safrano
     attr_accessor :relman
     attr_accessor :complex_types
     attr_accessor :function_imports
+    attr_accessor :function_import_keys
 
     # Instance attributes for specialized Version specific Instances
     attr_accessor :v1
@@ -156,13 +156,14 @@ module Safrano
       @relman = Safrano::RelationManager.new
       @complex_types = Set.new
       @function_imports = {}
+      @function_import_keys = []
       @cmap = {}
       instance_eval(&block) if block_given?
     end
 
     TRAILING_SLASH = %r{/\z}.freeze
-    DEFAULT_PATH_PREFIX = '/'.freeze
-    DEFAULT_SERVER_URL = 'http://localhost:9494'.freeze
+    DEFAULT_PATH_PREFIX = '/'
+    DEFAULT_SERVER_URL = 'http://localhost:9494'
 
     def enable_batch
       @batch_handler = Safrano::Batch::EnabledHandler.new
@@ -205,6 +206,12 @@ module Safrano
       (@v2.xserver_url = @xserver_url) if @v2
     end
 
+    # keep the bug active for now, but allow to activate the fix,
+    # later we will change the default to be fixed
+    def bugfix_create_response(bool = false)
+      @bugfix_create_response = bool
+    end
+
     # end public API
 
     def set_uribase
@@ -234,6 +241,7 @@ module Safrano
       other.batch_handler = @batch_handler
       other.complex_types = @complex_types
       other.function_imports = @function_imports
+      other.function_import_keys = @function_import_keys
       other
     end
 
@@ -317,6 +325,8 @@ module Safrano
     def function_import(name)
       funcimp = Safrano::FunctionImport(name)
       @function_imports[name] = funcimp
+      @function_import_keys << name
+      set_funcimports_sorted
       funcimp
     end
 
@@ -333,7 +343,11 @@ module Safrano
       @collections.sort_by! { |klass| klass.entity_set_name.size }.reverse! if @collections
       @collections
     end
-
+    
+    # need to be sorted by size too
+    def set_funcimports_sorted
+      @function_import_keys.sort_by!{|k| k.size}.reverse!
+    end
     # to be called at end of publishing block to ensure we get the right names
     # and additionally build the list of valid attribute path's used
     # for validation of $orderby or $filter params
@@ -362,6 +376,9 @@ module Safrano
       @collections.each do |klass|
         klass.build_uri(@uribase)
         klass.include(klass.time_cols.empty? ? Safrano::NoMappingBeforeOutput : Safrano::MappingBeforeOutput)
+
+        # Output create (POST) as single entity (Standard) or as array (non-standard buggy)
+        klass.include ( @bugfix_create_response ? Safrano::EntityCreateStandardOutput : Safrano::EntityCreateArrayOutput)
       end
 
       # build allowed transitions (requires that @collections are filled and sorted for having a
@@ -393,7 +410,7 @@ module Safrano
     end
 
     def base_url_func_regexp
-      @function_imports.keys.join('|')
+      @function_import_keys.join('|')
     end
 
     def service
@@ -530,7 +547,7 @@ module Safrano
 
     # methods related to transitions to next state (cf. walker)
     module Transitions
-      DOLLAR_ID_REGEXP = Regexp.new('\A\/\$').freeze
+      DOLLAR_ID_REGEXP = Regexp.new('\A\/\$')
       ALLOWED_TRANSITIONS_FIXED = [
         Safrano::TransitionEnd,
         Safrano::TransitionMetadata,

data/lib/safrano/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Safrano
-  VERSION = '0.4.4'
+  VERSION = '0.5.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safrano
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.2
 platform: ruby
 authors:
 - oz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2021-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -56,16 +56,16 @@ dependencies:
   name: rfc2047
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.51'
-description: Safrano is an OData server library based on Ruby, Rack and Sequel.
+description: Safrano is an OData server library based on Ruby Sequel and Rack.
 email: dev@aithscel.eu
 executables: []
 extensions: []
@@ -189,8 +189,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
-summary: Safrano is a Ruby OData server library based on Sequel and Rack
+summary: Safrano is an OData server library based on Ruby Sequel and Rack
 test_files: []