casdoor-ruby-sdk 1.0.0 → 1.1.0

data/lib/casdoor/util_modify.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Copyright 2026 The Casdoor Authors. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Casdoor
+  # The helpers shared by the APIs of the objects, the counterpart of util_modify.go of the Go SDK
+  class Client
+    private
+
+    def get_objects(action, klass, query_map)
+      (do_get_bytes(get_url(action, query_map)) || []).map { |item| klass.new(item) }
+    end
+
+    # Returns the objects of the page and the total count
+    def get_pagination_objects(action, klass, owner, page, page_size, query_map)
+      query = to_query_map(query_map).merge('owner' => owner, 'p' => page.to_s, 'pageSize' => page_size.to_s)
+      response = do_get_response(get_url(action, query))
+      [(response['data'] || []).map { |item| klass.new(item) }, response['data2'].to_i]
+    end
+
+    def get_object(action, klass, query_map)
+      data = do_get_bytes(get_url(action, query_map))
+      data && klass.new(data)
+    end
+
+    # Posts the object to an add/update/delete API, and returns whether the object is affected. The owner of the
+    # object defaults to default_owner, and columns limits the updated fields. Most APIs answer "Affected" or
+    # "Unaffected", while some (e.g. update-model) answer only "ok" when they succeed.
+    def modify_object(action, klass, object, default_owner, columns = nil, query_map = {})
+      object = to_entity(klass, object)
+      object.owner = default_owner if object.owner.to_s.empty?
+
+      query = { 'id' => object.get_id }.merge(query_map)
+      if columns && !columns.empty?
+        query['columns'] = columns.map do |column|
+          column.is_a?(Symbol) ? Entity.camelize(column) : column
+        end.join(',')
+      end
+      do_post(action, query, object)['data'] != 'Unaffected'
+    end
+
+    def to_entity(klass, object)
+      object.is_a?(Entity) ? object : klass.new(object)
+    end
+
+    # Symbol keys are snake_case, e.g. sort_field: "name", while String keys are the names of Casdoor
+    def to_query_map(query_map)
+      (query_map || {}).each_with_object({}) do |(key, value), query|
+        query[key.is_a?(Symbol) ? Entity.camelize(key) : key.to_s] = value
+      end
+    end
+  end
+end

data/lib/casdoor/version.rb

@@ -16,5 +16,5 @@
 
 module Casdoor
   # Set by semantic-release in CI when a new version is released, see .releaserc.json
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/casdoor/webhook.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Copyright 2026 The Casdoor Authors. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Casdoor
+  class Webhook < Entity; end
+
+  # The webhook APIs, the counterpart of webhook.go of the Go SDK
+  class Client
+    def get_webhooks
+      get_objects('get-webhooks', Webhook, 'owner' => organization_name)
+    end
+
+    # Returns the objects of the page and the total count. query_map can filter and sort them, e.g.
+    # { field: "name", value: "alice", sort_field: "created_time", sort_order: "descend" }
+    def get_pagination_webhooks(page, page_size, query_map = {})
+      get_pagination_objects('get-webhooks', Webhook, organization_name, page, page_size, query_map)
+    end
+
+    def get_webhook(name)
+      get_object('get-webhook', Webhook, 'id' => get_id(name))
+    end
+
+    def update_webhook(webhook)
+      modify_object('update-webhook', Webhook, webhook, organization_name)
+    end
+
+    def add_webhook(webhook)
+      modify_object('add-webhook', Webhook, webhook, organization_name)
+    end
+
+    def delete_webhook(webhook)
+      modify_object('delete-webhook', Webhook, webhook, organization_name)
+    end
+  end
+end

data/lib/casdoor.rb

@@ -17,8 +17,16 @@
 require_relative 'casdoor/version'
 require_relative 'casdoor/error'
 require_relative 'casdoor/entity'
