biovision 0.0.200518.1

data/app/controllers/my/recoveries_controller.rb

@@ -0,0 +1,2 @@
+class My::RecoveriesController < ApplicationController
+end

data/app/helpers/biovision_components_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Helper methods for component handling
+module BiovisionComponentsHelper
+  # @param [BiovisionComponent] entity
+  # @param [String] text
+  # @param [Hash] options
+  def admin_biovision_component_link(entity, text = nil, options = {})
+    if text.nil?
+      text = t("biovision.components.#{entity.slug}.name", default: entity.slug)
+    end
+    link_to(text, admin_component_path(slug: entity.slug), options)
+  end
+end

data/app/helpers/users_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Helpers for Users component
+module UsersHelper
+  # @param [User] entity
+  def user_image_tiny(entity)
+    return image_tag('biovision/placeholders/user.svg', alt: '') if entity.nil?
+
+    image_tag(entity.image.tiny.url, alt: '')
+  end
+end

data/app/lib/biovision/components/base_component.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    # Base biovision component
+    class BaseComponent
+      extend ComponentSettings
+
+      attr_reader :component, :slug, :name, :user, :user_link
+
+      # @param [BiovisionComponent] component
+      # @param [User] user
+      def initialize(component, user = nil)
+        @component = component
+        @slug = component&.slug || 'base'
+        self.user = user
+
+        @name = I18n.t("biovision.components.#{@slug}.name", default: @slug)
+      end
+
+      # Receive component-specific handler by component slug
+      #
+      # @param [String|BiovisionComponent] input
+      # @param [User] user
+      # @return [BaseComponent]
+      def self.handler(input, user = nil)
+        type = input.is_a?(String) ? input : input&.slug
+        handler_class(type)[user]
+      end
+
+      def self.slug
+        to_s.demodulize.underscore.gsub('_component', '')
+      end
+
+      # Receive component-specific handler by class name for component.
+      #
+      # e.g.: Biovision::Components::UsersComponent[user]
+      #
+      # @param [User] user
+      def self.[](user = nil)
+        new(BiovisionComponent[slug], user)
+      end
+
+      # @param [String] slug
+      def self.handler_class(slug)
+        handler_name = "biovision/components/#{slug}_component".classify
+        handler_name.safe_constantize || BaseComponent
+      end
+
+      # Privilege names for using in biovision_component_user.data
+      def self.privilege_names
+        []
+      end
+
+      # @param [User] user
+      def self.privileged?(user)
+        return false if user.nil? || user.banned?
+        return true if user.super_user?
+
+        BiovisionComponentUser.owned_by(user).each do |link|
+          return true if link.administrator? || !link.data['privileges'].blank?
+        end
+
+        false
+      end
+
+      # @param [User] user
+      def user=(user)
+        @user = user
+
+        criteria = { biovision_component: @component, user: user }
+
+        @user_link = BiovisionComponentUser.find_by(criteria)
+      end
+
+      def user_link!(force_create = false)
+        if @user_link.nil?
+          criteria = { biovision_component: @component, user: user }
+          @user_link = BiovisionComponentUser.new(criteria)
+          @user_link.save if force_create
+        end
+
+        @user_link
+      end
+
+      def use_parameters?
+        false
+      end
+
+      def use_settings?
+        use_parameters? || @component.settings.any?
+      end
+
+      def administrator?
+        return false if user.nil?
+
+        user.super_user? || @user_link&.administrator?
+      end
+
+      # @param [String|Array] privileges
+      def allow?(*privileges)
+        return false if user.nil?
+        return true if administrator? || (component.nil? && privileges.blank?)
+        return false if @user_link.nil?
+
+        result = privileges.blank?
+        privileges.flatten.each { |slug| result |= privilege?(slug) }
+        result
+      end
+
+      # @param [String] privilege_name
+      def privilege?(privilege_name)
+        privilege_handler.privilege?(privilege_name)
+      end
+
+      # @param [Hash] data
+      def settings=(data)
+        @component.settings.merge!(self.class.normalize_settings(data))
+        @component.save!
+      end
+
+      def settings
+        @component.settings
+      end
+
+      # Receive parameter value with default
+      #
+      # Returns value of component's parameter or default value
+      # when it's not found
+      #
+      # @param [String] key
+      # @param [String] default
+      # @return [String]
+      def receive(key, default = '')
+        @component.get(key, default)
+      end
+
+      # Receive parameter value or nil
+      #
+      # Returns value of component's parameter of nil when it's not found
+      #
+      # @param [String] key
+      # @return [String]
+      def [](key)
+        @component.get(key)
+      end
+
+      # Set parameter
+      #
+      # @param [String] key
+      # @param [String] value
+      def []=(key, value)
+        @component[key] = value unless key.blank?
+      end
+
+      # @param [String] name
+      # @param [Integer] quantity
+      def register_metric(name, quantity = 1)
+        metric = Metric.find_by(name: name)
+        if metric.nil?
+          attributes = {
+            biovision_component: @component,
+            name: name,
+            incremental: !name.end_with?('.hit')
+          }
+          metric = Metric.create(attributes)
+        end
+
+        metric << quantity
+      end
+
+      def privilege_handler
+        @privilege_handler ||= PrivilegeHandler.new(self)
+      end
+    end
+  end
+end

