resource_quotable 0.2.0

data/app/services/resource_quotable/create.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  # Create Quota and all quota_trackers for a group of users.
+  class Create < Base
+    attr_accessor :group, :action, :resource, :limit, :period
+
+    validates :group, :resource, presence: true
+    validates_inclusion_of :action, in: ResourceQuotable.actions.keys
+    validates_inclusion_of :period, in: Quotum.periods.keys.map(&:to_sym)
+    validates_numericality_of :limit, only_integer: true, greater_than_or_equal_to: 0
+
+    def call
+      # Crear Quotum
+      # Crear QuotaTracker user existentes.
+      quotum = nil
+      flag = !limit.positive?
+
+      ResourceQuotable::Quotum.transaction do
+        quotum = group.quota.create!(resource_class: resource, action: action, period: period, limit: limit)
+        group.resource_quotable_users.map { |user| user.quotum_trackers.create!(quotum: quotum, counter: 0, flag: flag) }
+      end
+
+      quotum
+    rescue ActiveRecord::RecordNotUnique
+      raise ResourceQuotable::QuotaDuplicateError
+    end
+  end
+end

data/app/services/resource_quotable/destroy.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  # Destroy Quota
+  class Destroy < Base
+    attr_accessor :quotum
+
+    validates :quotum, presence: true
+
+    def call
+      quotum.destroy
+    end
+  end
+end

data/app/services/resource_quotable/quotum_tracker_services/reset.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  module QuotumTrackerServices
+    # Reset a quotum_tracker instance.
+    class Reset < ::ResourceQuotable::Base
+      attr_accessor :quotum_tracker
+
+      validates :quotum_tracker, presence: true
+
+      def call
+        quotum_tracker.reset!
+        quotum_tracker.reload
+      end
+    end
+  end
+end

data/app/services/resource_quotable/reset/all.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  module Reset
+    # Reset Quota for all period.
+    class All < Base
+      include ActiveModel::Validations
+
+      protected
+
+      def quotum_in_period
+        Quotum.all
+      end
+    end
+  end
+end

data/app/services/resource_quotable/reset/any.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  module Reset
+    # Reset Quota for Any period.
+    class Any < Base
+      include ActiveModel::Validations
+
+      protected
+
+      def quotum_in_period
+        Quotum.any_period
+      end
+    end
+  end
+end

data/app/services/resource_quotable/reset/base.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  module Reset
+    # Base Reset Quota for X period.
+    class Base < ResourceQuotable::Base
+      include ActiveModel::Validations
+
+      def call
+        quotum_in_period.each do |quotum|
+          quotum.quotum_trackers.with_active_counter.map(&:reset!)
+        end
+      end
+
+      protected
+
+      def quotum_in_period
+        raise ResourceQuotable::AbstractClassError
+      end
+    end
+  end
+end

data/app/services/resource_quotable/reset/daily.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  module Reset
+    # Reset Quota for daily period.
+    class Daily < Base
+      include ActiveModel::Validations
+
+      protected
+
+      def quotum_in_period
+        Quotum.daily_period
+      end
+    end
+  end
+end

data/app/services/resource_quotable/reset/monthly.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  module Reset
+    # Reset Quota for Monthly period.
+    class Monthly < Base
+      include ActiveModel::Validations
+
+      protected
+
+      def quotum_in_period
+        Quotum.monthly_period
+      end
+    end
+  end
+end

data/app/services/resource_quotable/reset/weekly.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  module Reset
+    # Reset Quota for Weekly period.
+    class Weekly < Base
+      include ActiveModel::Validations
+
+      protected
+
+      def quotum_in_period
+        Quotum.weekly_period
+      end
+    end
+  end
+end

data/app/services/resource_quotable/reset/yearly.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  module Reset
+    # Reset Quota for Yearly period.
+    class Yearly < Base
+      include ActiveModel::Validations
+
+      protected
+
+      def quotum_in_period
+        Quotum.yearly_period
+      end
+    end
+  end
+end

