arkaan 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4990a4abb8ed39b023c47fed7560e0cad8aea739b74ed3a849ede6cf903f655
-  data.tar.gz: c83e4c79e96321d68b2a95774d7203a649850c27883b4bd0aa2f758c9d7bc9ea
+  metadata.gz: 15f29a2d1dc424ac2db2aed441e007437b4aab5fe6030711f89e8afe3ca7d1ed
+  data.tar.gz: c8f989b214ae66572e0b06249a95362642341c4a34ffe63c2eacb4e33e264150
 SHA512:
-  metadata.gz: 511fac191930fd795fc4f3961a249ef44159b0f21680f3a009efdd64b3e80c60a2de1046e938b73ae2eb6889a61e8355889367b6cb868ca2eb4f97eedd730c17
-  data.tar.gz: 72b3aa7b65f4f2bc142c5cab8c4859ca569e57f978d261c50c20c7495724dadbb33f554a9eaf911c12b7774f9f7690bef956891d10250965383d901c748c1b35
+  metadata.gz: 01dd270f06012cce7c1aef0e4da22deb04698e36312c1a306b9c465431fdf76cb267f86b4f616bbb8895d3b850ec3a6a9afd21e5c829d103e81ef1cbf0305952
+  data.tar.gz: 3e5a3d6cd2fdaff73b2cc88d754040267de4db4fb100ed4977a5f8ab106ccae7ba2b2e5fdfb2663b0f2fd07d87150bbb4a6e5783a7087d8019e4941eb00025e0

data/lib/arkaan.rb

@@ -13,6 +13,7 @@ module Arkaan
   autoload :Chatroom      , 'arkaan/chatroom'
   autoload :Chatrooms     , 'arkaan/chatrooms'
   autoload :Concerns      , 'arkaan/concerns'
+  autoload :Event         , 'arkaan/event'
   autoload :Factories     , 'arkaan/factories'
   autoload :Files         , 'arkaan/files'
   autoload :Monitoring    , 'arkaan/monitoring'

data/lib/arkaan/campaign.rb

@@ -51,14 +51,15 @@ module Arkaan
     # @param account [Arkaan::Account] the account of the creator for this campaign.
     def creator=(account)
       if !invitations.where(account: account).exists?
-        Arkaan::Campaigns::Invitation.create(campaign: self, account: account, enum_status: :creator)
+        invitation = Arkaan::Campaigns::Invitation.create(campaign: self, account: account)
+        invitation.status = :creator
       end
     end
 
     # Getter for the creator account of this campaign.
     # @return [Arkaan::Account] the account of the player creating this campaign.
     def creator
-      return invitations.where(enum_status: :creator).first.account
+      invitations.to_a.find(&:status_creator?).account
     end
 
     # Adds an error message if the account creating this campaign already has a campaign with the very same name.
@@ -83,7 +84,9 @@ module Arkaan
 
     # @return [Array<Arkaan::Campaigns::Invitation>] the players in this campaign.
     def players
-      invitations.where(enum_status: :accepted)
+      invitations.to_a.select do |invitation|
+        [:creator, :accepted].include? invitation.enum_status
+      end
     end
 
     # @return [Integer] the number of players in this campaign.

data/lib/arkaan/campaigns/invitation.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Campaigns
-    # An invitation is the linked between a player and a campaign, accepted or not.
+    # An invitation is the linked between a player and a campaign.
+    # It keeps the history of the interaction between the player and the campaign.
+    #
     # @author Vincent Courtois <courtois.vincent@outlook.com>
     class Invitation
       include Mongoid::Document
       include Mongoid::Timestamps
       include Arkaan::Concerns::Enumerable
-
-      # @!attribute [rw] status
-      #   @return [Symbol] the current status of the invitation.
-      enum_field :status, [:accepted, :blocked, :expelled, :ignored, :left, :pending, :refused, :request, :creator], default: :pending
+      include Arkaan::Concerns::Historizable
 
       # @!attribute [rw] account
       #   @return [Arkaan::Account] the account the invitation has been issued to.
