Polished API - Add an App

Description

Polished API - Add an App

Usage

add_app(app_name, app_url = NULL, api_key = get_api_key())

Arguments

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_apps() update_app() delete_app()

Polished API - Add a User to an App

Description

Polished API - Add a User to an App

Usage

add_app_user(
  app_uid,
  user_uid = NULL,
  email = NULL,
  is_admin = FALSE,
  send_invite_email = FALSE,
  api_key = get_api_key()
)

Arguments

Details

supply either the user_uid or email. If both are provided, then the user_uid will be used, and the email will be ignored.

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_app_users() update_app_user() delete_app_user()

add_auth_to_spec

Description

Add authentication to the openapi plumber spec so that you can use the swagger documentation with the auth_filter().

Usage

add_auth_to_spec(method = c("basic", "cookie"))

Arguments

Details

This minimal API example https://github.com/Tychobra/polished_example_apps/blob/master/11_plumber/api/00_start.R shows how you can add this function to your API.

Value

a function to update the openapi spec.

Polished API - Add a Role

Description

Polished API - Add a Role

Usage

add_role(role_name, api_key = get_api_key())

Arguments

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_roles() delete_role()

Polished API - Add a User

Description

Polished API - Add a User

Usage

add_user(email, api_key = get_api_key())

Arguments

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_users() update_user() delete_user()

Polished API - Add a User Role

Description

Polished API - Add a User Role

Usage

add_user_role(
  user_uid,
  role_uid = NULL,
  role_name = NULL,
  api_key = get_api_key()
)

Arguments

Details

one of either role_uid or role_name must be provided. If both are provided, only the role_uid will be used.

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_user_roles() delete_user_role()

An html button to navigate the the "Admin Panel"

Description

The UI portion of the 'shiny' module for the button to navigate to the "Admin Panel". This is the button that, when clicked, navigates a 'polished' admin from your 'shiny' app to the 'polished' Admin Panel. If your app is set up with the default 'polished' configuration, this button appears in the bottom right of your 'shiny' app.

Usage

admin_button_ui(align = "right", vertical_align = "bottom")

Arguments

Value

admin button UI

The server logic for the default Admin Panel dashboard

Description

The Shiny module server logic for the polished Admin Panel, accessible to Admin users.

Usage

admin_server(input, output, session)

Arguments

Value

invisible(NULL)

The UI for the "Admin Panel" dashboard

Description

The shiny module UI for the polished Admin Panel, accessible to Admin users.

Usage

admin_ui(options = default_admin_ui_options())

Arguments

Value

the UI for the "Admin Panel"

Convert a list returned from the Polished API into a data frame

Description

In order to avoid issues with converting R data frames into JSON objects and back to R data frames, we instead convert R data frames to R lists before converting them to JSON to be sent via the Polished API. This function then converts those lists back into R data frames (or more precisely tibbles).

Usage

api_list_to_df(api_list)

Arguments

Value

a tibble

Auth filter for a Plumber API

Description

Auth filter for a Plumber API

Usage

auth_filter(method = c("basic", "cookie"), api_key = get_api_key())

Arguments

Value

a Plumber API filter function

Create a tar archive

Description

This function is called by deploy_app() to compress Shiny apps before deploying them to Polished Hosting. You probably won't need to call this function directly.

Usage

bundle_app(app_dir = ".")

Arguments

Value

the file path of the app bundle

Examples

## Not run: 
bundle_app(
  system.file("examples/polished_example_01", package = "polished")
)

## End(Not run)

Default Options for the Admin UI

Description

This function specifies the default logos that are displayed in the "Admin Panel".

Usage

default_admin_ui_options()

Value

the default list of HTML for branding elements in the Admin Panel UI. The valid list element names are:

• title - Title/Logo element in top left corner of Admin Panel dashboard & browser tab title

• sidebar_branding - Branding (e.g. Logo) on left sidebar of Admin Panel dashboard

• browser_tab_icon - Icon to display in browser tab

Polished API - Delete an App

Description

Polished API - Delete an App

Usage

delete_app(app_uid = NULL, app_name = NULL, api_key = get_api_key())

Arguments

Details

If both app_uid and app_name arguments are provided, then the app_uid will be used and the app_name will be ignored.

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_apps() add_app() update_app()

Polished API - Delete an App User

Description

