onelogin 0.1.0 → 1.0.0

data/lib/onelogin/api/cursor.rb

@@ -0,0 +1,89 @@
+# Cursor
+#
+# Used for paginating requests to the OneLogin API
+#
+# Returns an enumerable object
+class Cursor
+  include Enumerable
+
+  # Create a new instance of the Cursor.
+  #
+  # @param url [String] The url of the API endpoint
+  # @param options [Hash] Configuation options
+  #
+  def initialize(url, options = {})
+    @url = url
+    @options = options
+
+    @model = options[:model]
+    @headers = options[:headers] || {}
+    @params = options[:params] || {}
+    @max_results = options[:max_results]
+
+    @collection = []
+    @after_cursor = options.fetch(:after_cursor, nil)
+  end
+
+  def each(start = 0)
+    return to_enum(:each, start) unless block_given?
+
+    Array(@collection[start..-1]).each do |item|
+      if @model
+        yield(@model.new(item))
+      else
+        yield(item)
+      end
+    end
+
+    unless last?
+      start = [@collection.size, start].max
+
+      fetch_next_page
+
+      each(start, &Proc.new)
+    end
+  end
+
+  private
+
+  def fetch_next_page
+    @params = @params.merge(after_cursor: @after_cursor) if @after_cursor
+
+    response = HTTParty.get(
+      @url,
+      headers: @headers,
+      query: @params
+    )
+
+    json = response.parsed_response
+
+    @collection += if results_remaining < json['data'].size
+      json['data'].slice(0, results_remaining)
+    else
+      json['data']
+    end
+
+    @after_cursor = after_cursor(json)
+    @last_cursor_empty = @after_cursor.nil?
+  end
+
+  def after_cursor(json)
+    return unless json['pagination']
+
+    json['pagination'].fetch('after_cursor', nil)
+  end
+
+  def results_remaining
+    @max_results - @collection.size
+  end
+
+  def fetch_completed?
+    return false unless @max_results
+
+    @collection.size >= @max_results
+  end
+
+  def last?
+    @last_cursor_empty || fetch_completed?
+  end
+end

data/lib/onelogin/api/models/app.rb

@@ -0,0 +1,22 @@
+module OneLogin
+  module Api
+    module Models
+
+      class App
+
+        attr_accessor :id, :name, :icon, :provisioned
+        attr_accessor :extension, :login_id, :personal
+
+        def initialize(data)
+          @id = data['id']
+          @name = data['name']
+          @icon = data['icon']
+          @provisioned = data['provisioned']
+          @extension = data['extension']
+          @login_id = data['login_id']
+          @personal = data['personal']
+        end
+      end
+    end
+  end
+end

data/lib/onelogin/api/models/device.rb

@@ -0,0 +1,16 @@
+module OneLogin
+  module Api
+    module Models
+
+      class Device
+
+        attr_accessor :id, :type
+
+        def initialize(data)
+          @id = data['device_id']
+          @type = data['device_type'].to_s
+        end
+      end
+    end
+  end
+end

data/lib/onelogin/api/models/embed_app.rb

@@ -0,0 +1,31 @@
+module OneLogin
+  module Api
+    module Models
+
+      class EmbedApp
+
+        attr_accessor :id, :name, :icon, :provisioned, :extension_required, :login_id, :personal
+
+        def initialize(data)
+          @data = data
+
+          @id = data['id'].to_i
+          @name = data['name'].to_s
+          @icon = data['icon']
+          @provisioned = data['provisioned'].to_i
+          @extension_required = truthy?('extension_required')
+          @login_id = data['login_id'].to_i
+          @personal = truthy?('personal')
+        end
+
+        private
+
+        def truthy?(attribute_name)
+          return false unless @data[attribute_name]
+
+          ['yes', 'true', '1'].include? @data[attribute_name].to_s.downcase
+        end
+      end
+    end
+  end
+end

