arkaan 1.3.11 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3453ca2f5008c85b237f6db1f5a83d829e5d8bb1
-  data.tar.gz: f9ba7f3c279e3b4ccaf8a38fd57f66d73ae29c74
+  metadata.gz: 1e39623177ee5030ea01c5247ff141e16cf822ff
+  data.tar.gz: c6ece8164773ae0dbd40cdb9f81ea2cb3f51ff2e
 SHA512:
-  metadata.gz: 80afc1f50745c3cf5e588b14c2e26460740c83aa923c9fbd3f80fce272a287497c0af862b3e8a53ed578a2651c8c2c3f462a27f0eae0cb7f402542585c67096b
-  data.tar.gz: 819afc88221dc311648a4070df1f45af95d7f115c112fe409a8cc0e3ea6f22f3894106ade2167ead0d4563fdf13df77c02878077212294471e0cc3308c244f33
+  metadata.gz: a7a0158cf4887d94e9213497c0281076ddabdd230884d1fc5b7fd605376f3568b303aeedada76ba685a4696c6678dad53668441323e9300fc00580e144ca26c4
+  data.tar.gz: c37f7e89de3de5a144233b69cddae20baa1a2670a0f1513dd9e95c9f3d1bcface464d0fcb92ae43aa80c75cd0096b9af44021b77bb0d574e64bd747ee67feb9c

data/lib/arkaan.rb

@@ -19,8 +19,11 @@ module Arkaan
   autoload :Decorators    , 'arkaan/decorators'
   autoload :Factories     , 'arkaan/factories'
   autoload :Monitoring    , 'arkaan/monitoring'
+  autoload :Notification  , 'arkaan/notification'
   autoload :OAuth         , 'arkaan/oauth'
   autoload :Permissions   , 'arkaan/permissions'
   autoload :Phone         , 'arkaan/phone'
+  autoload :Ruleset       , 'arkaan/ruleset'
+  autoload :Rulesets      , 'arkaan/rulesets'
   autoload :Utils         , 'arkaan/utils'
 end

data/lib/arkaan/account.rb

@@ -64,6 +64,19 @@ module Arkaan
     # @!attribute [rw] phones
     #   @return [Array<Arkaan::Phone>] the phone numbers given by the user.
     embeds_many :phones, class_name: 'Arkaan::Phone', inverse_of: :account
+    # @!attribute [rw] notifications
+    #  @return [Array<Arkaan::Notification>] the notifications linked to this user.
+    embeds_many :notifications, class_name: 'Arkaan::Notification', inverse_of: :account
+
+    # @return [Array<Arkaan::Notification>] the unread notifications that should be displayed first for the user.
+    def unread_notifications
+      notifications.where(read: false)
+    end
+
+    # @return [Array<Arkaan::Notification>] the notifications already read, less important to display than the unread ones.
+    def read_notifications
+      notifications.where(read: true)
+    end
 
     validates :username,
       presence: {message: 'required'},

data/lib/arkaan/campaign.rb

@@ -24,6 +24,9 @@ module Arkaan
     # @!attribute [rw] invitations
     #   @return [Array<Arkaan::Campaigns::Invitation>] the invitations to players that have been made for this campaign.
     has_many :invitations, class_name: 'Arkaan::Campaigns::Invitation', inverse_of: :campaign
+    # @!attribute [rw] files
+    #   @return [Array<Arkaan::Campaigns::File>] the list of files that were uploaded in this campaign.
+    has_many :files, class_name: 'Arkaan::Campaigns::File', inverse_of: :campaign
 
     # @!attribute [rw] messages
     #   @return [Array<Arkaan::Campaigns::Messages::Base>] the messages sent in the chatroom of the campaign.

data/lib/arkaan/campaigns.rb

@@ -2,9 +2,12 @@ module Arkaan
   # The campaigns module is holding the logic for some objects related to campaigns.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Campaigns
+    autoload :Document  , 'arkaan/campaigns/document'
     autoload :File      , 'arkaan/campaigns/file'
+    autoload :Files     , 'arkaan/campaigns/files'
     autoload :Invitation, 'arkaan/campaigns/invitation'
     autoload :Message   , 'arkaan/campaigns/message'
+    autoload :Note      , 'arkaan/campaigns/note'
     autoload :Tag       , 'arkaan/campaigns/tag'
   end
 end

data/lib/arkaan/campaigns/document.rb

