safrano 0.3.3 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b25412d7e053724965ba296bdd43a6f0b3bbd8a62cee2f45a14edf18303ed6c1
-  data.tar.gz: 1e9ad5ce553d13199e4ce79cecf7209ce1bb2695f5c476d8f5e5e16bd57bd4f9
+  metadata.gz: 497482614bfc6a87f8a42b9378a4fc8099ddb5b4f180d747b3717a6952f027b0
+  data.tar.gz: cd5236302671643fd9fbd9bcd200034f305ce7069e5d56ab2db2225dcfb4ce87
 SHA512:
-  metadata.gz: ad1361bb963f77870f784ed5322318b2567bac06e6ef915dcda62f57df767a0893a988672e4ace8dbd64cdda0cbff8d78de2aa712d4ebceb8821ed109018c909
-  data.tar.gz: d4f5f16fa548883e697479f313aa824c0798c38d71ead64172552ddfaec79fb53652063bf6dbfe36362cca5c30a80534665e8a12895fb2f343f1857a0dba8c1c
+  metadata.gz: 4415ca4dc24362f3c179f0cc40f1d73fac6fb7207c0571ef63f1af318fc345e0be8043d8aa1b5ab48e0ead1f5c904dcab07b84061b3ca47f6b7d3c38696d4ae8
+  data.tar.gz: 6646d12aadb3827b43c013a3da6c6223d072e5676f8676eac0db59ad8e3ac80d1a64ceb0f5e87d52bb75e5b556eecda701e2d473c4bdd3b650cb680b6ce19b96

data/lib/odata/attribute.rb

@@ -1,5 +1,5 @@
 require 'json'
-require_relative '../safrano_core.rb'
+require_relative '../safrano/core.rb'
 require_relative './entity.rb'
 
 module OData
@@ -13,15 +13,14 @@ module OData
     end
 
     def value
-      # WARNING; this code is duplicated in entity.rb
-      # (and the inverted transformation is in test/client.rb)
-      # will require a more systematic solution some day
-      # WARNING 2... this require more work to handle the timezones topci
+      # WARNING ... this require more work to handle the timezones topci
       # currently it is just set to make some minimal testcase work
       case (v = @entity.values[@name.to_sym])
       when Time
         # try to get back the database time zone and value
-        (v + v.gmt_offset).utc.to_datetime
+        #        (v + v.gmt_offset).utc.to_datetime
+        v.iso8601
+
       else
         v
       end
@@ -57,9 +56,11 @@ module OData
         [self, :end_with_value]
       end
 
+      ALLOWED_TRANSITIONS = [Safrano::TransitionEnd,
+                             Safrano::TransitionValue].freeze
+
       def allowed_transitions
-        [Safrano::TransitionEnd,
-         Safrano::TransitionValue]
+        ALLOWED_TRANSITIONS
       end
     end
     include Transitions

data/lib/odata/batch.rb

@@ -1,5 +1,5 @@
-require 'rack_app.rb'
-require 'safrano_core.rb'
+require_relative '../safrano/rack_app.rb'
+require_relative '../safrano/core.rb'
 require 'rack/body_proxy'
 require_relative './common_logger.rb'
 
@@ -59,7 +59,7 @@ module OData
         # TODO: test ?
         if (logga = @full_req.env['safrano.logger_mw'])
           logga.batch_log(env, status, header, began_at)
-          # TODO check why/if we need Rack::Utils::HeaderHash.new(header) 
+          # TODO: check why/if we need Rack::Utils::HeaderHash.new(header)
           # and Rack::BodyProxy.new(body) ?
         end
         [status, header, body]
@@ -71,7 +71,7 @@ module OData
 
         headers.each do |name, value|
           env_key = name.upcase.tr('-', '_')
-          env_key = 'HTTP_' + env_key unless env_key == 'CONTENT_TYPE'
+          env_key = "HTTP_#{env_key}" unless env_key == 'CONTENT_TYPE'
           converted_headers[env_key] = value
         end
 
