itg 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afb1a619f9859827f857cc4558a198ae8d753e3f86df4bb0c308df46abecd107
-  data.tar.gz: 5969d0683fc63c024cc789f5e3a8fcf39cdb1238ad8b416cb1f1c5222f2839b0
+  metadata.gz: 3d053cf4b8d8c39243e96253436bb4287d51c0f05c350e4974274547a3054ccd
+  data.tar.gz: ca430ed912df96c4d35439f78b40b4a041649430f3fdeecb13f29440a9e4a6f1
 SHA512:
-  metadata.gz: 636803d0bbf4672919fc52e95c0cac4c6d4390af1463e304bfe96889b1d6d2ac39516d71ed3492833d83e25c4aabba0412c5a21cb04f77cfdda9f480064e2e40
-  data.tar.gz: 1ba56414129bef246771f1b7d401a6a26563af8d6de49e456ba27220f936781ff2b718c0f86412d959295bc82bdc6763da873c6b7fb269aa4ea9aff386e5d9e9
+  metadata.gz: be3e9fa71c749a1413158cdf1152d75bd2a6891bce296bb337ae86a005132df6d5b0113ced3750130e764006f3236e5f48f9cec41d0b6a73d0ec6958e05d9535
+  data.tar.gz: 9e59e76d5deea88cd5d5ce33a3538288411974623852ff8c0f45249a4e12bd9d15ff1df6114be98c6ffbf4891ff03c121d1169c81da3ccf5b1dc0ac66ee6845d

data/lib/itg/models/itg_api_key_model_base.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# ItgApiKeyBase module
+module Itg
+  module ApiKeyModelBase
+    extend ActiveSupport::Concern
+
+    included do
+      include Itg::MongoBase
+      include Itg::Sec
+
+      field :bearer_id, type: Integer
+      field :bearer_type, type: String
+      field :token_digest, type: String
+
+      index({ bearer_id: 1,  bearer_type: 1}, { name: 'bearer_id_type_index' })
+      index({ token_digest: 1 }, { unique: true, name: 'token_digest_index' })
+
+      attr_accessor :token
+
+      belongs_to :bearer, polymorphic: true
+
+      before_create :generate_token_hmac
+
+      def serializable_hash(options = nil)
+        h = super options.merge(except: "token_digest")
+        h.merge! "token" => token if token.present?
+        h
+      end
+
+      private
+
+      def generate_token_hmac
+        raise Mongoid::Errors::InvalidValue, 'token is required' unless token.present?
+
+        digest = OpenSSL::HMAC.hexdigest 'SHA256', self.class.hmac_secret_key, token
+
+        self.token_digest = digest
+      end
+    end
+
+    class_methods do
+      attr_reader :hmac_secret_key
+
+      def authenticate_by_token!(token)
+        digest = OpenSSL::HMAC.hexdigest "SHA256", hmac_secret_key, token
+
+        find_by! token_digest: digest
+      end
+
+      def authenticate_by_token(token)
+        authenticate_by_token! token
+      rescue Mongoid::Errors::DocumentNotFound
+        nil
+      end
+
+      private
+
+      def itg_api_key_base(hmac_secret_key: "not-yet-specified")
+        @hmac_secret_key = hmac_secret_key
+      end
+    end
+  end
+end

data/lib/itg/models/itg_context_model_base.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Itg
+  module ContextModelBase
+    extend ActiveSupport::Concern
+
+    included do
+      include Itg::MongoBase
+      include Itg::Sec
+
+      field :code, type: String
+      field :name, type: String
+      field :descr, type: String
+      field :db, type: String
+
+      validates_presence_of(:code, :name)
+      validates_uniqueness_of :code
+    end
+  end
+end

data/lib/itg/models/itg_entity_model_base.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Itg
+  module EntityModelBase
+    extend ActiveSupport::Concern
+
+    included do
+      include Itg::MongoBase
+
+      store_in collection: 'entities'
+
+      # field :context, type: Array, default: [AppConfig::DEFAULT_CONTEXT_NAME]  # MERGE_WITH_BACKEND
+      field :context, type: Array, default: [:default]
+      field :permissions, type: Object, default: {}
+      field :kind, type: String
+      field :attrs, type: Object
+      field :roles, type: Array, default: []
+      field :tags, type: Array, default: []
+
+      validates_presence_of :kind
+      validates_presence_of :attrs
+
+      belongs_to :owner, class_name: 'User'
+
+      def to_s
+        attrs['name'] || attrs['descr'] || attrs['code']
+      end
+
+      def itg_print(header: nil, prefix: '', allow_nested: true)
+        puts header if header
+        puts "#{prefix}#{[attrs['name'] || attrs['descr'] || attrs['code']]}"
+      end
+    end
+  end
+end

