safrano 0.4.2 → 0.4.3

data/lib/odata/navigation_attribute.rb

@@ -140,9 +140,11 @@ module OData
         [self, :end_with_value]
       end
 
+      ALLOWED_TRANSITIONS = [Safrano::TransitionEnd,
+                             Safrano::TransitionValue].freeze
+
       def allowed_transitions
-        [Safrano::TransitionEnd,
-         Safrano::TransitionValue]
+        ALLOWED_TRANSITIONS
       end
     end
     include Transitions

data/lib/odata/walker.rb

@@ -27,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
@@ -51,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/core.rb

@@ -1,5 +1,3 @@
-#!/usr/bin/env ruby
-
 # our main namespace
 module OData
   # frozen empty Array/Hash to reduce unncecessary object creation

data/lib/safrano/multipart.rb

@@ -15,8 +15,6 @@ module MIME
     class Parser
       HMD_RGX = /^([\w-]+)\s*:\s*(.*)/.freeze
 
-      CRLF_LINE_RGX = /^#{CRLF}$/.freeze
-
       attr_accessor :lines
       attr_accessor :target
       def initialize
@@ -57,7 +55,6 @@ 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[CTT_TYPE_LC] || TEXT_PLAIN
           @state = new_content
@@ -199,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 = []
@@ -213,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
@@ -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
@@ -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/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/safrano/rack_app.rb

@@ -77,13 +77,13 @@ module OData
   # 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

data/lib/safrano/request.rb

@@ -108,13 +108,6 @@ module OData
       end
     end
 
-    def uribase
-      return @uribase if @uribase
-
-      @uribase =
-        "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}#{service.xpath_prefix}"
-    end
-
     def accept?(type)
       preferred_type(type).to_s.include?(type)
     end

data/lib/safrano/service.rb

@@ -2,14 +2,18 @@ require 'rexml/document'
 require 'odata/relations.rb'
 require 'odata/batch.rb'
 require 'odata/error.rb'
+require 'odata/filter/sequel.rb'
 
 module OData
   # this module has all methods related to expand/defered output preparation
   # and will be included in Service class
   module ExpandHandler
     PATH_SPLITTER = %r{\A(\w+)\/?(.*)\z}.freeze
-    def get_deferred_odata_h(entity:, attrib:, uribase:)
-      { '__deferred' => { 'uri' => "#{entity.uri(uribase)}/#{attrib}" } }
+    DEFERRED = '__deferred'.freeze
+    URI = 'uri'.freeze
+
+    def get_deferred_odata_h(entity_uri:, attrib:)
+      { DEFERRED => { URI => "#{entity_uri}/#{attrib}" } }
     end
 
     # split expand argument into first and rest part
@@ -33,29 +37,30 @@ module OData
 
     # default v2
     # overriden in ServiceV1
-    def get_coll_odata_h(array:, template:, uribase:, icount: nil)
-      res = array.map do |w|
-        get_entity_odata_h(entity: w,
-                           template: template,
-                           uribase: uribase)
+    RESULTS_K = 'results'.freeze
+    COUNT_K = '__count'.freeze
+    def get_coll_odata_h(array:, template:, icount: nil)
+      array.map! do |w|
+        get_entity_odata_h(entity: w, template: template)
       end
       if icount
-        { 'results' => res, '__count' => icount }
+        { RESULTS_K => array, COUNT_K => icount }
       else
-        { 'results' => res }
+        { RESULTS_K => array }
       end
     end
 
     # handle $links ... Note: $expand seems to be ignored when $links
     # are  requested
-    def get_entity_odata_link_h(entity:, uribase:)
-      { uri: entity.uri(uribase) }
+    def get_entity_odata_link_h(entity:)
+      { uri: entity.uri }
     end
 
     EMPTYH = {}.freeze
-    def get_entity_odata_h(entity:, template:, uribase:)
+    METADATA_K = '__metadata'.freeze
+    def get_entity_odata_h(entity:, template:)
       # start with metadata
-      hres = { '__metadata' => entity.metadata_h(uribase: uribase) }
+      hres = { METADATA_K => entity.metadata_h }
 
       template.each do |elmt, arg|
         case elmt
@@ -68,10 +73,7 @@ module OData
           arg.each do |attr, templ|
             enval = entity.send(attr)
             hres[attr] = if enval
