safrano 0.3.2 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '048c3efb69194f00a6ed5593c23300ae7b9d46f7d98a546d443bd5d9c5d2c6c8'
-  data.tar.gz: 825698055233240072faee6e038e531884e23d938fc1ed9708e98d27cf0db3c6
+  metadata.gz: 6397b8b41d6241576f613abfa0e36c8f6973fa96542b60d388b15954aaa3a92b
+  data.tar.gz: 3f36fe0d18bd9659d4e3ce27f501ef1540e82f24a26418c28760aae869de85d9
 SHA512:
-  metadata.gz: d2697db38029b2701a418a620b74e7b8080d368cd34461073de46065d7057cb3b852cc62795cabb1bbbad82d10607bff96b899beb483a3c0f03e028cf8cb8a31
-  data.tar.gz: 12a8674563e67e2f3c4e475d5867f8965e0095a0ff0afea80079f6e7e59c56921abc506d33b07ca483f5f2c16024176a6e3679db26b09e979a9f9fb6fac8d755
+  metadata.gz: f6f666fb8e2fb136fe7ca0c215e19c24648d9a1a4494c3cdb1a53f45561cf827c2670be56bcf74005828b3a9ebf78e2efc63e8b89db35fefb9f70d4c730e7ebb
+  data.tar.gz: 2cdfe6b8cb732184dacb256e5c114361f41da91f5a0f821c2f61a5b7ae541b0aa8f5ad45b23598c0d5301311c193f9f6e51d6e8b8def7eac78a54176f92cfd98

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

data/lib/odata/batch.rb

@@ -1,5 +1,7 @@
-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'
 
 module OData
   # Support for OData multipart $batch Requests
@@ -38,7 +40,7 @@ module OData
       def batch_call(part_req)
         env = batch_env(part_req)
         env['HTTP_HOST'] = @full_req.env['HTTP_HOST']
-
+        began_at = Rack::Utils.clock_time
         @request = OData::Request.new(env)
         @response = OData::Response.new
 
@@ -51,7 +53,16 @@ module OData
         before
         dispatch
 
-        @response.finish
+        status, header, body = @response.finish
+        # Logging of sub-requests with ODataCommonLogger.
+        # A bit hacky but working
+        # 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)
+          # and Rack::BodyProxy.new(body) ?
+        end
+        [status, header, body]
       end
 
       # shamelessely copied from Rack::TEST:Session
@@ -60,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
 
@@ -71,7 +82,10 @@ module OData
         @env = ::Rack::MockRequest.env_for(mime_req.uri,
                                            method: mime_req.http_method,
                                            input: mime_req.content)
+        # Logging of sub-requests
+        @env[Rack::RACK_ERRORS] = @full_req.env[Rack::RACK_ERRORS]
         @env.merge! headers_for_env(mime_req.hd)
+
         @env
       end
     end
@@ -90,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
@@ -112,7 +126,7 @@ module OData
       def odata_post(req)
         @request = req
 
-        if @request.media_type == 'multipart/mixed'
+        if @request.media_type == OData::MP_MIXED
 
           batcha = @request.create_batch_app
           @mult_request = @request.parse_multipart
@@ -124,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,11 +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_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/
@@ -42,25 +45,32 @@ 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
+
+    # 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
 
     attr_accessor :namespace
 
     # dataset
     attr_accessor :cx
 
-    # array of the objects --> dataset.to_a
-    attr_accessor :ax
-
     # url params
     attr_reader :params
 
@@ -75,13 +85,26 @@ module OData
     attr_accessor :deferred_iblock
 
     # convention: entityType is the Ruby Model class --> name is just to_s
+    # Warning: for handling Navigation relations, we use anonymous collection classes
+    # dynamically subtyped from a Model class, and in such an anonymous class
+    # 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
     end
 
-    # convention: default for entity_set_name is the model table name
+    # convention: default for entity_set_name is the type name
     def entity_set_name