@@ -104,11 +104,11 @@ module OData
     # jaune d'oeuf
     class DisabledHandler < HandlerBase
       def odata_post(_req)
-        [404, {}, '$batch is not enabled ']
+        [404, EMPTY_HASH, '$batch is not enabled ']
       end
 
       def odata_get(_req)
-        [404, {}, '$batch is not enabled ']
+        [404, EMPTY_HASH, '$batch is not enabled ']
       end
     end
     # battre le tout
@@ -138,12 +138,12 @@ module OData
 
           [202, resp_hdrs, @mult_response.body[0]]
         else
-          [415, {}, 'Unsupported Media Type']
+          [415, EMPTY_HASH, 'Unsupported Media Type']
         end
       end
 
       def odata_get(_req)
-        [405, {}, 'You cant GET $batch, POST it ']
+        [405, EMPTY_HASH, 'You cant GET $batch, POST it ']
       end
     end
   end

data/lib/odata/collection.rb

@@ -4,12 +4,14 @@
 
 require 'json'
 require 'rexml/document'
-require 'safrano_core.rb'
-require 'odata/error.rb'
-require 'odata/collection_filter.rb'
-require 'odata/collection_order.rb'
-require 'odata/url_parameters.rb'
-require 'odata/collection_media.rb'
+require_relative '../safrano/core.rb'
+require_relative 'error.rb'
+require_relative 'collection_filter.rb'
+require_relative 'collection_order.rb'
+require_relative 'expand.rb'
+require_relative 'select.rb'
+require_relative 'url_parameters.rb'
+require_relative 'collection_media.rb'
 
 # small helper method
 # http://stackoverflow.com/
@@ -43,16 +45,25 @@ module OData
   # we will add this to our Model classes with "extend" --> self is the Class
   module EntityClassBase
     SINGLE_PK_URL_REGEXP = /\A\(\s*'?([\w\s]+)'?\s*\)(.*)/.freeze
-    ONLY_INTEGER_RGX = /\A[+-]?\d+\z/
+    ONLY_INTEGER_RGX = /\A[+-]?\d+\z/.freeze
 
     attr_reader :nav_collection_url_regexp
     attr_reader :nav_entity_url_regexp
     attr_reader :entity_id_url_regexp
-    attr_reader :attrib_paths_url_regexp
     attr_reader :nav_collection_attribs
     attr_reader :nav_entity_attribs
     attr_reader :data_fields
     attr_reader :inlinecount
+    attr_reader :default_template
+    attr_reader :uri
+    attr_reader :time_cols
+
+    # Sequel associations pointing to this model. Sequel provides association
+    # reflection information on the "from" side. But in some cases
+    # we will need the reverted way
+    # finally not needed and not used yet
+    # attr_accessor :assocs_to
+
     # set to parent entity in case the collection is a nav.collection
     # nil otherwise
     attr_reader :nav_parent
@@ -62,9 +73,6 @@ module OData
     # dataset
     attr_accessor :cx
 
-    # array of the objects --> dataset.to_a
-    attr_accessor :ax
-
     # url params
     attr_reader :params
 
@@ -84,7 +92,11 @@ module OData
     # the class-name is not the OData Type. In these subclass we redefine "type_name"
     # thus when we need the Odata type name, we shall use this method instead of just the collection class name
     def type_name
-      to_s
+      @type_name
+    end
+
+    def build_type_name
+      @type_name = to_s
     end
 
     # convention: default for entity_set_name is the type name
@@ -96,10 +108,15 @@ module OData
       # TODO: automatically reset all attributes?
       @deferred_iblock = nil
       @entity_set_name = nil
+      @uri = nil
       @uparms = nil
       @params = nil
-      @ax = nil
       @cx = nil
