virtuatable-core 1.0.0

data/lib/core/models/permissions/category.rb

@@ -0,0 +1,17 @@
+module Core
+  module Models
+    module Permissions
+      # A category of rights regroups one or several rights for convenience purposes.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Category
+        include Mongoid::Document
+        include Mongoid::Timestamps
+        include Core::Models::Concerns::Sluggable
+
+        has_many :rights, class_name: 'Core::Models::Permissions::Right', inverse_of: :category
+
+        make_sluggable 'category'
+      end
+    end
+  end
+end

data/lib/core/models/permissions/group.rb

@@ -0,0 +1,32 @@
+module Core
+  module Models
+    module Permissions
+      # A group gathers one or several users to give them the same rights for conviniency purposes.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Group
+        include Mongoid::Document
+        include Mongoid::Timestamps
+        include Core::Models::Concerns::Sluggable
+
+        # @!attribute [rw] is_default
+        #   @return [Boolean] a boolean indicating whether this group is given when a new user registered or not.
+        field :is_default, type: Boolean, default: false
+        # @!attribute [rw] is_superuser
+        #   @return [Boolean] a boolean indicating whether this group should have access to all groups and rights or not.
+        field :is_superuser, type: Boolean, default: false
+
+        # @!attribute [rw] accounts
+        #   @return [Array<Core::Models::Account>] the accounts having the rights granted by this group.
+        has_and_belongs_to_many :accounts, class_name: 'Core::Models::Account', inverse_of: :groups
+        # @!attribute [rw] rights
+        #   @return [Array<Core::Models::Permissions::Right>] the rights granted by belonging to this group.
+        has_and_belongs_to_many :rights, class_name: 'Core::Models::Permissions::Right', inverse_of: :groups
+        # @!attribute [rw] routes
+        #   @return [Array<Core::Models::Monitoring::Route>] the routes this group can access in the API.
+        has_and_belongs_to_many :routes, class_name: 'Core::Models::Monitoring::Route', inverse_of: :groups
+
+        make_sluggable 'group'
+      end
+    end
+  end
+end

data/lib/core/models/permissions/right.rb

@@ -0,0 +1,21 @@
+module Core
+  module Models
+    module Permissions
+      # A right is the access to one or several features in the application. It's applied to a group, and transitively to an account.
+      # @author Vincent Courtois <courtois;vincent@outlook.com>
+      class Right
+        include Mongoid::Document
+        include Mongoid::Timestamps
+        include Core::Models::Concerns::Sluggable
+
+        # @!attribute [rw] groups
+        #   @return [Array<Core::Models::Permissions::Group>] the groups granted with the permission to access features opened by this right.
+        has_and_belongs_to_many :groups, class_name: 'Core::Models::Permissions::Group', inverse_of: :rights
+
+        belongs_to :category, class_name: 'Core::Models::Permissions::Category', inverse_of: :rights
+
+        make_sluggable 'right'
+      end
+    end
+  end
+end

data/lib/core/models/permissions.rb

@@ -0,0 +1,12 @@
+module Core
+  module Models
+    # This module holds the logic for all the classes concerning the permissions abd rights for the user.
+    # A permission is restricting the access to one or several features to the users having it.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Permissions
+      autoload :Right   , 'core/models/permissions/right'
+      autoload :Group   , 'core/models/permissions/group'
+      autoload :Category, 'core/models/permissions/category'
+    end
+  end
+end

data/lib/core/models/ruleset.rb

@@ -0,0 +1,32 @@
+module Core
+  module Models
+    # A set of rules is describing how a specific game system works (eg. Dungeons and Dragons 5th Edition, or Fate)
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Ruleset
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      # @!attribute [rw] name
+      #   @return [String] the name of the ruleset (eq. "Dungeons and Dragons 4th Edition")
+      field :name, type: String
+      # @!attribute [rw] description
+      #   @return [String] the complete description of the rule set to quickly have informations on its content.
+      field :description, type: String
+      # @!attribute [rw] mime_types
+      #   @return [Array<String>] a list of MIME types accepted as character sheets MIME types.
+      field :mime_types, type: Array, default: []
+
+      # @!attribute [rw] creator
+      #   @return [Core::Models::Account] the account of the user creating this ruleset.
+      belongs_to :creator, class_name: 'Core::Models::Account', inverse_of: :rulesets
+      # @!attribute [rw] campaigns
+      #   @return [Array<Core::Models::Campaign>] the campaigns using this set of rules.
+      has_many :campaigns, class_name: 'Core::Models::Campaign', inverse_of: :ruleset
+
+      validates :name,
+        presence: {message: 'required'},
+        length: {minimum: 4, message: 'minlength', if: :name?},
+        uniqueness: {message: 'uniq', if: :name?}
+    end
+  end
+end