data/app/services/resource_quotable/update.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  # Update Quota and reset QuotumTracker flag according
+  class Update < Base
+    attr_accessor :quotum, :limit
+
+    validates :quotum, presence: true
+    validates_numericality_of :limit, only_integer: true, greater_than_or_equal_to: 0
+
+    def call
+      quotum.update(limit: limit)
+
+      # rubocop:disable Rails/SkipsModelValidations
+      # We know what we are doing. Validation and callback are not needed here.
+      quotum.quotum_trackers.under_limit(limit).flagged.update_all(flag: false)
+      quotum.quotum_trackers.over_limit(limit).not_flagged.update_all(flag: true)
+      # rubocop:enable Rails/SkipsModelValidations
+
+      quotum
+    end
+  end
+end

data/app/views/layouts/resource_quotable/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Resource quotable</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "resource_quotable/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/resource_quotable/quota/_edit.html.erb

@@ -0,0 +1,11 @@
+<%= form_for @quotum, method: :put, remote: true do |f| %>
+  <fieldset>
+    <div class="form-group col-md-12">
+      <label class="form-control-label">Limit</label>
+      <%= f.number_field :limit, class: 'form-control', required: true %>
+    </div>
+    <div class="form-group col-md-12">
+      <%= f.submit 'Save', class: 'btn btn-success' %>
+    </div>
+  </fieldset>
+<% end %>

data/app/views/resource_quotable/quota/_index.html.erb

@@ -0,0 +1,43 @@
+<div class="row">
+  <div class="col-md-12">
+    <div class="panel panel-inverse lobiable lobi_scrollable" data-unpin=false data-minimize=false data-close=false data-edit-title=false data-reload=false data-edit=false data-fullscreen=true>
+      <div class="panel-heading">
+        <div class="panel-title" style="max-width: calc(100% - 120px);">
+          <h4>Quotas</h4>
+        </div>
+      </div>
+
+      <div class="panel-body" >
+        <% if @quota.empty? %>
+          <div class='row'>
+            <div class='col-md-12 text-center'>
+              <h3>No results</h3>
+            </div>
+          </div>
+        <% else %>
+          <div class='row'>
+            <div class='col-md-12'>
+              <table id='resource_quotable_table' class="table table-striped medium text-left">
+                <tbody>
+                  <tr>
+                    <th>Id</th>
+                    <th>User</th>
+                    <th>Resource</th>
+                    <th>Action</th>
+                    <th>Period</th>
+                    <th>Limit</th>
+                    <th></th>
+                  </tr>
+                  <% @quota.each do |quotum| %>
+                    <%= render partial: 'resource_quotable/quota/index/row', locals: { quotum: quotum } %>
+                  <% end %>
+                </tbody>
+              </table>
+              <%= paginate @quota, remote: true %>
+            </div>
+          </div>
+        <% end %>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/resource_quotable/quota/_new.html.erb

@@ -0,0 +1,34 @@
+<%= form_for @quotum_limit, remote: true do |f| %>
+  <fieldset>
+    <%= f.fields_for :quotum do |quotum_form| %>
+      <div class="form-group col-md-12">
+        <label class="form-control-label">User</label>
+        <%= quotum_form.select :user_id, options_from_collection_for_select(ResourceQuotable.user_class.all, :id, :name), { prompt: 'Select' }, class: "form-control", required: true  %>
+      </div>
+
+      <div class="form-group col-md-12">
+        <label class="form-control-label">Resource</label>
+        <%= quotum_form.select :resource_class, options_for_select(ResourceQuotable.resources, @quotum_limit.quotum.resource_class), { prompt: 'Select' }, class: "form-control", required: true  %>
+      </div>
+
+      <div class="form-group col-md-12">
+        <label class="form-control-label">Action</label>
+        <%= quotum_form.select :action, options_for_select(ResourceQuotable.actions.keys, @quotum_limit.quotum.action.to_s), { prompt: 'Select' }, class: "form-control", required: true  %>
+      </div>
+    <% end %>
+
+    <div class="form-group col-md-12">
+      <label class="form-control-label">Period</label>
+      <%= f.select :period, options_for_select(ResourceQuotable::QuotumLimit.periods.keys, @quotum_limit.period.to_s), { prompt: 'Select' }, class: "form-control", required: true  %>
+    </div>
+
+    <div class="form-group col-md-12">
+      <label class="form-control-label">Limit</label>
+      <%= f.number_field :limit, class: 'form-control', required: true %>
+    </div>
+
+    <div class="form-group col-md-12">
+      <%= f.submit 'Save', class: 'btn btn-success' %>
+    </div>
+  </fieldset>
+<% end %>

