casdoor-ruby-sdk 1.0.0 → 1.1.1

data/lib/casdoor/order.rb

@@ -0,0 +1,59 @@
+# 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 Order < Entity; end
+
+  # A product in an order, e.g. ProductInfo.new(name: "product-1", quantity: 1)
+  class ProductInfo < Entity; end
+
+  # The order APIs, the counterpart of order.go of the Go SDK
+  class Client
+    def get_orders
+      get_objects('get-orders', Order, '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_orders(page, page_size, query_map = {})
+      get_pagination_objects('get-orders', Order, organization_name, page, page_size, query_map)
+    end
+
+    def get_user_orders(user_name)
+      get_objects('get-user-orders', Order, 'owner' => organization_name, 'user' => user_name)
+    end
+
+    def get_order(name)
+      get_object('get-order', Order, 'id' => get_id(name))
+    end
+
+    def update_order(order)
+      modify_object('update-order', Order, order, organization_name)
+    end
+
+    def add_order(order)
+      modify_object('add-order', Order, order, organization_name)
+    end
+
+    def delete_order(order)
+      modify_object('delete-order', Order, order, organization_name)
+    end
+
+    def cancel_order(name)
+      do_post('cancel-order', { 'id' => get_id(name) }, '')['data'] == 'Affected'
+    end
+  end
+end

data/lib/casdoor/order_pay.rb

@@ -0,0 +1,40 @@
+# 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
+  # Placing and paying orders, the counterpart of order_pay.go of the Go SDK
+  class Client
+    # Places an order of the products for the user (the name in the client's organization).
+    # product_infos are like [ProductInfo.new(name: "product-1", quantity: 1)].
+    def place_order(product_infos, user_name)
+      query = { 'owner' => organization_name }
+      query['userName'] = user_name unless user_name.to_s.empty?
+      body = { 'productInfos' => product_infos.map { |info| to_entity(ProductInfo, info) } }
+      Order.new(do_post('place-order', query, body)['data'])
+    end
+
+    # Pays the order with the payment provider, returns the payment
+    def pay_order(order_name, provider_name)
+      query = { 'id' => get_id(order_name), 'providerName' => provider_name }
+      Payment.new(do_post('pay-order', query, '')['data'])
+    end
+
+    # Places an order of one product for the user, it's then paid with pay_order
+    def buy_product(name, _provider_name, user_name)
+      place_order([ProductInfo.new(name: name, quantity: 1)], user_name)
+    end
+  end
+end

data/lib/casdoor/organization.rb

@@ -0,0 +1,47 @@
+# 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 Organization < Entity; end
+
+  # The organization APIs, the counterpart of organization.go of the Go SDK
+  class Client
+    def get_organization(name)
+      get_object('get-organization', Organization, 'id' => get_admin_id(name))
+    end
+
+    def get_organizations
+      get_objects('get-organizations', Organization, 'owner' => 'admin')
+    end
+
+    # The organizations with only their names and display names
+    def get_organization_names
+      get_objects('get-organization-names', Organization, 'owner' => 'admin')
+    end
+
+    def add_organization(organization)
+      modify_object('add-organization', Organization, organization, 'admin')
+    end
+
+    def delete_organization(organization)
+      modify_object('delete-organization', Organization, organization, 'admin')
+    end
+
+    def update_organization(organization)
+      modify_object('update-organization', Organization, organization, 'admin')
+    end
+  end
+end

data/lib/casdoor/payment.rb

@@ -0,0 +1,61 @@
+# 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 Payment < Entity; end
+
+  # The payment APIs, the counterpart of payment.go of the Go SDK
+  class Client
+    def get_payments
+      get_objects('get-payments', Payment, '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_payments(page, page_size, query_map = {})
+      get_pagination_objects('get-payments', Payment, organization_name, page, page_size, query_map)
+    end
+
+    def get_payment(name)
+      get_object('get-payment', Payment, 'id' => get_id(name))
+    end
+
+    def get_user_payments(user_name)
+      get_objects('get-user-payments', Payment,
+                  'owner' => organization_name, 'organization' => organization_name, 'user' => user_name)
+    end
+
+    def update_payment(payment)
+      modify_object('update-payment', Payment, payment, organization_name)
+    end
+
+    def add_payment(payment)
+      modify_object('add-payment', Payment, payment, organization_name)
+    end
+
+    def delete_payment(payment)
+      modify_object('delete-payment', Payment, payment, organization_name)
+    end
+
+    def notify_payment(payment)
+      modify_object('notify-payment', Payment, payment, organization_name)
+    end
+
+    def invoice_payment(payment)
+      modify_object('invoice-payment', Payment, payment, organization_name)
+    end
+  end
+end

data/lib/casdoor/permission.rb

@@ -0,0 +1,57 @@
+# 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 Permission < Entity; end
+
+  # The permission APIs, the counterpart of permission.go of the Go SDK
+  class Client
+    def get_permissions
+      get_objects('get-permissions', Permission, 'owner' => organization_name)
+    end
+
+    # The permissions that the role is granted
+    def get_permissions_by_role(name)
+      get_objects('get-permissions-by-role', Permission, 'id' => get_id(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_permissions(page, page_size, query_map = {})
+      get_pagination_objects('get-permissions', Permission, organization_name, page, page_size, query_map)
+    end
+
+    def get_permission(name)
+      get_object('get-permission', Permission, 'id' => get_id(name))
+    end
+
+    def update_permission(permission)
+      modify_object('update-permission', Permission, permission, organization_name)
+    end
+
+    def update_permission_for_columns(permission, columns)
+      modify_object('update-permission', Permission, permission, organization_name, columns)
+    end
+
+    def add_permission(permission)
+      modify_object('add-permission', Permission, permission, organization_name)
+    end
+
+    def delete_permission(permission)
+      modify_object('delete-permission', Permission, permission, organization_name)
+    end
+  end
+end

data/lib/casdoor/plan.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 Plan < Entity; end
+
+  # The plan APIs, the counterpart of plan.go of the Go SDK
+  class Client
+    def get_plans
+      get_objects('get-plans', Plan, '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_plans(page, page_size, query_map = {})
+      get_pagination_objects('get-plans', Plan, organization_name, page, page_size, query_map)
+    end
+
+    def get_plan(name)
+      get_object('get-plan', Plan, 'id' => get_id(name))
+    end
+
+    def update_plan(plan)
+      modify_object('update-plan', Plan, plan, organization_name)
+    end
+
+    def add_plan(plan)
+      modify_object('add-plan', Plan, plan, organization_name)
+    end
+
+    def delete_plan(plan)
+      modify_object('delete-plan', Plan, plan, organization_name)
+    end
+  end
+end

data/lib/casdoor/policy.rb

@@ -0,0 +1,67 @@
+# 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
+  # A policy of an enforcer, e.g. CasbinRule.new(ptype: "p", v0: "alice", v1: "data1", v2: "read"). Casdoor names
+  # its JSON fields "Ptype", "V0", ..., "V5".
+  class CasbinRule < Entity
+    def self.field_key(name)
+      name.to_s.capitalize
+    end
+  end
+
+  # A filter of get_filtered_policies, e.g. PolicyFilter.new(ptype: "g", field_index: 0, field_values: ["alice"])
+  class PolicyFilter < Entity; end
+
+  # The policy APIs of the enforcers, the counterpart of policy.go of the Go SDK
+  class Client
+    def add_policy(enforcer, policy)
+      modify_policy('add-policy', enforcer, [policy])
+    end
+
+    def update_policy(enforcer, old_policy, new_policy)
+      modify_policy('update-policy', enforcer, [old_policy, new_policy])
+    end
+
+    def remove_policy(enforcer, policy)
+      modify_policy('remove-policy', enforcer, [policy])
+    end
+
+    # adapter_id ("owner/name") can be empty to use the adapter of the enforcer
+    def get_policies(enforcer_name, adapter_id)
+      get_objects('get-policies', CasbinRule, 'id' => get_id(enforcer_name), 'adapterId' => adapter_id)
+    end
+
+    # The policies of the enforcer ("owner/name") that match all the filters
+    def get_filtered_policies(enforcer_id, filters)
+      filters = filters.map { |filter| to_entity(PolicyFilter, filter) }
+      (do_post('get-filtered-policies', { 'id' => enforcer_id }, filters)['data'] || []).map do |item|
+        CasbinRule.new(item)
+      end
+    end
+
+    private
+
+    def modify_policy(action, enforcer, policies)
+      enforcer = to_entity(Enforcer, enforcer)
+      enforcer.owner = organization_name if enforcer.owner.to_s.empty?
+      policies = policies.map { |policy| to_entity(CasbinRule, policy) }
+
+      body = action == 'update-policy' ? policies : policies.first
+      do_post(action, { 'id' => enforcer.get_id }, body)['data'] == 'Affected'
+    end
+  end
+end

data/lib/casdoor/pricing.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 Pricing < Entity; end
+
+  # The pricing APIs, the counterpart of pricing.go of the Go SDK
+  class Client
+    def get_pricings
+      get_objects('get-pricings', Pricing, '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_pricings(page, page_size, query_map = {})
+      get_pagination_objects('get-pricings', Pricing, organization_name, page, page_size, query_map)
+    end
+
+    def get_pricing(name)
+      get_object('get-pricing', Pricing, 'id' => get_id(name))
+    end
+
+    def update_pricing(pricing)
+      modify_object('update-pricing', Pricing, pricing, organization_name)
+    end
+
+    def add_pricing(pricing)
+      modify_object('add-pricing', Pricing, pricing, organization_name)
+    end
+
+    def delete_pricing(pricing)
+      modify_object('delete-pricing', Pricing, pricing, organization_name)
+    end
+  end
+end

data/lib/casdoor/product.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 Product < Entity; end
+
+  # The product APIs, the counterpart of product.go of the Go SDK
+  class Client
+    def get_products
+      get_objects('get-products', Product, '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_products(page, page_size, query_map = {})
+      get_pagination_objects('get-products', Product, organization_name, page, page_size, query_map)
+    end
+
+    def get_product(name)
+      get_object('get-product', Product, 'id' => get_id(name))
+    end
+
+    def update_product(product)
+      modify_object('update-product', Product, product, organization_name)
+    end
+
+    def add_product(product)
+      modify_object('add-product', Product, product, organization_name)
+    end
+
+    def delete_product(product)
+      modify_object('delete-product', Product, product, organization_name)
+    end
+  end
+end

data/lib/casdoor/provider.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 Provider < Entity; end
+
+  # The provider APIs, the counterpart of provider.go of the Go SDK
+  class Client
+    def get_providers
+      get_objects('get-providers', Provider, '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_providers(page, page_size, query_map = {})
+      get_pagination_objects('get-providers', Provider, organization_name, page, page_size, query_map)
+    end
+
+    def get_provider(name)
+      get_object('get-provider', Provider, 'id' => get_id(name))
+    end
+
+    def update_provider(provider)
+      modify_object('update-provider', Provider, provider, organization_name)
+    end
+
+    def add_provider(provider)
+      modify_object('add-provider', Provider, provider, organization_name)
+    end
+
+    def delete_provider(provider)
+      modify_object('delete-provider', Provider, provider, organization_name)
+    end
+  end
+end

data/lib/casdoor/record.rb

@@ -0,0 +1,43 @@
+# 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 Record < Entity; end
+
+  # The record APIs, the counterpart of record.go of the Go SDK
+  class Client
+    def get_records
+      get_objects('get-records', Record, '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_records(page, page_size, query_map = {})
+      get_pagination_objects('get-records', Record, organization_name, page, page_size, query_map)
+    end
+
+    def get_record(name)
+      get_object('get-record', Record, 'id' => get_id(name))
+    end
+
+    def add_record(record)
+      record = to_entity(Record, record)
+      record.owner = organization_name if record.owner.to_s.empty?
+      record.organization = organization_name if record.organization.to_s.empty?
+      do_post('add-record', nil, record)['data'] == 'Affected'
+    end
+  end
+end

data/lib/casdoor/resource.rb

@@ -0,0 +1,75 @@
+# 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 Resource < Entity; end
+
+  # The resource (uploaded file) APIs, the counterpart of resource.go of the Go SDK
+  class Client
+    # id is "owner/name", where the name of a resource is its path, like "/casdoor/avatar/casbin/alice.png"
+    def get_resource(id)
+      get_object('get-resource', Resource, 'owner' => organization_name, 'id' => id)
+    end
+
+    def get_resource_ex(owner, name)
+      get_resource("#{owner}/#{name}")
+    end
+
+    def get_resources(owner, user, field, value, sort_field, sort_order)
+      get_objects('get-resources', Resource, 'owner' => owner, 'user' => user, 'field' => field, 'value' => value,
+                                             'sortField' => sort_field, 'sortOrder' => sort_order)
+    end
+
+    def get_pagination_resources(owner, user, field, value, page_size, page, sort_field, sort_order)
+      get_objects('get-resources', Resource, 'owner' => owner, 'user' => user, 'field' => field, 'value' => value,
+                                             'p' => page.to_s, 'pageSize' => page_size.to_s,
+                                             'sortField' => sort_field, 'sortOrder' => sort_order)
+    end
+
+    # Uploads a file for the user with the storage provider of the client's application.
+    # Returns [the URL of the file, the name of the resource].
+    def upload_resource(user, tag, parent, full_file_path, file_bytes)
+      upload_resource_ex(user, tag, parent, full_file_path, file_bytes, nil, nil)
+    end
+
+    def upload_resource_ex(user, tag, parent, full_file_path, file_bytes, created_time, description)
+      query = { 'owner' => organization_name, 'user' => user, 'application' => application_name, 'tag' => tag,
+                'parent' => parent, 'fullFilePath' => full_file_path, 'createdTime' => created_time,
+                'description' => description }
+      response = do_post('upload-resource', query, file_bytes, true, true)
+      [response['data'], response['data2']]
+    end
+
+    def add_resource(resource)
+      modify_object('add-resource', Resource, resource, organization_name)
+    end
+
+    def update_resource(resource)
+      modify_object('update-resource', Resource, resource, organization_name)
+    end
+
+    def delete_resource(resource)
+      delete_resource_with_tag(resource, '')
+    end
+
+    # A tag of "avatar" etc. also deletes the file from the storage
+    def delete_resource_with_tag(resource, tag)
+      resource = to_entity(Resource, resource)
+      resource.owner = organization_name if resource.owner.to_s.empty?
+      do_post('delete-resource', { 'tag' => tag }, resource)['data'] == 'Affected'
+    end
+  end
+end