-      @entity_set_name = (@entity_set_name || table_name.to_s)
+      @entity_set_name = (@entity_set_name || type_name)
+    end
+
+    def reset
+      # TODO: automatically reset all attributes?
+      @deferred_iblock = nil
+      @entity_set_name = nil
+      @uparms = nil
+      @params = nil
+      @cx = nil
     end
 
     def execute_deferred_iblock
@@ -89,19 +112,36 @@ module OData
     end
 
     # Factory json-> Model Object instance
-    def new_from_hson_h(hash, in_changeset: false)
+    def new_from_hson_h(hash)
       enty = new
-      hash.delete('__metadata')
-      # DONE: move this somewhere else where it's evaluated only once at setup
-      # data_fields = db_schema.map do |col, cattr|
-      #  cattr[:primary_key] ? nil : col
-      # end.select { |col| col }
       enty.set_fields(hash, @data_fields, missing: :skip)
-      # in-changeset requests get their own transaction
-      enty.save(transaction: !in_changeset)
       enty
     end
 
+    CREATE_AND_SAVE_ENTY_AND_REL = lambda do |new_entity, assoc, parent|
+      # in-changeset requests get their own transaction
+      case assoc[:type]
+      when :one_to_many, :one_to_one
+        OData.create_nav_relation(new_entity, assoc, parent)
+        new_entity.save(transaction: false)
+      when :many_to_one
+        new_entity.save(transaction: false)
+        OData.create_nav_relation(new_entity, assoc, parent)
+        parent.save(transaction: false)
+        # else # not supported
+      end
+    end
+    def odata_create_save_entity_and_rel(req, new_entity, assoc, parent)
+      if req.in_changeset
+        # in-changeset requests get their own transaction
+        CREATE_AND_SAVE_ENTY_AND_REL.call(new_entity, assoc, parent)
+      else
+        db.transaction do
+          CREATE_AND_SAVE_ENTY_AND_REL.call(new_entity, assoc, parent)
+        end
+      end
+    end
+
     def odata_get_inlinecount_w_sequel
       return unless (icp = @params['$inlinecount'])
 
@@ -114,10 +154,6 @@ module OData
                      end
     end
 
-    def navigated_coll
-      false
-    end
-
     def attrib_path_valid?(path)
       @attribute_path_list.include? path
     end
@@ -160,9 +196,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
@@ -175,26 +209,25 @@ 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)
       # break circles
-      return [] if nodes.include?(entity_set_name)
+      return EMPTY_ARRAY if nodes.include?(entity_set_name)
 
       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
+      @nav_entity_attribs&.each do |a, k|
+        ret.concat(k.attribute_path_list(nodes).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(nodes).map { |kc| "#{a}/#{kc}" })
       end
       ret
     end
@@ -203,20 +236,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.navigated_coll
+      @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
@@ -227,9 +258,9 @@ module OData
         [200, CT_TEXT, @cx.count.to_s]
       elsif req.accept?(APPJSON)
         if req.walker.do_links
-          [200, CT_JSON, to_odata_links_json(service: req.service)]
+          [200, CT_JSON, [to_odata_links_json(service: req.service)]]
         else
-          [200, CT_JSON, to_odata_json(service: req.service)]
+          [200, CT_JSON, [to_odata_json(service: req.service)]]
         end
       else # TODO: other formats
         406
@@ -250,9 +281,17 @@ module OData
       end
     end
 
+    def odata_post(req)
+      odata_create_entity_and_relation(req, @navattr_reflection, @nav_parent)
+    end
+
     # 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
@@ -268,67 +307,125 @@ 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
+    DJ_OPEN = '{"d":'.freeze
+    DJ_CLOSE = '}'.freeze
     def to_odata_links_json(service:)
-      { 'd' => service.get_coll_odata_links_h(array: get_a,
+      innerj = service.get_coll_odata_links_h(array: get_a,
                                               uribase: @uribase,
-                                              icount: @inlinecount) }.to_json
+                                              icount: @inlinecount).to_json
+      "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
 