-require_relative 'casdoor/api/auth'
-require_relative 'casdoor/api/crud'
-require_relative 'casdoor/api/users'
-require_relative 'casdoor/api/enforce'
-require_relative 'casdoor/client'
+require_relative 'casdoor/auth'
+require_relative 'casdoor/util'
+require_relative 'casdoor/util_modify'
+
+# The files of the APIs, the same as the casdoorsdk package of the Go SDK
+%w[
+  adapter application cert email enforce enforcer group invitation jwt ldap logout mfa model notification order
+  order_pay organization payment permission plan policy pricing product provider record resource role session sms
+  subscription syncer token transaction url user webhook
+].each { |file| require_relative "casdoor/#{file}" }
+
+# Must be the last, it delegates all the methods of Client to the module
+require_relative 'casdoor/global'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: casdoor-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yang Luo
@@ -42,14 +42,49 @@ files:
 - README.md
 - lib/casdoor-ruby-sdk.rb
 - lib/casdoor.rb
-- lib/casdoor/api/auth.rb
-- lib/casdoor/api/crud.rb
-- lib/casdoor/api/enforce.rb
-- lib/casdoor/api/users.rb
-- lib/casdoor/client.rb
+- lib/casdoor/adapter.rb
+- lib/casdoor/application.rb
+- lib/casdoor/auth.rb
+- lib/casdoor/cert.rb
+- lib/casdoor/email.rb
+- lib/casdoor/enforce.rb
+- lib/casdoor/enforcer.rb
 - lib/casdoor/entity.rb
 - lib/casdoor/error.rb
+- lib/casdoor/global.rb
+- lib/casdoor/group.rb
+- lib/casdoor/invitation.rb
+- lib/casdoor/jwt.rb
+- lib/casdoor/ldap.rb
+- lib/casdoor/logout.rb
+- lib/casdoor/mfa.rb
+- lib/casdoor/model.rb
+- lib/casdoor/notification.rb
+- lib/casdoor/order.rb
+- lib/casdoor/order_pay.rb
+- lib/casdoor/organization.rb
+- lib/casdoor/payment.rb
+- lib/casdoor/permission.rb
+- lib/casdoor/plan.rb
+- lib/casdoor/policy.rb
+- lib/casdoor/pricing.rb
+- lib/casdoor/product.rb
+- lib/casdoor/provider.rb
+- lib/casdoor/record.rb
+- lib/casdoor/resource.rb
+- lib/casdoor/role.rb
+- lib/casdoor/session.rb
+- lib/casdoor/sms.rb
+- lib/casdoor/subscription.rb
+- lib/casdoor/syncer.rb
+- lib/casdoor/token.rb
+- lib/casdoor/transaction.rb
+- lib/casdoor/url.rb
+- lib/casdoor/user.rb
+- lib/casdoor/util.rb
+- lib/casdoor/util_modify.rb
 - lib/casdoor/version.rb
+- lib/casdoor/webhook.rb
 homepage: https://github.com/casdoor/casdoor-ruby-sdk
 licenses:
 - Apache-2.0

data/lib/casdoor/api/auth.rb

