safrano 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f2ebcbe8cf374526aa263f93515e2424753898ad878904d6d5d087bc6317c4e
-  data.tar.gz: 48190a71451991630bd48347c3cf2acb701423bb58266fa736b0cf7a5b6f3bdf
+  metadata.gz: 37c9ae21ef2d9a7cd8cc216719fcebc353a2588c2c2c9947b2490b7f7efa4e37
+  data.tar.gz: 3fa80a8985eee84c193783c4202efdb41aa64e77c173dc3a969164bdc5d0e832
 SHA512:
-  metadata.gz: 70ef7d275b566269879e4cd37f019958cd354504d1dede907adcf4d078e47361412997c69eec2c403317013ef5ac8019315aeb8cc89715906f2f12bd59e885dc
-  data.tar.gz: 1ff899294284a5e9531187533938e14ae304c1344131177dff1612037ca32e6a27dfcd72b367dd705afbb5cd5b9d38e9c11dc7b8f7766d470c2ac4c45686372b
+  metadata.gz: f17f10577a0296d0077e16271f4ebd5db84cafaf72a6c01ea445045e9be92b4d3d07b25a51e72d4174d4aa3ecc9d1aee92987ebbb46b7d2037ceb8843631876e
+  data.tar.gz: 68ce7bbad19ae58dcc96e9aa84db0eefb56f5e1f5ff8b02fbb3ae1d562362f29b08616b239a5adf6dfb768ce8da58d503a8a330095420d1c762bafe212a1b83a

data/lib/odata/collection_media.rb

@@ -8,6 +8,11 @@ module Safrano
   module Media
     # base class for Media Handler
     class Handler
+      def check_before_create(data:,
+                              entity:,
+                              filename:)
+        Contract::OK
+      end
     end
 
     # Simple static File/Directory based media store handler
@@ -54,13 +59,13 @@ module Safrano
       end
 
       # relative to @root
-      # eg Photo/1/pommes-topaz.jpg
+      # eg Photo/1/1
       def filename(entity)
         Dir.chdir(abs_path(entity)) do
           # simple design: one file per directory, and the directory
           # contains the media entity-id --> implicit link between the media
           # entity
-          File.join(media_path(entity), Dir.glob('*').min)
+          File.join(media_path(entity), Dir.glob('*').max)
         end
       end
 
@@ -147,15 +152,14 @@ module Safrano
 
       # this is relative to abs_klass_dir(entity) eg to /@root/Photo
       # tree-structure
-      #  media_path_ids = 1  -->  1
-      #  media_path_ids = 15  -->  1/5
-      #  media_path_ids = 555  -->  5/5/5
-      #  media_path_ids = 5,5,5  -->  5/00/5/00/5
-      #  media_path_ids = 5,00,5  -->  5/00/0/0/00/5
-      #  media_path_ids = 5,xyz,5  -->  5/00/x/y/z/00/5
+      #  media_path_ids = 1  -->  1/v
+      #  media_path_ids = 15  -->  1/5/v
+      #  media_path_ids = 555  -->  5/5/5/v
+      #  media_path_ids = 5,5,5  -->  5/00/5/00/5/v
+      #  media_path_ids = 5,00,5  -->  5/00/0/0/00/5/v
+      #  media_path_ids = 5,xyz,5  -->  5/00/x/y/z/00/5/v
       def media_directory(entity)
         StaticTree.path_builder(entity.media_path_ids)
-        #        entity.media_path_ids.map{|id| id.to_s.chars.join('/')}.join(@sep)
       end
 
       def in_media_directory(entity)
@@ -267,29 +271,39 @@ module Safrano
                                   missing: :skip)
           end
 
-          # to_one rels are create with FK data set on the parent entity
-          if parent
-            odata_create_save_entity_and_rel(req, new_entity, assoc, parent)
-          else
-            # in-changeset requests get their own transaction
-            new_entity.save(transaction: !req.in_changeset)
-          end
+          # call before_create_entity media hook
+          new_entity.before_create_media_entity(data: data, mimetype: mimetype) if new_entity.respond_to? :before_create_media_entity
+
+          media_handler.check_before_create(data: data,
+                                            entity: new_entity,
+                                            filename: filename).if_valid { |_ret|
+            # to_one rels are create with FK data set on the parent entity
+            if parent
+              odata_create_save_entity_and_rel(req, new_entity, assoc, parent)
+            else
+              # in-changeset requests get their own transaction
+              new_entity.save(transaction: !req.in_changeset)
+            end
+
+            req.register_content_id_ref(new_entity)
+            new_entity.copy_request_infos(req)
 
-          req.register_content_id_ref(new_entity)
-          new_entity.copy_request_infos(req)
+            # call before_create_media hook
+            new_entity.before_create_media if new_entity.respond_to? :before_create_media
 
-          # call before_create_media hook
-          new_entity.before_create_media if new_entity.respond_to? :before_create_media
+            media_handler.save_file(data: data,
+                                    entity: new_entity,
+                                    filename: filename)
 
-          media_handler.save_file(data: data,
-                                  entity: new_entity,
-                                  filename: filename)
+            # call after_create_media hook
+            new_entity.after_create_media if new_entity.respond_to? :after_create_media
 
-          # call after_create_media hook
-          new_entity.after_create_media if new_entity.respond_to? :after_create_media
+            # json is default content type so we dont need to specify it here again
+            #           Contract.valid([201, EMPTY_HASH, new_entity.to_odata_post_json(service: req.service)])
+            # TODO quirks array mode !
+            Contract.valid([201, EMPTY_HASH, new_entity.to_odata_create_json(request: req)])
+          }.tap_error { |e| return e.odata_get(req) }.result
 
