DuoUniversalRuby

# Replace fake DUO constant values with real values obtained from DUO
DUO_CLIENT_ID = "X" * 20
DUO_CLIENT_SECRET = "x" * 40
DUO_HOST = "api-xxxxxxxx.duosecurity.com"
DUO_REDIRECT_URI =  "https://localhost/duo-callback"

client = DuoUniversalRuby::Client.new(
            client_id: DUO_CLIENT_ID,
            client_secret: DUO_CLIENT_SECRET,
            api_host: DUO_HOST,
            redirect_uri: DUO_REDIRECT_URI
            )
    # Initializes instance of Client class

    # Arguments:
    # client_id                -- Client ID for the application in Duo
    # client_secret            -- Client secret for the application in Duo
    # host                     -- Duo api host
    # redirect_uri             -- Uri to redirect to after a successful auth

client.health_check
    # Checks whether Duo is available.
    # POST /oauth/v1/health_check

    # Returns:
    # {'response': {'timestamp': <int:unix timestamp>}, 'stat': 'OK'}

    # Raises:
    # DuoException on error for invalid credentials
    # or problem connecting to Duo

state = client.generate_state
    # Random value that is checked after interactions to protect against CSRF attacks

username = "test@example.com"
    # user authenticating with Duo

client.create_auth_url(username: username, state: state)
    # Generate uri to Duo's prompt
    # GET /oauth/v1/authorize

    # Arguments:
    # username        -- username trying to authenticate with Duo
    # state           -- Randomly generated character string of at least 16
    #                    and at most 1024 characters returned to the integration by Duo after 2FA

    # Returns:
    # Authorization uri to redirect to for the Duo prompt

    # After a successful Duo authentication, Duo redirects the user to the redirect_uri, e.g. /duo_callback with the params: duo_code and state
    
decoded_token = client.exchange_authorization_code_for_2fa_result(duo_code: duo_code, username: username)
    # Exchange the duo_code for a token with Duo to determine
    # if the auth was successful.

    # POST /oauth/v1/token

    # Arguments:
    # duo_code        -- Authentication session transaction id returned by Duo
    # username        -- Name of the user authenticating with Duo

    # Return:
    # A token with meta-data about the auth

    # Raises:
    # DuoException on error for invalid duo_codes, invalid credentials,
    # or problems connecting to Duo