Polished API - Delete an App User

Usage

delete_app_user(app_uid, user_uid, api_key = get_api_key())

Arguments

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_apps() add_app() update_app_user()

Polished API - Delete a Role

Description

Polished API - Delete a Role

Usage

delete_role(role_uid, api_key = get_api_key())

Arguments

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_roles() add_role()

Polished API - Delete a User

Description

Polished API - Delete a User

Usage

delete_user(user_uid, api_key = get_api_key())

Arguments

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_users() add_user() update_user()

Polished API - Delete a User Role

Description

Polished API - Delete a User Role

Usage

delete_user_role(role_uid, user_uid, api_key = get_api_key())

Arguments

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_user_roles() add_user_role()

Deploy a Shiny app to Polished Hosting

Description

Deploy a Shiny app to Polished Hosting

Usage

deploy_app(
  app_name,
  app_dir = ".",
  api_key = get_api_key(),
  launch_browser = TRUE,
  region = "us-east1",
  ram_gb = 2,
  r_ver = NULL,
  tlmgr = character(0),
  golem_package_name = NULL,
  cache = TRUE,
  gh_pat = NULL,
  max_sessions = Inf
)

Arguments

Value

an object of class polished_api_res.

Examples

## Not run: 
deploy_app(
  app_name = "polished_example_01",
  app_dir = system.file("examples/polished_example_01", package = "polished"),
  api_key = "<your polished.tech API key>"
)

## End(Not run)

A Shiny email input

Description

This is a replica of shiny::textInput() with the HTML input type attribute set to "email" rather than "text".

Usage

email_input(
  inputId,
  label = tagList(shiny::icon("envelope"), "Email"),
  value = "",
  width = NULL,
  placeholder = NULL
)

Arguments

Value

the UI for the email input.

Load the Firebase JavaScript dependencies into the UI

Description

Under the hood, polished uses Firebase JavaScript dependencies to handle Social sign in & user authentication when sign_in_providers besides "email" are included in polished_config(). This function loads the required Firebase JavaScript dependencies in the the UI of your Shiny app.

Usage

firebase_dependencies(services = c("auth"), firebase_version = "7.15.5")

Arguments

Value

the HTML <script> tags for the Firebase JavaScript dependencies

Examples

firebase_dependencies()

Initialize Firebase

Description

Executes a few lines of JavaScript to initialize Firebase. This function should be called in your Shiny UI immediately after firebase_dependencies.

Usage

firebase_init(firebase_config)

Arguments

Value

a character string of JavaScript code to initialize Firebase

Examples

## Not run: 
my_config <- list(
  apiKey = "your Firebase API key",
  authDomain = "your Firebase auth domain",
  projectId = "your Firebase Project ID"
)

firebase_init(my_config)

## End(Not run)

Polished API - Get App(s) User(s)

Description

Polished API - Get App(s) User(s)

Usage

get_app_users(
  app_uid = NULL,
  user_uid = NULL,
  email = NULL,
  api_key = get_api_key()
)

Arguments

Details

If app_uid, user_uid, & email are all NULL, then all app users will be returned.

Value

an object of class polished_api_res. When successful, the content of the object is a tibble of app(s) with the following columns:

• uid

• app_uid

• user_uid

• is_admin

• created_at

• email

See Also

add_app_user() update_app_user() delete_app_user()

Polished API - Get App(s)

Description

Polished API - Get App(s)

Usage

get_apps(app_uid = NULL, app_name = NULL, api_key = get_api_key())

Arguments

Details

If both the app_uid and app_name are NULL, then all the apps in your account will be returned. If either app_uid or app_name are not NULL, then a single app will be returned (assuming the app exists). If both the app_uid and app_name are provided, then the app_uid will be used, and the app_name will be ignored. If the app does not exists, a zero row tibble will be returned.

Value

an object of class polished_api_res. When successful, the content of the object is a tibble of app(s) with the following columns:

• uid

• app_name

• app_url

• created_at

• modified_at In the case of an error, the content is a list with 1 element named "error".

See Also

add_app() update_app() delete_app()

Create a list of R Package Dependencies

Description

Given a path to a directory this function will scan all .R and .Rmd files for any used R Packages along with their CRAN versions or GitHub references.

Usage

get_package_deps(app_dir = ".", all_deps = FALSE)

Arguments

Details

