fusionauth_client 1.49.1 → 1.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a52be92b848e67c0506bf9706082bd7cd0fe08a4c4caceedd7c10f45c8d5533c
-  data.tar.gz: 6c6ccec915997b8162b4c2b43f0b30e1faf9cf29e1da377564584186e8e15199
+  metadata.gz: a22a0a8b25efafb5686e379bb4449e98648ef99ae3de8fc8de0f6747db206cba
+  data.tar.gz: 72fa24a5ebc673f58141c71e1769aa2eefd72d07491754d01f1669630a9978c6
 SHA512:
-  metadata.gz: 7a70a442af01bc63721eee306616a3018bb61eac5ffd9fdf0d70bc7c1b98a6fd06cd95491e1bf54151314610e6d1454ae93f919739a423e8328360979f7663db
-  data.tar.gz: ce1fd04311af248318fe103c184a76318ac64a68219659492a43a1898d7ace0a20e70d817bbb3928a2015033f4829391044a709774fe93b5e10c9e968249dbd5
+  metadata.gz: d6133b62a0e93ff2b0b054639af56e8da4e3de5a718c9cd2df4ce163a3be0d32daaec61de53fb593a93652636eb106bad730d4101eb04d30d68414450a34c277
+  data.tar.gz: e9162071e4335fbdc8d4b99c70039609788d50b04c2e81e14907890fb4630519813d1ef8e20917b66584389903f7d7fb3ef9b6bed26f48b393d0512cc9964748

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "docker"
+    directory: "/.github/fusionauth"
+    schedule:
+      interval: "weekly"

data/.github/fusionauth/.env

@@ -0,0 +1,6 @@
+DATABASE_USERNAME=fusionauth
+DATABASE_PASSWORD=hkaLBM3RVnyYeYeqE3WI1w2e4Avpy0Wd5O3s3
+FUSIONAUTH_APP_MEMORY=256M
+FUSIONAUTH_APP_RUNTIME_MODE=development
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres

data/.github/fusionauth/docker-compose.yml

@@ -0,0 +1,51 @@
+services:
+  db:
+    image: postgres:16.0-alpine
+    environment:
+      PGDATA: /var/lib/postgresql/data/pgdata
+      POSTGRES_USER: ${POSTGRES_USER}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+    healthcheck:
+      test: [ "CMD-SHELL", "pg_isready -U postgres" ]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+    networks:
+      - db_net
+    restart: unless-stopped
+    volumes:
+      - db_data:/var/lib/postgresql/data
+
+  fusionauth:
+    image: fusionauth/fusionauth-app:latest
+    depends_on:
+      db:
+        condition: service_healthy
+    environment:
+      DATABASE_URL: jdbc:postgresql://db:5432/fusionauth
+      DATABASE_ROOT_USERNAME: ${POSTGRES_USER}
+      DATABASE_ROOT_PASSWORD: ${POSTGRES_PASSWORD}
+      DATABASE_USERNAME: ${DATABASE_USERNAME}
+      DATABASE_PASSWORD: ${DATABASE_PASSWORD}
+      FUSIONAUTH_APP_MEMORY: ${FUSIONAUTH_APP_MEMORY}
+      FUSIONAUTH_APP_RUNTIME_MODE: ${FUSIONAUTH_APP_RUNTIME_MODE}
+      FUSIONAUTH_APP_SILENT_MODE: true
+      FUSIONAUTH_APP_URL: http://fusionauth:9011
+      FUSIONAUTH_APP_KICKSTART_FILE: /usr/local/fusionauth/kickstart.json
+      SEARCH_TYPE: database
+    networks:
+      - db_net
+    restart: unless-stopped
+    ports:
+      - 9011:9011
+    volumes:
+      - fusionauth_config:/usr/local/fusionauth/config
+      - ./kickstart.json:/usr/local/fusionauth/kickstart.json
+
+networks:
+  db_net:
+    driver: bridge
+
+volumes:
+  db_data:
+  fusionauth_config:

data/.github/fusionauth/kickstart.json

