virtuatable-core 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9afbc1d8f75f5d0b94194432b3a379a7b02d90d2490deeed47d46d9c89036b01
-  data.tar.gz: 56cfd05e3f53df001a852d26b6abf992313d52598902ecb21809cd16708ae266
+  metadata.gz: 66ce5b5678adffaaf85ae207353fb60805ebdde74d02c8aa87aedd70109184d6
+  data.tar.gz: 70b78998d52d0a8e47938b200500f445287d9d3d0f5cf3749fd856f645140275
 SHA512:
-  metadata.gz: 7f4fdde3ecd17bb2b33a535ce22c927783ab5d88c00f639ee9374fcc7b36c6680ed0e2f1ce50071a22e1c4784d453c1b74b0bc71d5b817bd72e0501faf637611
-  data.tar.gz: 7622404c051938c9cee8567de61f25005e7f178ae4a7dd22146d279aa8413a52c92c25c36db2472a59588c2f0a10db22322d4f0ff8348fc3609124798bcd4587
+  metadata.gz: 3547e559af72ec612be70b6423c50c8bb0d2a5ad8ea7cec3e64eef1c47940faa2702a1c4a8f010463f4ac5bc696f91811348e31ace459f206dd875c01ef93677
+  data.tar.gz: cc76eb73b5418e74d9215040d334991365d937675bd8af6015cc15b0a93526be4e0c410f03c358ae0f738675adaaaef226ef9af27abc68eed0348e1e476a3f20

data/lib/core/models/account.rb

@@ -8,6 +8,8 @@ module Core
       include ActiveModel::SecurePassword
       include Core::Models::Concerns::Enumerable
 
+      store_in collection: 'accounts'
+
       # @!attribute [rw] username
       #   @return [String] the nickname the user chose at subscription, must be given, unique, and 6 or more characters long.
       field :username, type: String
@@ -62,8 +64,6 @@ module Core
       #   @return [Array<Core::Models::Chatrooms::Messages>] all the messages ever sent by the user.
       has_many :messages, class_name: 'Core::Models::Chatrooms::Message', inverse_of: :account
 
-      has_many :memberships, class_name: 'Core::Models::Chatrooms::Membership', inverse_of: :account
-
       # @!attribute [rw] notifications
       #  @return [Array<Core::Models::Notification>] the notifications linked to this user.
       embeds_many :notifications, class_name: 'Core::Models::Notification', inverse_of: :account

data/lib/core/models/authentication/session.rb

@@ -9,6 +9,8 @@ module Core
         include Mongoid::Document
         include Mongoid::Timestamps
 
+        store_in collection: 'sessions'
+
         # @!attribute [rw] token
         #   @return [String] the unique token for this session, used to identify it and be sure the user is connected on this application.
         field :token, type: String

data/lib/core/models/campaign.rb

@@ -6,6 +6,8 @@ module Core
       include Mongoid::Document
       include Mongoid::Timestamps
 
+      store_in collection: 'campaigns'
+
       # @!attribute [rw] title
       #   @return [String] the title, or name, of the campaign, used to identify it in the list.
       field :title, type: String
@@ -33,6 +35,10 @@ module Core
       #   @return [Core::Models::Chatrooms::Campaign] the chatroom linked to this campaign.
       embeds_one :chatroom, class_name: 'Core::Models::Chatrooms::Campaign', inverse_of: :campaign
 
+      # @!attribute [rw] tokens
+      #   @return [Array<Core::Models::Campaigns::Token>] the tokens declared in this campaign.
+      embeds_many :tokens, class_name: 'Core::Models::Campaigns::Token', inverse_of: :campaign
+
       # @!attribute [rw] ruleset
       #   @return [Core::Models::Ruleset] the set of rules this campaign is based upon.
       belongs_to :ruleset, class_name: 'Core::Models::Ruleset', inverse_of: :campaigns, optional: true

data/lib/core/models/campaigns/invitation.rb

@@ -13,6 +13,8 @@ module Core
         include Core::Models::Concerns::Enumerable
         include Core::Models::Concerns::Historizable
 
+        store_in collection: 'invitations'
+
         # @!attribute [rw] account
         #   @return [Core::Models::Account] the account the invitation has been issued to.
         belongs_to :account, class_name: 'Core::Models::Account', inverse_of: :invitations

