oktakit 0.1.0

data/lib/oktakit/client/templates.rb

@@ -0,0 +1,99 @@
+module Oktakit
+  class Client
+    module Templates
+      # Add SMS Template
+      #
+      # @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 SMS Template.
+      # @see http://developer.okta.com/docs/api/resources/templates.html#add-sms-template
+      # @example
+      #   Oktakit.add_sms_template
+      def add_sms_template(options = {})
+        post('/templates/sms', options)
+      end
+
+      # Get SMS Template
+      #
+      # @params id [string] Template 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 SMS Template
+      # @see http://developer.okta.com/docs/api/resources/templates.html#get-sms-template
+      # @example
+      #   Oktakit.get_sms_template('id')
+      def get_sms_template(id, options = {})
+        get("/templates/sms/#{id}", options)
+      end
+
+      # List SMS Templates
+      #
+      # @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 SMS Template
+      # @see http://developer.okta.com/docs/api/resources/templates.html#list-sms-templates
+      # @example
+      #   Oktakit.list_sms_templates
+      def list_sms_templates(options = {})
+        get('/templates/sms', options)
+      end
+
+      # Update Sms Template
+      #
+      # @params id [string] Template 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 SMS Template
+      # @see http://developer.okta.com/docs/api/resources/templates.html#update-sms-template
+      # @example
+      #   Oktakit.update_sms_template('id')
+      def update_sms_template(id, options = {})
+        put("/templates/sms/#{id}", options)
+      end
+
+      # Partial SMS Template Update
+      #
+      # @params id [string] Template 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 Sms Template
+      # @see http://developer.okta.com/docs/api/resources/templates.html#partial-sms-template-update
+      # @example
+      #   Oktakit.partial_sms_template_update('id')
+      def partial_sms_template_update(id, options = {})
+        post("/templates/sms/#{id}", options)
+      end
+
+      # Remove SMS Template
+      #
+      # @params id [string] Template 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>] There is no content in the response.
+      # @see http://developer.okta.com/docs/api/resources/templates.html#remove-sms-template
+      # @example
+      #   Oktakit.remove_sms_template('id')
+      def remove_sms_template(id, options = {})
+        delete("/templates/sms/#{id}", options)
+      end
+    end
+  end
+end

data/lib/oktakit/client/users.rb

