safrano 0.4.4 → 0.5.2

data/lib/odata/entity.rb

@@ -112,10 +112,11 @@ module Safrano
       selvals
     end
 
-    # post paylod expects the new entity in an array
-    def to_odata_post_json(service:)
-      innerj = service.get_coll_odata_h(array: [self],
-                                        template: self.class.default_template).to_json
+    # some clients wrongly expect post payload with the new entity in an array
+    # TODO quirks array mode !
+    def to_odata_array_json(request:)
+      innerj = request.service.get_coll_odata_h(array: [self],
+                                                template: self.class.default_template).to_json
       "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
 
@@ -124,7 +125,7 @@ module Safrano
     end
 
     def copy_request_infos(req)
-      @params = req.params
+      @params = @inactive_query_params ? EMPTY_HASH : req.params
       @do_links = req.walker.do_links
       @uparms = UrlParameters4Single.new(self, @params)
     end
@@ -150,7 +151,11 @@ module Safrano
       @uparms.check_all.tap_valid { return odata_get_output(req) }
              .tap_error { |e| return e.odata_get(req) }
     end
-
+    def inactive_query_params
+      @inactive_query_params = true
+      self # chaining
+    end
+    
     DELETE_REL_AND_ENTY = lambda do |entity, assoc, parent|
       Safrano.remove_nav_relation(assoc, parent)
       entity.destroy(transaction: false)
@@ -263,6 +268,7 @@ module Safrano
       ret
     end
   end
+
   # end of module SafranoEntity
   module Entity
     include EntityBase
@@ -438,5 +444,22 @@ module Safrano
       pk_hash.values
     end
   end
-end
-# end of Module OData
+
+  module EntityCreateStandardOutput
+    # Json formatter for a create  entity POST call / Standard version; return as json object
+    def to_odata_create_json(request:)
+      # TODO Perf: reduce method call overhead
+      # we added this redirection for readability and flexibility
+      to_odata_json(request: request)
+    end
+  end
+
+  module EntityCreateArrayOutput
+    # Json formatter for a create  entity POST call Array version
+    def to_odata_create_json(request:)
+      # TODO Perf: reduce method call overhead
+      # we added this redirection for readability and flexibility
+      to_odata_array_json(request: request)
+    end
+  end
+end # end of Module OData

data/lib/odata/error.rb

@@ -37,6 +37,15 @@ module Safrano
         super(msg, symbname)
       end
     end
+
+    # duplicate attribute name
+    class ModelDuplicateAttributeError < NameError
+      def initialize(klass, symb)
+        symbname = symb.to_s
+        msg = "There is already an attribute :#{symbname} defined in class #{klass}"
+        super(msg, symbname)
+      end
+    end
   end
 
   # base module for HTTP errors, when used as a Error Class
@@ -105,6 +114,18 @@ module Safrano
     end
   end
 
+  # http Unprocessable Entity for example when trying to
+  # upload duplicated media ressource
+  class UnprocessableEntityError
+    extend  ErrorClass
+    include ErrorInstance
+    HTTP_CODE = 422
+    @msg = 'Unprocessable Entity'
+    def initialize(reason)
+      @msg = reason
+    end
+  end
+
   # http Bad Req.
   class BadRequestError
     extend  ErrorClass
@@ -116,6 +137,13 @@ module Safrano
     end
   end
 
+  # for upload empty media
+  class BadRequestEmptyMediaUpload < BadRequestError
+    include ErrorInstance
+    def initialize(path)
+      @msg = "Bad Request: empty media file #{path}"
+    end
+  end
   # Generic failed changeset
   class BadRequestFailedChangeSet < BadRequestError
     @msg = 'Bad Request: Failed changeset '

data/lib/odata/filter/base.rb

@@ -57,6 +57,11 @@ module Safrano
     class Literal < Leave
     end
 
+    # Null Literal is unquoted null word
+    class NullLiteral < Literal
+      LEUQES = nil
+    end
+
     # Qualit (qualified lits) are words separated by /
     # path/path/path/attrib
     class Qualit < Literal

data/lib/odata/filter/parse.rb

@@ -151,6 +151,12 @@ module Safrano
               grow_at_cursor(Literal.new(tok))
             end
 