@@ -0,0 +1,54 @@
+module Arkaan
+  module Campaigns
+    # A document is any piece of data added by a user to a campaign. It can either be a direct text note, or an uploaded file for example.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Document
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      # @!attribute [rw] permission
+      #   @return [Arkaan::Campaigns::Permission] the permissions granted to the different users of the campaign concerning this file.
+      has_many :permissions, class_name: 'Arkaan::Campaigns::Files::Permission', inverse_of: :file
+
+      # @!attribute [rw] campaign
+      #   @return [Arkaan::Campaign] the campaign in which this file was uploaded.
+      belongs_to :campaign, class_name: 'Arkaan::Campaign', inverse_of: :files
+
+      # Custom setter for the creator of the file so that it can be used as a normal field.
+      # @param invitation [Arkaan::Campaigns::Invitation] the invitation of the player creating this file.
+      def creator=(invitation)
+        if !permissions.where(invitation: invitation).exists?
+          Arkaan::Campaigns::Files::Permission.create(enum_level: :creator, file: self, invitation: invitation)
+        end
+      end
+
+      # Custom getter for the creator of the campaign.
+      # @return [Arkaan::Account] the account of the player that created this file.
+      def creator
+        return permissions.where(enum_level: :creator).first.invitation.account
+      end
+
+      # Checks if an account is allowed to access this file, accounts must have one of the following characteristics to read a file :
+      # - Be the creator of the file
+      # - Be the game master of the campaign in which the file is declared
+      # - Have been granted the permission to access the file
+      #
+      # @param account [Arkaan::Account] the account trying to access the file.
+      # @return [Boolean] TRUE if this account has the right to access the file, FALSe otherwise.
+      def is_allowed?(account)
+        return true if campaign.creator.id == account.id
+        return true if creator.id == account.id
+        return true if has_permission?(account)
+        return false
+      end
+
+      # Checks if the account has the permission to access the designated file.
+      # @param account [Arkaan::Account] the account to check the existence of a permission for.
+      # @return [Boolean] TRUE if the account has a permission to access this file, FALSE otherwise.
+      def has_permission?(account)
+        invitation = campaign.invitations.where(account: account).first
+        return !invitation.nil? && permissions.where(invitation: invitation).exists?
+      end
+    end
+  end
+end

data/lib/arkaan/campaigns/file.rb

@@ -2,9 +2,7 @@ module Arkaan
   module Campaigns
     # Representation of a file, allowing us to retrieve it on AWS by its filename and linked campaign ID.
     # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class File
-      include Mongoid::Document
-      include Mongoid::Timestamps
+    class File < Arkaan::Campaigns::Document
       include Arkaan::Concerns::MimeTypable
 
       # @!attribute [rw] filename
@@ -16,11 +14,7 @@ module Arkaan
 
       mime_type ['image/*', 'text/plain']
 
-      # @!attribute [rw] invitation
-      #   @return [Arkaan::Campaigns::Invitation] the link to the user creator of the file and the campaign it's created in.
-      embedded_in :invitation, class_name: 'Arkaan::Campaigns::Invitation', inverse_of: :files
-
-      validates :name     , presence: {message: 'required'}
+      validates :name, presence: {message: 'required'}
     end
   end
 end

data/lib/arkaan/campaigns/files.rb

@@ -0,0 +1,7 @@
+module Arkaan
+  module Campaigns
+    module Files
+      autoload :Permission, 'arkaan/campaigns/files/permission'
+    end
+  end
+end

data/lib/arkaan/campaigns/files/permission.rb

@@ -0,0 +1,26 @@
+module Arkaan
+  module Campaigns
+    module Files
+      # A file permission is the permission given by the creator of the file to another player to access it.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Permission
+        include Mongoid::Document
+        include Mongoid::Timestamps
+        include Arkaan::Concerns::Enumerable
+
+        # The status of a permission just differenciates the creator and the other players for the moment
+        # But it will later be used to give different access rights like read/write
+        # @!attribute [rw] status
+        #   @return [Symbol] the current level of permission for the linked user on the linked file.
+        enum_field :level, [:creator, :read], default: :read
+
+        # @!attribute [rw] invitation
+        #   @return [Arkaan::Campaigns::Invitation] the invitation of the player in the campaign where this file was uploaded.
+        belongs_to :invitation, class_name: 'Arkaan::Campaigns::Invitation', inverse_of: :permissions
+        # @!attribute [rw] file
+        #   @return [Arkaan::Campaigns::File] the file on which the permissions are granted.
+        belongs_to :file, class_name: 'Arkaan::Campaigns::File', inverse_of: :permissions
+      end
+    end
+  end
+end

data/lib/arkaan/campaigns/invitation.rb

@@ -20,7 +20,7 @@ module Arkaan
 
       # @!attribute [rw] files
       #   @return [Array<Arkaan::Campaigns::File>] the files uploaded in this campaign by the usere linked to this invitation.
-      embeds_many :files, class_name: 'Arkaan::Campaigns::File', inverse_of: :invitation
+      has_many :permissions, class_name: 'Arkaan::Campaigns::File', inverse_of: :invitation
     end
   end
 end

data/lib/arkaan/campaigns/note.rb

