oktakit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9909ae42a8aab1535c521ce334ab75809daf340
+  data.tar.gz: d961502c418a988213484c0427e080078ab1719e
+SHA512:
+  metadata.gz: cbb1128f0b98700c17e9476b46a72c5ce4024962e773b2331d11808432623ea7722f8e082dfec04170fa65b9e6d0621992db59d4e67a678d084a75b045555af1
+  data.tar.gz: 8721eb00c6ea3dc40fa13c980a1b02c4d472198f65dc7b6b6016171e6a8f183fc394bd7e412bbc6c3f2a4da79084d69beb87e6b972500289dbfece6145f8a858

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,84 @@
+# This file strictly follows the rules defined in the Ruby style guide:
+#   http://shopify.github.io/ruby-style-guide/
+
+AllCops:
+  TargetRubyVersion: 2.1
+
+Rails:
+  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:
+  IndentWhenRelativeTo: 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/ParameterLists:
+  Max: 5
+  CountKeywordArgs: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/MutableConstant:
+  Enabled: false
+
+Performance/Casecmp:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+before_install: gem install bundler
+rvm:
+  - '2.1'
+  - '2.2'
+

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'byebug'
+gem 'rubocop'
+gem 'yard'
+
+group :test do
+  gem 'rspec', '~> 3.2'
+  gem 'vcr', '~> 2.9', github: 'vcr/vcr', branch: 'master', ref: '480304be6d73803e6c4a0eb21a4ab4091da558d8'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Shopify
+
+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,52 @@
+# oktakit
+
+Ruby toolkit for the [Okta API](http://developer.okta.com/docs/api/getting_started/design_principles.html).
+
+[![Build Status](https://secure.travis-ci.org/Shopify/oktakit.png)](http://travis-ci.org/Shopify/oktakit)
+[![Gem Version](https://badge.fury.io/rb/oktakit.png)](http://badge.fury.io/rb/oktakit)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oktakit'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+`Oktakit` follow the same patterns as [`Octokit`](https://github.com/octokit/octokit.rb), if you are familiar with it you should feel right at home.
+
+```ruby
+client = Oktakit.new(token: 't0k3n', organization: 'my-great-org')
+response, http_status = client.list_users
+```
+
+## Development
+
+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).
+
+## Testing
+
+Testing is fairly straightforward, with the exception of the org URL.
+To anonymize the VCR data, first setup a real token and endpoint for Okta, such as `myokta.okta.com`
+
+- In `spec_helper.rb`, set the org to `my-okta` (or whatever your organization is).
+- Set the `OKTA_TEST_TOKEN` environment variable (this should be real). Don't worry, it is automatically removed.
+- Before committing, change `my-okta` to `okta-test` in `spec_helper.rb` and any VCR Cassettes.
+
+The [API Test Client](http://developer.okta.com/docs/api/getting_started/api_test_client) provided by Okta is also really helpful.
+
+## Contributing
+
+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

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task test: :spec
+task default: [:spec, :rubocop]
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files = %w(LICENSE.md lib/**/*.rb)
+    task.options = %w(--output-dir doc/yard --markup markdown)
+  end
+  task default: :yard
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'oktakit'
+
+# 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

data/bin/setup

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

data/dev.yml

@@ -0,0 +1,11 @@
+# This is an internal file for Shopify. Please ignore
+
+name: oktakit
+
+up:
+  - ruby: 2.3.1
+  - bundler
+
+commands:
+  test: bundle exec rspec
+  console: bin/console

data/lib/oktakit.rb

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

data/lib/oktakit/client.rb

@@ -0,0 +1,165 @@
+require 'sawyer'
+require 'oktakit/response/raise_error'
+require 'oktakit/client/admin_roles'
+require 'oktakit/client/apps'
+require 'oktakit/client/events'
+require 'oktakit/client/factors'
+require 'oktakit/client/groups'
+require 'oktakit/client/identity_providers'
+require 'oktakit/client/schemas'
+require 'oktakit/client/templates'
+require 'oktakit/client/users'
+
+module Oktakit
+  class Client
+    include AdminRoles
+    include Apps
+    include Events
+    include Factors
+    include Groups
+    include IdentityProviders
+    include Schemas
+    include Templates
+    include Users
+
+    # In Faraday 0.9, Faraday::Builder was renamed to Faraday::RackBuilder
+    RACK_BUILDER_CLASS = defined?(Faraday::RackBuilder) ? Faraday::RackBuilder : Faraday::Builder
+
+    # Default Faraday middleware stack
+    MIDDLEWARE = RACK_BUILDER_CLASS.new do |builder|
+      builder.use Oktakit::Response::RaiseError
+      builder.adapter Faraday.default_adapter
+    end
+
+    def initialize(token:, organization:)
+      @token = token
+      @organization = organization
+    end
+
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @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 [Sawyer::Resource]
+    def get(url, options = {})
+      request :get, url, query: options.delete(:query), headers: options.delete(:headers),
+                         accept: options.delete(:accept), content_type: options.delete(:content_type),
+                         data: options
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @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 [Sawyer::Resource]
+    def post(url, options = {})
+      request :post, url, query: options.delete(:query), headers: options.delete(:headers),
+                          accept: options.delete(:accept), content_type: options.delete(:content_type),
+                          data: options
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @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 [Sawyer::Resource]
+    def put(url, options = {})
+      request :put, url, query: options.delete(:query), headers: options.delete(:headers),
+                         accept: options.delete(:accept), content_type: options.delete(:content_type),
+                         data: options
+    end
+
+    # Make a HTTP PATCH request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @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 [Sawyer::Resource]
+    def patch(url, options = {})
+      request :patch, url, query: options.delete(:query), headers: options.delete(:headers),
+                           accept: options.delete(:accept), content_type: options.delete(:content_type),
+                           data: options
+    end
+
+    # Make a HTTP DELETE request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @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 [Sawyer::Resource]
+    def delete(url, options = {})
+      request :delete, url, query: options.delete(:query), headers: options.delete(:headers),
+                            accept: options.delete(:accept), content_type: options.delete(:content_type),
+                            data: options
+    end
+
+    # Make a HTTP HEAD request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @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 [Sawyer::Resource]
+    def head(url, options = {})
+      request :head, url, query: options.delete(:query), headers: options.delete(:headers),
+                          accept: options.delete(:accept), content_type: options.delete(:content_type),
+                          data: options
+    end
+
+    attr_reader :last_response
+
+    private
+
+    def request(method, path, data:, query:, headers:, accept:, content_type:)
+      options = {}
+      options[:query] = query || {}
+      options[:headers] = headers || {}
+      options[:headers][:accept] = accept if accept
+      options[:headers][:content_type] = content_type if content_type
+
+      uri = URI::Parser.new.escape("/api/v1/" + path.to_s)
+      @last_response = response = sawyer_agent.call(method, uri, data, options)
+      [response.data, response.status]
+    end
+
+    def sawyer_agent
+      @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
+      end
+    end
+
+    def sawyer_options
+      {
+        links_parser: Sawyer::LinkParsers::Simple.new,
+        faraday: Faraday.new(builder: MIDDLEWARE),
+      }
+    end
+
+    def api_endpoint
+      "https://#{@organization}.okta.com/api/v1/"
+    end
+  end
+end

data/lib/oktakit/client/admin_roles.rb

@@ -0,0 +1,160 @@
+module Oktakit
+  class Client
+    module AdminRoles
+      # List Roles Assigned to 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 [Array<Sawyer::Resource>] Array of Role
+      # @see http://developer.okta.com/docs/api/resources/roles.html#list-roles-assigned-to-user
+      # @example
+      #   Oktakit.list_roles_assigned_to_user('id')
+      def list_roles_assigned_to_user(id, options = {})
+        get("/users/#{id}/roles", options)
+      end
+
+      # Assign Role to 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>] Assigned Role
+      # @see http://developer.okta.com/docs/api/resources/roles.html#assign-role-to-user
+      # @example
+      #   Oktakit.assign_role_to_user('id')
+      def assign_role_to_user(id, options = {})
+        post("/users/#{id}/roles", options)
+      end
+
+      # Unassign Role from User
+      #
+      # @params user_id [string] User ID
+      # @params role_id [string] Role 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 http://developer.okta.com/docs/api/resources/roles.html#unassign-role-from-user
+      # @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)
+      end
+
+      # List Group Targets for User Admin Role
+      #
+      # @params user_id [string] User ID
+      # @params role_id [string] Role 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 Groups
+      # @see http://developer.okta.com/docs/api/resources/roles.html#list-group-targets-for-user-admin-role
+      # @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)
+      end
+
+      # Add Group Target to User Admin Role
+      #
+      # @params user_id [string] User ID
+      # @params role_id [string] Role ID
+      # @params group_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 http://developer.okta.com/docs/api/resources/roles.html#add-group-target-to-user-admin-role
+      # @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)
+      end
+
+      # Remove Group Target from User Admin Role
+      #
+      # @params user_id [string] User ID
+      # @params role_id [string] Role ID
+      # @params group_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 http://developer.okta.com/docs/api/resources/roles.html#remove-group-target-from-user-admin-role
+      # @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)
+      end
+
+      # List App Targets for App Admin Role
+      #
+      # @params user_id [string] User ID
+      # @params role_id [string] Role 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 Catalog Apps
+      # @see http://developer.okta.com/docs/api/resources/roles.html#list-app-targets-for-app-admin-role
+      # @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)
+      end
+
+      # Add App Target to App Admin Role
+      #
+      # @params user_id [string] User ID
+      # @params role_id [string] Role ID
+      # @params app_name [string] App Name
+      # @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 http://developer.okta.com/docs/api/resources/roles.html#add-app-target-to-app-admin-role
+      # @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)
+      end
+
+      # Remove App Target from App Admin Role
+      #
+      # @params user_id [string] User ID
+      # @params role_id [string] Role ID
+      # @params app_name [string] App Name
+      # @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 http://developer.okta.com/docs/api/resources/roles.html#remove-app-target-from-app-admin-role
+      # @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)
+      end
+    end
+  end
+end