data/lib/onelogin/api/models/event.rb

@@ -0,0 +1,48 @@
+module OneLogin
+  module Api
+    module Models
+
+      class Event
+
+        attr_accessor :id, :created_at, :account_id, :user_id, :user_name, :event_type_id,
+                      :notes, :ipaddr, :actor_user_id, :actor_user_name, :assuming_acting_user_id,
+                      :role_id, :role_name, :app_id, :group_id, :group_name, :otp_device_id,
+                      :otp_device_name, :policy_id, :policy_name, :actor_system, :custom_message,
+                      :operation_name, :directory_sync_run_id, :directory_id, :resolution, :client_id,
+                      :resource_type_id, :error_description
+
+        def initialize(data)
+          @id = data['id']
+          @created_at = data['created_at']? Time.iso8601(data['created_at']) : nil
+          @account_id = data['account_id']
+          @user_id = data['user_id']
+          @user_name = data['user_name'].to_s
+          @event_type_id = data['event_type_id']
+          @notes = data['notes'].to_s
+          @ipaddr = data['ipaddr'].to_s
+          @actor_user_id = data['actor_user_id']
+          @actor_user_name = data['actor_user_name'].to_s
+          @assuming_acting_user_id = data['assuming_acting_user_id']
+          @role_id = data['role_id']
+          @role_name = data['role_name'].to_s
+          @app_id = data['app_id']
+          @group_id = data['group_id']
+          @group_name = data['group_name'].to_s
+          @otp_device_id = data['otp_device_id']
+          @otp_device_name = data['otp_device_name'].to_s
+          @policy_id = data['policy_id']
+          @policy_name = data['policy_name'].to_s
+          @actor_system = data['actor_system'].to_s
+          @custom_message = data['custom_message'].to_s
+          @operation_name = data['operation_name'].to_s
+          @directory_sync_run_id = data['directory_sync_run_id']
+          @directory_id = data['directory_id']
+          @resolution = data['resolution'].to_s
+          @client_id = data['client_id']
+          @resource_type_id = data['resource_type_id']
+          @error_description = data['error_description'].to_s
+        end
+      end
+    end
+  end
+end

data/lib/onelogin/api/models/event_type.rb

@@ -0,0 +1,17 @@
+module OneLogin
+  module Api
+    module Models
+
+      class EventType
+
+        attr_accessor :id, :name, :reference
+
+        def initialize(data)
+          @id = data['id']
+          @name = data['name'].to_s
+          @reference = data['reference'].to_s
+        end
+      end
+    end
+  end
+end

data/lib/onelogin/api/models/group.rb

@@ -0,0 +1,17 @@
+module OneLogin
+  module Api
+    module Models
+
+      class Group
+
+        attr_accessor :id, :name, :reference
+
+        def initialize(data)
+          @id = data['id']
+          @name = data['name'].to_s
+          @reference = data['reference'].to_s
+        end
+      end
+    end
+  end
+end

data/lib/onelogin/api/models/mfa.rb

@@ -0,0 +1,26 @@
+module OneLogin
+  module Api
+    module Models
+
+      class MFA
+
+        attr_accessor :state_token, :callback_url, :user, :devices
+
+        def initialize(data)
+          unless data['user'].empty?
+            @user = OneLogin::Api::Models::User.new(data['user']) # Partial info
+          end
+          @state_token = data['state_token'].to_s
+          @callback_url = data['callback_url'].to_s
+          @devices = []
+          unless data['devices'].empty?
+            data['devices'].each do |device_data|
+              @devices << OneLogin::Api::Models::Device.new(device_data)
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/onelogin/api/models/onelogin_token.rb