@@ -1,153 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2026 The Casdoor Authors. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-require 'jwt'
-require 'openssl'
-
-module Casdoor
-  module Api
-    # Signing users in with OAuth 2.0 / OIDC, and verifying the JWT tokens issued by Casdoor.
-    #
-    # The OAuth tokens are returned as the hashes of the Casdoor token API, e.g.
-    #   {"access_token" => "...", "id_token" => "...", "refresh_token" => "...", "token_type" => "Bearer",
-    #    "expires_in" => 604800, "scope" => "read"}
-    module Auth
-      JWT_ALGORITHMS = %w[RS256 RS384 RS512 ES256 ES384 ES512 PS256 PS384 PS512].freeze
-
-      # The URL of the sign-in page that the browser is redirected to. After signing in, Casdoor redirects back to
-      # redirect_uri with "code" and "state" in the query, and the code is exchanged with get_oauth_token.
-      def get_signin_url(redirect_uri, state: application_name, scope: 'read')
-        query = { 'client_id' => client_id, 'response_type' => 'code', 'redirect_uri' => redirect_uri,
-                  'scope' => scope, 'state' => state }
-        "#{endpoint}/login/oauth/authorize?#{URI.encode_www_form(query)}"
-      end
-
-      # The URL of the sign-up page. Without redirect_uri, it's the plain sign-up page of the application, otherwise
-      # the user is signed in and redirected back to redirect_uri like get_signin_url.
-      def get_signup_url(redirect_uri = nil, state: application_name, scope: 'read')
-        return "#{endpoint}/signup/#{application_name}" if redirect_uri.nil?
-
-        url = get_signin_url(redirect_uri, state: state, scope: scope)
-        url.sub('/login/oauth/authorize', '/signup/oauth/authorize')
-      end
-
-      def get_user_profile_url(user_name, access_token = nil)
-        url = "#{endpoint}/users/#{organization_name}/#{user_name}"
-        access_token ? "#{url}?#{URI.encode_www_form('access_token' => access_token)}" : url
-      end
-
-      def get_my_profile_url(access_token = nil)
-        url = "#{endpoint}/account"
-        access_token ? "#{url}?#{URI.encode_www_form('access_token' => access_token)}" : url
-      end
-
-      # Exchanges the code that Casdoor passed to the redirect URI for the OAuth tokens
-      def get_oauth_token(code)
-        request_oauth_token('authorization_code', 'code' => code)
-      end
-
-      def refresh_oauth_token(refresh_token, scope: nil)
-        request_oauth_token('refresh_token', 'refresh_token' => refresh_token, 'scope' => scope)
-      end
-
-      # The "password" grant type, it must be enabled in the "Grant types" of the application in Casdoor.
-      # username is the user's name in the application's organization, like "alice".
-      def get_oauth_token_by_password(username, password)
-        request_oauth_token('password', 'username' => username, 'password' => password)
-      end
-
-      # A token of the application itself, the "client_credentials" grant type must be enabled in the application
-      def get_oauth_token_by_client_credentials
-        request_oauth_token('client_credentials')
-      end
-
-      # Verifies a JWT token (the access token or the ID token) with the certificate of the client, and returns its
-      # claims. The token must not be expired, and must be issued to this application: pass audience: to check a
-      # different audience (e.g. the resource of RFC 8707), or audience: false to skip the check.
-      #
-      #   claims = client.parse_jwt_token(token["access_token"])
-      #   claims.name          # => "alice"
-      #   claims.owner         # => "casbin"
-      #   claims.user          # => Casdoor::User
-      def parse_jwt_token(token, audience: nil)
-        # The expiration and the "not before" time are verified by default
-        payload, = JWT.decode(token, jwt_public_key, true, algorithms: JWT_ALGORITHMS)
-        check_audience(payload['aud'], audience) unless audience == false
-        Claims.new(payload)
-      rescue JWT::DecodeError => e
-        raise InvalidTokenError, e.message
-      end
-
-      # Asks Casdoor whether the token is active, see RFC 7662. Returns a hash like {"active" => true, ...}.
-      def introspect_token(token, token_type_hint: 'access_token')
-        request = Net::HTTP::Post.new(get_url('login/oauth/introspect'))
-        request.set_form_data('token' => token, 'token_type_hint' => token_type_hint)
-        check_oauth_response(send_request(request))
-      end
-
-      # Signs the user out of Casdoor, from all their sessions or only the session of the access token
-      def logout(access_token, all_sessions: true)
-        with_access_token(access_token).post_form('sso-logout', { 'logoutAll' => all_sessions }, {})
-        true
-      end
-
-      private
-
-      def request_oauth_token(grant_type, params = {})
-        form = { 'grant_type' => grant_type, 'client_id' => client_id, 'client_secret' => client_secret }
-        form.merge!(params.compact)
-
-        request = Net::HTTP::Post.new(get_url('login/oauth/access_token'))
-        request.set_form_data(form)
-        token = check_oauth_response(send_request(request, auth: false))
-
-        # Older Casdoor versions put the error into the access token
-        if token['access_token'].to_s.start_with?('error:')
-          raise ApiError, token['access_token'].delete_prefix('error:').strip
-        end
-
-        token
-      end
-
-      def check_oauth_response(body)
-        if body['error']
-          message = [body['error'], body['error_description']].compact.reject(&:empty?).join(': ')
-          raise ApiError, message
-        end
-
-        check_response(body)
-      end
-
-      def jwt_public_key
-        pem = certificate.to_s
-        raise Error, 'The certificate of the client is required to parse JWT tokens' if pem.strip.empty?
-
-        pem.include?('CERTIFICATE') ? OpenSSL::X509::Certificate.new(pem).public_key : OpenSSL::PKey.read(pem)
-      end
-
-      # Casdoor issues the tokens to the client ID, or to "<client ID>-org-<organization>" for shared applications
-      def check_audience(aud, audience)
-        auds = Array(aud)
-        valid = if audience
-                  auds.include?(audience)
-                else
-                  auds.any? { |item| item == client_id || item.to_s.start_with?("#{client_id}-org-") }
-                end
-        raise InvalidTokenError, "The token is issued to #{auds.inspect}, not this application" unless valid
-      end
-    end
-  end
-end