@@ -0,0 +1,46 @@
+{
+  "variables": {
+    "applicationId": "3c219e58-ed0e-4b18-ad48-f4f92793ae32",
+    "apiKey": "72a8c464b86c3c9098c33da73f471b8a0352f6e14087ddc3",
+    "asymmetricKeyId": "#{UUID()}",
+    "defaultTenantId": "d7d09513-a3f5-401c-9685-34ab6c552453",
+    "adminEmail": "admin@example.com",
+    "adminPassword": "password"
+  },
+  "apiKeys": [
+    {
+      "key": "#{apiKey}",
+      "description": "Unrestricted API key"
+    }
+  ],
+  "requests": [
+    {
+      "method": "POST",
+      "url": "/api/key/generate/#{asymmetricKeyId}",
+      "tenantId": "#{defaultTenantId}",
+      "body": {
+        "key": {
+          "algorithm": "RS256",
+          "name": "For GitHub Actions",
+          "length": 2048
+        }
+      }
+    },
+    {
+      "method": "POST",
+      "url": "/api/user/registration",
+      "body": {
+        "user": {
+          "email": "#{adminEmail}",
+          "password": "#{adminPassword}"
+        },
+        "registration": {
+          "applicationId": "#{applicationId}",
+          "roles": [
+            "admin"
+          ]
+        }
+      }
+    }
+  ]
+}

data/.github/workflows/docs.yml

@@ -0,0 +1,31 @@
+name: Generate Docs
+
+on:
+  push:
+    branches: [ "master" ]
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+
+    - name: Generate docs
+      run: |
+        rm -f doc/index.db
+        rdoc --format=markdown lib/fusionauth/fusionauth_client.rb
+
+    - name: Commit
+      uses: EndBug/add-and-commit@v9 
+      with:
+        add: 'doc/'
+        message: ':memo: Updating docs'
+

data/.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Test Library
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up FusionAuth
+      working-directory: .github/fusionauth
+      run: docker compose up -d
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+
+    - name: Waiting for FusionAuth App
+      run: timeout 30 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:9011)" != "200" ]]; do sleep 5; done' || false
+
+    - name: Run test suite
+      run: rake test

data/.ruby-version

@@ -1 +1 @@
-2.5.9
+2.7.5

data/Gemfile

@@ -1,4 +1,4 @@
-# Copyright (c) 2019-2022, FusionAuth, All Rights Reserved
+# Copyright (c) 2019-2024, FusionAuth, 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.
@@ -13,12 +13,11 @@
 # language governing permissions and limitations under the License.
 
 source 'https://rubygems.org'
-ruby '2.5.9'
+ruby '2.7.5'
 
-gem "rake", "12.3.3"
-gem "minitest", "5.8.3"
+gem 'minitest',      '~> 5.22', '>= 5.22.3'
+gem 'rake',          '~> 13.2', '>= 13.2.1'
+gem 'rdoc-markdown', '~> 0.4.2'
 
 # Specify your gem's dependencies in fusionauth_client.gemspec
 gemspec
-
-gem "rdoc-markdown", "~> 0.4"

data/Gemfile.lock

@@ -1,31 +1,29 @@
 PATH
   remote: .
   specs:
