safrano 0.6.7 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a93263d81a1f266029f7aac03d6b7226477f10d27d33255462e08133955ab759
-  data.tar.gz: 894a0bfab2eeeee57543bee7dd0c1ec93b5bc73e0afc6fe5f979c7b7e7067039
+  metadata.gz: dda061616194242041f7308c791bc5689fabaf0627f6f5090df3141fe5a34d8e
+  data.tar.gz: bec6791bb225330e1e149bf4166012397f9ffce9df2dbe0be3d7b224c5172212
 SHA512:
-  metadata.gz: f0900d4f692a9139226d4fb84703f8a0c47a071b97b0a46c8455016f6a7d0d09caf2b12f32e616c9880a10a0b50e09917ca22afc4af7fc0f4cddac690193b25c
-  data.tar.gz: 30a623f667830e0dc4342bcf240843d313173ef12c0e877dc1814e779fc7f53459e7ec7e958aedd22b4387c9390907844a0c2c84a639db8d98dc62805203a671
+  metadata.gz: 7aef08bdf67609d7e836b955e478f4b0a8cd67a08fc6caf0c9e9b263bac3d59086a6da59967cdacf5b3bb328060cbb20b9cdbe70e28fcacb5ce464e63eeb7e59
+  data.tar.gz: 2f65e93d591fc18ca7836a17c61250bc181c1d9aff14bd875e2d2f4803406ca76d577c6cd4c0b5f7e468240ac6d63e9389f7367a5b6cba6bfa298c4c5efd5fcd

data/lib/core_ext/DateTime/format.rb

@@ -49,7 +49,7 @@ module Safrano
           else
             # same as above with GMT offset in minutes
             # DateTime offset is Rational ; fraction of hours per Day --> *24*60
-            min_off_s = (min_off = (offset * 60 * 24).to_i) > 0 ? "+#{min_off}" : min_off.to_s
+            min_off_s = (min_off = (offset * 60 * 24).to_i).positive? ? "+#{min_off}" : min_off.to_s
             "/Date(#{strftime('%Q')}#{min_off_s})/"
           end
         end

data/lib/core_ext/Time/format.rb

@@ -57,7 +57,7 @@ module Safrano
         # the json raw data is like this :   "HireDate": "\/Date(704678400000)\/"
         # --> \/\/
         def to_edm_json
-          if utc? || (gmt_offset == 0)
+          if utc? || gmt_offset.zero?
             # no offset
             # %s : seconds since unix epoch
             # %L : milliseconds 000-999
@@ -66,7 +66,7 @@ module Safrano
           else
             # same as above with GMT offset in minutes
 
-            min_off_s = (min_off = gmt_offset / 60) > 0 ? "+#{min_off}" : min_off.to_s
+            min_off_s = (min_off = gmt_offset / 60).positive? ? "+#{min_off}" : min_off.to_s
             "/Date(#{strftime('%s%L')}#{min_off_s})/"
           end
         end

data/lib/odata/batch.rb

@@ -8,54 +8,63 @@ require_relative './common_logger'
 module Safrano
   # Support for OData multipart $batch Requests
   class Request
-    def create_batch_app
-      Batch::MyOApp.new(self)
-    end
-
     def parse_multipart
       @mimep = MIME::Media::Parser.new
       @boundary = media_type_params['boundary']
       @mimep.hook_multipart(media_type, @boundary)
       @mimep.parse_str(body)
     end
+
+    # The top-level (full_req) Request is used like
+    # a Rack App
+    # With this method we get the response of part-requests
+    # app.call(env)  --> full_req.bach_call(part_req)
+
+    def batch_call(part_req)
+      Safrano::Batch::PartRequest.new(part_req, self).process
+    end
+
+    # needed for changeset transaction
+    def db
+      @service.collections.first.db
+    end
   end
 
   module Batch
-    # Mayonaise
-    class MyOApp < Safrano::ServerApp
-      attr_reader :full_req
-      attr_reader :response
-      attr_reader :db
-
-      def initialize(full_req)
+    # Part-Request part of a Batch-Request
+    class PartRequest < Safrano::Request
+      def initialize(part_req, full_req)
+        batch_env(part_req, full_req)
+        @env['HTTP_HOST'] = full_req.env['HTTP_HOST']
+        super(@env, full_req.service_base)
         @full_req = full_req
