arkaan 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3b465b5fc4b05bb9c7418535aad8e08604e5a31a9ced1f59c35b1b9e034564a
-  data.tar.gz: f4b606b42e585e3f76fb67822438e45c3db8e992d0e147a6aa862269b2542ba4
+  metadata.gz: 88f3666897172e59135de5920b17f9356a7cdcf2877b5f5244eb21b55f95c7c8
+  data.tar.gz: 73c232117a9f905d00d1853d03176460b139a8a8b9b59544a5975d6af825d5c1
 SHA512:
-  metadata.gz: d10d9f661bd8a6a2355e1e9f5d3d8facda27b109c0573a95a0a36a99298b286b4e5aa232f0d43b5a57fe9428f320abe1fff64a1b29ba1262eb7132102a757d07
-  data.tar.gz: 01405711bc3616838a2dfa1ba589b19f1ed747c0ad1357f556f350cd5525779fb662231f6dbe2eebc169d6d8f7c93b6c5537e61877d8ed24c8127355715654e9
+  metadata.gz: 3035f83abcc6a2970d3fa21b149fe70ab6f9e7908fa124c01917a54c89d087a1239694e82241882df74b672494b3e38d1a9951b83bca512b54ee10134f7e4c6b
+  data.tar.gz: c5529c6c1c9ba7686492379bff4e2ab509d0a0f9515d1c77b190a175000af86ba8bedd22b2a919fa7c6a375253d8c9036fa41d5ab33d14c55a4eaec2a29d55e7

data/lib/arkaan.rb

@@ -18,6 +18,7 @@ module Arkaan
   autoload :Campaigns     , 'arkaan/campaigns'
   autoload :Concerns      , 'arkaan/concerns'
   autoload :Factories     , 'arkaan/factories'
+  autoload :Files         , 'arkaan/files'
   autoload :Monitoring    , 'arkaan/monitoring'
   autoload :Notification  , 'arkaan/notification'
   autoload :OAuth         , 'arkaan/oauth'

data/lib/arkaan/account.rb

@@ -60,6 +60,9 @@ module Arkaan
     # @!attribute [rw] websockets
     #   @return [Array<Arkaan::Monitoring::Websocket>] the websockets created by the owner of this account.
     has_many :websockets, class_name: 'Arkaan::Monitoring::Websocket', inverse_of: :creator
+    # @!attribute [rw] permissions
+    #   @return [Array<Arkaan::Files::Permission>] the file access permissions granted to this account.
+    has_many :permissions, class_name: 'Arkaan::Files::Permission', inverse_of: :account
 
     # @!attribute [rw] notifications
     #  @return [Array<Arkaan::Notification>] the notifications linked to this user.

data/lib/arkaan/campaign.rb

@@ -25,8 +25,8 @@ 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::Files::Document>] the list of files that were uploaded in this campaign.
-    has_many :files, class_name: 'Arkaan::Campaigns::Files::Document', inverse_of: :campaign
+    #   @return [Array<Arkaan::Files::Document>] the files uploaded in this campaign.
+    has_many :files, class_name: 'Arkaan::Files::Document'
 
     # @!attribute [rw] messages
     #   @return [Array<Arkaan::Campaigns::Messages::Base>] the messages sent in the chatroom of the campaign.
@@ -90,15 +90,5 @@ module Arkaan
     def players_count
       players.count
     end
-
-    # @return [Array<Arkaan::Campaigns::Character>] a flattened list of characters for this campaign.
-    def characters
-      players.map(&:characters).flatten
-    end
-
-    # @return [Array<Arkaan::Campaigns::Files::Document>] the document of this campaign as a flattened array.
-    def documents
-      invitations.map(&:documents).flatten
-    end
   end
 end

data/lib/arkaan/campaigns.rb

@@ -2,8 +2,6 @@ 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 :Character , 'arkaan/campaigns/character'
-    autoload :Files     , 'arkaan/campaigns/files'
     autoload :Invitation, 'arkaan/campaigns/invitation'
     autoload :Message   , 'arkaan/campaigns/message'
     autoload :Tag       , 'arkaan/campaigns/tag'