@@ -0,0 +1,20 @@
+module OneLogin
+  module Api
+    module Models
+
+      class OneLoginToken
+
+        attr_accessor :access_token, :refresh_token, :account_id, :token_type, :created_at, :expires_in
+
+        def initialize(data)
+          @access_token = data['access_token'].to_s
+          @refresh_token = data['refresh_token'].to_s
+          @account_id = data['account_id']
+          @token_type = data['token_type']
+          @created_at = Time.iso8601(data['created_at'])
+          @expires_in = data['expires_in']
+        end
+      end
+    end
+  end
+end

data/lib/onelogin/api/models/rate_limit.rb

@@ -0,0 +1,17 @@
+module OneLogin
+  module Api
+    module Models
+
+      class RateLimit
+
+        attr_accessor :limit, :remaining, :reset
+
+        def initialize(data)
+          @limit = data['X-RateLimit-Limit']
+          @remaining = data['X-RateLimit-Remaining']
+          @reset = data['X-RateLimit-Reset']
+        end
+      end
+    end
+  end
+end

data/lib/onelogin/api/models/role.rb

@@ -0,0 +1,16 @@
+module OneLogin
+  module Api
+    module Models
+
+      class Role
+
+        attr_accessor :id, :name
+
+        def initialize(data)
+          @id = data['id']
+          @name = data['name'].to_s
+        end
+      end
+    end
+  end
+end

data/lib/onelogin/api/models/saml_endpoint_response.rb

@@ -0,0 +1,18 @@
+module OneLogin
+  module Api
+    module Models
+
+      class SAMLEndpointResponse
+
+        attr_accessor :type, :message, :mfa, :saml_response
+
+        def initialize(status_type, status_message)
+          @type = status_type
+          @message = status_message
+          @saml_response = nil
+          @mfa = nil
+        end
+      end
+    end
+  end
+end

data/lib/onelogin/api/models/session_token_info.rb

@@ -0,0 +1,21 @@
+module OneLogin
+  module Api
+    module Models
+
+      class SessionTokenInfo
+
+        attr_accessor :status, :user, :return_to_url, :expires_at, :session_token
+
+        def initialize(data)
+          @status = data['status'].to_s
+          unless data['user'].empty?
+            @user = OneLogin::Api::Models::User.new(data['user']) # Partial info
+          end
+          @return_to_url = data['return_to_url'].to_s          
+          @expires_at = Time.parse(data['expires_at'])
+          @session_token = data['session_token'].to_s
+        end
+      end
+    end
+  end
+end

data/lib/onelogin/api/models/session_token_mfa_info.rb

@@ -0,0 +1,26 @@
+module OneLogin
+  module Api
+    module Models
+
+      class SessionTokenMFAInfo
+
+        attr_accessor :user, :state_token, :callback_url, :devices
+
+        def initialize(data)
+          unless data['user'].empty?
+            @user = OneLogin::Api::Models::User.new(data['user']) # Partial info
+          end
+          @state_token = data['state_token'].to_s
+          @callback_url = data['callback_url'].to_s
+          @devices = []
+          unless data['devices'].empty?
+            data['devices'].each do |device_data|
+              @devices << OneLogin::Api::Models::Device.new(device_data)
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/onelogin/api/models/user.rb

