safrano 0.3.3 → 0.4.3

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

@@ -1,6 +1,5 @@
-#!/usr/bin/env ruby
-
 require 'rack'
+require 'rfc2047'
 
 module OData
   # monkey patch deactivate Rack/multipart because it does not work on simple
@@ -109,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
@@ -136,11 +128,13 @@ module OData
     def with_media_data
       if (filename = @env['HTTP_SLUG'])
 
-        yield @env['rack.input'], content_type.split(';').first, filename
+        yield @env['rack.input'],
+               content_type.split(';').first,
+               Rfc2047.decode(filename)
 
       else
         ON_CGST_ERROR.call(self)
-        return [400, {}, ['File upload error: Missing SLUG']]
+        [400, EMPTY_HASH, ['File upload error: Missing SLUG']]
       end
     end
 
@@ -151,15 +145,15 @@ module OData
           data = JSON.parse(body.read)
         rescue JSON::ParserError => e
           ON_CGST_ERROR.call(self)
-          return [400, {}, ['JSON Parser Error while parsing payload : ',
-                            e.message]]
+          return [400, EMPTY_HASH, ['JSON Parser Error while parsing payload : ',
+                                    e.message]]
         end
 
         yield data
 
       else # TODO: other formats
 
-        [415, {}, []]
+        [415, EMPTY_HASH, EMPTY_ARRAY]
       end
     end
 

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

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 require 'rack'
 
 # monkey patch deactivate Rack/multipart because it does not work on simple
@@ -35,7 +34,7 @@ module OData
 
       if drop_body?
         close
-        result = []
+        result = EMPTY_ARRAY
       end
 
       if calculate_content_length?

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

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require_relative './sequel/plugins/join_by_paths.rb'
+require_relative '../sequel/plugins/join_by_paths.rb'
 
 Sequel::Model.plugin Sequel::Plugins::JoinByPaths

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

@@ -1,17 +1,19 @@
-#!/usr/bin/env ruby
-
 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
@@ -23,109 +25,75 @@ module OData
         # TODO: check errorhandling
         raise OData::ServerError if cur_exp.nil?
 
-        k = cur_exp.to_sym
+        k_s = cur_exp
+
       else
-        k = exp_one.strip.to_sym
+        k_s = exp_one.strip
         rest_exp = nil
       end
-      yield k, rest_exp
+      k = k_s.to_sym
+      yield k, k_s, rest_exp
     end
 
     # default v2
     # overriden in ServiceV1
-    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)
+    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 }
-      end
-    end
-
-    # handle a single expand
-    def handle_entity_expand_one(entity:, exp_one:, nav_values_h:, nav_coll_h:,
-                                 uribase:)
-
-      split_entity_expand_arg(exp_one) do |first, rest_exp|
-        if (enval = entity.nav_values[first])
-          nav_values_h[first.to_s] = get_entity_odata_h(entity: enval,
-                                                        expand: rest_exp,
-                                                        uribase: uribase)
-        elsif (encoll = entity.nav_coll[first])
-          # nav attributes that are a collection (x..n)
-          nav_coll_h[first.to_s] = get_coll_odata_h(array: encoll,
-                                                    expand: rest_exp,
-                                                    uribase: uribase)
-
-        end
-      end
-    end
-
-    def handle_entity_expand(entity:, expand:, nav_values_h:,
-                             nav_coll_h:, uribase:)
-      expand.strip!
-      explist = expand.split(',')
-      # handle multiple expands
-      explist.each do |exp|
-        handle_entity_expand_one(entity: entity, exp_one: exp,
-                                 nav_values_h: nav_values_h,
-                                 nav_coll_h: nav_coll_h,
-                                 uribase: uribase)
-      end
-    end
-
-    def handle_entity_deferred_attribs(entity:, nav_values_h:,
-                                       nav_coll_h:, uribase:)
-      entity.nav_values.each_key do |ksy|
-        ks = ksy.to_s
-        next if nav_values_h.key?(ks)
-
-        nav_values_h[ks] = get_deferred_odata_h(entity: entity,
-                                                attrib: ks, uribase: uribase)
-      end
-      entity.nav_coll.each_key do |ksy|
-        ks = ksy.to_s
-        next if nav_coll_h.key?(ks)
-
-        nav_coll_h[ks] = get_deferred_odata_h(entity: entity, attrib: ks,
-                                              uribase: uribase)
+        { 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) }
-    end
-
-    def get_entity_odata_h(entity:, expand: nil, uribase:)
-      hres = entity.casted_values
-      hres['__metadata'] = entity.metadata_h(uribase: uribase)
-
-      nav_values_h = {}
-      nav_coll_h = {}
+    def get_entity_odata_link_h(entity:)
+      { uri: entity.uri }
+    end
+
+    EMPTYH = {}.freeze
+    METADATA_K = '__metadata'.freeze
+    def get_entity_odata_h(entity:, template:)
+      # start with metadata
+      hres = { METADATA_K => entity.metadata_h }
+
+      template.each do |elmt, arg|
+        case elmt
+        when :all_values
+          hres.merge! entity.casted_values
+        when :selected_vals
+          hres.merge! entity.casted_values(arg)
+        when :expand_e
+
+          arg.each do |attr, templ|
+            enval = entity.send(attr)
+            hres[attr] = if enval
+                           get_entity_odata_h(entity: enval, template: templ)
+                         else
+                           # FK is NULL --> nav_value is nil --> return empty json
+                           EMPTYH
+                         end
+          end
+        when :expand_c
+          arg.each do |attr, templ|
+            next unless  (encoll = entity.send(attr))
 