+      @@time_cols = nil
+    end
+
+    def build_uri(uribase)
+      @uri = "#{uribase}/#{entity_set_name}"
     end
 
     def execute_deferred_iblock
@@ -123,8 +140,7 @@ module OData
         new_entity.save(transaction: false)
         OData.create_nav_relation(new_entity, assoc, parent)
         parent.save(transaction: false)
-      else
-        # not supported
+        # else # not supported
       end
     end
     def odata_create_save_entity_and_rel(req, new_entity, assoc, parent)
@@ -155,15 +171,7 @@ module OData
     end
 
     def odata_get_apply_params
-      begin
-        @cx = @uparms.apply_to_dataset(@cx)
-      rescue OData::Filter::Parser::ErrorWrongColumnName
-        @error = BadRequestFilterParseError
-        return
-      rescue OData::Filter::Parser::ErrorFunctionArgumentType
-        @error = BadRequestFilterParseError
-        return
-      end
+      @cx = @uparms.apply_to_dataset(@cx)
       odata_get_inlinecount_w_sequel
 
       @cx = @cx.offset(@params['$skip']) if @params['$skip']
@@ -192,9 +200,7 @@ module OData
     def check_u_p_inlinecount
       return unless (icp = @params['$inlinecount'])
 
-      unless (icp == 'allpages') || (icp == 'none')
-        return BadRequestInlineCountParamError
-      end
+      return BadRequestInlineCountParamError unless (icp == 'allpages') || (icp == 'none')
 
       nil
     end
@@ -207,26 +213,27 @@ module OData
       @uparms.check_order
     end
 
+    def check_u_p_expand
+      @uparms.check_expand
+    end
+
     def build_attribute_path_list
       @attribute_path_list = attribute_path_list
-      @attrib_paths_url_regexp = @attribute_path_list.join('|')
     end
 
-    def attribute_path_list(nodes = Set.new)
+    MAX_DEPTH = 6
+    def attribute_path_list(depth = 0)
+      ret = @columns.map(&:to_s)
       # break circles
-      return [] if nodes.include?(entity_set_name)
+      return ret if depth > MAX_DEPTH
 
-      ret = @columns.map(&:to_s)
-      nodes.add entity_set_name
-      if @nav_entity_attribs
-        @nav_entity_attribs.each do |a, k|
-          ret.concat(k.attribute_path_list(nodes).map { |kc| "#{a}/#{kc}" })
-        end
+      depth += 1
+
+      @nav_entity_attribs&.each do |a, k|
+        ret.concat(k.attribute_path_list(depth).map { |kc| "#{a}/#{kc}" })
       end
-      if @nav_collection_attribs
-        @nav_collection_attribs.each do |a, k|
-          ret.concat(k.attribute_path_list(nodes).map { |kc| "#{a}/#{kc}" })
-        end
+      @nav_collection_attribs&.each do |a, k|
+        ret.concat(k.attribute_path_list(depth).map { |kc| "#{a}/#{kc}" })
       end
       ret
     end
@@ -235,20 +242,18 @@ module OData
       return nil unless @params
 
       check_u_p_top || check_u_p_skip || check_u_p_orderby ||
-        check_u_p_filter || check_u_p_inlinecount
+        check_u_p_filter || check_u_p_expand || check_u_p_inlinecount
     end
 
     def initialize_dataset
       @cx = self
-      @ax = nil
       @cx = navigated_dataset if @cx.nav_parent
       @model = if @cx.respond_to? :model
                  @cx.model
                else
                  @cx
                end
-      @jh = @model.join_by_paths_helper
-      @uparms = UrlParameters.new(@jh, @params)
+      @uparms = UrlParameters4Coll.new(@model, @params)
     end
 
     # finally return the requested output according to format, options etc
@@ -268,15 +273,31 @@ module OData
       end
     end
 
