canvas-embed 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7af45da10208e45e2f54a9181dd2994c17811c7b6e43e73826a7265813d05d8c
-  data.tar.gz: 02ce2f185ae94eee00eba68fdc8b40fbcce0d74c244ae7fe83c54285aa44cc3e
+  metadata.gz: 3ed39f8027511445d28514cde191bade34d5b4101814dfb4bd7307d5b7eb51e4
+  data.tar.gz: 7528eaaf4db9c5c77d3be5a6a50ba40eb1321e9805b119b3144300ea020cd861
 SHA512:
-  metadata.gz: 3919c5c60d2d9e2c37cc7216cbda19b8f8f98bcd3c0ac740af7b919356c8ce8bc3e62872069a4b605fa0b135e967831978f798552661d4b5bd1e005d72249153
-  data.tar.gz: 56f950cd613d9b958da77cb91e5fb703063257a9b0e6da2c69ccec47846e473fc6fe0dc71a46d05f3693201006fd74e937079463fba3b37d8a031cb4c598748d
+  metadata.gz: a277e1fe0976095609dea6a27e35101028eeec6c8cb0129e05b91a61c8b40eab15c8a445189c9219915355d58722f6cdce6d4ae0998bfb80bf2158a1d1fd0580
+  data.tar.gz: edacd70f37ed8c97e9a4a045c795e5608ad967bf088cd5b9e6818a00be9889dbbb451eb5f422c0bd5fae1ab120331ea442b77533804867475109d06d8654c833

data/Gemfile

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in canvas-embed.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.1'
 
-gem "rspec", "~> 3.0"
+gem 'rspec', '~> 3.0'
 
-gem "rubocop", "~> 1.21"
+gem 'rubocop', '~> 1.21'
 
-gem "rbnacl", "~> 7.1.1"
+gem 'rbnacl', '~> 7.1.1'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    canvas-embed (0.1.0)
+    canvas-embed (0.1.4)
       rbnacl (~> 7.1.1)
 
 GEM
@@ -19,7 +19,7 @@ GEM
       racc
     racc (1.7.1)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.1.0)
     rbnacl (7.1.1)
       ffi
     regexp_parser (2.8.2)
@@ -59,7 +59,7 @@ PLATFORMS
 
 DEPENDENCIES
   canvas-embed!
-  rake (~> 13.0)
+  rake (~> 13.1)
   rbnacl (~> 7.1.1)
   rspec (~> 3.0)
   rubocop (~> 1.21)

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Will Pride
+Copyright (c) 2023 Infinite Canvas Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -10,18 +10,6 @@ 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
 
