canvas_faker 1.0.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at justinball@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in canvas_faker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016-2017 Atomic Jolt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# CanvasFaker
+
+This gem generates courses, students and other data for an Instructure Canvas instance which
+will help save time if you need to test
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'canvas_faker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install canvas_faker
+
+Rename .env.example to .env and provide a Canvas URL and an API Token
+
+
+## Usage
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version,
+update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git
+tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/atomicjolt/canvas_faker.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+load "./lib/tasks/canvas_faker.rake"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "canvas_faker"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/canvas_faker.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "canvas_faker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "canvas_faker"
+  spec.version       = CanvasFaker::VERSION
+  spec.authors       = ["Justin Ball", "Benjamin Call"]
+  spec.email         = ["justin.ball@atomicjolt.com"]
+
+  spec.summary       = "Utility for setting up courses and users in Instructure Canvas."
+  spec.description   = "Atomic Jolt found that we frequently needed to setup courses with " \
+                       "users to test. This gem handles that requirement."
+  spec.homepage      = "https://github.com/atomicjolt/canvas_faker"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "lms-api"
+  spec.add_dependency "highline"
+  spec.add_dependency "faker"
+  spec.add_dependency "dotenv"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 8.2", ">= 8.2.4"
+
+end

data/lib/canvas_faker.rb

@@ -0,0 +1,6 @@
+require "canvas_faker/version"
+
+module CanvasFaker
+end
+
+require "canvas_faker/functionality"

data/lib/canvas_faker/functionality.rb