+          when :NullLiteral
+            with_accepted(tok, typ) do
+              @cursor.update_state(tok, typ)
+              grow_at_cursor(NullLiteral.new(tok))
+            end
+
           when :Qualit
             with_accepted(tok, typ) do
               @cursor.update_state(tok, typ)

data/lib/odata/filter/sequel.rb

@@ -183,6 +183,13 @@ module Safrano
                     end
         Contract.collect_result!(@children[0].leuqes(jh),
                                  @children[1].leuqes(jh)) do |c0, c1|
+          if c1 == NullLiteral::LEUQES
+            if @value == :eq
+              leuqes_op = :IS
+            elsif @value == :ne
+              leuqes_op = :'IS NOT'
+            end
+          end
           Sequel::SQL::BooleanExpression.new(leuqes_op, c0, c1)
         end
       end
@@ -262,6 +269,14 @@ module Safrano
       end
     end
 
+    # Null
+    class NullLiteral
+      def leuqes(jh)
+        # Sequel's representation of NULL
+        success LEUQES
+      end
+    end
+
     # Qualit (qualified lits) are words separated by /
     class Qualit
       def leuqes(jh)

data/lib/odata/filter/token.rb

@@ -10,13 +10,14 @@ module Safrano
                        day hour minute month second year
                        round floor ceiling].freeze
         FUNCRGX = FUNCNAMES.join('|')
