safrano 0.3.4 → 0.4.4

data/lib/safrano/rack_app.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require 'rack'
+require_relative '../odata/walker'
+require_relative 'request'
+require_relative 'response'
+
+module Safrano
+  # handle GET PUT etc
+  module MethodHandlers
+    def odata_options
+      @walker.finalize.tap_error { |err| return err.odata_get(@request) }
+             .if_valid do |context|
+        # cf. stackoverflow.com/questions/22924678/sinatra-delete-response-headers
+        headers.delete('Content-Type')
+        @response.headers.delete('Content-Type')
+        @response.headers['Content-Type'] = ''
+        [200, EMPTY_HASH, '']
+      end
+    end
+
+    def odata_delete
+      @walker.finalize.tap_error { |err| return err.odata_get(@request) }
+             .if_valid { |context| context.odata_delete(@request) }
+    end
+
+    def odata_put
+      @walker.finalize.tap_error { |err| return err.odata_get(@request) }
+             .if_valid { |context| context.odata_put(@request) }
+    end
+
+    def odata_patch
+      @walker.finalize.tap_error { |err| return err.odata_get(@request) }
+             .if_valid { |context| context.odata_patch(@request) }
+    end
+
+    def odata_get
+      @walker.finalize.tap_error { |err| return err.odata_get(@request) }
+             .if_valid { |context| context.odata_get(@request) }
+    end
+
+    def odata_post
+      @walker.finalize.tap_error { |err| return err.odata_get(@request) }
+             .if_valid { |context| context.odata_post(@request) }
+    end
+
+    def odata_head
+      [200, EMPTY_HASH, [EMPTY_STRING]]
+    end
+  end
+
+  # the main Rack server app. Source: the Rack docu/examples and partly
+  # inspired from Sinatra
+  class ServerApp
+    METHODS_REGEXP = Regexp.new('HEAD|OPTIONS|GET|POST|PATCH|MERGE|PUT|DELETE').freeze
+    NOCACHE_HDRS = { 'Cache-Control' => 'no-cache',
+                     'Expires' => '-1',
+                     'Pragma' => 'no-cache' }.freeze
+    DATASERVICEVERSION = 'DataServiceVersion'.freeze
+    include MethodHandlers
+
+    def before
+      @request.service_base = self.class.get_service_base
+
+      @request.negotiate_service_version.tap_valid do
+        myhdrs = NOCACHE_HDRS.dup
+        myhdrs[DATASERVICEVERSION] = @request.service.data_service_version
+        headers myhdrs
+      end
+    end
+
+    # dispatch for all methods requiring parsing of the path
+    # with walker (ie. allmost all excepted HEAD)
+    def dispatch_with_walker
+      @walker = @request.create_odata_walker
+      case @request.request_method
+      when 'GET'
+        odata_get
+      when 'POST'
+        odata_post
+      when 'DELETE'
+        odata_delete
+      when 'OPTIONS'
+        odata_options
+      when 'PUT'
+        odata_put
+      when 'PATCH', 'MERGE'
+        odata_patch
+      else
+        raise Error
+      end
+    end
+
+    def dispatch_error(err)
+      @response.status, rsph, @response.body = err.odata_get(@request)
+      headers rsph
+    end
+
+    def dispatch
+      req_ret = if @request.request_method !~ METHODS_REGEXP
+                  [404, EMPTY_HASH, ['Did you get lost?']]
+                elsif @request.request_method == 'HEAD'
+                  odata_head
+                else
+                  dispatch_with_walker
+                end
+      @response.status, rsph, @response.body = req_ret
+      headers rsph
+    end
+
+    def call(env)
+      # for thread safety
+      dup._call(env)
+    end
+
+    def _call(env)
+      begin
+        @request = Safrano::Request.new(env)
+        @response = Safrano::Response.new
+
+        before.tap_error { |err| dispatch_error(err) }
+              .tap_valid { |res| dispatch }
+
+      # handle remaining Sequel errors that we couldnt prevent with our
+      # own pre-checks
+      rescue Sequel::Error => e
+        dispatch_error(SequelExceptionError.new(e))
+      end
+      @response.finish
+    end
+
+    # Set multiple response headers with Hash.
+    def headers(hash = nil)
+      @response.headers.merge! hash if hash
+      @response.headers
+    end
+
+    def self.enable_batch
+      @service_base.enable_batch
+    end
+
+    def self.path_prefix(path_pr)
+      @service_base.path_prefix path_pr
+    end
+
+    def self.get_service_base
+      @service_base
+    end
+
+    def self.set_servicebase(sbase)
+      @service_base = sbase
+      @service_base.enable_v1_service
+      @service_base.enable_v2_service
+    end
+
+    def self.publish_service(&block)
+      sbase = Safrano::ServiceBase.new
+      sbase.instance_eval(&block) if block_given?
+      sbase.finalize_publishing
+      set_servicebase(sbase)
+    end
+  end
+end
+
+# deprecated
+# REMOVE 0.6
+module OData
+  class ServerApp < Safrano::ServerApp
+    def self.publish_service(&block)
+      ::Safrano::Deprecation.deprecate('OData::ServerApp',
+                                       'Use Safrano::ServerApp instead')
+      super
+    end
+  end
+end

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'rack'
 require 'rack/cors'
 
 module Rack