@@ -0,0 +1,290 @@
+module Oktakit
+  class Client
+    module Users
+      # Create User
+      #
+      # @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>] Returns the created User.
+      # @see http://developer.okta.com/docs/api/resources/users.html#create-user
+      # @example
+      #   Oktakit.create_user
+      def create_user(options = {})
+        post('/users', options)
+      end
+
+      # Get 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>] Fetched User
+      # @see http://developer.okta.com/docs/api/resources/users.html#get-user
+      # @example
+      #   Oktakit.get_user('id')
+      def get_user(id, options = {})
+        get("/users/#{id}", options)
+      end
+
+      # List Users
+      #
+      # @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 User
+      # @see http://developer.okta.com/docs/api/resources/users.html#list-users
+      # @example
+      #   Oktakit.list_users
+      def list_users(options = {})
+        get('/users', options)
+      end
+
+      # Update 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>] Updated User
+      # @see http://developer.okta.com/docs/api/resources/users.html#update-user
+      # @example
+      #   Oktakit.update_user('id')
+      def update_user(id, options = {})
+        put("/users/#{id}", options)
+      end
+
+      # Update Profile
+      #
+      # @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>] Updated User
+      # @see http://developer.okta.com/docs/api/resources/users.html#update-profile
+      # @example
+      #   Oktakit.update_profile('id')
+      def update_profile(id, options = {})
+        post("/users/#{id}", options)
+      end
+
+      # Get Assigned App Links
+      #
+      # @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 App Links
+      # @see http://developer.okta.com/docs/api/resources/users.html#get-assigned-app-links
+      # @example
+      #   Oktakit.get_assigned_app_links('id')
+      def get_assigned_app_links(id, options = {})
+        get("/users/#{id}/appLinks", options)
+      end
+
+      # Get Member Groups
+      #
+      # @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 Groups
+      # @see http://developer.okta.com/docs/api/resources/users.html#get-member-groups
+      # @example
+      #   Oktakit.get_member_groups('id')
+      def get_member_groups(id, options = {})
+        get("/users/#{id}/groups", options)
+      end
+
+      # Activate 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>] Returns empty object by default. When sendEmail is false, returns an activation link for the user to set up their account.
+      # @see http://developer.okta.com/docs/api/resources/users.html#activate-user
+      # @example
+      #   Oktakit.activate_user('id')
+      def activate_user(id, options = {})
+        post("/users/#{id}/lifecycle/activate", options)
+      end
+
+      # Deactivate 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>] Returns an empty object.
+      # @see http://developer.okta.com/docs/api/resources/users.html#deactivate-user
+      # @example
+      #   Oktakit.deactivate_user('id')
+      def deactivate_user(id, options = {})
+        post("/users/#{id}/lifecycle/deactivate", options)
+      end
+
+      # Suspend 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>] Returns an empty object.
+      # @see http://developer.okta.com/docs/api/resources/users.html#suspend-user
+      # @example
+      #   Oktakit.suspend_user('id')
+      def suspend_user(id, options = {})
+        post("/users/#{id}/lifecycle/suspend", options)
+      end
+
+      # Unsuspend 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>] Returns an empty object. Returns an empty object.
+      # @see http://developer.okta.com/docs/api/resources/users.html#unsuspend-user
+      # @example
+      #   Oktakit.unsuspend_user('id')
+      def unsuspend_user(id, options = {})
+        post("/users/#{id}/lifecycle/unsuspend", options)
+      end
+
+      # Unlock 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>] Returns an empty object
+      # @see http://developer.okta.com/docs/api/resources/users.html#unlock-user
+      # @example
+      #   Oktakit.unlock_user('id')
+      def unlock_user(id, options = {})
+        post("/users/#{id}/lifecycle/unlock", options)
+      end
+
+      # Reset Password
+      #
+      # @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>] Returns an empty object by default. When sendEmail is false, returns a link for the user to reset their password.
+      # @see http://developer.okta.com/docs/api/resources/users.html#reset-password
+      # @example
+      #   Oktakit.reset_password('id')
+      def reset_password(id, options = {})
+        post("/users/#{id}/lifecycle/reset_password", options)
+      end
+
+      # Expire Password
+      #
+      # @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>] Returns the complete user object by default. When tempPassword is true, returns the temporary password.
+      # @see http://developer.okta.com/docs/api/resources/users.html#expire-password
+      # @example
+      #   Oktakit.expire_password('id')
+      def expire_password(id, options = {})
+        post("/users/#{id}/lifecycle/expire_password", options)
+      end
+
+      # Reset Factors
+      #
+      # @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>] Returns an empty object by default.
+      # @see http://developer.okta.com/docs/api/resources/users.html#reset-factors
+      # @example
+      #   Oktakit.reset_factors('id')
+      def reset_factors(id, options = {})
+        post("/users/#{id}/lifecycle/reset_factors", options)
+      end
+
+      # Forgot Password
+      #
+      # @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>] Returns an empty object by default. When sendEmail is false, returns a link for the user to reset their password.
+      # @see http://developer.okta.com/docs/api/resources/users.html#forgot-password
+      # @example
+      #   Oktakit.forgot_password('id')
+      def forgot_password(id, options = {})
+        post("/users/#{id}/credentials/forgot_password", options)
+      end
+
+      # Change Password
+      #
+      # @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>] Credentials of the user
+      # @see http://developer.okta.com/docs/api/resources/users.html#change-password
+      # @example
+      #   Oktakit.change_password('id')
+      def change_password(id, options = {})
+        post("/users/#{id}/credentials/change_password", options)
+      end
+
+      # Change Recovery Question
+      #
+      # @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>] Credentials of the user
+      # @see http://developer.okta.com/docs/api/resources/users.html#change-recovery-question
+      # @example
+      #   Oktakit.change_recovery_question('id')
+      def change_recovery_question(id, options = {})
+        post("/users/#{id}/credentials/change_recovery_question", options)
+      end
+    end
+  end
+end

data/lib/oktakit/error.rb