-      # handle expanded nav attributes
-      unless expand.nil?
-        handle_entity_expand(entity: entity, expand: expand,
-                             nav_values_h: nav_values_h,
-                             nav_coll_h: nav_coll_h,
-                             uribase: uribase)
+            #  nav attributes that are a collection (x..n)
+            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_uri: euri, attrib: attr)
+          end
+        end
       end
-
-      # handle not expanded (deferred) nav attributes
-      handle_entity_deferred_attribs(entity: entity,
-                                     nav_values_h: nav_values_h,
-                                     nav_coll_h: nav_coll_h,
-                                     uribase: uribase)
-      # merge  ...
-      hres.merge!(nav_values_h)
-      hres.merge!(nav_coll_h)
-
       hres
     end
   end
@@ -175,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
@@ -200,7 +169,8 @@ module OData
 
     DATASERVICEVERSION_RGX = /\A([1234])(?:\.0);*\w*\z/.freeze
     TRAILING_SLASH = %r{/\z}.freeze
-    DEFAULT_PATH_PREFIX = '/'
+    DEFAULT_PATH_PREFIX = '/'.freeze
+    DEFAULT_SERVER_URL = 'http://localhost:9494'
 
     # input is the       DataServiceVersion request header string, eg.
     # '2.0;blabla' ---> Version -> 2
@@ -243,40 +213,67 @@ 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
-      unless modelklass.is_a? Sequel::Model::ClassMethods
-        raise OData::API::ModelNameError, modelklass
-      end
+
+      raise(OData::API::ModelNameError, modelklass) unless modelklass.is_a? Sequel::Model::ClassMethods
 
       if modelklass.ancestors.include? OData::Entity
         # modules were already added previously;
         # cleanup state to avoid having data from previous calls
         # mostly usefull for testing (eg API)
         modelklass.reset
-      else # first API call... (normal non-testing case)
-        if modelklass.primary_key.is_a?(Array)
-          modelklass.extend OData::EntityClassMultiPK
-          modelklass.include OData::EntityMultiPK
-        else
-          modelklass.extend OData::EntityClassSinglePK
-          modelklass.include OData::EntitySinglePK
-        end
+      elsif modelklass.primary_key.is_a?(Array) # first API call... (normal non-testing case)
+        modelklass.extend OData::EntityClassMultiPK
+        modelklass.include OData::EntityMultiPK
+      else
+        modelklass.extend OData::EntityClassSinglePK
+        modelklass.include OData::EntitySinglePK
       end
       # Media/Non-media
       if is_media
@@ -326,15 +323,14 @@ module OData
     # example: CrewMember must be matched before Crew otherwise we get error
     def set_collections_sorted(coll_data)
       @collections = coll_data
-      if @collections
-        @collections.sort_by! { |klass| klass.entity_set_name.size }.reverse!
-      end
+      @collections.sort_by! { |klass| klass.entity_set_name.size }.reverse! if @collections
       @collections
     end
 
     # to be called at end of publishing block to ensure we get the right names
     # and additionally build the list of valid attribute path's used
     # for validation of $orderby or $filter params
+
     def finalize_publishing
       # build the cmap
       @cmap = {}
@@ -348,8 +344,36 @@ module OData
       # set default path prefix if path_prefix was not called
       path_prefix(DEFAULT_PATH_PREFIX) unless @xpath_prefix
 
-      # and finally build the path list
-      @collections.each(&:build_attribute_path_list)
+      # 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 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
@@ -374,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)
@@ -397,7 +421,7 @@ module OData
     def add_metadata_xml_entity_type(schema)
       @collections.each do |klass|
         enty = klass.add_metadata_rexml(schema)
-        klass.add_metadata_navs_rexml(enty, @cmap, @relman, @xnamespace)
+        klass.add_metadata_navs_rexml(enty, @relman, @xnamespace)
       end
     end
 
@@ -485,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)
@@ -540,22 +571,22 @@ 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:, expand: nil, 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,
-                           expand: expand,
-                           uribase: uribase)
+                           template: template)
       end
+      array
     end
 
     def get_emptycoll_odata_h
-      [{}]
+      EMPTY_HASH_IN_ARY
     end
   end
 
@@ -565,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' => [{}] }
+      { RESULTS_K => EMPTY_HASH_IN_ARY }
     end
   end
 
@@ -588,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)