virtuatable-core 1.0.0 → 1.2.1

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
@@ -19,7 +21,7 @@ module Core
         field :raw, type: String, default: ''
         # @!attribute [rw] deleted
         #   @return [Boolean] TRUE if the message has been marked as deleted by its user, FALSE otherwise.
-        field :deleted, type: Boolean, default: false
+        field :deleted, type: Mongoid::Boolean, default: false
 
         # @!attribute [rw] campaign
         #   @return [Core::Models::Chatrooms::Campaign] the chatroom in which the message has been emitted.

data/lib/core/models/concerns/activable.rb

@@ -9,7 +9,7 @@ module Core
         included do
           # @!attribute [rw] active
           #   @return [Boolean] the active status of the instance, indicating if someone has deactivated it or not.
-          field :active, type: Boolean, default: true
+          field :active, type: Mongoid::Boolean, default: true
         
           scope :active  , ->{ where(active: true)  }
           scope :inactive, ->{ where(active: false) }

data/lib/core/models/concerns/premiumable.rb

@@ -9,7 +9,7 @@ module Core
         included do
           # @!attribute [rw] premium
           #   @return [Boolean] TRUE if the entity is made to be accessible only to premiuma pplications, FALSE otherwise.
-          field :premium, type: Boolean, default: false
+          field :premium, type: Mongoid::Boolean, default: false
         end
       end
     end

data/lib/core/models/concerns.rb

@@ -4,7 +4,6 @@ module Core
     # @author Vincent Courtois <courtois.vincent@outlook.com>
     module Concerns
       autoload :Activable     , 'core/models/concerns/activable'
-      autoload :Diagnosticable, 'core/models/concerns/diagnosticable'
       autoload :Enumerable    , 'core/models/concerns/enumerable'
       autoload :Historizable  , 'core/models/concerns/historizable'
       autoload :MimeTypable   , 'core/models/concerns/mime_typable'

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/notification.rb

@@ -11,7 +11,7 @@ module Core
       field :type, type: String, default: 'NOTIFICATIONS.DEFAULT'
       # @!attribute [rw] read
       #   @return [Boolean] TRUE if the notification has been read (seen by the user), FALSE otherwise.
-      field :read, type: Boolean, default: false
+      field :read, type: Mongoid::Boolean, default: false
       # @!attribute [rw] data
       #   @return [Hash] the custom data that can be attached to this notification, for example for an invitation it can be the invited username.
       field :data, type: Hash, default: {}

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
@@ -15,7 +17,7 @@ module Core
         field :key, type: String, default: ->{ SecureRandom.hex }
         # @!attribute [rw] premium
         #   @return [Boolean] a value indicating whether the application should automatically receive a token when an account is created, or not.
-        field :premium, type: Boolean, default: false
+        field :premium, type: Mongoid::Boolean, default: false
         # @!attirbute [rw] redirect_uris
         #   @return [Array<String>] the redirection URIs used for this application.
         field :redirect_uris, type: Array, default: []

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,12 +8,14 @@ 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
+        field :is_default, type: Mongoid::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
+        field :is_superuser, type: Mongoid::Boolean, default: false
 
         # @!attribute [rw] accounts
         #   @return [Array<Core::Models::Account>] the accounts having the rights granted by this group.
@@ -23,7 +25,7 @@ module Core
         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
+        has_and_belongs_to_many :routes, class_name: 'Core::Models::Permissions::Route', inverse_of: :groups
 
         make_sluggable 'group'
       end

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/{monitoring → permissions}/route.rb

@@ -1,7 +1,7 @@
 module Core
   module Models
-    module Monitoring
-      # A route is an endpoint accessible in a service. Each route has to have an associated endpoint in the deployed instances.
+    module Permissions
+      # A route is an endpoint accessible in the API. Each route has to have an associated endpoint in the deployed instances.
       # @param Vincent Courtois <courtois.vincent@outlook.com>
       class Route
         include Mongoid::Document
@@ -9,20 +9,17 @@ 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 service?
+        #   @return [String] the path (URI) of the route in the API.
         field :path, type: String, default: '/'
         # @!attribute [rw] verb
-        #   @return [String] the verb (HTTP method) of this route in the service.
+        #   @return [String] the verb (HTTP method) of this route in the API.
         field :verb, type: String, default: 'get'
         # @!attribute [rw] authenticated
         #   @return [Boolean] if true, the session_id is needed for this route, if false it is not.
-        field :authenticated, type: Boolean, default: true
-
-        # @!attribute [rw] service
-        #   @return [Core::Models::Monitoring::Service] the service in which this route is declared.
-        belongs_to :service, class_name: 'Core::Models::Monitoring::Service', inverse_of: :routes
-
+        field :authenticated, type: Mongoid::Boolean, default: true
         # @!attribute [rw] groups
         #   @return [Array<Core::Models::Permissions::Group>] the groups having permission to access this route.
         has_and_belongs_to_many :groups, class_name: 'Core::Models::Permissions::Group', inverse_of: :groups
@@ -32,12 +29,6 @@ module Core
 
         validates :verb,
           inclusion: {message: 'unknown', in: ['get', 'post', 'put', 'delete', 'patch', 'option']}
-
-        # Returns the complete path, enriched with the path of the service.
-        # @return [String] the complete path to access this route from the outside.
-        def complete_path
-          path == '/' ? service.path : "#{service.path}#{path}"
-        end
       end
     end
   end

data/lib/core/models/permissions.rb

@@ -7,6 +7,7 @@ module Core
       autoload :Right   , 'core/models/permissions/right'
       autoload :Group   , 'core/models/permissions/group'
       autoload :Category, 'core/models/permissions/category'
+      autoload :Route   , 'core/models/permissions/route'
     end
   end
 end

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/models.rb

@@ -15,13 +15,10 @@ module Core
     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/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.0.0'
+  VERSION = '1.2.1'
 end

data/lib/core.rb

@@ -6,5 +6,8 @@ require 'dotenv/load'
 # Main module of the application, holding all the subsequent classes.
 # @author Vincent Courtois <courtois.vincent@outlook.com>
 module Core
+  autoload :Controllers, 'core/controllers'
+  autoload :Helpers, 'core/helpers'
   autoload :Models, 'core/models'
+  autoload :Services, 'core/services'
 end