data/app/lib/biovision/components/component_settings.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    # Normalizing component settings
+    module ComponentSettings
+      def settings_flags
+        []
+      end
+
+      def settings_numbers
+        []
+      end
+
+      def settings_strings
+        []
+      end
+
+      # @param [Hash] data
+      def normalize_settings(data)
+        result = {}
+        settings_flags.each { |f| result[f] = data[f].to_i == 1 }
+        settings_numbers.each { |n| result[n] = data[n].to_i }
+        settings_strings.each { |s| result[s] = data[s].to_s }
+
+        result
+      end
+    end
+  end
+end

data/app/lib/biovision/components/privilege_handler.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    # Handling user privileges in component
+    class PrivilegeHandler
+      attr_accessor :component
+
+      # @param [BaseComponent] component
+      def initialize(component)
+        @component = component
+      end
+
+      # @param [String|Symbol]
+      def privilege?(slug)
+        return false if @component.user_link.nil?
+
+        privileges = Array(@component.user_link.data['privileges'])
+        privileges.include?(slug)
+      end
+
+      def administrator!
+        return if @component.user.nil?
+
+        link = @component.user_link!
+        link.administrator = true
+        link.save
+      end
+
+      def not_administrator!
+        return if @component.user.nil? || @component.user_link.nil?
+
+        @component.user_link.update(administrator: false)
+      end
+
+      # @param [Array] new_privileges
+      def privileges=(new_privileges)
+        return if @component.user.nil?
+
+        link = @component.user_link!
+        link.data['privileges'] = Array(new_privileges).uniq
+        link.save
+      end
+
+      # @param [Hash] new_settings
+      def settings=(new_settings)
+        return if @component.user.nil?
+
+        link = @component.user_link!
+        link.data['settings'] = new_settings
+        link.save
+      end
+
+      # @param [String] slug
+      def add_privilege(slug)
+        return if @component.user.nil?
+
+        link = @component.user_link!
+        link.data['privileges'] ||= []
+        link.data['privileges'] += [slug.to_s]
+        link.data['privileges'].uniq!
+        link.save
+      end
+
+      # @param [String] slug
+      def remove_privilege(slug)
+        link = @component.user_link
+
+        return if link.nil?
+
+        link.data['privileges'] ||= []
+        link.data['privileges'] -= [slug.to_s]
+        link.save
+      end
+    end
+  end
+end

data/app/lib/biovision/components/track_component.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    # Component for tracking UA and IP
+    class TrackComponent < BaseComponent
+    end
+  end
+end

