arkaan 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fe7d3eac6402e98bbe2ad5d89304fa3724d3f4ae2cdf34b7d3e39cad91b933a
-  data.tar.gz: 9133895e88eee313f2c2e6dee1b328a37116d42dfd4f59d8a52631c8cb0206ec
+  metadata.gz: 7876afd3de8047883f8c7a4cedd1311c4b40dc3fdd711c3ebfa9b6abd118e330
+  data.tar.gz: 975ad0b4de93452222925f704460cb25f8d760cc26643bc2c1cd6377964a7fe4
 SHA512:
-  metadata.gz: 5f8582bf8546ea97a51323c48a3e87e536e9c528c67739fa362150f69d56d4579d22e912f850206ab3dafe954365307cfaba70d812ee2702c04f90ae70de442f
-  data.tar.gz: 1700055797b5790f2fac0cbd40675f351490960ad4149c7f6a237c7774ae970515e165fed7f1e24ff86e82e71b5b2f1b884660aa6e9b93278d2e8dde5ed93c0f
+  metadata.gz: 799b4bc8be02916ef27d7e3b99ee57991849450f7b0b2cab54945ebe8863a85a858836de4745725325fa76408b7799b284b7a28e91cc3bf3a294310b02daa314
+  data.tar.gz: 9e233034348c67b2a29672e3fe9154e252c5ce42819474c19b68cbf0adec613d1fb2dd9ce86ce3cba4823c46097bc7801a247132361ac2f08991b670f5f20326

data/lib/arkaan.rb

@@ -1,12 +1,6 @@
 require 'mongoid'
 require 'active_model'
 require 'active_support'
-require 'sinatra/base'
-require 'sinatra/config_file'
-require 'platform-api'
-require 'draper'
-require 'faraday'
-require 'sinatra/custom_logger'
 require 'dotenv/load'
 
 # Main module of the application, holding all the subsequent classes.
@@ -16,6 +10,8 @@ module Arkaan
   autoload :Authentication, 'arkaan/authentication'
   autoload :Campaign      , 'arkaan/campaign'
   autoload :Campaigns     , 'arkaan/campaigns'
+  autoload :Chatroom      , 'arkaan/chatroom'
+  autoload :Chatrooms     , 'arkaan/chatrooms'
   autoload :Concerns      , 'arkaan/concerns'
   autoload :Factories     , 'arkaan/factories'
   autoload :Files         , 'arkaan/files'

data/lib/arkaan/account.rb

@@ -63,6 +63,11 @@ module Arkaan
     # @!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] messages
+    #   @return [Array<Arkaan::Chatrooms::Messages>] all the messages ever sent by the user.
+    has_many :messages, class_name: 'Arkaan::Chatrooms::Message', inverse_of: :account
+
+    has_many :memberships, class_name: 'Arkaan::Chatrooms::Membership', inverse_of: :account
 
     # @!attribute [rw] notifications
     #  @return [Array<Arkaan::Notification>] the notifications linked to this user.

data/lib/arkaan/campaign.rb

@@ -28,9 +28,9 @@ module Arkaan
     #   @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.
-    embeds_many :messages, class_name: 'Arkaan::Campaigns::Message', inverse_of: :campaign
+    # @!attribute [rw] chatroom
+    #   @return [Arkaan::Chatrooms::Campaign] the chatroom linked to this campaign.
+    embeds_one :chatroom, class_name: 'Arkaan::Chatrooms::Campaign', inverse_of: :campaign
 
     # @!attribute [rw] ruleset
     #   @return [Arkaan::Ruleset] the set of rules this campaign is based upon.
@@ -90,5 +90,13 @@ module Arkaan
     def players_count
       players.count
     end
+
+    def messages
+      chatroom.messages
+    end
+
+    after_initialize do
+      self.chatroom = Arkaan::Chatrooms::Campaign.new(campaign: self)
+    end
   end
 end

data/lib/arkaan/campaigns.rb

@@ -3,7 +3,6 @@ module Arkaan
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Campaigns
     autoload :Invitation, 'arkaan/campaigns/invitation'
-    autoload :Message   , 'arkaan/campaigns/message'
     autoload :Tag       , 'arkaan/campaigns/tag'
   end
 end

data/lib/arkaan/chatrooms.rb

@@ -0,0 +1,11 @@
+module Arkaan
+  # The chatrooms modules regroup all classes concerning messages between players.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  module Chatrooms
+    autoload :Base        , 'arkaan/chatrooms/base'
+    autoload :Campaign    , 'arkaan/chatrooms/campaign'
+    autoload :Conversation, 'arkaan/chatrooms/conversation'
+    autoload :Message     , 'arkaan/chatrooms/message'
+    autoload :Membership  , 'arkaan/chatrooms/membership'
+  end
+end

data/lib/arkaan/chatrooms/base.rb

@@ -0,0 +1,14 @@
+module Arkaan
+  module Chatrooms
+    # The base chatroom class, made to be subclassed in campaign and personal chatrooms.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Base
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      # @!attribute [rw] messages
+      #   @return [Array<Arkaan::Chatrooms::Message>] the messages sent in this chatroom.
+      has_many :messages, class_name: 'Arkaan::Chatrooms::Message', inverse_of: :chatroom
+    end
+  end
+end

data/lib/arkaan/chatrooms/campaign.rb

