arkaan 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bde2ac4f9badeeff70fa6534caafb6080a2d0d1f0f1a1a8166ad8b8607bb6bd7
-  data.tar.gz: 95b9406a7be27cf571956a25f15714e3738d23ce2f57bbf9d22ca4cdcaf41faa
+  metadata.gz: 931a5d11dc8f40aa987d3960f2a8e16dc66ec04c6f1a442ecc31f3bbc08431fa
+  data.tar.gz: a425f9550df833b6221daa379b57d1ecaa54d428a253de887dffc9845ba59d88
 SHA512:
-  metadata.gz: fd2894fdb157d26cbe7b1421566da14cb9f72ee9ca0033bd6e4c2c308f60985c1e09893f4040de08ec45642dae5b0cf36bb71fe1a2c5b83735d82c9354ce5dc7
-  data.tar.gz: fca967434233e4f426ed12a52de45892f555d03ea8288ed2184607ea8392dece9ab517c574996c30b6288b48c44b697dfca6642c2724b37e8013582482624f55
+  metadata.gz: e7263f342e7821a773574f5bdc98fa35e6d931bc1b2223941be1c5ac790dbf83d3063561ff82f4f0bf345e14ba30391ba22640225efe23e33b90b7bff04a8f0f
+  data.tar.gz: decf9dc3d4431fd1c8fd84f557dcb2f46ba8f7674add35b947ef167fb69cfc198fd1a1c0c47e8020d71b02f1e24d8b28ef721ecaad2accfd6428e1b00fbdac60

data/lib/arkaan/campaign.rb

@@ -25,13 +25,17 @@ module Arkaan
     #   @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
+    #   @return [Array<Arkaan::Campaigns::Files::Document>] the list of files that were uploaded in this campaign.
+    has_many :files, class_name: 'Arkaan::Campaigns::Files::Document', inverse_of: :campaign
 
     # @!attribute [rw] messages
     #   @return [Array<Arkaan::Campaigns::Messages::Base>] the messages sent in the chatroom of the campaign.
     embeds_many :messages, class_name: 'Arkaan::Campaigns::Message', inverse_of: :campaign
 
+    # @!attribute [rw] ruleset
+    #   @return [Arkaan::Ruleset] the set of rules this campaign is based upon.
+    belongs_to :ruleset, class_name: 'Arkaan::Ruleset', inverse_of: :campaigns, optional: true
+
     validates :title,
       presence: {message: 'required'},
       length: {minimum: 4, message: 'minlength', if: :title?}

data/lib/arkaan/campaigns.rb

@@ -2,12 +2,9 @@ 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/files.rb

@@ -1,6 +1,11 @@
 module Arkaan
   module Campaigns
     module Files
+      autoload :Base      , 'arkaan/campaigns/files/base'
+      autoload :Character , 'arkaan/campaigns/files/character'
+      autoload :Concerns  , 'arkaan/campaigns/files/concerns'
+      autoload :Document  , 'arkaan/campaigns/files/document'
+      autoload :Note      , 'arkaan/campaigns/files/note'
       autoload :Permission, 'arkaan/campaigns/files/permission'
     end
   end

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

@@ -0,0 +1,56 @@
+module Arkaan
+  module Campaigns
+    module Files
+      # 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 Base
+        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
+end

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

@@ -0,0 +1,48 @@
+module Arkaan
+  module Campaigns
+    module Files
+      # A character sheet represents a character played by a player in a campaign.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Character < Arkaan::Campaigns::Files::Base
+        include Arkaan::Campaigns::Files::Concerns::Nameable
+        include Arkaan::Concerns::MimeTypable
+
+        # @!attribute [rw] selected
+        #   @return [Boolean] TRUE if the sheet is currently selected by the player, FALSE otherwise.
+        field :selected, type: Boolean, default: false
+        # @!attribute [rw] mime_type
+        #   @return [String] the mime_type of the character sheet, MUST be an authorized MIME type for
+        #     the ruleset the campaign is set to be in.
+        mime_type :available_mime_types
+
+        # @!attribute [rw] invitation
+        #   @return [Arkaan::Campaigns::Invitation] the invitation of the player playing this character.
+        belongs_to :invitation, class_name: 'Arkaan::Campaigns::Invitation', inverse_of: :characters
+
+        # Returns the player linked to this character.
+        # @return [Arkaan::Account] the account of the player incarnating this character.
+        def player
+          invitation.account
+        end
+
+        # Method used to dinamically determine what MIME types are allowed for this character sheet
+        # If the campaign this character is in has no ruleset, every MIME type is allowed.
+        # @return [Array<String>] the available MIME type for the campaign linked to this character.
+        def available_mime_types
+          invitation.campaign.ruleset.mime_types
+        end
+
+        # Puts the selected flag to TRUE for this character and to FALSE for all the
+        # other characters for the same player in the same campaign.
+        def select!
+          invitation.characters.each do |character|
+            character.update_attribute(:selected, false)
+            character.save!
+          end
+          update_attribute(:selected, true)
+          save!
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Arkaan
+  module Campaigns
+    module Files
+      module Concerns
+        autoload :Nameable, 'arkaan/campaigns/files/concerns/nameable'
+      end
+    end
+  end
+end