-
-                           get_entity_odata_h(entity: enval,
-                                              template: templ,
-                                              uribase: uribase)
+                           get_entity_odata_h(entity: enval, template: templ)
                          else
                            # FK is NULL --> nav_value is nil --> return empty json
                            EMPTYH
@@ -82,16 +84,13 @@ module OData
             next unless  (encoll = entity.send(attr))
 
             #  nav attributes that are a collection (x..n)
-            hres[attr] = get_coll_odata_h(array: encoll,
-                                          template: templ,
-                                          uribase: uribase)
+            hres[attr] = get_coll_odata_h(array: encoll, template: templ)
             # else error ?
           end
         when :deferr
+          euri = entity.uri
           arg.each do |attr|
-            hres[attr] = get_deferred_odata_h(entity: entity,
-                                              attrib: attr,
-                                              uribase: uribase)
+            hres[attr] = get_deferred_odata_h(entity_uri: euri, attrib: attr)
           end
         end
       end
@@ -144,7 +143,8 @@ module OData
     attr_accessor :xname
     attr_accessor :xnamespace
     attr_accessor :xpath_prefix
-    #    attr_accessor :xuribase
+    attr_accessor :xserver_url
+    attr_accessor :uribase
     attr_accessor :meta
     attr_accessor :batch_handler
     attr_accessor :relman
@@ -170,6 +170,7 @@ module OData
     DATASERVICEVERSION_RGX = /\A([1234])(?:\.0);*\w*\z/.freeze
     TRAILING_SLASH = %r{/\z}.freeze
     DEFAULT_PATH_PREFIX = '/'.freeze
+    DEFAULT_SERVER_URL = 'http://localhost:9494'
 
     # input is the       DataServiceVersion request header string, eg.
     # '2.0;blabla' ---> Version -> 2
@@ -212,21 +213,51 @@ module OData
       (@v1.xpath_prefix = @xpath_prefix) if @v1
       (@v2.xpath_prefix = @xpath_prefix) if @v2
     end
+
+    def server_url(surl)
+      @xserver_url = surl.sub(TRAILING_SLASH, '')
+      (@v1.xserver_url = @xserver_url) if @v1
+      (@v2.xserver_url = @xserver_url) if @v2
+    end
+
     # end public API
 
+    def set_uribase
+      @uribase = if @xpath_prefix.empty?
+                   @xserver_url
+                 else
+                   if @xpath_prefix[0] == '/'
+                     @xserver_url + @xpath_prefix
+                   else
+                     @xserver_url + '/' + @xpath_prefix
+                   end
+                 end
+      (@v1.uribase = @uribase) if @v1
+      (@v2.uribase = @uribase) if @v2
+    end
+
     def copy_attribs_to(other)
       other.cmap = @cmap
       other.collections = @collections
+      other.allowed_transitions = @allowed_transitions
       other.xtitle = @xtitle
       other.xname = @xname
       other.xnamespace = @xnamespace
       other.xpath_prefix = @xpath_prefix
+      other.xserver_url = @xserver_url
+      other.uribase = @uribase
       other.meta = ServiceMeta.new(other) # hum ... #todo: versions as well ?
       other.relman = @relman
       other.batch_handler = @batch_handler
       other
     end
 
+    # this is a central place. We extend Sequel models with OData functionality
+    # The included/extended modules depends on the properties(eg, pks, field types) of the model
+    # we differentiate
+    #  * Single/Multi PK
+    #  * Media/Non-Media entity
+    # Putting this logic here in modules loaded once on start shall result in less runtime overhead
     def register_model(modelklass, entity_set_name = nil, is_media = false)
       # check that the provided klass is a Sequel Model
 
@@ -313,10 +344,36 @@ module OData
       # set default path prefix if path_prefix was not called
       path_prefix(DEFAULT_PATH_PREFIX) unless @xpath_prefix
 
+      # set default server url if server_url was not called
+      server_url(DEFAULT_SERVER_URL) unless @xserver_url
+
+      set_uribase
+
       @collections.each(&:finalize_publishing)
 