+    # validation/error handling methods.
+    # normal processing is done in the passed proc
+
+    def with_validated_get(req)
+      begin
+        initialize_dataset
+        return yield unless (@error = check_url_params)
+      rescue OData::Filter::Parser::ErrorWrongColumnName
+        @error = BadRequestFilterParseError
+      rescue OData::Filter::Parser::ErrorFunctionArgumentType
+        @error = BadRequestFilterParseError
+      rescue OData::Filter::FunctionNotImplemented => e
+        @error = e.odata_error
+      rescue OData::Filter::Parser::ErrorInvalidFunction => e
+        @error = e.odata_error
+      end
+
+      @error.odata_get(req) if @error
+    end
+
     # on model class level we return the collection
     def odata_get(req)
       @params = req.params
-      @uribase = req.uribase
-      initialize_dataset
 
-      if (@error = check_url_params)
-        @error.odata_get(req)
-      else
+      with_validated_get(req) do
         odata_get_apply_params
         odata_get_output(req)
       end
@@ -288,7 +309,11 @@ module OData
 
     # add metadata xml to the passed REXML schema object
     def add_metadata_rexml(schema)
-      enty = schema.add_element('EntityType', 'Name' => to_s)
+      enty = if @media_handler
+               schema.add_element('EntityType', 'Name' => to_s, 'HasStream' => 'true')
+             else
+               schema.add_element('EntityType', 'Name' => to_s)
+             end
       # with their properties
       db_schema.each do |pnam, prop|
         if prop[:primary_key] == true
@@ -304,47 +329,119 @@ module OData
     end
 
     # metadata REXML data  for a single Nav attribute
-    def metadata_nav_rexml_attribs(assoc, cmap, relman, xnamespace)
+    def metadata_nav_rexml_attribs(assoc, to_klass, relman, xnamespace)
       from = type_name
-      to = cmap[assoc.to_s].type_name
+      to = to_klass.type_name
       relman.get_metadata_xml_attribs(from,
                                       to,
-                                      association_reflection(assoc)[:type],
-                                      xnamespace)
+                                      association_reflection(assoc.to_sym)[:type],
+                                      xnamespace,
+                                      assoc)
     end
 
     # and their Nav attributes == Sequel Model association
-    def add_metadata_navs_rexml(schema_enty, cmap, relman, xnamespace)
-      associations.each do |assoc|
-        # associated objects need to be in the map...
-        next unless cmap[assoc.to_s]
-
-        nattrs = metadata_nav_rexml_attribs(assoc, cmap, relman, xnamespace)
+    def add_metadata_navs_rexml(schema_enty, relman, xnamespace)
+      @nav_entity_attribs&.each do |ne, klass|
+        nattr = metadata_nav_rexml_attribs(ne,
+                                           klass,
+                                           relman,
+                                           xnamespace)
+        schema_enty.add_element('NavigationProperty', nattr)
+      end
 
-        schema_enty.add_element('NavigationProperty', nattrs)
+      @nav_collection_attribs&.each do |nc, klass|
+        nattr = metadata_nav_rexml_attribs(nc,
+                                           klass,
+                                           relman,
+                                           xnamespace)
+        schema_enty.add_element('NavigationProperty', nattr)
       end
     end
 
     D = 'd'.freeze
-    DJopen = '{"d":'.freeze
-    DJclose = '}'.freeze
+    DJ_OPEN = '{"d":'.freeze
+    DJ_CLOSE = '}'.freeze
     def to_odata_links_json(service:)
