safrano 0.4.3 → 0.4.4

data/lib/odata/error.rb

@@ -1,21 +1,31 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'rexml/document'
-require 'safrano.rb'
+require_relative '../safrano/contract'
 
 # Error handling
-module OData
+module Safrano
   # for errors occurring in API (publishing) usage --> Exceptions
   module API
     # when published class is not a Sequel Model
     class ModelNameError < NameError
       def initialize(name)
-        super("class #{name} is not a Sequel Model", name)
+        super("class #{name} is not a Sequel Model")
+      end
+    end
+
+    # when published complex type is not a Complex Type
+    class ComplexTypeNameError < NameError
+      def initialize(name)
+        super("class #{name} is not a ComplexType")
       end
     end
+
     # when published class as media does not have the mandatory media fields
     class MediaModelError < NameError
       def initialize(name)
-        super("Model #{name} does not have the mandatory media attributes content_type/media_src", name)
+        super("Model #{name} does not have the mandatory media attributes content_type/media_src")
       end
     end
 
@@ -31,43 +41,88 @@ module OData
 
   # base module for HTTP errors, when used as a Error Class
   module ErrorClass
+    include ::Safrano::Contract::Invalid
+    def http_code
+      const_get(:HTTP_CODE)
+    end
+    EMPTYH = {}.freeze
     def odata_get(req)
+      message = (m = @msg.to_s).empty? ? to_s : m
       if req.accept?(APPJSON)
-        [const_get(:HTTP_CODE), CT_JSON,
-         { 'odata.error' => { 'code' => '', 'message' => @msg } }.to_json]
+        # json is default content type so we dont need to specify it here again
+        [self.http_code, EMPTY_HASH,
+         { 'odata.error' => { 'code' => "#{http_code}",
+                              'type' => to_s,
+                              'message' => message } }.to_json]
       else
-        [const_get(:HTTP_CODE), CT_TEXT, @msg]
+        [self.http_code, CT_TEXT, message]
       end
     end
   end
 
   # base module for HTTP errors, when used as an Error instance
   module ErrorInstance
+    include ::Safrano::Contract::Invalid
+    # can(should) be overriden in subclasses
+    def msg
+      @msg
+    end
+
     def odata_get(req)
+      message = (m = msg.to_s).empty? ? self.class.to_s : m
       if req.accept?(APPJSON)
-        [self.class.const_get(:HTTP_CODE), CT_JSON,
-         { 'odata.error' => { 'code' => '', 'message' => @msg } }.to_json]
+        # json is default content type so we dont need to specify it here again
+        [self.class.http_code, EMPTY_HASH,
+         { 'odata.error' => { 'code' => "#{self.class.http_code}",
+                              'type' => "#{self.class}",
+                              'message' => message } }.to_json]
       else
-        [self.class.const_get(:HTTP_CODE), CT_TEXT, @msg]
+        [self.class.http_code, CT_TEXT, message]
       end
     end
   end
 
+  # generic http 500 server err
+  class ServerError
+    extend  ErrorClass
+    HTTP_CODE = 500
+    @msg = 'Server error'
+  end
+
+  # for outputing Sequel exceptions that we could not prevent
+  class SequelExceptionError < ServerError
+    include ErrorInstance
+    def initialize(seqle7n)
+      @msg = seqle7n.message
+    end
+  end
+
+  # for outputing Ruby StandardError exceptions that we could not prevent
+  class RubyStandardErrorException < ServerError
+    include ErrorInstance
+    def initialize(rubye7n)
+      @msg = rubye7n.message
+    end
+  end
+
   # http Bad Req.
   class BadRequestError
     extend  ErrorClass
+    include ErrorInstance
     HTTP_CODE = 400
-    @msg = 'Bad Request Error'
+    @msg = 'Bad Request'
+    def initialize(reason)
+      @msg = "Bad Request : #{reason}"
+    end
   end
+
   # Generic failed changeset
   class BadRequestFailedChangeSet < BadRequestError
