canvas_sync 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6178b9db26d809e2e35b5c4d38187d2ceb14018
-  data.tar.gz: ec84b34894e5b40e27666cdb0946053a355cf422
+  metadata.gz: 1489eac6e822527f27f73828fbe9bcccad401e55
+  data.tar.gz: e91a8c75620d6006dc935a2f7774e2cce04b4922
 SHA512:
-  metadata.gz: 4ee7ea65f6c785d05559f52b841483ea2a316509373feedc7c29a35599bfe99d20214ca3a2b2116d1ef503d366a03ec6382d59eb0636e361138cb6378ef6afe1
-  data.tar.gz: aaf71eaaf57f0ff80e7c5e92a22f3a3340e57358ab9a1042f1e821ad15dacbd0b401fd93199bbd0c0e9bbb3ff5540c223ce512be15315b5ad71dd43591e92875
+  metadata.gz: 3a8bb596f0e3c59b5318c1cb79927ca74fc08733a0e4db1733dc9ba45b6c2613ae13d1732a3b79dd8c99e3ec0f55be69c0740b44a3beced935c1a0c390f8e9ba
+  data.tar.gz: 163a3abc8abcba6f3406bcc0feb31fdb5b71fed6648d730bb716af112aa4fa8fddfd6487f1f4c860ed0117c9fad7f813400fb9bcfcb67601f05bf599eed7352c

data/README.md

@@ -34,16 +34,27 @@ The yard server will give you a URL you can visit to view the docs.
 
 ## Basic Usage
 
