canvas-blueprint-tool 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b13c57b4437490890ed32335bc4d81a94c7f58e918261142c39381fde0138129
+  data.tar.gz: 6122505cc43913e8b9eb1f63e2c96bc2025b87e423ac92f244a6ebd46631ba1a
+SHA512:
+  metadata.gz: 873a646c543c73520d0d1d43c7562d385bae15e559c960a4eda03c8da6e8b8c5d0263dd573756baf87cd82b036790022533e3d114b5bd96fda1cb418f1c5f45b
+  data.tar.gz: f043a8b3e8af8bc86ed98fae7146443768a67a4b339591e525fde3d6f27701dc9000d1437a5fd41fc56e5c903b6ac0e2a4a0c750cc2b54299f31579bf2d9acea

data/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to Learn.co Curriculum
+
+We're really excited that you're about to contribute to the
+[open curriculum](https://learn.co/content-license) on
+[Learn.co](https://learn.co). If this is your first time contributing, please
+continue reading to learn how to make the most meaningful and useful impact
+possible.
+
+## Raising an Issue to Encourage a Contribution
+
+If you notice a problem with the curriculum that you believe needs improvement
+, but you're unable to make the change yourself, you should raise a Github issue
+containing a clear description of the problem. Include relevant snippets of the
+content and screenshots if applicable. Curriculum owners regularly review
+issue lists, and your issue will be prioritized and addressed as appropriate.
+
+## Submitting a Pull Request to Suggest an Improvement
+
+If you see an opportunity for improvement and can make the change yourself go
+ahead and use a typical git workflow to make it happen:
+
+* Fork this curriculum repository
+* Make the change on your fork, with descriptive commits in the standard format
+* Open a Pull Request against this repo
+
+A curriculum owner will review your change and approve or comment on it in due
+course.
+
+## Why Contribute?
+
+Curriculum on Learn is publicly and freely available under Learn's
+[Educational Content License](https://learn.co/content-license). By embracing an
+open-source contribution model, our goal is for the curriculum on Learn to
+become, in time, the best educational content the world has ever seen.
+
+We need help from the community of Learners to maintain and improve the
+educational content. Everything from fixing typos, to correcting out-dated
+information, to improving exposition, to adding better examples, to fixing
+tests—all contributions to making the curriculum more effective are welcome.

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+ruby "2.6.1"
+
+gem 'require_all'
+gem 'json'
+gem 'rest-client'

data/LICENSE.md

@@ -0,0 +1,24 @@
+# Learn.co Educational Content License
+
+Copyright (c) 2020 Flatiron School, Inc
+
+The Flatiron School, Inc. owns this Educational Content. However, the Flatiron
+School supports the development and availability of educational materials in the
+public domain. Therefore, the Flatiron School grants Users of the Flatiron
+Educational Content set forth in this repository certain rights to reuse, build
+upon and share such Educational Content subject to the terms of the Educational
+Content License set forth
+[here](http://learn.co/content-license)(http://learn.co/content-license). You
+must read carefully the terms and conditions contained in the Educational
+Content License as such terms govern access to and use of the Educational
+Content.
+
+Flatiron School is willing to allow you access to and use of the Educational
+Content only on the condition that you accept all of the terms and conditions
+contained in the Educational Content License set forth
+[here](http://learn.co/content-license) (http://learn.co/content-license).  By
+accessing and/or using the Educational Content, you are agreeing to all of the
+terms and conditions contained in the Educational Content License.  If you do
+not agree to any or all of the terms of the Educational Content License, you are
+prohibited from accessing, reviewing or using in any way the Educational
+Content.

data/README.md

@@ -0,0 +1,6 @@
+# Canvas Blueprint Tool
+
+## Description
+
+The Canvas Blueprint Tool is a Ruby gem wrapper for specific Canvas LMS API endpoints. Using this gem,
+a Canvas acourse can be associated with a blueprint course via the command-line. Canvas courses can also be published using this gem.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/canvas-blueprint-tool

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'canvas-blueprint-tool'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = <<-EOBANNER
+    Canvas Blueprint Tool
+    ====================
+
+    canvas-blueprint-tool --associate --course <course_id> --blueprint <blueprint_id>
+    canvas-blueprint-tool --create-and-associate --blueprint <blueprint_id>
+    canvas-blueprint-tool --sync-courses --blueprint <course_id>
+    canvas-blueprint-tool --sync-courses --blueprint <course_id> --publish-newly-associated
+
+  EOBANNER
+
+  opts.on("-v", "--version", 
+          "Output the gem version") do |version| 
+            options[:version] = true
+          end
+  opts.on("-a", "--associate", 
+          "Associate a course with a blueprint. Requires --course and --blueprint flags") do |associate| 
+            options[:associate] = true
+          end
+  opts.on("-s", "--sync-courses", 
+          "Sync a blueprint course and its associated courses. Requires --blueprint flag") do |publish| 
+            options[:sync] = true
+          end
+  opts.on("-p", "--publish-newly-associated", 
+          "Used with -s. Publishes any courses newly associated with a blueprintt. Requires --sync-courses and --blueprint flag") do |publish| 
+            options[:publish_newly_associated] = true
+          end
+  opts.on("--create-and-associate", 
+          "Creates a new course and associates it with the provided blueprint. Requires --blueprint flag") do |create_and_associate| 
+            options[:create_and_associate] = true
+          end
+  opts.on("-cCOURSE", "--course COURSE", 
+          "Provide a course ID. Used for associating and publishing") do |course_id| 
+            options[:course_id] = course_id
+          end
+  opts.on("-bCOURSE", "--blueprint COURSE", 
+          "Provide a blueprint course ID. Used for associating a course to a blueprint") do |blueprint_id| 
+            options[:blueprint_id] = blueprint_id
+          end
+  
+
+end.parse!
+
+if options[:version]
+  CanvasBlueprintTool.new(mode: 'version')
+  abort
+end
+
+if options[:associate]
+  if !options[:course_id] || !options[:blueprint_id]
+    raise Exception.new "Associate option requires course and blueprint IDs using the --course and --blueprint flags"
+    abort
+  end
+  CanvasBlueprintTool.new(mode: 'associate',  
+                          course_id: options[:course_id], 
+                          blueprint_id: options[:blueprint_id])
+  abort
+end
+
+if options[:sync]
+  if !options[:blueprint_id]
+    raise Exception.new "Sync option requires a blueprint course ID using the --blueprint flag"
+    abort
+  end
+  CanvasBlueprintTool.new(mode: 'sync',  
+                          blueprint_id: options[:blueprint_id], 
+                          publish_newly_associated: !!options[:publish_newly_associated]
+                          )
+  abort
+end

data/lib/canvas-blueprint-tool.rb

@@ -0,0 +1,17 @@
+require_relative './canvas-blueprint-tool/canvas_interface'
+
+class CanvasBlueprintTool
+
+  def initialize(options)
+    case options[:mode]
+    when 'version'
+      puts VERSION
+    when 'associate'
+      CanvasInterface.associate(options)
+    when 'sync'
+      CanvasInterface.sync(options)
+    else
+      puts VERSION
+    end
+  end
+end

data/lib/canvas-blueprint-tool/canvas_interface.rb

@@ -0,0 +1,42 @@
+require 'rest-client'
+require 'json'
+
+class CanvasInterface
+
+  def self.associate(options)
+    url = "#{ENV['CANVAS_API_PATH']}/courses/#{options[:blueprint_id]}/blueprint_templates/default/update_associations"
+    payload = {
+      'course_ids_to_add' => options[:course_id]
+    }
+    response = RestClient.put(url, payload, self.headers)
+    response = JSON.parse(response)
+    if response["success"]
+      puts "Success: Course #{options[:course_id]} newly associated or was already associated with blueprint course #{options[:blueprint_id]}"
+    else
+      puts "Something went wrong while trying to associate course #{options[:course_id]} with blueprint course #{options[:blueprint_id]}"
+    end
+  end
+
+  def self.sync(options)
+    
+    url = "#{ENV['CANVAS_API_PATH']}/courses/#{options[:blueprint_id]}/blueprint_templates/default/migrations"
+    payload = {
+      'comment' => "Automatic association using canvas-blueprint-tool gem",
+      'send_notification' => true,
+      'publish_after_initial_sync' => options[:publish_newly_associated]
+    }
+    response = RestClient.post(url, payload, self.headers)
+    response = JSON.parse(response)
+    if response["workflow_state"] == "queued"
+      puts "Syncing courses from blueprint course #{options[:blueprint_id]}"
+    else
+      puts "Something may have gone wrong syncing courses from blueprint course #{options[:blueprint_id]}"
+    end
+  end
+  
+  def self.headers
+    {
+      "Authorization" => "Bearer #{ENV['CANVAS_API_KEY']}"
+    }
+  end
+end

data/lib/canvas-blueprint-tool/version.rb

@@ -0,0 +1,3 @@
+class CanvasBlueprintTool
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: canvas-blueprint-tool
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- maxwellbenton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description:
+email: curriculum@flatironschool.com
+executables:
+- canvas-blueprint-tool
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/canvas-blueprint-tool
+- lib/canvas-blueprint-tool.rb
+- lib/canvas-blueprint-tool/canvas_interface.rb
+- lib/canvas-blueprint-tool/version.rb
+homepage: https://github.com/learn-co-curriculum/canvas-blueprint-tool
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: canvas-blueprint-tool is a tool for associating and publishing courses on
+  the Canvas LMS
+test_files: []