safrano 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a69035d5b1015e36842490919163234c4ae55591657fb7d3b4b730b871c0035b
-  data.tar.gz: 5c0024539a67f37cbf397975315066b1df803dd826b242b873147bbd1da60062
+  metadata.gz: cd0dda1e8d7fc80e01fc15b50b0893a31b189bb95e0138c8c1e49f4d3cdb11d5
+  data.tar.gz: 4155a3d6ca1dcd2817aab51bc85208ada311b8a120d4ed90e5a8fcd6c05d23b7
 SHA512:
-  metadata.gz: 7538b83433db7381e77a34415e9cd4887cd2db20bfe8ba05db66e6d3703a0358e9f3024f137bddfca3b9b490caf3afbc2262b6b26514a36efeae792c8983a670
-  data.tar.gz: b12e002bdbdeb826678d9cd1f8c1c9dce8bd11791adf8205464d12b115551bebbc59ddf4635d4406e93c4f5cee955f5356fea3d373857bac662ddbe5dd098ef7
+  metadata.gz: e1b61fcb3776b7435821121eb41b21afcf5fba422cb7665182ca7dc4d5e11155c3ba92a41eee7c9dc20730728c838033aa4b30367fd0e518d108547b7fbb7bf5
+  data.tar.gz: 270e6f1942254b239aed16b0bdb4ba8c5f48eba6fa676f9e9da9758e984c1cdd37a72cd355ed30326881013342538bf59b4de7b9143aabd2104d4c3fdf7faa0d

data/lib/odata/collection.rb

@@ -50,6 +50,7 @@ module OData
     attr_reader :nav_collection_attribs
     attr_reader :nav_entity_attribs
     attr_reader :data_fields
+    attr_reader :inlinecount
 
     attr_accessor :namespace
 
@@ -131,12 +132,25 @@ module OData
       @cx = @cx.select_all(entity_set_name.to_sym)
     end
 
+    def odata_get_inlinecount_w_sequel
+      return unless (icp = @params['$inlinecount'])
+
+      @inlinecount = if icp == 'allpages'
+                       if is_a? Sequel::Model::ClassMethods
+                         @cx.count
+                       else
+                         @cx.dataset.count
+                       end
+                     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']
@@ -169,6 +183,16 @@ module OData
       return BadRequestError if iskip.nil? || (iskip < 0)
     end
 
+    def check_u_p_inlinecount
+      return unless (icp = @params['$inlinecount'])
+
+      unless (icp == 'allpages') || (icp == 'none')
+        return BadRequestInlineCountParamError
+      end
+
+      nil
+    end
+
     def check_u_p_filter
       return unless @params['$filter']
 
@@ -182,7 +206,8 @@ module OData
     end
 
     def check_u_p_orderby
-      # TODO: this should be moved into OData::Order somehow, at least partly
+      # TODO: this should be moved into OData::Order somehow,
+      # at least partly
       return unless (pordlist = @params['$orderby'].dup)
 
       pordlist.split(',').each do |pord|
@@ -224,7 +249,7 @@ 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_top || check_u_p_skip || check_u_p_orderby || check_u_p_filter || check_u_p_inlinecount
     end
 
     def initialize_dataset
@@ -248,19 +273,29 @@ module OData
           [200, { 'Content-Type' => 'text/plain;charset=utf-8' },
            @cx.count.to_s]
         elsif req.accept?('application/json')
-          [200, { 'Content-Type' => 'application/json;charset=utf-8' },
-           to_odata_json(service: req.service)]
+          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
         end
       end
     end
 
+    def to_odata_links_json(service:)
+      { 'd' => service.get_coll_odata_links_h(array: get_a,
+                                              uribase: @uribase) }.to_json
+    end
+
     def to_odata_json(service:)
