blix-rest 0.1.30 → 0.8.2

data/lib/blix/rest/request_mapper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'thread'
 
 module Blix::Rest
   class RequestMapperError < StandardError; end
@@ -7,6 +8,8 @@ module Blix::Rest
   # these routes and return an associated block and parameters.
   class RequestMapper
 
+    @@mutex = Mutex.new
+
     WILD_PLACEHOLDER = '/'
     PATH_SEP         = '/'
     STAR_PLACEHOLDER = '*'
@@ -52,6 +55,7 @@ module Blix::Rest
 
     class << self
 
+      # the root always starts with '/' and finishes with '/'
       def set_path_root(root)
         root = root.to_s
         root = '/' + root if root[0, 1] != '/'
@@ -64,19 +68,30 @@ module Blix::Rest
         @path_root || '/'
       end
 
-      attr_reader :path_root_length
+      def path_root_length
+        @path_root_length.to_i
+      end
 
       def full_path(path)
         path = path[1..-1] if path[0, 1] == '/'
         path_root + path
       end
 
+      # ensure that absolute path is the  full path
+      def ensure_full_path(path)
+        if path[0, 1] == '/' && (path_root_length>0) && path[0, path_root_length] != path_root[0, path_root_length]
+          path = path_root + path[1..-1]
+        end
+        path
+      end
+
       def locations
         @locations ||= Hash.new { |h, k| h[k] = [] }
       end
 
       def table
-        @table ||= compile
+        # compile the table in one thread only.
+        @table ||= @@mutex.synchronize{@table ||= compile}
       end
 
       def dump
@@ -147,6 +162,7 @@ module Blix::Rest
         path = path[1..-1] if path[0, 1] == PATH_SEP
         RequestMapper.locations[verb] << [verb, path, opts, blk]
         @table = nil # force recompile
+        true
       end
 
       # match a given path to  declared route.
@@ -212,12 +228,12 @@ module Blix::Rest
             # .. if there is a wildpath foloowing then fine ..
             # .. otherwise an error !
 
-            if idx == limit # the last section of request
+            if idx == limit # the last section of path
               if current.blk
                 return [current.blk, parameters, current.opts]
               elsif (havewild = current[STAR_PLACEHOLDER])
                 parameters[havewild.parameter.to_s] = '/'
-                return [havewild.blk, parameters, havewild.opts]
+                return [havewild.blk, parameters, havewild.opts, true]
               else
                 return [nil, {}, nil]
               end
@@ -250,7 +266,7 @@ module Blix::Rest
                   return [current.blk, parameters, current.opts]
                 elsif (havewild = current[STAR_PLACEHOLDER])
                   parameters[havewild.parameter.to_s] = '/'
-                  return [havewild.blk, parameters, havewild.opts]
+                  return [havewild.blk, parameters, havewild.opts, true]
                 else
                   return [nil, {}, nil]
                 end
@@ -268,7 +284,7 @@ module Blix::Rest
                   parameters['format'] = wildformat[1..-1].to_sym
                 end
                 parameters[current.parameter.to_s] = wildpath
-                return [current.blk, parameters, current.opts]
+                return [current.blk, parameters, current.opts, true]
               else
                 return [nil, {}, nil]
               end

data/lib/blix/rest/response.rb

@@ -12,13 +12,13 @@ module Blix::Rest
 
     def initialize
       @status  = 200
-      @headers  = {}
+      @headers  = Rack::Headers.new
       @content = nil
     end
 
     def set(status,content=nil,headers=nil)
       @status = status if status
-      @content = String.new(content) if content
+      @content = [String.new(content)] if content
       @headers.merge!(headers) if headers
     end
 

data/lib/blix/rest/route.rb

@@ -0,0 +1,33 @@
+module Blix::Rest
+
+  # class used to represent a route and to allow manipulation of the
+  # options and path of the route before registrATION
+
+  class Route
+
+    attr_reader :verb, :path, :opts
+    alias_method :method, :verb
+    alias_method :options, :opts
+
+    def initialize(verb, path, opts)
+      @verb = verb.dup
+      @path = path
+      @opts = opts
+    end
+
+    def default_option(key, val)
+      opts[key.to_sym] = val unless opts.key?(key) || opts.key?(key.to_sym)
+    end
+
+    def path_prefix(prefix)
+      prefix = prefix.to_s
+      prefix = '/' + prefix unless prefix[0] == '/'
+      path.replace( prefix + path) unless path.start_with?(prefix)
+    end
+
+    def path=(val)
+      path.replace(val.to_s)
+    end
+
+  end
+end

data/lib/blix/rest/server.rb

@@ -17,8 +17,23 @@ module Blix::Rest
       @_options = opts
     end
 