Currently, packages are detected via automagic::parse_packages() which supports the following calls within the code: library(), require(), and prefixed :: calls to functions.

Once an initial vector of package is created, each package is a checked that it can be downloaded and installed from CRAN or GitHub.

Value

a list of package dependencies with installation details

See Also

automagic::parse_packages()

Polished API - Get Role(s)

Description

Polished API - Get Role(s)

Usage

get_roles(role_uid = NULL, api_key = get_api_key())

Arguments

Value

an object of class polished_api_res. The content of the object is a tibble of user(s) with the following columns:

• uid

• role_name

• created_at

See Also

add_role() delete_role()

Polished API - Get User Role(s)

Description

Polished API - Get User Role(s)

Usage

get_user_roles(user_uid = NULL, role_uid = NULL, api_key = get_api_key())

Arguments

Value

an object of class polished_api_res. The "content" of the object is a tibble of users(s) with the following columns:

• role_uid

• role_name,

• user_uid,

• user_name,

• created_at

See Also

add_user_role() delete_user_role()

Polished API - Get User(s)

Description

Polished API - Get User(s)

Usage

get_users(
  user_uid = NULL,
  email = NULL,
  include_two_fa = FALSE,
  api_key = get_api_key()
)

Arguments

Details

If both the user_uid and email are NULL, then all the users in your account will be returned. If either user_uid or email are not NULL, then a single user will be returned (assuming the user exists). If both the user_uid and email are provided, then the user_uid will be used, and the email will be ignored. If the user does not exists, a zero row tibble will be returned.

Value

an object of class polished_api_res. The content of the object is a tibble of users(s) with the following columns:

• uid

• email

• email_verified

• created_by

• created_at

• modified_by

• modified_at

• is_password_set

See Also

add_user() update_user() delete_user()

normalize UI

Description

the UI passed a shiny app can be a function HTML. This function normalized the 2 different formats so that they both use the character

Usage

normalize_ui(ui, request_)

Arguments

Value

the Shiny UI

A modification of shiny::passwordInput

Description

This modified version of Shiny's passwordInput() does not actually send the password to our Shiny server. It is just a regular password input that always keeps your user's password on the client. The password is used to sign the user in and then converted to a JWT by Firebase, all on the client, before it is sent to your Shiny server.

Usage

password_input(
  input_id,
  label = htmltools::tagList(icon("unlock-alt"), "Password"),
  value = "",
  style = "",
  placeholder = NULL
)

Arguments

Value

the UI to create a password input.

Send GET Request to the Polished API

Description

Send GET Request to the Polished API

Usage

polished_api_res(resp)

Arguments

Value

an S3 object of class "polished_api_res".

global configuration for polished authentication

Description

global configuration for polished authentication

Usage

polished_config(
  app_name,
  api_key = get_api_key(),
  firebase_config = NULL,
  is_invite_required = TRUE,
  sign_in_providers = "email",
  is_email_verification_required = TRUE,
  cookie_expires = 365L,
  is_auth_required = TRUE,
  is_two_fa_required = FALSE
)

global_sessions_config(...)

Arguments

Details

This is the primary function for configuring polished. It configures your app's instance of the Polished class that manages polished authentication. Call this function in your global.R file. See https://github.com/Tychobra/polished/blob/master/inst/examples/polished_example_01/global.R for a complete example.

Value

invisible(NULL)

Examples

## Not run: 
# global.R

polished_config(
  app_name = "<your app name>",
  api_key = "<your API key>",
  firebase_config = list(
    apiKey = "<Firebase apiKey>",
    authDomain = "<Firebase authDomain",
    projectId = "<Firebase projectId>"
  ),
  sign_in_providers = c(
    "email",
    "google",
    "microsoft"
  )
)


## End(Not run)

print polished_api_res

Description

Generic print function for polished_api_res S3 class.

Usage

## S3 method for class 'polished_api_res'
print(x, ...)

Arguments

Value

invisible(NULL)

Profile Module Server

Description

The server logic to accompany the profile_module_ui.

Usage

profile_module(input, output, session)

Arguments

Value

invisible(NULL)

Profile Module UI

Description

Generates the UI for a user profile dropdown button to be used with the shinydashboard package.

Usage

profile_module_ui(id, other_lis = NULL)

Arguments

Value

the UI to create the profile dropdown.

