virtuatable-core 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2c522c5694270544ff7aa08e434bc1af1978dbd4b8c5488eac48158e4ae18c7
-  data.tar.gz: 8490c9d478c1cf2d2b505312bd8824ce67bc759fce490ea980517ac8ec4cf1df
+  metadata.gz: 13712af3f0db1598191b3a51bb599c93f512da5e074ef504288dc498f45602a4
+  data.tar.gz: c886c91f0698d97ebcfe6c0538ed35023e2472b03db28d625745794ac4a18c05
 SHA512:
-  metadata.gz: 2dd843cd275f9f9d5b0ee563a500069fa0af65c0ea716ad470147b87acfa62b2d369e122b36080a976567dee381bf2a4625b27b4b17d9faa485315463d945fa8
-  data.tar.gz: c0707af825058224eab8297cc92e370ed78be96ebe55876e99010c3a0603f3ea68f848e4f6171839a06a6241c36dcae7a4387cadb921f992f1a3dfc6116d38b6
+  metadata.gz: eec95c84abcc9093600b0d3d73279924e6d77095e246fad33a513868aaac08798dd2c4dc850406d47a93810deed2bc6750d0fd0f8349cbffaf72815223ab3280
+  data.tar.gz: c798211dda3d35be799be2ef21589a67e86dc1d646f6168e6f39d8ed4bc458b1a6418cecf04f15311e681cd41efd48d7fb5497f0e85baf11287196f2ba6a77c1

data/lib/core/helpers/applications.rb

@@ -10,10 +10,10 @@ module Core
       def application(premium: false)
         return @application unless @application.nil?
 
-        check_presence 'app_key'
-        @application = application_model.find_by(key: params['app_key'])
-        api_not_found 'app_key.unknown' if @application.nil?
-        api_forbidden 'app_key.forbidden' if premium && !@application.premium
+        check_presence 'client_id'
+        @application = application_model.find_by(client_id: params['client_id'])
+        api_not_found 'client_id.unknown' if @application.nil?
+        api_forbidden 'client_id.forbidden' if premium && !@application.premium
 
         @application
       end

data/lib/core/models/concerns/sluggable.rb

@@ -6,22 +6,16 @@ module Core
       module Sluggable
         extend ActiveSupport::Concern
 
-        # Module holding the class methods for the classes including this concern.
-        # @author Vincent Courtois <courtois.vincent@outlook.com>
-        module ClassMethods
-          # Add the field and its validations in the model including it.
-          # @param entity_type [String,Symbol] the name of the model including it, to be included in the error messages.
-          def make_sluggable(entity_type)
-            # @!attribute [rw] slug
-            #   @return [String] the slug of the current entity ; it must be snake-cased, longer than four characters, unique for the entity and given.
-            field :slug, type: String
+        included do
+          # @!attribute [rw] slug
+          #   @return [String] the slug of the current entity ; it must be snake-cased, longer than four characters, unique for the entity and given.
+          field :slug, type: String
 
-            validates :slug,
-              length: {minimum: 4, message: 'minlength', if: :slug?},
-              format: {with: /\A[a-z]+(_[a-z]+)*\z/, message: 'pattern', if: :slug?},
-              uniqueness: {message: 'uniq', if: :slug?},
-              presence: {message: 'required'}
-          end
+          validates :slug,
+            length: {minimum: 4, message: 'minlength', if: :slug?},
+            format: {with: /\A[a-z]+(_[a-z]+)*\z/, message: 'pattern', if: :slug?},
+            uniqueness: {message: 'uniq', if: :slug?},
+            presence: {message: 'required'}
         end
       end
     end

data/lib/core/models/oauth/access_token.rb

@@ -21,6 +21,12 @@ module Core
         #   @return [Core::Models::OAuth::Authorization] the authorization code that issued this token to the application for this user.
         belongs_to :authorization, class_name: 'Core::Models::OAuth::Authorization', inverse_of: :tokens
 