+    # options passed to the server
+    def _options
+      @_options
+    end
+
+
+    # the object serving as a cache
     def _cache
-      @_cache ||= {}
+      @_cache ||= begin
+        obj = _options[:cache] || _options['cache']
+        if obj
+          raise "cache must be a subclass of Blix::Rest::Cache" unless obj.is_a?(Cache)
+          obj
+        else
+          MemoryCache.new
+        end
+      end
     end
 
     def extract_parsers_from_options(opts)
@@ -34,7 +49,6 @@ module Blix::Rest
     def set_custom_headers(format, headers)
       parser = get_parser(format)
       raise "parser not found for custom headers format=>#{format}" unless parser
-
       parser.__custom_headers = headers
     end
 
@@ -54,6 +68,7 @@ module Blix::Rest
       parser._types.each { |t| @_mime_types[t.downcase] = parser } # register each of the mime types
     end
 
+    # retrieve parameters from the http request
     def retrieve_params(env)
       post_params = {}
       body        = ''
@@ -104,6 +119,7 @@ module Blix::Rest
       end
     end
 
+    # determine standard format from http mime type
     def get_format_from_mime(mime)
       case mime
       when 'application/json' then :json
@@ -138,20 +154,24 @@ module Blix::Rest
       parser
     end
 
+    # the call function is the interface with the rack framework
     def call(env)
       req = Rack::Request.new(env)
 
-      verb            = env['REQUEST_METHOD']
-      path            = req.path
+      verb  = env['REQUEST_METHOD']
+      path  = req.path
+      path  = CGI.unescape(path).gsub('+',' ') unless _options[:unescape] == false
 
-      blk, path_params, options = RequestMapper.match(verb, path)
+      blk, path_params, options, is_wild = RequestMapper.match(verb, path)
+
+      match_all = RequestMapper.match('ALL', path) unless blk && !is_wild
+      blk, path_params, options = match_all if match_all && match_all[0] # override
 
-      blk, path_params, options = RequestMapper.match('ALL', path) unless blk
 
       default_format = options && options[:default] && options[:default].to_sym
       force_format = options && options[:force] && options[:force].to_sym
-      do_cache = options && options[:cache]
-      clear_cache = options && options[:cache_reset]
+      do_cache     = options && options[:cache] && !Blix::Rest.cache_disabled
+      clear_cache  = options && options[:cache_reset]
 
       query_format = options && options[:query] && req.GET['format'] && req.GET['format'].to_sym
 
@@ -159,39 +179,49 @@ module Blix::Rest
 
       parser = get_parser(force_format || format)
 
-      return [406, {}, ["Invalid Format: #{format}"]] unless parser
+      unless parser
+        if blk
+          return [406, {}, ["Invalid Format: #{format}"]]
+        else
+          return [404, {}, ["Invalid Url"]]
+        end
+      end
 
       parser._options = options
 
       # check for cached response end return with cached response if found.
       #
-      if do_cache && _cache["#{verb}|#{format}|#{path}"]
-        response = _cache["#{verb}|#{format}|#{path}"]
-        return [response.status, response.headers.merge('X-Blix-Cache' => 'cached'), [response.content]]
+      if do_cache && ( response = _cache["#{verb}|#{format}|#{path}"] )
+        return [response.status, response.headers.merge('x-blix-cache' => 'cached'), response.content]
       end
 
       response = Response.new
 
-      if parser.__custom_headers
-        response.headers.merge! parser.__custom_headers
-      else
-        parser.set_default_headers(response.headers)
-      end
-
       if blk
 
         begin
           params = env['params']
-          value  = blk.call(path_params, params, req, format, response, @_options)
+          context = Context.new(path_params, params, req, format, response, verb, self)
+          value  = blk.call(context)
         rescue ServiceError => e
+          set_default_headers(parser,response)
           response.set(e.status, parser.format_error(e.message), e.headers)
+        rescue RawResponse => e
+          value = e.content
+          value = [value.to_s] unless value.respond_to?(:each) ||  value.respond_to?(:call)
+          response.status  = e.status if e.status
+          response.content = value
+          response.headers.merge!(e.headers) if e.headers
         rescue AuthorizationError => e
+          set_default_headers(parser,response)
           response.set(401, parser.format_error(e.message), AUTH_HEADER => "#{e.type} realm=\"#{e.realm}\", charset=\"UTF-8\"")
         rescue Exception => e
+          set_default_headers(parser,response)
           response.set(500, parser.format_error('internal error'))
           ::Blix::Rest.logger <<  "----------------------------\n#{$!}\n----------------------------"
           ::Blix::Rest.logger <<  "----------------------------\n#{$@}\n----------------------------"
         else # no error
+          set_default_headers(parser,response)
           parser.format_response(value, response)
           # cache response if requested
           _cache.clear if clear_cache