-  module OData
+  module Safrano
     # just a Wrapper to ensure (force?) that mandatory middlewares are acutally
     # used
     class Builder < ::Rack::Builder
@@ -10,9 +12,23 @@ module Rack
         super(default_app) {}
         use ::Rack::Cors
         instance_eval(&block) if block_given?
-        use ::Rack::Lint
         use ::Rack::ContentLength
       end
     end
   end
 end
+
+# deprecated
+# REMOVE 0.6
+module Rack
+  module OData
+    class Builder < ::Rack::Safrano::Builder
+      def initialize(default_app = nil, &block)
+        ::Safrano::Deprecation.deprecate('Rack::OData::Builder',
+                                         'Use Rack::Safrano::Builder instead')
+
+        super
+      end
+    end
+  end
+end

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

@@ -1,8 +1,9 @@
-#!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'rack'
+require 'rfc2047'
 
-module OData
+module Safrano
   # monkey patch deactivate Rack/multipart because it does not work on simple
   # OData $batch requests when the content-length
   # is not passed
@@ -16,6 +17,7 @@ module OData
     class AcceptEntry
       attr_accessor :params
       attr_reader :entry
+
       def initialize(entry)
         params = entry.scan(HEADER_PARAM).map! do |s|
           key, value = s.strip.split('=', 2)
@@ -95,7 +97,9 @@ module OData
     end
 
     def create_odata_walker
-      @env['safrano.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
@@ -109,13 +113,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 +133,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,56 +150,109 @@ 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
 
-    def negotiate_service_version
-      maxv = if (rqv = env['HTTP_MAXDATASERVICEVERSION'])
-               OData::ServiceBase.parse_data_service_version(rqv)
-             else
-               OData::MAX_DATASERVICE_VERSION
-             end
-      return OData::BadRequestError if maxv.nil?
-      # client request an too old version --> 501
-      return OData::NotImplementedError if maxv < OData::MIN_DATASERVICE_VERSION
-
-      minv = if (rqv = env['HTTP_MINDATASERVICEVERSION'])
-               OData::ServiceBase.parse_data_service_version(rqv)
-             else
-               OData::MIN_DATASERVICE_VERSION
-             end
-      return OData::BadRequestError if minv.nil?
-      # client request an too new version --> 501
-      return OData::NotImplementedError if minv > OData::MAX_DATASERVICE_VERSION
-      return OData::BadRequestError if minv > maxv
-
-      v = if (rqv = env['HTTP_DATASERVICEVERSION'])
-            OData::ServiceBase.parse_data_service_version(rqv)
+    # input is the       DataServiceVersion request header string, eg.
+    # '2.0;blabla' ---> Version -> 2
+    DATASERVICEVERSION_RGX = /\A([1234])(?:\.0);*\w*\z/.freeze
+
+    MAX_DTSV_PARSE_ERROR = Safrano::BadRequestError.new(
+      'MaxDataServiceVersion could not be parsed'
+    ).freeze
+    def get_maxversion
+      if (rqv = env['HTTP_MAXDATASERVICEVERSION'])
+        if (m = DATASERVICEVERSION_RGX.match(rqv))
+          # client request an too old version --> 501
+          if (maxv = m[1]) < Safrano::MIN_DATASERVICE_VERSION
+            Safrano::VersionNotImplementedError
           else
-            OData::MAX_DATASERVICE_VERSION
+            Contract.valid(maxv)
           end
+        else
+          MAX_DTSV_PARSE_ERROR
+        end
+      else
+        # not provided in request header --> take ours
+        Safrano::CV_MAX_DATASERVICE_VERSION
+      end
+    end
 
-      return OData::BadRequestError if v.nil?
-      return OData::NotImplementedError if v > OData::MAX_DATASERVICE_VERSION
-      return OData::NotImplementedError if v < OData::MIN_DATASERVICE_VERSION
-
-      @service = nil
-      @service = case maxv
-                 when '1'
-                   @service_base.v1
-                 when '2', '3', '4'
-                   @service_base.v2
-                 end
-      nil
+    DTSV_PARSE_ERROR = Safrano::BadRequestError.new(
+      'DataServiceVersion could not be parsed'
+    ).freeze
+    def get_version
+      if (rqv = env['HTTP_DATASERVICEVERSION'])
+        if (m = DATASERVICEVERSION_RGX.match(rqv))
+          # client request an too new version --> 501
+          if ((v = m[1]) > Safrano::MAX_DATASERVICE_VERSION) or
+             (v < Safrano::MIN_DATASERVICE_VERSION)
+            Safrano::VersionNotImplementedError
+          else
+            Contract.valid(v)
+          end
+        else
+          DTSV_PARSE_ERROR
+        end
+      else
+        # not provided in request header --> take our maxv
+        Safrano::CV_MAX_DATASERVICE_VERSION
+      end
+    end
+
+    MIN_DTSV_PARSE_ERROR = Safrano::BadRequestError.new(
+      'MinDataServiceVersion could not be parsed'
+    ).freeze
+    def get_minversion
+      if (rqv = env['HTTP_MINDATASERVICEVERSION'])
+        if (m = DATASERVICEVERSION_RGX.match(rqv))
+          # client request an too new version --> 501
+          if (minv = m[1]) > Safrano::MAX_DATASERVICE_VERSION
+            Safrano::VersionNotImplementedError
+          else
+            Contract.valid(minv)
+          end
+        else
+          MIN_DTSV_PARSE_ERROR
+        end
+      else
+        # not provided in request header --> take ours
+        Safrano::CV_MIN_DATASERVICE_VERSION
+      end
+    end
+
+    MAX_LT_MIN_DTSV_ERROR = Safrano::BadRequestError.new(
+      'MinDataServiceVersion is larger as MaxDataServiceVersion'
+    ).freeze
+    def negotiate_service_version
+      get_maxversion.if_valid do |maxv|
+        get_minversion.if_valid do |minv|
+          return MAX_LT_MIN_DTSV_ERROR if minv > maxv
+
+          get_version.if_valid do |v|
+            @service = nil
+            @service = case maxv
+                       when '1'
+                         @service_base.v1
+                       when '2', '3', '4'
+                         @service_base.v2
+                       else
+                         return Safrano::VersionNotImplementedError
+                       end
+
+            Contract::OK
+          end # valid get_version
+        end # valid get_minversion
+      end # valid get_maxversion
     end
   end
 end

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

@@ -1,9 +1,10 @@
-#!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'rack'
 
 # monkey patch deactivate Rack/multipart because it does not work on simple
 # OData $batch requests when the content-length is not passed
-module OData
+module Safrano
   # borrowed fro Sinatra
   # The response object. See Rack::Response and Rack::Response::Helpers for
   # more info:
@@ -13,7 +14,7 @@ module OData
     DROP_BODY_RESPONSES = [204, 205, 304].freeze
     def initialize(*)
       super
-      headers['Content-Type'] ||= 'text/html'
+      headers[CONTENT_TYPE] ||= APPJSON_UTF8
     end
 
     def body=(value)
@@ -35,7 +36,7 @@ module OData
 
       if drop_body?
         close
-        result = []
+        result = EMPTY_ARRAY
       end
 
       if calculate_content_length?

data/lib/safrano/sequel_join_by_paths.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative '../sequel/plugins/join_by_paths'
+
+Sequel::Model.plugin Sequel::Plugins::JoinByPaths