safrano 0.6.5 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b71032a7ee1e048867f3b54f57d920ba772a44f29a3419a598d2206d50e949c7
-  data.tar.gz: d203df34eda2c7aad9385a84e866d273f1a1f37ba981ffdcc8956de9dad35633
+  metadata.gz: a93263d81a1f266029f7aac03d6b7226477f10d27d33255462e08133955ab759
+  data.tar.gz: 894a0bfab2eeeee57543bee7dd0c1ec93b5bc73e0afc6fe5f979c7b7e7067039
 SHA512:
-  metadata.gz: d5cb1583e62f42f9007368204d24f101273049c05e75723dbcd7796732d83e1ac29a1515df0a876a2002c212b0da8204c498070104688fd4b493092072e13dee
-  data.tar.gz: 96aa136d330148331b98943807c83b42e466aa7357c8b360b3f5a66843b9472df41015309b2bef19d993bdabf5f4d1d41e983e7082a1f06d34015370bc87a034
+  metadata.gz: f0900d4f692a9139226d4fb84703f8a0c47a071b97b0a46c8455016f6a7d0d09caf2b12f32e616c9880a10a0b50e09917ca22afc4af7fc0f4cddac690193b25c
+  data.tar.gz: 30a623f667830e0dc4342bcf240843d313173ef12c0e877dc1814e779fc7f53459e7ec7e958aedd22b4387c9390907844a0c2c84a639db8d98dc62805203a671

data/lib/odata/collection_media.rb

@@ -21,7 +21,7 @@ module Safrano
     class Static < Handler
       def initialize(root: nil, mediaklass:)
         @root = File.absolute_path(root || Dir.pwd)
-        @file_server = ::Rack::File.new(@root)
+        @file_server = ::Rack::Files.new(@root)
         @media_class = mediaklass
         @media_dir_name = mediaklass.to_s
         register

data/lib/odata/complex_type.rb

@@ -81,9 +81,9 @@ module Safrano
       end
 
       # needed for ComplexType result
-      def to_odata_json(_req)
+      def to_odata_json(req)
         t = self.class.klassmod.output_template
-        innerh = _req.service.get_entity_odata_h(entity: @value, template: t)
+        innerh = req.service.get_entity_odata_h(entity: @value, template: t)
         innerj = innerh.to_json
 
         "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"

data/lib/odata/error.rb

@@ -48,6 +48,13 @@ module Safrano
     end
   end
 
+  # used in function import error handling. cf. func import / do_execute_func
+  def self.with_error(result)
+    if result.respond_to?(:error) && (err = result.error)
+      yield err
+    end
+  end
+
   # base module for HTTP errors, when used as a Error Class
   module ErrorClass
     include ::Safrano::Contract::Invalid
@@ -94,10 +101,20 @@ module Safrano
   # generic http 500 server err
   class ServerError
     extend  ErrorClass
+    include ErrorInstance
     HTTP_CODE = 500
     @msg = 'Server error'
   end
 
+  class ServiceOperationError
+    extend  ErrorClass
+    include ErrorInstance
+    HTTP_CODE = 500
+    def initialize(msg:, sopname: nil)
+      @msg = "Error in service operation #{sopname}: #{msg}"
+    end
+  end
+
   # for outputing Sequel exceptions that we could not prevent
   class SequelExceptionError < ServerError
     include ErrorInstance

data/lib/odata/function_import.rb

@@ -10,6 +10,21 @@ module Safrano
   end
 
   module FunctionImport
+    # error classes
+    class DefinitionMissing < StandardError
+      def initialize(fnam)
+        msg = "Function import #{fnam}: definition is missing. Provide definition either as a return code block or with .definition(lambda)"
+        super(msg)
+      end
+    end
+    class ProcRedefinition < StandardError
+      def initialize(fnam)
+        msg = "Function import #{fnam}: Block/lambda Redefinition . Provide definition either as a return code block or with .definition(lambda) but not both"
+        super(msg)
+      end
+    end
+
+    # Function import object
     class Function
       @allowed_transitions = [Safrano::TransitionEnd]
       attr_reader :name
@@ -53,8 +68,6 @@ module Safrano
       alias auto_query_params auto_query_parameters
 
       def return(klassmod, &proc)
-        raise('Please provide a code block') unless block_given?
-
         @returning = if klassmod.respond_to? :return_as_instance_descriptor
                        klassmod.return_as_instance_descriptor
                      else
@@ -62,13 +75,35 @@ module Safrano
                        # --> assume it is a Primitive
                        ResultDefinition.asPrimitiveType(klassmod)
                      end
-        @proc = proc
+        # block is optional  since 0.6.7
+        # the function definition can now also be made with .definition(lambda)
+        # consistency check that there is a single definition either as a
+        # return-block    or a definition lambda is made on publish finalise
+
+        if block_given?
+          # proc already defined...
+          raise Redefinition.new(@name) if @proc
+
+          @proc = proc
+        end
+
         self
       end
 
-      def return_collection(klassmod, &proc)
-        raise('Please provide a code block') unless block_given?
+      def definition(lambda)
+        raise('Please provide a lambda') unless lambda
+        # proc already defined...
+        raise ProcRedefinition.new(@name) if @proc
+
+        @proc = lambda
+      end
+
+      # this is called from service.finalize_publishing
+      def check_definition
+        raise DefinitionMissing.new(@name) unless @proc
+      end
 
+      def return_collection(klassmod, lambda: nil, &proc)
         @returning = if klassmod.respond_to? :return_as_collection_descriptor
                        klassmod.return_as_collection_descriptor
                      else