-Your tool must have an `ActiveJob` compatible job queue adapter configured, such as DelayedJob or Sidekiq. Once that's done and you've used the generator to create your models and migrations you can run the standard provisioning sync:
+Your tool must have an `ActiveJob` compatible job queue adapter configured, such as DelayedJob or Sidekiq. Additionally, you must have a method called `canvas_sync_client` defined in an initializer that returns a Bearcat client for the Canvas instance you are syncing against. Example:
 
 ```ruby
-CanvasSync.provisioning_sync(<canvas base url>, <canvas api token>, <array of models to sync>, <optional term scope>)
+# config/initializers/canvas_sync.rb
+def canvas_sync_client
+  Bearcat::Client.new(token: current_organization.settings[:api_token], prefix: current_organization.settings[:base_url])
+end
+```
+
+(Having the client defined here means the sensitive API token doesn't have to be passed in plain text between jobs.)
+
+Once that's done and you've used the generator to create your models and migrations you can run the standard provisioning sync:
+
+```ruby
+CanvasSync.provisioning_sync(<array of models to sync>, <optional term scope>)
 ```
 
 Example:
 
 ```ruby
-CanvasSync.provisioning_sync("https://pseng.instructure.com", "12345", ['users', 'courses'], :active)
+CanvasSync.provisioning_sync(['users', 'courses'], :active)
 ```
 
 This will kick off a string of jobs to sync your specified models.
@@ -76,14 +87,12 @@ end
 
 You must implement a job that will enqueue a report starter for your report. (TODO: would be nice to make some sort of builder for this, so you just define the report and its params and then the gem runs it in a pre-defined job.)
 
-Let's say we have a custom Canvas report called "my_really_cool_report_csv". First, we would need to create a job class that will enqueue a report starter. To work with the `CanvasSync` interface, your class must accept 4 parameters: `canvas_base_url`, `canvas_api_token`, `job_chain`, and `options`.
+Let's say we have a custom Canvas report called "my_really_cool_report_csv". First, we would need to create a job class that will enqueue a report starter. To work with the `CanvasSync` interface, your class must accept 2 parameters: `job_chain`, and `options`.
 
 ```ruby
 class MyReallyCoolReportJob < CanvasSync::Jobs::ReportStarter
-  def perform(canvas_base_url, canvas_api_token, job_chain, options)
+  def perform(job_chain, options)
     super(
-      canvas_base_url,
-      canvas_api_token,
       job_chain,
       'my_really_cool_report_csv', # Report name
       { "parameters[param1]" => true }, # Report parameters
@@ -121,7 +130,7 @@ job_chain = {
   options: {}
 }
 
-CanvasSync.process_jobs("https://pseng.instructure.com", "my-api-token", job_chain)
+CanvasSync.process_jobs(job_chain)
 ```
 
 What if you've got some other job that you want run that doesn't deal with a report? No problem! Just make sure you call `CanvasSync.invoke_next` at the end of your job. Example:
@@ -129,10 +138,10 @@ What if you've got some other job that you want run that doesn't deal with a rep
 
 ```
 class SomeRandomJob < CanvasSync::Jobs::ApplicationJob
-  def perform(canvas_base_url, canvas_api_token, job_chain, options)
+  def perform(job_chain, options)
     i_dunno_do_something!
 
-    CanvasSync.invoke_next(canvas_base_url, canvas_api_token, job_chain)
+    CanvasSync.invoke_next(job_chain)
   end
 end
 
@@ -144,7 +153,7 @@ job_chain = {
   options: {}
 }
 
-CanvasSync.process_jobs("https://pseng.instructure.com", "my-api-token", job_chain)
+CanvasSync.process_jobs(job_chain)
 ```
 
 ### Batching

data/lib/canvas_sync.rb

@@ -21,36 +21,30 @@ module CanvasSync
   # and have also specified a Term scope, Users will by synced first, before
   # every other model (as Users are never scoped to Term).
   #
-  # @param canvas_base_url [String] e.g., "https://pseng.instructure.com"
-  # @param canvas_api_token [String] A Canvas API token for the specified Canvas instance
   # @param models [Array<String>] A list of models to sync. e.g., ['users', 'courses'].
   #   must be one of SUPPORTED_MODELS
   # @param term_scope [Symbol, nil] An optional symbol representing a scope that exists on the Term model.
   #   The provisioning report will be run for each of the terms contained in that scope.
-  def self.provisioning_sync(canvas_base_url, canvas_api_token, models, term_scope=nil)
+  def self.provisioning_sync(models, term_scope=nil)
     validate_models!(models)
-    invoke_next(canvas_base_url, canvas_api_token, default_provisioning_report_chain(models, term_scope))
+    invoke_next(default_provisioning_report_chain(models, term_scope))
   end
 
   # Runs a chain of ordered jobs
   #
   # See the README for usage and examples
   #
-  # @param canvas_base_url [String]
-  # @param canvas_api_token [String]
   # @param job_chain [Hash]
-  def self.process_jobs(canvas_base_url, canvas_api_token, job_chain)
-    invoke_next(canvas_base_url, canvas_api_token, job_chain)
+  def self.process_jobs(job_chain)
+    invoke_next(job_chain)
   end
 
   # Invokes the next job in a chain of jobs.
   #
   # This should typically be called automatically by the gem where necessary.
   #
-  # @param canvas_base_url [String] e.g., "https://pseng.instructure.com"
-  # @param canvas_api_token [String] A Canvas API token for the specified Canvas instance
   # @param job_chain [Hash] A chain of jobs to execute
-  def self.invoke_next(canvas_base_url, canvas_api_token, job_chain)
+  def self.invoke_next(job_chain)
     return if job_chain[:jobs].empty?
 
     # Make sure all job classes are serialized as strings
@@ -60,7 +54,7 @@ module CanvasSync
     jobs = duped_job_chain[:jobs]
     next_job = jobs.shift
     next_job_class = next_job[:job].constantize
-    next_job_class.perform_later(canvas_base_url, canvas_api_token, duped_job_chain, next_job[:options])
+    next_job_class.perform_later(duped_job_chain, next_job[:options])
   end
 
   # Syncs terms, users if necessary, then the rest of the specified models.

data/lib/canvas_sync/jobs/application_job.rb

@@ -5,15 +5,6 @@ module CanvasSync
     # Inherit from this class to build a Job that integrates
     # well with this gem.
     class ApplicationJob < ActiveJob::Base
-      # Generates a Bearcat::Client used for Canvas API calls
-      #
-      # @param canvas_base_url [String]
-      # @param canvas_api_token [String]
-      # @return [Bearcat::Client]
-      def canvas_client(canvas_base_url, canvas_api_token)
-        Bearcat::Client.new(token: canvas_api_token, prefix: canvas_base_url)
-      end
-
       # Returns the amount of time to wait between report status checks
       #
       # @return [Integer]

data/lib/canvas_sync/jobs/report_checker.rb

@@ -4,22 +4,18 @@ module CanvasSync
     # Re-enqueues itself if the report is still processing on Canvas.
     # Enqueues the ReportProcessor when the report has completed.
     class ReportChecker < ApplicationJob
-      # @param canvas_base_url [String]
-      # @param canvas_api_token [String]
       # @param job_chain [Hash]
       # @param report_name [Hash] e.g., 'provisioning_csv'
       # @param report_id [Integer]
       # @param processor [String] a stringified report processor class name
       # @param options [Hash] hash of options that will be passed to the job processor
       # @return [nil]
-      def perform(canvas_base_url, canvas_api_token, job_chain, report_name, report_id, processor, options)
-        report_status = canvas_client(canvas_base_url, canvas_api_token).report_status('self', report_name, report_id)
+      def perform(job_chain, report_name, report_id, processor, options)
+        report_status = canvas_sync_client.report_status('self', report_name, report_id)
 
         case report_status['status'].downcase
           when 'complete'
             CanvasSync::Jobs::ReportProcessorJob.perform_later(
-              canvas_base_url,
-              canvas_api_token,
               job_chain,
               report_name,
               report_status['attachment']['url'],
@@ -33,8 +29,6 @@ module CanvasSync
           else
             CanvasSync::Jobs::ReportChecker.set(wait: report_checker_wait_time)
               .perform_later(
-                canvas_base_url,
-                canvas_api_token,
                 job_chain,
                 report_name,
                 report_id,

data/lib/canvas_sync/jobs/report_processor_job.rb

@@ -6,20 +6,18 @@ module CanvasSync
     # download the report, and then pass the file path and options into the
     # process method on the processor.
     class ReportProcessorJob < ApplicationJob
-      # @param canvas_base_url [String]
-      # @param canvas_api_token [String]
       # @param job_chain [Hash]
       # @param report_name [Hash] e.g., 'provisioning_csv'
       # @param report_url [String]
       # @param processor [String] a stringified report processor class name
       # @param options [Hash] hash of options that will be passed to the job processor
       # @return [nil]
-      def perform(canvas_base_url, canvas_api_token, job_chain, report_name, report_url, processor, options)
+      def perform(job_chain, report_name, report_url, processor, options)
         download(report_name, report_url) do |file_path|
           processor.constantize.process(file_path, options)
         end
 
-        CanvasSync.invoke_next(canvas_base_url, canvas_api_token, job_chain)
+        CanvasSync.invoke_next(job_chain)
       end
 
       private

data/lib/canvas_sync/jobs/report_starter.rb

@@ -2,21 +2,16 @@ module CanvasSync
   module Jobs
     # Starts a Canvas report and enqueues a ReportChecker
     class ReportStarter < ApplicationJob
-      # @param canvas_base_url [String]
-      # @param canvas_api_token [String]
       # @param job_chain [Hash]
       # @param report_name [Hash] e.g., 'provisioning_csv'
       # @param report_params [Hash] The Canvas report parameters
       # @param processor [String] a stringified report processor class name
       # @param options [Hash] hash of options that will be passed to the job processor
       # @return [nil]
-      def perform(canvas_base_url, canvas_api_token, job_chain, report_name, report_params, processor, options)
-        client = canvas_client(canvas_base_url, canvas_api_token)
-        report = client.start_report('self', report_name, report_params)
+      def perform(job_chain, report_name, report_params, processor, options)
+        report = canvas_sync_client.start_report('self', report_name, report_params)
 
         CanvasSync::Jobs::ReportChecker.set(wait: report_checker_wait_time).perform_later(
-          canvas_base_url,
-          canvas_api_token,
           job_chain,
           report_name,
           report['id'],

data/lib/canvas_sync/jobs/sync_provisioning_report_job.rb

@@ -2,15 +2,11 @@ module CanvasSync
   module Jobs
     # ActiveJob class that starts a Canvas provisioning report
     class SyncProvisioningReportJob < ApplicationJob
-      # @param canvas_base_url [String]
-      # @param canvas_api_token [String]
       # @param job_chain [Hash]
       # @param options [Hash] If options contains a :term_scope a seperate provisioning report
       #   will be started for each term in that scope. :models should be an array of
       #   models to sync.
-      def perform(canvas_base_url, canvas_api_token, job_chain, options)
-        @canvas_base_url = canvas_base_url
-        @canvas_api_token = canvas_api_token
+      def perform(job_chain, options)
         @job_chain = job_chain
 
         if options[:term_scope]
@@ -30,8 +26,6 @@ module CanvasSync
 
       def start_report(report_params, options)
         CanvasSync::Jobs::ReportStarter.perform_later(
-          @canvas_base_url,
-          @canvas_api_token,
           @job_chain,
           'proservices_provisioning_csv',
           report_params,

data/lib/canvas_sync/jobs/sync_terms_job.rb

@@ -5,18 +5,14 @@ module CanvasSync
       #
       # Terms are pre-synced so that provisioning reports can be scoped to term.
       #
-      # @param canvas_base_url [String]
-      # @param canvas_api_token [String]
       # @param job_chain [Hash]
       # @param options [Hash]
-      def perform(canvas_base_url, canvas_api_token, job_chain, options)
-        client = canvas_client(canvas_base_url, canvas_api_token)
-
-        client.terms('self').all_pages!.each do |term_params|
+      def perform(job_chain, options)
+        canvas_sync_client.terms('self').all_pages!.each do |term_params|
           Term.create_or_update(term_params)
         end
 
-        CanvasSync.invoke_next(canvas_base_url, canvas_api_token, job_chain)
+        CanvasSync.invoke_next(job_chain)
       end
     end
   end

data/lib/canvas_sync/jobs/sync_users_job.rb

@@ -12,14 +12,10 @@ module CanvasSync
       # running provisioning by term we sync users first so we don't duplicate
       # the work of syncing all users for each term.
       #
-      # @param canvas_base_url [String]
-      # @param canvas_api_token [String]
       # @param job_chain [Hash]
       # @param options [Hash]
-      def perform(canvas_base_url, canvas_api_token, job_chain, options)
+      def perform(job_chain, options)
         super(
-          canvas_base_url,
-          canvas_api_token,
           job_chain,
           'proservices_provisioning_csv',
           REPORT_PARAMS,

data/lib/canvas_sync/version.rb

@@ -1,3 +1,3 @@
 module CanvasSync
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/canvas_sync/canvas_sync_spec.rb

@@ -2,28 +2,23 @@ require 'spec_helper'
 
 RSpec.describe CanvasSync do
   describe '.provisioning_sync' do
-    let(:canvas_base_url) { 'https://test.instructure.com' }
-    let(:canvas_api_token) { 'cool-api-token' }
-
     it 'invokes the first job in the queue and passes on the rest of the job chain' do
       expected_job_chain = CanvasSync.default_provisioning_report_chain(['courses'], nil)
       first_job = expected_job_chain[:jobs].shift
 
       expect(CanvasSync::Jobs::SyncTermsJob).to receive(:perform_later)
         .with(
-          canvas_base_url,
-          canvas_api_token,
           expected_job_chain,
           first_job[:options]
         )
 
-      CanvasSync.provisioning_sync(canvas_base_url, canvas_api_token, ['courses'])
+      CanvasSync.provisioning_sync(['courses'])
     end
 
     context 'an invalid model is passed in' do
       it 'raises a helpful exception' do
         expect {
-          CanvasSync.provisioning_sync(canvas_base_url, canvas_api_token, ['courses', 'cheeses'])
+          CanvasSync.provisioning_sync(['courses', 'cheeses'])
         }.to raise_error("Invalid model(s) specified: cheeses. Only #{CanvasSync::SUPPORTED_MODELS.join(', ')} are supported.")
       end
     end

data/spec/canvas_sync/jobs/report_checker_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 
 RSpec.describe CanvasSync::Jobs::ReportChecker do
-  let(:canvas_base_url) { 'https://test.instructure.com' }
-  let(:canvas_api_token) { 'cool-api-token' }
   let(:client_double) { double('client') }
   let(:report_id) { 1 }
   let(:report_name) { 'provisioning_csv' }
@@ -11,8 +9,6 @@ RSpec.describe CanvasSync::Jobs::ReportChecker do
   describe '#perform' do
     def start_job
       CanvasSync::Jobs::ReportChecker.perform_now(
-        canvas_base_url,
-        canvas_api_token,
         [],
         'provisioning_csv',
         report_id,
@@ -28,7 +24,7 @@ RSpec.describe CanvasSync::Jobs::ReportChecker do
           .and_return({ 'status' => 'complete', 'attachment' => { 'url' => 'blah' } })
 
         expect(CanvasSync::Jobs::ReportProcessorJob).to receive(:perform_later)
-          .with(canvas_base_url, canvas_api_token, [], report_name, 'blah', processor, {})
+          .with([], report_name, 'blah', processor, {})
 
         start_job
       end

data/spec/canvas_sync/jobs/report_processor_job_spec.rb

@@ -3,8 +3,6 @@ require 'spec_helper'
 class FakeProcessor; end;
 
 RSpec.describe CanvasSync::Jobs::ReportProcessorJob do
-  let(:canvas_base_url) { 'https://test.instructure.com' }
-  let(:canvas_api_token) { 'cool-api-token' }
   let(:report_name) { 'provisioning_csv' }
   let(:report_url) { 'https://test.instructure.com/sample_report_download' }
   let(:processor) { FakeProcessor.to_s }
@@ -14,11 +12,9 @@ RSpec.describe CanvasSync::Jobs::ReportProcessorJob do
     it 'downloads the report to a file and then calls the process method on the processor, and then invokes the next job' do
       expect(IO).to receive(:copy_stream)
       expect(FakeProcessor).to receive(:process)
-      expect(CanvasSync).to receive(:invoke_next).with(canvas_base_url, canvas_api_token, job_chain)
+      expect(CanvasSync).to receive(:invoke_next).with(job_chain)
 
       CanvasSync::Jobs::ReportProcessorJob.perform_now(
-        canvas_base_url,
-        canvas_api_token,
         job_chain,
         report_name,
         report_url,

data/spec/canvas_sync/jobs/report_starter_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 
 RSpec.describe CanvasSync::Jobs::ReportStarter do
-  let(:canvas_base_url) { 'https://test.instructure.com' }
-  let(:canvas_api_token) { 'cool-api-token' }
   let(:report_params) { { 'parameters[users]' => true } }
   let(:report_name) { 'provisioning_csv' }
   let(:processor) { 'CoolProcessor' }
@@ -15,8 +13,7 @@ RSpec.describe CanvasSync::Jobs::ReportStarter do
 
       expect(CanvasSync::Jobs::ReportChecker).to receive(:set).and_call_original
 
-      CanvasSync::Jobs::ReportStarter.perform_now(canvas_base_url,
-                                canvas_api_token,
+      CanvasSync::Jobs::ReportStarter.perform_now(
                                 [],
                                 report_name,
                                 report_params,

data/spec/canvas_sync/jobs/sync_provisioning_report_job_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
 RSpec.describe CanvasSync::Jobs::SyncProvisioningReportJob do
-  let(:canvas_base_url) { 'https://test.instructure.com' }
-  let(:canvas_api_token) { 'cool-api-token' }
-
   describe '#perform' do
     context 'a term scope is specified' do
       let!(:active_term_1) { FactoryGirl.create(:term) }
@@ -13,8 +10,6 @@ RSpec.describe CanvasSync::Jobs::SyncProvisioningReportJob do
       it 'enqueues a ReportStarter for a provisioning report for the specified models for each term' do
         expect(CanvasSync::Jobs::ReportStarter).to receive(:perform_later)
           .with(
-            canvas_base_url,
-            canvas_api_token,
             [],
             'proservices_provisioning_csv',
             {
@@ -29,8 +24,6 @@ RSpec.describe CanvasSync::Jobs::SyncProvisioningReportJob do
 
         expect(CanvasSync::Jobs::ReportStarter).to receive(:perform_later)
           .with(
-            canvas_base_url,
-            canvas_api_token,
             [],
             'proservices_provisioning_csv',
             {
@@ -44,8 +37,6 @@ RSpec.describe CanvasSync::Jobs::SyncProvisioningReportJob do
           )
 
         CanvasSync::Jobs::SyncProvisioningReportJob.perform_now(
-          canvas_base_url,
-          canvas_api_token,
           [],
           { models: ['users', 'courses'], term_scope: 'active' }
         )
@@ -56,8 +47,6 @@ RSpec.describe CanvasSync::Jobs::SyncProvisioningReportJob do
       it 'enqueues a single ReportStarter for a provisioning report across all terms for the specified models' do
         expect(CanvasSync::Jobs::ReportStarter).to receive(:perform_later)
           .with(
-            canvas_base_url,
-            canvas_api_token,
             [],
             'proservices_provisioning_csv',
             {
@@ -70,8 +59,6 @@ RSpec.describe CanvasSync::Jobs::SyncProvisioningReportJob do
           )
 
         CanvasSync::Jobs::SyncProvisioningReportJob.perform_now(
-          canvas_base_url,
-          canvas_api_token,
           [],
           { models: ['users', 'courses'] }
         )