-    fusionauth_client (1.49.1)
+    fusionauth_client (1.50.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    cgi (0.3.6)
+    cgi (0.4.1)
     erb (2.2.3)
       cgi
-    extralite-bundle (1.19)
-    mini_portile2 (2.8.1)
-    minitest (5.8.3)
-    nokogiri (1.13.10)
-      mini_portile2 (~> 2.8.0)
+    extralite-bundle (1.27)
+    minitest (5.22.3)
+    nokogiri (1.15.6-aarch64-linux)
       racc (~> 1.4)
-    nokogiri (1.13.10-x86_64-darwin)
+    nokogiri (1.15.6-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.10-x86_64-linux)
+    nokogiri (1.15.6-x86_64-linux)
       racc (~> 1.4)
-    psych (5.0.1)
+    psych (5.1.2)
       stringio
-    racc (1.6.2)
-    rake (12.3.3)
-    rdoc (6.5.0)
+    racc (1.7.3)
+    rake (13.2.1)
+    rdoc (6.6.3.1)
       psych (>= 4.0.0)
-    rdoc-markdown (0.4)
+    rdoc-markdown (0.4.2)
       erb (~> 2.0)
       extralite-bundle (~> 1.0)
       rdoc (~> 6.0)
@@ -33,23 +31,22 @@ GEM
       unindent (~> 1.0)
     reverse_markdown (2.1.1)
       nokogiri
-    stringio (3.0.4)
+    stringio (3.1.0)
     unindent (1.0)
 
 PLATFORMS
-  ruby
-  x86_64-darwin-19
-  x86_64-darwin-20
+  aarch64-linux
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
   fusionauth_client!
-  minitest (= 5.8.3)
-  rake (= 12.3.3)
-  rdoc-markdown (~> 0.4)
+  minitest (~> 5.22, >= 5.22.3)
+  rake (~> 13.2, >= 13.2.1)
+  rdoc-markdown (~> 0.4.2)
 
 RUBY VERSION
-   ruby 2.7.0p0
+   ruby 2.7.5p203
 
 BUNDLED WITH
-   2.2.5
+   2.4.22

data/README.md

@@ -0,0 +1,225 @@
+# FusionAuth Ruby Client ![semver 2.0.0 compliant](http://img.shields.io/badge/semver-2.0.0-brightgreen.svg?style=flat-square)
+
+## Intro
+
+<!--
+tag::forDocSite[]
+-->
+
+This gem is the Ruby client library that helps connect Ruby applications
+to the FusionAuth (<https://fusionauth.io>) Identity and User Management
+platform.
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+    gem 'fusionauth_client'
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install fusionauth_client
+
+
+## Examples
+
+### Set Up
+
+First, you have to make sure you have a running FusionAuth instance. If you don't have one already, the easiest way to install FusionAuth is [via Docker](https://fusionauth.io/docs/get-started/download-and-install/docker), but there are [other ways](https://fusionauth.io/docs/get-started/download-and-install). By default, it'll be running on `localhost:9011`.
+
+Then, you have to [create an API Key](https://fusionauth.io/docs/apis/authentication#managing-api-keys) in the admin UI to allow calling API endpoints.
+
+You are now ready to use this library!
+
+### Response Handling
+
+After every request is made, you need to check for any errors and handle them. To avoid cluttering things up, we'll omit the error handling in the next examples, but you should do something like the following.
+
+```ruby
+require 'fusionauth/fusionauth_client'
+require 'pp'
+
+# actual code
+
+def handle_response(response)
+  if response.was_successful
+    pp response.success_response
+  else
+    print "status: #{response.status}"
+    if response.exception
+      # if we can't connect
+      print response.exception
+    end
+    print response.error_response
+    exit 1
+  end
+end
+```
+
+### Create the Client
+
+To make requests to the API, first you need to create a `FusionAuthClient` instance with [the API Key created](https://fusionauth.io/docs/apis/authentication#managing-api-keys) and the server address where FusionAuth is running.
+
+```ruby
+require 'fusionauth/fusionauth_client'
+
+# Construct the FusionAuth Client
+client = FusionAuth::FusionAuthClient.new(
+  '<paste the API Key you generated here>',
+  'http://localhost:9011' # or change this to whatever address FusionAuth is running on
+)
+```
+
+### Create an Application
+
+To create an [Application](https://fusionauth.io/docs/get-started/core-concepts/applications), use the `createApplication()` method.
+
+```ruby
+response = client.create_application(
+    '', # Leave this empty to automatically generate the UUID
+    {
+        :application => {
+            :name => 'ChangeBank',
+        }
+    }
+)
+
+handle_response(response)
+```
+
+[Check the API docs for this endpoint](https://fusionauth.io/docs/apis/applications#create-an-application)
+
+### Adding Roles to an Existing Application
+
+To add [roles to an Application](https://fusionauth.io/docs/get-started/core-concepts/applications#roles), use `createApplicationRole()`.
+
+```ruby
+response = client.create_application_role(
+    'd564255e-f767-466b-860d-6dcb63afe4cc', # Existing Application Id
+    '', # Role Id - Leave this empty to automatically generate the UUID
+    {
+        :role => {
+            :name => 'customer',
+            :description => 'Default role for regular customers',
+            :isDefault => true,
+        }
+    }
+)
+
+handle_response(response)
+```
+
+[Check the API docs for this endpoint](https://fusionauth.io/docs/apis/applications#create-an-application-role)
+
+### Retrieve Application Details
+
+To fetch details about an [Application](https://fusionauth.io/docs/get-started/core-concepts/applications), use `retrieveApplication()`.
+
+```ruby
+response = client.retrieve_application(
+    'd564255e-f767-466b-860d-6dcb63afe4cc'
+)
+
+handle_response(response)
+```
+
+[Check the API docs for this endpoint](https://fusionauth.io/docs/apis/applications#retrieve-an-application)
+
+### Delete an Application
+
+To delete an [Application](https://fusionauth.io/docs/get-started/core-concepts/applications), use `deleteApplication()`.
+
+```ruby
+response = client.delete_application(
+    'd564255e-f767-466b-860d-6dcb63afe4cc'
+)
+
+handle_response(response)
+# Note that response.success_response will be empty
+```
+
+[Check the API docs for this endpoint](https://fusionauth.io/docs/apis/applications#delete-an-application)
+
+### Lock a User
+
+To [prevent a User from logging in](https://fusionauth.io/docs/get-started/core-concepts/users), use `deactivateUser()`.
+
+```ruby
+response = client.deactivate_user(
+    'fa0bc822-793e-45ee-a7f4-04bfb6a28199',
+)
+
+handle_response(response)
+```
+
+[Check the API docs for this endpoint](https://fusionauth.io/docs/apis/users#delete-a-user)
+
+### Registering a User
+
+To [register a User in an Application](https://fusionauth.io/docs/get-started/core-concepts/users#registrations), use `register()`.
+
+The code below also adds a `customer` role and a custom `appBackgroundColor` property to the User Registration.
+
+```ruby
+response = client.register(
+    'fa0bc822-793e-45ee-a7f4-04bfb6a28199',
+    {
+        :registration => {
+            :applicationId => 'd564255e-f767-466b-860d-6dcb63afe4cc',
+            :roles => [
+                'customer',
+            ],
+            :data => {
+                :appBackgroundColor => '#096324',
+            },
+        },
+    }
+)
+
+handle_response(response)
+```
+
+[Check the API docs for this endpoint](https://fusionauth.io/docs/apis/registrations#create-a-user-registration-for-an-existing-user)
+
+# Documentation
+
+Documentation can be found at
+[doc](https://github.com/FusionAuth/fusionauth-ruby-client/tree/master/doc).
+
+<!--
+end::forDocSite[]
+-->
+
+## Questions and support
+
+
+If you find any bugs in this library, [please open an issue](https://github.com/FusionAuth/fusionauth-ruby-client/issues). Note that changes to the `FusionAuthClient` class have to be done on the [FusionAuth Client Builder repository](https://github.com/FusionAuth/fusionauth-client-builder/blob/master/src/main/client/ruby.client.ftl), which is responsible for generating that file.
+
+But if you have a question or support issue, we'd love to hear from you.
+
+If you have a paid plan with support included, please [open a ticket in your account portal](https://account.fusionauth.io/account/support/). Learn more about [paid plan here](https://fusionauth.io/pricing).
+
+Otherwise, please [post your question in the community forum](https://fusionauth.io/community/forum/).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/FusionAuth/fusionauth-ruby-client.
+
+Note: if you want to change the `FusionAuthClient` class, you have to do it on the [FusionAuth Client Builder repository](https://github.com/FusionAuth/fusionauth-client-builder/blob/master/src/main/client/ruby.client.ftl), which is responsible for generating all client libraries we support.
+
+## License
+
+This code is available as open source under the terms of the [Apache v2.0 License](https://opensource.org/blog/license/apache-2-0).
+
+
+## Upgrade Policy
+
+This library is built automatically to keep track of the FusionAuth API, and may also receive updates with bug fixes, security patches, tests, code samples, or documentation changes.
+
+These releases may also update dependencies, language engines, and operating systems, as we\'ll follow the deprecation and sunsetting policies of the underlying technologies that it uses.
+
+This means that after a dependency (e.g. language, framework, or operating system) is deprecated by its maintainer, this library will also be deprecated by us, and will eventually be updated to use a newer version.

data/build.savant

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018-2023, FusionAuth, All Rights Reserved
+ * Copyright (c) 2018-2024, FusionAuth, 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.
@@ -15,7 +15,7 @@
  */
 
 pubVersion = ""
-project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.49.1", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.50.0", licenses: ["ApacheV2_0"]) {
   workflow {
     fetch {
       cache()