+
+        # A refresh token is attached to each and every refresh token so that it can be used to deliver a new access token.
+        # @!attribute [rx] refresh_token
+        #   @return [Core::Models::OAuth::RefreshToken] the refresh token linked to this token
+        has_one :refresh_token, class_name: 'Core::Models::OAuth::RefreshToken', inverse_of: :token
+
         validates :value, 
           presence: {message: 'required'},
           uniqueness: {message: 'uniq'}
@@ -28,8 +34,25 @@ module Core
         # 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?
+          # Handles the case where the token is given to a premium app (our apps have infinite tokens).
+          return false if premium?
+          return true if refresh_token.used?
+
           created_at.to_time.to_i + expiration < Time.now.to_i
         end
+
+        # Returns the scopes this access token can use to access the application
+        # @return [Array<Core::Models::OAuth::Scope>] the array of scopes from the linked authorization
+        def scopes
+          # Premium applications (our applications) have all the rights on the API.
+          return Core::Models::OAuth::Scope.all.to_a if premium?
+
+          authorization.scopes
+        end
+
+        def premium?
+          authorization.application.premium
+        end
       end
     end
   end

data/lib/core/models/oauth/application.rb

@@ -12,9 +12,12 @@ module Core
         # @!attribute [rw] name
         #   @return [String] the unique name of the application, mainly used to identify and display it.
         field :name, type: String
-        # @!attribute [rw] key
+        # @!attribute [rw] client_id
         #   @return [String] the unique key for the application, identifying it when requesting a token for the API.
-        field :key, type: String, default: ->{ SecureRandom.hex }
+        field :client_id, type: String, default: ->{ SecureRandom.hex }
+        # @!attribute [rw] client_secret
+        #   @return [String] the "password" of the application, used to identify it when requesting tokens.
+        field :client_secret, type: String, default: ->{ SecureRandom.hex }
         # @!attribute [rw] premium
         #   @return [Boolean] a value indicating whether the application should automatically receive a token when an account is created, or not.
         field :premium, type: Mongoid::Boolean, default: false
@@ -28,16 +31,22 @@ module Core
         # @!attribute [rw] authorizations
         #   @return [Array<Core::Models::OAuth::Authorization>] the authorizations linked to the accounts this application can get the data from.
         has_many :authorizations, class_name: 'Core::Models::OAuth::Authorization', inverse_of: :application
+        # @!attribute [rw]
+        #   @return [Array<Core::Models::OAuth::Scope>] the scopes this application will transmit to its token
+        has_and_belongs_to_many :scopes, class_name: 'Core::Models::OAuth::Scope', inverse_of: :applications
 
         validates :name,
           presence: {message: 'required'},
           length: {minimum: 6, message: 'minlength'},
           uniqueness: {message: 'uniq'}
 
-        validates :key,
+        validates :client_id,
           presence: {message: 'required'},
           uniqueness: {message: 'uniq'}
 
+        validates :client_secret,
+          presence: {message: 'required'}
+
         validate :redirect_uris_values
 
         # Checks the URIs to get sure they are correct, a URI is correct if :

data/lib/core/models/oauth/authorization.rb

@@ -15,6 +15,9 @@ module Core
         # @!attribute [rw] code
         #   @return [String] the value corresponding to the authentication code in the RFC of OAuth2.0, kep for historic purpose.
         field :code, type: String, default: ->{ SecureRandom.hex }
+        # @!attribute [rw] expiration
+        #   @return [Integer] the time, in seconds, after which the authorization is declared expired.
+        field :expiration, type: Integer, default: 86400
 
         # @!attribute [rw] account
         #   @return [Arkaaan::Account] the account granting the authorization to access its data to the application.
@@ -25,10 +28,19 @@ module Core
         # @!attribute [rw] token
         #   @return [Core::Models::OAuth::AccessToken] the access token used further in the application process to access private data of the account.
         has_many :tokens, class_name: 'Core::Models::OAuth::AccessToken', inverse_of: :authorization