-    HTTP_CODE = 400
     @msg = 'Bad Request: Failed changeset '
   end
 
   # $value request for a non-media entity
   class BadRequestNonMediaValue < BadRequestError
-    HTTP_CODE = 400
     @msg = 'Bad Request: $value request for a non-media entity'
   end
   class BadRequestSequelAdapterError < BadRequestError
@@ -79,77 +134,127 @@ module OData
 
   # for Syntax error in Filtering
   class BadRequestFilterParseError < BadRequestError
-    HTTP_CODE = 400
     @msg = 'Bad Request: Syntax error in $filter'
   end
 
-  # for Syntax error in $expand param
-  class BadRequestExpandParseError < BadRequestError
-    HTTP_CODE = 400
-    @msg = 'Bad Request: Syntax error in $expand'
+  # for invalid attribute in path
+  class BadRequestInvalidAttribPath < BadRequestError
+    include ErrorInstance
+    def initialize(model, attr)
+      @msg = "Bad Request: the attribute #{attr} is invalid for entityset #{model.entity_set_name}"
+    end
+  end
+
+  # for invalid attribute in $expand param
+  class BadRequestExpandInvalidPath < BadRequestError
+    include ErrorInstance
+    def initialize(model, path)
+      @msg = "Bad Request: the $expand path #{path} is invalid for entityset #{model.entity_set_name}"
+    end
+  end
+  # for invalid properti(es) in $select param
+  class BadRequestSelectInvalidProps < BadRequestError
+    include ErrorInstance
+    def initialize(model, iprops)
+      @msg = ((iprops.size > 1) ? "Bad Request: the $select properties #{iprops.to_a.join(', ')} are invalid for entityset #{model.entity_set_name}" : "Bad Request: the $select property #{iprops.first} is invalid for entityset #{model.entity_set_name}")
+    end
   end
 
   # for Syntax error in $orderby param
   class BadRequestOrderParseError < BadRequestError
-    HTTP_CODE = 400
     @msg = 'Bad Request: Syntax error in $orderby'
   end
 
   # for $inlinecount error
   class BadRequestInlineCountParamError < BadRequestError
-    HTTP_CODE = 400
     @msg = 'Bad Request: wrong $inlinecount parameter'
   end
+
   # http not found
   class ErrorNotFound
     extend  ErrorClass
     HTTP_CODE = 404
     @msg = 'The requested ressource was not found'
   end
+
+  # http not found segment
+  class ErrorNotFoundSegment < ErrorNotFound
+    include ErrorInstance
+
+    def initialize(segment)
+      @msg = "The requested ressource segment #{segment} was not found"
+    end
+  end
+
   # Transition error (Safrano specific)
-  class ServerTransitionError
-    extend  ErrorClass
-    HTTP_CODE = 500
+  class ServerTransitionError < ServerError
     @msg = 'Server error: Segment could not be parsed'
   end
-  # generic http 500 server err
-  class ServerError
-    extend  ErrorClass
-    HTTP_CODE = 500
-    @msg = 'Server error'
-  end
+
   # not implemented (Safrano specific)
   class NotImplementedError
     extend  ErrorClass
     HTTP_CODE = 501
   end
-  # batch not implemented (Safrano specific)
-  class BatchNotImplementedError
+
+  # version not implemented (Safrano specific)
+  class VersionNotImplementedError
     extend  ErrorClass
     HTTP_CODE = 501
+    @msg = 'The requested OData version is not yet supported'
+  end
+  # batch not implemented (Safrano specific)
+  class BatchNotImplementedError < NotImplementedError
     @msg = 'Not implemented: OData batch'
   end
 
   # error in filter parsing (Safrano specific)
   class FilterParseError < BadRequestError
     extend  ErrorClass
-    HTTP_CODE = 400
   end
 
   class FilterFunctionNotImplementedError < BadRequestError
     extend  ErrorClass
     include ErrorInstance
     @msg = 'the requested $filter function is Not implemented'
