oktakit 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4d2b1dd5d6eee741338e02a62ea9cb64ae2782fd3663a4ee29a31a9b134bfce
-  data.tar.gz: b603e424a30b4940c6d957738c4873542f0a197f48552f5e914e92265b871033
+  metadata.gz: 81679c7021e11c6ee3e2a0f1366612b1bbed87103abbdf330419877c3b07032a
+  data.tar.gz: 55825fdd98c661f3b2fe29452ff441bf6eeabd096f51fa64a4d7050ca9176fab
 SHA512:
-  metadata.gz: 831cfddb2979a460730e874e37bccc9d1299daa48f2d41c3f6b8e7023d2183691565b5766d6b4062ec9f6e12baf143d66386ca66d62d49983c2ed6fdc8b44226
-  data.tar.gz: d49f7e8f455c5dbc642daa70609dfa4a352dfb88dd788d4ae62c882e434085cb961c2eb5ac13b4fc555cef00922f64bd367411e4c9a8330f5fe1d48ce84de6e5
+  metadata.gz: 3d3bb048652c9cb5fd02433b819d881bcd58f516aadd899a3db0c3afac0fd62c9035e57f7e091fa0ea2bb24dfd3b0d3d3fd4dfcafc2638e147e3fe1555dca385
+  data.tar.gz: 275a1957f10d7eaeb682c6e518018f3635c43ff10e4dafd5f067431f95a32c87d68b9b83885d70bcfd3f18a5ec82697113d074f203bb5e6888633c74f21dbec7

data/.github/dependabot.yml

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

data/.github/workflows/ci.yml

@@ -3,10 +3,10 @@ name: CI
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     branches:
-      - master
+      - main
 
 jobs:
   build:
@@ -14,12 +14,12 @@ jobs:
     name: Ruby ${{ matrix.ruby }}
     strategy:
       matrix:
-        ruby: [2.6, 2.7, 3.0, 3.1]
+        ruby: ["3.3", "3.4", "4.0"]
     steps:
     - name: Check out code
-      uses: actions/checkout@v2
+      uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
     - name: Set up Ruby ${{ matrix.ruby }}
-      uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@7f797815d8adceb1c412e7abefdd1ab4abc47a5f # v1.335.0
       with:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true

data/.github/workflows/release.yml

@@ -0,0 +1,70 @@
+name: Release gem on RubyGems.org and create GitHub release
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  release_gem:
+    name: Release gem on RubyGems.org
+    if: github.repository == 'Shopify/oktakit'
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      id-token: write
+
+    environment: release
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@7f797815d8adceb1c412e7abefdd1ab4abc47a5f # v1.335.0
+        with:
+          bundler-cache: true
+
+      - name: Validate release tag
+        env:
+          RELEASE_TAG: ${{ github.ref_name }}
+        run: |
+          git merge-base --is-ancestor HEAD origin/main || {
+            echo "::error::Release tags must point to a commit on main"
+            exit 1
+          }
+          ruby -Ilib -roktakit/version -e '
+            expected = "v#{Oktakit::VERSION}"
+            actual = ENV.fetch("RELEASE_TAG")
+            unless actual == expected
+              puts "::error::Release tag must be #{expected}, not #{actual}"
+              exit 1
+            end
+          '
+
+      - name: Release gem on RubyGems.org
+        uses: rubygems/release-gem@7f9650160c1a4e7989fdc9855807bdbd421d8b6b # v1.4.1
+
+  release_github:
+    name: Create GitHub release
+    if: github.repository == 'Shopify/oktakit'
+    needs: release_gem
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+
+      - name: Create GitHub release
+        run: |
+          tag_name="$(git describe --tags --abbrev=0)"
+          gh release create "${tag_name}" --verify-tag --generate-notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.rubocop.yml

@@ -4,7 +4,6 @@ inherit_gem:
   rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
   SuggestExtensions: false
 
 # Allow .ruby-version and spec.required_ruby_version to differ

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+4.0.9

data/Gemfile

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 source 'https://rubygems.org'
 
+gem 'base64'
 gem 'byebug'
 gem 'rake'
 gem 'yard'

