arkaan 3.0.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99aa03dc8a6f14cf981a81b89ab54adf9450c7bf2646a8231883ec71673d5695
-  data.tar.gz: 1e852dcc77ae4418286c94b7390888b3f8e71c57770852548cdf585ec300cea8
+  metadata.gz: 65f8289754a8004de723395b4b56b51c3a03298e12e2862bb93229a0b5a2628c
+  data.tar.gz: 784a148f4f3ceb643e5b2e644e0c79afd5207aaa8ed5c82c9dadd6b264a0ee6f
 SHA512:
-  metadata.gz: 7fb7d81811559f1daff3971c65b80d323ad9c29705e96b5cc3d6ba2729234498b094955e76478148c3876b2aeb62f6dad5806d34f6fae6761d0fecb86d495917
-  data.tar.gz: 4d2398bdc636a6b2307d4d4c101cf7f75e0e74b958f13e1d37d7e22addbbbfaec96022565737212c9f7b4beacd8f94e4f956f73a43203ca057612c8f50b33683
+  metadata.gz: 4553b140636382535cfaa9157d711c4e96d42e79c6f52dc4665eead60c9d73f9b9eaea1ab6c1f8f9849d8ae1f57d7ec880baacd67e42981ed663dca68c7a91bf
+  data.tar.gz: af868a3f99aea837395fb859bb0c5fe056d5b4f2c109c524a5eca7f077f0c03965d22d006f99e5121ec0bb40a1f09c30ffd6a9d5c63ef7c6ecf81acae0967801

data/lib/arkaan/account.rb

@@ -99,5 +99,7 @@ module Arkaan
 
     validates :password_confirmation,
               presence: { message: 'required', if: :password_digest_changed? }
+
+    scope :search, ->(pattern) { any_of({ username: /#{pattern}/i }, { email: /#{pattern}/i }) }
   end
 end

data/lib/arkaan/authentication.rb

@@ -4,6 +4,7 @@ module Arkaan
   # This module holds the logic for user authentication to our frontend.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Authentication
+    autoload :Device, 'arkaan/authentication/device'
     autoload :Session, 'arkaan/authentication/session'
   end
 end

data/lib/arkaan/authentication/device.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Arkaan
+  module Authentication
+    # A device is a computer or mobile phone from which a user logs in.
+    # @pauthor Vincent Courtois <courtois.vincent@outlook.com>
+    class Device
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      # @!attribute [rw] label
+      #   @return [String] the label attached to the device, describing it in details.
+      field :label, type: String
+      # @!attribute [rw] user_agent
+      #   @return [String] the string representation of the browser and OS of the user
+      field :user_agent, type: String
+      # @!attribute [rw] ip
+      #   @return [String] the IP address of the user
+      field :ip, type: String
+      # @!attribute [rw] safe
+      #   @return [Boolean] TRUE if the device is considered safe, FALSE otherwise
+      field :safe, type: Boolean, default: false
+
+      # @!attribute [rw] sessions
+      #   @return [Array<Arkaan::Authentication::Session] the sessions this browser is linked to.
+      has_many :sessions, class_name: 'Arkaan::Authentication::Session', inverse_of: :device
+    end
+  end
+end

data/lib/arkaan/authentication/session.rb

@@ -12,20 +12,36 @@ module Arkaan
 
       # @!attribute [rw] token
       #   @return [String] the unique token for this session, used to identify it and be sure the user is connected.
-      field :token, type: String
+      field :session_id, type: String
       # @!attribute [rw] websocket_id
       #   @return [String] the ID of the websocket the user is connected to.
       #     It's not an association because instances are embedded.
       field :websocket_id, type: String, default: ''
+      # @!attribute [rw] duration
+      #   @return [Integer] the duration of the session in seconds before it expires.
+      field :duration, type: Integer, default: 86_400
 
       # @!attribute [rw] account
       #   @return [Arkaan::Account] the account connected to the application.
       belongs_to :account, class_name: 'Arkaan::Account', inverse_of: :sessions
+      # @!attribute [rw] device
+      #   @return [Arkaan::Authentication::Device] the device (computer/mobile) linked to this session
+      belongs_to :device, class_name: 'Arkaan::Authentication::Device', inverse_of: :sessions, optional: true
 
-      validates :token,
+      validates :session_id,
                 presence: { message: 'required' },
-                uniqueness: { message: 'uniq', if: :token? },
-                length: { minimum: 10, message: 'minlength', if: :token? }
+                uniqueness: { message: 'uniq', if: :session_id? },
+                length: { minimum: 10, message: 'minlength', if: :session_id? }
+
+      validates :duration,
+                numericality: { greater_than_or_equal_to: 0, message: 'minimum' },
+                presence: { message: 'required' }
+
+      # Checks if the session is expired (it has a duration, and the duration has passed)
+      # @return [Boolean] TRUE if the session is expired, FALSE otherwise.
+      def expired?
+        duration != 0 && created_at + duration.to_f < DateTime.now
+      end
     end
   end
 end

data/lib/arkaan/oauth/application.rb

@@ -14,7 +14,7 @@ module Arkaan
       field :name, type: String
       # @!attribute [rw] key
       #   @return [String] the unique key for the application, identifying it when requesting a token for the API.
-      field :application_key, type: String, default: -> { SecureRandom.hex }
+      field :app_key, 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.
@@ -36,7 +36,7 @@ module Arkaan
                 length: { minimum: 6, message: 'minlength' },
                 uniqueness: { message: 'uniq' }
 
-      validates :application_key,
+      validates :app_key,
                 presence: { message: 'required' },
                 uniqueness: { message: 'uniq' }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_cleaner
@@ -313,6 +313,7 @@ files:
 - lib/arkaan.rb
 - lib/arkaan/account.rb
 - lib/arkaan/authentication.rb
+- lib/arkaan/authentication/device.rb
 - lib/arkaan/authentication/session.rb
 - lib/arkaan/campaign.rb
 - lib/arkaan/campaigns.rb