arkaan 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c1ec575ec3457e7920d4ba8adc017667cc6703e
+  data.tar.gz: 977526cae9348564d8e3e14674c73646a7b522a5
+SHA512:
+  metadata.gz: 28c7cecdc80476e4e624d7b5cbc37a8d12456ef0667a4c01586efcc4146068bc2930f81db9c8a3bb8415930f7e73e44bc8272cfa394246581a668b28c6895d81
+  data.tar.gz: 0126a61e8bc40fc9e8b4172084515a82f08720380f01b49fb1cad9aae2c27de6790939b9a187be620dae92c9d71774f96aceb036496c0cb3009e0acab2b6e874

data/lib/arkaan.rb

@@ -0,0 +1,11 @@
+require 'mongoid'
+require 'active_model'
+require 'active_support'
+
+# Main module of the application, holding all the subsequent classes.
+# @author Vincent Courtois <courtois.vincent@outlook.com>
+module Arkaan
+  autoload :Account    , 'arkaan/account'
+  autoload :Permissions, 'arkaan/permissions'
+  autoload :Concerns   , 'arkaan/concerns'
+end

data/lib/arkaan/account.rb

@@ -0,0 +1,42 @@
+module Arkaan
+  # A user account with all related attributes. It holds credentials and informations about a designated user.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  class Account
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include ActiveModel::SecurePassword
+
+    # @!attribute [rw] username
+    #   @return [String] the nickname the user chose at subscription, must be given, unique, and 6 or more characters long.
+    field :username, type: String
+    # @!attribute [r] password_digest
+    #   @return [String] the password of the user, encrypted with the Blowfish algorithm.
+    field :password_digest, type: String
+    # @!attribute [rw] lastname
+    #   @return [String] the last name (family name) of the user.
+    field :lastname, type: String, default: ''
+    # @!attribute [rw] firstname
+    #   @return [String] the first name of the user.
+    field :firstname, type: String, default: ''
+    # @!attribute [rw] birthdate
+    #   @return [DateTime] the day of birth of the user, as an ISO-8601.
+    field :birthdate, type: DateTime
+    # @!attribute [rw] email
+    #   @return [String] the email address of the user, useful to contact them ; it must be given, unique, and have an email format.
+    field :email, type: String
+
+    # @!attribute [rw] groups
+    #   @return [Array<Arkaan::Permissions::Group>] the groups giving their corresponding rights to the current account.
+    has_and_belongs_to_many :groups, class_name: 'Arkaan::Permissions::Group', inverse_of: :accounts
+
+    validates :username, length: {minimum: 6}, uniqueness: true
+
+    validates :email, presence: true, format: {with: /\A[a-z0-9._%+-]+@[a-z0-9.-]+\.[a-z]{2,}\z/}, uniqueness: true
+
+    # @!attribute [w] password
+    #   @return [String] password, in clear, of the user ; do not attempt to get the value, just set it when changing the password.
+    # @!attribute [w] password_confirmation
+    #   @return [String] the confirmation of the password, do not get, just set it ; it must be the same as the password.
+    has_secure_password
+  end
+end

data/lib/arkaan/concerns.rb

@@ -0,0 +1,7 @@
+module Arkaan
+  # This module holds the shared concerns to include in the desired models.
+  # @authro Vincent Courtois <courtois.vincent@outlook.com>
+  module Concerns
+    autoload :Sluggable, 'arkaan/concerns/sluggable'
+  end
+end

data/lib/arkaan/concerns/sluggable.rb

@@ -0,0 +1,17 @@
+module Arkaan
+  module Concerns
+    # Includes the slug field, always the same in all models.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Sluggable
+      extend ActiveSupport::Concern
+
+      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}, format: {with: /\A[a-z]+(_[a-z]+)*\z/}, uniqueness: true, presence: true
+      end
+    end
+  end
+end

data/lib/arkaan/permissions.rb

@@ -0,0 +1,10 @@
+module Arkaan
+  # This module holds the logic for all the classes concerning the permissions abd rights for the user.
+  # A permission is restricting the access to one or several features to the users having it.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  module Permissions
+    autoload :Right   , 'arkaan/permissions/right'
+    autoload :Group   , 'arkaan/permissions/group'
+    autoload :Category, 'arkaan/permissions/category'
+  end
+end

data/lib/arkaan/permissions/category.rb

@@ -0,0 +1,11 @@
+module Arkaan
+  module Permissions
+    # A category of rights regroups one or several rights for convenience purposes.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Category
+      include Mongoid::Document
+      include Mongoid::Timestamps
+      include Arkaan::Concerns::Sluggable
+    end
+  end
+end

data/lib/arkaan/permissions/group.rb

@@ -0,0 +1,18 @@
+module Arkaan
+  module Permissions
+    # A group gathers one or several users to give them the same rights for conviniency purposes.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Group
+      include Mongoid::Document
+      include Mongoid::Timestamps
+      include Arkaan::Concerns::Sluggable
+
+      # @!attribute [rw] accounts
+      #   @return [Array<Arkaan::Account>] the accounts having the rights granted by this group.
+      has_and_belongs_to_many :accounts, class_name: 'Arkaan::Account', inverse_of: :groups
+      # @!attribute [rw] rights
+      #   @return [Array<Arkaan::Permissions::Right>] the rights granted by belonging to this group.
+      has_and_belongs_to_many :rights, class_name: 'Arkaan::Permissions::Right', inverse_of: :groups
+    end
+  end
+end

data/lib/arkaan/permissions/right.rb

@@ -0,0 +1,15 @@
+module Arkaan
+  module Permissions
+    # A right is the access to one or several features in the application. It's applied to a group, and transitively to an account.
+    # @author Vincent Courtois <courtois;vincent@outlook.com>
+    class Right
+      include Mongoid::Document
+      include Mongoid::Timestamps
+      include Arkaan::Concerns::Sluggable
+
+      # @!attribute [rw] groups
+      #   @return [Array<Arkaan::Permissions::Group>] the groups granted with the permission to access features opened by this right.
+      has_and_belongs_to_many :groups, class_name: 'Arkaan::Permissions::Group', inverse_of: :rights
+    end
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: arkaan
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Vincent Courtois
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.8.1
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.0.0.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.0.0.beta
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.11
+description: This gem holds the model layer for my table-top RPG games application.
+email: courtois.vincent@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/arkaan.rb
+- lib/arkaan/account.rb
+- lib/arkaan/concerns.rb
+- lib/arkaan/concerns/sluggable.rb
+- lib/arkaan/permissions.rb
+- lib/arkaan/permissions/category.rb
+- lib/arkaan/permissions/group.rb
+- lib/arkaan/permissions/right.rb
+homepage: https://rubygems.org/gems/arkaan
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: The model layer for my table-RPG application
+test_files: []