culpa 2.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f32f675f29fa3dabc13a81c5862761de1452734a
-  data.tar.gz: 53d2dc0997562fb55f6eb4a1723fb805caf84ceb
+  metadata.gz: 03c0b8f371e586acd616e7bb39cef52ee97f5d47
+  data.tar.gz: 4ea587fdcbf158a2d3a4c9287fb05ae356b6df3a
 SHA512:
-  metadata.gz: 974d73a51e9ac4b4ebc8f905dd341bc6968f606fdd8c58e949f2b44aa91d4173f5e8ab237ff1efb2b6bd4f67bbdd05dfe578d18442eda0ef0ad343ea2f9147c0
-  data.tar.gz: 71c74d3e04522db35ac7ece51b8a9a612660935b0901730988f5dd793c6d336692d7f659579325a1f7a46fbf2ee53ed21af3b31f4604d9be616bd4812dd428c3
+  metadata.gz: 5e6036bf3ab63c1cdbf1ecd5fb4b4661b25d44c13f369e496ff1cccea831697b4bc4394a6598eb52e711efde67f7cbabd6642c740053319313d9951eb66ec863
+  data.tar.gz: c9de6db1d777c3c79f4bdf9acac33495393dd3b3a4a3981df80df8d38e2b393920e1e411d21a82c66ab00e5f698d3f0e9c84202838913e6ac66f943bda45887c

data/bin/culpa

@@ -34,6 +34,10 @@ def create_project(project_path)
   config_rackup_path = File.join(File.dirname(__FILE__), '../templates/culpa/config.ru')
   FileUtils.cp config_rackup_path, "#{project_path}/config.ru"
 
+  puts '==> Copying standard config.yml'
+  config_yml_path = File.join(File.dirname(__FILE__), '../templates/culpa/config.yml')
+  FileUtils.cp config_yml_path, "#{project_path}/config/config.yml"
+
   puts '==> Copying Dockerfile'
   dockerfile_rackup_path = File.join(File.dirname(__FILE__), '../templates/culpa/Dockerfile')
   FileUtils.cp dockerfile_rackup_path, "#{project_path}/Dockerfile"

data/lib/culpa.rb

@@ -8,6 +8,7 @@ require_relative 'culpa/path_parser'
 require_relative 'culpa/routes_builder'
 require_relative 'culpa/brickchain_helpers'
 require_relative 'culpa/version'
+require_relative 'culpa/session'
 
 ACTIONS_PATH ||= './actions/*.rb'.freeze
 MODELS_PATH ||= './models/*.rb'.freeze
@@ -52,6 +53,8 @@ module Culpa
       bc_path = options[:brickchains] || './config/brickchains.rb'
       route_builder = RoutesBuilder.new(File.read(bc_path))
       @router = route_builder.result
+      # Loads configuration file
+      @configuration = YAML.load_file(options[:config] || './config/config.yml')
       PathParser.create_route_cache(@router, route_builder.prefix || '')
       # Setting static file directory
       @public_folder = options[:public] || route_builder.public_folder || './public'
@@ -92,9 +95,17 @@ module Culpa
       else
         request[:input] = env['rack.input']
       end
-      # Extract vars from path, take route decision and go !
+      # Extract vars from path, creates session object, take route decision and go !
+      session_id = env.has_key?('HTTP_X_SESSION_ID') ? env['HTTP_X_SESSION_ID'] : nil
+      session_obj = if @configuration.has_key? 'session'
+        Session.new(@configuration['session']['driver'],
+                    @configuration['session']['configuration'],
+                    session_id)
+      else
+        Session.new('InMemory', {'duration' => 600}, session_id)
+      end
       method_name, f_request = PathParser.extract_vars(env['PATH_INFO'], request)
-      call_brickchain method_name, f_request
+      call_brickchain method_name, f_request, session_obj
     rescue UnpredictableSubCallError, MultiJson::ParseError
       # The sub_call wasn't predictacle, or the body wans't correct JSON.
       # In both cases, it is a bad_request.
@@ -127,7 +138,7 @@ module Culpa
 
     ##
     # Call a brickchain using the method_name associated to it
-    def call_brickchain(router_method_name, options)
+    def call_brickchain(router_method_name, options, session_obj)
       # Loading the router method
       raise RouteNotFoundError unless @router.key? router_method_name
       route = @router[router_method_name]
@@ -137,34 +148,38 @@ module Culpa
       request = EnvelopeRequest.new(options)
       # Execute before blocks in the brickchain
       route[:before].each do |before_block|
-        BrickchainExecutor.new(envelope, request).instance_eval(&before_block)
+        BrickchainExecutor.new(envelope, request, session_obj).instance_eval(&before_block)
       end if route.key? :before
       # Execute the brickchain itself
       if route.key? :block
-        BrickchainExecutor.new(envelope, request).instance_eval(&route[:block])
+        BrickchainExecutor.new(envelope, request, session_obj).instance_eval(&route[:block])
       else