data/lib/casdoor/api/crud.rb

@@ -1,122 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2026 The Casdoor Authors. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module Casdoor
-  module Api
-    # The add/get/update/delete APIs that all the Casdoor objects share. For each object, e.g. the user, it defines:
-    #
-    #   get_users(**query)                         # => [User]
-    #   get_pagination_users(page, page_size, **query) # => [[User], total count]
-    #   get_user(name)                             # => User or nil, name can be "name" or "owner/name"
-    #   add_user(user)                             # => true if added
-    #   update_user(user, columns: nil)            # => true if changed, columns limits the updated fields
-    #   delete_user(user_or_name)                  # => true if deleted
-    #
-    # The objects belong to the client's organization, except the ones in ADMIN_OWNED, which belong to "admin".
-    # A different owner can be passed with "owner/name", the owner field of the object, or owner: in the query.
-    # Extra query parameters of the list APIs can be passed in snake_case, e.g. get_users(sort_field: "name").
-    module Crud
-      OBJECTS = {
-        adapter: Adapter,
-        application: Application,
-        cert: Cert,
-        enforcer: Enforcer,
-        group: Group,
-        invitation: Invitation,
-        model: Model,
-        order: Order,
-        organization: Organization,
-        payment: Payment,
-        permission: Permission,
-        plan: Plan,
-        pricing: Pricing,
-        product: Product,
-        provider: Provider,
-        resource: Resource,
-        role: Role,
-        subscription: Subscription,
-        syncer: Syncer,
-        token: Token,
-        transaction: Transaction,
-        user: User,
-        webhook: Webhook
-      }.freeze
-
-      ADMIN_OWNED = %i[application organization token].freeze
-
-      OBJECTS.each do |object, klass|
-        plural = "#{object}s"
-
-        define_method("get_#{plural}") do |**query|
-          data = get_data("get-#{plural}", list_query(object, query)) || []
-          data.map { |item| klass.new(item) }
-        end
-
-        define_method("get_pagination_#{plural}") do |page, page_size, **query|
-          query = list_query(object, query).merge('p' => page, 'pageSize' => page_size)
-          response = get_response("get-#{plural}", query)
-          [(response['data'] || []).map { |item| klass.new(item) }, response['data2'].to_i]
-        end
-
-        define_method("get_#{object}") do |name|
-          data = get_data("get-#{object}", 'id' => object_id_of(object, name))
-          data && klass.new(data)
-        end
-
-        define_method("add_#{object}") do |entity|
-          modify_object("add-#{object}", object, entity)
-        end
-
-        define_method("update_#{object}") do |entity, columns: nil|
-          modify_object("update-#{object}", object, entity, columns: columns)
-        end
-
-        # Casdoor deletes an object by the whole object, e.g. an application is only deleted when its organization
-        # matches too, so the object is fetched first when only its name is given
-        define_method("delete_#{object}") do |entity|
-          entity = send("get_#{object}", entity) unless entity.is_a?(Entity)
-          return false if entity.nil?
-
-          modify_object("delete-#{object}", object, entity)
-        end
-      end
-
-      private
-
-      def default_owner(object)
-        ADMIN_OWNED.include?(object) ? 'admin' : organization_name
-      end
-
-      def object_id_of(object, name)
-        name.to_s.include?('/') ? name.to_s : "#{default_owner(object)}/#{name}"
-      end
-
-      def list_query(object, query)
-        query = query.each_with_object({}) { |(key, value), hash| hash[Entity.camelize(key)] = value }
-        { 'owner' => default_owner(object) }.merge(query)
-      end
-
-      def modify_object(action, object, entity, columns: nil, query: {})
-        entity = OBJECTS.fetch(object).new(entity) if entity.is_a?(Hash)
-        entity.owner = default_owner(object) if entity.owner.to_s.empty?
-
-        query = { 'id' => "#{entity.owner}/#{entity.name}" }.merge(query)
-        query['columns'] = Array(columns).map { |column| Entity.camelize(column) }.join(',') if columns
-        post_json(action, query, entity)['data'] == 'Affected'
-      end
-    end
-  end
-end