-        @db = full_req.service.collections.first.db
+        @part_req = part_req
       end
 
       # redefined for $batch
       def before
         headers 'Cache-Control' => 'no-cache'
-        @request.service = @full_req.service
-        headers 'DataServiceVersion' => @request.service.data_service_version
+        @service = @full_req.service
+        headers 'DataServiceVersion' => @service.data_service_version
       end
 
-      def batch_call(part_req)
-        env = batch_env(part_req)
-        env['HTTP_HOST'] = @full_req.env['HTTP_HOST']
+      def process
         began_at = Rack::Utils.clock_time
-        @request = Safrano::Request.new(env)
+
         @response = Safrano::Response.new
 
-        if part_req.level == 2
-          @request.in_changeset = true
-          @request.content_id = part_req.content_id
-          @request.content_id_references = part_req.content_id_references
+        if @part_req.level == 2
+          @in_changeset = true
+          @content_id = @part_req.content_id
+          @content_id_references = @part_req.content_id_references
         end
 
         before
+
         dispatch
 
         status, header, body = @response.finish
+
         # Logging of sub-requests with ODataCommonLogger.
         # A bit hacky but working
         # TODO: test ?
@@ -80,19 +89,19 @@ module Safrano
         converted_headers
       end
 
-      def batch_env(mime_req)
+      def batch_env(mime_req, full_req)
         @env = ::Rack::MockRequest.env_for(mime_req.uri,
                                            method: mime_req.http_method,
                                            input: mime_req.content)
         # Logging of sub-requests
-        @env[Rack::RACK_ERRORS] = @full_req.env[Rack::RACK_ERRORS]
+        @env[Rack::RACK_ERRORS] = full_req.env[Rack::RACK_ERRORS]
         @env.merge! headers_for_env(mime_req.hd)
 
         @env
       end
     end
 
-    # Huile d'olive extra
+    # $batch Handler
     class HandlerBase
       TREND = Safrano::Transition.new('', trans: 'transition_end')
       def allowed_transitions
@@ -103,7 +112,8 @@ module Safrano
         Safrano::Transition::RESULT_END
       end
     end
-    # jaune d'oeuf
+
+    # $batch disabled Handler
     class DisabledHandler < HandlerBase
       def odata_post(_req)
         [404, EMPTY_HASH, '$batch is not enabled ']
@@ -113,7 +123,8 @@ module Safrano
         [404, EMPTY_HASH, '$batch is not enabled ']
       end
     end
-    # battre le tout
+
+    # $batch enabled Handler
     class EnabledHandler < HandlerBase
       attr_accessor :boundary
       attr_accessor :mmboundary
@@ -121,8 +132,6 @@ module Safrano
       attr_accessor :parts
       attr_accessor :request
 
-      def initialize; end
-
       # here we are in the Batch handler object, and this POST should
       # normally handle a $batch request
       def odata_post(req)
@@ -130,15 +139,12 @@ module Safrano
 
         if @request.media_type == Safrano::MP_MIXED
 
-          batcha = @request.create_batch_app
           @mult_request = @request.parse_multipart
 
           @mult_request.prepare_content_id_refs
-          @mult_response = Safrano::Response.new
 
-          resp_hdrs, @mult_response.body = @mult_request.get_http_resp(batcha)
+          @mult_request.get_mult_resp(@request)
 
-          [202, resp_hdrs, @mult_response.body[0]]
         else
           [415, EMPTY_HASH, 'Unsupported Media Type']
         end

data/lib/odata/collection.rb

@@ -194,9 +194,8 @@ module Safrano
         @child_dataset_method.call
       end
 
-      def each
-        y = @child_method.call
-        y.each { |enty| yield enty }
+      def each(&block)
+        @child_method.call.each(&block)
       end
 
       def to_a

data/lib/odata/collection_media.rb

@@ -2,49 +2,73 @@
 
 require 'rack'
 require 'fileutils'
