safrano 0.4.1 → 0.4.2

data/lib/odata/entity.rb

@@ -11,7 +11,7 @@ module OData
     attr_reader :uribase
 
     include EntityBase::NavigationInfo
-    
+
     # methods related to transitions to next state (cf. walker)
     module Transitions
       def allowed_transitions
@@ -79,7 +79,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
 
@@ -95,31 +94,47 @@ module OData
       "#{uriba}/#{self.class.entity_set_name}(#{pk_uri})"
     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'],
+                                          template: template,
                                           uribase: @uribase).to_json
-      "#{DJopen}#{innerj}#{DJclose}"
+      "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     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,
                                                uribase: @uribase).to_json
-      "#{DJopen}#{innerj}#{DJclose}"
+      "#{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
 
     # needed for proper datetime output
-    # TODO design/performance
-    def casted_values
+    # TODO: design/performance
+    def casted_values(cols = nil)
+      vals = case cols
+             when nil
+               values_for_odata
+             else
+               selected_values_for_odata(cols)
+             end
+
       # 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|
+
+      vals.transform_values! do |v|
         case v
         when Time
           # try to get back the database time zone and value
@@ -127,14 +142,15 @@ module OData
         else
           v
         end
-      }
+      end
     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,
                                         uribase: @uribase).to_json
-      "#{DJopen}#{innerj}#{DJclose}"
+      "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
 
     def type_name
@@ -145,12 +161,12 @@ module OData
       @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)
@@ -163,12 +179,12 @@ module OData
         415
       end
     end
-    
+
     DELETE_REL_AND_ENTY = lambda do |entity, assoc, parent|
-      OData.remove_nav_relation(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
@@ -182,52 +198,48 @@ module OData
       else
         destroy(transaction: false)
       end
-      rescue StandardError => e
-        raise SequelAdapterError.new(e)
+    rescue StandardError => e
+      raise SequelAdapterError.new(e)
     end
-    
+
     # TODO: differentiate between POST/PUT/PATCH/MERGE
     def odata_post(req)
       if req.walker.media_value
         odata_media_value_put(req)
-      else
-        if req.accept?(APPJSON)
-          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
-  
-          [202, {}, to_odata_post_json(service: req.service)]
-        else # TODO: other formats
-          415
+      elsif req.accept?(APPJSON)
+        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
+
+        [202, EMPTY_HASH, to_odata_post_json(service: req.service)]
+      else # TODO: other formats
+        415
       end
     end
 
     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)
+        @uribase = req.uribase
+        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
 
@@ -238,7 +250,7 @@ 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
 
@@ -253,7 +265,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
 
@@ -281,7 +293,7 @@ module OData
         y.each { |enty| yield enty }
       end
 
-      # TODO design... this is not DRY
+      # TODO: design... this is not DRY
       def slug_field
         superclass.slug_field
       end
@@ -294,6 +306,10 @@ module OData
         superclass.media_handler
       end
 
+      def default_template
+        superclass.default_template
+      end
+
       def to_a
         y = @child_method.call
         y.to_a
@@ -321,7 +337,7 @@ module OData
         extend NavigationRedefinitions
       end
     end
-    
+
     # GetRelatedEntity that returns an single related Entity
     # (...to_one relationship )
     def get_related_entity(childattrib)
@@ -335,9 +351,9 @@ module OData
       # allows to receive a POST operation that would actually create the nav attribute entity
 
       ret = method(childattrib.to_sym).call || OData::NilNavigationAttribute.new
-            
+
       ret.set_relation_info(self, childattrib)
-        
+
       ret
     end
   end
@@ -359,7 +375,7 @@ module OData
 
     def odata_delete(req)
       if req.accept?(APPJSON)
-#        delete
+        #        delete
         begin
           odata_delete_relation_and_entity(req, @navattr_reflection, @nav_parent)
           [200, CT_JSON, [{ 'd' => req.service.get_emptycoll_odata_h }.to_json]]
@@ -372,13 +388,13 @@ module OData
     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
 
@@ -396,11 +412,11 @@ module OData
       version = self.class.media_handler.ressource_version(self)
       "#{uri(uribase)}/$value?version=#{version}"
     end
-    
+
     def edit_media(uribase)
       "#{uri(uribase)}/$value"
     end
-    
+
     # directory where to put/find the media files for this entity-type
     def klass_dir
       type_name