@@ -0,0 +1,125 @@
+module OneLogin
+  module Api
+    module Models
+
+      class User
+
+        attr_accessor :id, :external_id, :email, :username, :firstname, :lastname, :distinguished_name,
+                      :phone, :company, :department, :status, :member_of, :samaccountname, :userprincipalname,
+                      :group_id, :role_ids, :custom_attributes, :openid_name, :locale_code, :comment, :directory_id,
+                      :manager_ad_id, :trusted_idp_id, :activated_at, :created_at, :updated_at,
+                      :password_changed_at, :invitation_sent_at, :invalid_login_attempts, :last_login, :locked_until
+
+        def initialize(data)
+          @id = data['id']
+          @external_id = data['external_id']
+          @email = data['email'].to_s
+          @username = data['username'].to_s
+          @firstname = data['firstname'].to_s
+          @lastname = data['lastname'].to_s
+          @distinguished_name = data['distinguished_name'].to_s
+          @phone = data['phone'].to_s
+          @company = data['company'].to_s
+          @department = data['department'].to_s
+          @status = data['status']
+          @member_of = data['member_of'].to_s
+          @samaccountname = data['samaccountname'].to_s
+          @userprincipalname = data['userprincipalname'].to_s
+          @group_id = data['group_id']? data['group_id'].to_i : nil
+          @role_ids = data['role_id']? data['role_id'] : []
+          @custom_attributes = data['custom_attributes'] ? data['custom_attributes'] : []
+          @openid_name = data['openid_name'].to_s
+          @locale_code = data['locale_code'].to_s
+          @comment = data['comment'].to_s
+          @directory_id = data['directory_id']
+          @manager_ad_id = data['manager_ad_id']
+          @trusted_idp_id = data['trusted_idp_id']
+          @activated_at = data['activated_at']? Time.iso8601(data['activated_at']) : nil
+          @created_at = data['created_at']? Time.iso8601(data['created_at']) : nil
+          @password_changed_at = data['password_changed_at']? Time.iso8601(data['password_changed_at']) : nil
+          @invitation_sent_at = data['invitation_sent_at']? Time.iso8601(data['invitation_sent_at']) : nil
+          @invalid_login_attempts = data['invalid_login_attempts']
+          @last_login = data['last_login']? Time.iso8601(data['last_login']) : nil          
+          @locked_until = data['locked_until']? Time.iso8601(data['locked_until']) : nil
+        end
+
+        def get_role_ids
+          @role_ids
+        end
+
+        def get_role_ids
+          @group_id
+        end
+
+        def get_user_data
+          user_data = UserData.new
+          user_data.id = @id
+          user_data.external_id = @external_id
+          user_data.email = @email
+          user_data.username = @username
+          user_data.firstname = @firstname
+          user_data.lastname = @lastname
+          user_data.distinguished_name = @distinguished_name
+          user_data.phone = @phone
+          user_data.company = @company
+          user_data.department = @department
+          user_data.status = @status
+          user_data.member_of = @member_of
+          user_data.samaccountname = @samaccountname
+          user_data.userprincipalname = @userprincipalname
+          user_data.openid_name = @openid_name
+          user_data.locale_code = @locale_code
+          user_data.directory_id = @directory_id
+          user_data.manager_ad_id = @manager_ad_id
+          user_data.trusted_idp_id = @trusted_idp_id
+          return user_data
+        end       
+
+        def get_user_metadata
+          user_metadata = UserMetadata.new
+          user_metadata.id = @id
+          user_metadata.activated_at = @activated_at
+          user_metadata.created_at = @created_at
+          user_metadata.updated_at = @updated_at
+          user_metadata.password_changed_at = @password_changed_at
+          user_metadata.invalid_login_attempts = @invalid_login_attempts
+          user_metadata.invitation_sent_at = @invitation_sent_at
+          user_metadata.last_login = @last_login
+          user_metadata.locked_until = @locked_until
+          user_metadata.comment = @comment
+
+          return user_metadata
+        end
+
+        def get_custom_attributes
+          @custom_attributes
+        end
+
+        def get_user_params
+          return {
+            "external_id"=> self.external_id,
+            "email"=> self.email,
+            "username"=> self.username,
+            "firstname"=> self.firstname,
+            "lastname"=> self.lastname,
+            "distinguished_name"=> self.distinguished_name,
+            "phone"=> self.phone,
+            "company"=> self.company,
+            "department"=> self.department,
+            "status"=> self.status,
+            "member_of"=> self.member_of,
+            "samaccountname"=> self.samaccountname,
+            "invalid_login_attempts"=> self.invalid_login_attempts,
+            "userprincipalname"=> self.userprincipalname,
+            "group_id"=> self.group_id,
+            "locale_code"=> self.locale_code,
+            "openid_name"=> self.openid_name,
+            "directory_id"=> self.directory_id,
+            "manager_ad_id"=> self.manager_ad_id,
+            "trusted_idp_id"=> self.trusted_idp_id
+          }
+        end
+      end
+    end
+  end
+end