-    HTTP_CODE = 400
-    def initialize(exception)
-      @msg = exception.to_s
+    def initialize(xmsg)
+      @msg = xmsg
     end
   end
-  class FilterInvalidFunctionError < BadRequestError
+  class FilterUnknownFunctionError < BadRequestError
+    include ErrorInstance
+    def initialize(badfuncname)
+      @msg = "Bad request: unknown function #{badfuncname} in $filter"
+    end
+  end
+  class FilterParseErrorWrongColumnName < BadRequestError
+    extend ErrorClass
+    @msg = 'Bad request: invalid property name in $filter'
+  end
+  class FilterParseWrappedError < BadRequestError
     include ErrorInstance
-    HTTP_CODE = 400
     def initialize(exception)
       @msg = exception.to_s
     end
   end
+  class ServiceOperationParameterMissing < BadRequestError
+    include ErrorInstance
+    def initialize(missing:, sopname:)
+      @msg = "Bad request: Parameter(s) missing for for service operation #{sopname} : #{missing.join(', ')}"
+    end
+  end
+
+  class ServiceOperationParameterError < BadRequestError
+    include ErrorInstance
+    def initialize(type:, value:, param:, sopname:)
+      @type = type
+      @value = value
+      @param = param
+      @sopname = sopname
+    end
+
+    def msg
+      "Bad request: Parameter #{@param} with value '#{@value}' cannot be converted to type #{@type} for service operation #{@sopname}"
+    end
+  end
 end

data/lib/odata/expand.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 require 'odata/error.rb'
 
 # all dataset expanding related classes in our OData module
 # ie  do eager loading
-module OData
+module Safrano
   # base class for expanding
   class ExpandBase
     EmptyExpand = new # re-useable empty expanding (idempotent)
     EMPTYH = {}.freeze
 
-    def self.factory(expandstr)
-      expandstr.nil? ? EmptyExpand : MultiExpand.new(expandstr)
+    def self.factory(expandstr, model)
+      expandstr.nil? ? EmptyExpand : MultiExpand.new(expandstr, model)
     end
 
     # output template
     attr_reader :template
 
     def apply_to_dataset(dtcx)
-      dtcx
+      Contract.valid(dtcx)
     end
 
     def empty?
@@ -24,7 +26,7 @@ module OData
     end
 
     def parse_error?
-      false
+      Contract::OK
     end
 
     def template
@@ -60,7 +62,7 @@ module OData
     end
 
     def apply_to_dataset(dtcx)
-      dtcx
+      Contract.valid(dtcx)
     end
 
     def build_arg
@@ -70,11 +72,6 @@ module OData
       @template = DEEPH_1.call(@nodes)
     end
 
-    def parse_error?
-      # todo
-      false
-    end
-
     def empty?
       false
     end
@@ -85,19 +82,22 @@ module OData
     COMASPLIT = /\s*,\s*/.freeze
     attr_reader :template
 
-    def initialize(expandstr)
+    # Note: if you change this method, please also update arity_full_monkey?
+    #       see below
+    def initialize(expandstr, model)
       expandstr.strip!
+      @model = model
       @expandp = expandstr
-      @exlist = []
 
-      @exlist = expandstr.split(COMASPLIT).map { |exstr| Expand.new(exstr) }
+      @exstrlist = expandstr.split(COMASPLIT)
+      @exlist = @exstrlist.map { |exstr| Expand.new(exstr) }
       build_template
     end
 
     def apply_to_dataset(dtcx)
       # use eager loading for each used association
       @exlist.each { |exp| dtcx = dtcx.eager(exp.arg) }
-      dtcx
+      Contract.valid(dtcx)
     end
 
     def build_template
@@ -112,8 +112,11 @@ module OData
     end
 
     def parse_error?
-      # todo
-      false
+      @exstrlist.each do |expstr|
+        return BadRequestExpandInvalidPath.new(@model, expstr) unless @model.expand_path_valid? expstr
+      end
+
+      Contract::OK
     end
 
     def empty?