+        # @!attribute [rw]
+        #   @return [Array<Core::Models::OAuth::Scope>] the scopes this access token has.
+        has_and_belongs_to_many :scopes, class_name: 'Core::Models::OAuth::Scope', inverse_of: :authorizations
 
         validates :code,
           presence: {message: 'required'},
           uniqueness: {message: 'uniq'}
+
+        # Checks if the current date is inferior to the creation date + expiration period
+        # @return [Boolean] TRUE if the authorization is expired, FALSE otherwise.
+        def expired?
+          created_at.to_time.to_i + expiration < Time.now.to_i
+        end
       end
     end
   end

data/lib/core/models/oauth/refresh_token.rb

@@ -12,10 +12,17 @@ module Core
         # @!attribute [rw] value
         #   @return [String] the value of the token, returned to the application when built.
         field :value, type: String, default: ->{ SecureRandom.hex }
+        # @!attribute [rw] used_at
+        #   @return [DateTime] the date and time at which this refresh token has been useds to create a new access token.
+        field :used_at, type: DateTime, default: nil
 
         # @!attribute [rw] authorization
         #   @return [Core::Models::OAuth::Authorization] the authorization code that issued this token to the application for this user.
-        belongs_to :authorization, class_name: 'Core::Models::OAuth::Authorization', inverse_of: :refresh_token
+        belongs_to :token, class_name: 'Core::Models::OAuth::AccessToken', inverse_of: :refresh_token
+
+        def used?
+          !used_at.nil? && used_at < DateTime.now
+        end
       end
     end
   end

data/lib/core/models/oauth/scope.rb

@@ -0,0 +1,32 @@
+module Core
+  module Models
+    module OAuth
+      # A scope gives access to some parts of the API, for example to the management of campaigns,
+      # applications or for account profile management.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Scope
+        include Mongoid::Document
+        include Mongoid::Timestamps
+
+        store_in collection: 'scopes'
+
+        # @!attribute [rw] name
+        #   @return [String] the name of the scope, used to get its translation on the frontend.
+        field :name, type: String, default: ''
+
+        # @!attribute [rw] applications
+        #   @return [Array<Core::Models::OAuth::Application>] the applications that want to have access to this
+        #     scope from the users of the platform. These rights will be carried on to the tokens and frozen.
+        has_and_belongs_to_many :applications, class_name: 'Core::Models::OAuth::Application', inverse_of: :scopes
+        # @!attribute [rw] tokeauthorizationsns
+        #   @return [Array<Core::Models::OAuth::Authorization] the tokens having these scopes.
+        has_and_belongs_to_many :authorizations, class_name: 'Core::Models::OAuth::Authorization', inverse_of: :scopes
+
+        validates :name,
+          presence: {message: 'required'},
+          length: {minimum: 6, if: :name?, message: 'minlength'},
+          uniqueness: {id: :name?, message: 'uniq'}
+      end
+    end
+  end
+end

data/lib/core/models/oauth.rb

@@ -7,6 +7,7 @@ module Core
       autoload :Authorization, 'core/models/oauth/authorization'
       autoload :AccessToken  , 'core/models/oauth/access_token'
       autoload :RefreshToken , 'core/models/oauth/refresh_token'
+      autoload :Scope        , 'core/models/oauth/scope'
     end
   end
 end

data/lib/core/models/permissions/category.rb

@@ -11,8 +11,6 @@ module Core
         store_in collection: 'categories'
 
         has_many :rights, class_name: 'Core::Models::Permissions::Right', inverse_of: :category
-
-        make_sluggable 'category'
       end
     end
   end

data/lib/core/models/permissions/group.rb

@@ -26,8 +26,6 @@ module Core
         # @!attribute [rw] routes
         #   @return [Array<Core::Models::Monitoring::Route>] the routes this group can access in the API.
         has_and_belongs_to_many :routes, class_name: 'Core::Models::Permissions::Route', inverse_of: :groups