@@ -0,0 +1,7 @@
+module Arkaan
+  module Campaigns
+    class Note < Arkaan::Campaigns::Document
+      field :content, type: String, default: ''
+    end
+  end
+end

data/lib/arkaan/notification.rb

@@ -0,0 +1,22 @@
+module Arkaan
+  # A notification is a little something to warn a user that an action concerning him or her occurred.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  class Notification
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    # @!attribute [rw] type
+    #   @return [String] the type of notification this is supposed to be. All types are custom and facultative.
+    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
+    # @!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: {}
+
+    # @!attribute [rw] account
+    #   @return [Arkaan::Account] the account concerned by this notification.
+    embedded_in :account, class_name: 'Arkaan::Account', inverse_of: :notifications
+  end
+end

data/lib/arkaan/ruleset.rb

@@ -0,0 +1,27 @@
+module Arkaan
+  # 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] creator
+    #   @return [Arkaan::Account] the account of the user creating this ruleset.
+    belongs_to :creator, class_name: 'Arkaan::Account', inverse_of: :rulesets
+    # @!attribute [rw] blueprints
+    #   @return [Array<Arkaan::Rulesets::Blueprint>] the blueprints created inside this ruleset, see the class itself to know what it is.
+    has_many :blueprints, class_name: 'Arkaan::Rulesets::Blueprint', inverse_of: :ruleset
+
+    validates :name,
+      presence: {message: 'required'},
+      length: {minimum: 4, message: 'minlength', if: :name?},
+      uniqueness: {message: 'uniq', if: :name?}
+  end
+end

data/lib/arkaan/rulesets.rb

@@ -0,0 +1,11 @@
+module Arkaan
+  # The rulesets module holds all the logic for components present inside a ruleset.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  module Rulesets
+    autoload :Blueprint, 'arkaan/rulesets/blueprint'
+    autoload :Field    , 'arkaan/rulesets/field'
+    autoload :Fields   , 'arkaan/rulesets/fields'
+    autoload :Gauge    , 'arkaan/rulesets/gauge'
+    autoload :Integer  , 'arkaan/rulesets/integer'
+  end
+end

data/lib/arkaan/rulesets/blueprint.rb

@@ -0,0 +1,34 @@
+module Arkaan
+  module Rulesets
+    # A blueprint defines what a type of entity contains.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Blueprint
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      # @!attribute [rw] name
+      #   @return [String] the name of this type of entity in the ruleset.
+      field :name, type: String
+
+      # @!attribute [rw] ruleset
+      #   @return [Arkaan::Ruleset] the ruleset to which this blueprint belongs.
+      belongs_to :ruleset, class_name: 'Arkaan::Ruleset', inverse_of: :blueprints
+      # @!attribute [rw] _fields
+      #   @return [Array<Arkaan::Rulesets::Field>] the field composing the attributes of this blueprint.
+      embeds_many :_fields, class_name: 'Arkaan::Rulesets::Field', inverse_of: :blueprint
+
+      validates :name,
+        presence: {message: 'required'},
+        length: {minimum: 4, message: 'minlength', if: :name?}
+
+      validate :name_unicity
+
+      def name_unicity
+        has_duplicate = ruleset.blueprints.where(:_id.ne => _id, name: name).exists?
+        if !ruleset.nil? && name? && has_duplicate
+          errors.add(:name, 'uniq')
+        end
+      end
+    end
+  end
+end

data/lib/arkaan/rulesets/field.rb

@@ -0,0 +1,71 @@
+module Arkaan
+  module Rulesets
+    # A field is an attribute of a blueprint, with a type and a name.
+    # It does not have a defined value as it will be given in the instance of the blueprint.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Field
+      include Mongoid::Document
+      include Mongoid::Timestamps
+      include Arkaan::Concerns::Enumerable
+
+      # @!attribute [rw] name
+      #   @return [String] the name of the field is comparable to the name of a variable.
+      field :name, type: String
+      # @!attribute [rw] data
+      #   @return [Hash] the additional data, mainly constraints and needed values, for the field.
+      field :data, type: Hash, default: {}
+
+      # @!attribute [rw] blueprint
+      #   @return [Arkaan::Rulesets::Blueprint] the blueprint in which the field belongs.
+      embedded_in :blueprint, class_name: 'Arkaan::Rulesets::Blueprint', inverse_of: :_fields
+
+      validates :name,
+        presence: {message: 'required'},
+        length: {minimum: 4, message: 'minlength', if: :name?},
+        format: {with: /\A[a-zA-Z_]*\z/, message: 'pattern', if: :name?}
+
+      validate :name_unicity
+
+      validate :options_validity
+
+      # Getter for the type of the field, returning simply the last element of the type for simpler use.
+      # @return [Symbol] the name of the type of the field (eq :Integer or :Gauge)
+      def type
+        return _type.split('::').last.to_sym
+      end
+
+      # Default options for this type of field, specialize it in the subclasses.
+      # @return [Hash] a hash with the default value for all options you want default values on.
+      def default_options
+        return {}
+      end
+
+      # Setter for the additional datas, merging it with the default options for the current type.
+      # @param new_data [Hash] the additional data to add to this field.
+      def data=(new_data)
+        self[:data] = default_options.merge(new_data)
+      end
+
+      def name_unicity
+        has_duplicate = blueprint._fields.where(:_id.ne => _id, name: name).exists?
+        if name? && blueprint && has_duplicate
+          errors.add(:name, 'uniq')
+        end
+      end
+
+      def options_validity
+        send(:validate_options) rescue true
+      end
+
+      # Checks the corresponding option key against the given data type. All types can be used.
+      # @param key [String] the name of the key in the options you want to check the type of.
+      # @param required_type [String] the exact name of the class you want to check the option against.
+      def check_type(key, required_type)
+        parsed_type = Object.const_get("::#{required_type}")
+        if !errors.messages.has_key?(:data) && data[key.to_sym] && !data[key.to_sym].is_a?(parsed_type)
+          errors.add(:data, "#{key.to_s}|type")
+        end
+      end
+    end
+  end
+end

