fragmentary 0.1.0 → 0.3

data/lib/fragmentary/request_queue.rb

@@ -1,22 +1,21 @@
-require 'fragmentary/user_session'
-
 module Fragmentary
 
   class RequestQueue
 
-    @@all = []
-
     def self.all
-      @@all
+      @@all ||= []
     end
 
-    attr_reader :requests, :user_type, :sender
+    attr_reader :requests, :user_type, :host_root_url
 
-    def initialize(user_type)
+    def initialize(user_type, host_root_url)
       @user_type = user_type
+      # host_root_url represents where the queued *requests* are to be processed. For internal sessions it also represents where
+      # the *queue* will be processed by delayed_job. For external requests, the queue will be processed by the host creating the
+      # queue and the requests will be explicitly sent to the host_root_url.
+      @host_root_url = host_root_url
       @requests = []
-      @sender = Sender.new(self)
-      @@all << self
+      self.class.all << self
     end
 
     def <<(request)
@@ -30,21 +29,6 @@ module Fragmentary
       @requests.size
     end
 
-    def session
-      @session ||= new_session
-    end
-
-    def new_session
-      case user_type
-      when 'signed_in'
-        UserSession.new('Bob')
-      when 'admin'
-        UserSession.new('Alice', :admin => true)
-      else
-        UserSession.new
-      end
-    end
-
     def next_request
       @requests.shift
     end
@@ -53,14 +37,14 @@ module Fragmentary
       @requests = []
     end
 
-    def clear_session
-      @session = nil
-    end
-
     def remove_path(path)
       requests.delete_if{|r| r.path == path}
     end
 
+    def sender
+      @sender ||= Sender.new(self)
+    end
+
     def send(**args)
       sender.start(args)
     end
@@ -70,32 +54,39 @@ module Fragmentary
     end
 
     class Sender
+
       class << self
         def jobs
           ::Delayed::Job.where("(handler LIKE ?) OR (handler LIKE ?)", "--- !ruby/object:#{name} %", "--- !ruby/object:#{name}\n%")
         end
       end
 
