safrano 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6894a03a0224ba8beedc0a05fba7700ad4e06b34d79858478c5e4fe998ed8eef
-  data.tar.gz: '059f1dc5d7d3c4537f279be2b170b5c67b2c61fdbe27199f511e8f1e894776ad'
+  metadata.gz: ffa3b9e1f282380dcdd32162bca490faa4749e05a1db11d65dc2b0c25c5ee76c
+  data.tar.gz: eae063a3541b8eec09bea8d98adf04dc4ad6bed16bdfe6dc3c06fd2df7bb0baf
 SHA512:
-  metadata.gz: d41f73aa8bdd9084eaa150ee06d6c9b05e91ff18dd24f25daae75f25572cf0500c0c5669ade95275b65891655fae4e0e0c53fbb2712e414fe8daf6df91efb8cb
-  data.tar.gz: 11e49d68d0fc005be501f069ab8fcbaad40050449435f4369938b10f1cb90c71cc86b361b4bbaa7541ac7e274ec34de1f6925a1a63d481bcd5bb5690bfb84649
+  metadata.gz: 0c910a0f9677d820f85ae00926b3e7f4f5b29126aa86f5386868d8681e3b9808d44d3f31a6adddac861d98ed1d6969a955691c75262c7a2f892110a4dc948797
+  data.tar.gz: 54b66c00dc7456739457cc58d7a1a68aff8f9a35dccfda3f04b7b83ce12ac7a7e9525d95b7a620cb0e779467e67b26ae3342675477e5c7a49fdb8063bad12183

data/lib/multipart.rb

@@ -24,50 +24,64 @@ module MIME
         @lines << line
       end
 
-      def parse(level: 0)
-        @level = level
-        return unless @lines
+      def parse_first_part(line)
+        if @target.parser.next_part(line)
+          @state = :next_part
+        # this is for when there is only one part
+        # (first part is the last one)
+        elsif @target.parser.last_part(line)
+          @state = :end
+        else
+          @target.parser.addline(line)
+        end
+      end
 
-        @lines.each do |line|
-          case @state
-          when :h
-            if (hmd = /^([\w-]+)\s*:\s*(.*)/.match(line))
-              @target_hd[hmd[1].downcase] = hmd[2].strip
+      def parse_next_part(line)
+        if @target.parser.next_part(line)
 
-            elsif /^#{CRLF}$/ =~ line
-              @target_ct = @target_hd['content-type'] || 'text/plain'
-              @state = new_content
+        elsif @target.parser.last_part(line)
+          @state = :end
+        else
+          @target.parser.addline(line)
+        end
+      end
 
-            end
+      def parse_head(line)
+        if (hmd = /^([\w-]+)\s*:\s*(.*)/.match(line))
+          @target_hd[hmd[1].downcase] = hmd[2].strip
 
-          when :b
-            @target.parser.addline(line)
+        elsif /^#{CRLF}$/ =~ line
+          @target_ct = @target_hd['content-type'] || 'text/plain'
+          @state = new_content
 
-          when :bmp
+        end
+      end
 
-            @state = :first_part if @target.parser.first_part(line)
+      def parse_line(line)
+        case @state
+        when :h
+          parse_head(line)
 
-          when :first_part
-            if @target.parser.next_part(line)
-              @state = :next_part
-            # this is for when there is only one part
-            # (first part is the last one)
-            elsif @target.parser.last_part(line)
-              @state = :end
-            else
-              @target.parser.addline(line)
-            end
+        when :b
+          @target.parser.addline(line)
 
-          when :next_part
+        when :bmp
+          @state = :first_part if @target.parser.first_part(line)
 
-            if @target.parser.next_part(line)
+        when :first_part
+          parse_first_part(line)
 
-            elsif @target.parser.last_part(line)
-              @state = :end
-            else
-              @target.parser.addline(line)
-            end
-          end
+        when :next_part
+          parse_next_part(line)
+        end
+      end
+
+      def parse(level: 0)
+        @level = level
+        return unless @lines
+
+        @lines.each do |line|
+          parse_line(line)
         end
         # Warning: recursive here
         @target.parser.parse(level: level)
@@ -183,6 +197,17 @@ module MIME
             @lines << line
           end
 
