securial 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e22e132a47996962dd118e5bb2103f8d60bc5f9e2d7af9ee3b8c99baca20060a
+  data.tar.gz: b20fc748fbbc987af627ff8fe30cbdaf67a7c0db168e1d29355065f8b2b09650
+SHA512:
+  metadata.gz: a4015b2bfc0bb403d3816688e1a3d0481c9b40b750d5cdf6ac898abcf2ab352dfcbee308fe68b2dd799a7452d2717a21aa7c7553a5f73a54720b88bd286baaf7
+  data.tar.gz: 37d63d4212228b654ea528da4ed7b717e1980c4b71d248bac6a8370250d4593a84b8b80fd70d74d2fd21e7a4742cbd837be346d8db112dac309125ab3f5d2f5d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Aly Badawy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Securial
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "securial"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install securial
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/stylesheets/securial/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/securial/application_controller.rb

@@ -0,0 +1,4 @@
+module Securial
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/securial/roles_controller.rb

@@ -0,0 +1,51 @@
+module Securial
+  class RolesController < ApplicationController
+    before_action :set_role, only: %i[ show update destroy ]
+
+    # GET /roles
+    def index
+      @roles = Role.all
+    end
+
+    # GET /roles/1
+    def show
+    end
+
+    # POST /roles
+    def create
+      @role = Role.new(role_params)
+
+      if @role.save
+        render :show, status: :created, location: @role
+      else
+        render json: @role.errors, status: :unprocessable_entity
+      end
+    end
+
+    # PATCH/PUT /roles/1
+    def update
+      if @role.update(role_params)
+        render :show, status: :ok, location: @role
+      else
+        render json: @role.errors, status: :unprocessable_entity
+      end
+    end
+
+    # DELETE /roles/1
+    def destroy
+      @role.destroy!
+    end
+
+    private
+
+    # Use callbacks to share common setup or constraints between actions.
+    def set_role
+      @role = Role.find(params.expect(:id))
+    end
+
+    # Only allow a list of trusted parameters through.
+    def role_params
+      params.expect(role: [ :role_name ])
+    end
+  end
+end

data/app/helpers/securial/application_helper.rb

@@ -0,0 +1,4 @@
+module Securial
+  module ApplicationHelper
+  end
+end

data/app/helpers/securial/roles_helper.rb

@@ -0,0 +1,4 @@
+module Securial
+  module RolesHelper
+  end
+end

data/app/jobs/securial/application_job.rb

@@ -0,0 +1,4 @@
+module Securial
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/securial/application_mailer.rb

@@ -0,0 +1,6 @@
+module Securial
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/securial/application_record.rb

@@ -0,0 +1,5 @@
+module Securial
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/securial/role.rb

@@ -0,0 +1,7 @@
+module Securial
+  class Role < ApplicationRecord
+    normalizes :role_name, with: ->(e) { e.strip.titleize }
+
+    validates :role_name, presence: true, uniqueness: true
+  end
+end

data/app/views/securial/roles/_role.json.jbuilder

@@ -0,0 +1,3 @@
+json.extract! role, :id, :role_name
+json.extract! role, :created_at, :updated_at # TODO: hide if not admin
+json.url role_url(role, format: :json)

data/app/views/securial/roles/index.json.jbuilder

@@ -0,0 +1 @@
+json.array! @roles, partial: "securial/roles/role", as: :role

data/app/views/securial/roles/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! "securial/roles/role", role: @role

data/config/routes.rb

@@ -0,0 +1,5 @@
+Securial::Engine.routes.draw do
+  defaults format: :json do
+    resources :roles
+  end
+end

data/db/migrate/20250511095806_create_securial_roles.rb

@@ -0,0 +1,11 @@
+class CreateSecurialRoles < ActiveRecord::Migration[8.0]
+  def change
+    create_table :securial_roles do |t|
+      t.string :role_name
+
+      t.timestamps
+    end
+
+    add_index :securial_roles, :role_name, unique: true
+  end
+end

data/lib/securial/engine.rb

@@ -0,0 +1,5 @@
+module Securial
+  class Engine < ::Rails::Engine
+    isolate_namespace Securial
+  end
+end

data/lib/securial/version.rb

@@ -0,0 +1,3 @@
+module Securial
+  VERSION = "0.2.0"
+end

data/lib/securial.rb

@@ -0,0 +1,6 @@
+require "securial/version"
+require "securial/engine"
+
+module Securial
+  # Your code goes here...
+end

data/lib/tasks/securial_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :securial do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,284 @@
+--- !ruby/object:Gem::Specification
+name: securial
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Aly Badawy
+bindir: bin
+cert_chain: []
+date: 2025-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Securial is a mountable Rails engine that provides robust, extensible
+  authentication and access control for Rails applications. It supports JWT, API tokens,
+  session-based auth, and is designed for easy integration with modern web and mobile
+  apps.
+email:
+- 1198568+AlyBadawy@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/securial/application.css
+- app/controllers/securial/application_controller.rb
+- app/controllers/securial/roles_controller.rb
+- app/helpers/securial/application_helper.rb
+- app/helpers/securial/roles_helper.rb
+- app/jobs/securial/application_job.rb
+- app/mailers/securial/application_mailer.rb
+- app/models/securial/application_record.rb
+- app/models/securial/role.rb
+- app/views/securial/roles/_role.json.jbuilder
+- app/views/securial/roles/index.json.jbuilder
+- app/views/securial/roles/show.json.jbuilder
+- config/routes.rb
+- db/migrate/20250511095806_create_securial_roles.rb
+- lib/securial.rb
+- lib/securial/engine.rb
+- lib/securial/version.rb
+- lib/tasks/securial_tasks.rake
+homepage: https://github.com/AlyBadawy/Securial
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/AlyBadawy/Securial
+  source_code_uri: https://github.com/AlyBadawy/Securial
+  changelog_uri: https://github.com/AlyBadawy/Securial/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Authentication and access control Rails engine for your API.
+test_files: []