@@ -0,0 +1,11 @@
+module Arkaan
+  module Chatrooms
+    # Represents the chatroom embedded in a campaign.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Campaign < Arkaan::Chatrooms::Base
+      # @!attribute [rw] campaign
+      #   @return [Arkaan::Campaign] the campaign the chatroom is linked to.
+      embedded_in :campaign, class_name: 'Arkaan::Campaign', inverse_of: :chatroom
+    end
+  end
+end

data/lib/arkaan/chatrooms/conversation.rb

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

data/lib/arkaan/chatrooms/membership.rb

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

data/lib/arkaan/{campaigns → chatrooms}/message.rb

@@ -1,5 +1,5 @@
 module Arkaan
-  module Campaigns
+  module Chatrooms
     # This model represents an in-game tchat message sent in the tchat of a campaign.
     # @author Vincent Courtois <courtois.vincent@outlook.com>
     class Message
@@ -13,16 +13,19 @@ module Arkaan
       # @!attribute [rw] data
       #   @return [Hash] the additional data passed to the message (arguments of the command, or content of the text)
       field :data, type: Hash, default: {}
+      # @!attribute {rw} raw
+      #   @return [String] the content as typed by the user, without any parsing or transformation.
+      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
 
       # @!attribute [rw] campaign
-      #   @return [Arkaan::Campaign] the campaign in which the message has been emitted.
-      embedded_in :campaign, class_name: 'Arkaan::Campaign', inverse_of: :messages
+      #   @return [Arkaan::Chatrooms::Campaign] the chatroom in which the message has been emitted.
+      belongs_to :chatroom, class_name: 'Arkaan::Chatrooms::Campaign', inverse_of: :messages
       # @!attribute [rw] player
       #   @return [Arkaan::Account] the account that has emitted the message in the campaign.
-      belongs_to :player, class_name: 'Arkaan::Campaigns::Invitation'
+      belongs_to :account, class_name: 'Arkaan::Account', inverse_of: :messages
     end
   end
 end

data/lib/arkaan/version.rb

@@ -1,3 +1,3 @@
 module Arkaan
-  VERSION = '2.4.1'
+  VERSION = '2.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2020-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -220,90 +220,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.1.11
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.0.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.0.5
-- !ruby/object:Gem::Dependency
-  name: sinatra-contrib
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.0.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.0.5
-- !ruby/object:Gem::Dependency
-  name: platform-api
-  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
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.15.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !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.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: actionview
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 5.2.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 5.2.3
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -331,8 +247,13 @@ files:
 - lib/arkaan/campaign.rb
 - lib/arkaan/campaigns.rb
 - lib/arkaan/campaigns/invitation.rb
-- lib/arkaan/campaigns/message.rb
 - lib/arkaan/campaigns/tag.rb
+- lib/arkaan/chatrooms.rb
+- lib/arkaan/chatrooms/base.rb
+- lib/arkaan/chatrooms/campaign.rb
+- lib/arkaan/chatrooms/conversation.rb
+- lib/arkaan/chatrooms/membership.rb
+- lib/arkaan/chatrooms/message.rb
 - lib/arkaan/concerns.rb
 - lib/arkaan/concerns/activable.rb
 - lib/arkaan/concerns/diagnosticable.rb
@@ -347,13 +268,11 @@ files:
 - lib/arkaan/factories.rb
 - 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
 - lib/arkaan/monitoring/instance.rb
 - lib/arkaan/monitoring/results.rb
 - lib/arkaan/monitoring/results/heartbeat.rb
@@ -393,7 +312,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: The model layer for my table-RPG application

data/lib/arkaan/factories/gateways.rb

@@ -1,19 +0,0 @@
-module Arkaan
-  module Factories
-    # This class provides methods to create decorated services.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Gateways
-
-      # Searches for a gateway via its key and returns it decorated.
-      # @param key [String] the key of the server you want to find.
-      # @return [Arkaan::Decorators::Gateway, NilClass] nil if the gateway is not found, or the decorated gateway.
-      def self.random(action)
-        gateway = Arkaan::Monitoring::Gateway.where(active: true, running: true).first
-        if gateway.nil?
-          raise Arkaan::Factories::Errors::GatewayNotFound.new(action: action)
-        end
-        return Arkaan::Decorators::Gateway.new(action, gateway)
-      end
-    end
-  end
-end

data/lib/arkaan/monitoring/gateway.rb

@@ -1,37 +0,0 @@
-module Arkaan
-  module Monitoring
-    # A gateway is a portal by which you access the different web services of the application suite.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Gateway
-      include Mongoid::Document
-      include Mongoid::Timestamps
-      include Arkaan::Concerns::Activable
-      include Arkaan::Concerns::Diagnosticable
-      include Arkaan::Concerns::Typable
-
-      # @!attribute [rw] url
-      #   @return [String] the URL of the gateway, where the requests will be issued.
-      field :url, type: String
-      # @!attribute [rw] running
-      #   @return [Boolean] the running status of the gateway, indicating if it can be used or not.
-      field :running, type: Boolean, default: false
-      # @!attribute [rw] gateways
-      #   @return [String] the uniq token for this gateway, identifying it in the micro services.
-      field :token, type: String
-
-      scope :running , ->{ where(running: true) }
-
-      validates :url,
-        presence: {message: 'required'},
-        format: {
-          with: /\A(https?:\/\/)((localhost:[0-9]+)|(([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*)|(\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b):([0-9]{2,6}))\/?\z/,
-          message: 'pattern',
-          if: :url?
-        }
-
-      validates :token,
-        presence: {message: 'required'},
-        uniqueness: {message: 'uniq'}
-    end
-  end
-end