data/lib/onelogin/api/models/user_data.rb

@@ -0,0 +1,13 @@
+module OneLogin
+  module Api
+    module Models
+
+      class UserData
+
+        attr_accessor :id, :external_id, :email, :username, :firstname, :lastname, :distinguished_name,
+                      :phone, :company, :department, :status, :member_of, :samaccountname, :userprincipalname,
+                      :openid_name, :locale_code, :directory_id, :manager_ad_id, :trusted_idp_id
+      end
+    end
+  end
+end

data/lib/onelogin/api/models/user_metadata.rb

@@ -0,0 +1,13 @@
+module OneLogin
+  module Api
+    module Models
+
+      class UserMetadata
+
+        attr_accessor :id, :activated_at, :created_at, :updated_at, :password_changed_at,
+                      :invitation_sent_at, :invalid_login_attempts, :last_login, :locked_until,
+                      :comment
+      end
+    end
+  end
+end

data/lib/onelogin/api/models.rb

@@ -0,0 +1,16 @@
+require 'onelogin/api/models/app'
+require 'onelogin/api/models/device'
+require 'onelogin/api/models/event'
+require 'onelogin/api/models/event_type'
+require 'onelogin/api/models/group'
+require 'onelogin/api/models/mfa'
+require 'onelogin/api/models/onelogin_token'
+require 'onelogin/api/models/rate_limit'
+require 'onelogin/api/models/role'
+require 'onelogin/api/models/saml_endpoint_response'
+require 'onelogin/api/models/session_token_info'
+require 'onelogin/api/models/session_token_mfa_info'
+require 'onelogin/api/models/user_data'
+require 'onelogin/api/models/user_metadata'
+require 'onelogin/api/models/user'
+require 'onelogin/api/models/embed_app'

data/lib/onelogin/api/util/constants.rb

