safrano 0.3.2 → 0.4.2

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

@@ -7,7 +7,7 @@ module Rack
     # used
     class Builder < ::Rack::Builder
       def initialize(default_app = nil, &block)
-        super(default_app)
+        super(default_app) {}
         use ::Rack::Cors
         instance_eval(&block) if block_given?
         use ::Rack::Lint

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
@@ -26,12 +26,7 @@ module OData
       return @walker.error.odata_get(@request) unless @walker.error.nil?
 
       # this is too critical; raise a real Exception
-      #        begin
       raise 'Walker construction failed with a unknown Error '
-      #        rescue StandardError
-      #          binding.pry
-      #        end
-      #        [500, {}, 'Server Error']
     end
 
     def odata_delete
@@ -42,6 +37,14 @@ module OData
       end
     end
 
+    def odata_put
+      if @walker.status == :end
+        @walker.end_context.odata_put(@request)
+      else
+        odata_error
+      end
+    end
+
     def odata_patch
       if @walker.status == :end
         @walker.end_context.odata_patch(@request)
@@ -67,7 +70,7 @@ module OData
     end
 
     def odata_head
-      [200, {}, '']
+      [200, EMPTY_HASH, [EMPTY_STRING]]
     end
   end
 
@@ -105,7 +108,9 @@ module OData
         odata_delete
       when 'OPTIONS'
         odata_options
-      when 'PATCH', 'PUT', 'MERGE'
+      when 'PUT'
+        odata_put
+      when 'PATCH', 'MERGE'
         odata_patch
       else
         raise Error
@@ -114,7 +119,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

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
@@ -10,6 +9,7 @@ module OData
     HEADER_PARAM = /\s*[\w.]+=(?:[\w.]+|"(?:[^"\\]|\\.)*")?\s*/.freeze
     HEADER_VAL_RAW = '(?:\w+|\*)\/(?:\w+(?:\.|\-|\+)?|\*)*'.freeze
     HEADER_VAL_WITH_PAR = /(?:#{HEADER_VAL_RAW})\s*(?:;#{HEADER_PARAM})*/.freeze
+    ON_CGST_ERROR = (proc { |r| raise(Sequel::Rollback) if r.in_changeset })
 
     # borowed from Sinatra
     class AcceptEntry
@@ -94,7 +94,7 @@ module OData
     end
 
     def create_odata_walker
-      @walker = Walker.new(@service, path_info, @content_id_references)
+      @env['safrano.walker'] = @walker = Walker.new(@service, path_info, @content_id_references)
     end
 
     def accept
@@ -132,22 +132,35 @@ module OData
       end
     end
 
-    def with_parsed_data(on_error: nil)
+    def with_media_data
+      if (filename = @env['HTTP_SLUG'])
+
+        yield @env['rack.input'],
+               content_type.split(';').first,
+               Rfc2047.decode(filename)
+
+      else
+        ON_CGST_ERROR.call(self)
+        [400, EMPTY_HASH, ['File upload error: Missing SLUG']]
+      end
+    end
+
+    def with_parsed_data
       if content_type == APPJSON
         # Parse json payload
         begin
           data = JSON.parse(body.read)
         rescue JSON::ParserError => e
-          on_error.call if on_error
-          return [400, {}, ['JSON Parser Error while parsing payload : ',
-                            e.message]]
+          ON_CGST_ERROR.call(self)
+          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,5 +1,3 @@
-#!/usr/bin/env ruby
-
 require 'rexml/document'
 require 'odata/relations.rb'
 require 'odata/batch.rb'
@@ -23,20 +21,22 @@ 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)
+    def get_coll_odata_h(array:, template:, uribase:, icount: nil)
       res = array.map do |w|
         get_entity_odata_h(entity: w,
-                           expand: expand,
+                           template: template,
                            uribase: uribase)
       end
       if icount
@@ -46,89 +46,55 @@ module OData
       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)
-      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 = {}
-      hres['__metadata'] = entity.metadata_h(uribase: uribase)
+    EMPTYH = {}.freeze
+    def get_entity_odata_h(entity:, template:, uribase:)
+      # start with metadata
+      hres = { '__metadata' => entity.metadata_h(uribase: uribase) }
 
-      #      hres.merge!(entity.values)
-      hres.merge!(entity.casted_values)
+      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
 