data/app/views/resource_quotable/quota/_show.html.erb

@@ -0,0 +1,41 @@
+<div class="row">
+  <div class="col-md-12">
+    <div class="panel panel-inverse lobiable lobi_scrollable" data-unpin=false data-minimize=false data-close=false data-edit-title=false data-reload=false data-edit=false data-fullscreen=true>
+      <div class="panel-heading">
+        <div class="panel-title" style="max-width: calc(100% - 120px);">
+          <h4>Quota Details for <%= "#{@quotum.action} #{@quotum.resource_class}. Period: #{@quotum.period}" %></h4>
+        </div>
+      </div>
+
+      <div class="panel-body" >
+        <% if @quotum_trackers.empty? %>
+          <div class='row'>
+            <div class='col-md-12 text-center'>
+              <h3>No results</h3>
+            </div>
+          </div>
+        <% else %>
+          <div class='row'>
+            <div class='col-md-12'>
+              <table id='resource_quotable_table' class="table table-striped medium text-left">
+                <tbody>
+                  <tr>
+                    <th>Id</th>
+                    <th>User</th>
+                    <th>Counter</th>
+                    <th>Flag</th>
+                    <th></th>
+                  </tr>
+                  <% @quotum_trackers.each do |quotum_tracker| %>
+                    <%= render partial: 'resource_quotable/quota/show/row', locals: { quotum_tracker: quotum_tracker } %>
+                  <% end %>
+                </tbody>
+              </table>
+              <%= paginate @quotum_trackers, remote: true %>
+            </div>
+          </div>
+        <% end %>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/resource_quotable/quota/create.js.erb

@@ -0,0 +1,3 @@
+$('#resource_quotable_table').append("<%= escape_javascript render partial: 'index/row', locals: { quotum: @quotum } %>");
+
+alert("Quotum Limit #<%= @quotum.id %> created");

data/app/views/resource_quotable/quota/destroy.js.erb

@@ -0,0 +1,3 @@
+$("#quotum_<%= @id %>").remove();
+
+alert("Quotum Limit #<%= @id %> deleted");

data/app/views/resource_quotable/quota/edit.html.erb

@@ -0,0 +1 @@
+<%= render partial: 'edit' %>

data/app/views/resource_quotable/quota/edit.js.erb

@@ -0,0 +1 @@
+$("#<%= ResourceQuotable.main_content %>").html("<%= escape_javascript render partial: 'edit' %>")

data/app/views/resource_quotable/quota/index/_row.html.erb

@@ -0,0 +1,3 @@
+<tr id="quotum_<%= quotum.id %>">
+  <%= render partial: 'resource_quotable/quota/index/row_content', locals: { quotum: quotum } %>
+</tr>

data/app/views/resource_quotable/quota/index/_row_content.html.erb

@@ -0,0 +1,43 @@
+<td><%= link_to quotum.id, quotum_path(quotum), remote: true %></td>
+<td><%= quotum.user.name %></td>
+<td><%= quotum.resource_class %></td>
+<td><%= quotum.action %></td>
+<td><%= quotum.period %></td>
+<td><%= quotum.limit %></td>
+
+<td class='text-right'>
+  <%= link_to '',
+      reset_quotum_path(quotum),
+      remote: true,
+      method: :put,
+      data: {
+          confirm: 'Are you sure you want to reset this quotum?',
+          tooltip: 'Reset quotum',
+          toggle: 'tooltip',
+          title: 'Reset quotum',
+          placement: 'bottom'
+        },
+      class: "fa fa-reload" %>
+  <%= link_to '',
+      edit_quotum_path(quotum),
+      remote: true,
+      class: 'fa fa-edit',
+      data: {
+        tooltip: 'Edit',
+        title: 'Edit',
+        toggle:'tooltip',
+        placement: 'left'
+      } %>
+  <%= link_to '',
+      quotum_path(quotum),
+      remote: true,
+      method: :delete,
+      data: {
+        confirm: 'Are you sure you want to destroy this quotum?',
+        tooltip: 'Delete',
+        toggle: 'tooltip',
+        title: 'Delete',
+        placement: 'left'
+      },
+      class: 'fa fa-trash' %>
+</td>

