rbac_system 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a3c2341acf52bc0324e7e9ddcf70b59657974ae964e836fd78a8fc228aab014
+  data.tar.gz: 1b9215b92ca6dd5c4200efcfb912d927144b91d5f48186fd5f4b72e7f44115d1
+SHA512:
+  metadata.gz: f0c0dc3c5ea8112687d155ac73df76a103543e5b90506402cee91b968bda6890a47cb78a0a888fc4d4299661220ac60d35954eda34e5c98849b9333a30f43ac7
+  data.tar.gz: 8bf9ee8b3b701efb74b01f55babae92e31e424e8011a4457bd37f29730c8315161cb2001163b3ee7f59b82cd0931d081c96309b12b4e53f75b6045ebec2df01d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-09
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Yarramreddy.Sainathreddy@flaerhomes.com
+
+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,151 @@
+## RbacSystem
+
+The `rbac_system` gem provides a robust Role-Based Access Control (RBAC) implementation, enabling you to efficiently manage admin roles and permissions within your application. With this gem, you can easily define and enforce authorization rules for various resources and actions.
+
+## Overview
+
+This gem allows you to define three primary entities:
+
+1. **Admin**: Represents your admin users and their basic details.
+2. **Role**: Defines roles with specific permissions.
+
+   - **Name**: The name of the role (e.g., `Editor`, `Viewer`).
+   - **Permissions**: A hash mapping resources to their respective actions. For example:
+
+     ```ruby
+     {
+       Upload: { manage: true, create: true },
+       Download: { manage: true, read: true },
+       Area: { manage: true, create: true, update: true, read: true },
+       City: { manage: true, create: true, update: true, read: true },
+       AccountLedger: { manage: true, read: true },
+       CouponDiscount: { manage: true, read: true, create: true, update: true }
+     }
+     ```
+
+   In this example, `Upload` and `Download` are custom resource names, while `Area`, `City`, etc., correspond to database models.
+
+3. **AdminRole**: A junction table that connects `Admin` and `Role` entities, allowing you to assign roles to admins.
+
+## Installation
+
+To install the gem, add it to your application's Gemfile:
+
+```bash
+bundle add rbac_system
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install rbac_system
+```
+
+## Usage
+
+To use the rbac_system gem, you need to check authorization based on the current admin, the action being performed, and the resource name. Here are some usage scenarios:
+
+Case 1: Model Exists in Database
+For a standard model, you can implement authorization as follows:
+
+before_action :check_authorization
+
+action_map = {
+'create_area' => 'create',
+'area_listing' => 'read',
+'update_area' => 'update'
+}
+
+action = action_map[action_name]
+resource = controller_name.classify
+
+authorized = RbacSystem::Authorization.new(admin, resource, action).authorized?
+
+unless authorized
+render json: { status: 'failure', message: 'Forbidden', errors: ['You are not authorized to perform this action'] }, status: :forbidden
+end
+
+Multiple Models in a Single Controller
+If your controller manages multiple models, use the following approach:
+
+action_map = {
+'add_update_cart' => { action: 'create', resource: 'Cart' },
+'cart_checkout' => { action: 'create', resource: 'Cart' },
+'validate_discount' => { action: 'create', resource: 'Cart' },
+'get_cart_summary' => { action: 'read', resource: 'Cart' },
+'place_order' => { action: 'create', resource: 'Order' },
+'order_deliver' => { action: 'read', resource: 'Order' },
+'clear_cart' => { action: 'put', resource: 'Cart' },
+'get_orders' => { action: 'read', resource: 'Order' },
+'get_carts' => { action: 'read', resource: 'Cart' },
+'verify_unicommerce_order_status' => { action: 'update', resource: 'Order' },
+'unicommerce_snapshot' => { action: 'read', resource: 'ProductSku' },
+'cancel_order' => { action: 'create', resource: 'Order' },
+'get_unicommerce_order_status' => { action: 'read', resource: 'Order' }
+}
+
+action_info = action_map[action_name]
+action = action_info[:action]
+resource = action_info[:resource]
+
+authorized = RbacSystem::Authorization.new(admin, resource, action).authorized?
+
+unless authorized
+render json: { status: 'failure', message: 'Forbidden', errors: ['You are not authorized to perform this action'] }, status: :forbidden
+end
+
+Custom Resource Names
+If you need to define custom resource names without a corresponding model, you can do this:
+
+ruby
+Copy code
+action_map = {
+'bulk_sku_upload' => 'create',
+'bulk_option_values_upload' => 'create',
+'bulk_option_value_sku_mappings_upload' => 'create',
+'bulk_product_medias_upload' => 'create'
+}
+
+action = action_map[action_name]
+resource = 'Upload'
+
+authorized = RbacSystem::Authorization.new(admin, resource, action).authorized?
+
+unless authorized
+render json: { status: 'failure', message: 'Forbidden', errors: ['You are not authorized to perform this action'] }, status: :forbidden
+end
+
+## Development
+
+After checking out the repository, run bin/setup to install dependencies. You can run tests with:
+rake spec
+
+For an interactive prompt to experiment, run:
+bin/console
+
+To install the gem onto your local machine, execute:
+
+bundle exec rake install
+
+To release a new version, update the version number in version.rb, and then run:
+bundle exec rake release
+
+This will create a Git tag for the version, push Git commits and the created tag, and push the .gem file to RubyGems.org.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/saiganiankoji/rbac_system. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Code of Conduct.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.
+
+## Code of Conduct
+
+### Key Improvements:
+
+1. **Clarity and Structure**: The README is structured into clear sections with headings, making it easy to navigate.
+2. **Comprehensive Usage Instructions**: Each usage case is explained with code examples, making it easy for users to understand how to implement the gem.
+3. **Development and Contributing Guidelines**: Clear instructions for development, contributing, and licensing provide users with the necessary information to participate in the project.
+
+Feel free to customize any sections as needed, especially the GitHub links and any specific details regarding your implementation!

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rbac_system/authorization.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module RbacSystem
+    class Authorization
+      def initialize(admin, resource, action)
+        @admin = admin
+        @resource = resource
+        @action = action
+      end
+  
+      def authorized?
+        roles.each do |role|
+          return true if role_authorized?(role)
+        end
+        false
+      end
+  
+      private
+  
+      def roles
+        @admin.roles
+      end
+  
+      def role_authorized?(role)
+        role.permissions[@resource]&.key?(@action)
+      end
+    end
+end
+  

data/lib/rbac_system/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RbacSystem
+  VERSION = "0.1.0"
+end

data/lib/rbac_system.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "rbac_system/version"
+require_relative "rbac_system/authorization"
+
+module RbacSystem
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/rbac_system.rbs

@@ -0,0 +1,4 @@
+module RbacSystem
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: rbac_system
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yarramsaireddy2001@gmail.com
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-10-10 00:00:00.000000000 Z
+dependencies: []
+description: This gem provides a Role-Based Access Control implementation for Ruby
+  applications, allowing developers to define roles and permissions easily.
+email:
+- yarramsaireddy2001@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rbac_system.rb
+- lib/rbac_system/authorization.rb
+- lib/rbac_system/version.rb
+- sig/rbac_system.rbs
+homepage: https://github.com/saiganiankoji/rbac_system
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/saiganiankoji/rbac_system
+  source_code_uri: https://github.com/saiganiankoji/rbac_system
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: A simple RBAC system for Ruby applications
+test_files: []