data/lib/odata/filter/base.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
-module OData
+module Safrano
   module Filter
     # Base class for Leaves, Trees, RootTrees etc
     class Node
+      def success(res)
+        Contract.valid(res)
+      end
     end
 
     # Leaves are Nodes with a parent but no children

data/lib/odata/filter/error.rb

@@ -1,35 +1,31 @@
+# frozen_string_literal: true
+
 require_relative '../error'
 
-module OData
+module Safrano
   class SequelAdapterError < StandardError
     attr_reader :inner
+
     def initialize(err)
       @inner = err
     end
   end
 
-  # exception to OData error bridge
-  module ErrorBridge
-    # return an odata error object wrapping the exception
-    # the odata error object should respond to odata_get for output
-    def odata_error
-      self.class.const_get('ODATA_ERROR_KLASS').new(self)
-    end
-  end
-
   module Filter
-    class FunctionNotImplemented < StandardError
-      ODATA_ERROR_KLASS = OData::FilterFunctionNotImplementedError
-      include ::OData::ErrorBridge
-    end
-
     class Parser
       # Parser errors
-      class Error < StandardError
+
+      class Error
+        def Error.http_code
+          const_get(:HTTP_CODE)
+        end
+        HTTP_CODE = 400
+
         attr_reader :tok
         attr_reader :typ
         attr_reader :cur_val
         attr_reader :cur_typ
+
         def initialize(tok, typ, cur)
           @tok = tok
           @typ = typ
@@ -41,41 +37,61 @@ module OData
       end
       # Invalid Tokens
       class ErrorInvalidToken < Error
+        include ::Safrano::ErrorInstance
+        def initialize(tok, typ, cur)
+          super
+          @msg = "Bad Request: invalid token #{tok} in $filter"
+        end
       end
       # Unmached closed
       class ErrorUnmatchedClose < Error
+        include ::Safrano::ErrorInstance
+        def initialize(tok, typ, cur)
+          super
+          @msg = "Bad Request: unmatched #{tok} in $filter"
+        end
       end
 
-      class ErrorFunctionArgumentType < StandardError
+      class ErrorFunctionArgumentType
+        include ::Safrano::ErrorInstance
       end
 
-      class ErrorWrongColumnName < StandardError
+      class ErrorWrongColumnName
+        include ::Safrano::ErrorInstance
       end
 
       # attempt to add a child to a Leave
-      class ErrorLeaveChild < StandardError
-      end
-
-      # invalid function error (literal attach to IdentityFuncTree)
-      class ErrorInvalidFunction < StandardError
-        ODATA_ERROR_KLASS = OData::FilterInvalidFunctionError
-        include ::OData::ErrorBridge
+      class ErrorLeaveChild
+        include ::Safrano::ErrorInstance
       end
 
       # Invalid function arity
       class ErrorInvalidArity < Error
+        include ::Safrano::ErrorInstance
+        def initialize(tok, typ, cur)
+          super
+          @msg = "Bad Request: wrong number of parameters for function #{cur.parent.value.to_s} in $filter"
+        end
       end
       # Invalid separator in this context (missing parenthesis?)
       class ErrorInvalidSeparator < Error
+        include ::Safrano::ErrorInstance
       end
 
       # unmatched quot3
       class UnmatchedQuoteError < Error
+        include ::Safrano::ErrorInstance
+        def initialize(tok, typ, cur)
+          super
+          @msg = "Bad Request: unbalanced quotes #{tok} in $filter"
+        end
       end
 
       # wrong type of function argument
-      class ErrorInvalidArgumentType < StandardError
-        def initialize(tree, expected:,  actual:)
+      class ErrorInvalidArgumentType < Error
+        include ::Safrano::ErrorInstance
+
+        def initialize(tree, expected:, actual:)
           @tree = tree
           @expected = expected
           @actual = actual