japanda 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: abbd951e967108454451a2dead9d17e93c1c2ba7
-  data.tar.gz: a2c8ee97e2f6ac89b5374365008609639600026f
+SHA256:
+  metadata.gz: a8acb3a2a4f8a67997e25b5514be451f76dc2b6efaeb820b81d58384c773ef34
+  data.tar.gz: 82a46cfe03d449b9c308ce7606524a20c5e98712dea1d9bb67fb3e53786e8bd6
 SHA512:
-  metadata.gz: 7dcce860b5fede22513b30ff8fb051b249a797d8b0bb2e2b03ac53c0350d34abc7aa11f700ab7ade14414f568e07bbe13a1300e8d0b904af508cbba9b5536e5d
-  data.tar.gz: 6318804d2b3153d09bd9077d910be80e11e9b96644d498e3dd18e0aaf07b2d650e923ef5044c4b04e9f0e94ebb3d230f4f0325c0e604b285fedfeed2d789edcb
+  metadata.gz: 00e3b3e50ce617851288635346953a729df02fc76f5026b9eabbbdccf7710d0c667d15b25733070437eced81b8f36bff63aaf80708368331be3525bfd72aa7e2
+  data.tar.gz: 84e487cf7c6f2da50af89266551992ba869b5d119a63848eafcebbc3d63b671dd469e570d4be8a960129fbd2af819d321b2c0e97422233cff05002dfa58ceb4b

data/.env.example

@@ -0,0 +1,4 @@
+# canvas
+CANVAS_API_HOST=<your canvas host>
+CANVAS_API_TOKEN=<your canvas token>
+CANVAS_ACCOUNT_ID=<your canvas account id>

data/.gitignore

@@ -1,10 +1,10 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
-/.env/
+.env
 /tmp/
+*.iml

data/.rspec