-      expand = @params['$expand']
       { 'd' => service.get_coll_odata_h(array: get_a,
-                                        expand: expand,
-                                        uribase: @uribase) }.to_json
+                                        expand: @params['$expand'],
+                                        uribase: @uribase,
+                                        icount: @inlinecount) }.to_json
     end
 
     def get_a

data/lib/odata/collection_filter.rb

@@ -40,32 +40,6 @@ class String
   end
 end
 
-# Handles filtering with ruby expressions
-# (eval and DB full scan used --> better avoid using this)
-module FilterWithRuby
-  # this module requires the @fn attribute to exist where it is used
-  def fn=(farg)
-    @fn = farg
-    @fn_tab = farg.split('/').map(&:to_sym)
-  end
-
-  # returns the attribute named "@fn" of object inp. This version assumes that
-  # @fn can be a path like "address/city"
-  def get_value(inp, colescev = '')
-    obj = inp
-    @fn_tab.each do |csymb|
-      tmp = obj.send(csymb)
-      if tmp.nil?
-        obj = colescev
-        break
-      else
-        obj = tmp
-      end
-    end
-    obj
-  end
-end
-
 # filter base class and subclass in our OData namespace
 module OData
   # handles associations in filter arguments
@@ -120,11 +94,6 @@ module OData
       new(matx)
     end
 
-    # handle complex deep (relations) expressions with Ruby
-    def self.new_full_match_complexpr_by_ruby(filterstr)
-      ComplexFilterByRuby.new(filterstr)
-    end
-
     def apply_to_dataset(dtcx)
       dtcx
     end
@@ -137,7 +106,6 @@ module OData
 
   # well...
   class EqualFilter < Filter
-    include FilterWithRuby
     include FilterWithAssoc
     EQL = '[eE][qQ]|[LlgGNn][eETt]'.freeze
 
@@ -147,7 +115,7 @@ module OData
 
     def initialize(matx)
       super(matx)
-      self.fn = matx[1]
+      @fn = matx[1]
       get_assoc if @fn
 
       @val = matx[3] ? matx[3].gsub("''", "'") : matx[4]
@@ -172,29 +140,34 @@ module OData
       y
     end
 
-    def apply_to_dataset(dtcx)
-      seqfn = get_qualified_fn(dtcx)
-      # using @val in Procs below does not work reliably. Using a local var
-      # seems to work better
-      argval = @val
+    def apply_op_to_dataset(dtcx, lefval, rightval)
       case @op
       when 'eq'
-        dtcx.where(seqfn => @val)
+        dtcx.where(lefval => rightval)
       when 'ne'
-        dtcx.exclude(seqfn => @val)
+        dtcx.exclude(lefval => rightval)
       when 'le'
-        dtcx.where { seqfn <= argval }
+        dtcx.where { lefval <= rightval }
       when 'ge'
-        dtcx.where { seqfn >= argval }
+        dtcx.where { lefval >= rightval }
       when 'lt'
-        dtcx.where { seqfn < argval }
+        dtcx.where { lefval < rightval }
       when 'gt'
-        dtcx.where { seqfn > argval }
+        dtcx.where { lefval > rightval }
       else
         raise OData::FilterParseError
       end
     end
 
+    def apply_to_dataset(dtcx)
+      seqfn = get_qualified_fn(dtcx)
+      # using @val in Procs below does not work reliably. Using a local var
+      # seems to work better
+      argval = @val
+
+      apply_op_to_dataset(dtcx, seqfn, argval)
+    end
+
     def apply_to_object(inp)
       case @op
       when 'eq'
@@ -207,7 +180,132 @@ module OData
     end
   end
 