data/lib/core/models/campaigns/map.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Core
+  module Models
+    module Campaigns
+      # A map is a battleground where the players can place tokens and live the adventure.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Map
+        include Mongoid::Document
+        include Mongoid::Timestamps
+
+        store_in collection: 'maps'
+
+        # @!attribute [rw] height
+        #   @return [Integer] the number of lines in the map matric.
+        field :height, type: Integer, default: 1
+        # @!attribute [rw] width
+        #   @return [Integer] the number of columns in the map matric.
+        field :width, type: Integer, default: 1
+
+        # @!attribute [rw] campaign
+        #   @return [Core::Models::Campaign] the campaign in which the map can be found.
+        belongs_to :campaign, class_name: 'Core::Models::Campaign', inverse_of: :maps
+
+        # @!attribute [rw] positions
+        #   @return [Array<Core::Model::Campaigns::TokenPosition>] the instanciated tokens on this map.
+        embeds_many :positions, class_name: 'Core::Models::Campaigns::TokenPosition', inverse_of: :map
+
+        validates :height,
+          numericality: { greater_than: 0, message: 'minimum' }
+        
+        validates :width,
+          numericality: { greater_than: 0, message: 'minimum' }
+      end
+    end
+  end
+end

data/lib/core/models/campaigns/tag.rb

@@ -9,6 +9,8 @@ module Core
         include Mongoid::Document
         include Mongoid::Timestamps
 
+        store_in collection: 'tags'
+
         # @!attribute [rw] content
         #   @return [String] the string content of the tag, describing a characteristic.
         field :content, type: String

data/lib/core/models/campaigns/token.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Core
+  module Models
+    module Campaigns
+      # A token represents an player or a monster in the game. It can be placed as a TokenPosition.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Token
+        include Mongoid::Document
+        include Mongoid::Timestamps
+
+        store_in collection: 'tokens'
+
+        # @!attribute [rw] name
+        #   @return [String] the name of the token that will be displayed on the map
+        field :name, type: String
+
+        # @!attribute [rw] campaign
+        #   @return [Core::Models::Campaign] the campaign in which this token can be used
+        embedded_in :campaign, class_name: 'Core::Models::Campaign', inverse_of: :tokens
+        # @!attribute [rw] creator
+        #   @return [Core::Models::Account] the account of the player creating the token
+        belongs_to :creator, class_name: 'Core::Models::Account', inverse_of: :tokens
+
+        validates :name,
+          presence: {message: 'required'},
+          length: {minimum: 6, message: 'minlength', if: :name?}
+      end
+    end
+  end
+end

data/lib/core/models/campaigns/token_position.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Core
+  module Models
+    module Campaigns
+      # This is the instanciation of a token in one of the map of the campaign
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class TokenPosition
+        include Mongoid::Document
+        include Mongoid::Timestamps
+
+        store_in collection: 'token_positions'
+
+        # @!attribute [rw] x
+        #   @return [Integer] the number of cells from the left before this token
+        field :x, type: Integer, default: 0
+        # @!attribute [rw] y
+        #   @return [Integer] the number of cells from the top before this token
+        field :y, type: Integer, default: 0
+
+        # @!attribute [rw] map
+        #   @return [Core::Models::Campaigns::Map] the map where this token is instanciated.
+        embedded_in :map, class_name: 'Core::Models::Campaigns::Map', inverse_of: :positions
+
+        # @!attribute [rw] token
+        #   @return [Core::Models::Campaigns::Token] the source of the token, used to determine its appearance.
+        belongs_to :token, class_name: 'Core::Models::Campaigns::Token', inverse_of: :positions
+
+        validate :coordinates_bounds
+
+        # Validates that the coordinates of the token position are in the map bounds.
+        def coordinates_bounds
+          errors.add(:x, 'bounds') if map.nil? or x < 0 or x >= map.width
+          errors.add(:y, 'bounds') if map.nil? or y < 0 or y >= map.height
+        end
+      end
+    end
+  end
+end

data/lib/core/models/campaigns.rb

@@ -4,7 +4,10 @@ module Core
     # @author Vincent Courtois <courtois.vincent@outlook.com>
     module Campaigns
       autoload :Invitation, 'core/models/campaigns/invitation'
+      autoload :Map       , 'core/models/campaigns/map'
       autoload :Tag       , 'core/models/campaigns/tag'
+      autoload :Token     , 'core/models/campaigns/token'
+      autoload :TokenPosition, 'core/models/campaigns/token_position'
     end
   end
 end

data/lib/core/models/chatrooms/campaign.rb

@@ -7,6 +7,9 @@ module Core
         # @!attribute [rw] campaign
         #   @return [Core::Models::Campaign] the campaign the chatroom is linked to.
         embedded_in :campaign, class_name: 'Core::Models::Campaign', inverse_of: :chatroom
