blix-rest 0.1.30

data/lib/blix/utils/redis_store.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require 'redis'
+# require 'msgpack'
+
+#
+#  options:
+#     :expire_secs           - how long store should save data.
+#     :reset_expire_on_get   - start the expire timer again on read.
+
+module Blix
+  class RedisStore
+
+    attr_reader :_opts, :_prefix
+
+    STORE_PREFIX = 'session'
+
+    def initialize(opts = {})
+      @_opts = ::Blix::Rest::StringHash.new
+      @_opts[:prefix] = STORE_PREFIX
+      @_opts.merge!(opts)
+      @_prefix = _opts[:prefix]
+    end
+
+    #-----------------------------------------------------------------------------
+
+    # retrieve raw data and reset the expire time.
+    def get_data(id)
+      k = _key(id)
+      data = redis.get(k)
+      redis.expire(k, _opts[:expire_secs]) if data && _opts[:reset_expire_on_get] && _opts.key?(:expire_secs)
+      data
+    end
+
+    # store raw data
+    def store_data(id, data)
+      params = {}
+      params[:ex] = _opts[:expire_secs] if _opts.key?(:expire_secs)
+      redis.set(_key(id), data, params)
+      data
+    end
+
+    # delete a record from the store
+    def delete_data(id)
+      redis.del(_key(id))
+    end
+
+    # if decoding does not succeed then delete the data
+    # and return nil.
+    def get_hash(id)
+      str = get_data(id)
+      str && begin
+        _decode(str)
+      rescue Exception =>e
+        delete_data(id)
+        nil
+      end
+    end
+
+    def store_hash(id,hash)
+      store_data(id, _encode(hash || {}))
+      hash
+    end
+
+    # retrieve a session hash.
+    def get_session(id,opts={})
+      str = redis.get(_key(id))
+      opts = ::Blix::Rest::StringHash.new.merge(opts)
+      hash = begin
+        str && ::Blix::Rest::StringHash.new(_decode(str))
+      rescue
+        redis.del(_key(id))
+        hash = nil
+      end
+      if hash && (min_time = get_expiry_time(opts)) && (hash['_last_access'] < min_time)
+        delete_session(id)
+        raise SessionExpiredError
+      end
+      raise SessionExpiredError if !hash && opts[:nocreate]
+
+      hash ||= ::Blix::Rest::StringHash.new
+      hash['_last_access'] = Time.now
+      hash
+    end
+
+    # store a session hash
+    def store_session(id, hash)
+      params = {}
+      params[:ex] = _opts[:expire_secs] if _opts.key?(:expire_secs)
+      hash ||= {}
+      hash['_last_access'] = Time.now
+      redis.set(_key(id), _encode(hash), params)
+      hash
+    end
+
+    # delete a seession from the store
+    def delete_session(id)
+      redis.del(_key(id))
+    end
+
+    def _key(name)
+      _prefix + name
+    end
+
+
+
+    #-----------------------------------------------------------------------------
+
+    # remove all sessions from the store
+    def reset(name=nil)
+      keys = _all_keys(name)
+      redis.del(*keys) unless keys.empty?
+    end
+
+    def _all_keys(name=nil)
+      redis.keys("#{_prefix}#{name}*") || []
+    end
+
+    # the redis session store
+    def redis
+      @redis ||= begin
+        r = Redis.new
+        begin
+          r.ping
+        rescue Exception => e
+          Blix::Rest.logger.error "cannot reach redis server:#{e}"
+          raise
+        end
+        r
+      end
+    end
+
+    # the number of sessions in the store
+    def length
+      _all_keys.length
+    end
+
+    # delete expired sessions from the store. this should be handled
+    # automatically by redis if the ttl is set on save correctly
+    def cleanup(opts = nil); end
+
+    def _encode(data)
+      Marshal.dump(data)
+    end
+
+    def _decode(msg)
+      Marshal.load(msg)
+    end
+
+    # redis takes care of this operation
+    def run_cleanup_thread(opts = nil); end
+
+    # redis takes care of this operation
+    def stop_cleanup_thread(_opts = nil); end
+
+    def cleaning?
+      false
+    end
+
+    private
+
+    def get_expiry_time(opts)
+      if expire = opts[:expire_secs] || opts['expire_secs']
+        Time.now - expire
+      end
+    end
+
+    def get_expiry_secs(opts)
+      opts[:expire_secs] || opts['expire_secs']
+    end
+
+  end
+end