data/lib/arkaan/rulesets/fields.rb

@@ -0,0 +1,10 @@
+module Arkaan
+  module Rulesets
+    # This module holds all the classes for the different fields types in the blueprints.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Fields
+      autoload :Gauge  , 'arkaan/rulesets/fields/gauge'
+      autoload :Integer, 'arkaan/rulesets/fields/integer'
+    end
+  end
+end

data/lib/arkaan/rulesets/fields/gauge.rb

@@ -0,0 +1,20 @@
+module Arkaan
+  module Rulesets
+    module Fields
+      # A gauge is composed of a max value, and a min value, and when instanciated has a current value that can't go above max or below min.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Gauge < Arkaan::Rulesets::Field
+        def default_options
+          return {initial: 0, max: 100, min: 0, show: true}
+        end
+
+        def validate_options
+          check_type(:initial, 'Integer')
+          check_type(:max, 'Integer')
+          check_type(:min, 'Integer')
+          check_type(:show, 'Boolean')
+        end
+      end
+    end
+  end
+end

data/lib/arkaan/rulesets/fields/integer.rb

@@ -0,0 +1,14 @@
+module Arkaan
+  module Rulesets
+    module Fields
+      # An integer field can have a minimum and maximum value.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Integer < Arkaan::Rulesets::Field
+        def validate_options
+          check_type(:max, 'Integer')
+          check_type(:min, 'Integer')
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 1.3.11
+  version: 1.4.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-10 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -122,20 +122,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.11.1
-- !ruby/object:Gem::Dependency
-  name: draper
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.0.1
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -248,6 +234,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: draper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.1
 description: This gem holds the model layer for my table-top RPG games application.
 email: courtois.vincent@outlook.com
 executables: []
@@ -260,9 +260,13 @@ files:
 - lib/arkaan/authentication/session.rb
 - lib/arkaan/campaign.rb
 - lib/arkaan/campaigns.rb
+- lib/arkaan/campaigns/document.rb
 - lib/arkaan/campaigns/file.rb
+- lib/arkaan/campaigns/files.rb
+- lib/arkaan/campaigns/files/permission.rb
 - lib/arkaan/campaigns/invitation.rb
 - lib/arkaan/campaigns/message.rb
+- lib/arkaan/campaigns/note.rb
 - lib/arkaan/campaigns/tag.rb
 - lib/arkaan/concerns.rb
 - lib/arkaan/concerns/activable.rb
@@ -287,6 +291,7 @@ files:
 - lib/arkaan/monitoring/route.rb
 - lib/arkaan/monitoring/service.rb
 - lib/arkaan/monitoring/websocket.rb
+- lib/arkaan/notification.rb
 - lib/arkaan/oauth.rb
 - lib/arkaan/oauth/access_token.rb
 - lib/arkaan/oauth/application.rb
@@ -297,6 +302,13 @@ files:
 - lib/arkaan/permissions/group.rb
 - lib/arkaan/permissions/right.rb
 - lib/arkaan/phone.rb
+- lib/arkaan/ruleset.rb
+- lib/arkaan/rulesets.rb
+- lib/arkaan/rulesets/blueprint.rb
+- lib/arkaan/rulesets/field.rb
+- lib/arkaan/rulesets/fields.rb
+- lib/arkaan/rulesets/fields/gauge.rb
+- lib/arkaan/rulesets/fields/integer.rb
 - lib/arkaan/specs.rb
 - lib/arkaan/utils.rb
 - lib/arkaan/utils/controller.rb