japanda 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 75a79e6f6563fd41f8875193443cd1ca5ee3adfa
-  data.tar.gz: cbf89675cd0814e3f1f28f5389086d5dbfc5a260
+SHA256:
+  metadata.gz: 6d62c0b18d1c9844e0c9a62343edc2d681412c3bb453a7028d1c33ae47bfddac
+  data.tar.gz: 34bcfd1ac14c12c5fe61889bfd2c567edf6fcbf816fe5bce6f7d025154ced604
 SHA512:
-  metadata.gz: e9d7018ac25554bce9d6679dc83d6697130ec5318be1d63b267c1d70c73577006c0286af41e6cfc1c0e2128741c0bb9b49987f7bfd49d0ab0f5c62abb30d3d62
-  data.tar.gz: 96e479921c83bb3d91c31d9d2f9bb00921c0624bc2a186875c152aff0d61a3a2f3aa93e7e5883d6e4b27bd463fec49be5bc5be7fa17d8f816e3454b6aadf502f
+  metadata.gz: 38640dbdb09ffcf289130b8791ee5a6be3be255aa41b15359b4398efee7e51134e2879fecffda211aba59eacb1eccc56622fdae264d320b5036b9a0a9ccb1022
+  data.tar.gz: 70e93dbb2e8563b1724c36d9a9fc4eaef3f263a3c3ddfaae6c3ecefc09a253cb427f8c802e791f3a85987320eb4c53463f0594b4be2a4506525e1376909915b0

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.5)
+      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,26 +19,70 @@ Or install it yourself as:
     $ gem install japanda
 
 ## Usage
-Set a few enviroment variables:
 
-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,16 +1,8 @@
 require 'japanda/version'
 require 'securerandom'
-require 'dotenv'
+require 'rest-client'
+require 'json'
+require 'byebug'
 
 module Japanda
-  Dotenv.load
-  CANVAS_USER_DOMAIN ||= ENV['CANVAS_USER_DOMAIN']
-  CANVAS_API_V1 ||= "#{ENV['CANVAS_API_HOST']}/api/v1"
-  CANVAS_AUTH_HEADER ||= {
-      Authorization: "Bearer #{ENV['CANVAS_API_TOKEN']}",
-      content_type: 'application/json'
-  }
-  CANVAS_ACCOUNT_ID ||= ENV['CANVAS_ACCOUNT_ID']
-  GALLERY_API_TOKEN ||= ENV['GALLERY_API_TOKEN']
-  GALLERY_API_HOST = ENV['GALLERY_API_HOST']
 end

data/lib/japanda/canvas_factory.rb

@@ -0,0 +1,24 @@
+require 'dotenv'
+
+module CanvasFactory
+  Dotenv.load
+  CANVAS_API_V1 ||= "#{ENV['CANVAS_API_HOST']}/api/v1"
+  CANVAS_AUTH_HEADER ||= {
+      Authorization: "Bearer #{ENV['CANVAS_API_TOKEN']}",
+      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

@@ -0,0 +1,38 @@
+module CanvasFactory
+  # assignment class
+  class Assignment
+    attr_reader :id, :name, :course_id, :html_url, :grading_type, :published, :due_at,
+                :created_at, :request, :response
+
+    def initialize(course_id, opts = {}, merge = true)
+      @course_id = course_id
+      @request = {
+        assignment: {
+          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,
+          due_at: (DateTime.now + 1).iso8601,
+          published: true
+        }
+      }
+      @request = Mergie.deep_merge(@request, opts, merge)
+      create_assignment
+      self
+    end
+
+    private
+
+    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

@@ -0,0 +1,82 @@
+module CanvasFactory
+  # canvas course class
+  class Course
+    attr_reader :course_response, :course_id, :course_code, :course_name, :course_request,
+                :sections, :modules, :assignments, :quizzes
+
+    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 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
+
+    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']
+      self
+    end
+  end
+end