@@ -422,9 +438,8 @@ module OData
         # delete the MR
         # delegate to the media handler on collection(ie class) level
         # TODO error handling
-        
-      
-        self.class.media_handler.odata_delete(request: req, entity: self)
+
+        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
@@ -444,7 +459,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)
@@ -454,7 +469,7 @@ module OData
         model.media_handler.replace_file(data: data,
                                          entity: self,
                                          filename: filename)
-        [204, {}, []]
+        ARY_204_EMPTY_HASH_ARY
       end
     end
   end
@@ -469,6 +484,7 @@ module OData
     def media_path_id
       pk.to_s
     end
+
     def media_path_ids
       [pk]
     end
@@ -479,15 +495,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
-      self.pk_hash.values
+      pk_hash.values
     end
   end
 end

data/lib/odata/error.rb

@@ -40,7 +40,7 @@ module OData
       end
     end
   end
-  
+
   # base module for HTTP errors, when used as an Error instance
   module ErrorInstance
     def odata_get(req)
@@ -52,7 +52,7 @@ module OData
       end
     end
   end
-  
+
   # http Bad Req.
   class BadRequestError
     extend  ErrorClass
@@ -76,12 +76,25 @@ module OData
       @msg = err.inner.message
     end
   end
-  
+
   # for Syntax error in Filtering
   class BadRequestFilterParseError < BadRequestError
     HTTP_CODE = 400
-    @msg = 'Bad Request: Syntax error in Filter'
+    @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'
   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

data/lib/odata/expand.rb

@@ -0,0 +1,123 @@
+require 'odata/error.rb'
+
+# all dataset expanding related classes in our OData module
+# ie  do eager loading
+module OData
+  # 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)
+    end
+
+    # output template
+    attr_reader :template
+
+    def apply_to_dataset(dtcx)
+      dtcx
+    end
+
+    def empty?
+      true
+    end
+
+    def parse_error?
+      false
+    end
+
+    def template
+      EMPTYH
+    end
+  end
+
+  # single expand
+  class Expand < ExpandBase
+    # sequel eager arg.
+    attr_reader :arg
+    attr_reader :template
+
+    # used for Sequel eager argument
+    # Recursive array to deep hash
+    # [1,2,3,4]  -->  {1=>{2=>{3=>4}}}
+    # [1] --> 1
+    DEEPH_0 = ->(inp) { inp.size > 1 ? { inp[0] => DEEPH_0.call(inp[1..-1]) } : inp[0] }
+
+    # used for building output template
+    # Recursive array to deep hash
+    # [1,2,3,4]  -->  {1=>{2=>{3=>4}}}
+    # [1] --> { 1 => {} }
+    DEEPH_1 = ->(inp) { inp.size > 1 ? { inp[0] => DEEPH_1.call(inp[1..-1]) } : { inp[0] => {} } }
+
+    NODESEP = '/'.freeze
+
+    def initialize(exstr)
+      exstr.strip!
+      @expandp = exstr
+      @nodes = @expandp.split(NODESEP)
+      build_arg
+    end
+
+    def apply_to_dataset(dtcx)
+      dtcx
+    end
+
+    def build_arg
+      #   'a/b/c/d'  ==> {a: {b:{c: :d}}}
+      #   'xy'  ==> :xy
+      @arg = DEEPH_0.call(@nodes.map(&:to_sym))
+      @template = DEEPH_1.call(@nodes)
+    end
+
+    def parse_error?
+      # todo
+      false
+    end
+
+    def empty?
+      false
+    end
+  end
+
+  # Multi expanding logic
+  class MultiExpand < ExpandBase
+    COMASPLIT = /\s*,\s*/.freeze
+    attr_reader :template
+
+    def initialize(expandstr)
+      expandstr.strip!
+      @expandp = expandstr
+      @exlist = []
+
+      @exlist = expandstr.split(COMASPLIT).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
+    end
+
+    def build_template
+      #   'a/b/c/d,xy'  ==> [ {'a' =>{ 'b' => {'c' => {'d' => {} } }}},
+      #                       { 'xy' => {} }]
+      #
+      @template = @exlist.map(&:template)
+
+      # { 'a'  => { 'b' => {'c' => 'd' }},
+      #   'xy' => {} }
+      @template = @template.inject({}) { |mrg, elmt| mrg.merge elmt }
+    end
+
+    def parse_error?
+      # todo
+      false
+    end
+
+    def empty?
+      false
+    end
+  end
+end