JSONAPI Authorization 项目教程

JSONAPI Authorization 项目教程

jsonapi-authorizationAuthorization for JSONAPI::Resource项目地址:https://gitcode.com/gh_mirrors/js/jsonapi-authorization

1. 项目的目录结构及介绍

JSONAPI Authorization 项目的目录结构如下：

jsonapi-authorization/
├── bin/
├── lib/
│   ├── jsonapi/authorization/
│   │   ├── authorizer.rb
│   │   ├── configuration.rb
│   │   ├── pundit_authorizer.rb
│   │   └── version.rb
│   └── jsonapi-authorization.rb
├── spec/
│   ├── fixtures/
│   ├── integration/
│   ├── support/
│   └── spec_helper.rb
├── .gitignore
├── .rspec
├── .rubocop.yml
├── .travis.yml
├── CHANGELOG.md
├── Gemfile
├── LICENSE.md
├── README.md
├── Rakefile
└── jsonapi-authorization.gemspec

目录结构介绍

• bin/: 包含项目的可执行文件。
• lib/: 包含项目的主要代码文件。
  • jsonapi/authorization/: 包含授权相关的核心文件。
    • authorizer.rb: 定义了授权器的基本接口。
    • configuration.rb: 配置文件，用于设置授权相关的选项。
    • pundit_authorizer.rb: 使用 Pundit 进行授权的具体实现。
    • version.rb: 定义了项目的版本号。
  • jsonapi-authorization.rb: 项目的主文件，负责加载其他文件。
• spec/: 包含项目的测试文件。
  • fixtures/: 测试数据。
  • integration/: 集成测试。
  • support/: 测试支持文件。
  • spec_helper.rb: 测试辅助文件。
• .gitignore: Git 忽略文件列表。
• .rspec: RSpec 配置文件。
• .rubocop.yml: RuboCop 代码风格检查配置文件。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 变更日志。
• Gemfile: 依赖管理文件。
• LICENSE.md: 许可证文件。
• README.md: 项目说明文件。
• Rakefile: Rake 任务文件。
• jsonapi-authorization.gemspec: 项目 gem 的规范文件。

2. 项目的启动文件介绍

项目的启动文件是 lib/jsonapi-authorization.rb，它负责加载项目的主要代码文件。以下是该文件的内容概述：

require "jsonapi/authorization/version"
require "jsonapi/authorization/configuration"
require "jsonapi/authorization/authorizer"
require "jsonapi/authorization/pundit_authorizer"

module JSONAPI
  module Authorization
    # 项目初始化代码
  end
end

启动文件介绍

• require "jsonapi/authorization/version": 加载版本号文件。
• require "jsonapi/authorization/configuration": 加载配置文件。
• require "jsonapi/authorization/authorizer": 加载授权器接口文件。
• require "jsonapi/authorization/pundit_authorizer": 加载 Pundit 授权实现文件。
• module JSONAPI::Authorization: 定义了项目的主模块。

3. 项目的配置文件介绍

项目的配置文件是 lib/jsonapi/authorization/configuration.rb，它定义了项目的配置选项。以下是该文件的内容概述：

module JSONAPI
  module Authorization
    class Configuration
      attr_accessor :authorizer_class, :pundit_user

      def initialize
        @authorizer_class = JSONAPI::Authorization::PunditAuthorizer
        @pundit_user = :user
      end
    end

    def self.configuration
      @configuration ||= Configuration.new
    end

    def self.configure
      yield configuration
    end
  end
end

配置文件介绍

• attr_accessor :authorizer_class, :pundit_user: 定义了可配置的选项。
  • authorizer_class: 授权器的类名，默认为 JSONAPI::Authorization::PunditAuthorizer。
  • pundit_user: Pundit 用户对象的名称，默认为 :user。

jsonapi-authorizationAuthorization for JSONAPI::Resource项目地址:https://gitcode.com/gh_mirrors/js/jsonapi-authorization