safrano 0.3.2 → 0.4.2

data/lib/odata/relations.rb

@@ -85,7 +85,7 @@ module OData
       end
     end
 
-    def get_metadata_xml_attribs(from, to, assoc_type, xnamespace)
+    def get_metadata_xml_attribs(from, to, assoc_type, xnamespace, attrname)
       rel = get([from, to])
       # use Sequel reflection to get multiplicity (will be used later
       # in 2. Associations below)
@@ -107,7 +107,7 @@ module OData
       # <NavigationProperty Name="Supplier"
       # Relationship="ODataDemo.Product_Supplier_Supplier_Products"
       #         FromRole="Product_Supplier" ToRole="Supplier_Products"/>
-      { 'Name' => to, 'Relationship' => "#{xnamespace}.#{rel.name}",
+      { 'Name' => attrname, 'Relationship' => "#{xnamespace}.#{rel.name}",
         'FromRole' => from, 'ToRole' => to }
     end
   end

data/lib/odata/select.rb

@@ -0,0 +1,42 @@
+require 'odata/error.rb'
+
+# all dataset selecting related classes in our OData module
+# ie  do eager loading
+module OData
+  # base class for selecting. We have to distinguish between
+  # fields of the current entity, and the navigation properties
+  # we can have one special case
+  #  empty, ie no $select specified --> return all fields and all nav props
+  #            ==> SelectAll
+
+  class SelectBase
+    ALL = new # re-useable selecting-all handler
+
+    def self.factory(selectstr)
+      case selectstr&.strip
+      when nil, '', '*'
+        ALL
+      else
+        Select.new(selectstr)
+      end
+    end
+
+    def all_props?
+      false
+    end
+
+    def ALL.all_props?
+      true
+    end
+  end
+
+  # single select
+  class Select < SelectBase
+    COMASPLIT = /\s*,\s*/.freeze
+    attr_reader :props
+    def initialize(selstr)
+      @selectp = selstr.strip
+      @props = @selectp.split(COMASPLIT)
+    end
+  end
+end

data/lib/odata/url_parameters.rb

@@ -3,57 +3,72 @@ require 'odata/error.rb'
 # url parameters processing . Mostly delegates to specialised classes
 # (filter, order...) to convert into Sequel exprs.
 module OData
-  class UrlParameters
+  class UrlParametersBase
+    attr_reader :expand
+    attr_reader :select
+
+    def check_expand
+      return BadRequestExpandParseError if @expand.parse_error?
+    end
+  end
+
+  # url parameters for a single entity expand/select
+  class UrlParameters4Single < UrlParametersBase
+    def initialize(params)
+      @params = params
+      @expand = ExpandBase.factory(@params['$expand'])
+      @select = SelectBase.factory(@params['$select'])
+    end
+  end
+
+  # url parameters for a collection expand/select + filter/order
+  class UrlParameters4Coll < UrlParametersBase
     attr_reader :filt
     attr_reader :ordby
-    def initialize(jh, params)
-      @jh = jh
+
+    def initialize(model, params)
+      # join helper is only needed for odering or filtering
+      @jh = model.join_by_paths_helper if params['$orderby'] || params['$filter']
       @params = params
+      @ordby = OrderBase.factory(@params['$orderby'], @jh)
+      @filt = FilterBase.factory(@params['$filter'])
+      @expand = ExpandBase.factory(@params['$expand'])
+      @select = SelectBase.factory(@params['$select'])
     end
 
     def check_filter
-      return unless @params['$filter']
-
-      @filt = FilterByParse.new(@params['$filter'], @jh)
       return BadRequestFilterParseError if @filt.parse_error?
-
-      # nil is the expected return for no errors
-      nil
     end
 
     def check_order
-      return unless @params['$orderby']
+      return BadRequestOrderParseError if @ordby.parse_error?
+    end
 
-      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 @jh.start_model.attrib_path_valid? qualfn
-        return BadRequestError unless [nil, 'asc', 'desc'].include? dir
-      end
+    def apply_to_dataset(dtcx)
+      dtcx = apply_expand_to_dataset(dtcx)
+      apply_filter_order_to_dataset(dtcx)
+    end
 
-      @ordby = Order.new_by_parse(@params['$orderby'], @jh)
+    def apply_expand_to_dataset(dtcx)
+      return dtcx if @expand.empty?
 
-      # nil is the expected return for no errors
-      nil
+      @expand.apply_to_dataset(dtcx)
     end
 
-    def apply_to_dataset(dtcx)
-      return dtcx if (@filt.nil? && @ordby.nil?)
-
-      if @filt.nil?
-        dtcx = @jh.dataset.select_all(@jh.start_model.table_name)
-
-        @ordby.apply_to_dataset(dtcx)
-      elsif @ordby.nil?
-        @filt.apply_to_dataset(dtcx)
-      else
-        filtexpr = @filt.sequel_expr
-        dtcx = @jh.dataset(dtcx).where(filtexpr).select_all(@jh.start_model.table_name)
-        @ordby.apply_to_dataset(dtcx)
-      end
+    # Warning, the @ordby and @filt objects are coupled by way of the join helper
+    def apply_filter_order_to_dataset(dtcx)
+      return dtcx if @filt.empty? && @ordby.empty?
+
+      # filter object and join-helper need to be finalized after filter has been parsed and checked
+      @filt.finalize(@jh)
+
+      # start with the join
+      dtcx = @jh.dataset(dtcx)
+
+      dtcx = @filt.apply_to_dataset(dtcx)
+      dtcx = @ordby.apply_to_dataset(dtcx)
+
+      dtcx.select_all(@jh.start_model.table_name)
     end
   end
 end

data/lib/odata/walker.rb

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 require 'json'
 require 'rexml/document'
 require 'safrano.rb'
@@ -21,9 +19,12 @@ module OData
     # is $count requested?
     attr_accessor :do_count
 
-    # is $value requested?
+    # is $value (of attribute) requested?
     attr_reader :raw_value
 
+    # is $value (of media entity) requested?
+    attr_reader :media_value
+
     # are $links requested ?
     attr_reader :do_links
 
@@ -35,9 +36,11 @@ module OData
       @content_id_refs = content_id_refs
 
       @contexts = [@context]
+
       @path_start = @path_remain = if service
                                      unprefixed(service.xpath_prefix, path)
                                    else # This is for batch function
+
                                      path
                                    end
       @path_done = ''
@@ -51,7 +54,9 @@ module OData
       if (prefix == '') || (prefix == '/')
         path
       else
-        path.sub!(/\A#{prefix}/, '')
+        #        path.sub!(/\A#{prefix}/, '')
+        # TODO check
+        path.sub(/\A#{prefix}/, '')
       end
     end
 
@@ -107,6 +112,9 @@ module OData
       when :end_with_value
         @raw_value = true
         @status = :end
+      when :end_with_media_value
+        @media_value = true
+        @status = :end
       when :run_with_links
         @do_links = true
         @status = :run

data/lib/safrano.rb

@@ -1,18 +1,18 @@
-#!/usr/bin/env ruby
-
 require 'json'
 require 'rexml/document'
-require_relative './multipart.rb'
-require 'safrano_core.rb'
-require 'odata/entity.rb'
-require 'odata/attribute.rb'
-require 'odata/collection.rb'
-require 'service.rb'
-require 'odata/walker.rb'
+require_relative 'safrano/multipart.rb'
+require_relative 'safrano/core.rb'
+require_relative 'odata/entity.rb'
+require_relative 'odata/attribute.rb'
+require_relative 'odata/navigation_attribute.rb'
+require_relative 'odata/collection.rb'
+require_relative 'safrano/service.rb'
+require_relative 'odata/walker.rb'
 require 'sequel'
-require_relative './sequel_join_by_paths.rb'
-require 'rack_app'
-require 'odata_rack_builder'
+require_relative 'safrano/sequel_join_by_paths.rb'
+require_relative 'safrano/rack_app'
+require_relative 'safrano/odata_rack_builder'
+require_relative 'safrano/version'
 
 # picked from activsupport; needed for ruby < 2.5
 # Destructively converts all keys using the +block+ operations.
@@ -29,3 +29,14 @@ class Hash
     transform_keys! { |key| key.to_sym rescue key }
   end
 end
+
+# needed for ruby < 2.5
+class Dir
+  def self.each_child(dir)
+    Dir.foreach(dir) do |x|
+      next if (x == '.') || (x == '..')
+
+      yield x
+    end
+  end unless respond_to? :each_child
+end

data/lib/{safrano_core.rb → safrano/core.rb}

@@ -2,13 +2,23 @@
 
 # our main namespace
 module OData
+  # frozen empty Array/Hash to reduce unncecessary object creation
+  EMPTY_ARRAY = [].freeze
+  EMPTY_HASH = {}.freeze
+  EMPTY_HASH_IN_ARY = [EMPTY_HASH].freeze
+  EMPTY_STRING = ''.freeze
+  ARY_204_EMPTY_HASH_ARY = [204, EMPTY_HASH, EMPTY_ARRAY].freeze
+  SPACE = ' '.freeze
+  COMMA = ','.freeze
+
   # some prominent constants... probably already defined elsewhere eg in Rack
   # but lets KISS
   CONTENT_TYPE = 'Content-Type'.freeze
+  CTT_TYPE_LC = 'content-type'.freeze
   TEXTPLAIN_UTF8 = 'text/plain;charset=utf-8'.freeze
   APPJSON = 'application/json'.freeze
   APPXML = 'application/xml'.freeze
-
+  MP_MIXED = 'multipart/mixed'.freeze
   APPXML_UTF8 = 'application/xml;charset=utf-8'.freeze
   APPATOMXML_UTF8 = 'application/atomsvc+xml;charset=utf-8'.freeze
   APPJSON_UTF8 = 'application/json;charset=utf-8'.freeze
@@ -31,14 +41,15 @@ module OData
   # database-specific types.
   DB_TYPE_STRING_RGX = /\ACHAR\s*\(\d+\)\z/.freeze
 
+  # TODO... complete; used in $metadata
   def self.get_edm_type(db_type:)
-    case db_type
+    case db_type.upcase
     when 'INTEGER'
       'Edm.Int32'
     when 'TEXT', 'STRING'
       'Edm.String'
     else
-      'Edm.String' if DB_TYPE_STRING_RGX =~ db_type
+      'Edm.String' if DB_TYPE_STRING_RGX =~ db_type.upcase
     end
   end
 end

data/lib/{multipart.rb → safrano/multipart.rb}

@@ -6,10 +6,17 @@ require 'webrick/httpstatus'
 
 # Simple multipart support for OData $batch purpose
 module MIME
+  CTT_TYPE_LC = 'content-type'.freeze
+  TEXT_PLAIN = 'text/plain'.freeze
+
   # a mime object has a header(with content-type etc) and a content(aka body)
   class Media
     # Parser for MIME::Media
     class Parser
+      HMD_RGX = /^([\w-]+)\s*:\s*(.*)/.freeze
+
+      CRLF_LINE_RGX = /^#{CRLF}$/.freeze
+
       attr_accessor :lines
       attr_accessor :target
       def initialize
@@ -47,11 +54,12 @@ module MIME
       end
 
       def parse_head(line)
-        if (hmd = /^([\w-]+)\s*:\s*(.*)/.match(line))
+        if (hmd = HMD_RGX.match(line))
           @target_hd[hmd[1].downcase] = hmd[2].strip
 
-        elsif /^#{CRLF}$/ =~ line
-          @target_ct = @target_hd['content-type'] || 'text/plain'
+        #        elsif CRLF_LINE_RGX =~ line
+        elsif CRLF == line
+          @target_ct = @target_hd[CTT_TYPE_LC] || TEXT_PLAIN
           @state = new_content
 
         end
@@ -95,21 +103,24 @@ module MIME
       end
 
       def hook_multipart(content_type, boundary)
-        @target_hd['content-type'] = content_type
-        @target_ct = @target_hd['content-type']
+        @target_hd[CTT_TYPE_LC] = content_type
+        @target_ct = @target_hd[CTT_TYPE_LC]
         @target = multipart_content(boundary)
         @target.hd = @target_hd
         @target.ct = @target_ct
         @state = :bmp
       end
-      MP_RGX1 = %r{^multipart/(digest|mixed);\s*boundary=\"(.*)\"}.freeze
-      MP_RGX2 = %r{^multipart/(digest|mixed);\s*boundary=(.*)}.freeze
+      MPS = 'multipart/'.freeze
+      MP_RGX1 = %r{^(digest|mixed);\s*boundary=\"(.*)\"}.freeze
+      MP_RGX2 = %r{^(digest|mixed);\s*boundary=(.*)}.freeze
+      #      APP_HTTP_RGX = %r{^application/http}.freeze
+      APP_HTTP = 'application/http'.freeze
       def new_content
         @target =
-          if (md = MP_RGX1.match(@target_ct)) ||
-             (md = MP_RGX2.match(@target_ct))
+          if @target_ct.start_with?(MPS) &&
+             (md = (MP_RGX1.match(@target_ct[10..-1]) || MP_RGX2.match(@target_ct[10..-1])))
             multipart_content(md[2].strip)
-          elsif %r{^application/http} =~ @target_ct
+          elsif @target_ct.start_with?(APP_HTTP)
             MIME::Content::Application::Http.new
           else
             MIME::Content::Text::Plain.new
@@ -187,6 +198,8 @@ module MIME
       class Plain < Media
         # Parser for Text::Plain
         class Parser
+          HMD_RGX = /^([\w-]+)\s*:\s*(.*)/.freeze
+          CRLF_LINE_RGX = /^#{CRLF}$/.freeze
           def initialize(target)
             @state = :h
             @lines = []
@@ -198,9 +211,10 @@ module MIME
           end
 
           def parse_head(line)
-            if (hmd = /^([\w-]+)\s*:\s*(.*)/.match(line))
+            if (hmd = HMD_RGX.match(line))
               @target.hd[hmd[1].downcase] = hmd[2].strip
-            elsif /^#{CRLF}$/ =~ line
+            #            elsif CRLF_LINE_RGX =~ line
+            elsif CRLF == line
               @state = :b
             else
               @target.content << line
@@ -230,8 +244,8 @@ module MIME
           @hd = {}
           @content = ''
           # set default values. Can be overwritten by parser
-          @hd['content-type'] = 'text/plain'
-          @ct = 'text/plain'
+          @hd[CTT_TYPE_LC] = TEXT_PLAIN
+          @ct = TEXT_PLAIN
           @parser = Parser.new(self)
         end
 
@@ -251,6 +265,7 @@ module MIME
       class Base < Media
         # Parser for Multipart Base class
         class Parser
+          CRLF_ENDING_RGX = /#{CRLF}$/.freeze
           def initialize(target)
             @body_lines = []
             @target = target
@@ -295,7 +310,8 @@ module MIME
             # to remove it from the end of the last body line
             return unless @body_lines
 
-            @body_lines.last.sub!(/#{CRLF}$/, '')
+            #            @body_lines.last.sub!(CRLF_ENDING_RGX, '')
+            @body_lines.last.chomp!(CRLF)
             @parts << @body_lines
           end
 
@@ -349,7 +365,7 @@ module MIME
         end
 
         def set_multipart_header
-          @hd['content-type'] = "multipart/mixed; boundary=#{@boundary}"
+          @hd[CTT_TYPE_LC] = "#{OData::MP_MIXED}; boundary=#{@boundary}"
         end
 
         def get_http_resp(batcha)
@@ -367,9 +383,7 @@ module MIME
             # of the changes
             batcha.db.transaction do
               begin
-                @response.content = @content.map { |part|
-                  part.get_response(batcha)
-                }
+                @response.content = @content.map { |part| part.get_response(batcha) }
               rescue Sequel::Rollback => e
                 # one of the changes of the changeset has failed
                 # --> provide a dummy empty response for the change-parts
@@ -390,17 +404,19 @@ module MIME
           @response.content = [{ 'odata.error' =>
                                { 'message' =>
                                  'Bad Request: Failed changeset ' } }.to_json]
-          @response.hd = { 'Content-Type' => 'application/json;charset=utf-8' }
+          @response.hd = OData::CT_JSON
           @response
         end
 
         def unparse(bodyonly = false)
           b = ''
           unless bodyonly
-            b << 'Content-Type' << ': ' << @hd['content-type'] << CRLF
+            #            b << OData::CONTENT_TYPE << ': ' << @hd[OData::CTT_TYPE_LC] << CRLF
+            b << "#{OData::CONTENT_TYPE}: #{@hd[CTT_TYPE_LC]}#{CRLF}"
           end
-          b << "#{CRLF}--#{@boundary}#{CRLF}"
-          b << @content.map(&:unparse).join("#{CRLF}--#{@boundary}#{CRLF}")
+
+          b << crbdcr = "#{CRLF}--#{@boundary}#{CRLF}"
+          b << @content.map(&:unparse).join(crbdcr)
           b << "#{CRLF}--#{@boundary}--#{CRLF}"
           b
         end
@@ -425,7 +441,8 @@ module MIME
 
         def unparse
           b = "#{@http_method} #{@uri} HTTP/1.1#{CRLF}"
-          @hd.each { |k, v| b << k.to_s << ': ' << v.to_s << CRLF }
+          @hd.each { |k, v| b << "#{k}: #{v}#{CRLF}" }
+          #          @hd.each { |k, v| b << k.to_s << ': ' << v.to_s << CRLF }
           b << CRLF
           b << @content if @content != ''
           b
@@ -455,7 +472,8 @@ module MIME
         def unparse
           b = String.new(APPLICATION_HTTP_11)
           b << "#{@status} #{StatusMessage[@status]} #{CRLF}"
-          @hd.each { |k, v| b << k.to_s << ': ' << v.to_s << CRLF }
+          @hd.each { |k, v| b << "#{k}: #{v}#{CRLF}" }
+          #          @hd.each { |k, v| b << k.to_s << ': ' << v.to_s << CRLF }
           b << CRLF
           b << @content.join if @content
           b
@@ -464,13 +482,16 @@ module MIME
 
       # For application/http . Content is either a Request or a Response
       class Http < Media
-        HTTP_MTHS_RGX = 'POST|GET|PUT|MERGE|PATCH'.freeze
+        HTTP_MTHS_RGX = 'POST|GET|PUT|MERGE|PATCH|DELETE'.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
 
         # Parser for Http Media
         class Parser
+          HMD_RGX = /^([\w-]+)\s*:\s*(.*)/.freeze
+          CRLF_LINE_RGX = /^#{CRLF}$/.freeze
+
           def initialize(target)
             @state = :http
             @lines = []
@@ -483,7 +504,7 @@ module MIME
           end
 
           def parse_http(line)
-            if (hmd = /^([\w-]+)\s*:\s*(.*)/.match(line))
+            if (hmd = HMD_RGX.match(line))
               @target.hd[hmd[1].downcase] = hmd[2].strip
             elsif (mdht = HTTP_R_RGX.match(line))
               @state = :hd
@@ -499,9 +520,10 @@ module MIME
           end
 
           def parse_head(line)
-            if (hmd = /^([\w-]+)\s*:\s*(.*)/.match(line))
+            if (hmd = HMD_RGX.match(line))
               @target.content.hd[hmd[1].downcase] = hmd[2].strip
-            elsif /^#{CRLF}$/ =~ line
+            elsif CRLF == line
+              #            elsif CRLF_LINE_RGX =~ line
               @state = :b
             else
               @body_lines << line