Readme.md

ResourceQuotable

A Rails quota limit gem for resources. UNDER DEVELOPMENT

Installation

Add this line to your application's Gemfile:

gem 'resource_quotable'

And then execute:

$ bundle install

Install migrations:

$ rails resource_quotable:install:migrations
$ rails db:migrate

Mount engine:

# config/routes.rb
Rails.application.routes.draw do
  # ...
  mount ResourceQuotable::Engine => '/resource_quotable'
  # ...
end

Configure:

# config/initializers/resource_quotable.rb

ResourceQuotable.setup do |config|

  ##
  # Mandatory settings
  #
  # Resources to track quota.
  #   format: Array of strings. Could be anything.
  #
  config.resources = %w[ResourceA ResourceB NotModel]

  ##
  # Optional settings

  # Method to access group form user instance.
  # default: 'group'
  config.group_method = 'user_group'

  # Method to access users form group instance.
  # default: 'users'
  config.users_method = 'admin_users'

  # main_content ID for rendering.
  # default: 'resource_quotable_content'
  config.main_content = 'resource_quotable_content'

  # Base controller.
  # default: '::ApplicationController'
  config.base_controller = '::ApplicationController'

  # Actions
  # Default [:create,:update, :destroy]
  config.actions = {
    create: 0,
    update: 1,
    destroy: 2,
    send: 3
  }.freeze

end

Attach Quotable to model.

class User < ApplicationRecord
  acts_as_quota_trackable
  # ....
  belongs_to :group
  # ....
end

class Group < ApplicationRecord
  acts_as_quotable
  # ....
  has_many :users, dependent: :destroy
  # ....
end

Usage

<% if allowed_to? :create, 'Post' %>
  <%= link_to "New", new_post_path %>
<% end %>

class PostController < ApplicationController
  # ...

  def new
    quota_authorize! :create, 'Post'
    # ...
  end

  def create
    quota_increment! :create, 'Post'
    # ...
  end

  # ...
end

Customizations

Customize views

rails g resource_quotable:views

Customize Controllers

class ApplicationController < ActionController::Base
  # ...

  # Customize how to get the current user model to track
  # default: current_user
  def load_quotable_tracker_user
    # ...
  end

  # Customize how to retrieve the group model
  # default: quotum_params[:group_type].constantize.find(quotum_params[:group_id])
  def load_quotable_group
    # ...
  end

  # Customize if the current_user can access to the quota management interface
  # default: true
  def allowed_to_manage_quota?
    # ...
  end

  # Customize How Quotum model are retrieve/filter. Useful for scopes
  # default: Quotum
  def quota_scoped
    # ...
  end

  # hook before every action
  # default: nil
  def resource_quotable_before
    # ...
  end

  # hook after every action
  # default: nil
  def resource_quotable_after
    # ...
  end

  # ...
end

API

Still Working on this doc....

API is exposed as a services layer.

# Check quota for 20 actions on resource for this user
ResourceQuotable::ActionServices::CheckMultiple.call(user: user, resource: 'ResourceX', action: :create, amount: 20)
# Increment 20 quota for actions on resource for this user
ResourceQuotable::ActionServices::IncrementMultiple.call(user: user, resource: 'ResourceX', action: :create, amount: 20)

# Reset. Probably a good idea to have a cron job that call this.
ResourceQuotable::Reset::Any.call
ResourceQuotable::Reset::Yearly.call
ResourceQuotable::Reset::Monthly.call
ResourceQuotable::Reset::Weekly.call
ResourceQuotable::Reset::Daily.call

Contributing

$ docker-sync start
$ docker-compose build
$ docker-compose run web bundle install
$ docker-compose run web bundle rails db:setup
$ docker-compose run web bundle rspec

License

The gem is available as open source under the terms of the MIT License.