data/app/views/resource_quotable/quota/index.html.erb

@@ -0,0 +1 @@
+<%= render partial: 'index' %>

data/app/views/resource_quotable/quota/index.js.erb

@@ -0,0 +1 @@
+$("#<%= ResourceQuotable.main_content %>").html("<%= escape_javascript render partial: 'index' %>")

data/app/views/resource_quotable/quota/new.html.erb

@@ -0,0 +1 @@
+<%= render partial: 'new' %>

data/app/views/resource_quotable/quota/new.js.erb

@@ -0,0 +1 @@
+$("#<%= ResourceQuotable.main_content %>").html("<%= escape_javascript render partial: 'new' %>")

data/app/views/resource_quotable/quota/show/_row.html.erb

@@ -0,0 +1,3 @@
+<tr id="quotum_tracker_<%= quotum_tracker.id %>">
+  <%= render partial: 'resource_quotable/quota/show/row_content', locals: { quotum_tracker: quotum_tracker } %>
+</tr>

data/app/views/resource_quotable/quota/show/_row_content.html.erb

@@ -0,0 +1,7 @@
+<td><%= quotum_tracker.id %></td>
+<td><%= link_to quotum_tracker.user.full_name, sp_app_user_path(quotum_tracker.user), remote: true, class: 'leadser_js_link_disable leadser_ujs_partial', data: { 'partial-spinner_div': '#leadser_page_content', 'url-push': true } %>
+<td><%= quotum_tracker.counter %>/<%= quotum_tracker.limit %></td>
+<td><%= quotum_tracker.flag %></td>
+
+<td class='text-right'>
+</td>

data/app/views/resource_quotable/quota/show.html.erb

@@ -0,0 +1 @@
+<%= render partial: 'show' %>

data/app/views/resource_quotable/quota/show.js.erb

@@ -0,0 +1 @@
+$("#<%= ResourceQuotable.main_content %>").html("<%= escape_javascript render partial: 'show' %>")

data/app/views/resource_quotable/quota/update.js.erb

@@ -0,0 +1,3 @@
+$("#quotum_<%= @quotum.id %>").replaceWith( "<%= escape_javascript render partial: 'index/row_content', locals: { quotum: @quotum } %>" );
+
+alert("Quotum Limit #<%= @quotum.id %> updated");

data/app/views/resource_quotable/quotum_trackers/index/_row_content.html.erb

@@ -0,0 +1,8 @@
+<td><%= quotum_tracker.resource_class %></td>
+<td><%= quotum_tracker.action %>
+<td><%= quotum_tracker.quotum.period %>
+<td><%= quotum_tracker.counter %>/<%= quotum_tracker.limit %></td>
+<td><%= quotum_tracker.flag %></td>
+
+<td class='text-right'>
+</td>

data/app/views/resource_quotable/quotum_trackers/reset.js.erb

@@ -0,0 +1,3 @@
+$("#quotum_tracker_<%= @quotum_tracker.id %>").replaceWith( "<%= escape_javascript render partial: 'index/row_content', locals: { quotum_tracker: @quotum_tracker } %>" );
+
+alert("Quotum Tracker #<%= @quotum_tracker.id %> updated");

data/config/routes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+ResourceQuotable::Engine.routes.draw do
+  resources :quota
+
+  resources :quotum_trackers, only: [] do
+    put :reset, on: :member
+  end
+
+  root 'quota#index'
+end

data/db/migrate/20220805102601_create_resource_quotable_quota.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class CreateResourceQuotableQuota < ActiveRecord::Migration[4.2] # :nodoc:
+  def change
+    create_table :resource_quotable_quota do |t|
+      t.integer :group_id, null: false, index: true
+      t.string :group_type, null: false
+      t.string :resource_class, null: false
+      t.integer :action, null: false, default: 0
+      t.integer :period, null: false, default: 0
+      t.integer :limit, null: false, default: 1
+
+      t.timestamps
+    end
+    add_index :resource_quotable_quota, %i[group_id resource_class action period], unique: true, name: 'resource_quotable_quota_unique_index'
+  end
+end

