safrano 0.3.3 → 0.4.3

data/lib/odata/entity.rb

@@ -2,36 +2,19 @@ require 'json'
 require 'rexml/document'
 require 'safrano.rb'
 require 'odata/collection.rb' # required for  self.class.entity_type_name ??
+require_relative 'navigation_attribute'
 
 module OData
   # this will be mixed in the  Model classes (subclasses of Sequel Model)
   module EntityBase
     attr_reader :params
-    attr_reader :uribase
+
+    include EntityBase::NavigationInfo
 
     # methods related to transitions to next state (cf. walker)
     module Transitions
       def allowed_transitions
-        alltr = [
-          Safrano::TransitionEnd,
-          Safrano::TransitionCount,
-          Safrano::TransitionLinks,
-          Safrano::TransitionValue,
-          Safrano::Transition.new(self.class.transition_attribute_regexp,
-                                  trans: 'transition_attribute')
-        ]
-        if (ncurgx = self.class.nav_collection_url_regexp)
-          alltr <<
-            Safrano::Transition.new(%r{\A/(#{ncurgx})(.*)\z},
-                                    trans: 'transition_nav_collection')
-
-        end
-        if (neurgx = self.class.nav_entity_url_regexp)
-          alltr <<
-            Safrano::Transition.new(%r{\A/(#{neurgx})(.*)\z},
-                                    trans: 'transition_nav_entity')
-        end
-        alltr
+        self.class.entity_allowed_transitions
       end
 
       def transition_end(_match_result)
@@ -76,7 +59,6 @@ module OData
       self.class.nav_entity_attribs&.each_key do |na_str|
         @nav_values[na_str.to_sym] = send(na_str)
       end
-
       @nav_values
     end
 
@@ -88,43 +70,41 @@ module OData
       @nav_coll
     end
 
-    def uri(uriba)
-      "#{uriba}/#{self.class.entity_set_name}(#{pk_uri})"
+    def uri
+      @odata_pk ||= "(#{pk_uri})"
+      "#{self.class.uri}#{@odata_pk}"
     end
+
     D = 'd'.freeze
-    DJopen = '{"d":'.freeze
-    DJclose = '}'.freeze
+    DJ_OPEN = '{"d":'.freeze
+    DJ_CLOSE = '}'.freeze
+
     # Json formatter for a single entity (probably OData V1/V2 like)
     def to_odata_json(service:)
+      template = self.class.output_template(@uparms)
       innerj = service.get_entity_odata_h(entity: self,
-                                          expand: @params['$expand'],
-                                          #     links: @do_links,
-                                          uribase: @uribase).to_json
-      "#{DJopen}#{innerj}#{DJclose}"
+                                          template: template).to_json
+      "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
 
-    # needed for proper datetime output
-    # TODO design/performance
-    def casted_values
-      # WARNING; this code is duplicated in attribute.rb
-      # (and the inverted transformation is in test/client.rb)
-      # will require a more systematic solution some day
-      values_for_odata.transform_values! { |v|
-        case v
-        when Time
-          # try to get back the database time zone and value
-          (v + v.gmt_offset).utc.to_datetime
-        else
-          v
-        end
-      }
+    # Json formatter for a single entity reached by navigation $links
+    def to_odata_onelink_json(service:)
+      innerj = service.get_entity_odata_link_h(entity: self).to_json
+      "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
+    end
+
+    def selected_values_for_odata(cols)
+      allvals = values_for_odata
+      selvals = {}
+      cols.map(&:to_sym).each { |k| selvals[k] = allvals[k] if allvals.key?(k) }
+      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],
-                                        uribase: @uribase).to_json
-      "#{DJopen}#{innerj}#{DJclose}"
+                                        template: self.class.default_template).to_json
+      "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
 
     def type_name
@@ -133,38 +113,53 @@ module OData
 
     def copy_request_infos(req)
       @params = req.params
-      @uribase = req.uribase
       @do_links = req.walker.do_links
+      @uparms = UrlParameters4Single.new(@params)
     end
 
     # Finally Process REST verbs...
     def odata_get(req)
       copy_request_infos(req)
-
       if req.walker.media_value
         odata_media_value_get(req)
       elsif req.accept?(APPJSON)
-        [200, CT_JSON, [to_odata_json(service: req.service)]]
+        if req.walker.do_links
+          [200, CT_JSON, [to_odata_onelink_json(service: req.service)]]
+        else
+          [200, CT_JSON, [to_odata_json(service: req.service)]]
+        end
       else # TODO: other formats
         415
       end
     end
 
