one-for-all-framework 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1634666412d07dfeae3b9416c7a27b16436ba9d1a03f726df8b245e6f6fe71f7
-  data.tar.gz: 4240f873f851ecfccd556a7b061e2ac3c2020aa26d383b87a217506160c6295b
+  metadata.gz: fd84838fc3bc3f5241aa3d3a701accc2f9bfe8b6bf7303d708319e14ea68fe17
+  data.tar.gz: 5cce2c8ac4cfbc1586f12c5551eec509ef0536a189d7fa901d53dbb7a2d2f25d
 SHA512:
-  metadata.gz: efb0120858fb436c64f1ec7a92433deda88fee6dc1738661af68a0a303d8874cb4f6a5a7f2583a527ad8e9a9188b0e67b16abaf201c205044a421cb2a3780635
-  data.tar.gz: ff176420fce31ecfec8fffcec1862e911d64f8b78478d3a073f3b317bd98fa553df7b9d05fd36b5a0c219582ec1b835a83eb854480cdeb62a624822c2df02170
+  metadata.gz: 4ded6af832ba7cb08647f002f871cebf223057733142d8ac21c241d43fc0a96058e1439f3946195c0b231174e07293de69b08011bf2603cdfa9ddadab4bc93b4
+  data.tar.gz: 43a940c1c4288fbf4b273937bc5725c4418736cc88c525db71b494b4cd45b74b642220cf1fb1ce13766dbed1428653bf6907a1c27be1b2c6cd2fdd376889d18c

data/README.md

@@ -2,7 +2,7 @@
   <img src="public/images/logo.png" width="500" height="500" alt="OFA Framework Logo">
 </p>
 