+        # @!attribute [rw] messages
+        #   @return [Array<Core::Models::Chatrooms::Messages>] the messages said in this conversation
+        has_many :messages, class_name: 'Core::Models::Chatrooms::Message', inverse_of: :chatroom
       end
     end
   end

data/lib/core/models/chatrooms/message.rb

@@ -8,6 +8,8 @@ module Core
         include Mongoid::Timestamps
         include Core::Models::Concerns::Enumerable
 
+        store_in collection: 'chatrooms'
+
         # @!attribute [rw] type
         #  @return [Symbol] the type of message (plain text or command) contained in the data, used to parse and display it.
         enum_field :type, [:text, :command], default: :text

data/lib/core/models/files/document.rb

@@ -7,6 +7,8 @@ module Core
         include Mongoid::Document
         include Mongoid::Timestamps
 
+        store_in collection: 'documents'
+
         # @!attribute [rw] name
         #   @return [String] the filename the user entered when uploading the file.
         field :name, type: String

data/lib/core/models/files/permission.rb

@@ -8,6 +8,8 @@ module Core
         include Mongoid::Timestamps
         include Core::Models::Concerns::Enumerable
 
+        store_in collection: 'document_permissions'
+
         # @!attribute [rw] type
         #   @return [Symbol] the type of permission granted (is the user able to delete the file ?)
         enum_field :type, [:read, :read_write]

data/lib/core/models/oauth/access_token.rb

@@ -8,6 +8,8 @@ module Core
         include Mongoid::Document
         include Mongoid::Timestamps
 
+        store_in collection: 'oauth_access_token'
+
         # @!attribute [rw] value
         #   @return [String] the value of the token, returned to the application when built.
         field :value, type: String, default: ->{ SecureRandom.hex }

data/lib/core/models/oauth/application.rb

@@ -7,6 +7,8 @@ module Core
         include Mongoid::Document
         include Mongoid::Timestamps
 
+        store_in collection: 'oauth_application'
+
         # @!attribute [rw] name
         #   @return [String] the unique name of the application, mainly used to identify and display it.
         field :name, type: String

data/lib/core/models/oauth/authorization.rb

@@ -10,6 +10,8 @@ module Core
         include Mongoid::Document
         include Mongoid::Timestamps
 
+        store_in collection: 'oauth_authorization'
+
         # @!attribute [rw] code
         #   @return [String] the value corresponding to the authentication code in the RFC of OAuth2.0, kep for historic purpose.
         field :code, type: String, default: ->{ SecureRandom.hex }

data/lib/core/models/oauth/refresh_token.rb

@@ -7,6 +7,8 @@ module Core
         include Mongoid::Document
         include Mongoid::Timestamps
 
+        store_in collection: 'oauth_refresh_token'
+
         # @!attribute [rw] value
         #   @return [String] the value of the token, returned to the application when built.
         field :value, type: String, default: ->{ SecureRandom.hex }

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

@@ -8,6 +8,8 @@ module Core
         include Mongoid::Timestamps
         include Core::Models::Concerns::Sluggable
 
+        store_in collection: 'categories'
+
         has_many :rights, class_name: 'Core::Models::Permissions::Right', inverse_of: :category
 
         make_sluggable 'category'

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

@@ -8,6 +8,8 @@ module Core
         include Mongoid::Timestamps
         include Core::Models::Concerns::Sluggable
 
+        store_in collection: 'groups'
+
         # @!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

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

@@ -8,6 +8,8 @@ module Core
         include Mongoid::Timestamps
         include Core::Models::Concerns::Sluggable
 
+        store_in collection: 'rights'
+
         # @!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

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

@@ -9,6 +9,8 @@ module Core
         include Core::Models::Concerns::Premiumable
         include Core::Models::Concerns::Activable
 
+        store_in collection: 'routes'
+
         # @!attribute [rw] path
         #   @return [String] the path (URI) of the route in the API.
         field :path, type: String, default: '/'

data/lib/core/models/ruleset.rb

@@ -6,6 +6,8 @@ module Core
       include Mongoid::Document
       include Mongoid::Timestamps
 
+      store_in collection: 'rulesets'
+
       # @!attribute [rw] name
       #   @return [String] the name of the ruleset (eq. "Dungeons and Dragons 4th Edition")
       field :name, type: String

data/lib/core/services/accounts.rb

@@ -0,0 +1,16 @@
+module Core
+  module Services
+    class Accounts < Core::Services::Base
+      def get_by_username(username)
+        account = Core::Models::Account.find_by(username: username)
+        if account.nil?
+          raise Core::Helpers::Errors::NotFound.new(
+            field: 'username',
+            error: 'unknown'
+          )
+        end
+        account
+      end
+    end
+  end
+end