@@ -0,0 +1,220 @@
+require "highline"
+require "lms_api"
+require "faker"
+require "byebug"
+
+module CanvasFaker
+
+  class Functionality
+
+    def initialize(canvas_url, token, tools = [])
+      @api = LMS::Canvas.new(canvas_url, token)
+      @canvas_url = canvas_url
+      @tools = tools
+      @cli ||= HighLine.new
+    end
+
+    def setup_course
+      account_id = get_account_id
+      courses = course_list(account_id)
+      course_id = create_course(account_id, courses)["id"]
+      students = create_users(account_id)
+      enroll_user_in_course(students, course_id)
+      make_assignments_in_course(course_id)
+      install_lti_tool_to_course(course_id)
+    end
+
+    def add_students_to_course(account_id, course_id)
+      students = create_users(account_id)
+      enroll_user_in_course(students, course_id)
+    end
+
+    def delete_course
+      account_id = get_account_id
+      courses = course_list(account_id)
+      course = @cli.ask("Delete which course? ex.. 2", Integer)
+      @api.proxy(
+        "CONCLUDE_COURSE",
+        { id: courses[course]["id"],
+          event: "delete"
+        }
+      )
+      puts "Deleted #{courses[course]['name']}"
+    end
+
+    def get_quizzes(course_id)
+      a = @api.proxy(
+        "LIST_QUIZZES_IN_COURSE",
+        { course_id: course_id }
+      )
+      puts "QUIZ::: #{a}"
+    end
+
+    def delete_course_by_id(course_id)
+      @api.proxy(
+        "CONCLUDE_COURSE",
+        { id: course_id,
+          event: "delete"
+        }
+      )
+      puts "Deleted course with id: #{course_id}"
+    end
+
+    def make_assignments_in_course(course_id)
+      num_of_assignments = @cli.ask("How many assignments?", Integer)
+      create_assignments_in_course(course_id, num_of_assignments)
+    end
+
+    private
+
+    def create_assignments_in_course(course_id, num_of_assignments)
+      (1..num_of_assignments).map do
+        food = Faker::Pokemon.name
+        payload = {
+          assignment: {
+            name: "All about #{food}",
+            published: true
+          }
+        }
+        @api.proxy(
+          "CREATE_ASSIGNMENT",
+          { course_id: course_id },
+          payload
+        ).tap { |assignment| puts "Creating #{assignment['name']} in your course." }
+      end
+      puts "Added #{num_of_assignments} assignments to your course"
+    end
+
+    def course_list(account_id)
+      courses = @api.proxy(
+        "LIST_ACTIVE_COURSES_IN_ACCOUNT",
+        { account_id: account_id }
+      )
+      courses.each_with_index do |course, index|
+        puts "#{index}. #{course['name']}, id: (#{course['id']})"
+      end
+      courses
+    end
+
+    def get_account_id
+      accounts = @api.all_accounts # gets the accounts
+      accounts.each_with_index do |account, index|
+        puts "#{index}. #{account['name']}"
+      end
+      answer = @cli.ask("Which account? ex.. 2", Integer)
+      accounts[answer]["id"]
+    end
+
+    # Returns true or false
+    def should_create_course?(existing_course_names, course_name)
+      if existing_course_names.include?(course_name)
+        use_old_course = @cli.ask "That course already exists, want to use it? [y/n]"
+        if use_old_course == "y" || use_old_course == "yes"
+          return false
+        end
+        return true
+      end
+      return true
+    end
+
+    def create_course(account_id, courses)
+      existing_course_names = courses.map { |course| course["name"] }
+      course_name = @cli.ask "Name your new course."
+      if should_create_course?(existing_course_names, course_name)
+        payload = {
+          course: {
+            name: course_name,
+            # sis_course_id: course_id,
+          }
+        }
+        course = @api.proxy(
+          "CREATE_NEW_COURSE",
+          { account_id: account_id },
+          payload
+        )
+        puts "#{@canvas_url}/courses/#{course['id']}"
+        course
+      else
+        index = existing_course_names.find_index("#{course_name}")
+        courses[index]
+      end
+    end
+
+    def create_users(account_id)
+      num_students = @cli.ask(
+        "How many students do you want in your course?",
+        Integer
+      )
+      (1..num_students).map do
+        user_first_name = Faker::Name.first_name
+        user_last_name = Faker::Name.last_name
+        full_name = "#{user_first_name}#{user_last_name}"
+        email = Faker::Internet.safe_email(full_name)
+        payload = {
+          user: {
+            name: "#{user_first_name} #{user_last_name}",
+            short_name: user_first_name,
+            sortable_name: "#{user_last_name}, #{user_first_name}",
+            terms_of_use: true,
+            skip_registration: true,
+            avatar: {
+              url: Faker::Avatar.image
+            }
+          },
+          pseudonym: {
+            unique_id: "#{email}",
+            password: "asdfasdf"
+          }
+        }
+        @api.proxy(
+          "CREATE_USER",
+          { account_id: account_id },
+          payload
+        ).tap { |stud| puts "#{stud['name']} creating." }
+      end
+    end
+
+    def enroll_user_in_course(students, course_id)
+      students.each do |student|
+        payload = {
+          enrollment: {
+            user_id: student["id"],
+            type: "StudentEnrollment",
+            enrollment_state: "active"
+          }
+        }
+        @api.proxy(
+          "ENROLL_USER_COURSES",
+          { course_id: course_id },
+          payload
+        )
+        puts "Enrolled #{student['name']} into your course_id #{course_id}"
+      end
+    end
+
+    def install_lti_tool_to_course(course_id)
+      return if @tools.empty?
+      # Taken from canvas documentation, below.
+      # https://canvas.instructure.com/doc/api/external_tools.html
+      @tools.each_with_index do |tool, index|
+        puts "#{index}. #{tool[:app][:lti_key]}"
+      end
+      tool_index =
+        @cli.ask("Which tool do you want to add to your course?", Integer)
+      tool = tools[tool_index]
+      payload = {
+        name: "#{tool[:app][:lti_key]}",
+        privacy_level: "public",
+        consumer_key: "#{tool[:app][:lti_key]}",
+        shared_secret: "#{tool[:app][:lti_secret]}",
+        config_type: "by_xml",
+        config_xml: "#{tool[:config]}"
+      }
+      @api.proxy(
+        "CREATE_EXTERNAL_TOOL_COURSES",
+        { course_id: course_id },
+        payload
+      )
+    end
+  end
+end