japanda 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75a79e6f6563fd41f8875193443cd1ca5ee3adfa
+  data.tar.gz: cbf89675cd0814e3f1f28f5389086d5dbfc5a260
+SHA512:
+  metadata.gz: e9d7018ac25554bce9d6679dc83d6697130ec5318be1d63b267c1d70c73577006c0286af41e6cfc1c0e2128741c0bb9b49987f7bfd49d0ab0f5c62abb30d3d62
+  data.tar.gz: 96e479921c83bb3d91c31d9d2f9bb00921c0624bc2a186875c152aff0d61a3a2f3aa93e7e5883d6e4b27bd463fec49be5bc5be7fa17d8f816e3454b6aadf502f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+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/README.md

@@ -0,0 +1,46 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'japanda'
+```
+
+And then execute:
+
+    $ bundle
+
+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=
+
+## 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.
+
+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.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "japanda"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/japanda.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'japanda/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "japanda"
+  spec.version       = Japanda::VERSION
+  spec.authors       = ["Santosh Natarajan"]
+  spec.email         = ["snatarajan@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"
+
+  # 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'"
+  # 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 { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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"
+
+end

data/lib/canvas_factory/assignment.rb

@@ -0,0 +1,31 @@
+# assignment class
+module CanvasFactory
+  class Assignment
+    attr_reader :assignments
+
+    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 = {
+        assignment: {
+          name: "Assignment-#{i}-#{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
+        }
+      }
+      body.deep_merge!(opts[:assignment_options]) unless opts[:assignment_options].nil?
+
+      assign_end_point = "#{CANVAS_API_V1}/courses/#{opts[:course_id]}/assignments"
+      response = RestClient.post assign_end_point, body, CANVAS_AUTH_HEADER
+      JSON.parse(response)
+    end
+  end
+end

data/lib/canvas_factory/course.rb

@@ -0,0 +1,55 @@
+# canvas course class
+module CanvasFactory
+  class Course
+    attr_reader :course_response, :modules, :sections
+
+    def initialize(opts = {})
+      @options = {
+        name: 'catauto',
+        module: {
+          size: 1,
+          assignment:
+            { size: 2 }
+        },
+        section: { size: 3 }
+      }.update(opts)
+
+      add_a_course @options
+      add_modules(@options)
+      add_sections(@options)
+    end
+
+    def add_sections(opts)
+      s = CanvasFactory::Section.new
+      s.create_multiple_sections(opts)
+      @sections = s.sections
+    end
+
+    def add_modules(opts)
+      m = CanvasFactory::Module.new
+      m.create_modules(opts)
+      @modules = m.modules
+    end
+
+    def add_a_course(opts = {})
+      name = "#{opts[:name]}#{SecureRandom.hex}"
+      body = {
+        account_id: CANVAS_ACCOUNT_ID,
+        course: {
+          name: name,
+          course_code: name,
+          start_at: Time.now,
+          end_at: Time.now + (30 * 24 * 60 * 60)
+        },
+        offer: true
+      }
+      body.deep_merge!(opts[:course_options]) unless opts[:course_options].nil?
+
+      course_end_point = "#{CANVAS_API_V1}/accounts/#{CANVAS_ACCOUNT_ID}/courses"
+      response = RestClient.post course_end_point, body, CANVAS_AUTH_HEADER
+      @course_response = JSON.parse(response)
+      fail 'create canvas course failed' unless @course_response['workflow_state'].eql? 'available'
+      @options[:course_id] = @course_response['id']
+    end
+  end
+end

data/lib/canvas_factory/module.rb

@@ -0,0 +1,46 @@
+# canvas module class
+module CanvasFactory
+  class Module
+    attr_reader :modules
+
+    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 = {
+        module: {
+          name: "Course-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)
+
+      update_module opts[:course_id], m['id']
+      { module: m, module_items: mi.module_items }
+    end
+
+    def update_module(course_id, module_id)
+      body = {
+        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)
+    end
+  end
+end

data/lib/canvas_factory/module_item.rb

@@ -0,0 +1,31 @@
+# canvas module_item class
+module CanvasFactory
+  class ModuleItem
+    attr_reader :module_items
+
+    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 = {
+        module_item: {
+          title: "mod-#{module_item_type}-#{item_content_id}",
+          type: module_item_type,
+          content_id: item_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)
+    end
+  end
+end

data/lib/canvas_factory/section.rb

@@ -0,0 +1,22 @@
+# canvas section class
+module CanvasFactory
+  class Section
+    attr_reader :sections
+
+    def create_multiple_sections(opts)
+      @sections = []
+      opts[:section][:size].times do |i|
+        body = {
+          course_section: {
+            name: "section-#{i}-#{Time.now.to_i}"
+          }
+        }
+
+        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
+    end
+  end
+end

data/lib/canvas_factory/user.rb

@@ -0,0 +1,28 @@
+# canvas user class
+module CanvasFactory
+  class User
+    attr_reader :user_response, :user_response_id, :user_response_email_id, :user_short_name, :user_password
+    def initialize
+    end
+
+    def create_catalog_user(user_config)
+      user_config.set_up_user_hash
+      body = user_config.config_user_hash
+      user_end_point = "#{Japanda::CANVAS_API_V1}/accounts/#{Japanda::CANVAS_ACCOUNT_ID}/users"
+      response = RestClient.post user_end_point, body, Japanda::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.config_user_hash[:user][:short_name]
+      @user_password = user_config.config_user_hash[:pseudonym][:password]
+    end
+
+    def create_admin_user(user_config)
+      create_catalog_user user_config
+      user_config.set_up_admin_hash(@user_response['id'].to_i)
+      body = user_config.config_admin_hash
+      a_end_point = "#{Japanda::CANVAS_API_V1}/accounts/#{Japanda::CANVAS_ACCOUNT_ID}/admins"
+      RestClient.post a_end_point, body, Japanda::CANVAS_AUTH_HEADER
+    end
+  end
+end

data/lib/canvas_factory/user_config.rb

@@ -0,0 +1,41 @@
+module CanvasFactory
+  class UserConfig
+    attr_reader :config_user_hash, :config_admin_hash
+    attr_writer :email_prefix, :password, :short_name, :terms_of_use, :send_confirmation, :force_validations, :role_id, :email_id
+
+    def initialize
+      @email_prefix = 'catauto'
+      @password = 'Testing01'
+      @short_name = 'cat auto'
+      @terms_of_use = '1'
+      @send_confirmation = true
+      @force_validations = true
+      @email_id = "#{@email_prefix}#{SecureRandom.hex}@example.com"
+      @role_id = 'AccountAdmin'
+    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/catalog_factory/course_program.rb

@@ -0,0 +1,61 @@
+# 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

data/lib/japanda.rb

@@ -0,0 +1,16 @@
+require 'japanda/version'
+require 'securerandom'
+require 'dotenv'
+
+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/version.rb

@@ -0,0 +1,3 @@
+module Japanda
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: japanda
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Santosh Natarajan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Library to create custom course, catalog.
+email:
+- snatarajan@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- japanda.gemspec
+- lib/canvas_factory/assignment.rb
+- lib/canvas_factory/course.rb
+- lib/canvas_factory/module.rb
+- lib/canvas_factory/module_item.rb
+- lib/canvas_factory/section.rb
+- lib/canvas_factory/user.rb
+- lib/canvas_factory/user_config.rb
+- lib/catalog_factory/course_program.rb
+- lib/japanda.rb
+- lib/japanda/version.rb
+homepage: https://github.com/babababili/japanda
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Library to create custom course, catalog.
+test_files: []