-        ch = CallHolder.new(route[:brick_name], envelope, request)
+        ch = CallHolder.new(route[:brick_name], envelope, request, session_obj)
         ch.from(route[:class_name])
       end
       # If we come to this point, the brickchain haven't raised the RenderNow.
       # It means there is a problem with the brickchain since it has a path
       # that didn't render.
+      session_obj.close
       raise NoRenderCalled
     rescue Action::RenderNow => renderer
-      return do_render(renderer.to_render)
+      return do_render(renderer.to_render, session_obj)
     end
 
     ##
     # Method called after a correct Action::RenderNow have been raised
-    def do_render(to_render)
+    def do_render(to_render, session_obj)
       body = case to_render[:format]
-             when :json
-               [::MultiJson.dump(to_render[:object], pretty: ENV['RACK_ENV'] == 'development')]
-             when :file_from_path, :file_from_io
-               to_render[:object]
-             when :status
-               []
+               when :json
+                 [::MultiJson.dump(to_render[:object], pretty: ENV['RACK_ENV'] == 'development')]
+               when :string
+                 [to_render[:object]]
+               when :file_from_path, :file_from_io
+                 to_render[:object]
+               when :status
+                 []
              end
+      session_obj.close
       [to_render[:status], to_render[:headers], body]
     end
 

data/lib/culpa/action.rb

@@ -17,7 +17,7 @@ class Action
     end
   end
 
-  attr_reader :e, :r
+  attr_reader :e, :r, :session
 
   class RenderNow < StandardError
     attr_reader :to_render
@@ -26,9 +26,10 @@ class Action
     end
   end
 
-  def initialize(envelope, request)
+  def initialize(envelope, request, session)
     @e = envelope
     @r = request
+    @session = session
   end
 
   def method_missing(sym)

data/lib/culpa/brickchain_helpers.rb

@@ -2,6 +2,7 @@ module Culpa
 
   class BrickchainExecutor
     attr_reader :envelope
+    attr_reader :session
 
     @@injected_keywords = {}
 
@@ -9,13 +10,14 @@ module Culpa
       @@injected_keywords[keyword] = call
     end
 
-    def initialize(envelope, request)
+    def initialize(envelope, request, session)
       @envelope = envelope
       @request = request
+      @session = session
     end
 
     def async(&blk)
-      asb = AsyncBrickchain.new(@envelope, @request)
+      asb = AsyncBrickchain.new(@envelope, @request, @session)
       asb.instance_eval(&blk)
       asb.chs.each { |call_holder| call_holder.thread.join }
     end
@@ -29,7 +31,7 @@ module Culpa
         method = @@injected_keywords[sym]
         instance_exec args, &method
       else
-        CallHolder.new(sym.to_s, @envelope, @request)
+        CallHolder.new(sym.to_s, @envelope, @request, @session)
       end
     end
   end
@@ -38,14 +40,15 @@ module Culpa
     attr_reader :envelope
     attr_reader :chs
 
-    def initialize(envelope, request)
+    def initialize(envelope, request, session)
       @envelope = envelope
       @request = request
+      @session = session
       @chs = []
     end
 
     def method_missing(sym)
-      @chs << CallHolder.new(sym.to_s, @envelope, @request, true)
+      @chs << CallHolder.new(sym.to_s, @envelope, @request, @session, true)
       @chs.last
     end
   end
@@ -53,10 +56,11 @@ module Culpa
   class CallHolder
     attr_reader :thread
 
-    def initialize(brickname, envelope, request, async = false)
+    def initialize(brickname, envelope, request, session, async = false)
       @brickname = brickname
       @envelope = envelope
       @request = request
+      @session = session
       @async = async
     end
 
@@ -76,7 +80,7 @@ module Culpa
 
     def get_action(name)
       action_name = name.split('_').map(&:capitalize).join
-      Actions.const_get(action_name).new(@envelope, @request)
+      Actions.const_get(action_name).new(@envelope, @request, @session)
     end
 
   end

data/lib/culpa/envelope.rb

@@ -29,9 +29,7 @@ module Culpa
     def ==(other_envelope)
       return false unless other_envelope.is_a? Envelope
       return false unless other_envelope.instance_variables.count == instance_variables.count
-      instance_variables.select do |iv|
-        iv != :@semaphore
-      end.each do |iv|
+      instance_variables.select{ |iv| iv != :@semaphore }.each do |iv|
         return false unless instance_variable_get(iv) == other_envelope.instance_variable_get(iv)
       end
       true

data/lib/culpa/session.rb

@@ -0,0 +1,27 @@
+require_relative 'session_drivers/in_memory'
+
+# This is the decorator class against Session drivers
+class Session
+
+  def initialize(backend, options, session_id)
+    @backend = Culpa::SessionDrivers.const_get(backend).new(options, session_id)
+  end
+
+  def close
+    @backend.close if @backend.respond_to? :close
+  end
+
+  def id
+    @backend.session_id
+  end
+
+  def has_keys?(*keys)
+    keys.each { |key| return false unless @backend.has_key?(key) }
+    true
+  end
+
+  def method_missing(sym, *args, &blk)
+    @backend.send(sym, *args, &blk)
+  end
+
+end