UI for the Social Sign In authentication providers' buttons

Description

Creates the HTML UI of the "Sign in with *" buttons. These buttons are only necessary if you enable Social Sign In via the sign_in_providers argument passed to polished_config.

Usage

providers_ui(
  ns,
  sign_in_providers = c("google", "email"),
  title = "Sign In",
  fancy = TRUE
)

Arguments

Value

the HTML UI of the "Sign in with *" buttons.

Remove the URL query

Description

Remove the entire query string from the URL. This function should only be called inside the server function of your Shiny app.

Usage

remove_query_string(
  session = shiny::getDefaultReactiveDomain(),
  mode = "replace"
)

Arguments

Value

invisible(NULL)

Render and secure R Markdown document

Description

secure_rmd() can be used to render (or run) and secure many types of R Markdown documents. Rendering is handled either by rmarkdown::render or, if using shiny, a shiny app is constructed, and the then the output is secured with polished authentication.

Usage

secure_rmd(
  rmd_file_path,
  polished_config_args = list(),
  sign_in_page_args = list(),
  sign_out_button = NULL
)

Arguments

Value

a Shiny app object

Examples

## Not run: 

secure_rmd(system.file("examples/rmds/flexdashboard.Rmd", package = "polished"))
secure_rmd(
  system.file("examples/rmds/flexdashboard.Rmd", package = "polished"),
  polished_config_args = list(
    # any values in this list will override values in YAML header
    app_name = "different_name"
  ),
  sign_in_page_args = list(
    color = "#FF5700"
  )
)
secure_rmd(system.file("examples/rmds/flexdashboard_shiny.Rmd", package = "polished"))
secure_rmd(system.file("examples/rmds/html_document.Rmd", package = "polished"))
secure_rmd(system.file("examples/rmds/pdf_document.Rmd", package = "polished"))
io_file_path <- system.file(
  "examples/rmds/ioslides/ioslides_presentation.Rmd",
  package = "polished"
)
secure_rmd(io_file_path)

## End(Not run)

Secure your Shiny app's server

Description

This function is used to secure your Shiny app's server function. Make sure to pass your Shiny app's server function as the first argument to secure_server() at the bottom of your Shiny app's server.R file.

Usage

secure_server(server, custom_sign_in_server = NULL, custom_admin_server = NULL)

Arguments

Value

a Shiny server function.

Secure your Shiny UI

Description

This function is used to secure your Shiny app's UI. Make sure to pass your Shiny app's UI as the first argument to secure_ui() at the bottom of your Shiny app's ui.R file.

Usage

secure_ui(
  ui,
  sign_in_page_ui = NULL,
  custom_admin_ui = NULL,
  custom_admin_button_ui = admin_button_ui(),
  admin_ui_options = default_admin_ui_options()
)

Arguments

Value

Secured Shiny app UI

the server logic for a Shiny module to send a password reset email

Description

This function sends a request to the https://polished.tech API to reset a user's password.

Usage

send_password_reset_email_module(input, output, session, email)

Arguments

Value

invisible(NULL)

the UI for a Shiny module to send a password reset email

Description

the UI for a Shiny module to send a password reset email

Usage

send_password_reset_email_module_ui(id, link_text = "Forgot your password?")

Arguments

Value

the UI to create a password reset link.

set Polished API key

Description

The API key can be set as an Environment Variable via Sys.getenv("POLISHED_API_KEY").

Usage

set_api_key(api_key)

get_api_key()

Arguments

Value

a list of the newly set polished R options

Examples

set_api_key(api_key = "<my Polished API key>")

Automatically set the config environment

Description

Determines if the app is deployed to a server or running locally, and adjusts the config environment to "production" or "default", respectively. This function is almost always called in the global.R file of a Shiny app immediately before the configuration in the config.yml is read in.

Usage

set_config_env(override = NULL)

Arguments

Value

invisible(NULL)

Check the JWT from the user sign in

Description

This function retrieves the JWT created by the JavaScript from sign_in_js and signs the user in as long as the token can be verified. This function should be called in the server function of a shiny module. Make sure to call sign_in_js in the UI function of this module.

Usage

sign_in_check_jwt(jwt, session = shiny::getDefaultReactiveDomain())

Arguments

Value

invisible(NULL)

Sign in and register pages JavaScript dependencies

Description