@@ -1,2 +1,4 @@
+--format RspecJunitFormatter
+--out junit/rspec.xml
 --format documentation
 --color

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM instructure/ruby:2.5
+
+ENV APP_HOME /usr/src/app
+
+COPY --chown=docker:docker . $APP_HOME
+
+RUN bundle install --quiet --jobs 8
+
+

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    japanda (0.1.6)
+      rest-client (>= 2.1.0)
+      rspec_junit_formatter (~> 0.4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.0.2)
+    hashie (4.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    netrc (0.11.0)
+    rake (10.4.2)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  byebug
+  dotenv
+  hashie (~> 4.0.0)
+  japanda!
+  rake
+  rspec (~> 3.5.0)
+
+BUNDLED WITH
+   1.17.3

data/Jenkinsfile

@@ -0,0 +1,64 @@
+#! /usr/bin/env groovy
+
+String rspec_results = ''
+String container_id = ''
+
+pipeline {
+    agent { label 'docker' }
+
+    environment {
+        COMPOSE_PROJECT_NAME = 'japanda_build'
+        COMPOSE_FILE = 'docker-compose.yml'
+    }
+
+    options {
+        ansiColor("xterm")
+    }
+
+    stages {
+        stage('Build') {
+            steps {
+                echo 'Building the containers'
+                sh "docker-compose build --pull"
+
+                echo 'Starting containers'
+                sh "docker-compose up -d"
+                sh 'docker-compose run --no-deps -d testrunner tail -f /dev/null'
+
+                script {
+                    sh "docker ps"
+                    container_id = sh(script: "docker ps -qf 'name=testrunner'",
+                            returnStdout: true
+                    ).trim()
+                }
+            }
+
+        }
+
+        stage('Run Rspec Tests') {
+            steps {
+                sh "docker exec $container_id bundle exec rspec spec/ >> rspec_results"
+            }
+        }
+    }
+
+    post {
+        always {
+            script {
+                rspec_results = sh(script: 'cat rspec_results',
+                        returnStdout: true
+                ).trim()
+
+                sh "docker cp $container_id:/usr/src/app/junit ."
+                junit allowEmptyResults: true, testResults: 'junit/rspec.xml'
+            }
+            echo rspec_results
+        }
+
+        cleanup {
+            sh 'if [ -d "junit" ]; then rm -r "junit"; fi'
+            sh 'if [ -f "rspec_results" ]; then rm -rf "rspec_results"; fi'
+            sh "docker-compose down --remove-orphans --rmi=all --volumes"
+        }
+    }
+}

data/README.md

@@ -1,16 +1,14 @@
 # Japanda
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/japanda`. To experiment with that code, run `bin/console` for an interactive prompt.
+Japanda provides an object-oriented and a functional wrapper around Instructure Canvas Api's
 
-TODO: Delete this and the text above, and describe your gem
+Disclaimer: For testing purposes only.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'japanda'
-```
+    gem 'japanda'
 
 And then execute:
 
@@ -21,28 +19,70 @@ Or install it yourself as:
     $ gem install japanda
 
 ## Usage
-Set a few enviroment variables:
-
-```ruby
-export CANVAS_API_HOST=
-export CANVAS_API_TOKEN=
-export CANVAS_ACCOUNT_ID=
-export GALLERY_API_HOST=
-export GALLERY_API_TOKEN=
-```
+
+Set a few enviroment variables( or use .env.example file)
+
+    export CANVAS_API_HOST=
+    export CANVAS_API_TOKEN=
+    export CANVAS_ACCOUNT_ID=
+
+To create a new course
+
+    CanvasFactory::Course.new
+    
+To create a new course by providing a custom hash(merge)
+
+    opts = { course:{ name: 'coursename1', course_code: "code-change#{SecureRandom.hex}" } }
+    course = CanvasFactory::Course.new(opts)
+    
+To create a new course by providing a custom hash(no merge)
+
+    opts = {
+             account_id: '10',
+             course: {
+               name: "code-name#{SecureRandom.hex}",
+               course_code: "course_code#{SecureRandom.hex}"
+             },
+             offer: true
+           }
+    course = CanvasFactory::Course.new(opts, false)
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rspec` to run the tests.
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Run in docker
+
+Make sure your .env variable contains
+```
+CANVAS_API_HOST=<canvas_host>
+CANVAS_API_TOKEN=<canvas_api_token>
+CANVAS_ACCOUNT_ID=<canvas_account_id>
+```
+
+Building the testrunner
+```
+docker-compose build
+```
+
+Running the tests:
+```
+docker-compose run testrunner bundle exec rspec spec/
+```
+
+## Release a new version
+
+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).
 
-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/[USERNAME]/japanda. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/babababili/japanda. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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).
+For testing purposes only.
 
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '2.0'
+
+services:
+  testrunner:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    environment:
+      CANVAS_API_HOST: ${CANVAS_API_HOST}
+      CANVAS_API_TOKEN: ${CANVAS_API_TOKEN}
+      CANVAS_ACCOUNT_ID: ${CANVAS_ACCOUNT_ID}

data/japanda.gemspec

@@ -4,36 +4,36 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'japanda/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "japanda"
+  spec.name          = 'japanda'
   spec.version       = Japanda::VERSION
-  spec.authors       = ["Santosh Natarajan"]
-  spec.email         = ["snatarajan@instructure.com"]
+  spec.authors       = ['Santosh Natarajan', 'Robert Lamb']
+  spec.email         = ['snatarajan@instructure.com', 'rlamb@instructure.com']
 
-  spec.summary       = %q{Library to create custom course, catalog.}
-  spec.description   = %q{Library to create custom course, catalog.}
-  spec.homepage      = "https://github.com/babababili/japanda"
-  spec.license       = "MIT"
+  spec.summary       = %q{Library to create custom course.}
+  spec.description   = %q{Library to create custom course. wip.}
+  # spec.homepage      = 'https://github.com/babababili/japanda'
+  # spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
   # if spec.respond_to?(:metadata)
-  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #   spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
   # else
-  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   # end
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10.5"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  # spec.add_development_dependency "rest-client"
-  # spec.add_development_dependency "deep_merge"
-  spec.add_dependency "deep_merge"
-  spec.add_dependency "rest-client"
-  spec.add_dependency "dotenv"
+  spec.add_development_dependency 'bundler', '~>1.5'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'hashie', '~>4.0.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.5.0'
+  spec.add_dependency 'rest-client', '>= 2.1.0'
+  spec.add_dependency 'rspec_junit_formatter', '~>0.4.1'
 
 end

data/lib/japanda.rb

@@ -1,5 +1,8 @@
 require 'japanda/version'
 require 'securerandom'
+require 'rest-client'
+require 'json'
+require 'byebug'
 
 module Japanda
 end

data/lib/japanda/canvas_factory.rb

@@ -1,4 +1,5 @@
 require 'dotenv'
+
 module CanvasFactory
   Dotenv.load
   CANVAS_API_V1 ||= "#{ENV['CANVAS_API_HOST']}/api/v1"
@@ -7,4 +8,17 @@ module CanvasFactory
       content_type: 'application/json'
   }
   CANVAS_ACCOUNT_ID ||= ENV['CANVAS_ACCOUNT_ID']
+
+  # JSON.generate see: https://github.com/rest-client/rest-client/issues/635/
+  def self.perform_post(end_point, body)
+    JSON.parse(RestClient.post end_point, JSON.generate(body), CANVAS_AUTH_HEADER)
+  end
+
+  def self.perform_put(end_point, body)
+    JSON.parse(RestClient.put end_point, JSON.generate(body), CANVAS_AUTH_HEADER)
+  end
+
+  def self.perform_delete(end_point)
+    JSON.parse(RestClient.delete end_point, CANVAS_AUTH_HEADER)
+  end
 end

data/lib/japanda/canvas_factory/assignment.rb

@@ -1,19 +1,14 @@
-# assignment class
 module CanvasFactory
+  # assignment class
   class Assignment
-    attr_reader :assignments
+    attr_reader :id, :name, :course_id, :html_url, :grading_type, :published, :due_at,
+                :created_at, :request, :response
 
-    def add_assignments(opts)
-      @assignments = []
-      opts[:module][:assignment][:size].times do |i|
-        @assignments << add_assignment(opts, i)
-      end
-    end
-
-    def add_assignment(opts, i)
-      body = {
+    def initialize(course_id, opts = {}, merge = true)
+      @course_id = course_id
+      @request = {
         assignment: {
-          name: "Assignment-#{i}-#{Time.now.to_i}",
+          name: "Assignment-#{Time.now.to_i}",
           grading_type: %w(pass_fail percent letter_grade gpa_scale points).sample,
           submission_types: ['online_text_entry'],
           points_possible: 10,
@@ -21,11 +16,23 @@ module CanvasFactory
           published: true
         }
       }
-      body.deep_merge!(opts[:assignment_options]) unless opts[:assignment_options].nil?
+      @request = Mergie.deep_merge(@request, opts, merge)
+      create_assignment
+      self
+    end
+
+    private
 
-      assign_end_point = "#{CANVAS_API_V1}/courses/#{opts[:course_id]}/assignments"
-      response = RestClient.post assign_end_point, body, CANVAS_AUTH_HEADER
-      JSON.parse(response)
+    def create_assignment
+      assign_end_point = "#{CANVAS_API_V1}/courses/#{@course_id}/assignments"
+      @response = CanvasFactory.perform_post(assign_end_point, @request)
+      @id = response['id']
+      @name = response['name']
+      @html_url = response['html_url']
+      @grading_type = response['grading_type']
+      @published = response['published']
+      @created_at = response['created_at']
+      @due_at = response['due_at']
     end
   end
 end

data/lib/japanda/canvas_factory/course.rb

@@ -1,18 +1,83 @@
-# canvas course class
 module CanvasFactory
+  # canvas course class
   class Course
-    attr_reader :course_response, :course_id, :course_config, :course_code, :course_name
+    attr_reader :course_response, :course_id, :course_code, :course_name, :course_request,
+                :sections, :modules, :assignments, :quizzes
 
-    def initialize(course_config = nil)
-      @course_config = course_config
-      @course_config = CanvasFactory::CourseConfig.new if course_config.nil?
+    def initialize(opts = {}, merge = true)
+      @sections = []
+      @modules = []
+      @assignments = []
+      @quizzes = []
+      course_name_code = "auto#{SecureRandom.hex}"
+      @course_request = {
+        account_id: CANVAS_ACCOUNT_ID,
+        course: {
+          name: course_name_code,
+          course_code: course_name_code,
+          start_at: Time.now,
+          end_at: Time.now + (30 * 24 * 60 * 60),
+          license: 'public_domain',
+          is_public: true,
+          is_public_to_auth_users: false,
+          public_syllabus: false,
+          public_description: 'api created course',
+          allow_student_wiki_edits: true,
+          allow_wiki_comments: true,
+          allow_student_forum_attachments: true,
+          open_enrollment: true,
+          self_enrollment: false,
+          restrict_enrollments_to_course_dates: false,
+          term_id: nil,
+          # sis_course_id: '', # field is included only when user has permission to view SIS information
+          # integration_id: '', # field is included only when user has permission to view SIS information
+          hide_final_grades: true,
+          apply_assignment_group_weights: false,
+          syllabus_body: 'api syllabus',
+          grading_standard_id: nil,
+          course_format: 'online'
+        },
+        offer: true,
+        enroll_me: false,
+        enable_sis_reactivation: false
+      }
+      @course_request = Mergie.deep_merge(@course_request, opts, merge)
+      create_course
     end
 
-    def create
-      @course_config.set_course_request
-      course_end_point = "#{CANVAS_API_V1}/accounts/#{@course_config.account_id}/courses"
-      response = RestClient.post course_end_point, @course_config.course_request, CANVAS_AUTH_HEADER
-      @course_response = JSON.parse(response)
+    def add_section(opts = {}, merge = true)
+      section = CanvasFactory::Section.new(@course_id, opts, merge)
+      @sections << section
+    end
+
+    def add_module(opts = {}, merge = true)
+      mod = CanvasFactory::Module.new(@course_id, opts, merge)
+      @modules << mod
+      mod
+    end
+
+    def add_assignment(opts = {}, merge = true)
+      assignment = CanvasFactory::Assignment.new(@course_id, opts, merge)
+      @assignments << assignment
+      assignment
+    end
+
+    def add_quiz(opts = {}, merge = true)
+      quiz = CanvasFactory::Quiz.new(@course_id, opts, merge)
+      @quizzes << quiz
+      quiz
+    end
+
+    def delete_course
+      delete_end_point = "#{CANVAS_API_V1}/courses/#{@course_id}?event=delete"
+      CanvasFactory.perform_delete(delete_end_point)
+    end
+
+    private
+
+    def create_course
+      course_end_point = "#{CANVAS_API_V1}/accounts/#{@course_request[:account_id]}/courses"
+      @course_response = CanvasFactory.perform_post(course_end_point, @course_request)
       @course_id = @course_response['id']
       @course_name = @course_response['name']
       @course_code = @course_response['course_code']

data/lib/japanda/canvas_factory/mergie.rb

@@ -0,0 +1,10 @@
+require 'hashie/extensions/deep_merge'
+module CanvasFactory
+  class Mergie < Hash
+    include Hashie::Extensions::DeepMerge
+
+    def self.deep_merge(default_hash, given_hash, should_merge)
+      should_merge ? Mergie[default_hash].deep_merge(Mergie[given_hash]).to_h: given_hash
+    end
+  end
+end

data/lib/japanda/canvas_factory/module.rb

@@ -1,46 +1,51 @@
-# canvas module class
 module CanvasFactory
+  # canvas module class
   class Module
-    attr_reader :modules
+    attr_reader :course_id, :name, :module_id, :published, :request, :response,
+                :module_items, :publish_response, :publish_request
 
-    def create_modules(opts)
-      @modules = []
-      opts[:module][:size].times do
-        @modules << create_module_add_item_publish(opts)
-      end
-      @modules
-    end
-
-    def create_module_add_item_publish(opts)
-      body = {
+    def initialize(course_id, opts = {}, merge = true)
+      @module_items = []
+      @course_id = course_id
+      @request = {
         module: {
-          name: "Course-Module-#{Time.now.to_i}",
+          name: "module-#{Time.now.to_i}",
           unlock_at: DateTime.now.iso8601,
           require_sequential_progress: true
         }
       }
-      body.deep_merge!(opts[:module_options]) unless opts[:module_options].nil?
-
-      m_item_end_point = "#{CANVAS_API_V1}/courses/#{opts[:course_id]}/modules"
-      response = RestClient.post m_item_end_point, body, CANVAS_AUTH_HEADER
-      m = JSON.parse(response)
-
-      mi = CanvasFactory::ModuleItem.new
-      mi.add_module_items(m['id'], opts)
+      @request = Mergie.deep_merge(@request, opts, merge)
+      create_module
+      self
+    end
 
-      update_module opts[:course_id], m['id']
-      { module: m, module_items: mi.module_items }
+    def add_module_item(content, opts = {}, merge = true) # content can be assignment or quiz ...
+      module_item = CanvasFactory::ModuleItem.new(@course_id, @module_id, content, opts, merge)
+      @module_items << module_item
+      module_item
     end
 
-    def update_module(course_id, module_id)
-      body = {
+    def publish(opts = {}, merge = true)
+      @publish_request = {
         module: {
           published: true
         }
       }
-      m_p_end_point = "#{CANVAS_API_V1}/courses/#{course_id}/modules/#{module_id}"
-      response = RestClient.put m_p_end_point, body, CANVAS_AUTH_HEADER
-      JSON.parse(response)
+      @publish_request = Mergie.deep_merge(@publish_request, opts, merge)
+      publish_ep = "#{CANVAS_API_V1}/courses/#{@course_id}/modules/#{@module_id}"
+      @publish_response = CanvasFactory.perform_put(publish_ep, @publish_request)
+      @published = @publish_response['published']
+    end
+
+    private
+
+    def create_module
+      m_item_end_point = "#{CANVAS_API_V1}/courses/#{@course_id}/modules"
+      @response = CanvasFactory.perform_post(m_item_end_point, @request)
+      @course_id = course_id
+      @module_id = response['id']
+      @name = response['name']
+      @published = response['published']
     end
   end
 end

data/lib/japanda/canvas_factory/module_item.rb

@@ -1,31 +1,37 @@
-# canvas module_item class
 module CanvasFactory
+  # module item class
   class ModuleItem
-    attr_reader :module_items
+    attr_reader :item_id, :name, :course_id, :html_url, :title, :published, :type,
+                :created_at, :request, :response, :module_id
 
-    def add_module_items(module_id, opts)
-      @module_items = []
-      aa = CanvasFactory::Assignment.new
-      aa.add_assignments(opts)
-      aa.assignments.each do |a|
-        @module_items << add_module_item(module_id, 'Assignment', a['id'], opts)
-      end
-    end
-
-    def add_module_item(m_id, module_item_type, item_content_id, opts)
-      body = {
+    def initialize(course_id, module_id, content, opts = {}, merge = true)
+      @course_id = course_id
+      @module_id = module_id
+      @request = {
         module_item: {
-          title: "mod-#{module_item_type}-#{item_content_id}",
-          type: module_item_type,
-          content_id: item_content_id,
+          title: "module-item#{SecureRandom.hex}",
+          type: content.class.name.split('::').last || '',
+          content_id: content.id,
           completion_requirement: {
             type: 'must_view'
           }
         }
       }
-      m_i = "#{CANVAS_API_V1}/courses/#{opts[:course_id]}/modules/#{m_id}/items"
-      response = RestClient.post m_i, body, CANVAS_AUTH_HEADER
-      JSON.parse(response)
+      @request = Mergie.deep_merge(@request, opts, merge)
+      create_item
+      self
+    end
+
+    private
+
+    def create_item
+      item_end_point = "#{CANVAS_API_V1}/courses/#{@course_id}/modules/#{@module_id}/items"
+      @response = CanvasFactory.perform_post(item_end_point, @request)
+      @published = response['published']
+      @item_id = response['id']
+      @type = response['type']
+      @title = response['title']
+      @html_url = response['html_url']
     end
   end
 end

data/lib/japanda/canvas_factory/quiz.rb

@@ -0,0 +1,52 @@
+module CanvasFactory
+  # Quiz class
+  class Quiz
+    attr_reader :id, :course_id, :html_url, :published, :due_at, :title,
+                :request, :response
+
+    def initialize(course_id, opts = {}, merge = true)
+      @course_id = course_id
+      @request = {
+        quiz: {
+          title: "quiz-#{Time.now.to_i}",
+          description: 'api created quiz',
+          quiz_type: %w(practice_quiz assignment graded_survey survey).sample,
+          assignment_group_id: nil,
+          time_limit: nil,
+          shuffle_answers: true,
+          hide_results: %w(always until_after_last_attempt).sample,
+          show_correct_answers: true,
+          show_correct_answers_last_attempt: true,
+          hide_correct_answers_at: true,
+          allowed_attempts: 1,
+          scoring_policy: %w(keep_highest keep_latest).sample,
+          one_question_at_a_time: false,
+          cant_go_back: false,
+          access_code: nil,
+          ip_filter: nil,
+          due_at: (DateTime.now + 10).iso8601,
+          lock_at: (DateTime.now + 10).iso8601,
+          unlock_at: (DateTime.now).iso8601,
+          published: true,
+          one_time_results: false
+        }
+      }
+      @request = Mergie.deep_merge(@request, opts, merge)
+      create_quiz
+      self
+    end
+
+    private
+
+    def create_quiz
+      quiz_end_point = "#{CANVAS_API_V1}/courses/#{@course_id}/quizzes"
+      @response = CanvasFactory.perform_post(quiz_end_point, @request)
+      @id = response['id']
+      @title = response['title']
+      @html_url = response['html_url']
+      @published = response['published']
+      @due_at = response['due_at']
+    end
+  end
+end
+

data/lib/japanda/canvas_factory/section.rb

@@ -1,22 +1,36 @@
-# canvas section class
 module CanvasFactory
+  # canvas section class
   class Section
-    attr_reader :sections
+    attr_reader :course_id, :id, :end_at, :start_at, :name, :sis_section_id, :sis_course_id,
+                :integration_id, :sis_import_id, :nonxlist_course_id, :request, :response
 
-    def create_multiple_sections(opts)
-      @sections = []
-      opts[:section][:size].times do |i|
-        body = {
-          course_section: {
-            name: "section-#{i}-#{Time.now.to_i}"
-          }
+    def initialize(course_id, opts = {}, merge = true)
+      @course_id = course_id
+      @request = {
+        course_section: {
+          name: "section-#{Time.now.to_i}",
+          start_at: Time.now,
+          end_at: Time.now + (30 * 24 * 60 * 60),
+          restrict_enrollments_to_section_dates: false,
+          # enable_sis_reactivation: false,
+          # sis_section_id: nil
         }
+      }
+      @request = Mergie.deep_merge(@request, opts, merge)
+      create_section
+      self
+    end
+
+    private
 
-        body.deep_merge!(opts[:section_options]) unless opts[:section_options].nil?
-        section_end_point = "#{CANVAS_API_V1}/courses/#{opts[:course_id]}/sections"
-        response = RestClient.post section_end_point, body, CANVAS_AUTH_HEADER
-        @sections << JSON.parse(response)
-      end
+    def create_section
+      section_end_point = "#{CANVAS_API_V1}/courses/#{@course_id}/sections"
+      @response = CanvasFactory.perform_post(section_end_point, @request)
+      @course_id = response['course_id']
+      @id = response['id']
+      @name = response['name']
+      @end_at = response['end_at']
+      @start_at = response['start_at']
     end
   end
 end

data/lib/japanda/canvas_factory/user.rb

@@ -1,31 +1,67 @@
-# canvas user class
 module CanvasFactory
+  # canvas user class
   class User
-    attr_reader :user_response, :user_response_id, :user_response_email_id, :user_short_name, :user_password
+    attr_reader :learner_request, :user_response, :id, :admin_request,
+                :email_id, :short_name, :password
 
-    def initialize(user_config = nil)
-      @user_config = user_config
-      @user_config = CanvasFactory::UserConfig.new if user_config.nil?
+    def initialize(opts = {}, merge = true)
+      unique_email = "#{@email_prefix}#{SecureRandom.hex}@example.com"
+      @learner_request = {
+        user: {
+          name: unique_email,
+          short_name: 'auto user',
+          terms_of_use: '1',
+          send_confirmation: true
+        },
+        pseudonym: {
+          unique_id: unique_email,
+          password: 'Testing01'
+        },
+        force_validations: true
+      }
+      @learner_request = Mergie.deep_merge(@learner_request, opts, merge)
+      create_learner_user
+    end
+
+    def delete_user
+      user_end_point = "#{CANVAS_API_V1}/accounts/#{CANVAS_ACCOUNT_ID}/users/#{@id}"
+      @user_response = CanvasFactory.perform_delete(user_end_point)
     end
 
+    private
+
     def create_learner_user
-      @user_config.set_up_user_hash
-      body = @user_config.config_user_hash
       user_end_point = "#{CANVAS_API_V1}/accounts/#{CANVAS_ACCOUNT_ID}/users"
-      response = RestClient.post user_end_point, body, CANVAS_AUTH_HEADER
-      @user_response = JSON.parse(response)
-      @user_response_id = @user_response['id']
-      @user_response_email_id = @user_response['login_id']
-      @user_short_name = @user_config.short_name
-      @user_password = @user_config.password
+      @user_response = CanvasFactory.perform_post(user_end_point, @learner_request)
+      @id = @user_response['id']
+      @email_id = @user_response['login_id']
+      @short_name = @user_response['short_name']
+      @password = @learner_request[:pseudonym][:password]
+      @user_response
     end
+  end
 
-    def create_admin_user
-      create_learner_user
-      @user_config.set_up_admin_hash(@user_response['id'].to_i)
-      body = @user_config.config_admin_hash
-      a_end_point = "#{CANVAS_API_V1}/accounts/#{CANVAS_ACCOUNT_ID}/admins"
-      RestClient.post a_end_point, body, CANVAS_AUTH_HEADER
+  # canvas admin user class
+  class AdminUser < User
+    def initialize(opts = {}, merge = true)
+      super(opts, merge)
+      make_admin_user
+    end
+
+    private
+
+    def make_admin_user
+      @admin_request = {
+        user_id: @id,
+        role_id: 'AccountAdmin',
+        send_confirmation: true
+      }
+      admin_end_point = "#{CANVAS_API_V1}/accounts/#{CANVAS_ACCOUNT_ID}/admins"
+      @admin_response = CanvasFactory.perform_post(admin_end_point, @admin_request)
+      @id = @admin_response['user']['id']
+      @email_id = @admin_response['user']['login_id']
+      @short_name = @admin_response['user']['short_name']
+      @admin_response
     end
   end
 end

data/lib/japanda/version.rb

@@ -1,3 +1,3 @@
 module Japanda
-  VERSION = "0.1.1"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: japanda
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Santosh Natarajan
-autorequire: 
+- Robert Lamb
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,30 +17,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.5
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.5
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,83 +54,114 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: deep_merge
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Library to create custom course, catalog.
+        version: 0.4.1
+description: Library to create custom course. wip.
 email:
 - snatarajan@instructure.com
+- rlamb@instructure.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
-- LICENSE.txt
+- Gemfile.lock
+- Jenkinsfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - japanda.gemspec
 - lib/japanda.rb
 - lib/japanda/canvas_factory.rb
 - lib/japanda/canvas_factory/assignment.rb
 - lib/japanda/canvas_factory/course.rb
-- lib/japanda/canvas_factory/course_config.rb
+- lib/japanda/canvas_factory/mergie.rb
 - lib/japanda/canvas_factory/module.rb
 - lib/japanda/canvas_factory/module_item.rb
+- lib/japanda/canvas_factory/quiz.rb
 - lib/japanda/canvas_factory/section.rb
 - lib/japanda/canvas_factory/user.rb
-- lib/japanda/canvas_factory/user_config.rb
-- lib/japanda/catalog_factory.rb
-- lib/japanda/catalog_factory/course_program.rb
 - lib/japanda/version.rb
-homepage: https://github.com/babababili/japanda
-licenses:
-- MIT
+homepage:
+licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,9 +176,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
-summary: Library to create custom course, catalog.
+summary: Library to create custom course.
 test_files: []

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Santosh Natarajan
-
-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/lib/japanda/canvas_factory/course_config.rb

@@ -1,28 +0,0 @@
-module CanvasFactory
-  class CourseConfig
-    attr_accessor :course_request, :account_id, :name, :course_code, :start_at, :end_at, :offer
-
-    def initialize(opts = {})
-      course_name_code = "auto#{SecureRandom.hex}"
-      @account_id = opts[:account_id] || CANVAS_ACCOUNT_ID
-      @name = opts[:name] || course_name_code
-      @course_code = opts[:course_code] || course_name_code
-      @start_at = opts[:start_at] || Time.now
-      @end_at = opts[:end_at] || Time.now + (30 * 24 * 60 * 60)
-      @offer = opts[:offer] || true
-    end
-
-    def set_course_request
-      @course_request = {
-        account_id: @account_id,
-        course: {
-          name: @name,
-          course_code: @course_code,
-          start_at: @start_at,
-          end_at: @end_at
-        },
-        offer: @offer
-      }
-    end
-  end
-end

data/lib/japanda/canvas_factory/user_config.rb

@@ -1,41 +0,0 @@
-module CanvasFactory
-  class UserConfig
-    attr_reader :config_user_hash, :config_admin_hash
-    attr_accessor :email_prefix, :password, :short_name, :terms_of_use, :send_confirmation, :force_validations, :role_id, :email_id
-
-    def initialize(opts = {})
-      @email_prefix = opts[:email_prefix] || 'catauto'
-      @password = opts[:password] || 'Testing01'
-      @short_name = opts[:short_name] || 'cat auto'
-      @terms_of_use = opts[:terms_of_use] || '1'
-      @send_confirmation = opts[:send_confirmation] || true
-      @force_validations = opts[:force_validations] || true
-      @role_id = opts[:role_id] || 'AccountAdmin'
-      @email_id = opts[:email_id] || "#{@email_prefix}#{SecureRandom.hex}@example.com"
-    end
-
-    def set_up_user_hash
-      @config_user_hash = {
-        user: {
-          name: @email_id,
-          short_name: @short_name,
-          terms_of_use: @terms_of_use,
-          send_confirmation: @send_confirmation
-        },
-        pseudonym: {
-          unique_id: @email_id,
-          password: @password
-        },
-        force_validations: @force_validations
-      }
-    end
-
-    def set_up_admin_hash(id)
-      @config_admin_hash = {
-        user_id: id,
-        role_id: @role_id,
-        send_confirmation: @send_confirmation
-      }
-    end
-  end
-end

data/lib/japanda/catalog_factory.rb

@@ -1,6 +0,0 @@
-require 'dotenv'
-module CatalogFactory
-  Dotenv.load
-  GALLERY_API_TOKEN ||= ENV['GALLERY_API_TOKEN']
-  GALLERY_API_HOST = ENV['GALLERY_API_HOST']
-end

data/lib/japanda/catalog_factory/course_program.rb

@@ -1,61 +0,0 @@
-# add course and program to catalog
-module CatalogFactory
-  class CourseProgram
-    attr_reader :catalog_response, :course, :certificate_response
-
-    def initialize
-      @auth_token_content = {
-        Authorization: "Token token=#{GALLERY_API_TOKEN}",
-        content_type: 'application/json'
-      }
-    end
-
-    def add_course_to_catalog(canvas_options = {}, catalog_options = {})
-      @course = CanvasFactory::Course.new(canvas_options)
-      add_to_catalog(@course, catalog_options)
-    end
-
-    def add_to_catalog(canvas_course, opts = {})
-      @course = canvas_course
-      course_response = @course.course_response
-      body = {
-        course: {
-          title: course_response['name'],
-          description: 'created by api for testing',
-          path: course_response['name'],
-          canvas_course_id: course_response['id'],
-          teaser: 'created by api for testing',
-          enrollment_open: true,
-          visibility: 'listed',
-          enrollment_cap: 12,
-          enrollment_fee: 0.99,
-          days_to_complete: 45
-        }
-      }
-      body.deep_merge!(opts[:catalog_options]) unless opts[:catalog_options].nil?
-
-      course_end_point = "#{GALLERY_API_HOST}/api/v1/courses"
-      response = RestClient.post course_end_point, body, @auth_token_content
-      @catalog_response = JSON.parse(response)['course']
-      add_certificate @catalog_response['id'], opts
-    end
-
-    def add_certificate(catalog_id, opts = {})
-      body = {
-        certificate: {
-          listing_id: catalog_id,
-          name: 'test api certificate',
-          template: 'Description test api certificate',
-          pdf_settings: {
-            orientation: %w(Landscape Portrait).sample
-          }
-        }
-      }
-      body.deep_merge!(opts[:certificate_options]) unless opts[:certificate_options].nil?
-
-      new_course_end_point = "#{GALLERY_API_HOST}/api/v1/certificates"
-      response = RestClient.post new_course_end_point, body, @auth_token_content
-      @certificate_response = JSON.parse(response)
-    end
-  end
-end