data/lib/arkaan/campaigns/files/concerns/nameable.rb

@@ -0,0 +1,64 @@
+module Arkaan
+  module Campaigns
+    module Files
+      module Concerns
+        module Nameable
+          extend ActiveSupport::Concern
+
+          included do
+            # @!attribute [rw] filename
+            #   @return [String] the name of the file, corresponding to the AWS name.
+            field :name, type: String
+
+            validates :name, presence: {message: 'required'}
+
+            validate :name_unicity
+
+            # Checks if the name is unique in the campaign, and if it is not then modifies it.
+            # The modifications are the same than in a windows or UNIX system :
+            # - if the name exists as it is given, the system adds the suffix "(1)" to it.
+            # - if the name with the suffix still exists, the system tries to increment it until an available name is found.
+            # - the found name is then afected to the name of the current file.
+            def name_unicity
+              if !campaign.nil? && !self[:name].nil?
+                if exists_in_campaign(self[:name])
+                  suffix = 1
+                  while exists_in_campaign(merge_suffix(suffix))
+                    suffix = suffix + 1
+                  end
+                  self[:name] = merge_suffix(suffix)
+                end
+              end
+            end
+
+            # Merges the given suffix with the name correctly.
+            # @param suffix [String] the suffix to append between perenthesis at the end of the file name, but before the extension.
+            # @return [String] the complete name for the file, with the suffix correctly appended.
+            def merge_suffix(suffix)
+              return "#{raw_name} (#{suffix}).#{extension}"
+            end
+
+            # Checks if the given name already exists for a file in the campaign.
+            # @param tmp_name [String] the name to check the existence of in the campaign.
+            # @return [Boolean] TRUE if the file exists in the campaign, FALSE otherwise.
+            def exists_in_campaign(tmp_name)
+              campaign.files.where(name: tmp_name, :id.ne => id).exists?
+            end
+
+            # Returns the file name without the extension for the current file.
+            # @return [String] the name of the file without the extension.
+            def raw_name
+              return self[:name].gsub(".#{extension}", '')
+            end
+
+            # Returns the extension of the file, without the dot.
+            # @return [String] the text representation for this file extension, without the leading dot.
+            def extension
+              return self[:name].split('.').last
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Arkaan
+  module Campaigns
+    module Files
+      # 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 Document < Arkaan::Campaigns::Files::Base
+        include Arkaan::Concerns::MimeTypable
+        include Arkaan::Campaigns::Files::Concerns::Nameable
+
+        # @!attribute [rw] size
+        #   @return [Integer] the size of the file in bytes.
+        field :size, type: Integer, default: 0
+
+        mime_type ['image/*', 'text/plain']
+      end
+    end
+  end
+end

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

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

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

@@ -18,8 +18,8 @@ module Arkaan
         #   @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
+        #   @return [Arkaan::Campaigns::Files::Document] the file on which the permissions are granted.
+        belongs_to :file, class_name: 'Arkaan::Campaigns::Files::Document', inverse_of: :permissions
       end
     end
   end

data/lib/arkaan/campaigns/invitation.rb

@@ -19,8 +19,17 @@ module Arkaan
       belongs_to :campaign, class_name: 'Arkaan::Campaign', inverse_of: :invitations
 
       # @!attribute [rw] files
-      #   @return [Array<Arkaan::Campaigns::File>] the files uploaded in this campaign by the usere linked to this invitation.
-      has_many :permissions, class_name: 'Arkaan::Campaigns::File', inverse_of: :invitation
+      #   @return [Array<Arkaan::Campaigns::Files::Document>] the files uploaded in this campaign by the user linked to this invitation.
+      has_many :permissions, class_name: 'Arkaan::Campaigns::Files::Document', inverse_of: :invitation
+      # @!attribute [rw] characters
+      #   @return [Array<Arkaan::Campaigns::Files::Character>] the character sheets for this player.
+      has_many :characters, class_name: 'Arkaan::Campaigns::Files::Character', inverse_of: :invitation
+
+      # Gets the currently selected character in a convenient way.
+      # @return [Arkaan::Campaigns::Files::Character] the character currently selected by the player.
+      def character
+        characters.where(selected: true).first
+      end
     end
   end
 end

data/lib/arkaan/concerns/mime_typable.rb