+require 'tempfile'
+require 'pathname'
 require_relative './navigation_attribute'
 
 module Safrano
   module Media
     # base class for Media Handler
     class Handler
-      def check_before_create(data:,
-                              entity:,
-                              filename:)
+      def check_before_create(data:, entity:, filename:)
         Contract::OK
       end
     end
-
     # Simple static File/Directory based media store handler
     # similar to Rack::Static
     # with a flat directory structure
     class Static < Handler
       def initialize(root: nil, mediaklass:)
-        @root = File.absolute_path(root || Dir.pwd)
-        @file_server = ::Rack::Files.new(@root)
+        super()
+        @root = Pathname(File.absolute_path(root || Dir.pwd))
+        @files_class = ::Rack.release[0..2] == '2.0' ? ::Rack::File : ::Rack::Files
         @media_class = mediaklass
-        @media_dir_name = mediaklass.to_s
+        @media_dir_name = Pathname(mediaklass.to_s)
+        @semaphore = Thread::Mutex.new
+
         register
       end
 
       def register
-        @abs_klass_dir = File.absolute_path(@media_dir_name, @root)
+        @abs_klass_dir = @root + @media_dir_name
+        @abs_temp_dir = @abs_klass_dir.join('tmp')
       end
 
       def create_abs_class_dir
         FileUtils.makedirs @abs_klass_dir unless Dir.exist?(@abs_klass_dir)
       end
 
+      def create_abs_temp_dir
+        FileUtils.makedirs @abs_temp_dir unless Dir.exist?(@abs_temp_dir)
+      end
+
       def finalize
         create_abs_class_dir
+        create_abs_temp_dir
+      end
+
+      # see also ...
+      # File activesupport/lib/active_support/core_ext/file/atomic.rb, line 21
+      def atomic_write(file_name)
+        Tempfile.open('', @abs_temp_dir) do |temp_file|
+          temp_file.binmode
+          return_val = yield temp_file
+          temp_file.close
+
+          # Overwrite original file with temp file
+          File.rename(temp_file.path, file_name)
+          return_val
+        end
       end
 
       # minimal working implementation...
-      #  Note: @file_server works relative to @root directory
+      #  Note: files_app works relative to @root directory
       def odata_get(request:, entity:)
         media_env = request.env.dup
         media_env['PATH_INFO'] = filename(entity)
-        fsret = @file_server.call(media_env)
+        # new app instance for each call for thread safety
+        files_app = @files_class.new(@root)
+        fsret = files_app.call(media_env)
         if fsret.first == 200
           # provide own content type as we keep it in the media entity
           fsret[1]['Content-Type'] = entity.content_type
@@ -55,28 +79,23 @@ module Safrano
       # this is relative to @root
       # eg. Photo/1
       def media_path(entity)
-        File.join(@media_dir_name, media_directory(entity))
+        @media_dir_name + media_directory(entity)
       end
 
       # relative to @root
       # 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('*').max)
-        end
+        media_path(entity) + ressource_version(entity)
       end
 
       # /@root/Photo/1
       def abs_path(entity)
-        File.absolute_path(media_path(entity), @root)
+        @root + media_path(entity)
       end
 
       # absolute filename
       def abs_filename(entity)
-        File.absolute_path(filename(entity), @root)
+        @root + filename(entity)
       end
 
       # this is relative to abs_klass_dir(entity) eg to /@root/Photo
@@ -86,29 +105,31 @@ module Safrano
         entity.media_path_id
       end
 
-      def in_media_directory(entity)
-        mpi = media_directory(entity)
+      # the same as above but absolute
+      def abs_media_directory(entity)
+        @abs_klass_dir + entity.media_path_id
+      end
+
+      # yields the absolute path of media directory
+      # and ensure the directory exists
+      def with_media_directory(entity)
+        mpi = abs_media_directory(entity)
         Dir.mkdir mpi unless Dir.exist?(mpi)
-        Dir.chdir mpi do
-          yield
-        end
+        yield Pathname(mpi)
       end
 
       def odata_delete(entity:)