-# 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
 
 ```

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/bin/console

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "canvas/embed"
+require 'bundler/setup'
+require 'canvas/embed'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/canvas-embed.gemspec

@@ -1,28 +1,29 @@
 # frozen_string_literal: true
 
-require_relative "lib/canvas/embed/version"
+require_relative 'lib/canvas/embed/version'
 require 'rake/file_list'
 
 Gem::Specification.new do |spec|
-  spec.name = "canvas-embed"
+  spec.name = 'canvas-embed'
   spec.version = Canvas::Embed::VERSION
-  spec.authors = ["Will Pride"]
-  spec.email = ["will@canvasapp.com"]
+  spec.authors = ['Will Pride']
+  spec.email = ['will@canvasapp.com']
 
-  spec.summary = "Generate tokens to display your Canvas charts in your application."
+  spec.summary = 'Generate tokens to display your Canvas charts in your application.'
   spec.description = "This Gem allows you to generated signed tokens that grant your users scoped access to your Canvas embeds. This token can be used in Canvas' React component to display your Canvas charts in your own application."
-  spec.homepage = "https://github.com/canvas/embeds"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.homepage = 'https://github.com/canvas/embeds'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
 
-  spec.metadata["homepage_uri"] = "https://canvasapp.com"
-  spec.metadata["source_code_uri"] = "https://github.com/canvas/embeds"
+  spec.metadata['homepage_uri'] = 'https://canvasapp.com'
+  spec.metadata['source_code_uri'] = 'https://github.com/canvas/embeds'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/canvas/embeds/issues'
 
   spec.files = Rake::FileList['**/*'].exclude(*File.read('.gitignore').split)
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "rbnacl", "~> 7.1.1"
+  spec.add_dependency 'rbnacl', '~> 7.1.1'
 
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.21'
 end

data/example/Gemfile

@@ -1,37 +1,39 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-ruby "3.2.2"
+source 'https://rubygems.org'
+
+ruby '3.2.2'
 
 # Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
-gem "rails", "~> 7.1.1"
+gem 'rails', '~> 7.1.1'
 
-gem "canvas-embed", "~> 0.1.3"
+gem 'canvas-embed', '~> 0.1.4'
 
 gem 'rack-cors'
 
 # The original asset pipeline for Rails [https://github.com/rails/sprockets-rails]
-gem "sprockets-rails"
+gem 'sprockets-rails'
 
 # Use sqlite3 as the database for Active Record
-gem "sqlite3", "~> 1.4"
+gem 'sqlite3', '~> 1.4'
 
 # Use the Puma web server [https://github.com/puma/puma]
-gem "puma", ">= 5.0"
+gem 'puma', '>= 5.0'
 
 # Use JavaScript with ESM import maps [https://github.com/rails/importmap-rails]
-gem "importmap-rails"
+gem 'importmap-rails'
 
 # Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev]
-gem "turbo-rails"
+gem 'turbo-rails'
 
 # Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev]
-gem "stimulus-rails"
+gem 'stimulus-rails'
 
 # Build JSON APIs with ease [https://github.com/rails/jbuilder]
-gem "jbuilder"
+gem 'jbuilder'
 
 # Use Redis adapter to run Action Cable in production
-gem "redis", ">= 4.0.1"
+gem 'redis', '>= 4.0.1'
 
 # Use Kredis to get higher-level data types in Redis [https://github.com/rails/kredis]
 # gem "kredis"
@@ -40,33 +42,32 @@ gem "redis", ">= 4.0.1"
 # gem "bcrypt", "~> 3.1.7"
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
-gem "tzinfo-data", platforms: %i[ windows jruby ]
+gem 'tzinfo-data', platforms: %i[windows jruby]
 
 # Reduces boot times through caching; required in config/boot.rb
-gem "bootsnap", require: false
+gem 'bootsnap', require: false
 
 # Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
 # gem "image_processing", "~> 1.2"
 
 group :development, :test do
   # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
-  gem "debug", platforms: %i[ mri windows ]
+  gem 'debug', platforms: %i[mri windows]
 end
 
 group :development do
   # Use console on exceptions pages [https://github.com/rails/web-console]
-  gem "web-console"
+  gem 'web-console'
 
   # Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler]
   # gem "rack-mini-profiler"
 
   # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
   # gem "spring"
-
 end
 
 group :test do
   # Use system testing [https://guides.rubyonrails.org/testing.html#system-testing]
-  gem "capybara"
-  gem "selenium-webdriver"
+  gem 'capybara'
+  gem 'selenium-webdriver'
 end

data/example/Gemfile.lock

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

data/example/README.md

@@ -10,8 +10,21 @@ After running `bundle install` you can start the Rails server with
 CANVAS_SIGNING_KEY=[your signing key] bin/rails server
 ```
 
-Then access `localhost:3001/generate_token` in your browser. You should see the signed token payload. 
+This serves a GET endpoint `generate_token?scopes=[scopes]` where scopes are the scopes you want included in the generated token.
 
-This can be 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.
 