@@ -23,7 +23,13 @@ module Arkaan
           # Validates the validity of the MIME type by checking if it respects any of the given mime types.
           # If it does not respect any MIME types possible, it adds an error to the mime_type field and invalidates.
           define_method :mime_type_validity do
-            values.each do |type|
+            checked_types = if values.is_a? Symbol
+              self.send(values) rescue []
+            else
+              values
+            end
+            return true if checked_types.empty?
+            checked_types.each do |type|
               type_regex = ::Regexp.new("^#{type.sub(/\*/, '(.+)')}$")
               return true if !type_regex.match(mime_type).nil?
             end

data/lib/arkaan/ruleset.rb

@@ -11,13 +11,22 @@ module Arkaan
     # @!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 [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.
+    #   @return [Arr  ay<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
+    # @!attribute [rw] campaigns
+    #   @return [Array<Arkaan::Campaign>] the campaigns using this set of rules.
+    has_many :campaigns, class_name: 'Arkaan::Campaign', inverse_of: :ruleset
+    # @!attribute [rw] sheet
+    #   @return [Arkaan::Rulesets::Sheet] the character sheet template for this set of rules.
+    has_one :sheet, class_name: 'Arkaan::Rulesets::Sheet', inverse_of: :ruleset
 
     validates :name,
       presence: {message: 'required'},

data/lib/arkaan/rulesets.rb

@@ -7,5 +7,7 @@ module Arkaan
     autoload :Fields   , 'arkaan/rulesets/fields'
     autoload :Gauge    , 'arkaan/rulesets/gauge'
     autoload :Integer  , 'arkaan/rulesets/integer'
+    autoload :Sheet    , 'arkaan/rulesets/sheet'
+    autoload :Sheets   , 'arkaan/rulesets/sheets'
   end
 end

data/lib/arkaan/rulesets/sheet.rb

@@ -0,0 +1,28 @@
+module Arkaan
+  module Rulesets
+    # A character sheet is the templating to parse and transform an uploaded
+    # XML file into a readable character sheet we can display on the interface.
+    # The main way to do it is to create attributes sorted into categories (optional)
+    # and to link each of these attributes to a XPath selector in the XML sheet
+    # the game master uploaded and linked to the player.
+    #
+    # This way we can just rebuild a JSON object with the categories and fields
+    # defined in the sheet, extracted from the XML sheet of the character.
+    #
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Sheet
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      # @!attribute [rw] ruleset
+      #   @return [Arkaan::Ruleset] the set of rules this sheet corresponds to.
+      belongs_to :ruleset, class_name: 'Arkaan::Ruleset', inverse_of: :sheet
+      # @!attribute [rw] creator
+      #   @return [Arkaan::Account] the account of the creator of the sheet.
+      belongs_to :creator, class_name: 'Arkaan::Account'
+      # @!attribute [rw] categories
+      #   @return [Array<Arkaan::Rulesets::Sheets::Category>] the categories declared in this sheet.
+      embeds_many :categories, class_name: 'Arkaan::Rulesets::Sheets::Category', inverse_of: :sheet
+    end
+  end
+end

data/lib/arkaan/rulesets/sheets.rb

@@ -0,0 +1,10 @@
+module Arkaan
+  module Rulesets
+    # This module regroups the entities embedded in a character sheet template.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Sheets
+      autoload :Attribute, 'arkaan/rulesets/sheets/attribute'
+      autoload :Category , 'arkaan/rulesets/sheets/category'
+    end
+  end
+end

data/lib/arkaan/rulesets/sheets/attribute.rb

@@ -0,0 +1,40 @@
+module Arkaan
+  module Rulesets
+    module Sheets
+      class Attribute
+        include Mongoid::Document
+        include Mongoid::Timestamps
+        include Arkaan::Concerns::Enumerable
+
+        # @!attribute [rw] name
+        #   @return [String] the name of the attribute in the character sheet.
+        #     This name is then used in the translation files as a key to retrieve it.
+        field :name, type: String, default: ''
+        # @!attribute [rw] default
+        #   @return [Object] the default value for this attribute. Not typed so it
+        #     can be any type of value (mainly integer, strings or datetimes)
+        field :default
+        # @!attribute [rw] xpath
+        #   @return [String] the path to find this attribute in the XML sheet uploaded.
+        field :xpath, type: String
+
+        # @!attribute [rw] category
+        #   @return [Arkaan::Rulesets::Sheets::Category] the category the attribute is in.
+        embedded_in :category, class_name: 'Arkaan::Rulesets::Sheets::Category', inverse_of: :attrs
+
+        validates :name,
+          presence: {message: 'required'},
+          format: {with: /\A[a-zA-Z_]*\z/, message: 'pattern', if: :name?}
+
+        validate :name_unicity
+        
+        def name_unicity
+          has_duplicate = category.attrs.where(:_id.ne => _id, name: name).exists?
+          if name? && category && has_duplicate
+            errors.add(:name, 'uniq')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/arkaan/rulesets/sheets/category.rb

