canvas-embed 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ed39f8027511445d28514cde191bade34d5b4101814dfb4bd7307d5b7eb51e4
-  data.tar.gz: 7528eaaf4db9c5c77d3be5a6a50ba40eb1321e9805b119b3144300ea020cd861
+  metadata.gz: 45b64ffaefba9ed0079b7d68ce049ea9b13f43e33b1b16af374eece5f2d602c2
+  data.tar.gz: 06712ec1051c757a7835ab7df4c6d47728a4bc99f6a0054d2d42b4fb606d162e
 SHA512:
-  metadata.gz: a277e1fe0976095609dea6a27e35101028eeec6c8cb0129e05b91a61c8b40eab15c8a445189c9219915355d58722f6cdce6d4ae0998bfb80bf2158a1d1fd0580
-  data.tar.gz: edacd70f37ed8c97e9a4a045c795e5608ad967bf088cd5b9e6818a00be9889dbbb451eb5f422c0bd5fae1ab120331ea442b77533804867475109d06d8654c833
+  metadata.gz: dd3ee766aff62d4420fda59ab2e4a274a3cf28ebb00d5364b186c9476141fa350679db9506c45abab458c1f948d95409fa731300ff4c8700a982d3ae68d9992c
+  data.tar.gz: 8eb0765d2c8be6e8a5fd51e15637ad1a0c3692175a0ae3d89f1759ad093c40bf4d8503b2fbd1bedb41271c060503570d6726a1c30d1e88c46e41bb5728dcad3f

data/Gemfile

@@ -5,6 +5,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in canvas-embed.gemspec
 gemspec
 
+gem 'canvas-embed'
+
 gem 'rake', '~> 13.1'
 
 gem 'rspec', '~> 3.0'

data/README.md

@@ -10,6 +10,18 @@ If any scopes are required by your charts that are not present in the scopes pay
 
 You can view how this Gem is used in a sample rails app in the `example/` directory
 
+# Usage
+
+Add `gem 'canvas-embed'` to your Gemfile, then:
+
+```
+# key is the private key from Canvas
+# scopes is the Hash of scopes to grant the user
+# expiration_seconds is the duration in seconds for the token to be valid (default is one hour)
+# user_id is an optional user identifier that will be used in Canvas' logging
+Canvas::Embed.generate_embed_token(key, scopes, expiration_seconds, user_id)
+```
+
 # Running tests
 
 ```

data/example/Gemfile

@@ -7,7 +7,7 @@ ruby '3.2.2'
 # Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
 gem 'rails', '~> 7.1.1'
 
-gem 'canvas-embed', '~> 0.1.4'
+gem 'canvas-embed', '~> 0.1.6'
 
 gem 'rack-cors'
 

data/example/Gemfile.lock

@@ -82,7 +82,7 @@ GEM
     bootsnap (1.17.0)
       msgpack (~> 1.2)
     builder (3.2.4)
-    canvas-embed (0.1.5)
+    canvas-embed (0.1.6)
       rbnacl (~> 7.1.1)
     capybara (3.39.2)
       addressable
@@ -251,7 +251,7 @@ PLATFORMS
 
 DEPENDENCIES
   bootsnap
-  canvas-embed (~> 0.1.4)
+  canvas-embed (~> 0.1.6)
   capybara
   debug
   importmap-rails

data/example/README.md

@@ -10,7 +10,7 @@ After running `bundle install` you can start the Rails server with
 CANVAS_SIGNING_KEY=[your signing key] bin/rails server
 ```
 
-This serves a GET endpoint `generate_token?scopes=[scopes]` where scopes are the scopes you want included in the generated token.
+This serves a GET endpoint `generate_embed_token?scopes=[scopes]` where scopes are the scopes you want included in the generated token.
 
 
 This endpoint is used in the [React component](https://github.com/canvas/embeds/tree/main/react) to view embedded Canvas charts as they will appear to your users.

data/example/app/controllers/application_controller.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-include Canvas::Embed
-
 class ApplicationController < ActionController::Base
-  def generate_token
+  def generate_embed_token
     # this is the secret signing key from Canvas
     key_hex = ENV['CANVAS_SIGNING_KEY']
     # this should be updated to include the scopes needed for your charts and that are
@@ -13,7 +11,14 @@ class ApplicationController < ActionController::Base
     rescue StandardError
       return render json: { 'message' => 'Scopes were not valid JSON' }, status: 500
     end
-    token = Canvas::Embed.generate_token(key_hex, scopes, 7200, "usr_test123")
+    token = Canvas::Embed.generate_embed_token(key_hex, scopes, 7200, "usr_test123")
+    render json: { 'token' => token }
+  end
+  def generate_login_token
+    # this is the secret signing key from Canvas
+    key_hex = ENV['CANVAS_SIGNING_KEY']
+    email = params[:email]
+    token = Canvas::Embed.generate_login_token(key_hex, email)
     render json: { 'token' => token }
   end
 end

data/example/config/routes.rb

@@ -6,7 +6,8 @@ Rails.application.routes.draw do
   # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.
   # Can be used by load balancers and uptime monitors to verify that the app is live.
   get 'up' => 'rails/health#show', as: :rails_health_check
-  get '/generate_token', to: 'application#generate_token'
+  get '/generate_embed_token', to: 'application#generate_embed_token'
+  get '/generate_login_token', to: 'application#generate_login_token'
 
   # Defines the root path route ("/")
   # root "posts#index"