@@ -17,6 +18,12 @@ 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] status
+      #   @return [Symbol] the current status of the invitation.
+      historize enum_field :status,
+        [:pending, :request, :accepted, :refused, :expelled, :left, :master, :creator],
+        default: :pending
     end
   end
-end
+end

data/lib/arkaan/campaigns/tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Campaigns
     # A campaign tag is a string describing a characteristic of the campaign it's in.
@@ -13,9 +15,7 @@ module Arkaan
       #   @return [Integer] the number of campaigns this tag is in, avoiding a join.
       field :count, type: Integer, default: 1
 
-      validates :content,
-        presence: {message: 'required'},
-        uniqueness: {message: 'uniq'}
+      validates :content, presence: { message: 'required' }, uniqueness: { message: 'uniq' }
     end
   end
-end
+end

data/lib/arkaan/concerns.rb

@@ -5,6 +5,7 @@ module Arkaan
     autoload :Activable     , 'arkaan/concerns/activable'
     autoload :Diagnosticable, 'arkaan/concerns/diagnosticable'
     autoload :Enumerable    , 'arkaan/concerns/enumerable'
+    autoload :Historizable  , 'arkaan/concerns/historizable'
     autoload :MimeTypable   , 'arkaan/concerns/mime_typable'
     autoload :Premiumable   , 'arkaan/concerns/premiumable'
     autoload :Sluggable     , 'arkaan/concerns/sluggable'

data/lib/arkaan/concerns/enumerable.rb

@@ -14,7 +14,7 @@ module Arkaan
         # @param values [Array<Symbol>] the possible values of the enumerated field.
         # @param options [Hash<Symbol, Any>] the possible options for the field.
         def enum_field(field_name, values, options = {})
-          field :"enum_#{field_name}", type: Symbol, default: options[:default]
+          returned = field :"enum_#{field_name}", type: Symbol, default: options[:default]
 
           validates :"enum_#{field_name}", inclusion: {in: values.map(&:to_sym), message: 'inclusion'}
 
@@ -37,6 +37,10 @@ module Arkaan
               self["enum_#{field_name}"] == value
             end
           end
+
+          # This is to make enumerations historizable by
+          # returning the field object created by Mongoid.
+          returned
         end
       end
     end

data/lib/arkaan/concerns/historizable.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Arkaan
+  module Concerns
+    # This module is what I call "a beautiful piece of Ruby engineering"
+    # It takes any mongoid field that you may have declared, and historizes
+    # it in a dedicated relation if this relation does not already exists.
+    #
+    # What it does exactly :
+    # - Creates the :history relation if it does not already exists.
+    # - Creates a method to check for changes of a specific attribute.
+    # - Check for changes at initialization to insert the first value.
+    # - Check for changes at update/save to store the history.
+    #
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Historizable
+      extend ActiveSupport::Concern
+
+      # Adds an entry in the history table for the given field.
+      # It checks several things to make the history entry valid :
+      # - the new value is different from the old value
+      # - the old value is identical to the last recorded new value.
+      #
+      # @param field [String] the name of the field to historize
+      # @param from [Any] the old value before update
+      # @param to [Any] the new value after update.
+      def add_history(field:, from:, to:)
+        return if from == to
+        return if !history.empty? && history.order_by(:created_at.desc).first.to != from
+
+        event = Arkaan::Event.create(field: field, from: from, to: to, document: self)
+        event.save
+      end
+
+      # Submodule holding all the static methods add to the current subclass.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      module ClassMethods
+        
+        # Takes the Mongoid declared field and creates the callbacks
+        # to intercept any value change and add it to the history.
+        # @field field [Mongoid::Fields::Standard] the Mongoid field to historize.
+        def historize(field)
+
+          unless relations.key?('history')
+            embeds_many :history, class_name: 'Arkaan::Event'
+          end
+
+          after_initialize do |doc|
+            add_history(field: field.name, from: nil, to: doc[field.name])
+          end
+
+          after_save do |doc|
+            if doc.changed_attributes.key?(field.name)
+              from = doc.changed_attributes[field.name]
+              add_history(field: field.name, from: from, to: doc[field.name])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/arkaan/event.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Arkaan
+  # An event is symbolizing a timestamped change in a model.
+  # It is recommended NOT to use this class directly but to use
+  # the Arkaan::Concerns::Historizable concern in a model.
+  #
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  class Event
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    # @!attribute [rw] field
+    #   @return [String] the name of the field being historized
+    field :field, type: String
+    # @!attribute [rw] from
+    #   @return [Any] the value of the field before update
+    field :from
+    # @!attribute [rw] to
+    #   @return [Any] the value of the field after update
+    field :to
+
+    # @!attribute [rw] document
+    #   @return [Any] the model in which the history is embedded
+    embedded_in :document, polymorphic: true, inverse_of: :history
+
+    validates :field, presence: { message: 'required' }
+  end
+end