@@ -199,9 +229,19 @@ module Blix::Rest
         end
 
       else
+        set_default_headers(parser,response)
         response.set(404, parser.format_error('Invalid Url'))
       end
-      [response.status, response.headers, [response.content]]
+
+      [response.status.to_i, response.headers, response.content]
+    end
+
+    def set_default_headers(parser,response)
+      if parser.__custom_headers
+        response.headers.merge! parser.__custom_headers
+      else
+        parser.set_default_headers(response.headers)
+      end
     end
 
   end

data/lib/blix/rest/session.rb

@@ -0,0 +1,138 @@
+module Blix::Rest
+
+  module Session
+    #----------------------------------------------------------------------------
+    #
+    #  manage the session and authorization
+    #
+    #----------------------------------------------------------------------------
+
+    DAY = 24 * 60 * 60
+    MIN = 60
+    SESSION_NAME = 'blix'
+
+    SESSION_OPTS = {
+      #:secure=>true,
+      :http => false,
+      :samesite => :lax,
+      :path => Blix::Rest.full_path('/'),
+      :expire_secs => 30 * MIN,       # 30 mins
+      :cleanup_every_secs => 5 * 60   # 5 minutes
+      #:max_age => nil # session cookie
+    }.freeze
+
+
+    def session_manager
+      self.class.get_session_manager
+    end
+
+    def session_name
+      self.class.get_session_name
+    end
+
+    def session_opts
+      self.class.get_session_opts
+    end
+
+    def session
+      @__session
+    end
+
+    def csrf_token
+      @__session['csrf'] ||= SecureRandom.hex(32)
+    end
+
+    def reset_session
+      raise 'login_session missing' unless @__session && @__session_id
+      session_manager.delete_session(@__session_id)
+      @__session_id = refresh_session_id(session_name, session_opts)
+      @__session['csrf'] = SecureRandom.hex(32)
+      session_manager.store_session(@__session_id, @__session)
+    end
+
+    # get a session id and use this to retrieve the session information - if any.
+    #
+    def session_before(opts)
+      @__session = {}
+
+      # do not set session on pages. that will be cached.
+      unless opts[:nosession] || opts[:cache]
+        @__session_id = get_session_id(session_name, session_opts)
+        @__session =
+          begin
+            session_manager.get_session(@__session_id)
+          rescue SessionExpiredError
+            @__session_id = refresh_session_id(session_name, session_opts)
+            session_manager.get_session(@__session_id)
+          end
+      end
+
+      if opts[:csrf]
+        if env["HTTP_X_CSRF_TOKEN"] != csrf_token
+          send_error("invalid csrf token")
+        end
+      end
+
+    end
+
+    # save the session hash before we go.
+    def session_after
+      session_manager.store_session(@__session_id, @__session) if @__session_id
+    end
+
+    private
+
+    def self.included(mod)
+      mod.extend Session::ClassMethods
+    end
+
+    module ClassMethods
+
+      def session_name(name)
+        @_sess_name = name.to_s
+      end
+
+      def session_opts(opts)
+        @_sess_custom_opts = opts
+      end
+
+      def session_manager(man)
+        raise ArgumentError, "incompatible session store" unless man.respond_to?(:get_session)
+        raise ArgumentError, "incompatible session store" unless man.respond_to?(:store_session)
+        raise ArgumentError, "incompatible session store" unless man.respond_to?(:delete_session)
+        @_sess_manager= man
+      end
+
+      def get_session_name
+        @_sess_name ||= begin
+          if superclass.respond_to?(:get_session_name)
+            superclass.get_session_name
+          else
+            SESSION_NAME
+          end
+        end
+      end
+
+      def get_session_opts
+        @_session_opts ||= begin
+          if superclass.respond_to?(:get_session_opts)
+            superclass.get_session_opts.merge(@_sess_custom_opts || {})
+          else
+            SESSION_OPTS.merge(@_sess_custom_opts || {})
+          end
+        end
+      end
+
+      def get_session_manager
+        @_sess_manager ||= begin
+          if superclass.respond_to?(:get_session_manager)
+            superclass.get_session_manager
+          else
+            Blix::RedisStore.new(get_session_opts)
+          end
+        end
+      end
+
+    end # ClassMethods
+  end # Session
+end  # Blix::Rest

data/lib/blix/rest/version.rb

@@ -1,5 +1,5 @@
 module Blix
   module Rest
-    VERSION = "0.1.30"
+    VERSION = "0.8.2"
   end
 end

data/lib/blix/rest.rb

@@ -1,6 +1,8 @@
 require 'base64'
 require 'logger'
 require 'time'
+require 'cgi'
+require 'rack'
 
 module Blix
   module Rest
