rails_jwt_admin 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2f5f5a86b728dd53e5e8818c0c717d125eb3e1c0e65afb3762e6d1785010e60
-  data.tar.gz: 0ea73870bb73f4ebf65cd4457ccd5d99f087c2ea4c49f5d8d07bf74a54d0083c
+  metadata.gz: 12e5b16df86e414638bf8f1ddc1f99caa51c243a89edf567ce3434954b711e4d
+  data.tar.gz: 1b7f6b9d4423e633b227998ff60afafe894086dcfb90d6374cf413f3eb048c4c
 SHA512:
-  metadata.gz: 805b8f195f3a53f81930de9f5b9bf782fa4d763e1ff4700e5a7470a627d97c61e4e50126a2b4d6cf5e012785d895d2293ed448e2a92bfb8078ef24f78b33a7b6
-  data.tar.gz: 1fae5650da230718930586ad7e4b2604287f2bf60565011dcbfdff7e67641ae47e9a8ed47a52a73420e22f32bc9eb57c645e1d0d45180961fd9dd4f3f501ec6f
+  metadata.gz: aed76e5d45e8ab3ab6d6b504c8d3169c0b44ccf4ecae6813716a5bdd08ab9b5d17f26ee28a7e3bcd36012a6185ee34593e990a5deadde037a449e629d1e80d09
+  data.tar.gz: ac93744aa679de8942ef3c49350370cc855d547e078d5a3c2f1f417e2f02cd14cc1547bbcebd495efcda8f9b4d62eae5b375d4a9b85a48809138a5ac0f6c21e7

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2020 afeiship
+Copyright aric.zheng
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,33 +1,128 @@
-# rails_jwt_admin
-> Jwt for rails admin.
+# RailsJwtAdmin
+> JWT-based authentication system for Rails admin panel.
 
-## installation
-```shell
-# 1. add gen & bundle install
-gem 'rails_jwt_admin'
+## Features
+- JWT token-based authentication
+- Admin user management
+- Secure API responses with consistent format
+- Easy installation and configuration
 
-# 2. install admin
+## Installation
+
+1. Add the required gems to your Gemfile(If not already added):
+```ruby
+# decode/encode methods
+gem "jwt"
+gem "bcrypt"
+
+# normalize response
+gem "rails_warp"
+gem "rails_jwt_admin"
+```
+
+2. Run bundle install:
+```bash
+bundle install
+```
+
+3. Install the admin:
+```bash
 rails g rails_jwt_admin:install
+```
 
-# 3. check table & rake db:migrate
-rake db:migrate
+4. Run database migration:
+```bash
+rails db:migrate
 ```
 
-## seed
-```rb
+## Configuration
+
+1. Generate and edit your application credentials:
+```bash
+EDITOR=vim rails credentials:edit
+```
+
+2. Add your JWT secret key:
+```yaml
+jwt_secret: "your_secret_key_here"
+```
+
+## Setup Admin User
+
+Create an initial admin user:
+```ruby
 RailsJwtAdmin::User.create(
-    username: "admin", 
-    email: "example@qq.com", 
-    password: "123123", 
-    password_confirmation: "123123"
+  username: "admin", 
+  email: "admin@example.com", 
+  password: "your_secure_password", 
+  password_confirmation: "your_secure_password"
 )
 ```
 