-          # json is default content type so we dont need to specify it here again
-          [201, EMPTY_HASH, new_entity.to_odata_post_json(service: req.service)]
         else # TODO: other formats
           415
         end

data/lib/odata/entity.rb

@@ -112,10 +112,11 @@ module Safrano
       selvals
     end
 
-    # post paylod expects the new entity in an array
-    def to_odata_post_json(service:)
-      innerj = service.get_coll_odata_h(array: [self],
-                                        template: self.class.default_template).to_json
+    # some clients wrongly expect post payload with the new entity in an array
+    # TODO quirks array mode !
+    def to_odata_array_json(request:)
+      innerj = request.service.get_coll_odata_h(array: [self],
+                                                template: self.class.default_template).to_json
       "#{DJ_OPEN}#{innerj}#{DJ_CLOSE}"
     end
 
@@ -263,6 +264,7 @@ module Safrano
       ret
     end
   end
+
   # end of module SafranoEntity
   module Entity
     include EntityBase
@@ -438,5 +440,22 @@ module Safrano
       pk_hash.values
     end
   end
-end
-# end of Module OData
+
+  module EntityCreateStandardOutput
+    # Json formatter for a create  entity POST call / Standard version; return as json object
+    def to_odata_create_json(request:)
+      # TODO Perf: reduce method call overhead
+      # we added this redirection for readability and flexibility
+      to_odata_json(request: request)
+    end
+  end
+
+  module EntityCreateArrayOutput
+    # Json formatter for a create  entity POST call Array version
+    def to_odata_create_json(request:)
+      # TODO Perf: reduce method call overhead
+      # we added this redirection for readability and flexibility
+      to_odata_array_json(request: request)
+    end
+  end
+end # end of Module OData

data/lib/odata/error.rb

@@ -114,6 +114,18 @@ module Safrano
     end
   end
 
+  # http Unprocessable Entity for example when trying to
+  # upload duplicated media ressource
+  class UnprocessableEntityError
+    extend  ErrorClass
+    include ErrorInstance
+    HTTP_CODE = 422
+    @msg = 'Unprocessable Entity'
+    def initialize(reason)
+      @msg = reason
+    end
+  end
+
   # http Bad Req.
   class BadRequestError
     extend  ErrorClass
@@ -125,6 +137,13 @@ module Safrano
     end
   end
 
+  # for upload empty media
+  class BadRequestEmptyMediaUpload < BadRequestError
+    include ErrorInstance
+    def initialize( path )
+      @msg = "Bad Request: empty media file #{path}"
+    end
+  end
   # Generic failed changeset
   class BadRequestFailedChangeSet < BadRequestError
     @msg = 'Bad Request: Failed changeset '

data/lib/odata/model_ext.rb

@@ -627,7 +627,9 @@ module Safrano
           req.register_content_id_ref(new_entity)
           new_entity.copy_request_infos(req)
           # json is default content type so we dont need to specify it here again
-          [201, EMPTY_HASH, new_entity.to_odata_post_json(service: req.service)]
+          # TODO quirks array mode !
+          # [201, EMPTY_HASH, new_entity.to_odata_post_json(service: req.service)]
+          [201, EMPTY_HASH, new_entity.to_odata_create_json(request: req)]
         else # TODO: other formats
           415
         end

data/lib/safrano/service.rb

@@ -204,6 +204,12 @@ module Safrano
       (@v2.xserver_url = @xserver_url) if @v2
     end
 
+    # keep the bug active for now, but allow to activate the fix,
+    # later we will change the default to be fixed
+    def bugfix_create_response(bool = false)
+      @bugfix_create_response = bool
+    end
+
     # end public API
 
     def set_uribase
@@ -361,6 +367,9 @@ module Safrano
       @collections.each do |klass|
         klass.build_uri(@uribase)
         klass.include(klass.time_cols.empty? ? Safrano::NoMappingBeforeOutput : Safrano::MappingBeforeOutput)
+
+        # Output create (POST) as single entity (Standard) or as array (non-standard buggy)
+        klass.include ( @bugfix_create_response ? Safrano::EntityCreateStandardOutput : Safrano::EntityCreateArrayOutput)
       end
 
       # build allowed transitions (requires that @collections are filled and sorted for having a

data/lib/safrano/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Safrano
-  VERSION = '0.4.5' 
+  VERSION = '0.4.6'  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safrano
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - oz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-27 00:00:00.000000000 Z
+date: 2021-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -108,7 +108,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.51'
-description: Safrano is an OData server library based on Ruby, Rack and Sequel.
+description: Safrano is an OData server library based on Ruby Sequel and Rack.
 email: dev@aithscel.eu
 executables: []
 extensions: []
@@ -189,8 +189,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.2
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
-summary: Safrano is a Ruby OData server library based on Sequel and Rack
+summary: Safrano is an OData server library based on Ruby Sequel and Rack
 test_files: []