-
-        make_sluggable 'group'
       end
     end
   end

data/lib/core/models/permissions/right.rb

@@ -15,8 +15,6 @@ module Core
         has_and_belongs_to_many :groups, class_name: 'Core::Models::Permissions::Group', inverse_of: :rights
 
         belongs_to :category, class_name: 'Core::Models::Permissions::Category', inverse_of: :rights
-
-        make_sluggable 'right'
       end
     end
   end

data/lib/core/models.rb

@@ -1,24 +1,22 @@
-require 'mongoid'
-require 'active_model'
-require 'active_support'
-require 'dotenv/load'
+# frozen_string_literal: true
 
-# Main module of the application, holding all the subsequent classes.
-# @author Vincent Courtois <courtois.vincent@outlook.com>
 module Core
+  # Module holding the representations of the business objects we're manipulating
+  # in the database. Models are declared as Mongoid classes to connect to MongoDB
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Models
-    autoload :Account       , 'core/models/account'
+    autoload :Account, 'core/models/account'
     autoload :Authentication, 'core/models/authentication'
-    autoload :Campaign      , 'core/models/campaign'
-    autoload :Campaigns     , 'core/models/campaigns'
-    autoload :Chatroom      , 'core/models/chatroom'
-    autoload :Chatrooms     , 'core/models/chatrooms'
-    autoload :Concerns      , 'core/models/concerns'
-    autoload :Event         , 'core/models/event'
-    autoload :Files         , 'core/models/files'
-    autoload :Notification  , 'core/models/notification'
-    autoload :OAuth         , 'core/models/oauth'
-    autoload :Permissions   , 'core/models/permissions'
-    autoload :Ruleset       , 'core/models/ruleset'
+    autoload :Campaign, 'core/models/campaign'
+    autoload :Campaigns, 'core/models/campaigns'
+    autoload :Chatroom, 'core/models/chatroom'
+    autoload :Chatrooms, 'core/models/chatrooms'
+    autoload :Concerns, 'core/models/concerns'
+    autoload :Event, 'core/models/event'
+    autoload :Files, 'core/models/files'
+    autoload :Notification, 'core/models/notification'
+    autoload :OAuth, 'core/models/oauth'
+    autoload :Permissions, 'core/models/permissions'
+    autoload :Ruleset, 'core/models/ruleset'
   end
-end
+end

data/lib/core/services.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Core
+  # Services are orchestrating models to provide more high-level operations.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Services
     autoload :Accounts, 'core/services/accounts'
     autoload :Base, 'core/services/base'
     autoload :Registry, 'core/services/registry'
     autoload :Sessions, 'core/services/sessions'
   end
-end
+end

data/lib/core/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Core
-  VERSION = '1.2.2'
-end
+  VERSION = '1.3.0'
+end

data/lib/core.rb

@@ -1,7 +1,6 @@
-require 'mongoid'
-require 'active_model'
-require 'active_support'
-require 'dotenv/load'
+# frozen_string_literal: true
+
+%w[active_model mongoid active_support].each { |g| require g }
 
 # Main module of the application, holding all the subsequent classes.
 # @author Vincent Courtois <courtois.vincent@outlook.com>
@@ -10,4 +9,4 @@ module Core
   autoload :Helpers, 'core/helpers'
   autoload :Models, 'core/models'
   autoload :Services, 'core/services'
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: virtuatable-core
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2022-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_cleaner
@@ -332,6 +332,7 @@ files:
 - lib/core/models/oauth/application.rb
 - lib/core/models/oauth/authorization.rb
 - lib/core/models/oauth/refresh_token.rb
+- lib/core/models/oauth/scope.rb
 - lib/core/models/permissions.rb
 - lib/core/models/permissions/category.rb
 - lib/core/models/permissions/group.rb