Merge pull request #69 from metabase/minimal-examples

gvwilson · web-flow · commit 7f59a2162c02 · 2021-06-04T09:49:18.000-04:00
Minimal examples
diff --git a/django/minimal_example/index.html b/django/minimal_example/index.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>{{ title }}</title>
+  </head>
+  <body>
+    <h1>Embed {{ title }}</h1>
+    <iframe
+      src="{{iframeUrl}}"
+      frameborder="1"
+      width="800"
+      height="600"
+    ></iframe>
+  </body>
+</html>
diff --git a/django/minimal_example/index.py b/django/minimal_example/index.py
@@ -0,0 +1,51 @@
+# A minimal example of a signed embedding in a Django application. Run this program with:
+#
+#    django-admin runserver --pythonpath=. --settings=index
+#
+# URLs are:
+# - http://localhost:8000/       : home page
+#
+# You will need to modify the value of `METABASE_SECRET_KEY` to make this work.
+# Please see https://www.metabase.com/learn/developing-applications/advanced-metabase/embedding-charts-and-dashboards.html
+# for the full tutorial.
+
+import os
+import time
+
+from django.conf.urls import url
+from django.http import HttpResponse
+from django.template.loader import render_to_string
+
+import jwt
+
+
+DEBUG = True
+SECRET_KEY = '4l0ngs3cr3tstr1ngw3lln0ts0l0ngw41tn0w1tsl0ng3n0ugh'
+ROOT_URLCONF = __name__
+TEMPLATES = [{
+    'BACKEND': 'django.template.backends.django.DjangoTemplates',
+    'DIRS': [os.getcwd()]
+}]
+
+
+def home(request):
+    METABASE_SITE_URL = 'http://localhost:3000'
+    METABASE_SECRET_KEY = '40e0106db5156325d600c37a5e077f44a49be1db9d02c96271e7bd67cc9529fa'
+    payload = {
+        'resource': {'question': 1},
+        'params': {},
+        'exp': round(time.time()) + (60 * 10)
+    }
+    token = jwt.encode(payload, METABASE_SECRET_KEY, algorithm='HS256')
+    iframeUrl = METABASE_SITE_URL + '/embed/question/' + token + '#bordered=true&titled=true'
+
+    html = render_to_string('index.html', {
+        'title': 'Embedding Metabase',
+        'iframeUrl': iframeUrl
+    })
+    return HttpResponse(html)
+    
+
+urlpatterns = [
+    url(r'^$', home, name='homepage')
+]
diff --git a/html/index.html b/html/index.html
@@ -0,0 +1,23 @@
+<!--
+A simple example showing how to embed a question using an iframe.  This embed is not signed; please see:
+
+    https://www.metabase.com/learn/developing-applications/advanced-metabase/embedding-charts-and-dashboards.html
+
+for the full tutorial.
+
+You will need to modify the `src` attribute of the iframe to match your Metabase installation.
+-->
+<html>
+  <head>
+    <title>Metabase Embedding</title>
+  </head>
+  <body>
+    <h1>Metabase Embedding</h1>
+    <iframe
+      src="http://localhost:3000/public/question/7f0c3c4b-173e-452c-810f-ccb3fc4482a3"
+      frameborder="1"
+      width="600"
+      height="400"
+      ></iframe>
+  </body>
+</html>
diff --git a/shiny/minimal_example/app.R b/shiny/minimal_example/app.R
@@ -0,0 +1,34 @@
+library(shiny)
+library(jose)
+library(glue)
+
+# Metabase location and secret key of our embedded question.
+METABASE_SITE_URL <- 'http://localhost:3000'
+METABASE_SECRET_KEY <- '40e0106db5156325d600c37a5e077f44a49be1db9d02c96271e7bd67cc9529fa'
+
+# Display title and iframe in UI.
+ui <- bootstrapPage(
+  h1('Page title'),
+  uiOutput('container')
+)
+
+# Server does the work.
+server <- function(input, output) {
+  # Token expires 10 minutes in the future.
+  expiry <- as.integer(unclass(Sys.time())) + (60 * 10)
+
+  # Construct params in two steps so that JSON conversion knows it's a list.
+  params <- list()
+  names(params) <- character(0)
+
+  # Create the JWT claim.
+  claim <- jwt_claim(exp = expiry, resource = list(question = 1), params = params)
+
+  # Encode token and use it to construct iframe URL.
+  token <- jwt_encode_hmac(claim, secret = METABASE_SECRET_KEY)
+  url <- glue("{METABASE_SITE_URL}/embed/question/{token}#bordered=true&titled=true")
+  output$container <- renderUI(tags$iframe(width = "600", height = "600", src = url))
+}
+
+# Run application.
+shinyApp(ui = ui, server = server, options = list(port = 8001))