data/lib/itg/models/itg_user_model_base.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Itg
+  module UserModelBase
+    extend ActiveSupport::Concern
+
+    included do
+      include Itg::MongoBase
+      include Itg::Sec
+
+      devise :database_authenticatable, :registerable, :recoverable, :rememberable,
+             :validatable, :confirmable, :lockable, :timeoutable, :trackable
+
+      ## Database authenticatable
+      field :encrypted_password, type: String, default: ''
+
+      ## Recoverable
+      field :reset_password_token,   type: String
+      field :reset_password_sent_at, type: Time
+
+      ## Rememberable
+      field :remember_created_at, type: Time
+
+      ## Trackable
+      field :sign_in_count,      type: Integer, default: 0
+      field :current_sign_in_at, type: Time
+      field :last_sign_in_at,    type: Time
+      field :current_sign_in_ip, type: String
+      field :last_sign_in_ip,    type: String
+
+      ## Confirmable
+      field :confirmation_token,   type: String
+      field :confirmed_at,         type: Time
+      field :confirmation_sent_at, type: Time
+      field :unconfirmed_email,    type: String # Only if using reconfirmable
+
+      ## Lockable
+      field :failed_attempts, type: Integer, default: 0 # Only if lock strategy is :failed_attempts
+      field :unlock_token,    type: String # Only if unlock strategy is :email or :both
+      field :locked_at,       type: Time
+
+
+      # include ActiveModel::SecurePassword
+
+      field :email, type: String
+      # field :password_digest, type: String
+      field :db, type: String
+      field :kind, type: String, default: 'user'
+      field :contexts, type: Object, default: {}
+
+      index({ email: 1 }, { unique: true, name: 'email_index' })
+
+      has_many :api_keys, as: :bearer
+      has_many :requests, dependent: :destroy
+
+      # has_secure_password
+
+      validates_presence_of(:email)
+      validates_uniqueness_of(:email)
+
+      def write_attribute(attr_name, value)
+        # puts "write_attribute - attr_name: #{attr_name}, value: #{value}"
+        if attr_name.to_s.downcase == 'kind'
+          value = value.to_s.strip.downcase
+          value = 'user' if ['', nil].include? value
+        end
+        super
+      end
+
+      def add_context(context, role: :user)
+        if context.persisted?
+          unless contexts.keys.include?(context.code.to_sym)
+            contexts[context.code.to_sym] = {role: role.to_sym}
+            contexts[context.code.to_sym][:name] = context[:name] if context[:name]
+            contexts[context.code.to_sym][:descr] = context[:descr] if context[:descr]
+            contexts[context.code.to_sym][:db] = context[:db] if context[:db]
+          end
+        end
+      end
+
+      def to_s
+        attributes.symbolize_keys.slice(:_id, :email, :db, :role).to_s
+      end
+
+      def itg_print(header: nil, prefix: '', allow_nested: true)
+        puts header if header
+        puts "#{prefix}#{to_s}"
+      end
+    end
+
+    class_methods do
+
+    end
+  end
+end

data/lib/itg/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Itg
-  VERSION = "0.1.6"
-  DATE = "17/2/2024"
+  VERSION = "0.1.8"
+  DATE = "18/2/2024"
 
   def self.version_info
     "Itg gem v.#{VERSION} #{DATE}"

data/lib/itg.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require_relative "itg/version"
-require_relative "itg/itg_model_base"
+require_relative "itg/models/itg_model_base"
+require_relative "itg/models/itg_api_key_model_base"
+require_relative "itg/models/itg_user_model_base"
+require_relative "itg/models/itg_context_model_base"
+require_relative "itg/models/itg_entity_model_base"
 require_relative "itg/itg_mongo_base"
 require_relative "itg/itg_printable"
-# require_relative "itg/itg_sec"
-require_relative "itg/itg_api_key_base"
 require_relative "itg/itg_api_key_authenticatable"
 require_relative "itg/itg_response"
 require_relative "itg/itg_sec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itg
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - aAon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-17 00:00:00.000000000 Z
+date: 2024-02-18 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -30,12 +30,15 @@ files:
 - itg.gemspec
 - lib/itg.rb
 - lib/itg/itg_api_key_authenticatable.rb
-- lib/itg/itg_api_key_base.rb
-- lib/itg/itg_model_base.rb
 - lib/itg/itg_mongo_base.rb
 - lib/itg/itg_printable.rb
 - lib/itg/itg_response.rb
 - lib/itg/itg_sec.rb
+- lib/itg/models/itg_api_key_model_base.rb
+- lib/itg/models/itg_context_model_base.rb
+- lib/itg/models/itg_entity_model_base.rb
+- lib/itg/models/itg_model_base.rb
+- lib/itg/models/itg_user_model_base.rb
 - lib/itg/version.rb
 - sig/itg.rbs
 homepage: https://aaon.aggate.gr

data/lib/itg/itg_api_key_base.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-# ItgApiKeyBase module
-module Itg
-  module ApiKeyBase
-    extend ActiveSupport::Concern
-
-    # include Itg::MongoBase
-    # include Itg::Sec
-    # include Mongoid::Fields
-    #
-    # field :bearer_id, type: Integer
-    # field :bearer_type, type: String
-    # field :token_digest, type: String
-    #
-    # index({ bearer_id: 1,  bearer_type: 1}, { name: "bearer_id_type_index" })
-    # index({ token_digest: 1 }, { unique: true, name: "token_digest_index" })
-
-    included do
-      include Itg::MongoBase
-      include Itg::Sec
-
-      # field :bearer_id, type: Integer
-      # field :bearer_type, type: String
-      # field :token_digest, type: String
-      #
-      # index({ bearer_id: 1,  bearer_type: 1}, { name: "bearer_id_type_index" })
-      # index({ token_digest: 1 }, { unique: true, name: "token_digest_index" })
-
-      # Virtual attribute for raw token value, allowing us to respond with the
-      # API key's non-hashed token value. but only directly after creation.
-      # attr_accessor :token
-      #
-      # belongs_to :bearer, polymorphic: true
-
-      # Add virtual token attribute to serializable attributes, and exclude
-      # the token's HMAC digest
-      def serializable_hash(options = nil)
-        h = super options.merge(except: 'token_digest')
-        h.merge! 'token' => token if token.present?
-        h
-      end
-    end
-  end
-end