-    def odata_delete(req)
-      if req.accept?(APPJSON)
-        delete
-        [200, CT_JSON, [{ 'd' => req.service.get_emptycoll_odata_h }.to_json]]
-      else # TODO: other formats
-        415
+    DELETE_REL_AND_ENTY = lambda do |entity, assoc, parent|
+      OData.remove_nav_relation(assoc, parent)
+      entity.destroy(transaction: false)
+    end
+
+    def odata_delete_relation_and_entity(req, assoc, parent)
+      if parent
+        if req.in_changeset
+          # in-changeset requests get their own transaction
+          DELETE_REL_AND_ENTY.call(self, assoc, parent)
+        else
+          db.transaction do
+            DELETE_REL_AND_ENTY.call(self, assoc, parent)
+          end
+        end
+      else
+        destroy(transaction: false)
       end
+    rescue StandardError => e
+      raise SequelAdapterError.new(e)
     end
 
     # TODO: differentiate between POST/PUT/PATCH/MERGE
     def odata_post(req)
-      data = JSON.parse(req.body.read)
-      @uribase = req.uribase
-
-      if req.accept?(APPJSON)
+      if req.walker.media_value
+        odata_media_value_put(req)
+      elsif req.accept?(APPJSON)
         data.delete('__metadata')
 
         if req.in_changeset
@@ -174,7 +169,7 @@ module OData
           update_fields(data, self.class.data_fields, missing: :skip)
         end
 
-        [202, {}, to_odata_post_json(service: req.service)]
+        [202, EMPTY_HASH, to_odata_post_json(service: req.service)]
       else # TODO: other formats
         415
       end
@@ -183,23 +178,20 @@ module OData
     def odata_put(req)
       if req.walker.media_value
         odata_media_value_put(req)
-      else
-        if req.accept?(APPJSON)
-          data = JSON.parse(req.body.read)
-          @uribase = req.uribase
-          data.delete('__metadata')
-
-          if req.in_changeset
-            set_fields(data, self.class.data_fields, missing: :skip)
-            save(transaction: false)
-          else
-            update_fields(data, self.class.data_fields, missing: :skip)
-          end
+      elsif req.accept?(APPJSON)
+        data = JSON.parse(req.body.read)
+        data.delete('__metadata')
 
-          [204, {}, []]
-        else # TODO: other formats
-          415
+        if req.in_changeset
+          set_fields(data, self.class.data_fields, missing: :skip)
+          save(transaction: false)
+        else
+          update_fields(data, self.class.data_fields, missing: :skip)
         end
+
+        ARY_204_EMPTY_HASH_ARY
+      else # TODO: other formats
+        415
       end
     end
 
