simpleokta 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c2978f423bda98ad6abb1b38ad0188bf6cb0e04f079fb3c7490b70eaa648ae5
+  data.tar.gz: 2b11a74d15293784ee2bd5553e7624363c6961b1c2a450a87490679409134f0e
+SHA512:
+  metadata.gz: daf4875930536168a954a3b6a3b5f2a30f6e04cf30950310a72e8526da295b6b551a35d92d039ef74a7233ac438baca71881d50e95abe785cc1cdfcb8f2a89ee
+  data.tar.gz: 7957d372c06ce456f84c9adb8eb71bae67592b881749e2311fd62ce0d3d0cca791aa8e1e6fd9b3f9b324b587f966f808262428c84dc34a616c4c708148ee7c69

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+config/simpleokta.yml
+.env
+
+# rspec failure tracking
+.rspec_status
+vendor/bundle

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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, gender identity and expression, level of experience,
+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 bradenrshipley@gmail.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://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simpleokta.gemspec
+gemspec
+
+gem 'breakers'
+gem 'config'
+gem 'dotenv'
+gem 'faraday', '~> 0.7.4'
+gem 'http'
+gem 'rake', '~> 12.0'
+gem 'rest-client'
+gem 'rspec', '~> 3.0'
+gem 'vcr'
+gem 'webmock'
+gem 'yard'

data/Gemfile.lock