data/db/migrate/20220811072023_create_resource_quotable_quotum_trackers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# rubocop:disable Rails/CreateTableWithTimestamps
+# No needs for timestamp here.
+class CreateResourceQuotableQuotumTrackers < ActiveRecord::Migration[4.2] # :nodoc:
+  def change
+    create_table :resource_quotable_quotum_trackers do |t|
+      t.integer :quotum_id, null: false, index: true
+      t.integer :user_id, null: false, index: true
+      t.string :user_type, null: false
+      t.boolean :flag, null: false, default: false
+      t.integer :counter, null: false, default: 0
+    end
+    add_index :resource_quotable_quotum_trackers, %i[user_id quotum_id], unique: true, name: 'resource_quotable_quotum_trackers_unique_index'
+  end
+end
+
+# rubocop:enable Rails/CreateTableWithTimestamps

data/lib/concerns/controllers/allowed_to_manage_quota_check.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  # API inclusion to ApplicationController in order to allow customizations.
+  #
+  module AllowedToManageQuotaCheck
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :allowed_to?
+
+      def allowed_to?(action, resource)
+        !ResourceQuotable::ActionServices::Check.call(
+          user: load_quotable_tracker_user,
+          resource: resource,
+          action: action
+        )
+      end
+
+      def allowed_to_do_multi?(action, resource, amount)
+        !ResourceQuotable::ActionServices::CheckMultiple.call(
+          user: load_quotable_tracker_user,
+          resource: resource,
+          action: action,
+          amount: amount
+        )
+      end
+
+      def quota_authorize!(action, resource)
+        raise ResourceQuotable::QuotaLimitError unless allowed_to?(action, resource)
+      end
+
+      def quota_authorize_multiple!(action, resource, amount)
+        raise ResourceQuotable::QuotaMultiLimitError unless allowed_to_do_multi?(action, resource, amount)
+      end
+
+      def quota_increment!(action, resource)
+        quota_authorize!(action, resource)
+        ResourceQuotable::ActionServices::Increment.call(
+          user: load_quotable_tracker_user,
+          resource: resource,
+          action: action
+        )
+      end
+
+      def quota_increment_multiple!(action, resource, amount)
+        quota_authorize_multiple!(action, resource, amount)
+        ResourceQuotable::ActionServices::IncrementMultiple.call(
+          user: load_quotable_tracker_user,
+          resource: resource,
+          action: action,
+          amount: amount
+        )
+      end
+
+      def allowed_to_manage_quota?
+        true
+      end
+
+      def quota_scoped
+        Quotum
+      end
+
+      def load_quotable_tracker_user
+        current_user
+      end
+
+      def load_quotable_group; end
+      def resource_quotable_before; end
+      def resource_quotable_after; end
+    end
+  end
+end

data/lib/concerns/models/act_as_quota_trackable.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  module ActsAsQuotaTrackable # :nodoc:
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def acts_as_quota_trackable(_options = {})
+        has_many :quotum_trackers,
+                 dependent: :destroy,
+                 class_name: 'ResourceQuotable::QuotumTracker',
+                 foreign_key: 'user_id',
+                 inverse_of: :user
+
+        define_method(:resource_quotable_group) { send(ResourceQuotable.group_method) }
+
+        define_method(:quota_for_resource_action) do |resource, action|
+          resource_quotable_group.quota.for_resource_action(resource, action)
+        end
+      end
+    end
+  end
+end

data/lib/concerns/models/act_as_quotable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ResourceQuotable
+  module ActsAsQuotable # :nodoc:
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def acts_as_quotable(_options = {})
+        has_many :quota,
+                 dependent: :destroy,
+                 class_name: 'ResourceQuotable::Quotum',
+                 foreign_key: 'group_id',
+                 inverse_of: :group
+
+        define_method(:resource_quotable_users) { send(ResourceQuotable.users_method) }
+      end
+    end
+  end
+end