@@ -210,13 +202,11 @@ module OData
         # validate payload column names
         if (invalid = self.class.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
         # TODO: check values/types
 
         my_data_fields = self.class.data_fields
-        @uribase = req.uribase
-        #      if req.accept?('application/json')
 
         if req.in_changeset
           set_fields(data, my_data_fields, missing: :skip)
@@ -225,7 +215,7 @@ module OData
           update_fields(data, my_data_fields, missing: :skip)
         end
         # patch should return 204 + no content
-        [204, {}, []]
+        ARY_204_EMPTY_HASH_ARY
       end
     end
 
@@ -253,14 +243,39 @@ module OData
         y.each { |enty| yield enty }
       end
 
+      # TODO: design... this is not DRY
+      def slug_field
+        superclass.slug_field
+      end
+
       def type_name
         superclass.type_name
       end
 
+      def time_cols
+        superclass.time_cols
+      end
+
       def media_handler
         superclass.media_handler
       end
 
+      def uri
+        superclass.uri
+      end
+
+      def default_template
+        superclass.default_template
+      end
+
+      def allowed_transitions
+        superclass.allowed_transitions
+      end
+
+      def entity_allowed_transitions
+        superclass.entity_allowed_transitions
+      end
+
       def to_a
         y = @child_method.call
         y.to_a
@@ -301,8 +316,9 @@ module OData
       # then we return a Nil... wrapper object. This object then
       # allows to receive a POST operation that would actually create the nav attribute entity
 
-      ret = method(childattrib.to_sym).call ||
-            OData::NilNavigationAttribute.new(self, childattrib)
+      ret = method(childattrib.to_sym).call || OData::NilNavigationAttribute.new
+
+      ret.set_relation_info(self, childattrib)
 
       ret
     end
@@ -314,38 +330,87 @@ module OData
 
   module NonMediaEntity
     # non media entity metadata for json h
-    def metadata_h(uribase:)
-      {   uri: uri(uribase),
+    def metadata_h
+      {   uri: uri,
           type: type_name }
     end
 
     def values_for_odata
-      values.dup
+      values
+    end
+
+    def odata_delete(req)
+      if req.accept?(APPJSON)
+        #        delete
+        begin
+          odata_delete_relation_and_entity(req, @navattr_reflection, @nav_parent)
+          [200, CT_JSON, [{ 'd' => req.service.get_emptycoll_odata_h }.to_json]]
+        rescue SequelAdapterError => e
+          BadRequestSequelAdapterError.new(e).odata_get(req)
+        end
+      else # TODO: other formats
+        415
+      end
     end
 
     # in case of a non media entity, we have to return an error on $value request
-    def odata_media_value_get(req)
-      return BadRequestNonMediaValue.odata_get
+    def odata_media_value_get(_req)
+      BadRequestNonMediaValue.odata_get
     end
 
     # in case of a non media entity, we have to return an error on $value PUT
-    def odata_media_value_put(req)
-      return BadRequestNonMediaValue.odata_get
+    def odata_media_value_put(_req)
+      BadRequestNonMediaValue.odata_get
+    end
+  end
+
+  module MappingBeforeOutput
+    # needed for proper datetime output
+    def casted_values(cols = nil)
+      vals = case cols
+             when nil
+               # we need to dup the model values as we need to change it before passing to_json,
+               # but we dont want to interfere with Sequel's owned data
+               # (eg because then in worst case it could happen that we write back changed values to DB)
+               values_for_odata.dup
+             else
+               selected_values_for_odata(cols)
+        end
+      self.class.time_cols.each { |tc| vals[tc] = vals[tc]&.iso8601 if vals.key?(tc) }
+      vals
+    end
+  end
+  module NoMappingBeforeOutput
+    # current model does not have eg. Time fields--> no special mapping, just to_json is fine
+    # --> we can use directly the model.values (values_for_odata) withoud dup'ing it as we dont
+    # need to change it, just output as is
+    def casted_values(cols = nil)
+      case cols
+      when nil
+        values_for_odata
+      else
+        selected_values_for_odata(cols)
+        end
     end
   end
 
   module MediaEntity
     # media entity metadata for json h
-    def metadata_h(uribase:)
-      {   uri: uri(uribase),
+    def metadata_h
+      {   uri: uri,
           type: type_name,
-          media_src: media_src(uribase),
-          edit_media: media_src(uribase),
+          media_src: media_src,
+          edit_media: edit_media,
           content_type: @values[:content_type] }
     end
 
-    def media_src(urbase)
-      "#{uri(urbase)}/$value"
+    def media_src
+      version = self.class.media_handler.ressource_version(self)
+      "#{uri}/$value?version=#{version}"
+    end
+
+    def edit_media
+      "#{uri}/$value"
     end
 
     # directory where to put/find the media files for this entity-type
@@ -364,6 +429,22 @@ module OData
       ret
     end
 
+    def odata_delete(req)
+      if req.accept?(APPJSON)
+        # delete the MR
+        # delegate to the media handler on collection(ie class) level
+        # TODO error handling
+
+        self.class.media_handler.odata_delete(entity: self)
+        # delete the relation(s)  to parent(s) (if any) and then entity
+        odata_delete_relation_and_entity(req, @navattr_reflection, @nav_parent)
+        # result
+        [200, CT_JSON, [{ 'd' => req.service.get_emptycoll_odata_h }.to_json]]
+      else # TODO: other formats
+        415
+      end
+    end
+
     # real implementation for returning $value for a media entity
     def odata_media_value_get(req)
       # delegate to the media handler on collection(ie class) level
@@ -374,7 +455,7 @@ module OData
     def odata_media_value_put(req)
       model = self.class
       req.with_media_data do |data, mimetype, filename|
-        emdata = { :content_type => mimetype }
+        emdata = { content_type: mimetype }
         if req.in_changeset
           set_fields(emdata, model.data_fields, missing: :skip)
           save(transaction: false)
@@ -384,7 +465,7 @@ module OData
         model.media_handler.replace_file(data: data,
                                          entity: self,
                                          filename: filename)
-        [204, {}, []]
+        ARY_204_EMPTY_HASH_ARY
       end
     end
   end
@@ -399,6 +480,10 @@ module OData
     def media_path_id
       pk.to_s
     end
+
+    def media_path_ids
+      [pk]
+    end
   end
 
   # for multiple key
@@ -406,11 +491,15 @@ module OData
     include Entity
     def pk_uri
       # pk_hash is provided by Sequel
-      self.pk_hash.map { |k, v| "#{k}='#{v}'" }.join(',')
+      pk_hash.map { |k, v| "#{k}='#{v}'" }.join(COMMA)
     end
 
     def media_path_id
-      self.pk_hash.values.join('_')
+      pk_hash.values.join(SPACE)
+    end
+
+    def media_path_ids
+      pk_hash.values
     end
   end
 end