casdoor-ruby-sdk

gem 'casdoor-ruby-sdk'

require 'casdoor'

client = Casdoor.new_client(endpoint, client_id, client_secret, certificate, organization_name, application_name)
users = client.get_users

Casdoor.init_config(endpoint, client_id, client_secret, certificate, organization_name, application_name)
users = Casdoor.get_users

# 1. Redirect the browser to the sign-in page of Casdoor
redirect_to client.get_signin_url('https://your-app.example.com/callback', state: session[:state] = SecureRandom.hex)

# 2. Casdoor redirects back to the callback with "code" and "state", exchange the code for the tokens
raise 'Invalid state' unless params[:state] == session[:state]
token = client.get_oauth_token(params[:code], params[:state])
# => {"access_token" => "...", "id_token" => "...", "refresh_token" => "...", "expires_in" => 604800, ...}

# 3. Verify the access token and read the user in it
claims = client.parse_jwt_token(token['access_token'])
claims.name          # => "alice"
claims.owner         # => "casbin", the organization
claims.user          # => Casdoor::User with the fields of the user

client.get_signup_url(true, '')                          # the sign-up page of the application
client.get_user_profile_url('alice', access_token)       # the profile page of a user
client.get_my_profile_url(access_token)                  # the profile page of the signed-in user
client.refresh_oauth_token(token['refresh_token'])
client.get_oauth_token_by_password('alice', 'password')   # needs the "password" grant type in the application
client.impersonate_user('alice', 'master-password')      # an admin acts as a user, with the organization's master password
client.introspect_token(token['access_token'])           # => {"active" => true, ...}
client.logout(token['access_token'])                     # signs the user out of all their sessions
client.logout_current_session(token['access_token'])     # signs the user out of the current session only

user_client = client.with_access_token(token['access_token'])
user = user_client.get_account
user.display_name = 'Alice'
user_client.update_user(user)

user = client.get_user('alice')                 # in the client's organization, or client.get_user('org/alice')
user.display_name = 'Alice Smith'
user.properties = (user.properties || {}).merge('department' => 'R&D')
client.update_user(user)                         # => true when something changed
client.update_user_for_columns(user, %w[displayName email])   # only update these fields

client.add_user(Casdoor::User.new(name: 'bob', display_name: 'Bob', password: '123456'))
client.delete_user(client.get_user('bob'))

client.get_users                                 # => [Casdoor::User]
users, total = client.get_pagination_users(1, 20, field: 'name', value: 'a', sort_field: 'created_time')
client.get_sorted_users('created_time', 10)
client.get_global_users                          # the users of all the organizations
client.get_user_by_email('alice@example.com')
client.get_user_by_phone('13800000000')
client.get_user_by_user_id('uuid')               # by the "id" field of the user
client.update_user_by_id('casbin/alice', user)   # e.g. to rename the user
client.get_user_count('')                        # "" for all, "1" for the online users, "0" for the offline ones
client.set_password('casbin', 'alice', 'old-password', 'new-password')   # an admin can leave the old password empty
client.check_user_password(Casdoor::User.new(name: 'alice', password: 'password'))   # => true or false

client.get_roles                                  # => [Casdoor::Role]
client.get_pagination_roles(1, 20)                # => [[Casdoor::Role], total]
client.get_role('admin')                          # => Casdoor::Role or nil
client.add_role(Casdoor::Role.new(name: 'admin', users: ['casbin/alice']))
client.update_role(role)
client.update_role_for_columns(role, %w[users])
client.delete_role(role)

client.get_organization_applications                # the applications of the client's organization
client.get_organization_names
client.get_global_certs
client.get_permissions_by_role('admin')
client.get_invitation_info('CODE', 'app-example')
client.get_session('alice', 'app-example')
client.get_user_orders('alice')
client.cancel_order('order-1')
client.get_user_payments('alice')
client.notify_payment(payment)
client.invoice_payment(payment)
client.get_user_transactions('alice')
affected, transaction_id = client.add_transaction(transaction)
client.add_transaction_with_dry_run(transaction, true)

# One of the permission ID, model ID, resource ID, enforcer ID or owner chooses the policies to check
client.enforce('casbin/permission-1', '', '', '', '', %w[alice data1 read])   # => true or false
client.batch_enforce('', '', '', 'casbin/enforcer-1', '', [%w[alice data1 read], %w[bob data2 write]])
# => [[true, false]], the results of each permission

rule = Casdoor::CasbinRule.new(ptype: 'p', v0: 'alice', v1: 'data1', v2: 'read')
client.add_policy(enforcer, rule)
client.update_policy(enforcer, rule, new_rule)
client.remove_policy(enforcer, rule)
client.get_policies('enforcer-1', '')
client.get_filtered_policies('casbin/enforcer-1', [Casdoor::PolicyFilter.new(ptype: 'p', field_index: 0, field_values: ['alice'])])

order = client.place_order([Casdoor::ProductInfo.new(name: 'product-1', quantity: 1)], 'alice')
payment = client.pay_order(order.name, 'provider_payment_dummy')
order = client.buy_product('product-1', 'provider_payment_dummy', 'alice')

file_url, name = client.upload_resource('alice', 'avatar', '', 'alice.png', File.binread('alice.png'))
client.get_resources('casbin', 'alice', '', '', '', '')
client.delete_resource(client.get_resource("casbin/#{name}"))

client.send_email('Title', 'Content', 'sender', 'alice@example.com', 'bob@example.com')
client.send_email_by_provider('Title', 'Content', 'sender', 'provider_email', 'alice@example.com')
client.send_sms('Your code is 123456', '+15555550100')
client.send_sms_by_provider('Your code is 123456', 'provider_sms', '+15555550100')
client.send_notification('Content', 'recipient')

response = client.initiate('casbin', 'app', 'alice')    # => {"status" => "ok", "data" => {"secret" => ..., "url" => ...}}
client.verify('casbin', 'app', 'alice', secret, passcode)
client.enable('casbin', 'app', 'alice', secret, recovery_code)
client.set_preferred('casbin', 'app', 'alice', secret)
client.delete('casbin', 'alice')                        # disables the MFA of the user

client.get_ldaps
client.get_ldap_users('ldap-id')                        # => {"users" => [Casdoor::LdapUser], ...}
client.sync_ldap_users_from_server('ldap-id')           # imports the LDAP users into Casdoor

client.do_get_bytes(client.get_url('get-organization-applications', 'owner' => 'admin', 'organization' => 'casbin'))
client.do_get_response(client.get_url('get-sessions', 'owner' => 'casbin'))   # the whole response, e.g. "data2"
client.do_post('add-ldap', nil, ldap)                   # POST with a JSON body
client.do_post('set-password', nil, form, true)         # POST with a form body