@@ -0,0 +1,25 @@
+module Arkaan
+  module Rulesets
+    module Sheets
+      # A category is just a semantic group of attributes having the same function
+      # or sharing some semantic proximity (eg. all characteristics or skills).
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Category
+        include Mongoid::Document
+        include Mongoid::Timestamps
+
+        # @!attribute [rw] name
+        #   @return [String] the name of the category you're creating.
+        field :name, type: String, default: ''
+
+        # @!attribute [rw] sheet
+        #   @return [Arkaan::Rulesets::Sheet] the sheet template the category is embedded in; 
+        embedded_in :sheet, class_name: 'Arkaan::Rulesets::Sheet', inverse_of: :categories
+
+        # @!attribute [rw] attributes
+        #   @return [Array<Arkaan::Rulesets::Sheets::Attribute>] the attributes linked to this category.
+        embeds_many :attrs, class_name: 'Arkaan::Rulesets::Sheets::Attribute', inverse_of: :category
+      end
+    end
+  end
+end

data/lib/arkaan/version.rb

@@ -1,3 +1,3 @@
 module Arkaan
-  VERSION = '1.7.0'
+  VERSION = '1.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-27 00:00:00.000000000 Z
+date: 2019-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -302,13 +302,16 @@ 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/base.rb
+- lib/arkaan/campaigns/files/character.rb
+- lib/arkaan/campaigns/files/concerns.rb
+- lib/arkaan/campaigns/files/concerns/nameable.rb
+- lib/arkaan/campaigns/files/document.rb
+- lib/arkaan/campaigns/files/note.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
@@ -355,6 +358,10 @@ files:
 - lib/arkaan/rulesets/fields.rb
 - lib/arkaan/rulesets/fields/gauge.rb
 - lib/arkaan/rulesets/fields/integer.rb
+- lib/arkaan/rulesets/sheet.rb
+- lib/arkaan/rulesets/sheets.rb
+- lib/arkaan/rulesets/sheets/attribute.rb
+- lib/arkaan/rulesets/sheets/category.rb
 - lib/arkaan/specs.rb
 - lib/arkaan/utils.rb
 - lib/arkaan/utils/controllers.rb

data/lib/arkaan/campaigns/document.rb

@@ -1,54 +0,0 @@
-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

@@ -1,65 +0,0 @@
-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 < Arkaan::Campaigns::Document
-      include Arkaan::Concerns::MimeTypable
-
-      # @!attribute [rw] filename
-      #   @return [String] the name of the file, corresponding to the AWS name.
-      field :name, type: String
-      # @!attribute [rw] size
-      #   @return [Integer] the size of the file in bytes.
-      field :size, type: Integer, default: 0
-
-      mime_type ['image/*', 'text/plain']
-
-      validates :name, presence: {message: 'required'}
-
-      validate :name_unicity
-
-      # Checks if the name is unique in the campaign, and if it is not then modifies it.
-      # The modifications are the same than in a windows or UNIX system :
-      # - if the name exists as it is given, the system adds the suffix "(1)" to it.
-      # - if the name with the suffix still exists, the system tries to increment it until an available name is found.
-      # - the found name is then afected to the name of the current file.
-      def name_unicity
-        if !campaign.nil? && !self[:name].nil?
-          if exists_in_campaign(self[:name])
-            suffix = 1
-            while exists_in_campaign(merge_suffix(suffix))
-              suffix = suffix + 1
-            end
-            self[:name] = merge_suffix(suffix)
-          end
-        end
-      end
-
-      # Merges the given suffix with the name correctly.
-      # @param suffix [String] the suffix to append between perenthesis at the end of the file name, but before the extension.
-      # @return [String] the complete name for the file, with the suffix correctly appended.
-      def merge_suffix(suffix)
-        return "#{raw_name} (#{suffix}).#{extension}"
-      end
-
-      # Checks if the given name already exists for a file in the campaign.
-      # @param tmp_name [String] the name to check the existence of in the campaign.
-      # @return [Boolean] TRUE if the file exists in the campaign, FALSE otherwise.
-      def exists_in_campaign(tmp_name)
-        campaign.files.where(name: tmp_name, :id.ne => id).exists?
-      end
-
-      # Returns the file name without the extension for the current file.
-      # @return [String] the name of the file without the extension.
-      def raw_name
-        return self[:name].gsub(".#{extension}", '')
-      end
-
-      # Returns the extension of the file, without the dot.
-      # @return [String] the text representation for this file extension, without the leading dot.
-      def extension
-        return self[:name].split('.').last
-      end
-    end
-  end
-end

data/lib/arkaan/campaigns/note.rb

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