@@ -77,7 +112,14 @@ module Safrano
                        #                       ResultAsPrimitiveTypeColl.new(klassmod)
                        ResultDefinition.asPrimitiveTypeColl(klassmod)
                      end
-        @proc = proc
+        # block is optional  since 0.6.7
+        if block_given?
+          # proc already defined...
+          raise ProcRedefinition.new(@name) if @proc
+
+          @proc = proc
+        end
+
         self
       end
       #      def initialize_params
@@ -151,14 +193,31 @@ module Safrano
       def with_transition_validated(req)
         #        initialize_params
         @params = req.params
-        return yield unless (@error = check_url_func_params)
-
+        unless (@error = check_url_func_params)
+          begin
+            return yield
+          rescue LocalJumpError => e
+            @error = Safrano::ServiceOperationReturnError.new
+          end
+        end
         [nil, :error, @error] if @error
       end
 
       def do_execute_func(req)
         with_transition_validated(req) do
           result = @proc.call(**@funcparams)
+
+          # (application-)error handling
+          # the result is an Error object or class
+
+          # Note: Sequel::Error exceptions are already
+          # handled on rack app level (cf. the call methode )
+          Safrano::with_error(result) do |error|
+            @error = error
+            return [nil, :error, @error] # this is return from do_execute_func !
+          end
+
+          # non error case
           [@returning.do_execute_func_result(result, req, @auto_query_params), :run]
         end
       end

data/lib/odata/model_ext.rb

@@ -753,7 +753,8 @@ module Safrano
           # json is default content type so we dont need to specify it here again
           # TODO quirks array mode !
           # [201, EMPTY_HASH, new_entity.to_odata_post_json(service: req.service)]
-          [201, { 'Location' => new_entity.uri }, new_entity.to_odata_create_json(request: req)]
+          [201, { Safrano::LOCATION => new_entity.uri },
+           new_entity.to_odata_create_json(request: req)]
         else # TODO: other formats
           415
         end

data/lib/odata/request/json.rb

@@ -1,9 +1,15 @@
 require 'json'
 require 'time'
-
+require 'base64'
 # client parsing functionality to ease testing
 
 module Safrano
+  module RFC2047
+    def self.encode(str)
+      "=?utf-8?b?#{Base64.strict_encode64(str)}?="
+    end
+  end
+
   module OData
     # this is used to parse inbound json payload on POST / PUT & co
     # it does not do symbolize but proper (hopefully) type casting when needed

data/lib/safrano/core.rb

@@ -13,10 +13,10 @@ module Safrano
 
   # some prominent constants... probably already defined elsewhere eg in Rack
   # but lets KISS
-  CONTENT_TYPE = 'Content-Type'
-  CONTENT_LENGTH = 'Content-Length'
-  LOCATION = 'Location'
-  CTT_TYPE_LC = 'content-type'
+  CONTENT_TYPE = 'content-type'
+  CONTENT_LENGTH = 'content-length'
+  LOCATION = 'location'
+
   TEXTPLAIN_UTF8 = 'text/plain;charset=utf-8'
   APPJSON = 'application/json'
   APPXML = 'application/xml'

data/lib/safrano/multipart.rb

@@ -142,12 +142,12 @@ module MIME
           @lines = inpstr.readlines(@sep)
         else
           # rack input wrapper only has gets but not readlines
-          sepsave = $INPUT_RECORD_SEPARATOR
-          $INPUT_RECORD_SEPARATOR = @sep
-          while (line = inpstr.gets)
-            @lines << line
-          end
-          $INPUT_RECORD_SEPARATOR = sepsave
+          # BUT the rack SPEC says it only supports gets without argument!
+          # --> finally we end up using read and split into lines...
+          # normally should be ok for $batch POST payloads
+
+          # inpstr.read should be a String
+          @lines = inpstr.read.lines(@sep)
 
         end
         # tmp hack for test-tools that convert CRLF in payload to LF :-(

data/lib/safrano/service.rb

@@ -375,7 +375,7 @@ module Safrano
     def finalize_publishing
       # build the cmap
       @cmap = {}
-      @collections.each do |klass|
+      @collections&.each do |klass|
         @cmap[klass.entity_set_name] = klass
         # set namespace needed to have qualified type name
         copy_namespace_to(klass)
@@ -393,7 +393,7 @@ module Safrano
       set_uribase
 
       # finalize the uri's and include NoMappingBeforeOutput or MappingBeforeOutput as needed
-      @collections.each do |klass|
+      @collections&.each do |klass|
         klass.finalize_publishing(self)
 
         klass.build_uri(@uribase)
@@ -448,9 +448,14 @@ module Safrano
         Safrano::Filter::DateTimeLit.include Safrano::Filter::DateTimeDefault
         Safrano::Filter::DateTimeOffsetLit.include Safrano::Filter::DateTimeDefault
       end
+
+      # check function import definition
+      function_imports.each_value { |func| func.check_definition }
     end
 
     def execute_deferred_iblocks
+      return unless @collections
+
       @collections.each do |k|
         k.instance_eval(&k.deferred_iblock) if k.deferred_iblock
       end
@@ -460,6 +465,8 @@ module Safrano
     ## evaluated after '@collections' is filled !
     # A regexp matching all allowed base entities (eg product|categories )
     def base_url_regexp
+      return unless @collections
+
       @collections.map(&:entity_set_name).join('|')
     end
 

data/lib/safrano/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safrano
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.7
 platform: ruby
 authors:
 - oz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2023-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rfc2047
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement