safrano 0.4.1 → 0.4.6

data/lib/safrano/deprecation.rb

@@ -0,0 +1,73 @@
+# frozen-string-literal: true
+
+# shamelessly copied from Sequel...
+
+module Safrano
+  # This module makes it easy to print deprecation warnings with optional backtraces to a given stream.
+  # There are a two accessors you can use to change how/where the deprecation methods are printed
+  # and whether/how backtraces should be included:
+  #
+  #   Safrano::Deprecation.output = $stderr # print deprecation messages to standard error (default)
+  #   Safrano::Deprecation.output = File.open('deprecated_calls.txt', 'wb') # use a file instead
+  #   Safrano::Deprecation.output = false # do not output deprecation messages
+  #
+  #   Safrano::Deprecation.prefix = "SAFRANO DEPRECATION WARNING: " # prefix deprecation messages with a given string (default)
+  #   Safrano::Deprecation.prefix = false # do not prefix deprecation messages
+  #
+  #   Safrano::Deprecation.backtrace_filter = false # don't include backtraces
+  #   Safrano::Deprecation.backtrace_filter = true # include full backtraces
+  #   Safrano::Deprecation.backtrace_filter = 2 # include 2 backtrace lines (default)
+  #   Safrano::Deprecation.backtrace_filter = 1 # include 1 backtrace line
+  #   Safrano::Deprecation.backtrace_filter = lambda{|line, line_no| line_no < 3 || line =~ /my_app/} # select backtrace lines to output
+  module Deprecation
+    @backtrace_filter = false
+    @output = $stderr
+    @prefix = 'SAFRANO DEPRECATION WARNING: '
+
+    class << self
+      # How to filter backtraces.  +false+ does not include backtraces, +true+ includes
+      # full backtraces, an Integer includes that number of backtrace lines, and
+      # a proc is called with the backtrace line and line number to select the backtrace
+      # lines to include.  The default is no backtrace .
+      attr_accessor :backtrace_filter
+
+      # Where deprecation messages should be output, must respond to puts.  $stderr by default.
+      attr_accessor :output
+
+      # Where deprecation messages should be prefixed with ("SEQUEL DEPRECATION WARNING: " by default).
+      attr_accessor :prefix
+    end
+
+    # Print the message and possibly backtrace to the output.
+    def self.deprecate(method, instead = nil)
+      return unless output
+
+      message = instead ? "#{method} is deprecated and will be removed in Safrano 0.6.  #{instead}." : method
+      message = "#{prefix}#{message}" if prefix
+      output.puts(message)
+      case b = backtrace_filter
+      when Integer
+        caller.each do |c|
+          b -= 1
+          output.puts(c)
+          break if b <= 0
+        end
+      when true
+        caller.each { |c| output.puts(c) }
+      when Proc
+        caller.each_with_index { |line, line_no| output.puts(line) if b.call(line, line_no) }
+      end
+      nil
+    end
+
+    # If using ruby 2.3+, use Module#deprecate_constant to deprecate the constant,
+    # otherwise do nothing as the ruby implementation does not support constant deprecation.
+    def self.deprecate_constant(mod, constant)
+      # :nocov:
+      return unless RUBY_VERSION > '2.3'
+
+      # :nocov:
+      mod.deprecate_constant(constant)
+    end
+  end
+end

data/lib/safrano/multipart.rb

@@ -1,21 +1,25 @@
-CRLF = "\r\n".freeze
-LF = "\n".freeze
+# frozen_string_literal: true
+
+CRLF = "\r\n"
+LF = "\n"
 
 require 'securerandom'
 require 'webrick/httpstatus'
 
 # Simple multipart support for OData $batch purpose
 module MIME
+  CTT_TYPE_LC = 'content-type'
+  TEXT_PLAIN = 'text/plain'
+
   # a mime object has a header(with content-type etc) and a content(aka body)
   class Media
     # Parser for MIME::Media
     class Parser
       HMD_RGX = /^([\w-]+)\s*:\s*(.*)/.freeze
 
-      CRLF_LINE_RGX = /^#{CRLF}$/.freeze
-
       attr_accessor :lines
       attr_accessor :target