-        Dir.chdir(@abs_klass_dir) do
-          in_media_directory(entity) do
-            Dir.glob('*').each { |oldf| File.delete(oldf) }
-          end
-        end
+        mpi = abs_media_directory(entity)
+        return unless Dir.exist?(mpi)
+
+        mpi.children.each { |oldp| File.delete(oldp) }
       end
 
       # Here as well, MVP implementation
       def save_file(data:, filename:, entity:)
-        Dir.chdir(@abs_klass_dir) do
-          in_media_directory(entity) do
-            filename = '1'
-            File.open(filename, 'wb') { |f| IO.copy_stream(data, f) }
-          end
+        with_media_directory(entity) do |d|
+          filename = d.join('1')
+          atomic_write(filename) { |f| IO.copy_stream(data, f) }
         end
       end
 
@@ -116,24 +137,31 @@ module Safrano
       # after each upload, so that clients get informed about new versions
       # of the same media ressource
       def ressource_version(entity)
-        Dir.chdir(@abs_klass_dir) do
-          in_media_directory(entity) do
-            Dir.glob('*').max
-          end
-        end
+        abs_media_directory(entity).children(false).max.to_s
       end
 
-      # Here as well, MVP implementation
-      def replace_file(data:, filename:, entity:)
-        Dir.chdir(@abs_klass_dir) do
-          in_media_directory(entity) do
-            version = nil
-            Dir.glob('*').sort.each do |oldf|
-              version = oldf
-              File.delete(oldf)
-            end
-            filename = (version.to_i + 1).to_s
-            File.open(filename, 'wb') { |f| IO.copy_stream(data, f) }
+      # Note:  add a new Version and remove the previous one
+      def replace_file(data:, entity:)
+        with_media_directory(entity) do |d|
+          tp = Tempfile.open('', @abs_temp_dir) do |temp_file|
+            temp_file.binmode
+            IO.copy_stream(data, temp_file)
+            temp_file.path
+          end
+
+          # picking new filename and the "move" operation must
+          # be protected
+          @semaphore.synchronize do
+            # new filename =  "version" + 1
+            v = ressource_version(entity)
+            filename = d + (v.to_i + 1).to_s
+
+            # Move temp file to original target file
+            File.rename(tp, filename)
+
+            # remove the previous version
+            filename = d + v
+            File.delete(filename)
           end
         end
       end
@@ -162,42 +190,25 @@ module Safrano
         StaticTree.path_builder(entity.media_path_ids)
       end
 
-      def in_media_directory(entity)
-        mpi = media_directory(entity)
+      # the same as above but absolute
+      def abs_media_directory(entity)
+        @abs_klass_dir + StaticTree.path_builder(entity.media_path_ids)
+      end
+
+      # yields the absolute path of media directory
+      # and ensure the directory exists
+      def with_media_directory(entity)
+        mpi = abs_media_directory(entity)
+
         FileUtils.makedirs mpi unless Dir.exist?(mpi)
-        Dir.chdir(mpi) { yield }
+        yield Pathname(mpi)
       end
 
       def odata_delete(entity:)
-        Dir.chdir(@abs_klass_dir) do
-          in_media_directory(entity) do
-            Dir.glob('*').sort.each { |oldf| File.delete(oldf) if File.file?(oldf) }
-          end
-        end
-      end
+        mpi = abs_media_directory(entity)
+        return unless Dir.exist?(mpi)
 
-      # Here as well, MVP implementation
-      #      def replace_file(data:, filename:, entity:)
-      #        Dir.chdir(abs_klass_dir(entity)) do
-      #          in_media_directory(entity) do
-      #            Dir.glob('*').each { |oldf| File.delete(oldf) if File.file?(oldf) }
-      #            File.open(filename, 'wb') { |f| IO.copy_stream(data, f) }
-      #          end
-      #        end
-      #      end
-      # Here as well, MVP implementation
-      def replace_file(data:, filename:, entity:)
-        Dir.chdir(@abs_klass_dir) do
-          in_media_directory(entity) do
-            version = nil
-            Dir.glob('*').sort.each do |oldf|
-              version = oldf
-              File.delete(oldf)
-            end
-            filename = (version.to_i + 1).to_s
-            File.open(filename, 'wb') { |f| IO.copy_stream(data, f) }
-          end
-        end
+        mpi.children.each { |oldp| File.delete(oldp) if File.file?(oldp) }
       end
     end
   end

