safrano 0.3.2 → 0.3.3

data/lib/odata/error.rb

@@ -14,6 +14,13 @@ module OData
         super("class #{name} is not a Sequel Model", name)
       end
     end
+    # when published class as media does not have the mandatory media fields
+    class MediaModelError < NameError
+      def initialize(name)
+        super("Model #{name} does not have the mandatory media attributes content_type/media_src", name)
+      end
+    end
+
     # when published association was not defined on Sequel level
     class ModelAssociationNameError < NameError
       def initialize(klass, symb)
@@ -27,13 +34,11 @@ module OData
   # base module for HTTP errors
   module Error
     def odata_get(req)
-      if req.accept?('application/json')
-        [const_get(:HTTP_CODE),
-         { 'Content-Type' => 'application/json;charset=utf-8' },
+      if req.accept?(APPJSON)
+        [const_get(:HTTP_CODE), CT_JSON,
          { 'odata.error' => { 'code' => '', 'message' => @msg } }.to_json]
       else
-        [const_get(:HTTP_CODE),
-         { 'Content-Type' => 'text/plain;charset=utf-8' }, @msg]
+        [const_get(:HTTP_CODE), CT_TEXT, @msg]
       end
     end
   end
@@ -49,6 +54,12 @@ module OData
     @msg = 'Bad Request: Failed changeset '
   end
 
+  # $value request for a non-media entity
+  class BadRequestNonMediaValue < BadRequestError
+    HTTP_CODE = 400
+    @msg = 'Bad Request: $value request for a non-media entity'
+  end
+
   # for Syntax error in Filtering
   class BadRequestFilterParseError < BadRequestError
     HTTP_CODE = 400

data/lib/odata/navigation_attribute.rb

@@ -0,0 +1,119 @@
+require 'json'
+require_relative '../safrano_core.rb'
+require_relative './entity.rb'
+
+module OData
+  # link newly created entities(child) to an existing parent
+  # by following the association_reflection rules
+  def OData.create_nav_relation(child, assoc, parent)
+    return unless assoc
+
+    # Note: this coding shares some bits from our sequel/plugins/join_by_paths,
+    # method build_unique_join_segments
+    # eventually there is an opportunity to have more reusable code here
+    case assoc[:type]
+    when :one_to_many, :one_to_one
+      # sets the FK values in child to corresponding related parent key-values
+      # thus creating the "link" between the new entity and the parent
+      # if a FK value is already set (not nil/NULL) then only check the
+      # consistency with the corresponding parent key-value
+      # If the FK value and the parent key value are different, then it's  a
+      # a Bad Request error
+
+      leftm = assoc[:model] # should be same as parent.class
+      lks = [leftm.primary_key].flatten
+      rks = [assoc[:key]].flatten
+      join_cond = rks.zip(lks).to_h
+      join_cond.each { |rk, lk|
+        if child.values[rk] # FK in new entity from payload not nil, only check consistency
+          # with the parent - id(s)
+          if (child.values[rk] != parent.pk_hash[lk]) # error...
+            # TODO
+          end
+        else # we can set the FK value, thus creating the "link"
+          child.set(rk => parent.pk_hash[lk])
+        end
+      }
+    when :many_to_one
+      # sets the FK values in parent to corresponding related child key-values
+      # thus creating the "link" between the new entity and the parent
+      # Per design, this can only be called when the FK value is nil
+      # from NilNavigationAttribute.odata_post
+      lks = [assoc[:key]].flatten
+      rks = [child.class.primary_key].flatten
+      join_cond = rks.zip(lks).to_h
+      join_cond.each { |rk, lk|
+        if parent.values[lk] # FK in parent not nil, only check consistency
+          # with the child - id(s)
+          if (parent.values[lk] != child.pk_hash[rk]) # error...
+            # TODO
+          end
+        else # we can set the FK value, thus creating the "link"
+          parent.set(lk => child.pk_hash[rk])
+        end
+      }
+    end
+  end
+
+  # Represents a named but nil-valued navigation-attribute of an Entity
+  # (usually resulting from a NULL FK db value)
+  class NilNavigationAttribute
+    attr_reader :name
+    attr_reader :parent
+    def initialize(parent, name)
+      @parent = parent
+      @name = name
+      @navattr_reflection = parent.class.association_reflections[name.to_sym]
+      @klass = @navattr_reflection[:class_name].constantize
+    end
+
+    def odata_get(req)
+      if req.walker.media_value
+        OData::ErrorNotFound.odata_get
+      elsif req.accept?(APPJSON)
+        [200, CT_JSON, to_odata_json(service: req.service)]
+      else # TODO: other formats
+        415
+      end
+    end
+
+    # create the nav. entity
+    def odata_post(req)
+      # delegate to the class method
+      @klass.odata_create_entity_and_relation(req, @navattr_reflection, @parent)
+    end
+
+    # create the nav. entity
+    def odata_put(req)
+      # delegate to the class method
+      @klass.odata_create_entity_and_relation(req, @navattr_reflection, @parent)
+    end
+
+    # empty output as OData json (v2)
+    def to_odata_json(*)
+      { 'd' => {} }.to_json
+    end
+
+    # for testing purpose (assert_equal ...)
+    def ==(other)
+      (@parent == other.parent) && (@name == other.name)
+    end
+
+    # methods related to transitions to next state (cf. walker)
+    module Transitions
+      def transition_end(_match_result)
+        [nil, :end]
+      end
+
+      def transition_value(_match_result)
+        [self, :end_with_value]
+      end
+
+      def allowed_transitions
+        [Safrano::TransitionEnd,
+         Safrano::TransitionValue]
+      end
+    end
+    include Transitions
+  end
+end

data/lib/odata/walker.rb

@@ -21,9 +21,12 @@ module OData
     # is $count requested?
     attr_accessor :do_count
 
-    # is $value requested?
+    # is $value (of attribute) requested?
     attr_reader :raw_value
 
+    # is $value (of media entity) requested?
+    attr_reader :media_value
+
     # are $links requested ?
     attr_reader :do_links
 
@@ -35,9 +38,11 @@ module OData
       @content_id_refs = content_id_refs
 
       @contexts = [@context]
+
       @path_start = @path_remain = if service
                                      unprefixed(service.xpath_prefix, path)
                                    else # This is for batch function
+
                                      path
                                    end
       @path_done = ''
@@ -51,7 +56,9 @@ module OData
       if (prefix == '') || (prefix == '/')
         path
       else
-        path.sub!(/\A#{prefix}/, '')
+        #        path.sub!(/\A#{prefix}/, '')
+        # TODO check
+        path.sub(/\A#{prefix}/, '')
       end
     end
 
@@ -107,6 +114,9 @@ module OData
       when :end_with_value
         @raw_value = true
         @status = :end
+      when :end_with_media_value
+        @media_value = true
+        @status = :end
       when :run_with_links
         @do_links = true
         @status = :run

data/lib/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

@@ -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, {}, ['']]
     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

data/lib/request.rb

@@ -10,6 +10,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 +95,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,13 +133,24 @@ 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, filename
+
+      else
+        ON_CGST_ERROR.call(self)
+        return [400, {}, ['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
+          ON_CGST_ERROR.call(self)
           return [400, {}, ['JSON Parser Error while parsing payload : ',
                             e.message]]
         end

data/lib/safrano.rb

@@ -6,6 +6,7 @@ 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'

data/lib/safrano_core.rb

@@ -5,10 +5,11 @@ module OData
   # some prominent constants... probably already defined elsewhere eg in Rack
   # but lets KISS
   CONTENT_TYPE = 'Content-Type'.freeze
+  CTT_TYPE_LC = 'content-type'.freeze
   TEXTPLAIN_UTF8 = 'text/plain;charset=utf-8'.freeze
   APPJSON = 'application/json'.freeze
   APPXML = 'application/xml'.freeze
-
+  MP_MIXED = 'multipart/mixed'.freeze
   APPXML_UTF8 = 'application/xml;charset=utf-8'.freeze
   APPATOMXML_UTF8 = 'application/atomsvc+xml;charset=utf-8'.freeze
   APPJSON_UTF8 = 'application/json;charset=utf-8'.freeze

data/lib/service.rb

@@ -103,12 +103,9 @@ module OData
     end
 
     def get_entity_odata_h(entity:, expand: nil, uribase:)
-      hres = {}
+      hres = entity.casted_values
       hres['__metadata'] = entity.metadata_h(uribase: uribase)
 
-      #      hres.merge!(entity.values)
-      hres.merge!(entity.casted_values)
-
       nav_values_h = {}
       nav_coll_h = {}
 
@@ -203,6 +200,7 @@ module OData
 
     DATASERVICEVERSION_RGX = /\A([1234])(?:\.0);*\w*\z/.freeze
     TRAILING_SLASH = %r{/\z}.freeze
+    DEFAULT_PATH_PREFIX = '/'
 
     # input is the       DataServiceVersion request header string, eg.
     # '2.0;blabla' ---> Version -> 2
@@ -260,18 +258,38 @@ 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)
-        modelklass.extend OData::EntityClassMultiPK
-        modelklass.include OData::EntityMultiPK
+      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
+      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::EntityClassSinglePK
-        modelklass.include OData::EntitySinglePK
+        modelklass.extend OData::EntityClassNonMedia
+        modelklass.include OData::NonMediaEntity
       end
 
       modelklass.prepare_pk
@@ -290,6 +308,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)
@@ -319,6 +345,9 @@ module OData
       # now that we know all model klasses we can handle relationships
       execute_deferred_iblocks
 
+      # 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)
     end
@@ -497,7 +526,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
@@ -570,7 +599,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

data/lib/version.rb

@@ -0,0 +1,4 @@
+
+module Safrano
+  VERSION = '0.3.3'
+end