safrano 0.3.3 → 0.4.3

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'
@@ -29,9 +27,11 @@ module OData
 
     # are $links requested ?
     attr_reader :do_links
-
+    NIL_SERVICE_FATAL = 'Walker is called with a nil service'.freeze
+    EMPTYSTR = ''.freeze
+    SLASH = '/'.freeze
     def initialize(service, path, content_id_refs = nil)
-      raise 'Walker is called with a nil service' unless service
+      raise NIL_SERVICE_FATAL unless service
 
       path = URI.decode_www_form_component(path)
       @context = service
@@ -53,12 +53,12 @@ module OData
     end
 
     def unprefixed(prefix, path)
-      if (prefix == '') || (prefix == '/')
+      if (prefix == EMPTYSTR) || (prefix == SLASH)
         path
       else
         #        path.sub!(/\A#{prefix}/, '')
         # TODO check
-        path.sub(/\A#{prefix}/, '')
+        path.sub(/\A#{prefix}/, EMPTYSTR)
       end
     end
 

data/lib/safrano.rb

@@ -1,19 +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/navigation_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.
@@ -30,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}

@@ -1,7 +1,14 @@
-#!/usr/bin/env ruby
-
 # 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
@@ -32,14 +39,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,14 +6,15 @@ 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
@@ -54,9 +55,8 @@ module MIME
         if (hmd = HMD_RGX.match(line))
           @target_hd[hmd[1].downcase] = hmd[2].strip
 
-        #        elsif CRLF_LINE_RGX =~ line
         elsif CRLF == line
-          @target_ct = @target_hd['content-type'] || 'text/plain'
+          @target_ct = @target_hd[CTT_TYPE_LC] || TEXT_PLAIN
           @state = new_content
 
         end
@@ -100,8 +100,8 @@ 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
@@ -114,10 +114,8 @@ module MIME
       APP_HTTP = 'application/http'.freeze
       def new_content
         @target =
-          if @target_ct.start_with?(MPS) and
-             (md = ((MP_RGX1.match(@target_ct[10..-1])) ||
-                      (MP_RGX2.match(@target_ct[10..-1])))
-             )
+          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 @target_ct.start_with?(APP_HTTP)
             MIME::Content::Application::Http.new
@@ -198,7 +196,6 @@ module MIME
         # Parser for Text::Plain
         class Parser
           HMD_RGX = /^([\w-]+)\s*:\s*(.*)/.freeze
-          CRLF_LINE_RGX = /^#{CRLF}$/.freeze
           def initialize(target)
             @state = :h
             @lines = []
@@ -212,7 +209,6 @@ module MIME
           def parse_head(line)
             if (hmd = HMD_RGX.match(line))
               @target.hd[hmd[1].downcase] = hmd[2].strip
-            #            elsif CRLF_LINE_RGX =~ line
             elsif CRLF == line
               @state = :b
             else
@@ -243,8 +239,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
 
@@ -364,7 +360,7 @@ module MIME
         end
 
         def set_multipart_header
-          @hd['content-type'] = "#{OData::MP_MIXED}; boundary=#{@boundary}"
+          @hd[CTT_TYPE_LC] = "#{OData::MP_MIXED}; boundary=#{@boundary}"
         end
 
         def get_http_resp(batcha)
@@ -382,9 +378,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
@@ -413,10 +407,11 @@ module MIME
           b = ''
           unless bodyonly
             #            b << OData::CONTENT_TYPE << ': ' << @hd[OData::CTT_TYPE_LC] << 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
@@ -442,7 +437,6 @@ module MIME
         def unparse
           b = "#{@http_method} #{@uri} HTTP/1.1#{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
@@ -473,7 +467,6 @@ module MIME
           b = String.new(APPLICATION_HTTP_11)
           b << "#{@status} #{StatusMessage[@status]} #{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
@@ -482,7 +475,7 @@ 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
@@ -490,7 +483,6 @@ module MIME
         # Parser for Http Media
         class Parser
           HMD_RGX = /^([\w-]+)\s*:\s*(.*)/.freeze
-          CRLF_LINE_RGX = /^#{CRLF}$/.freeze
 
           def initialize(target)
             @state = :http
@@ -523,7 +515,6 @@ module MIME
             if (hmd = HMD_RGX.match(line))
               @target.content.hd[hmd[1].downcase] = hmd[2].strip
             elsif CRLF == line
-              #            elsif CRLF_LINE_RGX =~ line
               @state = :b
             else
               @body_lines << line

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

@@ -10,7 +10,6 @@ module Rack
         super(default_app) {}
         use ::Rack::Cors
         instance_eval(&block) if block_given?
-        use ::Rack::Lint
         use ::Rack::ContentLength
       end
     end

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

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'rack'
-require_relative 'odata/walker.rb'
+require_relative '../odata/walker.rb'
 require_relative 'request.rb'
 require_relative 'response.rb'
 
@@ -14,7 +14,7 @@ module OData
       x = if @walker.status == :end
             headers.delete('Content-Type')
             @response.headers.delete('Content-Type')
-            [200, {}, '']
+            [200, EMPTY_HASH, '']
           else
             odata_error
           end
@@ -70,20 +70,20 @@ module OData
     end
 
     def odata_head
-      [200, {}, ['']]
+      [200, EMPTY_HASH, [EMPTY_STRING]]
     end
   end
 
   # the main Rack server app. Source: the Rack docu/examples and partly
   # inspired from Sinatra
   class ServerApp
-    METHODS_REGEXP = Regexp.new('HEAD|OPTIONS|GET|POST|PATCH|MERGE|PUT|DELETE')
+    METHODS_REGEXP = Regexp.new('HEAD|OPTIONS|GET|POST|PATCH|MERGE|PUT|DELETE').freeze
+    NOCACHE_HDRS = { 'Cache-Control' => 'no-cache',
+                     'Expires' => '-1',
+                     'Pragma' => 'no-cache' }.freeze
+    DATASERVICEVERSION = 'DataServiceVersion'.freeze
     include MethodHandlers
     def before
-      headers 'Cache-Control' => 'no-cache'
-      headers 'Expires' => '-1'
-      headers 'Pragma' => 'no-cache'
-
       @request.service_base = self.class.get_service_base
 
       neg_error = @request.negotiate_service_version
@@ -92,7 +92,9 @@ module OData
 
       return false unless @request.service
 
-      headers 'DataServiceVersion' => @request.service.data_service_version
+      myhdrs = NOCACHE_HDRS.dup
+      myhdrs[DATASERVICEVERSION] = @request.service.data_service_version
+      headers myhdrs
     end
 
     # dispatch for all methods requiring parsing of the path
@@ -119,7 +121,7 @@ module OData
 
     def dispatch
       req_ret = if @request.request_method !~ METHODS_REGEXP
-                  [404, {}, ['Did you get lost?']]
+                  [404, EMPTY_HASH, ['Did you get lost?']]
                 elsif @request.request_method == 'HEAD'
                   odata_head
                 else