-      # finalize the media handlers
-      @collections.each { |klass| }
+      # finalize the uri's and include NoMappingBeforeOutput or MappingBeforeOutput as needed
+      @collections.each { |klass|
+        klass.build_uri(@uribase)
+        if klass.time_cols.empty?
+          klass.include OData::NoMappingBeforeOutput
+        else
+          klass.include OData::MappingBeforeOutput
+        end
+      }
+
+      # build allowed transitions (requires that @collections are filled and sorted for having a
+      # correct base_url_regexp)
+      build_allowed_transitions
+
+      # mixin adapter specific modules where needed
+      case Sequel::Model.db.adapter_scheme
+      when :postgres
+        OData::Filter::FuncTree.include OData::Filter::FuncTreePostgres
+      when :sqlite
+        OData::Filter::FuncTree.include OData::Filter::FuncTreeSqlite
+      else
+        OData::Filter::FuncTree.include OData::Filter::FuncTreeDefault
+      end
     end
 
     def execute_deferred_iblocks
@@ -341,7 +398,7 @@ module OData
     def service_xml(req)
       doc = REXML::Document.new
       # separator required ? ?
-      root = doc.add_element('service', 'xml:base' => req.uribase)
+      root = doc.add_element('service', 'xml:base' => @uribase)
 
       root.add_namespace('xmlns:atom', XMLNS::W3_2005_ATOM)
       root.add_namespace('xmlns:app', XMLNS::W3_2007_APP)
@@ -452,15 +509,22 @@ module OData
     # methods related to transitions to next state (cf. walker)
     module Transitions
       DOLLAR_ID_REGEXP = Regexp.new('\A\/\$').freeze
-      def allowed_transitions
-        @allowed_transitions = [
-          Safrano::TransitionEnd,
-          Safrano::TransitionMetadata,
-          Safrano::TransitionBatch,
-          Safrano::TransitionContentId,
+      ALLOWED_TRANSITIONS_FIXED = [
+        Safrano::TransitionEnd,
+        Safrano::TransitionMetadata,
+        Safrano::TransitionBatch,
+        Safrano::TransitionContentId
+      ].freeze
+
+      def build_allowed_transitions
+        @allowed_transitions = (ALLOWED_TRANSITIONS_FIXED + [
           Safrano::Transition.new(%r{\A/(#{base_url_regexp})(.*)},
                                   trans: 'transition_collection')
-        ]
+        ]).freeze
+      end
+
+      def allowed_transitions
+        @allowed_transitions
       end
 
       def transition_collection(match_result)
@@ -507,18 +571,18 @@ module OData
       @data_service_version = '1.0'
     end
 
-    def get_coll_odata_links_h(array:, uribase:, icount: nil)
+    def get_coll_odata_links_h(array:, icount: nil)
       array.map do |w|
-        get_entity_odata_link_h(entity: w, uribase: uribase)
+        get_entity_odata_link_h(entity: w)
       end
     end
 
-    def get_coll_odata_h(array:, template:, uribase:, icount: nil)
-      array.map do |w|
+    def get_coll_odata_h(array:, template:, icount: nil)
+      array.map! do |w|
         get_entity_odata_h(entity: w,
-                           template: template,
-                           uribase: uribase)
+                           template: template)
       end
+      array
     end
 
     def get_emptycoll_odata_h
@@ -532,19 +596,19 @@ module OData
       @data_service_version = '2.0'
     end
 
-    def get_coll_odata_links_h(array:, uribase:, icount: nil)
+    def get_coll_odata_links_h(array:, icount: nil)
       res = array.map do |w|
-        get_entity_odata_link_h(entity: w, uribase: uribase)
+        get_entity_odata_link_h(entity: w)
       end
       if icount
-        { 'results' => res, '__count' => icount }
+        { RESULTS_K => res, COUNT_K => icount }
       else
-        { 'results' => res }
+        { RESULTS_K => res }
       end
     end
 
     def get_emptycoll_odata_h
-      { 'results' => EMPTY_HASH_IN_ARY }
+      { RESULTS_K => EMPTY_HASH_IN_ARY }
     end
   end
 
@@ -555,9 +619,9 @@ module OData
       @service = service
     end
 
+    ALLOWED_TRANSITIONS_FIXED = [Safrano::TransitionEnd].freeze
     def allowed_transitions
-      @allowed_transitions = [Safrano::Transition.new('',
-                                                      trans: 'transition_end')]
+      ALLOWED_TRANSITIONS_FIXED
     end
 
     def transition_end(_match_result)