+        NULLRGX = 'null|NULL|Null'
         QSTRINGRGX = /'((?:[^']|(?:'{2}))*)'/.freeze
         BINOBOOL = '[eE][qQ]|[LlgGNn][eETt]|[aA][nN][dD]|[oO][rR]'
         BINOARITHM = '[aA][dD][dD]|[sS][uU][bB]|[mM][uU][lL]|[dD][iI][vV]|[mM][oO][dD]'
-        NOTRGX = 'not|NOT'
+        NOTRGX = 'not|NOT|Not'
         FPRGX = '\d+(?:\.\d+)?(?:e[+-]?\d+)?'
         QUALITRGX = '\w+(?:\/\w+)+'
-        RGX = /(#{FUNCRGX})|([\(\),])|(#{BINOBOOL})\s+|(#{BINOARITHM})|(#{NOTRGX})|#{QSTRINGRGX}|(#{FPRGX})|(#{QUALITRGX})|(\w+)|(')/.freeze
+        RGX = /(#{FUNCRGX})|(#{NULLRGX})|([\(\),])|(#{BINOBOOL})\s+|(#{BINOARITHM})|(#{NOTRGX})|#{QSTRINGRGX}|(#{FPRGX})|(#{QUALITRGX})|(\w+)|(')/.freeze
 
         def each_typed_token(inp)
           typ = nil
@@ -34,27 +35,29 @@ module Safrano
                   when 0
                     :FuncTree
                   when 1
+                    :NullLiteral
+                  when 2
                     case found
                     when '(', ')'
                       :Delimiter
                     when ','
                       :Separator
                     end
-                  when 2
-                    :BinopBool
                   when 3
-                    :BinopArithm
+                    :BinopBool
                   when 4
-                    :UnopTree
+                    :BinopArithm
                   when 5
-                    :QString
+                    :UnopTree
                   when 6
-                    :FPNumber
+                    :QString
                   when 7
-                    :Qualit
+                    :FPNumber
                   when 8
-                    :Literal
+                    :Qualit
                   when 9
+                    :Literal
+                  when 10
                     :unmatchedQuote
                   end
             yield found, typ

data/lib/odata/filter/tree.rb

@@ -65,7 +65,7 @@ module Safrano
       # nil is considered as accepted, otherwise non-nil=the error
       def accept?(tok, typ)
         case typ
-        when :Literal, :Qualit, :QString, :FuncTree, :ArgTree,
+        when :Literal, :NullLiteral, :Qualit, :QString, :FuncTree, :ArgTree,
              :UnopTree, :FPNumber
           nil
         when :Delimiter
@@ -232,7 +232,7 @@ module Safrano
 
       def update_state(_tok, typ)
         case typ
-        when :Literal, :Qualit, :QString, :FuncTree, :BinopBool, :BinopArithm, :UnopTree, :FPNumber
+        when :Literal, :NullLiteral, :Qualit, :QString, :FuncTree, :BinopBool, :BinopArithm, :UnopTree, :FPNumber
           @state = :closed
         end
       end
@@ -297,7 +297,7 @@ module Safrano
           @state = :closed
         when :Separator
           @state =  :sep
-        when :Literal, :Qualit, :QString, :FuncTree, :FPNumber
+        when :Literal, :NullLiteral, :Qualit, :QString, :FuncTree, :FPNumber
           @state =  :val
         end
       end
@@ -327,7 +327,7 @@ module Safrano
           elsif @state == :sep
             Parser::ErrorInvalidToken.new(tok, typ, self)
           end
-        when :Literal, :Qualit, :QString, :FuncTree, :FPNumber
+        when :Literal, :NullLiteral, :Qualit, :QString, :FuncTree, :FPNumber
           if (@state == :open) || (@state == :sep)
             if @parent.arity_full?(@children.size)
               Parser::ErrorInvalidArity.new(tok, typ, self)

data/lib/odata/function_import.rb

@@ -2,8 +2,10 @@
 
 require_relative 'complex_type'
 require_relative 'edm/primitive_types'
+require_relative 'transition'
+
 module Safrano
-  def Safrano.FunctionImport(name)
+  def self.FunctionImport(name)
     FunctionImport::Function.new(name)
   end
 
@@ -19,12 +21,12 @@ module Safrano
       end
 
       def allowed_transitions
-        [Safrano::TransitionEnd]
+        [Safrano::TransitionExecuteFunc]
       end
 
       def input(**parmtypes)
         @input = {}
-        parmtypes.each { |k, t|
+        parmtypes.each do |k, t|
           @input[k] = case t.name
                       when 'Integer'
                         Safrano::Edm::Edm::Int32
@@ -37,10 +39,16 @@ module Safrano
                       else
                         t
                       end
-        }
+        end
         self
       end
-
+      
+      def auto_query_parameters
+        @auto_query_params = true
+        self   # chaining
+      end
+      alias auto_query_params auto_query_parameters 
+      
       def return(klassmod, &proc)
         raise('Please provide a code block') unless block_given?
 
@@ -49,7 +57,7 @@ module Safrano
                      else
                        # if it's neither a ComplexType nor a Model-Entity
                        # --> assume it is a Primitive
-                       ResultAsPrimitiveType.new(klassmod)
+                       ResultDefinition.asPrimitiveType(klassmod)
                      end
         @proc = proc
         self
@@ -63,7 +71,8 @@ module Safrano
                      else
                        # if it's neither a ComplexType nor a Modle-Entity
                        # --> assume it is a Primitive
-                       ResultAsPrimitiveTypeColl.new(klassmod)
+#                       ResultAsPrimitiveTypeColl.new(klassmod)
+                       ResultDefinition.asPrimitiveTypeColl(klassmod)
                      end
         @proc = proc
         self
@@ -91,20 +100,20 @@ module Safrano
         return nil unless @input # anything to check ?
 
         # do we have all parameters provided ?
-        check_missing_params.tap_error do |error| return error end
+        check_missing_params.tap_error { |error| return error }
         # ==> all params were provided
 
         # now we shall check the content and type of the parameters
-        @input.each { |ksym, typ|
+        @input.each do |ksym, typ|
           typ.convert_from_urlparam(v = @params[ksym.to_s])
              .tap_valid do |retval|
             @funcparams[ksym] = retval
           end
-             .tap_error do |error|
+             .tap_error do
             # return is really needed here, or we end up returning nil below
             return parameter_convertion_error(ksym, typ, v)
           end
-        }
+        end
         nil
       end
 
@@ -125,41 +134,33 @@ module Safrano
                                #                       EntitySet= @entity_set ,
                                'ReturnType' => @returning.type_metadata,
                                'm:HttpMethod' => @http_method)
-        @input.each { |iname, type|
+        @input.each do |iname, type|
           funky.add_element('Parameter',
                             'Name' => iname.to_s,
                             'Type' => type.type_name,
                             'Mode' => 'In')
-        } if @input
+        end if @input
         funky
       end
-
-      def with_validated_get(req)
+      
+      def with_transition_validated(req)
         #        initialize_params
+        @params = req.params
         return yield unless (@error = check_url_func_params)
 
-        @error.odata_get(req) if @error
+        [nil, :error, @error] if @error
       end
-
-      def to_odata_json(req)
-        result = @proc.call(**@funcparams)
-        @returning.to_odata_json(result, req)
-      end
-
-      def odata_get_output(req)
-        [200, EMPTY_HASH, [to_odata_json(req)]]
-      end
-
-      def odata_get(req)
-        @params = req.params
-
-        with_validated_get(req) do
-          odata_get_output(req)
+      
+     
+      def do_execute_func(req)
+        with_transition_validated(req) do
+          result = @proc.call(**@funcparams)
+          [@returning.do_execute_func_result(result, req, @auto_query_params), :run]
         end
       end
-
-      def transition_end(_match_result)
-        [nil, :end]
+    
+      def transition_execute_func(_match_result)
+        [self, :run_with_execute_func]
       end
     end
   end

data/lib/odata/model_ext.rb

@@ -81,11 +81,11 @@ module Safrano
     end
 
     def return_as_collection_descriptor
-      Safrano::FunctionImport::ResultAsEntityColl.new(self)
+      Safrano::FunctionImport::ResultDefinition.asEntityColl(self)
     end
 
     def return_as_instance_descriptor
-      Safrano::FunctionImport::ResultAsEntity.new(self)
+      Safrano::FunctionImport::ResultDefinition.asEntity(self)
     end
 
     def execute_deferred_iblock
@@ -94,8 +94,10 @@ module Safrano
 
     # Factory json-> Model Object instance
     def new_from_hson_h(hash)
-      enty = new
-      enty.set_fields(hash, data_fields, missing: :skip)
+      #enty = new
+      #enty.set_fields(hash, data_fields, missing: :skip)
+      enty = create(hash)
+      #enty.set(hash)
       enty
     end
 
@@ -299,6 +301,14 @@ module Safrano
 
       attr_class = assoc[:class_name].constantize
       lattr_name_str = (attr_name_str || assoc_symb.to_s)
+
+      # check duplicate attributes names
+      raise Safrano::API::ModelDuplicateAttributeError.new(self, lattr_name_str) if @columns.include? lattr_name_str.to_sym
+
+      if @nav_entity_attribs_keys
+        raise Safrano::API::ModelDuplicateAttributeError.new(self, lattr_name_str) if @nav_entity_attribs_keys.include? lattr_name_str
+      end
+
       @nav_collection_attribs[lattr_name_str] = attr_class
       @nav_collection_attribs_keys << lattr_name_str
       @nav_collection_url_regexp = @nav_collection_attribs_keys.join('|')
@@ -317,6 +327,14 @@ module Safrano
 
       attr_class = assoc[:class_name].constantize
       lattr_name_str = (attr_name_str || assoc_symb.to_s)
+
+      # check duplicate attributes names
+      raise Safrano::API::ModelDuplicateAttributeError.new(self, lattr_name_str) if @columns.include? lattr_name_str.to_sym
+
+      if @nav_collection_attribs_keys
+        raise Safrano::API::ModelDuplicateAttributeError.new(self, lattr_name_str) if @nav_collection_attribs_keys.include? lattr_name_str
+      end
+
       @nav_entity_attribs[lattr_name_str] = attr_class
       @nav_entity_attribs_keys << lattr_name_str
       @nav_entity_url_regexp = @nav_entity_attribs_keys.join('|')
@@ -352,6 +370,9 @@ module Safrano
 
       build_allowed_transitions
       build_entity_allowed_transitions
+
+      # for media
+      finalize_media if self.respond_to? :finalize_media
     end
 
     KEYPRED_URL_REGEXP = /\A\(\s*'?([\w=,'\s]+)'?\s*\)(.*)/.freeze
@@ -608,7 +629,9 @@ module Safrano
           req.register_content_id_ref(new_entity)
           new_entity.copy_request_infos(req)
           # json is default content type so we dont need to specify it here again
-          [201, EMPTY_HASH, new_entity.to_odata_post_json(service: req.service)]
+          # TODO quirks array mode !
+          # [201, EMPTY_HASH, new_entity.to_odata_post_json(service: req.service)]
+          [201, EMPTY_HASH, new_entity.to_odata_create_json(request: req)]
         else # TODO: other formats
           415
         end