-## resources
-- https://edgeapi.rubyonrails.org/classes/Rails/Engine.html
-- https://guides.rubyonrails.org/engines.html
-- https://www.jianshu.com/p/56467f890516
-- https://www.pluralsight.com/guides/token-based-authentication-with-ruby-on-rails-5-api
-- https://github.com/jwt/ruby-jwt
-- https://github.com/afeiship/rails-module-jwt
-- https://github.com/afeiship/rails_admin_users
+## API Usage
+- POST `/rails_jwt_admin/auth` - Authenticate and get token
+- GET `/rails_jwt_admin/me` - Get current user info
+
+### Authentication
+Send POST request to `/rails_jwt_admin/auth` with:
+- `username` - Admin username
+- `password` - Admin password
+
+### Response Format
+Successful authentication returns:
+```json
+{
+  "success": true,
+  "code": 200,
+  "message": null,
+  "data": {
+    "token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxfQ..."
+  }
+}
+```
+
+Get current user returns:
+```json
+{
+  "success": true,
+  "code": 200,
+  "message": null,
+  "data": {
+    "id": 1,
+    "username": "admin",
+    "email": "example@qq.com"
+  }
+}
+```
+
+Failed authentication returns:
+```json
+{
+  "success": false,
+  "code": 401,
+  "message": "Authentication failed",
+  "data": null
+}
+```
+
+### Authorization
+Include the token in your requests using the Authorization header:
+```
+Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxfQ...
+```
+
+## Security Considerations
+
+- Use a strong, unique JWT secret key
+- Consider token expiration times for security
+- Store sensitive credentials using Rails encrypted credentials
+- Regularly update dependencies for security patches
+- Follow Rails security best practices for session management and CSRF protection
+
+## Development Resources
+- [Rails Engines Guide](https://guides.rubyonrails.org/engines.html)
+- [JWT Ruby Implementation](https://github.com/jwt/ruby-jwt)
+- [Rails Security Guide](https://guides.rubyonrails.org/security.html)
+
+## License
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,32 +1,6 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'RailsJwtAdmin'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require "bundler/setup"
 
 APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load 'rails/tasks/engine.rake'
-
-load 'rails/tasks/statistics.rake'
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
+load "rails/tasks/engine.rake"
 
-task default: :test
+require "bundler/gem_tasks"

data/app/controllers/rails_jwt_admin/application_controller.rb

@@ -13,8 +13,9 @@ module RailsJwtAdmin
 
     private
 
-    def render_failed(messages = ["Authenticate failed."])
-      render json: { errors: messages }, status: :unauthorized
+    def render_failed(message = "Authenticate failed.")
+      # render json: { errors: messages }, status: :unauthorized
+      fail(message: message, code: 401)
     end
 
     def http_token

data/app/controllers/rails_jwt_admin/authentication_controller.rb

@@ -4,9 +4,11 @@ module RailsJwtAdmin
   class AuthenticationController < ApplicationController
     def create
       if user = User.find_by(username: params[:username]).try(:authenticate, params[:password])
-        render json: user.token
+        # render json: user.token
+        ok(data: user.token)
       else
-        render json: { errors: ["Username or password error."] }, status: :unauthorized
+        # render json: { errors: ["Username or password error."] }, status: :unauthorized
+        fail(errors: ["Username or password error."], code: 401)
       end
     end
   end

data/app/controllers/rails_jwt_admin/users_controller.rb

@@ -4,8 +4,10 @@ module RailsJwtAdmin
   class UsersController < ApplicationController
     before_action :authenticate!
 
-    def profile
-      render json: current_user.to_json
+    # 取当前用户信息
+    def me
+      data = current_user.as_json(only: [:id, :username, :email])
+      ok(data: data)
     end
   end
 end

data/config/routes.rb

@@ -1,4 +1,4 @@
 RailsJwtAdmin::Engine.routes.draw do
-  get "profile", to: "users#profile"
-  resources :authentication, only: :create
+  post "auth", to: "authentication#create"
+  get "me", to: "users#me"
 end

data/db/migrate/20201202013006_create_rails_jwt_admin_users.rb

@@ -1,11 +1,12 @@
 class CreateRailsJwtAdminUsers < ActiveRecord::Migration[6.0]
   def change
     create_table :rails_jwt_admin_users do |t|
-      t.string :username
-      t.string :email
-      t.string :password_digest
+      t.string :username, null: false, index: { unique: true }
+      t.string :email, null: false, index: { unique: true }
+      t.string :password_digest, null: false
 
       t.timestamps
     end
+
   end
-end
+end

data/lib/generators/rails_jwt_admin/install_generator.rb

@@ -9,10 +9,5 @@ module RailsJwtAdmin
     def create_routes
       route 'mount RailsJwtAdmin::Engine => "/rails_jwt_admin"'
     end
-
-    def add_gems
-      gem "jwt"
-      gem "bcrypt"
-    end
   end
 end

data/lib/rails_jwt_admin/version.rb

@@ -1,3 +1,3 @@
 module RailsJwtAdmin
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/vendors/token.rb

@@ -2,12 +2,16 @@ require "rails_jwt_admin/engine"
 
 module RailsJwtAdmin
   class Token
+    def self.secret_key
+      Rails.application.credentials.jwt_secret
+    end
+
     def self.encode(payload)
-      JWT.encode(payload, Rails.application.secrets.secret_key_base)
+      JWT.encode(payload, secret_key, 'HS256')
     end
 
     def self.decode(token)
-      HashWithIndifferentAccess.new(JWT.decode(token, Rails.application.secrets.secret_key_base)[0])
+      HashWithIndifferentAccess.new(JWT.decode(token, secret_key, 'HS256')[0])
     rescue
       nil
     end

metadata

@@ -1,30 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: rails_jwt_admin
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
-- afeiship
-autorequire: 
+- aric.zheng
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2026-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails_warp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - 1290657123@qq.com
 executables: []
@@ -51,7 +93,7 @@ homepage: https://github.com/afeiship/rails_jwt_admin
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -66,8 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Summary of RailsJwtAdmin.
 test_files: []