+          def parse_head(line)
+            if (hmd = /^([\w-]+)\s*:\s*(.*)/.match(line))
+              @target.hd[hmd[1].downcase] = hmd[2].strip
+            elsif /^#{CRLF}$/ =~ line
+              @state = :b
+            else
+              @target.content << line
+              @state = :b
+            end
+          end
+
           def parse(level: 0)
             return unless @lines
 
@@ -190,14 +215,7 @@ module MIME
             @lines.each do |line|
               case @state
               when :h
-                if (hmd = /^([\w-]+)\s*:\s*(.*)/.match(line))
-                  @target.hd[hmd[1].downcase] = hmd[2].strip
-                elsif /^#{CRLF}$/ =~ line
-                  @state = :b
-                else
-                  @target.content << line
-                  @state = :b
-                end
+                parse_head(line)
               when :b
                 @target.content << line
               end
@@ -361,9 +379,7 @@ module MIME
               end
             end
           else
-            @response.content = @content.map { |part|
-              part.get_response(batcha)
-            }
+            @response.content = @content.map { |prt| prt.get_response(batcha) }
           end
           @response
         end
@@ -448,7 +464,8 @@ module MIME
 
       # For application/http . Content is either a Request or a Response
       class Http < Media
-        HTTP_R_RGX = %r{^(POST|GET|PUT|MERGE|PATCH)\s+(\S*)\s?(HTTP/1\.1)\s*$}.freeze
+        HTTP_MTHS_RGX = 'POST|GET|PUT|MERGE|PATCH'.freeze
+        HTTP_R_RGX = %r{^(#{HTTP_MTHS_RGX})\s+(\S*)\s?(HTTP/1\.1)\s*$}.freeze
         HEADER_RGX = %r{^([a-zA-Z\-]+):\s*([0-9a-zA-Z\-\/,\s]+;?\S*)\s*$}.freeze
         HTTP_RESP_RGX = %r{^HTTP/1\.1\s(\d+)\s}.freeze
 
@@ -465,34 +482,42 @@ module MIME
             @lines << line
           end
 
+          def parse_http(line)
+            if (hmd = /^([\w-]+)\s*:\s*(.*)/.match(line))
+              @target.hd[hmd[1].downcase] = hmd[2].strip
+            elsif (mdht = HTTP_R_RGX.match(line))
+              @state = :hd
+              @target.content = MIME::Content::Application::HttpReq.new
+              @target.content.http_method = mdht[1]
+              @target.content.uri = mdht[2]
+            #  HTTP 1.1 status line  --> HttpResp.new
+            elsif (mdht = HTTP_RESP_RGX.match(line))
+              @state = :hd
+              @target.content = MIME::Content::Application::HttpResp.new
+              @target.content.status = mdht[1]
+            end
+          end
+
+          def parse_head(line)
+            if (hmd = /^([\w-]+)\s*:\s*(.*)/.match(line))
+              @target.content.hd[hmd[1].downcase] = hmd[2].strip
+            elsif /^#{CRLF}$/ =~ line
+              @state = :b
+            else
+              @body_lines << line
+              @state = :b
+            end
+          end
+
           def parse(level: 0)
             return unless @lines
 
             @lines.each do |line|
               case @state
               when :http
-                if (hmd = /^([\w-]+)\s*:\s*(.*)/.match(line))
-                  @target.hd[hmd[1].downcase] = hmd[2].strip
-                elsif (mdht = HTTP_R_RGX.match(line))
-                  @state = :hd
-                  @target.content = MIME::Content::Application::HttpReq.new
-                  @target.content.http_method = mdht[1]
-                  @target.content.uri = mdht[2]
-                #  HTTP 1.1 status line  --> HttpResp.new
-                elsif (mdht = HTTP_RESP_RGX.match(line))
-                  @state = :hd
-                  @target.content = MIME::Content::Application::HttpResp.new
-                  @target.content.status = mdht[1]
-                end
+                parse_http(line)
               when :hd
-                if (hmd = /^([\w-]+)\s*:\s*(.*)/.match(line))
-                  @target.content.hd[hmd[1].downcase] = hmd[2].strip
-                elsif /^#{CRLF}$/ =~ line
-                  @state = :b
-                else
-                  @body_lines << line
-                  @state = :b
-                end
+                parse_head(line)
               when :b
                 @body_lines << line
               end
@@ -538,27 +563,3 @@ module MIME
   end
 end
 
-#    @mimep = MIME::Media::Parser.new
-
-#    @inpstr = File.open('../test/multipart/odata_changeset_1_body.txt','r')
-#    @boundary = 'batch_48f8-3aea-2f04'
-
-#    @inpstr = File.open('../test/multipart/odata_changeset_body.txt','r')
-#    @boundary = 'batch_36522ad7-fc75-4b56-8c71-56071383e77b'
-
-#    @mime = @mimep.hook_multipart('multipart/mixed', @boundary)
-#    @mime = @mimep.parse_str(@inpstr)
-
-#    require 'pry'
-#    binding.pry
-
-#    @inpstr.close
-
-# inp = File.open(ARGV[0], 'r') do |f|
-# f.readlines(CRLF)
-# end
-# x = MIME::Media::Parser.new
-# y = x.parsein(inp)
-# pp y
-# puts '-----------------------------------------------'
-# puts y.unparse

data/lib/odata/attribute.rb

@@ -13,16 +13,25 @@ module OData
     end
 
     def value
-      @entity.values[@name.to_sym]
+      # 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
+      # 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
+      else
+        v
+      end
     end
 
     def odata_get(req)
       if req.walker.raw_value
-        [200, { 'Content-Type' => 'text/plain;charset=utf-8' },
-         value.to_s]
-      elsif req.accept?('application/json')
-        [200, { 'Content-Type' => 'application/json;charset=utf-8' },
-         to_odata_json(service: req.service)]
+        [200, CT_TEXT, value.to_s]
+      elsif req.accept?(APPJSON)
+        [200, CT_JSON, to_odata_json(service: req.service)]
       else # TODO: other formats
         406
       end

data/lib/odata/collection.rb

@@ -8,6 +8,7 @@ require 'safrano_core.rb'
 require 'odata/error.rb'
 require 'odata/collection_filter.rb'
 require 'odata/collection_order.rb'
+require 'odata/url_parameters.rb'
 
 # small helper method
 # http://stackoverflow.com/
@@ -40,6 +41,8 @@ module OData
   # class methods. They Make heavy use of Sequel::Model functionality
   # we will add this to our Model classes with "extend" --> self is the Class
   module EntityClassBase
+    SINGLE_PK_URL_REGEXP = /\A\('?([\w\s]+)'?\)(.*)/.freeze
+
     attr_reader :nav_collection_url_regexp
     attr_reader :nav_entity_url_regexp
     attr_reader :entity_id_url_regexp
@@ -60,6 +63,10 @@ module OData
     # url params
     attr_reader :params
 
+    # url parameters processing object (mostly covert to sequel exprs).
+    # exposed for testing only
+    attr_reader :uparms
+
     # initialising block of code to be executed at end of
     # ServerApp.publish_service after all model classes have been registered
     # (without the associations/relationships)
@@ -94,42 +101,6 @@ module OData
       enty
     end
 
-    def odata_get_apply_filter_w_sequel
-      return unless @params['$filter']
-
-      # Sequel requires a dataset to build some sql expressions, so we
-      # need to pass one todo: use a dummy one ?
-      #      @fi = Filter.new_by_parse(@params['$filter'], @cx)
-      return if @fi.parse_error?
-
-      @cx = @fi.apply_to_dataset(@cx)
-      @right_assocs.merge @fi.assocs
-    end
-
-    def odata_get_apply_order_w_sequel
-      return unless @params['$orderby']
-
-      fo = Order.new_by_parse(@params['$orderby'], @cx)
-      @cx = fo.apply_to_dataset(@cx)
-      @left_assocs.merge fo.assocs
-    end
-
-    def odata_get_do_assoc_joins_w_sequel
-      return if @right_assocs.empty? && @left_assocs.empty?
-
-      # Preparation: ensure that the left and right assocs sets are disjoint
-      # by keeping the duplicates in the left assoc set and removing
-      # them from the right assocs set. We can use Set difference...
-      @right_assocs -= @left_assocs
-
-      # this is for the filtering. Normally we can use inner join
-      @right_assocs.each { |aj| @cx = @cx.association_join(aj) }
-      # this is for the ordering.
-      # we need left join otherwise we could miss records sometimes
-      @left_assocs.each { |aj| @cx = @cx.association_left_join(aj) }
-      @cx = @cx.select_all(entity_set_name.to_sym)
-    end
-
     def odata_get_inlinecount_w_sequel
       return unless (icp = @params['$inlinecount'])
 
@@ -142,25 +113,29 @@ module OData
                      end
     end
 
-    def odata_get_apply_params_w_sequel
-      @left_assocs = Set.new
-      @right_assocs = Set.new
-      odata_get_apply_filter_w_sequel
-      odata_get_apply_order_w_sequel
-      odata_get_do_assoc_joins_w_sequel
-      odata_get_inlinecount_w_sequel
-
-      @cx = @cx.offset(@params['$skip']) if @params['$skip']
-      @cx = @cx.limit(@params['$top']) if @params['$top']
-      @cx
-    end
-
     def navigated_coll
       false
     end
 
+    def attrib_path_valid?(path)
+      @attribute_path_list.include? path
+    end
+
     def odata_get_apply_params
-      odata_get_apply_params_w_sequel
+      begin
+        @cx = @uparms.apply_to_dataset(@cx)
+      rescue OData::Filter::Parser::ErrorWrongColumnName
+        @error = BadRequestFilterParseError
+        return
+      rescue OData::Filter::Parser::ErrorFunctionArgumentType
+        @error = BadRequestFilterParseError
+        return
+      end
+      odata_get_inlinecount_w_sequel
+
+      @cx = @cx.offset(@params['$skip']) if @params['$skip']
+      @cx = @cx.limit(@params['$top']) if @params['$top']
+      @cx
     end
 
     # url params validation methods.
@@ -192,33 +167,11 @@ module OData
     end
 
     def check_u_p_filter
-      return unless @params['$filter']
-
-      # Sequel requires a dataset to build some sql expressions, so we
-      # need to pass one todo: use a dummy one ?
-      @fi = Filter.new_by_parse(@params['$filter'], @cx)
-      return BadRequestFilterParseError if @fi.parse_error?
-
-      # nil is the expected return for no errors
-      nil
+      @uparms.check_filter
     end
 
     def check_u_p_orderby
-      # TODO: this should be moved into OData::Order somehow,
-      # at least partly
-      return unless @params['$orderby']
-
-      pordlist = @params['$orderby'].dup
-      pordlist.split(',').each do |pord|
-        pord.strip!
-        qualfn, dir = pord.split(/\s/)
-        qualfn.strip!
-        dir.strip! if dir
-        return BadRequestError unless @attribute_path_list.include? qualfn
-        return BadRequestError unless [nil, 'asc', 'desc'].include? dir
-      end
-      # nil is the expected return for no errors
-      nil
+      @uparms.check_order
     end
 
     def build_attribute_path_list
@@ -248,14 +201,38 @@ module OData
     def check_url_params
       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_top || check_u_p_skip || check_u_p_orderby ||
+        check_u_p_filter || check_u_p_inlinecount
     end
 
     def initialize_dataset
-      # initialize dataset
       @cx = self
       @ax = nil
       @cx = navigated_dataset if @cx.navigated_coll
+      @model = if @cx.respond_to? :model
+                 @cx.model
+               else
+                 @cx
+               end
+      @jh = @model.join_by_paths_helper
+      @uparms = UrlParameters.new(@jh, @params)
+    end
+
+    # finally return the requested output according to format, options etc
+    def odata_get_output(req)
+      return @error.odata_get(req) if @error
+
+      if req.walker.do_count
+        [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)]
+        else
+          [200, CT_JSON, to_odata_json(service: req.service)]
+        end
+      else # TODO: other formats
+        406
+      end
     end
 
     # on model class level we return the collection
@@ -264,24 +241,50 @@ module OData
       @uribase = req.uribase
       initialize_dataset
 
-      if (perr = check_url_params)
-        perr.odata_get(req)
+      if (@error = check_url_params)
+        @error.odata_get(req)
       else
         odata_get_apply_params
-        if req.walker.do_count
-          [200, { 'Content-Type' => 'text/plain;charset=utf-8' },
-           @cx.count.to_s]
-        elsif req.accept?('application/json')
-          if req.walker.do_links
-            [200, { 'Content-Type' => 'application/json;charset=utf-8' },
-             to_odata_links_json(service: req.service)]
-          else
-            [200, { 'Content-Type' => 'application/json;charset=utf-8' },
-             to_odata_json(service: req.service)]
-          end
-        else # TODO: other formats
-          406
+        odata_get_output(req)
+      end
+    end
+
+    # add metadata xml to the passed REXML schema object
+    def add_metadata_rexml(schema)
+      enty = schema.add_element('EntityType', 'Name' => to_s)
+      # with their properties
+      db_schema.each do |pnam, prop|
+        if prop[:primary_key] == true
+          enty.add_element('Key').add_element('PropertyRef',
+                                              'Name' => pnam.to_s)
         end
+        attrs = { 'Name' => pnam.to_s,
+                  'Type' => OData.get_edm_type(db_type: prop[:db_type]) }
+        attrs['Nullable'] = 'false' if prop[:allow_null] == false
+        enty.add_element('Property', attrs)
+      end
+      enty
+    end
+
+    # metadata REXML data  for a single Nav attribute
+    def metadata_nav_rexml_attribs(assoc, cmap, relman, xnamespace)
+      from = type_name
+      to = cmap[assoc.to_s].type_name
+      relman.get_metadata_xml_attribs(from,
+                                      to,
+                                      association_reflection(assoc)[:type],
+                                      xnamespace)
+    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)
+
+        schema_enty.add_element('NavigationProperty', nattrs)
       end
     end
 
