canvas-tools 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3941f3a71b4ae2ecd1d8803d6f08269f7da80c75
+  data.tar.gz: c57360b4557adca9bb2fe05417cc592ea9dd5c0e
+SHA512:
+  metadata.gz: 0c0ab6b9df77b1608dec5878790b8a1a3bc227cf3bea9cfcd40f5befc22d401c09d515f877d86e641e985e0db5b9ce7546e059f2b0760bfeac8dd7abad21d2c9
+  data.tar.gz: 187f5d479ce1b2967af5a757000c6f2bb1bd202cb1b08fa6bbdcf446dac5893e0d8a1dbcc2045492b80bb0506d2d3014a6594690fc6307f1395fe7d6d4cc18a8

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/canvas-tools.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name          = 'canvas-tools'
+  s.version       = '0.0.1'
+  s.date          = '2016-09-26'
+  s.summary       = "Basic commmand line tools for canvas"
+  s.description   = ""
+  s.authors       = ["Dr. Ogg"]
+  s.email         = ["ogg@sr375.com"]
+  # s.files         = ["lib/canvas-tools.rb"]
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.homepage      = ''
+  s.license       = 'MIT'
+
+  s.add_dependency "bundler", "~> 1.12"
+  s.add_dependency "rake", "~> 10.0"
+  s.add_dependency 'console_table', '~> 0.2.4'
+
+
+end

data/exe/canvas-addusers.rb

@@ -0,0 +1,180 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'getoptlong'
+require 'colorize'
+require 'json'
+require 'fileutils'
+require 'rest-client'
+require 'csv'
+require 'console_table'
+
+
+@config_file = "#{ENV["HOME"]}/.canvas-tools.json"
+@active_config = ""
+@file = ""
+
+def generate_example_config
+  example_config = {
+    :learnistute => {
+      :url => "https://lms.someschool.org",
+      :token => "PLACE YOUR ADMIN TOKEN HERE.",
+      :account_id => 1
+    }
+  }
+  if !File.exists? @config_file
+    puts "Config file not found".colorize(:red)
+    puts "Generating example config: #{@config_file}".colorize(:yellow)
+    File.open(@config_file,"w") do |f|
+      f.write(JSON.pretty_generate(example_config))
+    end
+  end
+end
+
+def load_config
+  if File.exists? @config_file
+    puts "Found config file: #{@config_file}"
+    begin
+      @config = JSON.parse(File.read @config_file)
+    rescue
+      puts "I'm So Sorry, I can't open or read or find your config file (#{@config_file})".colorize(:red)
+      exit 1
+    end
+  end
+end
+
+def generate_example_csv
+  filename = "canvas-addusers-example.csv"
+  example_data = [
+    ["Name","e-mail","SIS_ID"],
+    ["Fake3 middle Student","Fake3@example.com","4043.6"],
+    ["Fake2 Student-dash","Fake2@example.com","4044.6"],
+    ["Fake1 Student","Fake1@example.com","4042.6"]
+  ]
+  if File.exists? filename
+    puts "I have already created an example, if you want to repeat this, try renameing the file".colorize(:red)
+  else
+    puts "Generating example csv: #{filename}".colorize(:yellow)
+    s = File.open(filename,"w")
+    csv = CSV.new(s, :force_quotes => true)
+    example_data.each do |row|
+      csv << row
+    end
+    s.close
+  end
+
+end
+
+def display_help
+	puts
+  puts "This tool is used to add users to your canvas install using an CSV file"
+  puts "Config File: #{@config_file.colorize(:blue)}"
+  puts
+	puts "Options:"
+	puts "-h or --help ".ljust(30) 		  	+"-> Display this help message"
+	puts "-c or --config".ljust(30) 		  +"-> Specifiy Config to use"
+	puts "-f or --file".ljust(30) 		    +"-> CSV File"
+	puts "-l or --list".ljust(30)         + "-> List Valid Configs"
+  puts "-g or --generate".ljust(30)     + "-> Generate an example csv file"
+	puts
+	exit 1
+end
+
+def parse_cli
+  if ARGV[0] == nil
+  	display_help
+  end
+
+  parser = GetoptLong.new
+  parser.set_options(["-h", "--help", GetoptLong::NO_ARGUMENT],
+                     ["-c", "--config", GetoptLong::NO_ARGUMENT],
+                     ["-f", "--fqdn", GetoptLong::NO_ARGUMENT],
+                     ["-l", "--list", GetoptLong::NO_ARGUMENT],
+                     ["-g", "--generate", GetoptLong::NO_ARGUMENT]
+
+                     )
+
+  begin
+    begin
+        opt,arg = parser.get_option
+        break if not opt
+        case opt
+           when "-h" || "--help"
+             display_help
+           exit
+           when "-c" || "--config"
+              @active_config = ARGV[0].strip().downcase()
+           when "-f" || "--file"
+              @file = ARGV[0].strip()
+           when "-l" || "--list"
+              list
+          when "-g" || "--generate"
+              generate_example_csv
+  	    end
+    rescue => err
+       puts "#{err.class()}: #{err.message}"
+       puts "this should never happen, Did'nt i warn you?".red.blink
+  	   display_help
+       exit
+    end
+  end while 1
+end
+
+def list
+  table_config = [
+     {:key=>:name, :size=>19, :title=>"Name"},
+     {:key=>:url, :size=>35, :title=>"URL"},
+     {:key=>:account_id, :size=>15, :title=>"Account ID"}
+  ]
+  ConsoleTable.define(table_config) do |table|
+      @config.each  do |r|
+        table << [
+          r[0].dup.colorize(:yellow),
+          r[1]["url"],
+          r[1]["account_id"]
+        ]
+      end
+  end
+end
+
+def create_user(sis_id,full_name,email)
+  # application/x-www-form-urlencoded
+  # POST /api/v1/accounts/:account_id/users
+  sel_config = @config[@active_config]
+  parms = {
+    "pseudonym[unique_id]" => email,
+    "pseudonym[force_self_registration]" => true,
+    "user[name]" => full_name,
+    "pseudonym[sis_user_id]" => sis_id,
+    "communication_channel[type]" => "email",
+    "communication_channel[address]" => email,
+    "pseudonym[send_confirmation]" => true,
+  }
+  begin
+    RestClient.post "#{sel_config["canvas"]["url"]}/api/v1/accounts/#{sel_config["canvas"]["account_id"]}/users?access_token=#{sel_config["canvas"]["token"]}", parms, :accept => :json
+  rescue RestClient::RequestFailed => e
+    puts "The request failed with HTTP status code #{e.response.code}"
+    puts "The body was:"
+    puts e.response.body
+    '{"id":0}'
+  end
+
+end
+
+def run_import
+  if @file.nil? or !File.file? @file
+    puts "Import file not found, please check your path".red
+  end
+  new_user_list = CSV.read(@file, headers:true)
+  new_user_list.each do |u|
+    puts "Adding #{u["Name"]}, #{u["e-mail"]}".blue
+    result = JSON.parse(create_user(u["SIS_ID"],u["Name"],u["e-mail"]))
+    puts "Canvas ID: #{result["id"]}".yellow
+  end
+end
+
+generate_example_config
+load_config
+parse_cli
+if @file != ""  && @active_config != ""
+  run_import
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: canvas-tools
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dr. Ogg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: console_table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+description: ''
+email:
+- ogg@sr375.com
+executables:
+- canvas-addusers.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- canvas-tools.gemspec
+- exe/canvas-addusers.rb
+- lib/canvas-tools.rb
+homepage: ''
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Basic commmand line tools for canvas
+test_files: []