data/lib/arkaan/oauth/access_token.rb

@@ -1,6 +1,7 @@
 module Arkaan
   module OAuth
-    # An access token is the value assigned to the application to access the private data of an account.
+    # An access token is the value assigned to the application
+    # to access the data the user is allowed to access.
     # @author Vincent Courtois <courtois.vincent@outlook.com>
     class AccessToken
       include Mongoid::Document
@@ -15,11 +16,17 @@ module Arkaan
 
       # @!attribute [rw] authorization
       #   @return [Arkaan::OAuth::Authorization] the authorization code that issued this token to the application for this user.
-      belongs_to :authorization, class_name: 'Arkaan::OAuth::Authorization', inverse_of: :access_token
+      belongs_to :authorization, class_name: 'Arkaan::OAuth::Authorization', inverse_of: :tokens
 
       validates :value, 
         presence: {message: 'required'},
         uniqueness: {message: 'uniq'}
+
+      # Checks if the current date is inferior to the creation date + expiration period
+      # @return [Boolean] TRUE if the token is expired, FALSE otherwise.
+      def expired?
+        created_at.to_time.to_i + expiration < Time.now.to_i
+      end
     end
   end
 end

data/lib/arkaan/oauth/authorization.rb

@@ -1,6 +1,9 @@
 module Arkaan
   module OAuth
     # An OAuth authorization is granted by a user to an application to access its personal data.
+    # The application then transforms it into an access token to be able to send it with
+    # further requests, so that we know the user has authorized the application to access its data.
+    #
     # @author Vincent Courtois <courtois.vincent@outlook.com>
     class Authorization
       include Mongoid::Document
@@ -18,7 +21,7 @@ module Arkaan
       belongs_to :application, class_name: 'Arkaan::OAuth::Application', inverse_of: :authorizations
       # @!attribute [rw] token
       #   @return [Arkaan::OAuth::AccessToken] the access token used further in the application process to access private data of the account.
-      has_one :token, class_name: 'Arkaan::OAuth::AccessToken', inverse_of: :authorization
+      has_many :tokens, class_name: 'Arkaan::OAuth::AccessToken', inverse_of: :authorization
 
       validates :code,
         presence: {message: 'required'},

data/lib/arkaan/version.rb

@@ -1,3 +1,3 @@
 module Arkaan
-  VERSION = '2.6.0'
+  VERSION = '2.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-24 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -164,6 +164,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.85.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.85.1
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -258,6 +272,7 @@ files:
 - lib/arkaan/concerns/activable.rb
 - lib/arkaan/concerns/diagnosticable.rb
 - lib/arkaan/concerns/enumerable.rb
+- lib/arkaan/concerns/historizable.rb
 - lib/arkaan/concerns/mime_typable.rb
 - lib/arkaan/concerns/premiumable.rb
 - lib/arkaan/concerns/sluggable.rb
@@ -265,6 +280,7 @@ files:
 - lib/arkaan/decorators/errors.rb
 - lib/arkaan/decorators/errors/env_variable_missing.rb
 - lib/arkaan/decorators/gateway.rb
+- lib/arkaan/event.rb
 - lib/arkaan/factories.rb
 - lib/arkaan/factories/errors.rb
 - lib/arkaan/factories/errors/gateway_not_found.rb