data/lib/culpa/session_drivers/in_memory.rb

@@ -0,0 +1,66 @@
+require 'securerandom'
+
+module Culpa::SessionDrivers
+
+  class InMemory
+
+    attr_reader :session_id
+
+    @@persist = {}
+
+    def initialize(options, session_id)
+      @options = options
+      @session_id = session_id || SecureRandom.hex
+      generate_session_struct unless session_exists?
+    end
+
+    def clear!
+      @@persist.delete(@session_id)
+    end
+
+    def [](k)
+      return nil unless is_valid?
+      session_prologation
+      @@persist[@session_id][:data][k]
+    end
+
+    def []=(k,v)
+      session_prologation
+      @@persist[@session_id][:data][k] = v
+    end
+
+    def has_key?(key)
+      return false unless is_valid?
+      @@persist[@session_id][:data].has_key? key
+    end
+
+    def merge!(new_hash)
+      @@persist[@session_id][:data].merge!(new_hash)
+    end
+
+    private
+
+      def session_exists?
+        @@persist.has_key?(@session_id)
+      end
+
+      def generate_session_struct
+        unless @@persist.has_key?(@session_id)
+          @@persist[@session_id] = {}
+          @@persist[@session_id][:data] = {}
+          @@persist[@session_id][:expire] = Time.new.to_i + @options['duration']
+        end
+      end
+
+      def is_valid?
+        @@persist.has_key?(@session_id) and \
+          @@persist[@session_id][:expire] > Time.new.to_i
+      end
+
+      def session_prologation
+        @@persist[@session_id][:expire] = Time.new.to_i + @options['duration']
+      end
+
+  end
+
+end

data/lib/culpa/test_helpers.rb

@@ -1,5 +1,6 @@
 require_relative 'envelope'
 require_relative 'action'
+require_relative 'session'
 require 'rspec/expectations'
 
 module CulpaHelpers
@@ -22,6 +23,7 @@ module CulpaHelpers
 
     def initialize(brick_name)
       @brick_name = brick_name.to_s
+      @session = Session.new('InMemory', {'duration' => 600}, nil)
       @from_done = false
     end
 
@@ -31,6 +33,10 @@ module CulpaHelpers
       self
     end
 
+    def with_session(hash)
+      @session.merge!(hash)
+    end
+
     def with(opts)
       opts[:envelope] ||= {}
       @envelope = Culpa::Envelope.new(opts[:envelope])
@@ -44,7 +50,7 @@ module CulpaHelpers
       return @call_cache if @call_done
       @envelope ||= Culpa::Envelope.new({})
       @params ||= Culpa::EnvelopeRequest.new({})
-      @action_const.new(@envelope, @params).send(@brick_name)
+      @action_const.new(@envelope, @params, @session).send(@brick_name)
       @call_done = true
       return @call_cache = { to_render: nil, envelope: @envelope }
     rescue Action::RenderNow => renderer

data/lib/culpa/version.rb

@@ -1 +1 @@
-CULPA_VERSION = '2.0.1'.freeze
+CULPA_VERSION = '2.1.1'.freeze

data/templates/culpa/Gemfile

@@ -1,9 +1,11 @@
 source 'https://rubygems.org'
 
 # The MEA framework
-gem 'culpa', '~> 2.0'
+gem 'culpa', '~> 2.1'
 # Coliseum extension to describe JSON in an elegent way
-gem 'culpa-coliseum', '~> 2.0'
+gem 'culpa-coliseum', '~> 2.1'
+# If you want to use Redis as a backend for sessions, uncomment :
+# gem 'culpa-redis', '~> 2.1'
 
 # Use rspec to test your project.
 gem 'rspec', '~> 3.4'

data/templates/culpa/config.yml

@@ -0,0 +1,10 @@
+# This is the main configuration file of Culpa
+# Check the guides at http://culpaframework.org/guides.html for more information
+
+production:
+  log_level: WARN
+
+session:
+  driver: InMemory
+  configuration:
+    duration: 600

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: culpa
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.1
 platform: ruby
 authors:
 - Jérémy SEBAN
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-27 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -84,11 +84,14 @@ files:
 - lib/culpa/renderers/json.rb
 - lib/culpa/renderers/status.rb
 - lib/culpa/routes_builder.rb
+- lib/culpa/session.rb
+- lib/culpa/session_drivers/in_memory.rb
 - lib/culpa/test_helpers.rb
 - lib/culpa/version.rb
 - templates/culpa/Dockerfile
 - templates/culpa/Gemfile
 - templates/culpa/config.ru
+- templates/culpa/config.yml
 - templates/culpa/generators/action.tmpl
 - templates/culpa/index.html
 - templates/culpa/logo.png