data/lib/odata/common_logger.rb

@@ -13,11 +13,28 @@ module Rack
     MSG_FUNC = case FORMAT.count('%')
                when 10
                  lambda { |env, length, status, began_at|
-                   format(FORMAT, env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR'] || '-', env['REMOTE_USER'] || '-', Time.now.strftime('%d/%b/%Y:%H:%M:%S %z'), env[REQUEST_METHOD], env[SCRIPT_NAME] + env[PATH_INFO], env[QUERY_STRING].empty? ? '' : "?#{env[QUERY_STRING]}", env[SERVER_PROTOCOL], status.to_s[0..3], length, Utils.clock_time - began_at)
+                   format(FORMAT,
+                          env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR'] || '-',
+                          env['REMOTE_USER'] || '-',
+                          Time.now.strftime('%d/%b/%Y:%H:%M:%S %z'),
+                          env[REQUEST_METHOD],
+                          env[SCRIPT_NAME] + env[PATH_INFO],
+                          env[QUERY_STRING].empty? ? '' : "?#{env[QUERY_STRING]}",
+                          env[SERVER_PROTOCOL],
+                          status.to_s[0..3], length, Utils.clock_time - began_at)
                  }
                when 11
                  lambda { |env, length, status, began_at|
-                   format(FORMAT, env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR'] || '-', env['REMOTE_USER'] || '-', Time.now.strftime('%d/%b/%Y:%H:%M:%S %z'), env[REQUEST_METHOD], env[SCRIPT_NAME], env[PATH_INFO], env[QUERY_STRING].empty? ? '' : "?#{env[QUERY_STRING]}", env[SERVER_PROTOCOL], status.to_s[0..3], length, Utils.clock_time - began_at)
+                   format(FORMAT,
+                          env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR'] || '-',
+                          env['REMOTE_USER'] || '-',
+                          Time.now.strftime('%d/%b/%Y:%H:%M:%S %z'),
+                          env[REQUEST_METHOD],
+                          env[SCRIPT_NAME],
+                          env[PATH_INFO],
+                          env[QUERY_STRING].empty? ? '' : "?#{env[QUERY_STRING]}",
+                          env[SERVER_PROTOCOL],
+                          status.to_s[0..3], length, Utils.clock_time - began_at)
                  }
                end
 

data/lib/odata/complex_type.rb

@@ -92,7 +92,7 @@ module Safrano
       # wrapper
       # for OData Entity and Collections, return them directly
       # for others, ie ComplexType, Prims etc, return the ResultDefinition-subclass wrapped result
-      def self.do_execute_func_result(result, _req, _apply_query_params = false)
+      def self.do_execute_func_result(result, _req, apply_query_params: false)
         new(result)
       end
     end
@@ -129,7 +129,7 @@ module Safrano
 
       # wrapper
       # for OData Entity  return them directly
-      def self.do_execute_func_result(result, _req, apply_query_params = false)
+      def self.do_execute_func_result(result, _req, apply_query_params: false)
         # note: Sequel entities instances seem to be thread safe, so we can
         # safely add request-dependant data (eg. req.params) there
         apply_query_params ? result : result.inactive_query_params
@@ -143,7 +143,7 @@ module Safrano
 
       # wrapper
       # for OData Entity Collection return them directly
-      def self.do_execute_func_result(result, req, apply_query_params = false)
+      def self.do_execute_func_result(result, req, apply_query_params: false)
         coll = Safrano::OData::Collection.new(@klassmod)
         # instance_exec has other instance variables; @values would be nil in the block below
         # need to pass a local copy
@@ -241,12 +241,8 @@ module Safrano
     def odata_h
       ret = { METAK => { TYPEK => self.class.type_name } }
 
-      @values.each do |k, v|
-        ret[k] = if v.respond_to? :odata_h
-                   v.odata_h
-                 else
-                   v
-                 end
+      @values.each do |key, val|
+        ret[key] = val.respond_to?(:odata_h) ? val.odata_h : val
       end
       ret
     end