oktakit 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c9ab3f2927fb37bff5e7f744fef1b776cea1e177
-  data.tar.gz: 14e391e87f55541c6ed309023e415e455e452486
+SHA256:
+  metadata.gz: c1fe01d108abe860a7ac491800fbb764ee376f75347117c4e3d190b362f60792
+  data.tar.gz: e679278c7cc07668e9d46b8147df2b0b8103190f4e63e4c716d73b0592f27784
 SHA512:
-  metadata.gz: 60452d050ed044d24b3cc167ed21e785d6ac16afb728f88090355f637c9a794e9d9bb9cfb63d09ccbc3511f06a08ebad76350843df0c4f6556f854761e709839
-  data.tar.gz: f5e11f04ef1b29c96c7f4093ce6bc4c53abf2e3a7c470ce7e1af672cc9d5eb15b286504ffcb2c09af0a175b0dbbfe09cac98700f3d4ca1b39f0e186acfa6ca6a
+  metadata.gz: 18a8717946d4430395cd9b84b2a5fc2d80af63190fe32bbfafbbdf080add411ffcb98dbc4b19693f0292eba5c644b1db6de742c97c887d77d34401ed60c30014
+  data.tar.gz: 57533c0ebcf0369fc7d7d8f58087af0c744a4b5908c9b3ec17c0b8433a3e1ee5cef7768455b73d759c301191ad303508dff944965d83bb734510c020f03f3ddb

data/.github/probots.yml

@@ -0,0 +1,2 @@
+enabled:
+  - cla

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}
+    strategy:
+      matrix:
+        ruby: [2.6, 2.7, 3.0, 3.1]
+    steps:
+    - name: Check out code
+      uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Ruby tests
+      run: bundle exec rspec

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -9,3 +8,4 @@
 /tmp/
 .byebug_history
 .DS_Store
+*.gem

data/.rubocop.yml

@@ -1,88 +1,16 @@
 # This file strictly follows the rules defined in the Ruby style guide:
 #   http://shopify.github.io/ruby-style-guide/
+inherit_gem:
+  rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
 
-Rails:
+# Allow .ruby-version and spec.required_ruby_version to differ
+# to run a newer Ruby version for Rubocop, but don't force users to upgrade
+Gemspec/RequiredRubyVersion:
   Enabled: false
 
-Lint/AssignmentInCondition:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/MultilineOperationIndentation:
-  Enabled: false
-
-Style/AlignParameters:
-  EnforcedStyle: with_fixed_indentation
-
-Style/FirstParameterIndentation:
-  EnforcedStyle: consistent
-
-Style/TrailingCommaInLiteral:
-  Enabled: false
-
-Style/SignalException:
-  EnforcedStyle: only_raise
-
-Style/NumericLiterals:
-  Enabled: false
-
-Style/CaseIndentation:
-  EnforcedStyle: end
-
-Style/IndentHash:
-  EnforcedStyle: consistent
-
-Style/WordArray:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: false
-
-Metrics/LineLength:
-  Max: 120
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/BlockLength:
-  Exclude:
-    - "**/*_spec.rb"
-
-Metrics/ParameterLists:
-  Max: 5
-  CountKeywordArgs: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-Lint/EndAlignment:
-  EnforcedStyleAlignWith: variable
-
 Style/FrozenStringLiteralComment:
   Enabled: false
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/MutableConstant:
-  Enabled: false
-
-Performance/Casecmp:
-  Enabled: false
-
-Style/GuardClause:
-  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/.travis.yml

@@ -1,7 +1,5 @@
-sudo: false
+language: ruby
+os: linux
 before_install: gem install bundler
 rvm:
-  - '2.1'
-  - '2.2'
-  - '2.3.1'
-
+  - '2.6.0'

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## [v0.3.0] - 2022-01-20
+- [Adds support for Ruby 3](https://github.com/Shopify/oktakit/pull/42)
+- [Adds support for user reactivation endpoint](https://github.com/Shopify/oktakit/pull/47)
+- [Adds support for app user schema operations endpoint](https://github.com/Shopify/oktakit/pull/32)
+- [Makes custom error details available](https://github.com/Shopify/oktakit/pull/48)
+
+## [v0.2.1] - 2021-10-14
+- Adds support for [Group Rule operations](https://developer.okta.com/docs/reference/api/groups/#group-rule-operations)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at security@shopify.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gem 'byebug'
 gem 'rake'
-gem 'rubocop'
 gem 'yard'
 
 group :test do
-  gem 'rspec', '~> 3.2'
-  gem 'vcr', '~> 2.9', github: 'vcr/vcr', branch: 'master', ref: '480304be6d73803e6c4a0eb21a4ab4091da558d8'
+  gem 'rubocop'
+  gem 'rubocop-shopify', require: false
+  gem 'rspec', '~> 3.10'
+  gem 'vcr', '~> 6.0'
 end
 
 gemspec

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    oktakit (0.3.0)
+      sawyer (~> 0.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    faraday (1.9.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    multipart-post (2.1.1)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      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)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.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.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    unicode-display_width (2.1.0)
+    vcr (6.0.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  -darwin-21
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  byebug
+  oktakit!
+  rake
+  rspec (~> 3.10)
+  rubocop
+  rubocop-shopify
+  vcr (~> 6.0)
+  yard
+
+BUNDLED WITH
+   2.2.22

data/README.md

@@ -15,11 +15,13 @@ gem 'oktakit'
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 ## Usage
 
-`Oktakit` follows similar patterns as found in [`Octokit`](https://github.com/octokit/octokit.rb). So if you are familiar with Oktakit, then you should feel right at home.
+`Oktakit` follows similar patterns as found in [`Octokit`](https://github.com/octokit/octokit.rb). So if you are familiar with Octokit, then you should feel right at home.
 
 ```ruby
 client = Oktakit.new(token: 't0k3n', organization: 'my-great-org')
@@ -32,7 +34,8 @@ To work with the Okta sandbox (`<organization>.oktapreview.com`), set the `api_e
 client = Oktakit.new(token: 't0k3n', api_endpoint: 'https://my-great-org.oktapreview.com/api/v1')
 ```
 
-#### Pagination
+### Pagination
+
 Pass the `paginate` flag as options for any `get` action for Oktakit to autopaginate the response for you.
 
 ```ruby
@@ -59,8 +62,13 @@ The [API Test Client](https://developer.okta.com/docs/api/getting_started/api_te
 
 ## Contributing
 
-1. Fork it ( https://github.com/shopify/oktakit/fork )
+1. Fork it ( <https://github.com/shopify/oktakit/fork> )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+### Contributor License Agreement
+
+ New contributors will be required to sign [Shopify's Contributor License Agreement (CLA)](https://cla.shopify.com/).
+ There are two versions of the CLA: one for individuals and one for organizations.

data/dev.yml

@@ -3,13 +3,9 @@
 name: oktakit
 
 up:
-  - ruby: 2.3.1
+  - ruby: 2.6.6
   - bundler
 
 commands:
   test: bundle exec rspec
   console: bin/console
-
-packages:
-  - git@github.com:Shopify/dev-shopify.git
-

data/lib/oktakit/client/apps.rb

@@ -176,6 +176,22 @@ module Oktakit
         get("/apps/#{id}/users", options)
       end
 
+      # List Applications Assigned to User
+      #
+      # @params user_id [string] User ID
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return [Array<Sawyer::Resource>] Array of Applications Assigned to User
+      # @see https://developer.okta.com/docs/api/resources/apps#list-applications-assigned-to-user
+      # @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)
+      end
+
       # Update Application Credentials for Assigned User
       #
       # @params app_id [string] Application ID

data/lib/oktakit/client/group_rules.rb

@@ -0,0 +1,115 @@
+module Oktakit
+  class Client
+    module GroupRules
+      # Add Group Rule
+      #
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return [Hash<Sawyer::Resource>] The created Group Rule.
+      # @see https://developer.okta.com/docs/reference/api/groups/#create-group-rule
+      # @example
+      #   Oktakit.add_group_rule
+      def add_group_rule(options = {})
+        post('/groups/rules', options)
+      end
+
+      # Get Group Rule
+      #
+      # @params id [string] Group Rule ID
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return [Hash<Sawyer::Resource>] Fetched Group Rule
+      # @see https://developer.okta.com/docs/reference/api/groups/#get-group-rule
+      # @example
+      #   Oktakit.get_group_rule('id')
+      def get_group_rule(id, options = {})
+        get("/groups/rules/#{id}", options)
+      end
+
+      # List Group Rules
+      #
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return [Array<Sawyer::Resource>] Array of Group Rules
+      # @see https://developer.okta.com/docs/reference/api/groups/#list-group-rules
+      # @example
+      #   Oktakit.list_group_rules
+      def list_group_rules(options = {})
+        get('/groups/rules', options)
+      end
+
+      # Update Group Rule
+      #
+      # @params id [string] Group Rule ID
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return [Hash<Sawyer::Resource>] Updated Group Rule
+      # @see https://developer.okta.com/docs/reference/api/groups/#update-group-rule
+      # @example
+      #   Oktakit.update_group_rule('id')
+      def update_group_rule(id, options = {})
+        put("/groups/rules/#{id}", options)
+      end
+
+      # Remove Group Rule
+      #
+      # @params id [string] Group ID
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return  HTTP 202 Accepted
+      # @see https://developer.okta.com/docs/reference/api/groups/#delete-a-group-rule
+      # @example
+      #   Oktakit.remove_group_rule('id')
+      def remove_group_rule(id, options = {})
+        delete("/groups/rules/#{id}", options)
+      end
+
+      # Activate Group Rule
+      #
+      # @params id [string] Group ID
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return  HTTP 204 No Content
+      # @see https://developer.okta.com/docs/reference/api/groups/#activate-a-group-rule
+      # @example
+      #   Oktakit.activate_group_rule('id')
+      def activate_group_rule(id, options = {})
+        post("/groups/rules/#{id}/lifecycle/activate", options)
+      end
+
+      # Deactivate Group Rule
+      #
+      # @params id [string] Group ID
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return  HTTP 204 No Content
+      # @see https://developer.okta.com/docs/reference/api/groups/#deactivate-a-group-rule
+      # @example
+      #   Oktakit.deactivate_group_rule('id')
+      def deactivate_group_rule(id, options = {})
+        post("/groups/rules/#{id}/lifecycle/deactivate", options)
+      end
+    end
+  end
+end

data/lib/oktakit/client/schemas.rb

@@ -60,6 +60,70 @@ module Oktakit
       def remove_property_from_user_profile_schema(options = {})
         post('/meta/schemas/user/default', options)
       end
+
+      # Get App User Schema
+      #
+      # @params id [string] Application ID
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return [Hash<Sawyer::Resource>] User Schema
+      # @see https://developer.okta.com/docs/reference/api/schemas/#get-app-user-schema
+      # @example
+      #   Oktakit.get_app_user_schema('id')
+      def get_app_user_schema(id, options = {})
+        get("/meta/schemas/apps/#{id}/default", options)
+      end
+
+      # Add Property to App User Profile Schema
+      #
+      # @params id [string] Application ID
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return [Hash<Sawyer::Resource>] User Schema
+      # @see https://developer.okta.com/docs/reference/api/schemas/#add-property-to-app-user-profile-schema
+      # @example
+      #   Oktakit.add_property_to_app_user_profile_schema('id')
+      def add_property_to_app_user_profile_schema(id, options = {})
+        post("/meta/schemas/apps/#{id}/default", options)
+      end
+
+      # Update App User Profile Schema property
+      #
+      # @params id [string] Application ID
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return [Hash<Sawyer::Resource>] User Schema
+      # @see https://developer.okta.com/docs/reference/api/schemas/#update-app-user-profile-schema-property
+      # @example
+      #   Oktakit.update_app_user_profile_schema_property('id')
+      def update_app_user_profile_schema_property(id, options = {})
+        post("/meta/schemas/apps/#{id}/default", options)
+      end
+
+      # Remove property from App User Profile Schema
+      #
+      # @params id [string] Application ID
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return [Hash<Sawyer::Resource>] User Schema
+      # @see https://developer.okta.com/docs/reference/api/schemas/#remove-property-from-app-user-profile-schema
+      # @example
+      #   Oktakit.remove_property_from_app_user_profile_schema('id')
+      def remove_property_from_app_user_profile_schema(id, options = {})
+        post("/meta/schemas/apps/#{id}/default", options)
+      end
     end
   end
 end

data/lib/oktakit/client/users.rb

@@ -9,7 +9,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Returns the created User.
-      # @see http://developer.okta.com/docs/api/resources/users.html#create-user
+      # @see https://developer.okta.com/docs/api/resources/users#create-user
       # @example
       #   Oktakit.create_user
       def create_user(options = {})
@@ -25,7 +25,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Fetched User
-      # @see http://developer.okta.com/docs/api/resources/users.html#get-user
+      # @see https://developer.okta.com/docs/api/resources/users#get-user
       # @example
       #   Oktakit.get_user('id')
       def get_user(id, options = {})
@@ -40,7 +40,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Array<Sawyer::Resource>] Array of User
-      # @see http://developer.okta.com/docs/api/resources/users.html#list-users
+      # @see https://developer.okta.com/docs/api/resources/users#list-users
       # @example
       #   Oktakit.list_users
       def list_users(options = {})
@@ -54,13 +54,18 @@ module Oktakit
       # @param options[:headers] [Hash] Optional. Header params for the request.
       # @param options[:accept] [String] Optional. The content type to accept. Default application/json
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options[:partial] [Boolean] Indicates a partial update, in which case POST will be used instead of PUT
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Updated User
-      # @see http://developer.okta.com/docs/api/resources/users.html#update-user
+      # @see https://developer.okta.com/docs/api/resources/users#update-user
       # @example
       #   Oktakit.update_user('id')
       def update_user(id, options = {})
-        put("/users/#{id}", options)
+        if options.delete(:partial)
+          post("/users/#{id}", options)
+        else
+          put("/users/#{id}", options)
+        end
       end
 
       # Update Profile
@@ -72,7 +77,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Updated User
-      # @see http://developer.okta.com/docs/api/resources/users.html#update-profile
+      # @see https://developer.okta.com/docs/api/resources/users#update-profile
       # @example
       #   Oktakit.update_profile('id')
       def update_profile(id, options = {})
@@ -87,7 +92,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Array<Sawyer::Resource>] Array of App Links
-      # @see http://developer.okta.com/docs/api/resources/users.html#get-assigned-app-links
+      # @see https://developer.okta.com/docs/api/resources/users#get-assigned-app-links
       # @example
       #   Oktakit.get_assigned_app_links('id')
       def get_assigned_app_links(id, options = {})
@@ -103,7 +108,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Array<Sawyer::Resource>] Array of Groups
-      # @see http://developer.okta.com/docs/api/resources/users.html#get-member-groups
+      # @see https://developer.okta.com/docs/api/resources/users#get-member-groups
       # @example
       #   Oktakit.get_member_groups('id')
       def get_member_groups(id, options = {})
@@ -119,13 +124,31 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Returns empty object by default. If sendEmail is false, a user activation link.
-      # @see http://developer.okta.com/docs/api/resources/users.html#activate-user
+      # @see https://developer.okta.com/docs/api/resources/users#activate-user
       # @example
       #   Oktakit.activate_user('id')
       def activate_user(id, options = {})
         post("/users/#{id}/lifecycle/activate", options)
       end
 
+      # Reactivate User
+      #
+      # @params id [string] User ID
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for request.
+      # @return [Hash<Sawyer::Resource>].
+      # @note The user must be in a PROVISIONED status
+      # @see https://developer.okta.com/docs/reference/api/users/#reactivate-user
+      # @example
+      #   Oktakit.reactivate_user('id')
+
+      def reactivate_user(id, options = {})
+        post("/users/#{id}/lifecycle/reactivate", options)
+      end
+
       # Deactivate User
       #
       # @params id [string] User ID
@@ -135,13 +158,31 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Returns an empty object.
-      # @see http://developer.okta.com/docs/api/resources/users.html#deactivate-user
+      # @see https://developer.okta.com/docs/api/resources/users#deactivate-user
       # @example
       #   Oktakit.deactivate_user('id')
       def deactivate_user(id, options = {})
         post("/users/#{id}/lifecycle/deactivate", options)
       end
 
+      # Delete User
+      #
+      # @params id [string] User ID
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for the request.
+      # @return 204 'No Content'
+      # @note Deletes a user permanently. This operation can only be performed on users that have a DEPROVISIONED status. This action cannot be recovered!
+      # This operation on a user that hasn't been deactivated causes that user to be deactivated. A second delete operation is required to delete the user.
+      # @see https://developer.okta.com/docs/reference/api/users/#delete-user
+      # @example
+      #   Oktakit.delete_user('id')
+      def delete_user(id, options = {})
+        delete("/users/#{id}", options)
+      end
+
       # Suspend User
       #
       # @params id [string] User ID
@@ -151,7 +192,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Returns an empty object.
-      # @see http://developer.okta.com/docs/api/resources/users.html#suspend-user
+      # @see https://developer.okta.com/docs/api/resources/users#suspend-user
       # @example
       #   Oktakit.suspend_user('id')
       def suspend_user(id, options = {})
@@ -167,7 +208,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Returns an empty object. Returns an empty object.
-      # @see http://developer.okta.com/docs/api/resources/users.html#unsuspend-user
+      # @see https://developer.okta.com/docs/api/resources/users#unsuspend-user
       # @example
       #   Oktakit.unsuspend_user('id')
       def unsuspend_user(id, options = {})
@@ -183,7 +224,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Returns an empty object
-      # @see http://developer.okta.com/docs/api/resources/users.html#unlock-user
+      # @see http://developer.okta.com/docs/api/resources/users#unlock-user
       # @example
       #   Oktakit.unlock_user('id')
       def unlock_user(id, options = {})
@@ -199,7 +240,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Returns an empty object by default. If sendEmail is false a password reset link
-      # @see http://developer.okta.com/docs/api/resources/users.html#reset-password
+      # @see https://developer.okta.com/docs/api/resources/users#reset-password
       # @example
       #   Oktakit.reset_password('id')
       def reset_password(id, options = {})
@@ -215,7 +256,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Returns the user by default. If tempPassword is true, a temporary password.
-      # @see http://developer.okta.com/docs/api/resources/users.html#expire-password
+      # @see https://developer.okta.com/docs/api/resources/users#expire-password
       # @example
       #   Oktakit.expire_password('id')
       def expire_password(id, options = {})
@@ -231,7 +272,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Returns an empty object by default.
-      # @see http://developer.okta.com/docs/api/resources/users.html#reset-factors
+      # @see https://developer.okta.com/docs/api/resources/users#reset-factors
       # @example
       #   Oktakit.reset_factors('id')
       def reset_factors(id, options = {})
@@ -247,7 +288,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Returns an empty object by default. If sendEmail is false a password reset link
-      # @see http://developer.okta.com/docs/api/resources/users.html#forgot-password
+      # @see https://developer.okta.com/docs/api/resources/users#forgot-password
       # @example
       #   Oktakit.forgot_password('id')
       def forgot_password(id, options = {})
@@ -263,7 +304,7 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Credentials of the user
-      # @see http://developer.okta.com/docs/api/resources/users.html#change-password
+      # @see https://developer.okta.com/docs/api/resources/users#change-password
       # @example
       #   Oktakit.change_password('id')
       def change_password(id, options = {})
@@ -279,12 +320,27 @@ module Oktakit
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
       # @return [Hash<Sawyer::Resource>] Credentials of the user
-      # @see http://developer.okta.com/docs/api/resources/users.html#change-recovery-question
+      # @see https://developer.okta.com/docs/api/resources/users#change-recovery-question
       # @example
       #   Oktakit.change_recovery_question('id')
       def change_recovery_question(id, options = {})
         post("/users/#{id}/credentials/change_recovery_question", options)
       end
+
+      # Clear user sessions
+      #
+      # @params id [string] User ID
+      # @param options[:query] [Hash] Optional. Query params for request
+      # @param options[:headers] [Hash] Optional. Header params for the request.
+      # @param options[:accept] [String] Optional. The content type to accept. Default application/json
+      # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+      # @param options [Hash] Optional. Body params for the request.
+      # @return 204 'No Content'
+      # @see https://developer.okta.com/docs/api/resources/users#user-sessions
+      #   Oktakit.clear_user_sessions('id')
+      def clear_user_sessions(id, options = {})
+        delete("/users/#{id}/sessions", options)
+      end
     end
   end
 end

data/lib/oktakit/client.rb

@@ -5,6 +5,7 @@ require 'oktakit/client/apps'
 require 'oktakit/client/events'
 require 'oktakit/client/factors'
 require 'oktakit/client/groups'
+require 'oktakit/client/group_rules'
 require 'oktakit/client/identity_providers'
 require 'oktakit/client/schemas'
 require 'oktakit/client/templates'
@@ -17,6 +18,7 @@ module Oktakit
     include Events
     include Factors
     include Groups
+    include GroupRules
     include IdentityProviders
     include Schemas
     include Templates
@@ -27,26 +29,27 @@ module Oktakit
 
     # Default Faraday middleware stack
     MIDDLEWARE = RACK_BUILDER_CLASS.new do |builder|
-      builder.use Oktakit::Response::RaiseError
-      builder.adapter Faraday.default_adapter
+      builder.use(Oktakit::Response::RaiseError)
+      builder.adapter(Faraday.default_adapter)
     end
 
-    def initialize(token:, organization: nil, api_endpoint: nil)
+    def initialize(token: nil, access_token: nil, organization: nil, api_endpoint: nil)
       if organization.nil? && api_endpoint.nil?
         raise ArgumentError, "Please provide either the organization or the api_endpoint argument"
       end
 
+      if (token.nil? && access_token.nil?) || (token && access_token)
+        raise ArgumentError, "Please provide either the token or the access_token argument"
+      end
+
       @token = token
+      @access_token = access_token
       @organization = organization
       @api_endpoint = api_endpoint
     end
 
     def api_endpoint
-      if @api_endpoint
-        @api_endpoint
-      else
-        "https://#{@organization.downcase}.okta.com/api/v1"
-      end
+      @api_endpoint || "https://#{@organization.downcase}.okta.com/api/v1"
     end
 
     # Make a HTTP GET request
@@ -67,16 +70,16 @@ module Oktakit
         accept: options.delete(:accept),
         content_type: options.delete(:content_type),
         paginate: should_paginate,
-        data: options
+        data: options,
       }
 
-      resp, status, next_page = request :get, url, **request_options
+      resp, status, next_page = request(:get, url, **request_options)
 
       # If request succeeded and we should paginate, then automatically traverse all next_pages
       if status == 200 && should_paginate
         all_objs = [resp]
         while next_page
-          resp, status, next_page = request :get, next_page, **request_options
+          resp, status, next_page = request(:get, next_page, **request_options)
           break unless status == 200 # Return early if page request fails
 
           all_objs << resp
@@ -97,9 +100,9 @@ module Oktakit
     # @param options [Hash] Optional. Body params for request.
     # @return [Sawyer::Resource]
     def post(url, options = {})
-      request :post, url, query: options.delete(:query), headers: options.delete(:headers),
+      request(:post, url, query: options.delete(:query), headers: options.delete(:headers),
                           accept: options.delete(:accept), content_type: options.delete(:content_type),
-                          data: options
+                          data: options)
     end
 
     # Make a HTTP PUT request
@@ -112,9 +115,9 @@ module Oktakit
     # @param options [Hash] Optional. Body params for request.
     # @return [Sawyer::Resource]
     def put(url, options = {})
-      request :put, url, query: options.delete(:query), headers: options.delete(:headers),
+      request(:put, url, query: options.delete(:query), headers: options.delete(:headers),
                          accept: options.delete(:accept), content_type: options.delete(:content_type),
-                         data: options
+                         data: options)
     end
 
     # Make a HTTP PATCH request
@@ -127,9 +130,9 @@ module Oktakit
     # @param options [Hash] Optional. Body params for request.
     # @return [Sawyer::Resource]
     def patch(url, options = {})
-      request :patch, url, query: options.delete(:query), headers: options.delete(:headers),
+      request(:patch, url, query: options.delete(:query), headers: options.delete(:headers),
                            accept: options.delete(:accept), content_type: options.delete(:content_type),
-                           data: options
+                           data: options)
     end
 
     # Make a HTTP DELETE request
@@ -142,9 +145,9 @@ module Oktakit
     # @param options [Hash] Optional. Body params for request.
     # @return [Sawyer::Resource]
     def delete(url, options = {})
-      request :delete, url, query: options.delete(:query), headers: options.delete(:headers),
+      request(:delete, url, query: options.delete(:query), headers: options.delete(:headers),
                             accept: options.delete(:accept), content_type: options.delete(:content_type),
-                            data: options
+                            data: options)
     end
 
     # Make a HTTP HEAD request
@@ -157,9 +160,9 @@ module Oktakit
     # @param options [Hash] Optional. Body params for request.
     # @return [Sawyer::Resource]
     def head(url, options = {})
-      request :head, url, query: options.delete(:query), headers: options.delete(:headers),
+      request(:head, url, query: options.delete(:query), headers: options.delete(:headers),
                           accept: options.delete(:accept), content_type: options.delete(:content_type),
-                          data: options
+                          data: options)
     end
 
     attr_reader :last_response
@@ -182,11 +185,12 @@ module Oktakit
     end
 
     def sawyer_agent
-      @agent ||= Sawyer::Agent.new(api_endpoint, sawyer_options) do |http|
+      @sawyer_agent ||= Sawyer::Agent.new(api_endpoint, sawyer_options) do |http|
         http.headers[:accept] = 'application/json'
         http.headers[:content_type] = 'application/json'
         http.headers[:user_agent] = "Oktakit v#{Oktakit::VERSION}"
-        http.authorization 'SSWS ', @token
+        http.authorization('SSWS ', @token) if @token
+        http.authorization(:Bearer, @access_token) if @access_token
       end
     end
 
@@ -199,6 +203,7 @@ module Oktakit
 
     def absolute_to_relative_url(next_ref)
       return unless next_ref
+
       next_ref.href.sub(api_endpoint, '')
     end
   end

data/lib/oktakit/error.rb

@@ -8,7 +8,7 @@ module Oktakit
     # @return [Oktakit::Error]
     def self.from_response(response)
       status = response[:status].to_i
-      if klass = error(status)
+      if (klass = error(status))
         klass.new(response)
       end
     end
@@ -41,19 +41,19 @@ module Oktakit
     # Array of validation errors
     # @return [Array<Hash>] Error info
     def errors
-      if data && data.is_a?(Hash)
+      if data&.is_a?(Hash)
         data[:errors] || []
       else
         []
       end
     end
 
-    private
-
     def data
       @data ||= parse_data
     end
 
+    private
+
     def parse_data
       body = @response[:body]
       return if body.empty?
@@ -89,7 +89,7 @@ module Oktakit
 
     def redact_url(url_string)
       %w[client_secret access_token].each do |token|
-        url_string.gsub!(/#{token}=\S+/, "#{token}=(redacted)") if url_string.include? token
+        url_string.gsub!(/#{token}=\S+/, "#{token}=(redacted)") if url_string.include?(token)
       end
       url_string
     end

data/lib/oktakit/response/raise_error.rb

@@ -7,10 +7,8 @@ module Oktakit
     # This class raises an Oktakit-flavored exception based
     # HTTP status codes returned by the API
     class RaiseError < Faraday::Response::Middleware
-      private
-
       def on_complete(response)
-        if error = Oktakit::Error.from_response(response)
+        if (error = Oktakit::Error.from_response(response))
           raise error
         end
       end

data/lib/oktakit/version.rb

@@ -1,3 +1,3 @@
 module Oktakit
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/oktakit.rb

@@ -2,7 +2,7 @@ require 'oktakit/version'
 require 'oktakit/client'
 
 module Oktakit
-  def self.new(*args)
-    Client.new(*args)
+  def self.new(**args)
+    Client.new(**args)
   end
 end

data/oktakit.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'oktakit/version'
 
@@ -9,16 +9,16 @@ Gem::Specification.new do |spec|
   spec.email         = ['graeme.johnson@shopify.com', 'julian@shopify.com']
 
   spec.summary       = 'Ruby toolkit for working with the Okta API'
-  spec.homepage      = 'https://github.com/shopify/oktakit'
+  spec.homepage      = 'https://github.com/Shopify/oktakit'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.0'
+  spec.required_ruby_version = '>= 2.6'
 
-  spec.add_dependency 'sawyer', '~> 0.8.1'
-  spec.add_development_dependency 'bundler'
+  spec.add_dependency('sawyer', '~> 0.8.1')
+  spec.add_development_dependency('bundler')
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: oktakit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Graeme Johnson
 - Julian Nadeau
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-10-06 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sawyer
@@ -39,7 +39,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - graeme.johnson@shopify.com
 - julian@shopify.com
@@ -47,11 +47,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/probots.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -64,6 +70,7 @@ files:
 - lib/oktakit/client/apps.rb
 - lib/oktakit/client/events.rb
 - lib/oktakit/client/factors.rb
+- lib/oktakit/client/group_rules.rb
 - lib/oktakit/client/groups.rb
 - lib/oktakit/client/identity_providers.rb
 - lib/oktakit/client/schemas.rb
@@ -73,11 +80,11 @@ files:
 - lib/oktakit/response/raise_error.rb
 - lib/oktakit/version.rb
 - oktakit.gemspec
-homepage: https://github.com/shopify/oktakit
+homepage: https://github.com/Shopify/oktakit
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,16 +92,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.2.20
+signing_key:
 specification_version: 4
 summary: Ruby toolkit for working with the Okta API
 test_files: []