-  # equality expressions with functions ... length(name) eq 2
+  class Func2a_EqualFilter < EqualFilter
+    FUNC = 'concat'.freeze
+    attr_reader :funcname
+
+    # like for concat(Name, 'xyz') EQ 'blablux'
+    def self.qualified_regexp(pathsrx)
+      /\s*(#{FUNC})\((#{pathsrx}),\s*(?:#{QUO})\)\s+(#{EQL})\s+(?:#{QUO})\s*/
+    end
+
+    def initialize(matx)
+      #      super(matx)
+      @funcname = matx[1]
+      @fn = matx[2]
+      get_assoc if @fn
+      @farg = matx[3].gsub("''", "'")
+      @op = matx[4].downcase
+
+      @val = matx[5].gsub("''", "'")
+    end
+
+    def apply_to_dataset(dtcx)
+      seqfn = get_qualified_fn(dtcx)
+      # using @val in Procs below does not work reliably. Using a local var
+      # seems to work better
+      argval = @val
+      seqfunc = case @funcname
+                when 'concat'
+                  Sequel.join([seqfn, @farg])
+                else
+                  raise OData::FilterParseError
+                end
+      apply_op_to_dataset(dtcx, seqfunc, argval)
+    end
+  end
+  class Func2b_EqualFilter < EqualFilter
+    FUNC = 'concat'.freeze
+    attr_reader :funcname
+
+    # like for concat('xyz', Name) EQ 'blablux'
+    def self.qualified_regexp(pathsrx)
+      /\s*(#{FUNC})\((?:#{QUO}),\s*(#{pathsrx})\)\s+(#{EQL})\s+(?:#{QUO})\s*/
+    end
+
+    def initialize(matx)
+      #      super(matx)
+      @funcname = matx[1]
+      @fn = matx[3]
+      get_assoc if @fn
+      @farg = matx[2].gsub("''", "'")
+      @op = matx[4].downcase
+
+      @val = matx[5].gsub("''", "'")
+    end
+
+    def apply_to_dataset(dtcx)
+      seqfn = get_qualified_fn(dtcx)
+      # using @val in Procs below does not work reliably. Using a local var
+      # seems to work better
+      argval = @val
+      seqfunc = case @funcname
+                when 'concat'
+                  Sequel.join([@farg, seqfn])
+                else
+                  raise OData::FilterParseError
+                end
+      apply_op_to_dataset(dtcx, seqfunc, argval)
+    end
+  end
+
+  class Func2c_EqualFilter < EqualFilter
+    FUNC = 'concat'.freeze
+    attr_reader :funcname
+
+    # like for concat(first_ame, last_name) EQ 'blablux'
+    def self.qualified_regexp(pathsrx)
+      /\s*(#{FUNC})\((#{pathsrx}),\s*(#{pathsrx})\)\s+(#{EQL})\s+(?:#{QUO})\s*/
+    end
+
+    def get_assoc
+      @assoc, @fn = @fn.split('/') if @fn.include?('/')
+      assoc1, @fn1 = @fn1.split('/') if @fn1.include?('/')
+      if assoc1 != @assoc
+        # TODO... handle this
+        raise OData::ServerError
+      end
+    end
+
+    def get_qualified_fn1(dtcx)
+      seqtn = if dtcx.respond_to? :table_name
+                @assoc ? @assoc.to_sym : dtcx.table_name
+              else
+                @assoc ? @assoc.to_sym : dtcx.model.table_name
+              end
+      Sequel[seqtn][@fn1.to_sym]
+    end
+
+    def initialize(matx)
+      #      super(matx)
+      @funcname = matx[1]
+      @fn = matx[2]
+      @fn1 = matx[3]
+      get_assoc if @fn
+
+      @op = matx[4].downcase
+
+      @val = matx[5].gsub("''", "'")
+    end
+
+    def apply_to_dataset(dtcx)
+      seqfn = get_qualified_fn(dtcx)
+      seqfn1 = get_qualified_fn1(dtcx)
+      # using @val in Procs below does not work reliably. Using a local var
+      # seems to work better
+      argval = @val
+      seqfunc = case @funcname
+                when 'concat'
+                  Sequel.join([seqfn, seqfn1])
+                else
+                  raise OData::FilterParseError
+                end
+      apply_op_to_dataset(dtcx, seqfunc, argval)
+    end
+  end
+
+  # equality expressions with functions having 1 parameter
+  # like for  length(name) eq 2
   class FuncEqualFilter < EqualFilter
     FUNC = 'length|trim|tolower|toupper'.freeze
 
@@ -220,29 +318,12 @@ module OData
     def initialize(matx)
       super(matx)
       @funcname = matx[1]
-      self.fn = matx[2]
+      @fn = matx[2]
       get_assoc if @fn
 
-      @val = matx[4] ? matx[4].gsub("''", "'") : matx[5]
-
       @op = matx[3].downcase
-    end
-
-    # ugly hack... but working
-    def gen_sql(dtcx)
-      # handle ambiguous column names (joins) by qualifiying the names
-      #      seqfn = @assoc ? Sequel[@assoc.to_sym][@fn.to_sym] : @fn.to_sym
-      # handle ambiguous column names (joins) by qualifiying the names
-      # for the main table as well
-      # TODO: find a better way to differentiate between the two types
-      #      of dtcx : Model or Dataset
 
-      # DONE: same handling for order and substring and everywhere where
-      # qualified fieldnames could be needed (uses attrib path regexp)
-      x = apply_to_dataset(dtcx)
-      # ugly ugly hack :-(
-      y = x.unordered.sql.sub(x.unfiltered.unordered.sql + ' WHERE', '')
-      y
+      @val = matx[4] ? matx[4].gsub("''", "'") : matx[5]
     end
 
     def apply_to_dataset(dtcx)
@@ -264,22 +345,7 @@ module OData
                   raise OData::FilterParseError
                 end
 
-      case @op
-      when 'eq'
-        dtcx.where(seqfunc => argval)
-      when 'ne'
-        dtcx.exclude(seqfunc => argval)
-      when 'le'
-        dtcx.where { seqfunc  <= argval }
-      when 'ge'
-        dtcx.where { seqfunc  >= argval }
-      when 'lt'
-        dtcx.where { seqfunc < argval }
-      when 'gt'
-        dtcx.where { seqfunc > argval }
-      else
-        raise OData::FilterParseError
-      end
+      apply_op_to_dataset(dtcx, seqfunc, argval)
     end
   end
 
@@ -290,7 +356,6 @@ module OData
 
   # for substringof('value', field)
   class SubstringOfFilterSig1 < FilterWithKeyword
-    include FilterWithRuby
     include FilterWithAssoc
 
     def self.qualified_regexp(paths_rx)
@@ -303,8 +368,8 @@ module OData
 
     def initialize(matx)
       super(matx)
-      #      binding.pry
-      self.fn = matx[4]
+
+      @fn = matx[4]
       get_assoc if @fn
       #      @val = matx[2].strip_single_quote
       @val = matx[2] ? matx[2].gsub("''", "'") : matx[3]
@@ -328,19 +393,14 @@ module OData
     def apply_to_dataset(dtcx)
       dtcx.where(whcl(dtcx))
     end
-
-    def apply_to_object(inp)
-      get_value(inp).include?(@val)
-    end
   end
   # for substringof(field,'value')
   class SubstringOfFilterSig2 < FilterWithKeyword
-    include FilterWithRuby
     include FilterWithAssoc
 
     def initialize(matx)
       super(matx)
-      self.fn = matx[2]
+      @fn = matx[2]
       get_assoc if @fn
       @val = matx[3]
       @keyword = matx[1]
@@ -351,15 +411,10 @@ module OData
     def apply_to_dataset(dtcx)
       dtcx
     end
-
-    def apply_to_object(inp)
-      get_value(inp).include?(@val)
-    end
   end
 
   # Filter by start/end with
   class StartOrEndsWithFilter < FilterWithKeyword
-    include FilterWithRuby
     include FilterWithAssoc
     # DONE: better handle quotes vs not-quotes. Unblanced quotes are now handled
     # example : startswith(year, 190')
@@ -372,21 +427,11 @@ module OData
       super(matx)
       # DONE: the regexp should only match on known field names...
       # --> use qualified_regexp(attr_paths_rgx)
-      self.fn = matx[2]
+      @fn = matx[2]
       get_assoc if @fn
       # double quotes need to be unescaped
       @val = matx[3] ? matx[3].gsub("''", "'") : matx[4]
       @keyword = matx[1]
-      ve = Regexp.escape(@val)
-      # used for "filter with ruby"
-      case @keyword
-      when 'startswith'
-        @startend_rgx = Regexp.new("\A#{ve}")
-      when 'endswith'
-        @startend_rgx = Regexp.new("#{ve}\z")
-      else
-        raise FilterParseError
-      end
     end
 
     def whcl(dtcx)
@@ -412,10 +457,6 @@ module OData
     def apply_to_dataset(dtcx)
       dtcx.where(whcl(dtcx))
     end
-
-    def apply_to_object(inp)
-      get_value(inp) =~ @startend_rgx
-    end
   end
 
   FILTER_CLASSES = [EqualFilter,
@@ -435,6 +476,9 @@ module OData
     # list of active Subfilter classes. The ordering is important
     SUBFILTERS = [EqualFilter,
                   FuncEqualFilter,
+                  Func2a_EqualFilter,
+                  Func2b_EqualFilter,
+                  Func2c_EqualFilter,
                   SubstringOfFilterSig1,
                   StartOrEndsWithFilter].freeze
     # for counting number of AND OR's
@@ -487,39 +531,4 @@ module OData
       dtcx.where(Sequel.lit(@osql))
     end
   end
-
-  # Handle complex filter expression with Ruby
-  class ComplexFilterByRuby < Filter
-    def initialize(filterstr)
-      @subf = []
-      @f = nil
-      @rbcode = filterstr.dup
-      @rbcode.with_mask_quoted_substrings! do |_s|
-        SUBFILTERS.each { |klass| init_subfilter(klass) }
-        downcase_and_or
-      end
-    end
-
-    # downcase AND OR in  @rbcode otherwise it is seen as a Ruby constant
-    #  instead as a ruby langu keyword
-    def downcase_and_or
-      @rbcode.gsub!(/(OR|Or|AND|And)/) do |_mx|
-        Regexp.last_match[1].downcase
-      end
-    end
-
-    def init_subfilter(subfiltclass)
-      @rbcode.gsub!(subfiltclass.regexp) do |_mx|
-        @f = subfiltclass.new(Regexp.last_match)
-        @subf << @f
-        "@subf[#{@subf.size - 1}].apply_to_object(@o)"
-      end
-    end
-
-    def apply_to_object(inp)
-      @o = inp
-      b = binding
-      eval(@rbcode, b)
-    end
-  end
 end

data/lib/odata/entity.rb

@@ -17,6 +17,7 @@ module OData
         alltr = [
           Safrano::TransitionEnd,
           Safrano::TransitionCount,
+          Safrano::TransitionLinks,
           Safrano::Transition.new(%r{\A/(#{aurgx})(.*)\z},
                                   trans: 'transition_attribute')
         ]
@@ -42,6 +43,10 @@ module OData
         [self, :end]
       end
 
+      def transition_links(_match_result)
+        [self, :run_with_links]
+      end
+
       def transition_attribute(match_result)
         attrib = match_result[1]
         #        [values[attrib.to_sym], :run]
@@ -97,6 +102,7 @@ module OData
     def to_odata_json(service:)
       { 'd' => service.get_entity_odata_h(entity: self,
                                           expand: @params['$expand'],
+                                          #                                          links: @do_links,
                                           uribase: @uribase) }.to_json
     end
 
@@ -120,6 +126,7 @@ module OData
     def odata_get(req)
       @params = req.params
       @uribase = req.uribase
+      @do_links = req.walker.do_links
       if req.accept?('application/json')
         [200, { 'Content-Type' => 'application/json;charset=utf-8' },
          to_odata_json(service: req.service)]

data/lib/odata/error.rb

@@ -49,6 +49,11 @@ module OData
     HTTP_CODE = 400
     @msg = 'Bad Request: Syntax error in Filter'
   end
+  # for $inlinecount error
+  class BadRequestInlineCountParamError < BadRequestError
+    HTTP_CODE = 400
+    @msg = 'Bad Request: wrong $inlinecount parameter'
+  end
   # http not found
   class ErrorNotFound
     extend  Error

data/lib/odata/walker.rb

@@ -25,6 +25,9 @@ module OData
     # is $value requested?
     attr_reader :raw_value
 
+    # are $links requested ?
+    attr_reader :do_links
+
     def initialize(service, path)
       path = URI.decode_www_form_component(path)
       @context = service
@@ -82,13 +85,16 @@ module OData
           @path_remain = @tr_next.path_remain
           @path_done << @tr_next.path_done
           # little hack's
-          if @status == :end_with_count
+          case @status
+          when :end_with_count
             @do_count = true
             @status == :end
-          end
-          if @status == :end_with_value
+          when :end_with_value
             @raw_value = true
             @status == :end
+          when :run_with_links
+            @do_links = true
+            @status = :run
           end
         else
           @context = nil

data/lib/safrano_core.rb

@@ -85,5 +85,7 @@ module Safrano
                                    trans: 'transition_count')
   TransitionValue = Transition.new('(\A\/\$value)(.*)\z',
                                    trans: 'transition_value')
+  TransitionLinks = Transition.new('(\A\/\$links)(.*)\z',
+                                   trans: 'transition_links')
   attr_accessor :allowed_transitions
 end

data/lib/service.rb

@@ -74,6 +74,12 @@ module OData
       end
     end
 
+    # handle $links ... Note: $expand seems to be ignored when $links
+    # are  requested
+    def get_entity_odata_link_h(entity:, uribase:)
+      hres = { uri: entity.uri(uribase) }
+    end
+
     def get_entity_odata_h(entity:, expand: nil, uribase:)
       hres = {}
       hres['__metadata'] = entity.metadata_h(uribase: uribase)
@@ -511,7 +517,7 @@ module OData
       @data_service_version = '1.0'
     end
 
-    def get_coll_odata_h(array:, expand: nil, uribase:)
+    def get_coll_odata_h(array:, expand: nil, uribase:, icount: nil)
       array.map do |w|
         get_entity_odata_h(entity: w,
                            expand: expand,
@@ -530,13 +536,23 @@ module OData
       @data_service_version = '2.0'
     end
 
-    def get_coll_odata_h(array:, expand: nil, uribase:)
-      { 'results' =>
-          array.map do |w|
-            get_entity_odata_h(entity: w,
-                               expand: expand,
-                               uribase: uribase)
-          end }
+    def get_coll_odata_links_h(array:, uribase:)
+      array.map do |w|
+        get_entity_odata_link_h(entity: w, uribase: uribase)
+      end
+    end
+
+    def get_coll_odata_h(array:, expand: nil, uribase:, icount: nil)
+      res = array.map do |w|
+        get_entity_odata_h(entity: w,
+                           expand: expand,
+                           uribase: uribase)
+      end
+      if icount
+        { 'results' => res, '__count' => icount }
+      else
+        { 'results' => res }
+      end
     end
 
     def get_emptycoll_odata_h

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safrano
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - D.M.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-19 00:00:00.000000000 Z
+date: 2019-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -66,8 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.51'
-description: Safrano is a small experimental OData server framework based on Ruby,
-  Rack and Sequel.
+description: Safrano is a small OData server framework based on Ruby, Rack and Sequel.
 email: dm@0data.dev
 executables: []
 extensions: []