-In order for this to work, you'll need to update the scopes in `ApplicationController` to include the ones relevant to your charts and user.
+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.
+
+In order for this to work, you'll need to update the scopes in `ApplicationController` to include the ones relevant to your charts and user.
+
+# 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
+```

data/example/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require_relative "config/application"
+require_relative 'config/application'
 
 Rails.application.load_tasks

data/example/app/controllers/application_controller.rb

@@ -1,4 +1,6 @@
-# require "canvas-embed"
+# frozen_string_literal: true
+
+include Canvas::Embed
 
 class ApplicationController < ActionController::Base
   def generate_token
@@ -8,10 +10,10 @@ class ApplicationController < ActionController::Base
     # appropriate for the user
     begin
       scopes = ActiveSupport::JSON.decode params[:scopes]
-    rescue StandardError => e
-      return render :json => { "message" => "Scopes were not valid JSON" }, status: 500
+    rescue StandardError
+      return render json: { 'message' => 'Scopes were not valid JSON' }, status: 500
     end
-    token = Canvas::Embed::generate_token(key_hex, scopes)
-    render :json => { "token" => token }
+    token = Canvas::Embed.generate_token(key_hex, scopes, 7200, "usr_test123")
+    render json: { 'token' => token }
   end
 end

data/example/bin/bundle

@@ -8,46 +8,46 @@
 # this file is here to facilitate running it.
 #
 
-require "rubygems"
+require 'rubygems'
 
 m = Module.new do
   module_function
 
   def invoked_as_script?
-    File.expand_path($0) == File.expand_path(__FILE__)
+    File.expand_path($PROGRAM_NAME) == File.expand_path(__FILE__)
   end
 
   def env_var_version
-    ENV["BUNDLER_VERSION"]
+    ENV['BUNDLER_VERSION']
   end
 
   def cli_arg_version
     return unless invoked_as_script? # don't want to hijack other binstubs
-    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    return unless 'update'.start_with?(ARGV.first || ' ') # must be running `bundle update`
+
     bundler_version = nil
     update_index = nil
     ARGV.each_with_index do |a, i|
-      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
-        bundler_version = a
-      end
+      bundler_version = a if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
       next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
-      bundler_version = $1
+
+      bundler_version = Regexp.last_match(1)
       update_index = i
     end
     bundler_version
   end
 
   def gemfile
-    gemfile = ENV["BUNDLE_GEMFILE"]
+    gemfile = ENV['BUNDLE_GEMFILE']
     return gemfile if gemfile && !gemfile.empty?
 
-    File.expand_path("../Gemfile", __dir__)
+    File.expand_path('../Gemfile', __dir__)
   end
 
   def lockfile
     lockfile =
       case File.basename(gemfile)
-      when "gems.rb" then gemfile.sub(/\.rb$/, ".locked")
+      when 'gems.rb' then gemfile.sub(/\.rb$/, '.locked')
       else "#{gemfile}.lock"
       end
     File.expand_path(lockfile)
@@ -55,8 +55,10 @@ m = Module.new do
 
   def lockfile_version
     return unless File.file?(lockfile)
+
     lockfile_contents = File.read(lockfile)
     return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+
     Regexp.last_match(1)
   end
 
@@ -76,20 +78,24 @@ m = Module.new do
   end
 
   def load_bundler!
-    ENV["BUNDLE_GEMFILE"] ||= gemfile
+    ENV['BUNDLE_GEMFILE'] ||= gemfile
 
     activate_bundler
   end
 
   def activate_bundler
     gem_error = activation_error_handling do
-      gem "bundler", bundler_requirement
+      gem 'bundler', bundler_requirement
     end
     return if gem_error.nil?
+
     require_error = activation_error_handling do
-      require "bundler/version"
+      require 'bundler/version'
+    end
+    if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+      return
     end
-    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+
     warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
     exit 42
   end
@@ -104,6 +110,4 @@ end
 
 m.load_bundler!
 
-if m.invoked_as_script?
-  load Gem.bin_path("bundler", "bundle")
-end
+load Gem.bin_path('bundler', 'bundle') if m.invoked_as_script?

data/example/bin/importmap

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require_relative "../config/application"
-require "importmap/commands"
+require_relative '../config/application'
+require 'importmap/commands'

data/example/bin/rails

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path("../config/application", __dir__)
-require_relative "../config/boot"
-require "rails/commands"
+# frozen_string_literal: true
+
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/example/bin/rake

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
-require_relative "../config/boot"
-require "rake"
+# frozen_string_literal: true
+
+require_relative '../config/boot'
+require 'rake'
 Rake.application.run

data/example/bin/setup

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
-require "fileutils"
+# frozen_string_literal: true
+
+require 'fileutils'
 
 # path to your application root.
-APP_ROOT = File.expand_path("..", __dir__)
+APP_ROOT = File.expand_path('..', __dir__)
 
 def system!(*args)
   system(*args, exception: true)
@@ -13,9 +15,9 @@ FileUtils.chdir APP_ROOT do
   # This script is idempotent, so that you can run it at any time and get an expectable outcome.
   # Add necessary setup steps to this file.
 
-  puts "== Installing dependencies =="
-  system! "gem install bundler --conservative"
-  system("bundle check") || system!("bundle install")
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
 
   # puts "\n== Copying sample files =="
   # unless File.exist?("config/database.yml")
@@ -23,11 +25,11 @@ FileUtils.chdir APP_ROOT do
   # end
 
   puts "\n== Preparing database =="
-  system! "bin/rails db:prepare"
+  system! 'bin/rails db:prepare'
 
   puts "\n== Removing old logs and tempfiles =="
-  system! "bin/rails log:clear tmp:clear"
+  system! 'bin/rails log:clear tmp:clear'
 
   puts "\n== Restarting application server =="
-  system! "bin/rails restart"
+  system! 'bin/rails restart'
 end

data/example/config/application.rb

@@ -1,6 +1,8 @@
-require_relative "boot"
+# frozen_string_literal: true
 
-require "rails/all"
+require_relative 'boot'
+
+require 'rails/all'
 
 # Require the gems listed in Gemfile, including any gems
 # you've limited to :test, :development, or :production.
@@ -14,7 +16,7 @@ module Blog
     # Please, add to the `ignore` list any other `lib` subdirectories that do
     # not contain `.rb` files, or that should not be reloaded or eager loaded.
     # Common ones are `templates`, `generators`, or `middleware`, for example.
-    config.autoload_lib(ignore: %w(assets tasks))
+    config.autoload_lib(ignore: %w[assets tasks])
 
     # Configuration for the application, engines, and railties goes here.
     #

data/example/config/boot.rb

@@ -1,4 +1,6 @@
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+# frozen_string_literal: true
 
-require "bundler/setup" # Set up gems listed in the Gemfile.
-require "bootsnap/setup" # Speed up boot time by caching expensive operations.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.
+require 'bootsnap/setup' # Speed up boot time by caching expensive operations.

data/example/config/environment.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # Load the Rails application.
-require_relative "application"
+require_relative 'application'
 
 # Initialize the Rails application.
 Rails.application.initialize!

data/example/config/environments/development.rb

@@ -1,4 +1,6 @@
-require "active_support/core_ext/integer/time"
+# frozen_string_literal: true
+
+require 'active_support/core_ext/integer/time'
 
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
@@ -19,13 +21,13 @@ Rails.application.configure do
 
   # Enable/disable caching. By default caching is disabled.
   # Run rails dev:cache to toggle caching.
-  if Rails.root.join("tmp/caching-dev.txt").exist?
+  if Rails.root.join('tmp/caching-dev.txt').exist?
     config.action_controller.perform_caching = true
     config.action_controller.enable_fragment_cache_logging = true
 
     config.cache_store = :memory_store
     config.public_file_server.headers = {
-      "Cache-Control" => "public, max-age=#{2.days.to_i}"
+      'Cache-Control' => "public, max-age=#{2.days.to_i}"
     }
   else
     config.action_controller.perform_caching = false

data/example/config/initializers/cors.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 Rails.application.config.middleware.insert_before 0, Rack::Cors do
-	allow do
-	  origins '*'
-      
-	  resource '*',
-	    headers: :any,
-	    methods: [:get, :post, :put, :patch, :delete, :options, :head]
-	end
-      end
+  allow do
+    origins '*'
+
+    resource '*',
+             headers: :any,
+             methods: %i[get post put patch delete options head]
+  end
+end

data/example/config/puma.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This configuration file will be evaluated by Puma. The top-level methods that
 # are invoked here are part of Puma's configuration DSL. For more information
 # about methods provided by the DSL, see https://puma.io/puma/Puma/DSL.html.
@@ -7,29 +9,29 @@
 # Any libraries that use thread pools should be configured to match
 # the maximum value specified for Puma. Default is set to 5 threads for minimum
 # and maximum; this matches the default thread size of Active Record.
-max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
-min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+max_threads_count = ENV.fetch('RAILS_MAX_THREADS', 5)
+min_threads_count = ENV.fetch('RAILS_MIN_THREADS') { max_threads_count }
 threads min_threads_count, max_threads_count
 
 # Specifies that the worker count should equal the number of processors in production.
-if ENV["RAILS_ENV"] == "production"
-  require "concurrent-ruby"
-  worker_count = Integer(ENV.fetch("WEB_CONCURRENCY") { Concurrent.physical_processor_count })
+if ENV['RAILS_ENV'] == 'production'
+  require 'concurrent-ruby'
+  worker_count = Integer(ENV.fetch('WEB_CONCURRENCY') { Concurrent.physical_processor_count })
   workers worker_count if worker_count > 1
 end
 
 # Specifies the `worker_timeout` threshold that Puma will use to wait before
 # terminating a worker in development environments.
-worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development"
+worker_timeout 3600 if ENV.fetch('RAILS_ENV', 'development') == 'development'
 
 # Specifies the `port` that Puma will listen on to receive requests; default is 3000.
-port ENV.fetch("PORT") { 3001 }
+port ENV.fetch('PORT', 3001)
 
 # Specifies the `environment` that Puma will run in.
-environment ENV.fetch("RAILS_ENV") { "development" }
+environment ENV.fetch('RAILS_ENV', 'development')
 
 # Specifies the `pidfile` that Puma will use.
-pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+pidfile ENV.fetch('PIDFILE', 'tmp/pids/server.pid')
 
 # Allow puma to be restarted by `bin/rails restart` command.
 plugin :tmp_restart