@@ -0,0 +1,65 @@
+module OneLogin
+  module Api
+    module Util
+      # Constants class of the OneLogin's Ruby SDK.
+      #
+      # This class defines all the constants that will be used
+      # in the OneLogin's Ruby SDK.
+      #
+      module Constants
+        # OAuth2 Tokens URLs
+        TOKEN_REQUEST_URL = "https://api.%s.onelogin.com/auth/oauth2/token"
+        TOKEN_REFRESH_URL = "https://api.%s.onelogin.com/auth/oauth2/token"
+        TOKEN_REVOKE_URL = "https://api.%s.onelogin.com/auth/oauth2/revoke"
+        GET_RATE_URL = "https://api.%s.onelogin.com/auth/rate_limit"
+
+        # User URLs
+        GET_USERS_URL = "https://api.%s.onelogin.com/api/1/users"
+        GET_USER_URL = "https://api.%s.onelogin.com/api/1/users/%s"
+        GET_APPS_FOR_USER_URL = "https://api.%s.onelogin.com/api/1/users/%s/apps"
+        GET_ROLES_FOR_USER_URL = "https://api.%s.onelogin.com/api/1/users/%s/roles"
+        GET_CUSTOM_ATTRIBUTES_URL = "https://api.%s.onelogin.com/api/1/users/custom_attributes"
+        CREATE_USER_URL = "https://api.%s.onelogin.com/api/1/users"
+        SESSION_LOGIN_TOKEN_URL = "https://api.%s.onelogin.com/api/1/login/auth"
+        GET_TOKEN_VERIFY_FACTOR = "https://api.%s.onelogin.com/api/1/login/verify_factor"
+        SESSION_API_TOKEN_URL = "https://admin.%s.onelogin.com/session_via_api_token"
+        UPDATE_USER_URL = "https://api.%s.onelogin.com/api/1/users/%s"
+        DELETE_USER_URL = "https://api.%s.onelogin.com/api/1/users/%s"
+        ADD_ROLE_TO_USER_URL = "https://api.%s.onelogin.com/api/1/users/%s/add_roles"
+        DELETE_ROLE_TO_USER_URL = "https://api.%s.onelogin.com/api/1/users/%s/remove_roles"
+        SET_PW_CLEARTEXT = "https://api.%s.onelogin.com/api/1/users/set_password_clear_text/%s"
+        SET_PW_SALT = "https://api.%s.onelogin.com/api/1/users/set_password_using_salt/%s"
+        SET_CUSTOM_ATTRIBUTE_TO_USER_URL = "https://api.%s.onelogin.com/api/1/users/%s/set_custom_attributes"
+        LOG_USER_OUT_URL = "https://api.%s.onelogin.com/api/1/users/%s/logout"
+        LOCK_USER_URL = "https://api.%s.onelogin.com/api/1/users/%s/lock_user"
+
+        # Role URLs
+        GET_ROLES_URL = "https://api.%s.onelogin.com/api/1/roles"
+        CREATE_ROLE_URL = "https://api.%s.onelogin.com/api/1/roles"
+        GET_ROLE_URL = "https://api.%s.onelogin.com/api/1/roles/%s"
+
+        # Event URLS
+        GET_EVENT_TYPES_URL = "https://api.%s.onelogin.com/api/1/events/types"
+        GET_EVENTS_URL = "https://api.%s.onelogin.com/api/1/events"
+        CREATE_EVENT_URL = "https://api.%s.onelogin.com/api/1/events"
+        GET_EVENT_URL = "https://api.%s.onelogin.com/api/1/events/%s"
+
+        # Group URLs
+        GET_GROUPS_URL = "https://api.%s.onelogin.com/api/1/groups"
+        CREATE_GROUP_URL = "https://api.%s.onelogin.com/api/1/groups"
+        GET_GROUP_URL = "https://api.%s.onelogin.com/api/1/groups/%s"
+
+        # SAML Assertion URLs
+        GET_SAML_ASSERTION_URL = "https://api.%s.onelogin.com/api/1/saml_assertion"
+        GET_SAML_VERIFY_FACTOR = "https://api.%s.onelogin.com/api/1/saml_assertion/verify_factor"
+
+        # Invite Link URLS
+        GENERATE_INVITE_LINK_URL = "https://api.%s.onelogin.com/api/1/invites/get_invite_link"
+        SEND_INVITE_LINK_URL = "https://api.%s.onelogin.com/api/1/invites/send_invite_link"
+
+        # Embed Apps URL
+        EMBED_APP_URL = "https://api.onelogin.com/client/apps/embed2"
+      end
+    end
+  end
+end

data/lib/onelogin/api/util/url_builder.rb

@@ -0,0 +1,21 @@
+module OneLogin
+  module Api
+    module Util
+      module UrlBuilder
+
+        # Build the URL of the API endpoint
+        #
+        # @param base [String] Base of the endpoint
+        # @param obj_id [String, nil] Id of the referenced object
+        #
+        def url_for(base, obj_id=nil)
+          if obj_id.nil? || obj_id.to_s.empty?
+            base % [@region]
+          else
+            base % [@region, obj_id]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onelogin/api/util.rb

@@ -0,0 +1,11 @@
+require 'onelogin/api/util/constants'
+require 'onelogin/api/util/url_builder'
+
+module OneLogin
+  module Api
+    module Util
+      include OneLogin::Api::Util::Constants
+      include OneLogin::Api::Util::UrlBuilder
+    end
+  end
+end

data/lib/onelogin/api.rb

@@ -0,0 +1,2 @@
+require 'onelogin/api/client'
+require 'onelogin/api/models'