This function should be called at the bottom of your custom sign in and registration pages UI. It loads in all the JavaScript dependencies to handle polished sign in and registration. See the vignette for details.

Usage

sign_in_js(ns = function(x) x)

Arguments

Value

the javascript to and other web dependencies to create the sign in functionality.

Server logic for the Sign In & Register pages

Description

This server logic accompanies the sign_in_module_ui.

Usage

sign_in_module(input, output, session)

Arguments

Value

invisible(NULL)

Server logic for the Sign In & Register pages

Description

This server logic accompanies sign_in_module_2_ui.

Usage

sign_in_module_2(input, output, session)

Arguments

Value

invisible(NULL)

UI for the Sign In & Register pages

Description

Alternate sign in UI that works regardless of whether or not invites are required. The UI displays email sign in inputs on the left, and social sign in options on the right. sign_in_module_2 must be provided as the argument custom_sign_in_server in secure_server for proper functionality.

Usage

sign_in_module_2_ui(id)

Arguments

Value

the sign in module UI.

UI for the Sign In & Register pages

Description

UI for the Sign In & Register pages when a user invite is required to Register & Sign In.

Usage

sign_in_module_ui(
  id,
  register_link = "First time user? Register here!",
  password_reset_link = "Forgot your password?"
)

Arguments

Value

the sign in module UI.

verify the users Firebase JWT and store the session

Description

verify the users Firebase JWT and store the session

Usage

sign_in_social(firebase_token, hashed_cookie)

Arguments

Value

NULL if sign in fails. If sign in is successful, a list containing the following:

• email

• email_verified

• is_admin

• user_uid

• hashed_cookie

• session_uid

Default UI styles for the Sign In & Registration pages

Description

Default styling for the sign in & registration pages. Update the sign_in_ui_default() arguments with your brand and colors to quickly style the sign in & registration pages to match your brand.

Usage

sign_in_ui_default(
  sign_in_module = sign_in_module_ui("sign_in"),
  color = "#5ec7dd",
  company_name = "Your Brand Here",
  logo_top = tags$div(style = "width: 300px; max-width: 100%; color: #FFF;", class =
    "text-center", h1("Your", style = "margin-bottom: 0; margin-top: 30px;"), h1("Brand",
    style = "margin-bottom: 0; margin-top: 10px;"), h1("Here", style =
    "margin-bottom: 15px; margin-top: 10px;")),
  logo_bottom = NULL,
  icon_href = "polish/images/polished_icon.png",
  background_image = NULL,
  terms_and_privacy_footer = NULL,
  align = "center",
  button_color = NULL,
  footer_color = "#FFF"
)

Arguments

Value

the html and css to create the default sign in UI.

the UI for the Sign In & Registration pages

Sign Out from your Shiny app

Description

Call this function to sign a user out of your Shiny app. This function should be called inside the server function of your Shiny app. See https://github.com/Tychobra/polished/blob/master/inst/examples/polished_example_01/server.R For an example of this function being called after the user clicks a "Sign Out" button.

Usage

sign_out_from_shiny(
  session = shiny::getDefaultReactiveDomain(),
  redirect_page = "?page=sign_in"
)

Arguments

Value

invisible(NULL)

Polished API - Update an App

Description

Polished API - Update an App

Usage

update_app(app_uid, app_name = NULL, app_url = NULL, api_key = get_api_key())

Arguments

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_apps() add_app() delete_app()

Polished API - Update an App User

Description

Polished API - Update an App User

Usage

update_app_user(app_uid, user_uid, is_admin = FALSE, api_key = get_api_key())

Arguments

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_app_users() add_app_user() delete_app_user()

Polished API - Update a user

Description

Polished API - Update a user

Usage

update_user(user_uid, user_data, api_key = get_api_key())

Arguments

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_users() add_user() delete_user()

admin user access module

Description

Server function for the default Shiny module to control user access in the polished Admin Panel.

Usage

user_access_module(input, output, session)

Arguments

Value

invisible(NULL)

admin user access_ui

Description

Shiny module UI for the default user access tab in the polished Admin Panel.

Usage

user_access_module_ui(id)

Arguments

Value

the UI to create the user access module.

Valid Regions for Polished Hosting

Description

Set the region argument of deploy_app() to one of these regions.

Usage

valid_gcp_regions

Format

An object of class character of length 35.