-    def to_odata_json(service:)
-      { 'd' => service.get_coll_odata_h(array: get_a,
-                                        expand: @params['$expand'],
-                                        uribase: @uribase,
-                                        icount: @inlinecount) }.to_json
+    #    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
 
-    def get_a
-      @ax.nil? ? @cx.to_a : @ax
-    end
+    # Recursive
+    def output_template_deep(expand_list:, select: OData::SelectBase::ALL)
+      return default_template if expand_list.empty? && select.all_props?
 
-    def odata_post(req)
-      # TODO: this is for v2 only...
-      on_error = (proc { raise Sequel::Rollback } if req.in_changeset)
+      template = {}
+      expand_e = {}
+      expand_c = {}
+      deferr = []
 
-      req.with_parsed_data(on_error: on_error) do |data|
-        data.delete('__metadata')
-        # validate payload column names
-        if (invalid = invalid_hash_data?(data))
-          on_error.call if on_error
-          return [422, {}, ['Invalid attribute name: ', invalid.to_s]]
+      # 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
 
-        if req.accept?(APPJSON)
-
-          new_entity = new_from_hson_h(data, in_changeset: req.in_changeset)
-          req.register_content_id_ref(new_entity)
-          new_entity.copy_request_infos(req)
+        @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
 
-          [201, CT_JSON, new_entity.to_odata_post_json(service: req.service)]
-        else # TODO: other formats
-          415
+      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 to_odata_json(service:)
+      template = output_template(@uparms)
+      innerj = service.get_coll_odata_h(array: get_a,
+                                        template: template,
+                                        uribase: @uribase,
+                                        icount: @inlinecount).to_json
+      "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
+    end
+
+    def get_a
+      @cx.all
     end
 
     # this functionally similar to the Sequel Rels (many_to_one etc)
@@ -340,9 +437,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)
@@ -357,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)
@@ -367,10 +462,30 @@ 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
+      # finalize media handler
+      @media_handler.register(self) if @media_handler
+
+      # build default output template structure
+      @default_template = build_default_template
+
+      # and finally build the path list
+      build_attribute_path_list
+    end
+
     def prepare_pk
       if primary_key.is_a? Array
         @pk_names = []
@@ -419,11 +534,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
@@ -471,6 +582,7 @@ module OData
     end
     include Transitions
   end
+
   # special handling for composite key
   module EntityClassMultiPK
     include EntityClassBase
@@ -483,7 +595,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
@@ -491,7 +603,7 @@ module OData
           error = true
           break
         end
-      }
+      end
       if error
         [false, md]
       else
@@ -508,4 +620,38 @@ module OData
       check_odata_val_type(id, db_schema[primary_key][:type])
     end
   end
+
+  # normal handling for non-media entity
+  module EntityClassNonMedia
+    # POST for non-media entity collection -->
+    # 1. Create and add entity from payload
+    # 2. Create relationship if needed
+    def odata_create_entity_and_relation(req, assoc, parent)
+      # TODO: this is for v2 only...
+      req.with_parsed_data do |data|
+        data.delete('__metadata')
+        # validate payload column names
+        if (invalid = invalid_hash_data?(data))
+          ::OData::Request::ON_CGST_ERROR.call(req)
+          return [422, EMPTY_HASH, ['Invalid attribute name: ', invalid.to_s]]
+        end
+
+        if req.accept?(APPJSON)
+          new_entity = new_from_hson_h(data)
+          if parent
+            odata_create_save_entity_and_rel(req, new_entity, assoc, parent)
+          else
+            # in-changeset requests get their own transaction
+            new_entity.save(transaction: !req.in_changeset)
+          end
+          req.register_content_id_ref(new_entity)
+          new_entity.copy_request_infos(req)
+
+          [201, CT_JSON, new_entity.to_odata_post_json(service: req.service)]
+        else # TODO: other formats
+          415
+        end
+      end
+    end
+  end
 end