+
       def initialize
         @state = :h
         @lines = []
@@ -54,9 +58,8 @@ module MIME
         if (hmd = HMD_RGX.match(line))
           @target_hd[hmd[1].downcase] = hmd[2].strip
 
-        #        elsif CRLF_LINE_RGX =~ line
         elsif CRLF == line
-          @target_ct = @target_hd['content-type'] || 'text/plain'
+          @target_ct = @target_hd[CTT_TYPE_LC] || TEXT_PLAIN
           @state = new_content
 
         end
@@ -100,24 +103,22 @@ module MIME
       end
 
       def hook_multipart(content_type, boundary)
-        @target_hd['content-type'] = content_type
-        @target_ct = @target_hd['content-type']
+        @target_hd[CTT_TYPE_LC] = content_type
+        @target_ct = @target_hd[CTT_TYPE_LC]
         @target = multipart_content(boundary)
         @target.hd = @target_hd
         @target.ct = @target_ct
         @state = :bmp
       end
-      MPS = 'multipart/'.freeze
-      MP_RGX1 = %r{^(digest|mixed);\s*boundary=\"(.*)\"}.freeze
+      MPS = 'multipart/'
+      MP_RGX1 = %r{^(digest|mixed);\s*boundary="(.*)"}.freeze
       MP_RGX2 = %r{^(digest|mixed);\s*boundary=(.*)}.freeze
       #      APP_HTTP_RGX = %r{^application/http}.freeze
-      APP_HTTP = 'application/http'.freeze
+      APP_HTTP = 'application/http'
       def new_content
         @target =
-          if @target_ct.start_with?(MPS) and
-             (md = ((MP_RGX1.match(@target_ct[10..-1])) ||
-                      (MP_RGX2.match(@target_ct[10..-1])))
-             )
+          if @target_ct.start_with?(MPS) &&
+             (md = (MP_RGX1.match(@target_ct[10..-1]) || MP_RGX2.match(@target_ct[10..-1])))
             multipart_content(md[2].strip)
           elsif @target_ct.start_with?(APP_HTTP)
             MIME::Content::Application::Http.new
@@ -198,7 +199,6 @@ module MIME
         # Parser for Text::Plain
         class Parser
           HMD_RGX = /^([\w-]+)\s*:\s*(.*)/.freeze
-          CRLF_LINE_RGX = /^#{CRLF}$/.freeze
           def initialize(target)
             @state = :h
             @lines = []
@@ -212,7 +212,6 @@ module MIME
           def parse_head(line)
             if (hmd = HMD_RGX.match(line))
               @target.hd[hmd[1].downcase] = hmd[2].strip
-            #            elsif CRLF_LINE_RGX =~ line
             elsif CRLF == line
               @state = :b
             else
@@ -241,10 +240,11 @@ module MIME
 
         def initialize
           @hd = {}
-          @content = ''
+          # we need it unfrozen --> +
+          @content = +''
           # set default values. Can be overwritten by parser
-          @hd['content-type'] = 'text/plain'
-          @ct = 'text/plain'
+          @hd[CTT_TYPE_LC] = TEXT_PLAIN
+          @ct = TEXT_PLAIN
           @parser = Parser.new(self)
         end
 
@@ -309,8 +309,10 @@ module MIME
             # to remove it from the end of the last body line
             return unless @body_lines
 
-            #            @body_lines.last.sub!(CRLF_ENDING_RGX, '')
-            @body_lines.last.chomp!(CRLF)
+            # the last line ends up frozen --> chomp! fails
+            # @body_lines.last.chomp!(CRLF)
+            last_line = @body_lines.pop.chomp(CRLF)
+            @body_lines.push last_line
             @parts << @body_lines
           end
 
@@ -364,7 +366,7 @@ module MIME
         end
 
         def set_multipart_header
-          @hd['content-type'] = "#{OData::MP_MIXED}; boundary=#{@boundary}"
+          @hd[CTT_TYPE_LC] = "#{Safrano::MP_MIXED}; boundary=#{@boundary}"
         end
 
         def get_http_resp(batcha)
@@ -382,9 +384,7 @@ module MIME
             # of the changes
             batcha.db.transaction do
               begin
-                @response.content = @content.map { |part|
-                  part.get_response(batcha)
-                }
+                @response.content = @content.map { |part| part.get_response(batcha) }
               rescue Sequel::Rollback => e
                 # one of the changes of the changeset has failed
                 # --> provide a dummy empty response for the change-parts
@@ -405,18 +405,18 @@ module MIME
           @response.content = [{ 'odata.error' =>
                                { 'message' =>
                                  'Bad Request: Failed changeset ' } }.to_json]
-          @response.hd = OData::CT_JSON
+          @response.hd = Safrano::CT_JSON
           @response
         end
 
         def unparse(bodyonly = false)
-          b = ''
+          b = +String.new
           unless bodyonly
-            #            b << OData::CONTENT_TYPE << ': ' << @hd[OData::CTT_TYPE_LC] << CRLF
-            b << "#{OData::CONTENT_TYPE}: #{@hd[OData::CTT_TYPE_LC]}#{CRLF}"
+            b << "#{Safrano::CONTENT_TYPE}: #{@hd[CTT_TYPE_LC]}#{CRLF}"
           end
-          b << "#{CRLF}--#{@boundary}#{CRLF}"
-          b << @content.map(&:unparse).join("#{CRLF}--#{@boundary}#{CRLF}")
+
+          b << crbdcr = "#{CRLF}--#{@boundary}#{CRLF}"
+          b << @content.map(&:unparse).join(crbdcr)
           b << "#{CRLF}--#{@boundary}--#{CRLF}"
           b
         end
@@ -436,15 +436,14 @@ module MIME
 
         def initialize
           @hd = {}
-          @content = ''
+          @content = +String.new
         end
 
         def unparse
-          b = "#{@http_method} #{@uri} HTTP/1.1#{CRLF}"
+          b = +"#{@http_method} #{@uri} HTTP/1.1#{CRLF}"
           @hd.each { |k, v| b << "#{k}: #{v}#{CRLF}" }
-          #          @hd.each { |k, v| b << k.to_s << ': ' << v.to_s << CRLF }
           b << CRLF
-          b << @content if @content != ''
+          b << @content unless content.empty?
           b
         end
       end
@@ -470,10 +469,9 @@ module MIME
         end
 
         def unparse
-          b = String.new(APPLICATION_HTTP_11)
+          b = +String.new(APPLICATION_HTTP_11)
           b << "#{@status} #{StatusMessage[@status]} #{CRLF}"
           @hd.each { |k, v| b << "#{k}: #{v}#{CRLF}" }
-          #          @hd.each { |k, v| b << k.to_s << ': ' << v.to_s << CRLF }
           b << CRLF
           b << @content.join if @content
           b
@@ -482,15 +480,14 @@ module MIME
 
       # For application/http . Content is either a Request or a Response
       class Http < Media
-        HTTP_MTHS_RGX = 'POST|GET|PUT|MERGE|PATCH|DELETE'.freeze
+        HTTP_MTHS_RGX = 'POST|GET|PUT|MERGE|PATCH|DELETE'
         HTTP_R_RGX = %r{^(#{HTTP_MTHS_RGX})\s+(\S*)\s?(HTTP/1\.1)\s*$}.freeze
-        HEADER_RGX = %r{^([a-zA-Z\-]+):\s*([0-9a-zA-Z\-\/,\s]+;?\S*)\s*$}.freeze
+        HEADER_RGX = %r{^([a-zA-Z\-]+):\s*([0-9a-zA-Z\-/,\s]+;?\S*)\s*$}.freeze
         HTTP_RESP_RGX = %r{^HTTP/1\.1\s(\d+)\s}.freeze
 
         # Parser for Http Media
         class Parser
           HMD_RGX = /^([\w-]+)\s*:\s*(.*)/.freeze
-          CRLF_LINE_RGX = /^#{CRLF}$/.freeze
 
           def initialize(target)
             @state = :http
@@ -523,7 +520,6 @@ module MIME
             if (hmd = HMD_RGX.match(line))
               @target.content.hd[hmd[1].downcase] = hmd[2].strip
             elsif CRLF == line
-              #            elsif CRLF_LINE_RGX =~ line
               @state = :b
             else
               @body_lines << line
@@ -575,7 +571,7 @@ module MIME
         end
 
         def unparse
-          b =  "Content-Type: #{@ct}#{CRLF}"
+          b =  +"Content-Type: #{@ct}#{CRLF}"
           b << "Content-Transfer-Encoding: binary#{CRLF}#{CRLF}"
           b << @content.unparse
           b

data/lib/safrano/rack_app.rb

@@ -1,98 +1,72 @@
-#!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'rack'
-require_relative '../odata/walker.rb'
-require_relative 'request.rb'
-require_relative 'response.rb'
+require_relative '../odata/walker'
+require_relative 'request'
+require_relative 'response'
 
-module OData
+module Safrano
   # handle GET PUT etc
   module MethodHandlers
     def odata_options
-      # cf. stackoverflow.com/questions/22924678/sinatra-delete-response-headers
-
-      x = if @walker.status == :end
-            headers.delete('Content-Type')
-            @response.headers.delete('Content-Type')
-            [200, {}, '']
-          else
-            odata_error
-          end
-      @response.headers['Content-Type'] = ''
-      x
-    end
-
-    def odata_error
-      return @walker.error.odata_get(@request) unless @walker.error.nil?
-
-      # this is too critical; raise a real Exception
-      raise 'Walker construction failed with a unknown Error '
+      @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
-      if @walker.status == :end
-        @walker.end_context.odata_delete(@request)
-      else
-        odata_error
-      end
+      @walker.finalize.tap_error { |err| return err.odata_get(@request) }
+             .if_valid { |context| context.odata_delete(@request) }
     end
 
     def odata_put
-      if @walker.status == :end
-        @walker.end_context.odata_put(@request)
-      else
-        odata_error
-      end
+      @walker.finalize.tap_error { |err| return err.odata_get(@request) }
+             .if_valid { |context| context.odata_put(@request) }
     end
 
     def odata_patch
-      if @walker.status == :end
-        @walker.end_context.odata_patch(@request)
-      else
-        odata_error
-      end
+      @walker.finalize.tap_error { |err| return err.odata_get(@request) }
+             .if_valid { |context| context.odata_patch(@request) }
     end
 
     def odata_get
-      if @walker.status == :end
-        @walker.end_context.odata_get(@request)
-      else
-        odata_error
-      end
+      @walker.finalize.tap_error { |err| return err.odata_get(@request) }
+             .if_valid { |context| context.odata_get(@request) }
     end
 
     def odata_post
-      if @walker.status == :end
-        @walker.end_context.odata_post(@request)
-      else
-        odata_error
-      end
+      @walker.finalize.tap_error { |err| return err.odata_get(@request) }
+             .if_valid { |context| context.odata_post(@request) }
     end
 
     def odata_head
-      [200, {}, ['']]
+      [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')
+    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'
     include MethodHandlers
-    def before
-      headers 'Cache-Control' => 'no-cache'
-      headers 'Expires' => '-1'
-      headers 'Pragma' => 'no-cache'
 
+    def before
       @request.service_base = self.class.get_service_base
 
-      neg_error = @request.negotiate_service_version
-
-      raise RuntimeError if neg_error
-
-      return false unless @request.service
-
-      headers 'DataServiceVersion' => @request.service.data_service_version
+      @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
@@ -117,9 +91,14 @@ module OData
       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, {}, ['Did you get lost?']]
+                  [404, EMPTY_HASH, ['Did you get lost?']]
                 elsif @request.request_method == 'HEAD'
                   odata_head
                 else
@@ -130,13 +109,23 @@ module OData
     end
 
     def call(env)
-      @request = OData::Request.new(env)
-      @response = OData::Response.new
+      # for thread safety
+      dup._call(env)
+    end
 
-      before
+    def _call(env)
+      begin
+        @request = Safrano::Request.new(env)
+        @response = Safrano::Response.new
 
-      dispatch
+        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
 
@@ -165,10 +154,22 @@ module OData
     end
 
     def self.publish_service(&block)
-      sbase = OData::ServiceBase.new
+      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