saas_platform 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e4e2092f5ba398e0ea833920dc041dea5ad5118e5476b99fbb8d4e4372b15d6f
+  data.tar.gz: f5676ec92b0d91aef440aa0e59357a1f1fcb61907d625e9ff608c8e106d970c0
+SHA512:
+  metadata.gz: d79b115d14fa563b017ce118bc9ff8bfa1c4f2223db60c9fd42699215a09ba6fbf167454a54c67de92d6a3cdd11e2c8efabdffb5efe2d5e8b8b4c4a61af4e8a4
+  data.tar.gz: d747ec29ea25717fc6f83c395573f9b61247f412f7a8d8de991ccdd522a3733c5a9b300f62f0df5e9dcc4782870ba1da90f0c2c54c7c149cfcb198d4b39c37f3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright shiboshreeroy
+
+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,143 @@
+# SaasPlatform 💎
+
+[![Gem Version](https://badge.fury.io/rb/saas_platform.svg)](https://badge.fury.io/rb/saas_platform)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Rails Version](https://img.shields.io/badge/Rails-8.0+-red.svg)](https://rubyonrails.org)
+[![Security Scan](https://img.shields.io/badge/Security-Brakeman%20Passed-success.svg)]()
+
+**SaasPlatform** is an enterprise-grade, mountable Ruby on Rails 8 engine that delivers a complete **SaaS Operating System**. It provides a premium Apple-inspired GUI, robust multi-tenancy, banking logic, ecommerce, and enterprise security out of the box.
+
+---
+
+## 🏗 Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'saas_platform'
+```
+
+### 1. Initialize Infrastructure
+Run the following commands to install migrations and prepare your database:
+
+```bash
+$ bundle install
+$ bin/rails saas_platform:install:migrations
+$ bin/rails db:migrate
+```
+
+### 2. Mount the GUI
+Mount the engine in your `config/routes.rb`. This is where your users and admins will access the platform.
+
+```ruby
+Rails.application.routes.draw do
+  # You can mount it at any path, e.g., /app, /admin, or /dashboard
+  mount SaasPlatform::Engine => "/app"
+end
+```
+
+### 3. Add Middleware
+Enable rate-limiting security in `config/application.rb`:
+
+```ruby
+config.middleware.use Rack::Attack
+```
+
+---
+
+## 🖥 Using the GUI (Graphical User Interface)
+
+SaasPlatform features a high-end design system inspired by **macOS** and **iOS**. All interfaces are fully responsive and support Hotwire (Turbo/Stimulus) for a "Single Page App" feel.
+
+### 1. Authentication (Glassmorphic Interface)
+Access the login page at `/app/users/sign_in`. 
+*   **Design**: Features a centered frosted-glass card with native SF-inspired typography.
+*   **Flows**: Includes premium layouts for Sign In, Sign Up, Password Reset, and 2FA Verification.
+
+### 2. The Main Dashboard
+The primary landing zone for users (`/app`).
+*   **Sidebar**: Persistent navigation with frosted-glass effects. Includes sections for Overview, Orders, Products, and Settings.
+*   **Analytics Widgets**: Real-time charts showing Revenue Growth (Line Chart) and Top Products (Bar Chart).
+*   **Recent Activity**: Live data tables showing latest transactions and orders with status badges.
+
+### 3. Global Search 🔍
+Located in the top navigation bar.
+*   **Functionality**: Instant search across all your data (Users, Products, Orders).
+*   **Security**: Automatically filters results based on the current user's Account (Multi-tenant isolation).
+
+### 4. Notification Center 🔔
+The "Bell" icon in the top right tracks all system activity.
+*   **Real-time**: Alerts appear instantly via Turbo Streams.
+*   **Management**: Users can view recent notifications and mark them as read directly from the dropdown.
+
+### 5. Enterprise Audit Logs 📜
+Available for accounts on the **Enterprise Plan**.
+*   **Location**: `/app/audit_logs`.
+*   **GUI Feature**: A detailed list showing exactly who changed what data, including "before and after" snapshots.
+
+---
+
+## 🛠 Developer Guide (Customizing the GUI)
+
+### Using ViewComponents
+You can use the platform's premium UI components in your own host application views:
+
+```erb
+<%# Render a native-feeling card %>
+<%= render SaasPlatform::CardComponent.new(glass: true) do %>
+  <h3 class="text-lg font-bold">Custom Widget</h3>
+  <p>Your custom content here...</p>
+<% end %>
+
+<%# Render a native Apple-style button %>
+<%= render SaasPlatform::ButtonComponent.new(variant: :primary) do %>
+  Action Item
+<% end %>
+```
+
+### Role-Based Access (RBAC)
+Control what users see in the GUI based on their roles:
+
+```ruby
+user = SaasPlatform::User.find(1)
+user.add_role(:admin) # Now has access to admin-only GUI features
+```
+
+### Plan-Based Gating
+Hide or show GUI features based on the account's subscription:
+
+```ruby
+<% if current_account.can_use?(:advanced_analytics) %>
+  <%= render "premium_gui_widget" %>
+<% end %>
+```
+
+---
+
+## 💰 Banking & Fintech Logic
+
+The GUI interfaces directly with a robust backend banking system:
+*   **Atomic Wallets**: Every account has a balance managed in cents (`money-rails`).
+*   **Transaction Integrity**: Every credit/debit is logged with a polymorphic reference.
+
+```ruby
+# Example: Process a GUI-triggered refund
+current_account.wallet.credit!(order.total, category: "refund", reference: order)
+```
+
+---
+
+## 🔒 Security Standards
+
+*   **Rate Limiting**: Throttles brute-force attempts on the GUI login.
+*   **Secure Headers**: Injected CSP to prevent XSS and clickjacking.
+*   **Multi-Tenancy**: The GUI *never* shows data from another account.
+
+---
+
+## 📄 License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+---
+
+Built for excellence by **Shiboshree Roy**. 🚀

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new

data/app/assets/stylesheets/saas_platform/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/assets/stylesheets/saas_platform/application.tailwind.css

@@ -0,0 +1,25 @@
+@import "tailwindcss/base";
+@import "tailwindcss/components";
+@import "tailwindcss/utilities";
+
+@layer components {
+  .apple-glass {
+    @apply bg-white/70 backdrop-blur-apple border border-white/20 shadow-apple;
+  }
+
+  .apple-glass-dark {
+    @apply bg-apple-dark/70 backdrop-blur-apple border border-white/10 shadow-apple;
+  }
+
+  .btn-apple {
+    @apply inline-flex items-center justify-center px-4 py-2 rounded-apple font-medium transition-all duration-200 active:scale-95 disabled:opacity-50 disabled:pointer-events-none;
+  }
+
+  .btn-apple-primary {
+    @apply btn-apple bg-apple-blue text-white hover:bg-opacity-90;
+  }
+
+  .btn-apple-secondary {
+    @apply btn-apple bg-apple-light text-apple-dark hover:bg-gray-200;
+  }
+}

data/app/components/saas_platform/button_component.rb

@@ -0,0 +1,46 @@
+module SaasPlatform
+  class ButtonComponent < ViewComponent::Base
+    def initialize(variant: :primary, size: :md, type: :button, **system_arguments)
+      @variant = variant
+      @size = size
+      @type = type
+      @system_arguments = system_arguments
+    end
+
+    def call
+      content_tag(:button, content, type: @type, class: classes, **@system_arguments)
+    end
+
+    private
+
+    def classes
+      [
+        base_classes,
+        variant_classes,
+        size_classes,
+        @system_arguments[:class]
+      ].compact.join(" ")
+    end
+
+    def base_classes
+      "btn-apple"
+    end
+
+    def variant_classes
+      case @variant
+      when :primary then "btn-apple-primary"
+      when :secondary then "btn-apple-secondary"
+      when :danger then "bg-apple-red text-white hover:bg-opacity-90"
+      when :outline then "border-2 border-apple-blue text-apple-blue hover:bg-apple-blue hover:text-white"
+      end
+    end
+
+    def size_classes
+      case @size
+      when :sm then "text-sm px-3 py-1.5"
+      when :md then "text-base px-4 py-2"
+      when :lg then "text-lg px-6 py-3"
+      end
+    end
+  end
+end

data/app/components/saas_platform/card_component.html.erb

@@ -0,0 +1,3 @@
+<%= content_tag :div, class: classes, **@system_arguments.except(:class) do %>
+  <%= content %>
+<% end %>

data/app/components/saas_platform/card_component.rb

@@ -0,0 +1,29 @@
+module SaasPlatform
+  class CardComponent < ViewComponent::Base
+    def initialize(glass: true, padding: :md, **system_arguments)
+      @glass = glass
+      @padding = padding
+      @system_arguments = system_arguments
+    end
+
+    private
+
+    def classes
+      [
+        "rounded-apple-lg overflow-hidden",
+        @glass ? "apple-glass" : "bg-white border border-gray-200 shadow-sm",
+        padding_classes,
+        @system_arguments[:class]
+      ].compact.join(" ")
+    end
+
+    def padding_classes
+      case @padding
+      when :none then ""
+      when :sm then "p-4"
+      when :md then "p-6"
+      when :lg then "p-8"
+      end
+    end
+  end
+end

data/app/components/saas_platform/notification_component.html.erb

@@ -0,0 +1,27 @@
+<div class="relative inline-block text-left" data-controller="dropdown">
+  <button type="button" class="relative p-1 text-apple-gray hover:text-apple-blue focus:outline-none" id="notifications-menu" aria-expanded="false" aria-haspopup="true">
+    <span class="sr-only">View notifications</span>
+    <svg class="w-6 h-6" fill="none" stroke="currentColor" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M15 17h5l-1.405-1.405A2.032 2.032 0 0118 14.158V11a6.002 6.002 0 00-4-5.659V5a2 2 0 10-4 0v.341C7.67 6.165 6 8.388 6 11v3.159c0 .538-.214 1.055-.595 1.436L4 17h5m6 0v1a3 3 0 11-6 0v-1m6 0H9"></path></svg>
+    <% if @notifications.unread.any? %>
+      <span class="absolute top-0 right-0 block w-2.5 h-2.5 rounded-full bg-apple-red ring-2 ring-white"></span>
+    <% end %>
+  </button>
+
+  <div class="absolute right-0 w-80 mt-2 origin-top-right apple-glass rounded-apple-lg shadow-apple ring-1 ring-black ring-opacity-5 focus:outline-none z-50 overflow-hidden" role="menu" aria-orientation="vertical" aria-labelledby="notifications-menu" tabindex="-1">
+    <div class="px-4 py-3 border-b border-gray-100 flex justify-between items-center">
+      <h3 class="text-sm font-semibold text-apple-dark">Notifications</h3>
+      <a href="#" class="text-xs text-apple-blue hover:underline">Mark all as read</a>
+    </div>
+    <div class="max-h-96 overflow-y-auto">
+      <% @notifications.recent.limit(5).each do |notification| %>
+        <div class="px-4 py-3 hover:bg-apple-light/30 transition-colors border-b border-gray-50 <%= 'bg-blue-50/20' unless notification.read? %>">
+          <p class="text-sm text-apple-dark"><%= notification.params['message'] %></p>
+          <p class="mt-1 text-xs text-apple-gray"><%= time_ago_in_words(notification.created_at) %> ago</p>
+        </div>
+      <% end %>
+    </div>
+    <div class="px-4 py-2 bg-apple-light/50 text-center">
+      <a href="#" class="text-xs font-medium text-apple-blue hover:underline">View all notifications</a>
+    </div>
+  </div>
+</div>

data/app/components/saas_platform/notification_component.rb

@@ -0,0 +1,11 @@
+module SaasPlatform
+  class NotificationComponent < ViewComponent::Base
+    def initialize(notifications:)
+      @notifications = notifications
+    end
+
+    def render?
+      @notifications.any?
+    end
+  end
+end

data/app/components/saas_platform/order_list_component.html.erb

@@ -0,0 +1,28 @@
+<div class="overflow-x-auto">
+  <table class="min-w-full divide-y divide-gray-200">
+    <thead>
+      <tr>
+        <th class="px-6 py-3 text-left text-xs font-medium text-apple-gray uppercase tracking-wider">Order ID</th>
+        <th class="px-6 py-3 text-left text-xs font-medium text-apple-gray uppercase tracking-wider">Customer</th>
+        <th class="px-6 py-3 text-left text-xs font-medium text-apple-gray uppercase tracking-wider">Status</th>
+        <th class="px-6 py-3 text-left text-xs font-medium text-apple-gray uppercase tracking-wider">Total</th>
+        <th class="px-6 py-3 text-left text-xs font-medium text-apple-gray uppercase tracking-wider">Date</th>
+      </tr>
+    </thead>
+    <tbody class="divide-y divide-gray-200">
+      <% @orders.each do |order| %>
+        <tr class="hover:bg-apple-light/30 transition-colors">
+          <td class="px-6 py-4 whitespace-nowrap text-sm font-medium text-apple-blue">#<%= order.id %></td>
+          <td class="px-6 py-4 whitespace-nowrap text-sm text-apple-dark"><%= order.user.name %></td>
+          <td class="px-6 py-4 whitespace-nowrap">
+            <span class="px-2.5 py-0.5 rounded-full text-xs font-medium <%= status_classes(order.status) %>">
+              <%= order.status.humanize %>
+            </span>
+          </td>
+          <td class="px-6 py-4 whitespace-nowrap text-sm font-bold text-apple-dark"><%= order.total.format %></td>
+          <td class="px-6 py-4 whitespace-nowrap text-sm text-apple-gray"><%= order.created_at.strftime("%b %d, %Y") %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/app/components/saas_platform/order_list_component.rb

@@ -0,0 +1,18 @@
+module SaasPlatform
+  class OrderListComponent < ViewComponent::Base
+    def initialize(orders:)
+      @orders = orders
+    end
+
+    private
+
+    def status_classes(status)
+      case status.to_sym
+      when :paid, :completed then "bg-apple-green/10 text-apple-green"
+      when :pending then "bg-apple-orange/10 text-apple-orange"
+      when :cancelled, :refunded then "bg-apple-red/10 text-apple-red"
+      else "bg-apple-gray/10 text-apple-gray"
+      end
+    end
+  end
+end

data/app/controllers/saas_platform/application_controller.rb

@@ -0,0 +1,31 @@
+module SaasPlatform
+  class ApplicationController < ActionController::Base
+    set_current_tenant_through_filter
+    before_action :set_tenant
+
+    include Pundit::Authorization
+    
+    helper_method :current_account
+
+    rescue_from Pundit::NotAuthorizedError, with: :user_not_authorized
+
+    def current_account
+      current_tenant
+    end
+
+    private
+
+    def set_tenant
+      # For simplicity, we'll use the current user's account if they are logged in.
+      # In a real SaaS, this would be based on subdomain or domain.
+      if current_user
+        set_current_tenant(current_user.account)
+      end
+    end
+
+    def user_not_authorized
+      flash[:alert] = "You are not authorized to perform this action."
+      redirect_to(request.referrer || main_app.root_path)
+    end
+  end
+end

data/app/controllers/saas_platform/audit_logs_controller.rb

@@ -0,0 +1,22 @@
+module SaasPlatform
+  class AuditLogsController < ApplicationController
+    before_action :authenticate_user!
+    before_action :check_enterprise_access
+    layout 'saas_platform/dashboard'
+
+    def index
+      @versions = PaperTrail::Version.where(item_type: ['SaasPlatform::User', 'SaasPlatform::Wallet', 'SaasPlatform::Order'])
+                                    .order(created_at: :desc)
+                                    .page(params[:page])
+    end
+
+    private
+
+    def check_enterprise_access
+      unless current_account.can_use?(:audit_logs)
+        flash[:alert] = "Audit logs are only available on Enterprise plans."
+        redirect_to root_path
+      end
+    end
+  end
+end

data/app/controllers/saas_platform/dashboard_controller.rb

@@ -0,0 +1,14 @@
+module SaasPlatform
+  class DashboardController < ApplicationController
+    before_action :authenticate_user!
+    layout 'saas_platform/dashboard'
+
+    def index
+      @analytics = AnalyticsService.new(current_account)
+      @revenue_data = @analytics.revenue_over_time
+      @top_products = @analytics.top_products
+      @user_growth = @analytics.user_growth
+      @recent_orders = current_account.orders.includes(:user).order(created_at: :desc).limit(10)
+    end
+  end
+end

data/app/controllers/saas_platform/devise/confirmations_controller.rb

@@ -0,0 +1,7 @@
+module SaasPlatform
+  module Devise
+    class ConfirmationsController < ::Devise::ConfirmationsController
+      layout 'saas_platform/auth'
+    end
+  end
+end

data/app/controllers/saas_platform/devise/passwords_controller.rb

@@ -0,0 +1,7 @@
+module SaasPlatform
+  module Devise
+    class PasswordsController < ::Devise::PasswordsController
+      layout 'saas_platform/auth'
+    end
+  end
+end

data/app/controllers/saas_platform/devise/registrations_controller.rb

@@ -0,0 +1,7 @@
+module SaasPlatform
+  module Devise
+    class RegistrationsController < ::Devise::RegistrationsController
+      layout 'saas_platform/auth'
+    end
+  end
+end

data/app/controllers/saas_platform/devise/sessions_controller.rb

@@ -0,0 +1,7 @@
+module SaasPlatform
+  module Devise
+    class SessionsController < ::Devise::SessionsController
+      layout 'saas_platform/auth'
+    end
+  end
+end

data/app/controllers/saas_platform/devise/unlocks_controller.rb

@@ -0,0 +1,7 @@
+module SaasPlatform
+  module Devise
+    class UnlocksController < ::Devise::UnlocksController
+      layout 'saas_platform/auth'
+    end
+  end
+end

data/app/controllers/saas_platform/search_controller.rb

@@ -0,0 +1,15 @@
+module SaasPlatform
+  class SearchController < ApplicationController
+    before_action :authenticate_user!
+    
+    def index
+      @query = params[:q]
+      @results = SearchService.new(current_account, @query).perform if @query.present?
+      
+      respond_to do |format|
+        format.html
+        format.turbo_stream
+      end
+    end
+  end
+end

data/app/helpers/saas_platform/application_helper.rb

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

data/app/jobs/saas_platform/application_job.rb

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

data/app/mailers/saas_platform/application_mailer.rb

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

data/app/models/saas_platform/account.rb

@@ -0,0 +1,36 @@
+module SaasPlatform
+  class Account < ApplicationRecord
+    include PgSearch::Model
+    pg_search_scope :search_by_name, against: [:name, :subdomain, :domain]
+    
+    has_many :users, class_name: 'SaasPlatform::User', dependent: :destroy
+    has_one :wallet, class_name: 'SaasPlatform::Wallet', dependent: :destroy
+    has_many :products, class_name: 'SaasPlatform::Product', dependent: :destroy
+    has_many :orders, class_name: 'SaasPlatform::Order', dependent: :destroy
+    
+    after_create :create_default_wallet
+
+    validates :name, presence: true
+    validates :subdomain, presence: true, uniqueness: true, format: { with: /\A[a-z0-9-]+\z/ }
+    
+    scope :active, -> { where(status: 'active') }
+    
+    def self.current
+      ActsAsTenant.current_tenant
+    end
+
+    def plan
+      @plan ||= PlanService.new(self)
+    end
+
+    def can_use?(feature)
+      plan.has_feature?(feature)
+    end
+
+    private
+
+    def create_default_wallet
+      create_wallet(currency: 'USD')
+    end
+  end
+end

data/app/models/saas_platform/api_key.rb

@@ -0,0 +1,24 @@
+module SaasPlatform
+  class ApiKey < ApplicationRecord
+    acts_as_tenant :account, class_name: 'SaasPlatform::Account'
+    
+    belongs_to :user, class_name: 'SaasPlatform::User'
+    
+    validates :access_token, presence: true, uniqueness: true
+    validates :name, presence: true
+    
+    before_validation :generate_access_token, on: :create
+    
+    scope :active, -> { where(active: true).where('expires_at IS NULL OR expires_at > ?', Time.current) }
+    
+    def self.authenticate(token)
+      active.find_by(access_token: token)
+    end
+
+    private
+    
+    def generate_access_token
+      self.access_token = "sp_#{SecureRandom.hex(24)}"
+    end
+  end
+end

data/app/models/saas_platform/application_record.rb

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

data/app/models/saas_platform/notification.rb

@@ -0,0 +1,19 @@
+module SaasPlatform
+  class Notification < ApplicationRecord
+    acts_as_tenant :account, class_name: 'SaasPlatform::Account'
+    
+    belongs_to :recipient, polymorphic: true
+    
+    scope :unread, -> { where(read_at: nil) }
+    scope :read, -> { where.not(read_at: nil) }
+    scope :recent, -> { order(created_at: :desc) }
+    
+    def read?
+      read_at.present?
+    end
+    
+    def mark_as_read!
+      update!(read_at: Time.current)
+    end
+  end
+end