data/lib/core/services/base.rb

@@ -0,0 +1,11 @@
+module Core
+  module Services
+    class Base
+      attr_reader :services
+
+      def initialize(registry)
+        @services = registry
+      end
+    end
+  end
+end

data/lib/core/services/registry.rb

@@ -0,0 +1,15 @@
+module Core
+  module Services
+    # The registry holds references to all the services accessible in the library. To access
+    # all services and be able to manage resources easily, just instanciate the 
+    class Registry
+
+      attr_reader :accounts, :sessions
+
+      def initialize
+        @accounts = Core::Services::Accounts.new(self)
+        @sessions = Core::Services::Sessions.new(self)
+      end
+    end
+  end
+end

data/lib/core/services/sessions.rb

@@ -0,0 +1,33 @@
+require 'bcrypt'
+require 'securerandom'
+
+module Core
+  module Services
+    # Service concerning sessions (log in and log out)
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Sessions < Core::Services::Base
+      # Creates a new session from the given user credentials. IT will
+      # * check that the user exists in the database
+      # * check that the password matches the user encrypted password
+      # If both steps are correctly passed, it will create and return
+      # a session object so that the user can have a login token.
+      #
+      # @param username [string] the name of the user trying to log in
+      # @param password [string] the password the user has provided
+      # @return [Core::Models::Authentication::Session] the login session
+      def create(username, password)
+        account = services.accounts.get_by_username(username)
+        if BCrypt::Password.new(account.password_digest) != password
+          raise Core::Helpers::Errors::Forbidden.new(
+            field: 'password',
+            error: 'wrong'
+          )
+        end
+        return Core::Models::Authentication::Session.create(
+          account: account,
+          token: SecureRandom.uuid
+        )
+      end
+    end
+  end
+end

data/lib/core/services.rb

@@ -0,0 +1,8 @@
+module Core
+  module Services
+    autoload :Accounts, 'core/services/accounts'
+    autoload :Base, 'core/services/base'
+    autoload :Registry, 'core/services/registry'
+    autoload :Sessions, 'core/services/sessions'
+  end
+end

data/lib/core/version.rb

@@ -1,3 +1,3 @@
 module Core
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/core.rb

@@ -9,4 +9,5 @@ module Core
   autoload :Controllers, 'core/controllers'
   autoload :Helpers, 'core/helpers'
   autoload :Models, 'core/models'
+  autoload :Services, 'core/services'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: virtuatable-core
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-07 00:00:00.000000000 Z
+date: 2022-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_cleaner
@@ -252,14 +252,14 @@ dependencies:
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
@@ -306,12 +306,13 @@ files:
 - lib/core/models/campaign.rb
 - lib/core/models/campaigns.rb
 - lib/core/models/campaigns/invitation.rb
+- lib/core/models/campaigns/map.rb
 - lib/core/models/campaigns/tag.rb
+- lib/core/models/campaigns/token.rb
+- lib/core/models/campaigns/token_position.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
@@ -337,6 +338,11 @@ files:
 - lib/core/models/permissions/right.rb
 - lib/core/models/permissions/route.rb
 - lib/core/models/ruleset.rb
+- lib/core/services.rb
+- lib/core/services/accounts.rb
+- lib/core/services/base.rb
+- lib/core/services/registry.rb
+- lib/core/services/sessions.rb
 - lib/core/version.rb
 homepage: https://rubygems.org/gems/virtuatable-core
 licenses:

data/lib/core/models/chatrooms/conversation.rb

@@ -1,9 +0,0 @@
-module Core
-  module Models
-    module Chatrooms
-      class Conversation < Core::Models::Chatrooms::Base
-        has_many :memberships, class_name: 'Core::Models::Chatrooms::Membership', inverse_of: :chatroom
-      end
-    end
-  end
-end

data/lib/core/models/chatrooms/membership.rb

@@ -1,17 +0,0 @@
-module Core
-  module Models
-    module Chatrooms
-      class Membership
-        include Mongoid::Document
-        include Mongoid::Timestamps
-        include Core::Models::Concerns::Enumerable
-
-        enum_field :status, [:shown, :hidden], default: :shown
-
-        belongs_to :chatroom, class_name: 'Core::Models::Chatrooms::Private', inverse_of: :memberships
-
-        belongs_to :account, class_name: 'Core::Models::Account', inverse_of: :memberships
-      end
-    end
-  end
-end