@@ -0,0 +1,136 @@
+PATH
+  remote: .
+  specs:
+    simpleokta (0.1.5)
+      http
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    breakers (0.4.0)
+      faraday (>= 0.7.4, < 0.18)
+      multi_json (~> 1.0)
+    concurrent-ruby (1.1.8)
+    config (3.0.0)
+      deep_merge (~> 1.2, >= 1.2.1)
+      dry-validation (~> 1.0, >= 1.0.0)
+    crack (0.4.5)
+      rexml
+    deep_merge (1.2.1)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.6)
+    dry-configurable (0.12.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.5.0)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-initializer (3.0.4)
+    dry-logic (1.1.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-schema (1.6.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.8, >= 0.8.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.5)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.5, >= 1.5.2)
+    faraday (0.7.6)
+      addressable (~> 2.2)
+      multipart-post (~> 1.1)
+      rack (~> 1.1)
+    ffi (1.15.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.1)
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    multi_json (1.15.0)
+    multipart-post (1.2.0)
+    netrc (0.11.0)
+    public_suffix (4.0.6)
+    rack (1.6.13)
+    rake (12.3.3)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.4)
+    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.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    vcr (6.0.0)
+    webmock (3.12.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.26)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  breakers
+  config
+  dotenv
+  faraday (~> 0.7.4)
+  http
+  rake (~> 12.0)
+  rest-client
+  rspec (~> 3.0)
+  simpleokta!
+  vcr
+  webmock
+  yard
+
+BUNDLED WITH
+   2.2.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Braden Shipley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Simpleokta
+
+This gem provides easy access to multiple common Okta API calls. Please see the [documentation on rubydoc](https://www.rubydoc.info/github/bradenshipley/simpleokta/main) for more information on what methods are available.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simpleokta'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install simpleokta
+
+## Usage
+
+Pass in the `api_token` and `base_api_url` of your okta instance as a hash into the `Client` initializer.
+
+```ruby
+config = {
+  :api_token => "API_TOKEN HERE",
+  :base_api_url => "URL HERE." #EX: 'https://dev-123456.okta.com'
+}
+@okta_util = Simpleokta::Client.new(config)
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bradenshipley/simpleokta. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/bradenshipley/simpleokta/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Simpleokta project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/simpleokta/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'dotenv'
+require 'dotenv/tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+Dotenv.load('.env')
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'simpleokta'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simpleokta.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'simpleokta/version'
+require 'simpleokta/client'
+require 'faraday'
+
+# @author Braden Shipley
+module Simpleokta
+  def self.new(*args)
+    Simpleokta::Client.new(*args)
+  end
+end

data/lib/simpleokta/apps.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Simpleokta
+  class Client
+    module Apps
+      # APP METHODS
+
+      # Returns a list of all applications in the okta instance.
+      # @return [Array<Application Object>]
+      # @see https://developer.okta.com/docs/reference/api/apps/#application-object Application Object
+      def apps
+        response = call_with_token('get', Constants::APP_API_BASE_PATH)
+        JSON.parse(response.body)
+      end
+
+      # Return a specific application in the okta instance.
+      # @param app_id [String] the unique id of the application
+      # @return [Hash<Application Object>]
+      # @see https://developer.okta.com/docs/reference/api/apps/#application-object Application Object
+      def app(app_id)
+        response = call_with_token('get', "#{Constants::APP_API_BASE_PATH}/#{app_id}")
+        JSON.parse(response.body)
+      end
+
+      # Returns all users currently assigned to the application
+      # @param app_id [String] the unique id of the application
+      # @return [Array<User Object>]
+      # @see https://developer.okta.com/docs/reference/api/apps/#application-user-object User Object
+      def users_assigned_to_application(app_id)
+        response = call_with_token('get', "#{Constants::APP_API_BASE_PATH}/#{app_id}/users")
+        JSON.parse(response.body)
+      end
+
+      # Creates an application in Okta.
+      # @param app_data [Hash] The hash of data you want the application to contain.
+      # @see https://developer.okta.com/docs/reference/api/apps/#add-application Add application data.
+      # @example
+      #   Creating a Basic Auth App
+      #     app_data = {
+      #       "name": "template_basic_auth",
+      #       "label": "Sample Basic Auth App",
+      #       "signOnMode": "BASIC_AUTH",
+      #       "settings": {
+      #         "app": {
+      #           "url": "https://example.com/login.html",
+      #           "authURL": "https://example.com/auth.html"
+      #         }
+      #       }
+      #     }
+      # @return [Hash<Application Object>]
+      # @see https://developer.okta.com/docs/reference/api/apps/#application-object Application Object
+      def create_app(app_data)
+        response = call_with_token('post', Constants::APP_API_BASE_PATH, app_data)
+        JSON.parse(response.body)
+      end
+
+      # Update an application
+      # @param app_id [String] the unique id of the application
+      # @param app_data [Hash] The hash of data you want the application to contain.
+      #   Pass in all required fields, anything you leave out will be removed from the application on update.
+      # @return [Hash<Application Object>] The updated app
+      # @see https://developer.okta.com/docs/reference/api/apps/#update-application Update Application
+      # @see https://developer.okta.com/docs/reference/api/apps/#application-object Application Object
+      def update_app(app_id, app_data)
+        response = call_with_token('put', "#{Constants::APP_API_BASE_PATH}/#{app_id}", app_data)
+        JSON.parse(response.body)
+      end
+
+      # Delete an application by id
+      # @param app_id [String] the unique id of the application
+      # @return 204 No Content
+      def delete_app(app_id)
+        response = call_with_token('delete', "#{Constants::APP_API_BASE_PATH}/#{app_id}")
+        response
+      end
+
+      # Activate an application by id
+      # @param app_id [String] the unique id of the application
+      # @see https://developer.okta.com/docs/reference/api/apps/#activate-application Activate Application
+      # @return {}
+      def activate_app(app_id)
+        response = call_with_token('post', "#{Constants::APP_API_BASE_PATH}/#{app_id}/lifecycle/activate")
+        "Application with id: #{app_id} activated"
+      end
+
+      # Deactivate an application by id
+      # @param app_id [String] the unique id of the application
+      # @see https://developer.okta.com/docs/reference/api/apps/#deactivate-application Deactivate Application
+      # @return {}
+      def deactivate_app(app_id)
+        response = call_with_token('post', "#{Constants::APP_API_BASE_PATH}/#{app_id}/lifecycle/deactivate")
+        "Application with id: #{app_id} deactivated"
+      end
+    end
+  end
+end