canvas-embed 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ae4f7ad4a25488a444dea932b5846ab57a78e86c6383f579c89e70fc668eb0c
-  data.tar.gz: 414c3d87b5f1203fa1a877118c77b0e87d744231c568881c1ae1a2afa76f146f
+  metadata.gz: e185250539e0fd29e6b9e3324986a044e7c0432017b8cce37a83a3c40a6a8d03
+  data.tar.gz: 7ff8320e2b3648c934e0cb14f41aab09a65f66df2989e642af5d9232205576a0
 SHA512:
-  metadata.gz: d9aca4c63145661dcd1f504d5107f5c86139e0f1245247dd1ad93a8fd8b990f8dc34367cf783d53544011f07fa2ff7740d375f20a9cb2bceb6be35a849aef30a
-  data.tar.gz: ebb161e1a0af4aa2d90baaadb65108cb244747a75fae74b729a09ddedf4b313f9867f93209f8380caa13d0b4171412e6321bded36d5949cb66127b42cc8c77e5
+  metadata.gz: bfcf03d22c7f2458af4a9bee05dd9035413648e51b12f951527a22c2360c2f47239577af721ee24bfd9df067019df9074f27a78c829c7d469a10f8537ce3cd9f
+  data.tar.gz: 8bf90b19df7368243da97e30e8f127a5b2d45ac58619cddcdd4098b2810e5df1d9d784001bc53940493aa23728a9c2031be2e7a1c8dd771ba7b5ce5e1235fe82

data/README.md

@@ -0,0 +1,40 @@
+# Canvas::Embed
+
+This Gem allows you to generate signed tokens that grant access to your Canvas embeds.
+
+Your application frontend can then use these tokens in the Canvas [React component](https://github.com/canvas/embeds/tree/main/react) to display your Canvas embeds in your application.
+
+Each token should be configured with the set of scopes that are approriate for the user, granting them access to only their data.
+
+If any scopes are required by your charts that are not present in the scopes payload, the request will fail.
+
+You can view how this Gem is used in a sample rails app in the `example/` directory
+
+# Running
+
+```
+bin/rails server
+```
+
+This application expects the key in the CANVAS_SIGNING_KEY variable. You can set this by running:
+
+```
+CANVAS_SIGNING_KEY=emk_HgwRqhyt.f0533f95ed220910218667124cac2116fsse11daf2aa1ff9938f7fde7a16c203 bin/rails server
+```
+
+# Running tests
+
+```
+rspec
+```
+
+# Canvas publishing
+
+```
+# increment the version in version.rb
+# build the new gem
+rake build
+# outputs new gem path eg 'canvas-embed 0.1.1 built to pkg/canvas-embed-0.1.1.gem'
+# publish the new gem (need rubygems.org access) from the path above
+gem push pkg/canvas-embed-0.1.1.gem
+```

data/lib/canvas/embed.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "embed/version"
+require 'json'
+require 'rbnacl'
+require "base64"
+
+module Canvas
+  module Embed
+    extend self
+    def generate_token(private_key, scopes)
+      # token consists of an id and the signing key
+      key_id, key = private_key.split('.')
+      # transform signing key hex into bytes
+      key_bytes = [key].pack('H*')
+      secret_box = RbNaCl::SecretBox.new(key_bytes)
+      nonce = RbNaCl::Random.random_bytes(secret_box.nonce_bytes)
+      message = { "scopes" => scopes }.to_json
+      ciphertext = secret_box.encrypt(nonce, message)
+      # transform bytes into hex
+      unpacked_message = ciphertext.unpack('H*').first
+      unpacked_nonce = nonce.unpack('H*').first
+      token = { "message" => unpacked_message, "nonce" => unpacked_nonce, "keyId" => key_id }.to_json;
+      # strict for no newlines
+      Base64.strict_encode64(token)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas-embed
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Will Pride
@@ -60,7 +60,9 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- README.md
+- lib/canvas/embed.rb
 homepage: https://github.com/canvas/embeds
 licenses:
 - MIT