data/app/lib/biovision/components/users/authentication.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    module Users
+      # Authentication part of users component
+      module Authentication
+        def authenticate(password, track)
+          @password = password
+          @track = track
+          let_user_in?
+        end
+
+        protected
+
+        def let_user_in?
+          return false if user.nil? || user.banned?
+
+          too_many_attempts? ? (log_attempt && false) : try_password
+        end
+
+        def too_many_attempts?
+          timeout = settings['bounce_timeout'].to_i.abs.minutes.ago
+          limit = settings['bounce_limit'].to_i
+          LoginAttempt.owned_by(user).since(timeout).count > limit
+        end
+
+        def log_attempt
+          data = { password: @password }
+          LoginAttempt.owned_by(user).create(data.merge(@track))
+        end
+
+        def try_password
+          user.authenticate(@password) || (count_attempt && false)
+        end
+
+        def count_attempt
+          log_attempt
+          return unless too_many_attempts?
+
+          notifier = Biovision::Notifiers::UsersNotifier.new(user)
+          notifier.new_login_attempt(@track)
+        end
+      end
+    end
+  end
+end

data/app/lib/biovision/components/users/code_handler.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    module Users
+      # Handling user codes for different components
+      class CodeHandler
+        attr_accessor :code
+
+        # @param [Biovision::Components::BaseComponent] component
+        # @param [Code] code
+        def initialize(component, code = nil)
+          @component = component
+          self.code = code
+        end
+
+        def valid?
+          true
+        end
+      end
+    end
+  end
+end

data/app/lib/biovision/components/users/profile_handler.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    module Users
+      # Handling user profiles
+      class ProfileHandler
+        attr_accessor :user
+      end
+    end
+  end
+end

data/app/lib/biovision/components/users/registration_handler.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Biovision
+  module Components
+    module Users
+      # Handling user registration
+      class RegistrationHandler
+        # @param [Biovision::Components::UsersComponent] component
+        def initialize(component)
+          @component = component
+        end
+
+        def handle(parameters, code = nil)
+          @user = User.new(parameters)
+          @user.screen_name = @user.email if email_as_login?
+          @user.super_user = 1 if User.count < 1
+          @manager = CodeHandler.new(@component, code)
+
+          use_invites? ? use_code : persist_user
+          persist_user if @component.valid?(@user)
+
+          @user
+        end
+
+        def open?
+          @component.settings['registration_open']
+        end
+
+        def invite_only?
+          @component.settings['invite_only']
+        end
+
+        def use_invites?
+          @component.settings['use_invites'] || invite_only?
+        end
+
+        def confirm_email?
+          @component.settings['confirm_email']
+        end
+
+        def email_as_login?
+          @component.settings['email_as_login']
+        end
+
+        def require_email?
+          @component.settings['require_email'] || email_as_login?
+        end
+
+        protected
+
+        def persist_user
+          return unless @user.save
+
+          metric = Biovision::Components::UsersComponent::METRIC_NEW_USER
+          @component.register_metric(metric)
+
+          # handle_codes
+        end
+
+        # Check invitation code and persist user if it's valid
+        def use_code
+          if @manager.valid? || (@manager.code.nil? && !invite_only?)
+            persist_user
+          else
+            error = I18n.t('biovision.components.users.messages.invalid_code')
+
+            # Add "invalid code" error to other model errors, if any
+            @user.valid?
+            @user.errors.add(:code, error)
+          end
+        end
+
+        def handle_codes
+          if confirm_email?
+            code = CodeManager::Confirmation.code_for_user(@user)
+            CodeSender.email(code.id).deliver_later
+          end
+
+          return unless use_invites?
+
+          @manager.activate(@user) if @manager.valid?
+          create_invitations(settings['invite_count'].to_i)
+        end
+
+        # @param [Integer] quantity
+        def create_invitations(quantity = 1)
+          return unless quantity.positive?
+
+          parameters = {
+            code_type: CodeManager::Invitation.code_type,
+            user: @user,
+            quantity: quantity
+          }
+          Code.create(parameters)
+        end
+      end
+    end
+  end
+end