-      innerj = service.get_coll_odata_links_h(array: get_a,
-                                              uribase: @uribase,
+      innerj = service.get_coll_odata_links_h(array: @cx.all,
                                               icount: @inlinecount).to_json
-      "#{DJopen}#{innerj}#{DJclose}"
+      "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
 
-    def to_odata_json(service:)
-      innerj = service.get_coll_odata_h(array: get_a,
-                                        expand: @params['$expand'],
-                                        uribase: @uribase,
-                                        icount: @inlinecount).to_json
-      "#{DJopen}#{innerj}#{DJclose}"
+    #    def output_template(expand: nil, select: nil)
+    def output_template(uparms)
+      #      output_template_deep(expand_list: expand_list, select: select)
+      output_template_deep(expand_list: uparms.expand.template, select: uparms.select)
+    end
+
+    # Recursive
+    def output_template_deep(expand_list:, select: OData::SelectBase::ALL)
+      return default_template if expand_list.empty? && select.all_props?
+
+      template = {}
+      expand_e = {}
+      expand_c = {}
+      deferr = []
+
+      # 1. handle non-navigation properties, only consider $select
+      # 2. handle navigations properties, need to check $select and $expand
+      if select.all_props?
+        template[:all_values] = EMPTYH
+        # include all nav attributes -->
+        @nav_entity_attribs&.each do |attr, klass|
+          if expand_list.key?(attr)
+            expand_e[attr] = klass.output_template_deep(expand_list: expand_list[attr])
+          else
+            deferr << attr
+          end
+        end
+
+        @nav_collection_attribs&.each do |attr, klass|
+          if expand_list.key?(attr)
+            expand_c[attr] = klass.output_template_deep(expand_list: expand_list[attr])
+          else
+            deferr << attr
+          end
+        end
+
+      else
+        template[:selected_vals] = @columns.map(&:to_s) & select.props
+        # include only selected nav attribs-->need additional intersection step
+        if @nav_entity_attribs
+          selected_nav_e = @nav_entity_attribs.keys & select.props
+
+          selected_nav_e&.each do |attr|
+            if expand_list.key?(attr)
+              klass = @nav_entity_attribs[attr]
+              expand_e[attr] = klass.output_template_deep(expand_list: expand_list[attr])
+            else
+              deferr << attr
+            end
+          end
+        end
+        if @nav_collection_attribs
+          selected_nav_c = @nav_collection_attribs.keys & select.props
+          selected_nav_c&.each do |attr|
+            if expand_list.key?(attr)
+              klass = @nav_collection_attribs[attr]
+              expand_c[attr] = klass.output_template_deep(expand_list: expand_list[attr])
+            else
+              deferr << attr
+            end
+          end
+        end
+      end
+      template[:expand_e] = expand_e if expand_e
+      template[:expand_c] = expand_c if expand_c
+      template[:deferr] = deferr if deferr
+      template
     end
 
-    def get_a
-      @ax.nil? ? @cx.to_a : @ax
+    def to_odata_json(service:)
+      template = output_template(@uparms)
+      innerj = service.get_coll_odata_h(array: @cx.all,
+                                        template: template,
+                                        icount: @inlinecount).to_json
+      "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
 
     # this functionally similar to the Sequel Rels (many_to_one etc)
@@ -356,9 +453,8 @@ module OData
       assoc = all_association_reflections.find do |a|
         a[:name] == assoc_symb && a[:model] == self
       end
-      unless assoc
-        raise OData::API::ModelAssociationNameError.new(self, assoc_symb)
-      end
+
+      raise OData::API::ModelAssociationNameError.new(self, assoc_symb) unless assoc
 
       attr_class = assoc[:class_name].constantize
       lattr_name_str = (attr_name_str || assoc_symb.to_s)
@@ -373,9 +469,8 @@ module OData
       assoc = all_association_reflections.find do |a|
         a[:name] == assoc_symb && a[:model] == self
       end
-      unless assoc
-        raise OData::API::ModelAssociationNameError.new(self, assoc_symb)
-      end
+
+      raise OData::API::ModelAssociationNameError.new(self, assoc_symb) unless assoc
 
       attr_class = assoc[:class_name].constantize
       lattr_name_str = (attr_name_str || assoc_symb.to_s)
@@ -383,10 +478,38 @@ module OData
       @nav_entity_url_regexp = @nav_entity_attribs.keys.join('|')
     end
 
+    EMPTYH = {}.freeze
+
+    def build_default_template
+      template = { all_values: EMPTYH }
+      if @nav_entity_attribs || @nav_collection_attribs
+        template[:deferr] = (@nav_entity_attribs&.keys || []) + (@nav_collection_attribs&.keys || EMPTY_ARRAY)
+      end
+      template
+    end
     # old names...
     #    alias_method :add_nav_prop_collection, :addNavCollectionAttrib
     #    alias_method :add_nav_prop_single, :addNavEntityAttrib
 
+    def finalize_publishing
+      build_type_name
+
+      # finalize media handler
+      @media_handler.register(self) if @media_handler
+
+      # build default output template structure
+      @default_template = build_default_template
+
+      # Time columns
+      @time_cols = db_schema.select { |c, v| v[:type] == :datetime }.map { |c, v| c }
+
+      # and finally build the path list and allowed tr's
+      build_attribute_path_list
+
+      build_allowed_transitions
+      build_entity_allowed_transitions
+    end
+
     def prepare_pk
       if primary_key.is_a? Array
         @pk_names = []
@@ -435,11 +558,7 @@ module OData
     def check_odata_val_type(val, type)
       case type
       when :integer
-        if (val =~ ONLY_INTEGER_RGX)
-          [true, Integer(val)]
-        else
-          [false, val]
-        end
+        val =~ ONLY_INTEGER_RGX ? [true, Integer(val)] : [false, val]
       when :string
         [true, val]
       else
@@ -479,10 +598,38 @@ module OData
       end
 
       def allowed_transitions
-        [Safrano::TransitionEnd,
-         Safrano::TransitionCount,
-         Safrano::Transition.new(entity_id_url_regexp,
-                                 trans: 'transition_id')]
+        @allowed_transitions
+      end
+
+      def entity_allowed_transitions
+        @entity_allowed_transitions
+      end
+
+      def build_allowed_transitions
+        @allowed_transitions = [Safrano::TransitionEnd,
+                                Safrano::TransitionCount,
+                                Safrano::Transition.new(entity_id_url_regexp,
+                                                        trans: 'transition_id')].freeze
+      end
+
+      def build_entity_allowed_transitions
+        @entity_allowed_transitions = [
+          Safrano::TransitionEnd,
+          Safrano::TransitionCount,
+          Safrano::TransitionLinks,
+          Safrano::TransitionValue,
+          Safrano::Transition.new(transition_attribute_regexp, trans: 'transition_attribute')
+        ]
+        if (ncurgx = @nav_collection_url_regexp)
+          @entity_allowed_transitions <<
+            Safrano::Transition.new(%r{\A/(#{ncurgx})(.*)\z}, trans: 'transition_nav_collection')
+        end
+        if (neurgx = @nav_entity_url_regexp)
+          @entity_allowed_transitions <<
+            Safrano::Transition.new(%r{\A/(#{neurgx})(.*)\z}, trans: 'transition_nav_entity')
+        end
+        @entity_allowed_transitions.freeze
+        @entity_allowed_transitions
       end
     end
     include Transitions
@@ -500,7 +647,7 @@ module OData
       md.shift # remove first element which is the whole match
       mdc = []
       error = false
-      primary_key.each_with_index { |pk, i|
+      primary_key.each_with_index do |pk, i|
         ck, casted = check_odata_val_type(md[i], db_schema[pk][:type])
         if ck
           mdc << casted
@@ -508,7 +655,7 @@ module OData
           error = true
           break
         end
-      }
+      end
       if error
         [false, md]
       else
@@ -538,7 +685,7 @@ module OData
         # validate payload column names
         if (invalid = invalid_hash_data?(data))
           ::OData::Request::ON_CGST_ERROR.call(req)
-          return [422, {}, ['Invalid attribute name: ', invalid.to_s]]
+          return [422, EMPTY_HASH, ['Invalid attribute name: ', invalid.to_s]]
         end
 
         if req.accept?(APPJSON)