data/lib/arkaan/campaigns/invitation.rb

@@ -17,29 +17,6 @@ module Arkaan
       # @!attribute [rw] campaign
       #   @return [Arkaan::Campaign] the campaign the invitation has been made in.
       belongs_to :campaign, class_name: 'Arkaan::Campaign', inverse_of: :invitations
-
-      # @!attribute [rw] files
-      #   @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::Permission', inverse_of: :invitation
-      # @!attribute [rw] characters
-      #   @return [Array<Arkaan::Campaigns::Character>] the character sheets for this player.
-      has_many :characters, class_name: 'Arkaan::Campaigns::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
-
-      def documents
-        permissions.map(&:document)
-      end
-
-      def has_file?(filename)
-        return permissions.map(&:document).map(&:name).any? do |name|
-          name == filename
-        end
-      end
     end
   end
 end

data/lib/arkaan/files.rb

@@ -0,0 +1,6 @@
+module Arkaan
+  module Files
+    autoload :Document  , 'arkaan/files/document'
+    autoload :Permission, 'arkaan/files/permission'
+  end
+end

data/lib/arkaan/files/document.rb

@@ -0,0 +1,40 @@
+module Arkaan
+  module Files
+    # a document is an uploaded file in the S3 clone application.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Document
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      # @!attribute [rw] name
+      #   @return [String] the filename the user entered when uploading the file.
+      field :name, type: String
+
+      field :extension, type: String
+      # @!attribute [rw] size
+      #   @return [String] the size, in bytes, of the uploaded file.
+      field :size, type: Integer, default: 0
+      # @!attribute [rw] folder
+      #   @return [String] the folder in which the file is stored in the S3 clone.
+      field :folder, type: String, default: '/'
+      # @!attribute [rw] mime_type
+      #   @return [String] the MIME type of the file. this MAY not correspond to the real
+      #     MIME type of the uploaded file, this is just an indication.
+      field :mime_type, type: String
+
+      # @!attribute [rw] creator
+      #   @return [Arkaan::Account] the account of the person that uploaded the file.
+      belongs_to :creator, class_name: 'Arkaan::Account', inverse_of: :files
+
+      # @!attribute [rw] permissions
+      #   @return [Array<Arkaan::Files::Permission>] the permissions granted to access this file.
+      has_many :permissions, class_name: 'Arkaan::Files::Permission', inverse_of: :file
+
+      validates :name, uniqueness: {message: 'uniq'}
+
+      validates :name, :extension, :folder, :mime_type, presence: {message: 'required'}
+
+      validates :folder, format: {without: /\/\//, message: 'format'}
+    end
+  end
+end

data/lib/arkaan/files/permission.rb

@@ -0,0 +1,22 @@
+module Arkaan
+  module Files
+    # The permission granted to a user to access and/or delete a file.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Permission
+      include Mongoid::Document
+      include Mongoid::Timestamps
+      include Arkaan::Concerns::Enumerable
+
+      # @!attribute [rw] type
+      #   @return [Symbol] the type of permission granted (is the user able to delete the file ?)
+      enum_field :type, [:read, :read_write]
+
+      # @!attribute [rw] file
+      #   @return [Arkaan::Files::Document] the document the permission is linked to.
+      belongs_to :file, class_name: 'Arkaan::Files::Document', inverse_of: :permissions
+      # @!attribute [rw] account
+      #   @return [Arkaan::Account] the user being granted the access to the file.
+      belongs_to :account, class_name: 'Arkaan::Account', inverse_of: :permissions
+    end
+  end
+end

data/lib/arkaan/version.rb

@@ -1,3 +1,3 @@
 module Arkaan
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-31 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -66,6 +66,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 4.8.1
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.1
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +142,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.7
+        version: 2.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.8
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.7
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -302,12 +330,6 @@ files:
 - lib/arkaan/authentication/session.rb
 - lib/arkaan/campaign.rb
 - lib/arkaan/campaigns.rb
-- lib/arkaan/campaigns/character.rb
-- lib/arkaan/campaigns/files.rb
-- lib/arkaan/campaigns/files/concerns.rb
-- lib/arkaan/campaigns/files/concerns/nameable.rb
-- lib/arkaan/campaigns/files/document.rb
-- lib/arkaan/campaigns/files/permission.rb
 - lib/arkaan/campaigns/invitation.rb
 - lib/arkaan/campaigns/message.rb
 - lib/arkaan/campaigns/tag.rb
@@ -326,6 +348,9 @@ files:
 - lib/arkaan/factories/errors.rb
 - lib/arkaan/factories/errors/gateway_not_found.rb
 - lib/arkaan/factories/gateways.rb
+- lib/arkaan/files.rb
+- lib/arkaan/files/document.rb
+- lib/arkaan/files/permission.rb
 - lib/arkaan/monitoring.rb
 - lib/arkaan/monitoring/action.rb
 - lib/arkaan/monitoring/gateway.rb

data/lib/arkaan/campaigns/character.rb

@@ -1,45 +0,0 @@
-module Arkaan
-  module Campaigns
-    # A character sheet represents a character played by a player in a campaign.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Character
-      include Mongoid::Document
-      include Mongoid::Timestamps
-
-      # @!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] data
-      #   @return [Hash] the heart of the Arkaan::Campaigns::Character class, the polymorphic
-      #     data representing all the fields of a character sheet are validated using the validator
-      #     of the associated plugin, and created/updated with the corresponding form.
-      field :data, type: Hash, default: {}
-
-      # @!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
-
-      def campaign
-        invitation.campaign
-      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

data/lib/arkaan/campaigns/files.rb

@@ -1,10 +0,0 @@
-module Arkaan
-  module Campaigns
-    module Files
-      autoload :Character , 'arkaan/campaigns/files/character'
-      autoload :Concerns  , 'arkaan/campaigns/files/concerns'
-      autoload :Document  , 'arkaan/campaigns/files/document'
-      autoload :Permission, 'arkaan/campaigns/files/permission'
-    end
-  end
-end

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

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

@@ -1,19 +0,0 @@
-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'}
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,64 +0,0 @@
-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 document for example.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      class Document
-        include Mongoid::Document
-        include Mongoid::Timestamps
-        include Arkaan::Concerns::MimeTypable
-        include Arkaan::Campaigns::Files::Concerns::Nameable
-        
-        # @!attribute [rw] size
-        #   @return [Integer] the size of the document in bytes.
-        field :size, type: Integer, default: 0
-
-        mime_type ['image/*', 'text/plain']
-
-        # @!attribute [rw] permission
-        #   @return [Arkaan::Campaigns::Permission] the permissions granted to the different users of the campaign concerning this document.
-        has_many :permissions, class_name: 'Arkaan::Campaigns::Files::Permission', inverse_of: :document
-
-        # Custom setter for the creator of the document so that it can be used as a normal field.
-        # @param invitation [Arkaan::Campaigns::Invitation] the invitation of the player creating this document.
-        def creator=(invitation)
-          if !permissions.where(invitation: invitation).exists?
-            Arkaan::Campaigns::Files::Permission.create(enum_level: :creator, document: self, invitation: invitation)
-          end
-        end
-
-        # Custom getter for the creator of the campaign.
-        # @return [Arkaan::Account] the account of the player that created this document.
-        def creator
-          return permissions.where(enum_level: :creator).first.invitation.account
-        end
-
-        # Checks if an account is allowed to access this document, accounts must have one of the following characteristics to read a document :
-        # - Be the creator of the document
-        # - Be the game master of the campaign in which the document is declared
-        # - Have been granted the permission to access the document
-        #
-        # @param account [Arkaan::Account] the account trying to access the document.
-        # @return [Boolean] TRUE if this account has the right to access the document, 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 document.
-        # @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 document, FALSE otherwise.
-        def has_permission?(account)
-          invitation = campaign.invitations.where(account: account).first
-          return !invitation.nil? && permissions.where(invitation: invitation).exists?
-        end
-
-        def campaign
-          permissions.first.invitation.campaign rescue nil
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-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::Files::Document] the file on which the permissions are granted.
-        belongs_to :document, class_name: 'Arkaan::Campaigns::Files::Document', inverse_of: :permissions
-      end
-    end
-  end
-end