-      nav_values_h = {}
-      nav_coll_h = {}
+          arg.each do |attr, templ|
+            enval = entity.send(attr)
+            hres[attr] = if enval
 
-      # 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)
+                           get_entity_odata_h(entity: enval,
+                                              template: templ,
+                                              uribase: uribase)
+                         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))
+
+            #  nav attributes that are a collection (x..n)
+            hres[attr] = get_coll_odata_h(array: encoll,
+                                          template: templ,
+                                          uribase: uribase)
+            # else error ?
+          end
+        when :deferr
+          arg.each do |attr|
+            hres[attr] = get_deferred_odata_h(entity: entity,
+                                              attrib: attr,
+                                              uribase: uribase)
+          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
@@ -203,6 +169,7 @@ module OData
 
     DATASERVICEVERSION_RGX = /\A([1234])(?:\.0);*\w*\z/.freeze
     TRAILING_SLASH = %r{/\z}.freeze
+    DEFAULT_PATH_PREFIX = '/'.freeze
 
     # input is the       DataServiceVersion request header string, eg.
     # '2.0;blabla' ---> Version -> 2
@@ -260,19 +227,36 @@ module OData
       other
     end
 
-    def register_model(modelklass, entity_set_name = nil)
+    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
 
-      if modelklass.primary_key.is_a?(Array)
+      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
+      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
+        modelklass.extend OData::EntityClassMedia
+        # set default media handler . Can be overridden later with the
+        #  "use HandlerKlass, options" API
+
+        modelklass.set_default_media_handler
+        modelklass.api_check_media_fields
+        modelklass.include OData::MediaEntity
+      else
+        modelklass.extend OData::EntityClassNonMedia
+        modelklass.include OData::NonMediaEntity
+      end
 
       modelklass.prepare_pk
       modelklass.prepare_fields
@@ -290,6 +274,14 @@ module OData
       modelklass.deferred_iblock = block if block_given?
     end
 
+    def publish_media_model(modelklass, entity_set_name = nil, &block)
+      register_model(modelklass, entity_set_name, true)
+      # we need to execute the passed block in a deferred step
+      # after all models have been registered (due to rel. dependancies)
+      #      modelklass.instance_eval(&block) if block_given?
+      modelklass.deferred_iblock = block if block_given?
+    end
+
     def cmap=(imap)
       @cmap = imap
       set_collections_sorted(@cmap.values)
@@ -300,15 +292,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 = {}
@@ -319,8 +310,13 @@ module OData
       # now that we know all model klasses we can handle relationships
       execute_deferred_iblocks
 
-      # and finally build the path list
-      @collections.each(&:build_attribute_path_list)
+      # set default path prefix if path_prefix was not called
+      path_prefix(DEFAULT_PATH_PREFIX) unless @xpath_prefix
+
+      @collections.each(&:finalize_publishing)
+
+      # finalize the media handlers
+      @collections.each { |klass| }
     end
 
     def execute_deferred_iblocks
@@ -368,7 +364,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
 
@@ -497,7 +493,7 @@ module OData
         # Documents MUST be
         # identified with the "application/atomsvc+xml" media type (see
         # [RFC5023] section 8).
-        [200, CT_ATOMXML, service_xml(req)]
+        [200, CT_ATOMXML, [service_xml(req)]]
       else
         # this is returned by http://services.odata.org/V2/OData/OData.svc
         415
@@ -517,16 +513,16 @@ module OData
       end
     end
 
-    def get_coll_odata_h(array:, expand: nil, uribase:, icount: nil)
+    def get_coll_odata_h(array:, template:, uribase:, icount: nil)
       array.map do |w|
         get_entity_odata_h(entity: w,
-                           expand: expand,
+                           template: template,
                            uribase: uribase)
       end
     end
 
     def get_emptycoll_odata_h
-      [{}]
+      EMPTY_HASH_IN_ARY
     end
   end
 
@@ -548,7 +544,7 @@ module OData
     end
 
     def get_emptycoll_odata_h
-      { 'results' => [{}] }
+      { 'results' => EMPTY_HASH_IN_ARY }
     end
   end
 
@@ -570,7 +566,7 @@ module OData
 
     def odata_get(req)
       if req.accept?(APPXML)
-        [200, CT_APPXML, @service.metadata_xml(req)]
+        [200, CT_APPXML, [@service.metadata_xml(req)]]
       else
         415
       end