data/lib/core/models.rb

@@ -0,0 +1,27 @@
+require 'mongoid'
+require 'active_model'
+require 'active_support'
+require 'dotenv/load'
+
+# Main module of the application, holding all the subsequent classes.
+# @author Vincent Courtois <courtois.vincent@outlook.com>
+module Core
+  module Models
+    autoload :Account       , 'core/models/account'
+    autoload :Authentication, 'core/models/authentication'
+    autoload :Campaign      , 'core/models/campaign'
+    autoload :Campaigns     , 'core/models/campaigns'
+    autoload :Chatroom      , 'core/models/chatroom'
+    autoload :Chatrooms     , 'core/models/chatrooms'
+    autoload :Concerns      , 'core/models/concerns'
+    autoload :Event         , 'core/models/event'
+    autoload :Factories     , 'core/models/factories'
+    autoload :Files         , 'core/models/files'
+    autoload :Monitoring    , 'core/models/monitoring'
+    autoload :Notification  , 'core/models/notification'
+    autoload :OAuth         , 'core/models/oauth'
+    autoload :Permissions   , 'core/models/permissions'
+    autoload :Phone         , 'core/models/phone'
+    autoload :Ruleset       , 'core/models/ruleset'
+  end
+end

data/lib/core/version.rb

@@ -0,0 +1,3 @@
+module Core
+  VERSION = '1.0.0'
+end

data/lib/core.rb

@@ -0,0 +1,10 @@
+require 'mongoid'
+require 'active_model'
+require 'active_support'
+require 'dotenv/load'
+
+# Main module of the application, holding all the subsequent classes.
+# @author Vincent Courtois <courtois.vincent@outlook.com>
+module Core
+  autoload :Models, 'core/models'
+end

metadata

@@ -0,0 +1,329 @@
+--- !ruby/object:Gem::Specification
+name: virtuatable-core
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vincent Courtois
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.8.1
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.90.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.90.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 6.0.3.2
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.13
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+description: This gem holds the model layer for my table-top RPG games application.
+email: courtois.vincent@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/core.rb
+- lib/core/models.rb
+- lib/core/models/account.rb
+- lib/core/models/authentication.rb
+- lib/core/models/authentication/session.rb
+- lib/core/models/campaign.rb
+- lib/core/models/campaigns.rb
+- lib/core/models/campaigns/invitation.rb
+- lib/core/models/campaigns/tag.rb
+- lib/core/models/chatrooms.rb
+- lib/core/models/chatrooms/base.rb
+- lib/core/models/chatrooms/campaign.rb
+- lib/core/models/chatrooms/conversation.rb
+- lib/core/models/chatrooms/membership.rb
+- lib/core/models/chatrooms/message.rb
+- lib/core/models/concerns.rb
+- lib/core/models/concerns/activable.rb
+- lib/core/models/concerns/diagnosticable.rb
+- lib/core/models/concerns/enumerable.rb
+- lib/core/models/concerns/historizable.rb
+- lib/core/models/concerns/mime_typable.rb
+- lib/core/models/concerns/premiumable.rb
+- lib/core/models/concerns/sluggable.rb
+- lib/core/models/concerns/typable.rb
+- lib/core/models/decorators/errors.rb
+- lib/core/models/decorators/errors/env_variable_missing.rb
+- lib/core/models/decorators/gateway.rb
+- lib/core/models/event.rb
+- lib/core/models/factories.rb
+- lib/core/models/factories/errors.rb
+- lib/core/models/factories/errors/gateway_not_found.rb
+- lib/core/models/files.rb
+- lib/core/models/files/document.rb
+- lib/core/models/files/permission.rb
+- lib/core/models/monitoring.rb
+- lib/core/models/monitoring/route.rb
+- lib/core/models/monitoring/service.rb
+- lib/core/models/notification.rb
+- lib/core/models/oauth.rb
+- lib/core/models/oauth/access_token.rb
+- lib/core/models/oauth/application.rb
+- lib/core/models/oauth/authorization.rb
+- lib/core/models/oauth/refresh_token.rb
+- lib/core/models/permissions.rb
+- lib/core/models/permissions/category.rb
+- lib/core/models/permissions/group.rb
+- lib/core/models/permissions/right.rb
+- lib/core/models/ruleset.rb
+- lib/core/version.rb
+homepage: https://rubygems.org/gems/virtuatable-core
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: The model layer for my table-RPG application
+test_files: []