-# ⚡ One-For-All (OFA) Framework v4.2.0
+# ⚡ One-For-All (OFA) Framework v4.3.0
 
 [![Ruby Version](https://img.shields.io/badge/ruby-%3E%3D%203.0.0-red.svg)](https://www.ruby-lang.org/)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
@@ -21,6 +21,7 @@
 -   **🔐 Enterprise Ready**: Built-in CSRF protection, secure session management, and input validation.
 -   **🌐 Global Support**: Multi-language (I18n) support and SEO optimization ready.
 -   **🖋️ Rich Text Editor**: Integrated Trix Editor for seamless post and page creation with image upload support.
+-   **📡 Modern API**: Built-in JWT support and automated Swagger/OpenAPI documentation.
 
 ---
 
@@ -82,6 +83,8 @@ Boots the high-performance Eksa Server engine.
 ### 🏗️ Generators (Scaffolding)
 #### `ofa g controller NAME`
 *   **Output:** `✅ Created app/controllers/blog_controller.rb`
+#### `ofa g api NAME`
+*   **Output:** `✅ Created app/controllers/shop_controller.rb`
 #### `ofa g model NAME`
 *   **Output:** `✅ Created app/models/product.rb`
 #### `ofa g post TITLE [args]`
@@ -89,6 +92,11 @@ Creates a SEO-optimized blog post with metadata.
 *   **Example:** `./ofa g post "Hello World" --author Antigravity`
 *   **Output:** `✅ Created app/views/posts/hello_world.erb`
 
+### 📡 API & Documentation
+#### `ofa swagger`
+Generates a standards-compliant `openapi.json` file.
+*   **Output:** `✅ Documentation saved to: openapi.json`
+
 ### 📂 Database Management
 #### `ofa db switch TYPE [URL]`
 Switches your database adapter on the fly.
@@ -132,6 +140,7 @@ Securely manages admin credentials.
 | `ofa console` | **Interactive REPL.** Starts a Ruby console pre-loaded with your application environment and models for testing and debugging. |
 | `ofa doctor` | **System Health Check.** Validates `.env` config, database connectivity (SQL/MongoDB), Ruby version, and dependencies. |
 | `ofa routes` | **Route Inspection.** Lists all registered routes in your application in a clean tabular format. |
+| `ofa swagger` | **OpenAPI Generation.** Auto-generates `openapi.json` for your entire application. |
 | `ofa deploy` | **Production Deployment.** Automatically detects deployment targets (Railway/Docker/Git). |
 
 ---
@@ -142,6 +151,7 @@ Automate the creation of boilerplate code with the generator command.
 | Command | Description |
 | :--- | :--- |
 | `ofa g controller NAME` | Creates a new controller in `app/controllers/{name}_controller.rb` with a default `index` action. |
+| `ofa g api NAME` | Creates a JSON-based controller in `app/controllers/{name}_controller.rb` inheriting from `ApiController`. |
 | `ofa g model NAME` | Generates a database model in `app/models/{name}.rb` integrated with the Sequel ORM. |
 | `ofa g migration NAME` | Creates a timestamped migration file in `db/migrations/`. Use this to define your schema changes. |
 | `ofa g post TITLE` | Creates a new Markdown/ERB post in `app/views/posts/`. <br> *Args:* `--category`, `--author`, `--image`. <br> *Example:* `./ofa g post "My First Journey" --category Tech --author "John Doe"` |

data/app/controllers/application_controller.rb

@@ -27,6 +27,10 @@ class ApplicationController
     @res.headers['Location'] = path
   end
 
+  def render_json(data, status: 200)
+    @res.json(data, status: status)
+  end
+
   # Validation Helper
   def validate!(required_params)
     missing = required_params.select { |p| params[p.to_s].nil? || params[p.to_s].empty? }

data/app/middleware/jwt_middleware.rb

@@ -0,0 +1,31 @@
+begin
+  require 'jwt'
+rescue LoadError
+end
+
+class JwtMiddleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    auth_header = env['HTTP_AUTHORIZATION']
+    if auth_header && auth_header.start_with?('Bearer ')
+      token = auth_header.split(' ').last
+      begin
+        secret = ENV['JWT_SECRET'] || 'one-for-all-secret-key'
+        if defined?(JWT)
+          decoded_token = JWT.decode(token, secret, true, { algorithm: 'HS256' })
+          env['current_user_id'] = decoded_token[0]['user_id']
+          env['jwt_payload'] = decoded_token[0]
+        end
+      rescue JWT::DecodeError
+        # If token is invalid, we don't halt here, just don't set current_user_id
+      rescue NameError
+        # JWT not defined
+      end
+    end
+
+    @app.call(env)
+  end
+end

data/app/views/docs.erb

@@ -1,6 +1,6 @@
 <div class="space-y-12 pb-20">
     <div class="text-left">
-        <div class="badge-premium">Documentation v4.2.0</div>
+        <div class="badge-premium">Documentation v4.3.0</div>
         <h1 class="text-5xl font-black tracking-tighter mb-4 text-slate-700 dark:text-white">Framework <span class="text-primary">Guide</span></h1>
         <p class="text-xl text-slate-500 max-w-2xl leading-relaxed">Everything you need to know about building premium web applications with the One-For-All framework.</p>
     </div>
@@ -16,6 +16,8 @@
                 <a href="#routing" class="block px-4 py-2 rounded-xl hover:bg-primary/5 text-slate-600 hover:text-primary transition-all font-semibold border-l-2 border-transparent hover:border-primary">Routing System</a>
                 <a href="#cms" class="block px-4 py-2 rounded-xl hover:bg-primary/5 text-slate-600 hover:text-primary transition-all font-semibold border-l-2 border-transparent hover:border-primary">CMS & Features</a>
                 <a href="#ecommerce" class="block px-4 py-2 rounded-xl hover:bg-primary/5 text-slate-600 hover:text-primary transition-all font-semibold border-l-2 border-transparent hover:border-primary">E-Commerce</a>
+                <a href="#api" class="block px-4 py-2 rounded-xl hover:bg-primary/5 text-slate-600 hover:text-primary transition-all font-semibold border-l-2 border-transparent hover:border-primary">API & Modern Web</a>
+                <a href="#deploy" class="block px-4 py-2 rounded-xl hover:bg-primary/5 text-slate-600 hover:text-primary transition-all font-semibold border-l-2 border-transparent hover:border-primary">Deployment</a>
                 <a href="#deploy" class="block px-4 py-2 rounded-xl hover:bg-primary/5 text-slate-600 hover:text-primary transition-all font-semibold border-l-2 border-transparent hover:border-primary">Deployment</a>
             </nav>
         </aside>
@@ -74,16 +76,24 @@
                                 <td class="px-6 py-4 font-mono text-primary">./ofa routes</td>
                                 <td class="px-6 py-4 text-slate-600 dark:text-slate-400 text-xs">List all registered routes in a clean table.</td>
                             </tr>
-                            <tr>
-                                <td class="px-6 py-4 font-mono text-primary">./ofa deploy</td>
-                                <td class="px-6 py-4 text-slate-600 dark:text-slate-400 text-xs italic">Railway/Docker/Git auto-detection for production.</td>
-                            </tr>
+                             <tr>
+                                 <td class="px-6 py-4 font-mono text-primary">./ofa deploy</td>
+                                 <td class="px-6 py-4 text-slate-600 dark:text-slate-400 text-xs italic">Railway/Docker/Git auto-detection for production.</td>
+                             </tr>
+                             <tr>
+                                 <td class="px-6 py-4 font-mono text-primary">./ofa swagger</td>
+                                 <td class="px-6 py-4 text-slate-600 dark:text-slate-400 text-xs">Generate <code>openapi.json</code> for Swagger UI.</td>
+                             </tr>
 
                             <tr class="bg-slate-500/5"><td colspan="2" class="px-6 py-2 text-[10px] font-black uppercase tracking-tighter text-slate-400">Generators (Scaffolding)</td></tr>
-                            <tr>
-                                <td class="px-6 py-4 font-mono text-primary">./ofa g controller NAME</td>
-                                <td class="px-6 py-4 text-slate-600 dark:text-slate-400">Generates <code>app/controllers/{name}_controller.rb</code>.</td>
-                            </tr>
+                             <tr>
+                                 <td class="px-6 py-4 font-mono text-primary">./ofa g controller NAME</td>
+                                 <td class="px-6 py-4 text-slate-600 dark:text-slate-400">Generates <code>app/controllers/{name}_controller.rb</code>.</td>
+                             </tr>
+                             <tr>
+                                 <td class="px-6 py-4 font-mono text-primary">./ofa g api NAME</td>
+                                 <td class="px-6 py-4 text-slate-600 dark:text-slate-400 text-xs">JSON-based controller inheriting from ApiController.</td>
+                             </tr>
                             <tr>
                                 <td class="px-6 py-4 font-mono text-primary">./ofa g model NAME</td>
                                 <td class="px-6 py-4 text-slate-600 dark:text-slate-400">Creates model & migration linked to Sequel/NoSQL.</td>
@@ -310,6 +320,36 @@ resources :posts
                 </div>
             </section>
 
+            <!-- API & Modern Web -->
+            <section id="api" class="glass-panel p-8 md:p-12 text-left bg-gradient-to-br from-primary/10 to-transparent">
+                <h2 class="text-3xl font-black tracking-tight mb-6 flex items-center gap-3">
+                    <i class="fas fa-network-wired text-primary"></i> API & Modern Web
+                </h2>
+                <div class="markdown-content space-y-8">
+                    <div>
+                        <h4 class="font-bold text-lg mb-2">📡 JSON API Support</h4>
+                        <p class="text-sm text-slate-600 dark:text-slate-400">Build high-performance backends for mobile apps or SPAs. OFA provides a specialized <code>ApiController</code> and JSON rendering helpers.</p>
+                        <div class="p-4 bg-white/5 border border-white/10 rounded-2xl mt-4 font-mono text-sm">
+                            ./ofa g api order
+                        </div>
+                    </div>
+
+                    <div>
+                        <h4 class="font-bold text-lg mb-2">🔐 JWT Authentication</h4>
+                        <p class="text-sm text-slate-600 dark:text-slate-400">Decoupled frontends require token-based auth. OFA automatically generates a <code>JWT_SECRET</code> during initialization and includes a <code>JwtMiddleware</code> to verify incoming requests.</p>
+                        <p class="text-[10px] text-slate-500 mt-2 italic">Note: Tokens are expected in the 'Authorization: Bearer <TOKEN>' header.</p>
+                    </div>
+
+                    <div>
+                        <h4 class="font-bold text-lg mb-2">📝 Swagger/OpenAPI Documentation</h4>
+                        <p class="text-sm text-slate-600 dark:text-slate-400">Keep your API documentation in sync with your code. The <code>ofa swagger</code> command scans your routes and generates a <code>openapi.json</code> file.</p>
+                        <div class="p-4 bg-white/5 border border-white/10 rounded-2xl mt-4 font-mono text-sm">
+                            ./ofa swagger
+                        </div>
+                    </div>
+                </div>
+            </section>
+
             <!-- Deployment -->
             <section id="deploy" class="glass-panel p-8 md:p-12 text-left border-primary/20">
                 <h2 class="text-3xl font-black tracking-tight mb-6 flex items-center gap-3">

data/app/views/index.erb

@@ -1,6 +1,6 @@
 <div class="text-center space-y-6 max-w-2xl mx-auto py-12">
     <div class="inline-flex items-center px-4 py-1.5 rounded-full bg-primary/10 border border-primary/20 text-primary text-xs font-bold uppercase tracking-wider animate-pulse">
-        Framework Version 4.2.0
+        Framework Version 4.3.0
     </div>
     
     <h1 class="text-5xl md:text-7xl font-black tracking-tight leading-tight">

data/bin/ofa

@@ -22,7 +22,7 @@ def help
   puts "  / __ \\/ ____/  /   |                      "
   puts " / / / / /_     / /| |  Framework           "
   puts "/ /_/ / __/    / ___ |  Premium MVC         "
-  puts "\\____/_/      /_/  |_|  v4.2.0              "
+  puts "\\____/_/      /_/  |_|  v4.3.0              "
   puts "                                            "
   puts "✨ One-For-All Framework CLI ✨"
   puts "-----------------------------"
@@ -30,6 +30,7 @@ def help
   puts "  ofa new NAME [TYPE]   - Create a new project + automatic bundle install"
   puts "  ofa init [TYPE]       - Initialize project in current folder"
   puts "  ofa g controller NAME - Generate a new controller"
+  puts "  ofa g api NAME        - Generate a new API controller (JSON)"
   puts "  ofa g model NAME      - Generate a new model"
   puts "  ofa g migration NAME  - Generate a new migration"
   puts "  ofa g post TITLE      - Create a new post [args: --category, --author, --image]"
@@ -45,6 +46,7 @@ def help
   puts "  ofa console           - Start interactive REPL session"
   puts "  ofa doctor            - Check system health (DB, config, gems)"
   puts "  ofa routes            - List all registered routes"
+  puts "  ofa swagger           - Auto-generate OpenAPI/Swagger documentation"
   puts "  ofa run               - Start the application server"
   puts "  ofa deploy            - Deploy project to production"
   puts "-----------------------------"
@@ -229,7 +231,7 @@ when 'init'
   puts "  / __ \\/ ____/  /   |                      "
   puts " / / / / /_     / /| |  Framework           "
   puts "/ /_/ / __/    / ___ |  Premium MVC         "
-  puts "\\____/_/      /_/  |_|  v4.2.0              "
+  puts "\\____/_/      /_/  |_|  v4.3.0              "
   puts "                                            "
   puts "Initializing One-For-All project as '#{app_type}' in #{PROJECT_ROOT}..."
 
@@ -277,6 +279,7 @@ when 'init'
   env_content << "EKS_ENV=development"
   env_content << "DATABASE_URL=#{db_url}" if db_type == 'mongodb'
   env_content << "CLOUDINARY_URL=#{cloudinary_url}" if img_storage == 'cloudinary'
+  env_content << "JWT_SECRET=#{Array.new(32){[*'0'..'9',*'a'..'z',*'A'..'Z'].sample}.join}"
   File.write(File.join(PROJECT_ROOT, '.env'), env_content.join("\n"))
 
   # Create config.ru
@@ -294,6 +297,7 @@ when 'init'
     use EksCent::Middleware::ShowExceptions
     use EksCent::Middleware::Session, secret: EksCent.secret_key_base
     use AuthMiddleware
+    use JwtMiddleware
     use CSRFMiddleware
     use EksCent::Middleware::Static, root: 'public'
     use EksCent::Middleware::Logger
@@ -463,11 +467,38 @@ when 'g'
       class #{class_name} < ApplicationController
         def index
           # Logic for #{name}
+          render_json({ message: "Welcome to #{class_name}" })
         end
       end
     RUBY
     File.write(file_name, content)
     puts "Created: #{file_name}"
+  elsif sub == 'api' && name
+    class_name = name.capitalize + "Controller"
+    file_name = File.join(PROJECT_ROOT, "app/controllers/#{name.downcase}_controller.rb")
+    content = <<~RUBY
+      require_relative 'api_controller'
+
+      class #{class_name} < ApiController
+        # GET /api/#{name.downcase}
+        def index
+          render_json({ 
+            status: 'success', 
+            message: "API endpoint for #{name} ready",
+            data: [] 
+          })
+        end
+
+        # POST /api/#{name.downcase}
+        def create
+          # TODO: Implement creation logic
+          render_json({ status: 'success', message: "#{name} created" }, status: 201)
+        end
+      end
+    RUBY
+    File.write(file_name, content)
+    puts "Created API Controller: #{file_name}"
+    puts "💡 Don't forget to register it in config/routes.rb"
   elsif sub == 'model' && name
     class_name = name.capitalize
     file_name = File.join(PROJECT_ROOT, "app/models/#{name.downcase}.rb")
@@ -702,7 +733,7 @@ when 'console'
   puts "  / __ \\/ ____/  /   |                      "
   puts " / / / / /_     / /| |  Framework           "
   puts "/ /_/ / __/    / ___ |  Console (REPL)      "
-  puts "\\____/_/      /_/  |_|  v4.2.0              "
+  puts "\\____/_/      /_/  |_|  v4.3.0              "
   puts "                                            "
   puts "✨ Loading environment... (Type 'exit' to quit)"
   
@@ -736,6 +767,53 @@ when 'routes'
   end
   puts "--------------------------------------------------------"
 
+when 'swagger'
+  ensure_initialized!
+  puts "📝 Generating OpenAPI 3.0 documentation..."
+  
+  Object.const_set(:APP_ROOT, PROJECT_ROOT) unless defined?(APP_ROOT)
+  ENV['EKS_ENV'] = 'test'
+  require File.join(FRAMEWORK_ROOT, 'config', 'boot')
+  
+  openapi = {
+    openapi: "3.0.0",
+    info: {
+      title: "#{File.basename(PROJECT_ROOT)} API",
+      version: "1.0.0",
+      description: "Auto-generated by One-For-All Framework"
+    },
+    paths: {}
+  }
+  
+  if defined?(ROUTES)
+    routes_hash = ROUTES.instance_variable_get(:@routes)
+    routes_hash.each do |verb, list|
+      list.each do |r|
+        path = r[:path].gsub(/:(\w+)/, '{\1}') # Convert :id to {id}
+        openapi[:paths][path] ||= {}
+        openapi[:paths][path][verb.to_s.downcase] = {
+          summary: "Endpoint for #{path}",
+          responses: {
+            "200" => { description: "Successful response" }
+          }
+        }
+        
+        # Add parameters if dynamic path
+        if path.include?('{')
+          params = path.scan(/\{(\w+)\}/).flatten
+          openapi[:paths][path][verb.to_s.downcase][:parameters] = params.map do |p|
+            { name: p, in: "path", required: true, schema: { type: "string" } }
+          end
+        end
+      end
+    end
+  end
+  
+  output_path = File.join(PROJECT_ROOT, 'openapi.json')
+  File.write(output_path, JSON.pretty_generate(openapi))
+  puts "✅ Documentation saved to: #{output_path}"
+  puts "💡 You can paste this into https://editor.swagger.io to view it."
+
 when 'run'
   ensure_initialized!
   # Check for config.ru

data/config/boot.rb

@@ -4,6 +4,10 @@ Bundler.require(:default)
 require 'eks-cent'
 require 'json'
 require 'kramdown'
+begin
+  require 'jwt'
+rescue LoadError
+end
 
 # Basic project structure constants
 APP_ROOT ||= File.expand_path('..', __dir__)
@@ -75,6 +79,12 @@ module EksCent
       @headers['Content-Type'] ||= 'text/html'
       @body << result
     end
+
+    def json(data, status: 200)
+      @status = status
+      @headers['Content-Type'] = 'application/json'
+      @body << data.to_json
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: one-for-all-framework
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Ishikawa Uta
@@ -169,6 +169,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
 description: One-For-All is a high-performance Ruby web framework built for speed
   and aesthetics. It features a built-in CMS, premium Glassmorphism design, and supports
   multiple databases including SQLite, MySQL, and MongoDB.
@@ -198,6 +212,7 @@ files:
 - app/helpers/cloudinary_helper.rb
 - app/middleware/auth_middleware.rb
 - app/middleware/csrf_middleware.rb
+- app/middleware/jwt_middleware.rb
 - app/models/page.rb
 - app/models/post.rb
 - app/models/product.rb