data/lib/blix/utils/yaml_config.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+require 'yaml'
+
+module Blix
+  # read a configuration hash from a yaml file depending on the current environment
+  # and using a user specified file or default locations.
+  #
+  # options:
+  #   :name     # the config file name
+  #   :file     # the fixed file name
+
+  class YamlConfig
+
+    HOME_DIR = ENV['HOME'] || Dir.pwd
+    DEFAULT_FILE_NAME = 'blix'
+    DEFAULT_CONFIG_DIR = 'config'
+
+    class ConfigError < StandardError; end
+
+    # create a new configuration object
+    def initialize(*args)
+      if args.length > 2
+        raise ConfigError, 'too many arguments'
+      elsif args.length > 1
+        opts = args[1]
+        env = args[0]
+      elsif !args.empty?
+        if args[0].is_a? Hash
+          opts = args[0]
+          env = if defined? Blix::Rest.environment
+                  Blix::Rest.environment
+                else
+                  ENV['RACK_ENV']
+                end
+        else
+          opts = {}
+          env = args[0]
+        end
+      else
+        opts = {}
+        env = Blix::Rest.environment
+      end
+
+      raise ConfigError, 'environment required!' unless env
+
+      file_name = opts['name'] || opts[:name] || DEFAULT_FILE_NAME
+      file_name = file_name.to_s
+      file_name += '.yml' unless file_name[-4, 4] == '.yml'
+
+      # look for a file
+      if config_file = opts['file'] || opts[:file]
+        config_file = config_file.to_s
+        unless File.exist?(config_file)
+          raise ConfigError, "blix config file:#{config_file} not found"
+        end
+      elsif File.exist?("#{HOME_DIR}/.#{file_name}")
+        config_file = "#{HOME_DIR}/.#{file_name}"
+      elsif File.exist?("#{DEFAULT_CONFIG_DIR}/#{file_name}")
+        config_file = "#{DEFAULT_CONFIG_DIR}/#{file_name}"
+      else
+        raise ConfigError, 'no blix config file found - pass as :file / :name  parameter or default config/blix.yml or ~.blix.yml'
+      end
+
+      yaml = YAML.safe_load File.read(config_file)
+      raise ConfigError, "cannot read yaml configuration data from #{config_file} for environment:#{env} " unless yaml && yaml.key?(env.to_s)
+      @config = yaml[env.to_s] || {}
+    end
+
+    def [](k)
+      @config[k.to_s]
+    end
+
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: blix-rest
+version: !ruby/object:Gem::Version
+  version: 0.1.30
+platform: ruby
+authors:
+- Clive Andrews
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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.
+  Fully extensible through RACK middleware and your own code
+email:
+- gems@realitybites.eu
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/blix/rest.rb
+- lib/blix/rest/controller.rb
+- lib/blix/rest/cucumber.rb
+- lib/blix/rest/cucumber/hooks.rb
+- lib/blix/rest/cucumber/request_steps.rb
+- lib/blix/rest/cucumber/resource_steps.rb
+- lib/blix/rest/cucumber/world.rb
+- lib/blix/rest/format.rb
+- lib/blix/rest/format_parser.rb
+- lib/blix/rest/handlebars_assets_fix.rb
+- lib/blix/rest/request_mapper.rb
+- lib/blix/rest/resource_cache.rb
+- lib/blix/rest/response.rb
+- lib/blix/rest/server.rb
+- lib/blix/rest/string_hash.rb
+- lib/blix/rest/version.rb
+- lib/blix/utils.rb
+- lib/blix/utils/misc.rb
+- lib/blix/utils/redis_store.rb
+- lib/blix/utils/yaml_config.rb
+homepage: https://github.com/realbite/blix-rest
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Framework for HTTP REST services
+test_files: []