@@ -8,14 +10,14 @@ module Blix
     # EXPIRED_TOKEN_MESSAGE = 'token expired'
     # INVALID_TOKEN_MESSAGE = 'invalid token'
 
-    CONTENT_TYPE      = 'Content-Type'.freeze
+    CONTENT_TYPE      = 'content-type'.freeze
     CONTENT_TYPE_JSON = 'application/json'.freeze
     CONTENT_TYPE_HTML = 'text/html; charset=utf-8'.freeze
     CONTENT_TYPE_XML  = 'application/xml'.freeze
-    AUTH_HEADER       = 'WWW-Authenticate'.freeze
-    CACHE_CONTROL     = 'Cache-Control'.freeze
+    AUTH_HEADER       = 'www-authenticate'.freeze
+    CACHE_CONTROL     = 'cache-control'.freeze
     CACHE_NO_STORE    = 'no-store'.freeze
-    PRAGMA            = 'Pragma'.freeze
+    PRAGMA            = 'pragma'.freeze
     NO_CACHE          = 'no-cache'.freeze
     URL_ENCODED       = %r{^application/x-www-form-urlencoded}.freeze
     JSON_ENCODED      = %r{^application/json}.freeze # NOTE: "text/json" and "text/javascript" are deprecated forms
@@ -43,6 +45,14 @@ module Blix
       @_logger = val
     end
 
+    def self.cache_disabled
+      @_cache_disabled
+    end
+
+    def self.disable_cache
+      @_cache_disabled = true
+    end
+
     def self.logger
       @_logger ||= begin
         l = Logger.new(STDOUT)
@@ -67,13 +77,10 @@ module Blix
     end
 
     # interpret payload string as json
-    class RawJsonString
-      def initialize(str)
-        @str = str
-      end
+    class RawJsonString < String
 
       def as_json(*_a)
-        @str
+        self
       end
 
       def to_json(*a)
@@ -94,6 +101,19 @@ module Blix
       end
     end
 
+    class RawResponse < StandardError
+      attr_reader :status
+      attr_reader :headers
+      attr_reader :content
+
+      def initialize(message, status = nil, headers = nil)
+        super(message || "")
+        @status  = status
+        @headers = headers
+        @content = message
+      end
+    end
+
     class AuthorizationError < StandardError
       attr_reader :realm, :type
       def initialize(message=nil, realm=nil, type=nil)
@@ -128,8 +148,9 @@ require 'rack'
 require 'blix/rest/response'
 require 'blix/rest/format_parser'
 require 'blix/rest/request_mapper'
+require 'blix/rest/cache'
 require 'blix/rest/server'
-# require 'blix/rest/provider'
+require 'blix/rest/route'
 require 'blix/rest/controller'
 # require 'blix/rest/provider_controller'
 

data/lib/blix/utils/redis_store.rb

@@ -36,7 +36,7 @@ module Blix
     def store_data(id, data)
       params = {}
       params[:ex] = _opts[:expire_secs] if _opts.key?(:expire_secs)
-      redis.set(_key(id), data, params)
+      redis.set(_key(id), data, **params)
       data
     end
 
@@ -89,7 +89,7 @@ module Blix
       params[:ex] = _opts[:expire_secs] if _opts.key?(:expire_secs)
       hash ||= {}
       hash['_last_access'] = Time.now
-      redis.set(_key(id), _encode(hash), params)
+      redis.set(_key(id), _encode(hash), **params)
       hash
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blix-rest
 version: !ruby/object:Gem::Version
-  version: 0.1.30
+  version: 0.8.2
 platform: ruby
 authors:
 - Clive Andrews
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-30 00:00:00.000000000 Z
+date: 2023-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   Rack based framework focused on building JSON REST web services.
   Concentrates on making the basics very easy to write and fast to execute.
@@ -81,6 +95,7 @@ files:
 - LICENSE
 - README.md
 - lib/blix/rest.rb
+- lib/blix/rest/cache.rb
 - lib/blix/rest/controller.rb
 - lib/blix/rest/cucumber.rb
 - lib/blix/rest/cucumber/hooks.rb
@@ -90,10 +105,13 @@ files:
 - lib/blix/rest/format.rb
 - lib/blix/rest/format_parser.rb
 - lib/blix/rest/handlebars_assets_fix.rb
+- lib/blix/rest/redis_cache.rb
 - lib/blix/rest/request_mapper.rb
 - lib/blix/rest/resource_cache.rb
 - lib/blix/rest/response.rb
+- lib/blix/rest/route.rb
 - lib/blix/rest/server.rb
+- lib/blix/rest/session.rb
 - lib/blix/rest/string_hash.rb
 - lib/blix/rest/version.rb
 - lib/blix/utils.rb
@@ -119,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Framework for HTTP REST services