japanda 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c88d5e552e2c67042dd5da76188c48ffefc2f8b7
-  data.tar.gz: b871098f94298c6ad6c0acb22c7d12a01a6bbd25
+SHA256:
+  metadata.gz: 6d62c0b18d1c9844e0c9a62343edc2d681412c3bb453a7028d1c33ae47bfddac
+  data.tar.gz: 34bcfd1ac14c12c5fe61889bfd2c567edf6fcbf816fe5bce6f7d025154ced604
 SHA512:
-  metadata.gz: cdbcc9424cd02a9923fed5121c7d74638888ab9cb37e25e7286f1ecaa0b70a9c46109ee688fdcfa149c28f81bbccca3eba977d613f8d979a1bad148c692c8012
-  data.tar.gz: e4c24a8f9858ebd769ce85723066772e46be305456020c90d6ebdba950cab3f5f53f5753d9569b8c87cdab79d27742e6d6bdb15100824171bea160757533414c
+  metadata.gz: 38640dbdb09ffcf289130b8791ee5a6be3be255aa41b15359b4398efee7e51134e2879fecffda211aba59eacb1eccc56622fdae264d320b5036b9a0a9ccb1022
+  data.tar.gz: 70e93dbb2e8563b1724c36d9a9fc4eaef3f263a3c3ddfaae6c3ecefc09a253cb427f8c802e791f3a85987320eb4c53463f0594b4be2a4506525e1376909915b0

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 .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

@@ -1,53 +1,62 @@
 PATH
   remote: .
   specs:
-    japanda (0.1.4)
-      rest-client
+    japanda (0.1.5)
+      rest-client (>= 2.1.0)
+      rspec_junit_formatter (~> 0.4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.2.5)
-    domain_name (0.5.24)
+    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 (2.0.5)
-    http-cookie (1.0.2)
+    hashie (4.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
       domain_name (~> 0.5)
-    mime-types (2.6.2)
-    netrc (0.10.3)
+    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 (1.8.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
+      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.3.0)
-    rspec-mocks (3.3.2)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.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.1)
+    unf_ext (0.0.7.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (>= 1.0.0)
+  bundler (~> 1.5)
+  byebug
   dotenv
-  hashie
+  hashie (~> 4.0.0)
   japanda!
-  rake (~> 10.0)
-  rspec
+  rake
+  rspec (~> 3.5.0)
 
 BUNDLED WITH
-   1.10.6
+   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,9 @@
 # Japanda
 
-Japanda provides an object-oriented wrapper and functional wrapper around Instructure Canvas Api's
+Japanda provides an object-oriented and a functional wrapper around Instructure Canvas Api's
 
 Disclaimer: For testing purposes only.
 
-v0.1.3 Features
-
-1. Create canvas learner user and admin user
-2. Create canvas course
-3. Add sections to canvas
-4. Add module(s) with assignment(s)
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -37,22 +30,47 @@ To create a new course
 
     CanvasFactory::Course.new
     
-To create a canvas course by specifying the course config
+To create a new course by providing a custom hash(merge)
 
-    course_config = CanvasFactory::CourseConfig.new({ name: 'Candy Tasting' })
-    course = CanvasFactory::Course.new course_config
+    opts = { course:{ name: 'coursename1', course_code: "code-change#{SecureRandom.hex}" } }
+    course = CanvasFactory::Course.new(opts)
     
-To create a canvas learner user
-
-    user_config = CanvasFactory::UserConfig.new(short_name: 'John Doe', password: 'Password01') 
-    user = CanvasFactory::User.new(user_config)
-    learner_user = user.create_learner_user
+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 `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).

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

@@ -27,10 +27,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '>= 1.0.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'hashie'
+  spec.add_development_dependency 'bundler', '~>1.5'
+  spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'dotenv'
-  spec.add_dependency 'rest-client'
+  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,6 +1,8 @@
 require 'japanda/version'
 require 'securerandom'
 require 'rest-client'
+require 'json'
+require 'byebug'
 
 module Japanda
 end

data/lib/japanda/canvas_factory.rb

@@ -9,11 +9,16 @@ module CanvasFactory
   }
   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, body, CANVAS_AUTH_HEADER)
+    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, body, CANVAS_AUTH_HEADER)
+    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/mergie.rb

@@ -1,9 +1,10 @@
 require 'hashie/extensions/deep_merge'
+module CanvasFactory
+  class Mergie < Hash
+    include Hashie::Extensions::DeepMerge
 
-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
+    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
+end

data/lib/japanda/canvas_factory/user.rb

@@ -23,6 +23,11 @@ module CanvasFactory
       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
@@ -52,7 +57,11 @@ module CanvasFactory
         send_confirmation: true
       }
       admin_end_point = "#{CANVAS_API_V1}/accounts/#{CANVAS_ACCOUNT_ID}/admins"
-      CanvasFactory.perform_post(admin_end_point, @admin_request)
+      @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.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,46 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: japanda
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Santosh Natarajan
 - Robert Lamb
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        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:
     - - ">="
@@ -57,18 +57,18 @@ dependencies:
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,20 +81,48 @@ dependencies:
     - - ">="
       - !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: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 description: Library to create custom course. wip.
 email:
 - snatarajan@instructure.com
@@ -106,14 +134,18 @@ files:
 - ".env.example"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
+- Jenkinsfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - japanda.gemspec
 - lib/japanda.rb
 - lib/japanda/canvas_factory.rb
@@ -126,10 +158,10 @@ files:
 - lib/japanda/canvas_factory/section.rb
 - lib/japanda/canvas_factory/user.rb
 - lib/japanda/version.rb
-homepage: 
+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.
 test_files: []