data/lib/casdoor/api/enforce.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2026 The Casdoor Authors. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module Casdoor
-  module Api
-    # The permission checks of Casdoor. Pass one of permission_id, model_id, resource_id, enforcer_id or owner
-    # ("owner/name" for the IDs) to choose which policies to check against.
-    module Enforce
-      # request is a Casbin request like ["alice", "data1", "read"]. Returns true if any of the checked
-      # permissions allows it.
-      def enforce(request, permission_id: nil, model_id: nil, resource_id: nil, enforcer_id: nil, owner: nil)
-        query = enforce_query(permission_id, model_id, resource_id, enforcer_id, owner)
-        Array(post_json('enforce', query, request)['data']).any?(true)
-      end
-
-      # requests is a list of Casbin requests. Returns a list of results for each checked permission, like
-      # [[true, false]] for two requests checked against one permission.
-      def batch_enforce(requests, permission_id: nil, model_id: nil, resource_id: nil, enforcer_id: nil, owner: nil)
-        query = enforce_query(permission_id, model_id, resource_id, enforcer_id, owner)
-        post_json('batch-enforce', query, requests)['data'] || []
-      end
-
-      private
-
-      def enforce_query(permission_id, model_id, resource_id, enforcer_id, owner)
-        { 'permissionId' => permission_id, 'modelId' => model_id, 'resourceId' => resource_id,
-          'enforcerId' => enforcer_id, 'owner' => owner }
-      end
-    end
-  end
-end

data/lib/casdoor/api/users.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright 2026 The Casdoor Authors. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module Casdoor
-  module Api
-    # The user APIs besides the ones in Crud
-    module Users
-      # The user that the client is authenticated as, meant to be used with with_access_token:
-      #
-      #   user = client.with_access_token(access_token).get_account
-      def get_account
-        data = get_data('get-account')
-        data && User.new(data)
-      end
-
-      # The users of all the organizations, only allowed for global admins
-      def get_global_users
-        (get_data('get-global-users') || []).map { |item| User.new(item) }
-      end
-
-      def get_sorted_users(sorter, limit)
-        query = { 'owner' => organization_name, 'sorter' => sorter, 'limit' => limit }
-        (get_data('get-sorted-users', query) || []).map { |item| User.new(item) }
-      end
-
-      # is_online: nil counts all the users, true or false counts the online or offline ones
-      def get_user_count(is_online: nil)
-        online = { nil => '', true => '1', false => '0' }.fetch(is_online)
-        query = { 'owner' => organization_name, 'isOnline' => online }
-        get_data('get-user-count', query).to_i
-      end
-
-      def get_user_by_email(email)
-        find_user('email' => email)
-      end
-
-      def get_user_by_phone(phone)
-        find_user('phone' => phone)
-      end
-
-      # user_id is the "id" field of the user (a UUID), not "owner/name"
-      def get_user_by_user_id(user_id)
-        find_user('userId' => user_id)
-      end
-
-      # Sets the user's password. old_password can be empty when an admin sets the password of another user.
-      def set_password(owner, name, new_password, old_password: '')
-        form = { 'userOwner' => owner, 'userName' => name, 'oldPassword' => old_password,
-                 'newPassword' => new_password }
-        post_form('set-password', {}, form)['status'] == 'ok'
-      end
-
-      # Checks the password of a user, e.g. User.new(owner: "casbin", name: "alice", password: "123")
-      def check_user_password(user)
-        user = User.new(user) if user.is_a?(Hash)
-        user.owner = organization_name if user.owner.to_s.empty?
-        post_json('check-user-password', { 'id' => "#{user.owner}/#{user.name}" }, user)['status'] == 'ok'
-      rescue ApiError
-        false
-      end
-
-      private
-
-      def find_user(query)
-        data = get_data('get-user', { 'owner' => organization_name }.merge(query))
-        data && User.new(data)
-      end
-    end
-  end
-end