@@ -0,0 +1,166 @@
+module Oktakit
+  # Custom error class for rescuing from all Okta errors
+  class Error < StandardError
+    # Returns the appropriate Oktakit::Error subclass based
+    # on status and response message
+    #
+    # @param [Hash] response HTTP response
+    # @return [Oktakit::Error]
+    def self.from_response(response)
+      status = response[:status].to_i
+      if klass =  case status
+                  when 400      then Oktakit::BadRequest
+                  when 401      then Oktakit::Unauthorized
+                  when 403      then Oktakit::Forbidden
+                  when 404      then Oktakit::NotFound
+                  when 405      then Oktakit::MethodNotAllowed
+                  when 406      then Oktakit::NotAcceptable
+                  when 409      then Oktakit::Conflict
+                  when 415      then Oktakit::UnsupportedMediaType
+                  when 422      then Oktakit::UnprocessableEntity
+                  when 400..499 then Oktakit::ClientError
+                  when 500      then Oktakit::InternalServerError
+                  when 501      then Oktakit::NotImplemented
+                  when 502      then Oktakit::BadGateway
+                  when 503      then Oktakit::ServiceUnavailable
+                  when 500..599 then Oktakit::ServerError
+                  end
+        klass.new(response)
+      end
+    end
+
+    def initialize(response = nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    # Documentation URL returned by the API for some errors
+    #
+    # @return [String]
+    def documentation_url
+      data[:documentation_url] if data.is_a? Hash
+    end
+
+    # Array of validation errors
+    # @return [Array<Hash>] Error info
+    def errors
+      if data && data.is_a?(Hash)
+        data[:errors] || []
+      else
+        []
+      end
+    end
+
+    private
+
+    def data
+      @data ||= parse_data
+    end
+
+    def parse_data
+      body = @response[:body]
+      return if body.empty?
+      return body unless body.is_a?(String)
+
+      headers = @response[:response_headers]
+      content_type = headers && headers[:content_type] || ''
+      if content_type =~ /json/
+        Sawyer::Agent.serializer.decode(body)
+      else
+        body
+      end
+    end
+
+    def response_message
+      case data
+      when Hash
+        data[:message]
+      when String
+        data
+      end
+    end
+
+    def response_error
+      "Error: #{data[:error]}" if data.is_a?(Hash) && data[:error]
+    end
+
+    def response_error_summary
+      return nil unless data.is_a?(Hash) && !Array(data[:errors]).empty?
+
+      summary = "\nError summary:\n"
+      summary << data[:errors].map do |hash|
+        hash.map { |k, v| "  #{k}: #{v}" }
+      end.join("\n")
+
+      summary
+    end
+
+    def build_error_message
+      return nil if @response.nil?
+
+      message =  "#{@response[:method].to_s.upcase} "
+      message << redact_url(@response[:url].to_s) + ': '
+      message << "#{@response[:status]} - "
+      message << response_message.to_s unless response_message.nil?
+      message << response_error.to_s unless response_error.nil?
+      message << response_error_summary.to_s unless response_error_summary.nil?
+      message << " // See: #{documentation_url}" unless documentation_url.nil?
+      message
+    end
+
+    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
+      end
+      url_string
+    end
+  end
+
+  # Raised on errors in the 400-499 range
+  class ClientError < Error; end
+
+  # Raised when Okta returns a 400 HTTP status code
+  class BadRequest < ClientError; end
+
+  # Raised when Okta returns a 401 HTTP status code
+  class Unauthorized < ClientError; end
+
+  # Raised when Okta returns a 403 HTTP status code
+  class Forbidden < ClientError; end
+
+  # Raised when Okta returns a 404 HTTP status code
+  class NotFound < ClientError; end
+
+  # Raised when Okta returns a 405 HTTP status code
+  class MethodNotAllowed < ClientError; end
+
+  # Raised when Okta returns a 406 HTTP status code
+  class NotAcceptable < ClientError; end
+
+  # Raised when Okta returns a 409 HTTP status code
+  class Conflict < ClientError; end
+
+  # Raised when Okta returns a 414 HTTP status code
+  class UnsupportedMediaType < ClientError; end
+
+  # Raised when Okta returns a 422 HTTP status code
+  class UnprocessableEntity < ClientError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < Error; end
+
+  # Raised when Okta returns a 500 HTTP status code
+  class InternalServerError < ServerError; end
+
+  # Raised when Okta returns a 501 HTTP status code
+  class NotImplemented < ServerError; end
+
+  # Raised when Okta returns a 502 HTTP status code
+  class BadGateway < ServerError; end
+
+  # Raised when Okta returns a 503 HTTP status code
+  class ServiceUnavailable < ServerError; end
+
+  # Raised when client fails to provide valid Content-Type
+  class MissingContentType < ArgumentError; end
+end