@@ -313,15 +316,13 @@ module OData
           return [422, {}, ['Invalid attribute name: ', invalid.to_s]]
         end
 
-        if req.accept?('application/json')
+        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)
 
-          [201,
-           { 'Content-Type' => 'application/json;charset=utf-8' },
-           new_entity.to_odata_post_json(service: req.service)]
+          [201, CT_JSON, new_entity.to_odata_post_json(service: req.service)]
         else # TODO: other formats
           415
         end
@@ -382,7 +383,7 @@ module OData
         @entity_id_url_regexp = /\A\(\s*(#{iuk.join(',\s*')})\s*\)(.*)/
       else
         @pk_names = [primary_key.to_s]
-        @entity_id_url_regexp = /\A\('?([\w\s]+)'?\)(.*)/
+        @entity_id_url_regexp = SINGLE_PK_URL_REGEXP
       end
     end
 
@@ -396,12 +397,12 @@ module OData
       data.keys.map(&:to_sym).find { |ksym| !(@columns.include? ksym) }
     end
 
-    # A regexp matching all allowed attributes of the Entity
-    # (eg ID|name|size etc... )
-    def attribute_url_regexp
+    ## A regexp matching all allowed attributes of the Entity
+    ## (eg ID|name|size etc... ) at start position and returning the rest
+    def transition_attribute_regexp
       #      db_schema.map { |sch| sch[0] }.join('|')
       # @columns is from Sequel Model
-      @columns.join('|')
+      %r{\A/(#{@columns.join('|')})(.*)\z}
     end
 
     # methods related to transitions to next state (cf. walker)
@@ -416,7 +417,7 @@ module OData
 
       def transition_id(match_result)
         if (id = match_result[1])
-          if (y = find(id))
+          if (y = find_by_odata_key(id))
             [y, :run]
           else
             [nil, :error, ErrorNotFound]
@@ -439,12 +440,14 @@ module OData
   module EntityClassMultiPK
     include EntityClassBase
     # id is for composite key, something like      fx='aas',fy_w='0001'
-    def find(mid)
-      # Note: @iuk_rgx is (needs to be) built on start with
+    def find_by_odata_key(mid)
+      # @iuk_rgx is (needs to be) built on start with
       # collklass.prepare_pk
       md = @iuk_rgx.match(mid).to_a
       md.shift # remove first element which is the whole match
-      self[*md] # Sequel Model rulez
+      # amazingly this works as expected from an Entity.get_related(...) anonymous class
+      # without need to redefine primary_key_lookup (returns nil for valid but unrelated keys)
+      primary_key_lookup(md)
     end
   end
 
@@ -452,8 +455,8 @@ module OData
   module EntityClassSinglePK
     include EntityClassBase
     # id is really just the  value of single pk
-    def find(id)
-      self[id]
+    def find_by_odata_key(id)
+      primary_key_lookup(id)
     end
   end
 end