+      class Target
+
+        attr_reader :url
+
+        def initialize(url)
+          @url = url
+        end
+
+        def queue_name
+          @url.gsub(%r{https?://}, '')
+        end
+      end
+
       attr_reader :queue
 
       def initialize(queue)
         @queue = queue
+        @target = Target.new(queue.host_root_url)
       end
 
-      def next_request
-        queue.next_request.to_proc
-      end
-
-      def send_next_request
-        if queue.size > 0
-          queue.session.instance_exec(&(next_request))
-        end
+      def session_user
+        @session_user ||= Fragmentary::SessionUser.fetch(queue.user_type)
       end
 
-      def send_all_requests
-        while queue.size > 0
-          send_next_request
-        end
+      def session
+        @session ||= InternalUserSession.new(@target.url, session_user)
       end
 
       # Send all requests, either directly or by schedule
@@ -117,23 +108,41 @@ module Fragmentary
         @between ? send_next_request : send_all_requests
       end
 
+      def send_next_request
+        if queue.size > 0
+          request = queue.next_request
+          session.send_request(:method => request.method, :path => request.path, :parameters => request.parameters, :options => request.options)
+        end
+      end
+
       def success
         schedule_requests(@between) if queue.size > 0
       end
 
       private
 
+      def send_all_requests
+        while queue.size > 0
+          send_next_request
+        end
+      end
+
       def schedule_requests(delay=0.seconds)
         if queue.size > 0
-          queue.clear_session
+          clear_session
           Delayed::Job.transaction do
             self.class.jobs.destroy_all
-            Delayed::Job.enqueue self, :run_at => delay.from_now
+            Delayed::Job.enqueue self, :run_at => delay.from_now, :queue => @target.queue_name
           end
         end
       end
 
+      def clear_session
+        @session = nil
+      end
+
     end
 
   end
+
 end

data/lib/fragmentary/session_user.rb

@@ -0,0 +1,38 @@
+module Fragmentary
+
+  class SessionUser
+
+    def self.all
+      @@all ||= Hash.new
+    end
+
+    def self.fetch(key)
+      all[key]
+    end
+
+    def initialize(user_type, options={})
+      if user = self.class.fetch(user_type)
+        if user.options != options
+          raise RangeError, "You can't redefine an existing SessionUser object: #{user_type.inspect}"
+        else
+          user
+        end
+      else
+        @user_type = user_type
+        @options = options
+        self.class.all.merge!({user_type => self})
+      end
+    end
+
+    def credentials
+      options[:credentials]
+    end
+
+    protected
+    def options
+      @options
+    end
+
+  end
+
+end

data/lib/fragmentary/subscriber.rb

@@ -24,7 +24,9 @@ module Fragmentary
 
     def subscribe_to(publisher, block)
       if subscriptions[publisher.name]
-        instance_exec(&block)
+        mod = Module.new
+        mod.module_exec(&block)
+        self.extend mod
       end
     end
 

data/lib/fragmentary/subscription.rb

@@ -44,7 +44,7 @@ module Fragmentary
     end
 
     include ActiveSupport::Callbacks
-    define_callbacks :after_destroy
+    define_callbacks :after_create, :after_destroy
 
     attr_reader :subscriber
     attr_accessor :record
@@ -55,7 +55,10 @@ module Fragmentary
     end
 
     def after_create(record)
-      call_method(:"create_#{record.class.model_name.param_key}_successful", record)
+      run_callbacks :after_create do
+        @record = record
+        call_method(:"create_#{record.class.model_name.param_key}_successful", record)
+      end
     end
 
     def after_update(record)

data/lib/fragmentary/user_session.rb

@@ -1,53 +1,155 @@
 require 'rails/console/app'
+require 'http'
+require 'nokogiri'
 
 module Fragmentary
 
-  class UserSession
+  class InternalUserSession
 
     include Rails::ConsoleMethods
 
-    attr_reader :session, :user
-
-    def initialize(*user, &block)
+    def initialize(target, user=nil, &block)
       # app is from Rails::ConsoleMethods. It returns an object ActionDispatch::Integration::Session.new(Rails.application)
       # with some extensions. See https://github.com/rails/rails/blob/master/railties/lib/rails/console/app.rb
       # The session object has instance methods get, post etc.
       # See https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/testing/integration.rb
       @session = app
-      sign_in if @user = get_user(*user)
+      @user = user
+      @target = URI.parse(target)
+      @session.host! session_host
+      sign_in if session_credentials
       instance_eval(&block) if block_given?
     end
 
-    def method_missing(method, *args)
-      session.send(method, *args)
+    def session_host
+      @session_host ||= @target.host + (port=@target.port ? ":#{port}" : "")
     end
 
-    def sign_out
-      post '/users/sign_out', {:_method => 'delete', :authenticity_token => request.session[:_csrf_token]}
+    def session_sign_in_path
+      @sign_in_path ||= Fragmentary.config.get_sign_in_path
+    end
+
+    def session_sign_out_path
+      @sign_out_path ||= Fragmentary.config.sign_out_path
+    end
+
+    def session_credentials
+      return nil unless @user
+      @credentials ||= begin
+        credentials = @user.credentials
+        credentials.is_a?(Proc) ? credentials.call : credentials
+      end
+    end
+
+    def relative_url_root
+      @relative_url_root ||= Rails.application.config.relative_url_root
+    end
+
+    def session_options
+      @session_options ||= relative_url_root ? {:env => {'SCRIPT_NAME' => relative_url_root}} : {}
+    end
+
+    def method_missing(method, *args)
+      @session.send(method, *args)
     end
 
     def sign_in
-      get "/users/sign_in"  # necessary in order to get the csrf token
+      raise "Can't sign in without user credentials" unless session_credentials
+      send_request(:method => :get, :path => session_sign_in_path, :options => session_options)  # necessary in order to get the csrf token
       # NOTE: In Rails 5, params is changed to a named argument, i.e. :params => {...}. Will need to be changed.
-      post "/users/sign_in", {:user => {:email => user.email, :password => user.try(:password)},
-                              :authenticity_token => request.session[:_csrf_token]}
-      if session.redirect?
+      # Note that request is called on session, returning an ActionDispatch::Request; request.session is an ActionDispatch::Request::Session
+      puts "      * Signing in as #{session_credentials.inspect}"
+      parameters = session_credentials.merge(:authenticity_token => request.session[:_csrf_token])
+      send_request(:method => :post, :path => session_sign_in_path, :parameters => parameters, :options => session_options)
+      if @session.redirect?
         follow_redirect!
       else
-        raise "Sign in failed for user #{user.name} #{user.password}"
+        raise "Sign in failed with credentials #{@credentials.inspect}"
+      end
+    end
+
+    def follow_redirect!
+      raise "not a redirect! #{status} #{status_message}" unless redirect?
+      if (url = response.location) =~ %r{://}
+        destination = URI.parse(url)
+        path = destination.query ? "#{destination.path}?#{destination.query}" : destination.path
+      end
+      path = relative_url_root ? path.gsub(Regexp.new("^#{relative_url_root}"), "") : path
+      send_request(:method => :get, :path => path, :options => session_options)
+      status
+    end
+
+    def send_request(method:, path:, parameters: nil, options: {})
+      options.merge!({:params => parameters})
+      options.merge!(session_options)
+      if options.try(:[], :xhr)
+        Rails.logger.info "      * Sending xhr request '#{method.to_s} #{path}'" + (!parameters.nil? ? " with #{parameters.inspect}" : "")
+      else
+        Rails.logger.info "      * Sending request '#{method.to_s} #{path}'" + (!parameters.nil? ? " with #{parameters.inspect}" : "")
       end
+      @session.send(method, path, options)
+    end
+
+    def sign_out
+      # request is called on session, returning an ActionDispatch::Request; request.session is an ActionDispatch::Request::Session
+      parameters = {:_method => 'delete', :authenticity_token => request.session[:_csrf_token]}
+      send_request(:method => :post, :path => session_sign_out_path, :parameters => parameters, :options => session_options)
+    end
+
+  end
+
+  class ExternalUserSession
+
+    def initialize(target, user=nil)
+      @target = URI.parse(target)
+      @relative_url_root = @target.path
+      @session = HTTP.persistent(target)
+      @cookie = nil
+      @authenticity_token = nil
+      sign_in if @credentials = session_credentials(user)
     end
 
-    private
-    def get_user(*attrs)
-      return nil if attrs.nil?
-      if (user = attrs.shift).is_a? User and user.password
-        user
-      elsif user.is_a? String
-        User.test_user(user, :admin => attrs.shift.try(:delete, :admin))
+    def send_request(method:, path:, parameters: nil, options: {})
+      if options.try(:[], :xhr)
+        Rails.logger.info "      * Sending xhr request '#{method.to_s} #{path}'" + (!parameters.nil? ? " with #{parameters.inspect}" : "")
+      else
+        Rails.logger.info "      * Sending request '#{method.to_s} #{path}'" + (!parameters.nil? ? " with #{parameters.inspect}" : "")
+      end
+      unless path =~ %r{://}
+        path = @relative_url_root + path
+      end
+      cookies = @cookie ? {@cookie.name.to_sym => @cookie.value} : {}
+      headers = options.try(:delete, :headers) || {}
+      headers.merge!({:'X-Requested-With' => 'XMLHttpRequest'}) if options.try(:delete, :xhr)
+      response = @session.cookies(cookies).headers(headers).send(method, path, {:json => parameters})
+      @cookie = response.cookies.first
+      @authenticity_token = Nokogiri::HTML.parse(response.to_s).css('head meta[name="csrf-token"]').first.try(:[], 'content')
+      if (response.code >=300) && (response.code <=399)
+        location = response.headers[:location]
+        options = {:headers => {:accept => "text/html,application/xhtml+xml,application/xml"}}
+        response = send_request(:method => :get, :path => location, :parameters => nil, :options => options)
       end
+      response
+    end
+
+    def session_credentials(user)
+      credentials = user.try(:credentials)
+      credentials.is_a?(Proc) ? credentials.call : credentials
     end
 
+    def sign_in
+      # The first request retrieves the authentication token
+      response = send_request(:method => :get, :path => Fragmentary.config.get_sign_in_path)
+      puts "      * Signing in as #{@credentials.inspect}"
+      response = send_request(:method => :post, :path => Fragmentary.config.post_sign_in_path,
+                              :parameters => @credentials.merge(:authenticity_token => @authenticity_token),
+                              :options => {:headers => {:accept => "text/html,application/xhtml+xml,application/xml"}})
+    end
+
+    def sign_out
+      send_request(:method => :delete, :path => Fragmentary.config.sign_out_path, :parameters => {:authenticity_token => @authenticity_token})
+      @session.close
+    end
   end
 
 end

data/lib/fragmentary/version.rb

@@ -1,3 +1,3 @@
 module Fragmentary
-  VERSION = "0.1.0"
+  VERSION = "0.3"
 end

data/lib/fragmentary/widget.rb

@@ -1,7 +1,7 @@
 module Fragmentary
 
   class Widget
-    attr_reader :template, :key, :match
+    attr_reader :template, :match
 
     def self.inherited subclass
       super if defined? super
@@ -18,7 +18,6 @@ module Fragmentary
 
     def initialize(template, key)
       @template = template
-      @key = key
       @match = key.match(pattern)
     end
 
@@ -30,6 +29,8 @@ module Fragmentary
       match ? content : nil
     end
 
+    private
+
     def content
       "Undefined Widget"
     end
@@ -41,13 +42,15 @@ module Fragmentary
 
     def initialize(template, key)
       super
-      @current_user = template.respond_to?(:current_user) ? template.current_user : nil
+      @current_user = Fragmentary::Template.new(template).current_user
     end
 
     def _content
       match ? user_content : nil
     end
 
+    private
+
     def user_content
       current_user ? content : ""
     end

data/lib/fragmentary/widget_parser.rb

@@ -4,7 +4,7 @@ module Fragmentary
 
     include ActionView::Helpers::JavaScriptHelper
 
-    attr_reader :template, :current_user, :widget_container
+    attr_reader :template, :widget_container
 
     def initialize(template)
       @template = template
@@ -31,7 +31,7 @@ module Fragmentary
             widget._content
           end
         else
-          "Oops! Widget not found."
+          "Oops! Widget for #{widget_key} not found."
         end
       end
       # The gsub replaces instances of '%' that aren't part of widget specifications with '%%', preventing

data/lib/fragmentary.rb

@@ -1,4 +1,5 @@
 require 'fragmentary/version'
+require 'fragmentary/config'
 require 'fragmentary/fragments_helper'
 require 'fragmentary/subscriber'
 require 'fragmentary/request_queue'
@@ -6,6 +7,16 @@ require 'fragmentary/request'
 require 'fragmentary/fragment'
 require 'fragmentary/handler'
 require 'fragmentary/user_session'
+require 'fragmentary/session_user'
 require 'fragmentary/widget_parser'
 require 'fragmentary/widget'
 require 'fragmentary/publisher'
+
+module Fragmentary
+  def self.config
+    @config ||= Fragmentary::Config.instance
+    yield @config if block_given?
+    @config
+  end
+  class << self; alias setup config; end
+end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fragmentary
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: '0.3'
 platform: ruby
 authors:
 - Mark Thomson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-07 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: delayed_job_active_record
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +132,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -118,6 +141,7 @@ files:
 - bin/setup
 - fragmentary.gemspec
 - lib/fragmentary.rb
+- lib/fragmentary/config.rb
 - lib/fragmentary/dispatcher.rb
 - lib/fragmentary/fragment.rb
 - lib/fragmentary/fragments_helper.rb
@@ -125,6 +149,7 @@ files:
 - lib/fragmentary/publisher.rb
 - lib/fragmentary/request.rb
 - lib/fragmentary/request_queue.rb
+- lib/fragmentary/session_user.rb
 - lib/fragmentary/subscriber.rb
 - lib/fragmentary/subscription.rb
 - lib/fragmentary/user_session.rb
@@ -150,8 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Fragment modeling and caching for Rails