data/Gemfile.lock

@@ -1,73 +1,99 @@
 PATH
   remote: .
   specs:
-    oktakit (1.0.0)
+    oktakit (1.1.0)
       faraday (>= 2.0.1, < 3)
       sawyer (>= 0.8.1, < 0.10)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.4)
-      public_suffix (>= 2.0.2, < 6.0)
-    ast (2.4.2)
-    byebug (11.1.3)
-    diff-lcs (1.4.4)
-    faraday (2.7.10)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
-    parallel (1.21.0)
-    parser (3.0.3.2)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    byebug (13.0.0)
+      reline (>= 0.6.0)
+    diff-lcs (1.6.2)
+    faraday (2.15.1)
+      faraday-net_http (>= 2.0, < 3.6)
+      json
+      logger
+    faraday-net_http (3.5.0)
+      net-http (~> 0.5)
+    io-console (0.9.4)
+    json (3.1.0)
+    language_server-protocol (3.17.0.6)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    net-http (0.10.0)
+      net-protocol (>= 0.3.0)
+      uri (>= 0.11.1)
+    net-protocol (0.4.0)
+      timeout
+    parallel (2.3.0)
+    parser (3.3.13.0)
       ast (~> 2.4.1)
-    public_suffix (5.0.3)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.2.0)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+      racc
+    prism (1.9.0)
+    public_suffix (7.0.5)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.4.2)
+    regexp_parser (2.13.1)
+    reline (0.7.0)
+      io-console (~> 0.5)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.23.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    rubocop (1.92.1)
+      json (>= 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (>= 1.10)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      regexp_parser (>= 2.11.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.0)
-      parser (>= 3.0.1.1)
-    rubocop-shopify (2.3.0)
-      rubocop (~> 1.22)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    sawyer (0.9.2)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.50.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-shopify (3.1.0)
+      lint_roller
+      rubocop (~> 1.89)
+    ruby-progressbar (1.13.0)
+    sawyer (0.9.3)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
-    unicode-display_width (2.1.0)
-    vcr (6.0.0)
-    webrick (1.7.0)
-    yard (0.9.27)
-      webrick (~> 1.7.0)
+    timeout (0.6.1)
+    unicode-display_width (3.3.0)
+      unicode-emoji (~> 4.3)
+    unicode-emoji (4.3.0)
+    uri (1.1.2)
+    vcr (6.4.0)
+    yard (0.9.45)
 
 PLATFORMS
   -darwin-21
   arm64-darwin-21
+  arm64-darwin-24
+  ruby
   x86_64-linux
 
 DEPENDENCIES
+  base64
   bundler
   byebug
   oktakit!
@@ -79,4 +105,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.3.24
+  4.0.20

data/README.md

@@ -47,7 +47,11 @@ response, http_status = client.list_users(paginate: true)
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, and merge the change to `main`. Then push a `vX.Y.Z` tag for that commit. The `Release` GitHub Actions workflow uses [trusted publishing](https://guides.rubygems.org/trusted-publishing/) to push the gem to [rubygems.org](https://rubygems.org), and then creates a GitHub release for the tag. The release notes list the merged pull requests.
+
+The changes in each version are in the [GitHub releases](https://github.com/Shopify/oktakit/releases).
 
 ## Testing
 

data/dev.yml

@@ -3,7 +3,7 @@
 name: oktakit
 
 up:
-  - ruby: 2.7.2
+  - ruby
   - bundler
 
 commands:

data/lib/oktakit/client/admin_roles.rb

@@ -14,7 +14,7 @@ module Oktakit
       # @example
       #   Oktakit.list_roles_assigned_to_user('id')
       def list_roles_assigned_to_user(id, options = {})
-        get("/users/#{id}/roles", options)
+        get("/users/#{path_segment(id)}/roles", options)
       end
 
       # Assign Role to User
@@ -30,7 +30,7 @@ module Oktakit
       # @example
       #   Oktakit.assign_role_to_user('id')
       def assign_role_to_user(id, options = {})
-        post("/users/#{id}/roles", options)
+        post("/users/#{path_segment(id)}/roles", options)
       end
 
       # Unassign Role from User
@@ -47,7 +47,7 @@ module Oktakit
       # @example
       #   Oktakit.unassign_role_from_user('user_id', 'role_id')
       def unassign_role_from_user(user_id, role_id, options = {})
-        delete("/users/#{user_id}/roles/#{role_id}", options)
+        delete("/users/#{path_segment(user_id)}/roles/#{path_segment(role_id)}", options)
       end
 
       # List Group Targets for User Admin Role
@@ -64,7 +64,7 @@ module Oktakit
       # @example
       #   Oktakit.list_group_targets_for_user_admin_role('user_id', 'role_id')
       def list_group_targets_for_user_admin_role(user_id, role_id, options = {})
-        get("/users/#{user_id}/roles/#{role_id}/targets/groups", options)
+        get("/users/#{path_segment(user_id)}/roles/#{path_segment(role_id)}/targets/groups", options)
       end
 
       # Add Group Target to User Admin Role
@@ -82,7 +82,8 @@ module Oktakit
       # @example
       #   Oktakit.add_group_target_to_user_admin_role('group_id', 'user_id', 'role_id')
       def add_group_target_to_user_admin_role(user_id, role_id, group_id, options = {})
-        put("/users/#{user_id}/roles/#{role_id}/targets/groups/#{group_id}", options)
+        role = "/users/#{path_segment(user_id)}/roles/#{path_segment(role_id)}"
+        put("#{role}/targets/groups/#{path_segment(group_id)}", options)
       end
 
       # Remove Group Target from User Admin Role
@@ -100,7 +101,8 @@ module Oktakit
       # @example
       #   Oktakit.remove_group_target_from_user_admin_role('group_id', 'user_id', 'role_id')
       def remove_group_target_from_user_admin_role(user_id, role_id, group_id, options = {})
-        delete("/users/#{user_id}/roles/#{role_id}/targets/groups/#{group_id}", options)
+        role = "/users/#{path_segment(user_id)}/roles/#{path_segment(role_id)}"
+        delete("#{role}/targets/groups/#{path_segment(group_id)}", options)
       end
 
       # List App Targets for App Admin Role
@@ -117,7 +119,7 @@ module Oktakit
       # @example
       #   Oktakit.list_app_targets_for_app_admin_role('user_id', 'role_id')
       def list_app_targets_for_app_admin_role(user_id, role_id, options = {})
-        get("/users/#{user_id}/roles/#{role_id}/targets/catalog/apps", options)
+        get("/users/#{path_segment(user_id)}/roles/#{path_segment(role_id)}/targets/catalog/apps", options)
       end
 
       # Add App Target to App Admin Role
@@ -135,7 +137,8 @@ module Oktakit
       # @example
       #   Oktakit.add_app_target_to_app_admin_role('user_id', 'role_id')
       def add_app_target_to_app_admin_role(user_id, role_id, app_name, options = {})
-        put("/users/#{user_id}/roles/#{role_id}/targets/catalog/apps/#{app_name}", options)
+        role = "/users/#{path_segment(user_id)}/roles/#{path_segment(role_id)}"
+        put("#{role}/targets/catalog/apps/#{path_segment(app_name)}", options)
       end
 
       # Remove App Target from App Admin Role
@@ -153,7 +156,8 @@ module Oktakit
       # @example
       #   Oktakit.remove_app_target_from_app_admin_role('user_id', 'role_id')
       def remove_app_target_from_app_admin_role(user_id, role_id, app_name, options = {})
-        delete("/users/#{user_id}/roles/#{role_id}/targets/catalog/apps/#{app_name}", options)
+        role = "/users/#{path_segment(user_id)}/roles/#{path_segment(role_id)}"
+        delete("#{role}/targets/catalog/apps/#{path_segment(app_name)}", options)
       end
     end
   end

data/lib/oktakit/client/apps.rb

@@ -29,7 +29,7 @@ module Oktakit
       # @example
       #   Oktakit.get_application('id')
       def get_application(id, options = {})
-        get("/apps/#{id}", options)
+        get("/apps/#{path_segment(id)}", options)
       end
 
       # List Applications
@@ -60,7 +60,7 @@ module Oktakit
       # @example
       #   Oktakit.update_application('id')
       def update_application(id, options = {})
-        put("/apps/#{id}", options)
+        put("/apps/#{path_segment(id)}", options)
       end
 
       # Delete Application
@@ -76,7 +76,7 @@ module Oktakit
       # @example
       #   Oktakit.delete_application('id')
       def delete_application(id, options = {})
-        delete("/apps/#{id}", options)
+        delete("/apps/#{path_segment(id)}", options)
       end
 
       # Activate Application
@@ -92,7 +92,7 @@ module Oktakit
       # @example
       #   Oktakit.activate_application('id')
       def activate_application(id, options = {})
-        post("/apps/#{id}/lifecycle/activate", options)
+        post("/apps/#{path_segment(id)}/lifecycle/activate", options)
       end
 
       # Deactivate Application
@@ -108,7 +108,7 @@ module Oktakit
       # @example
       #   Oktakit.deactivate_application('id')
       def deactivate_application(id, options = {})
-        post("/apps/#{id}/lifecycle/deactivate", options)
+        post("/apps/#{path_segment(id)}/lifecycle/deactivate", options)
       end
 
       # Assign User to Application for SSO
@@ -124,7 +124,7 @@ module Oktakit
       # @example
       #   Oktakit.assign_user_to_application_for_sso('id')
       def assign_user_to_application_for_sso(id, options = {})
-        post("/apps/#{id}/users", options)
+        post("/apps/#{path_segment(id)}/users", options)
       end
 
       # Assign User to Application for SSO & Provisioning
@@ -140,7 +140,7 @@ module Oktakit
       # @example
       #   Oktakit.assign_user_to_application_for_sso_provisioning('id')
       def assign_user_to_application_for_sso_provisioning(id, options = {})
-        post("/apps/#{id}/users", options)
+        post("/apps/#{path_segment(id)}/users", options)
       end
 
       # Get Assigned User for Application
@@ -157,7 +157,7 @@ module Oktakit
       # @example
       #   Oktakit.get_assigned_user_for_application('user_id', 'app_id')
       def get_assigned_user_for_application(app_id, user_id, options = {})
-        get("/apps/#{app_id}/users/#{user_id}", options)
+        get("/apps/#{path_segment(app_id)}/users/#{path_segment(user_id)}", options)
       end
 
       # List Users Assigned to Application
@@ -173,7 +173,7 @@ module Oktakit
       # @example
       #   Oktakit.list_users_assigned_to_application('id')
       def list_users_assigned_to_application(id, options = {})
-        get("/apps/#{id}/users", options)
+        get("/apps/#{path_segment(id)}/users", options)
       end
 
       # List Applications Assigned to User
@@ -189,7 +189,14 @@ module Oktakit
       # @example
       #  Oktakit.list_applications_assigned_to_user('<user_id>')
       def list_applications_assigned_to_user(user_id, options = {})
-        get("/apps?filter=user.id+eq+\"#{user_id}\"&expand=user/#{user_id}", options)
+        id = user_id.to_s
+        raise ArgumentError, "Invalid user ID: #{user_id.inspect}" if id.empty?
+
+        # Okta filter string literals must be valid JSON strings, so to_json escapes quotes and backslashes.
+        # The filter and expand values here always win over any caller-supplied ones.
+        query = (options[:query] || {}).reject { |key, _| ["filter", "expand"].include?(key.to_s) }
+        query = query.merge(filter: "user.id eq #{id.to_json}", expand: "user/#{id}")
+        get("/apps", options.merge(query: query))
       end
 
       # Update Application Credentials for Assigned User
@@ -206,7 +213,7 @@ module Oktakit
       # @example
       #   Oktakit.update_application_credentials_for_assigned_user('user_id', 'app_id')
       def update_application_credentials_for_assigned_user(app_id, user_id, options = {})
-        post("/apps/#{app_id}/users/#{user_id}", options)
+        post("/apps/#{path_segment(app_id)}/users/#{path_segment(user_id)}", options)
       end
 
       # Update Application Profile for Assigned User
@@ -223,7 +230,7 @@ module Oktakit
       # @example
       #   Oktakit.update_application_profile_for_assigned_user('user_id', 'app_id')
       def update_application_profile_for_assigned_user(app_id, user_id, options = {})
-        post("/apps/#{app_id}/users/#{user_id}", options)
+        post("/apps/#{path_segment(app_id)}/users/#{path_segment(user_id)}", options)
       end
 
       # Remove User from Application
@@ -240,7 +247,7 @@ module Oktakit
       # @example
       #   Oktakit.remove_user_from_application('user_id', 'app_id')
       def remove_user_from_application(app_id, user_id, options = {})
-        delete("/apps/#{app_id}/users/#{user_id}", options)
+        delete("/apps/#{path_segment(app_id)}/users/#{path_segment(user_id)}", options)
       end
 
       # Assign Group to Application
@@ -257,7 +264,7 @@ module Oktakit
       # @example
       #   Oktakit.assign_group_to_application('group_id', 'app_id')
       def assign_group_to_application(app_id, group_id, options = {})
-        put("/apps/#{app_id}/groups/#{group_id}", options)
+        put("/apps/#{path_segment(app_id)}/groups/#{path_segment(group_id)}", options)
       end
 
       # Get Assigned Group for Application
@@ -274,7 +281,7 @@ module Oktakit
       # @example
       #   Oktakit.get_assigned_group_for_application('group_id', 'app_id')
       def get_assigned_group_for_application(app_id, group_id, options = {})
-        get("/apps/#{app_id}/groups/#{group_id}", options)
+        get("/apps/#{path_segment(app_id)}/groups/#{path_segment(group_id)}", options)
       end
 
       # List Groups Assigned to Application
@@ -290,7 +297,7 @@ module Oktakit
       # @example
       #   Oktakit.list_groups_assigned_to_application('id')
       def list_groups_assigned_to_application(id, options = {})
-        get("/apps/#{id}/groups", options)
+        get("/apps/#{path_segment(id)}/groups", options)
       end
 
       # Remove Group from Application
@@ -307,7 +314,7 @@ module Oktakit
       # @example
       #   Oktakit.remove_group_from_application('group_id', 'app_id')
       def remove_group_from_application(app_id, group_id, options = {})
-        delete("/apps/#{app_id}/groups/#{group_id}", options)
+        delete("/apps/#{path_segment(app_id)}/groups/#{path_segment(group_id)}", options)
       end
 
       # Generate New Application Key Credential
@@ -323,7 +330,7 @@ module Oktakit
       # @example
       #   Oktakit.generate_new_application_key_credential('app_id')
       def generate_new_application_key_credential(app_id, options = {})
-        post("/apps/#{app_id}/credentials/keys/generate", options)
+        post("/apps/#{path_segment(app_id)}/credentials/keys/generate", options)
       end
 
       # List Key Credentials for Application
@@ -339,7 +346,7 @@ module Oktakit
       # @example
       #   Oktakit.list_key_credentials_for_application('app_id')
       def list_key_credentials_for_application(app_id, options = {})
-        get("/apps/#{app_id}/credentials/keys", options)
+        get("/apps/#{path_segment(app_id)}/credentials/keys", options)
       end
 
       # Get Key Credential for Application
@@ -356,7 +363,7 @@ module Oktakit
       # @example
       #   Oktakit.get_key_credential_for_application('app_id', 'key_id')
       def get_key_credential_for_application(app_id, key_id, options = {})
-        get("/apps/#{app_id}/credentials/keys/#{key_id}", options)
+        get("/apps/#{path_segment(app_id)}/credentials/keys/#{path_segment(key_id)}", options)
       end
 
       # Preview SAML metadata for Application
@@ -372,7 +379,7 @@ module Oktakit
       # @example
       #   Oktakit.preview_saml_metadata_for_application('app_id')
       def preview_saml_metadata_for_application(app_id, options = {})
-        get("/apps/#{app_id}/sso/saml/metadata", options)
+        get("/apps/#{path_segment(app_id)}/sso/saml/metadata", options)
       end
     end
   end