integration_pal 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17225c001e18da68a033fa8b20b7aa96c568dbd2
-  data.tar.gz: 4823be875bf24dc9e2ce83dea646ba408de6955b
+  metadata.gz: 280b4edff89cc46a952f3f285598cd653e30302e
+  data.tar.gz: b901792e8bd9b9c4b0a15f00ed417b63f37ef22c
 SHA512:
-  metadata.gz: 693d29af95a8abdddee204db1d077ea7beca1dfa72b0e6a8ac16934e1cb118072e7df5b07b954603a48b6b18cbfc8165694ce0366589be3b99b79ec807a04c24
-  data.tar.gz: 6c68c5f63f781834340731bcf12387e5f814ea5050044468f84dde823be3dff3f9f1037ab7c113fe0ae3c9faeca715ffacb4a8ec4677ad2e7fdf459f2b64501f
+  metadata.gz: 0af7e88b02c0ff73a2b14bf00b49613a056d600e95d9e0c574e5657685f62b7d30a4f5526c2abd0a5c6b7e563534bfaf4d1a9330b71a251cf95320272542c4ce
+  data.tar.gz: 8ba3b65e035a8b837c8280a39fa3fe12037d79a92468e5ec4e5c3af15b1755e4f6c24bd7cc2389b3d1a14ef909388af68240caf0f1dc16ab93c0cd1b73704aa7

data/config/initializers/jobs.rb

@@ -1,4 +1,6 @@
-jobs = Dir.glob("#{Rails.root}/app/jobs/*.rb")
-job_types = jobs.map{ |job| File.basename(job).to_s.gsub('.rb', '').camelcase }
-job_types.delete('ApplicationJob')
-JOB_TYPES = job_types
+jobs = Dir.glob("#{Rails.root}/app/jobs/**/*.rb")
+jobs = jobs.map{ |job| job.gsub("#{Rails.root}/app/jobs/", '') }
+jobs = jobs.map{ |job| job.gsub(".rb", '') }
+jobs = jobs.map{ |job| job.split("/").map{ |j| j.camelcase }.join('::') }
+jobs.delete('ApplicationJob')
+JOB_TYPES = jobs

data/lib/canvas/client.rb

@@ -0,0 +1,24 @@
+require 'httmultiparty'
+
+module Canvas
+  class Client
+    include ::HTTMultiParty
+
+    attr_accessor :token, :canvas_url
+
+    def initialize(canvas_url, token)
+      self.class.base_uri(canvas_url)
+      @canvas_url = canvas_url
+      @token = token
+    end
+
+    def post_sis_zip_to_canvas(account_id, *params)
+      path = "/api/v1/accounts/#{account_id}/sis_imports"
+      params_hash = params.first
+      query = {attachment: File.open(params_hash.delete(:attachment))}
+      query.merge!(params_hash)
+      self.class.post(path, query: query, headers: {'Authorization' => "Bearer #{token}", 'Content-Type' => 'application/zip'})
+    end
+
+  end
+end

data/lib/canvas/models/account.rb

@@ -0,0 +1,11 @@
+module Canvas::Models
+  class Account < BaseModel
+    validates :sis_id, :name, presence: true
+    validates :status, inclusion: {in: %w(active deleted)}
+    attr_accessor :sis_id, :parent_sis_id, :name, :status
+
+    def after_initialize
+      self.status ||= 'active'
+    end
+  end
+end

data/lib/canvas/models/base_model.rb

@@ -0,0 +1,22 @@
+module Canvas::Models
+  class BaseModel
+    include ::ActiveModel::Validations
+    include ::ActiveModel::Serialization
+
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
+
+      after_initialize
+    end
+
+    def after_initialize
+      # this method should be overwritten in subclass
+    end
+
+    def ==(other)
+      to_json == other.to_json
+    end
+  end
+end

data/lib/canvas/models/course.rb

@@ -0,0 +1,11 @@
+module Canvas::Models
+  class Course < BaseModel
+    validates :sis_id, :short_name, :long_name, presence: true
+    validates :status, inclusion: {in: %w(active deleted completed)}
+    attr_accessor :sis_id, :account_sis_id, :term_sis_id, :short_name, :long_name, :status, :start_date, :end_date
+
+    def after_initialize
+      self.status ||= 'active'
+    end
+  end
+end

data/lib/canvas/models/enrollment.rb

@@ -0,0 +1,17 @@
+module Canvas::Models
+  class Enrollment < BaseModel
+    validates :user_sis_id, :role, presence: true
+    validates :role, inclusion: {in:  ['student', 'teacher', 'ta', 'observer', 'designer', 'Pending Orientation']}
+    validates :status, inclusion: {in:  %w(active deleted completed)}
+    validate :course_or_section
+    attr_accessor :course_sis_id, :user_sis_id, :role, :section_sis_id, :status, :associated_user_sis_id
+
+    def course_or_section
+      errors.add(:id, 'An enrollment must have either a course_id or a section_id') unless @course_sis_id || @section_sis_id
+    end
+
+    def after_initialize
+      self.status ||= 'active'
+    end
+  end
+end

data/lib/canvas/models/file.rb

@@ -0,0 +1,7 @@
+module Canvas::Models
+  class File < BaseModel
+    attr_accessor :size, :content_type, :url, :id, :display_name, :created_at, :updated_at, :unlock_at, :locked,
+                  :hidden, :lock_at, :locked_for_user, :hidden_for_user
+
+  end
+end

data/lib/canvas/models/folder.rb

@@ -0,0 +1,7 @@
+module Canvas::Models
+  class Folder < BaseModel
+    attr_accessor :context_type, :context_id, :files_count, :position, :updated_at, :folders_url, :files_url,
+                  :full_name, :lock_at, :id, :folders_count, :name, :parent_folder_id, :created_at, :unlock_at,
+                  :hidden, :hidden_for_user, :locked, :locked_for_user
+  end
+end

data/lib/canvas/models/group.rb

@@ -0,0 +1,11 @@
+module Canvas::Models
+  class Group < BaseModel
+    validates :sis_id, :name, presence: true
+    validates :status, inclusion: {in: %w(available closed completed deleted)}
+    attr_accessor :sis_id, :account_sis_id, :name, :status
+
+    def after_initialize
+      self.status ||= 'available'
+    end
+  end
+end

data/lib/canvas/models/group_membership.rb

@@ -0,0 +1,11 @@
+module Canvas::Models
+  class GroupMembership < BaseModel
+    validates :user_sis_id, :group_sis_id, presence: true
+    validates :status, inclusion: {in: %w(accepted deleted)}
+    attr_accessor :group_sis_id, :user_sis_id, :status
+
+    def after_initialize
+      self.status ||= 'accepted'
+    end
+  end
+end

data/lib/canvas/models/section.rb

@@ -0,0 +1,11 @@
+module Canvas::Models
+  class Section < BaseModel
+    validates :sis_id, :course_sis_id, :name, presence: true
+    validates :status, inclusion: {in: %w(active deleted)}
+    attr_accessor :sis_id, :course_sis_id, :account_sis_id, :name, :status, :start_date, :end_date
+
+    def after_initialize
+      self.status ||= 'active'
+    end
+  end
+end

data/lib/canvas/models/term.rb

@@ -0,0 +1,11 @@
+module Canvas::Models
+  class Term < BaseModel
+    validates :sis_id, :name, presence: true
+    validates :status, inclusion: {in: %w(active deleted)}
+    attr_accessor :sis_id, :name, :status, :start_date, :end_date
+
+    def after_initialize
+      self.status ||= 'active'
+    end
+  end
+end

data/lib/canvas/models/user.rb

@@ -0,0 +1,11 @@
+module Canvas::Models
+  class User < BaseModel
+    validates :sis_id, :login_id, presence: true
+    validates :status, inclusion: {in: %w(active deleted)}
+    attr_accessor :sis_id, :login_id, :password, :first_name, :last_name, :email, :status, :avatar_url
+
+    def after_initialize
+      self.status ||= 'active'
+    end
+  end
+end

data/lib/canvas/models/user_observer.rb

@@ -0,0 +1,11 @@
+module Canvas::Models
+  class UserObserver < BaseModel
+    validates :observer_id, :student_id, presence: true
+    validates :status, inclusion: {in: %w(active deleted)}
+    attr_accessor :observer_id, :student_id, :status
+
+    def after_initialize
+      self.status ||= 'active'
+    end
+  end
+end

data/lib/canvas/models/x_list.rb

@@ -0,0 +1,11 @@
+module Canvas::Models
+  class XList < BaseModel
+    validates :section_sis_id, :xlist_course_sis_id, presence: true
+    validates :status, inclusion: {in: %w(active deleted)}
+    attr_accessor :xlist_course_sis_id, :section_sis_id, :status
+
+    def after_initialize
+      self.status ||= 'active'
+    end
+  end
+end

data/lib/canvas/utils/csv.rb

@@ -0,0 +1,38 @@
+require 'csv'
+
+module Canvas::Utils
+  class Csv
+
+    def self.hash_csv(csv_string)
+      CSV.parse(csv_string, {:headers => true, :return_headers => false, :header_converters => :symbol} )
+    end
+
+    def self.hash_csv_file(file_path)
+      CSV.read(file_path, {:headers => true, :return_headers => false, :header_converters => :symbol} )
+    end
+
+    def self.create_csv(models, headers)
+      CSV.generate do |csv|
+        csv << headers.map do |header|
+          header.instance_of?(Hash) ? header.values.first.to_s : header.to_s
+        end
+        models.each do |model|
+          csv << headers.map do |header|
+            const = header.instance_of?(Hash) ? header.keys.first : header
+            model.respond_to?(const) ? model.send(const) : nil
+          end
+        end
+      end
+    end
+
+    def self.unzip_csv(zip)
+      {}.tap do |h|
+        Zip::InputStream.open(StringIO.new(zip)) do |archive|
+          while entry = archive.get_next_entry
+            h[entry.name] = self.hash_csv(archive.read)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/canvas/utils/sis.rb

@@ -0,0 +1,71 @@
+require 'zip'
+
+module Canvas::Utils
+  class Sis
+    class << self
+      Headers = {
+        user: [{sis_id: 'user_id'}, :login_id, :password, :first_name, :last_name, :email, :status],
+        account: [{sis_id: 'account_id'}, {parent_sis_id: 'parent_account_id'}, :name, :status],
+        term: [{sis_id: 'term_id'}, :name, :status, :start_date, :end_date],
+        course: [{sis_id: 'course_id'}, :short_name, :long_name, {account_sis_id: 'account_id'}, {term_sis_id: 'term_id'}, :status, :start_date, :end_date],
+        section: [{sis_id: 'section_id'}, {course_sis_id: 'course_id'}, :name, :status, :start_date, :end_date, {account_sis_id: 'account_id'}],
+        enrollment: [{course_sis_id: 'course_id'}, {user_sis_id: 'user_id'}, :role, {section_sis_id: 'section_id'}, :status, {associated_user_sis_id: 'associated_user_id'}],
+        group: [{sis_id: 'group_id'}, {account_sis_id: 'account_id'}, :name, :status],
+        group_membership: [{group_sis_id: 'group_id'}, {user_sis_id: 'user_id'}, :status],
+        xlist: [{xlist_course_sis_id: 'xlist_course_id'}, {section_sis_id: 'section_id'}, :status],
+        user_observer: [:observer_id, :student_id, :status]
+      }
+
+      def create_csv(type, models)
+        Canvas::Utils::Csv.create_csv(models, Headers[type.to_sym])
+      end
+
+      def write_zip(filename, *models)
+        Zip::OutputStream.open(filename) {|zip| generate_zip_data zip, models }
+      end
+
+      def zip_string(*models)
+        stringIO = Zip::ZipOutputStream::write_buffer {|zip| generate_zip_data zip, models }
+        stringIO.rewind
+        stringIO.string.bytes.to_a.pack("C*")
+      end
+
+      def generate_zip_data(zip, models)
+        map_data(models).each do |key, value|
+          zip.put_next_entry("#{key}s.csv")
+          zip.write create_csv(key, value)
+        end
+      end
+
+      def map_data(data)
+        models = {}
+        data.flatten.each do |model|
+          case model
+            when Canvas::Models::Account
+              (models[:account] ||= []) << model
+            when Canvas::Models::Course
+              (models[:course] ||= []) << model
+            when Canvas::Models::Enrollment
+              (models[:enrollment] ||= []) << model
+            when Canvas::Models::Group
+              (models[:group] ||= []) << model
+            when Canvas::Models::GroupMembership
+              (models[:group_membership] ||= []) << model
+            when Canvas::Models::Section
+              (models[:section] ||= []) << model
+            when Canvas::Models::Term
+              (models[:term] ||= []) << model
+            when Canvas::Models::User
+              (models[:user] ||= []) << model
+            when Canvas::Models::XList
+              (models[:xlist] ||= []) << model
+            when Canvas::Models::UserObserver
+              (models[:user_observer] ||= []) << model
+          end
+        end
+        return models
+      end
+
+    end
+  end
+end

data/lib/integration_pal/engine.rb

@@ -1,6 +1,7 @@
 module IntegrationPal
   class Engine < ::Rails::Engine
     require 'api-auth'
+    require 'rack-cas'
     require 'rack-cas-rails'
     require 'attr_encrypted'
 

data/lib/integration_pal/version.rb

@@ -1,3 +1,3 @@
 module IntegrationPal
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: integration_pal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Cody Tanner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-26 00:00:00.000000000 Z
+date: 2017-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.1
+- !ruby/object:Gem::Dependency
+  name: httmultiparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.16
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +206,22 @@ files:
 - config/routes.rb
 - db/migrate/20170524203831_create_integration_pal_workers.rb
 - db/migrate/20170525153603_create_integration_pal_jobs.rb
+- lib/canvas/client.rb
+- lib/canvas/models/account.rb
+- lib/canvas/models/base_model.rb
+- lib/canvas/models/course.rb
+- lib/canvas/models/enrollment.rb
+- lib/canvas/models/file.rb
+- lib/canvas/models/folder.rb
+- lib/canvas/models/group.rb
+- lib/canvas/models/group_membership.rb
+- lib/canvas/models/section.rb
+- lib/canvas/models/term.rb
+- lib/canvas/models/user.rb
+- lib/canvas/models/user_observer.rb
+- lib/canvas/models/x_list.rb
+- lib/canvas/utils/csv.rb
+- lib/canvas/utils/sis.rb
 - lib/integration_pal.rb
 - lib/integration_pal/engine.rb
 - lib/integration_pal/version.rb
@@ -244,8 +274,6 @@ files:
 - spec/dummy/config/secrets.yml
 - spec/dummy/config/spring.rb
 - spec/dummy/db/schema.rb
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
 - spec/dummy/package.json
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -331,8 +359,6 @@ test_files:
 - spec/dummy/config/spring.rb
 - spec/dummy/config.ru
 - spec/dummy/db/schema.rb
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
 - spec/dummy/package.json
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html

data/spec/dummy/log/development.log

@@ -1,38 +0,0 @@
-   (21.9ms)  CREATE TABLE "schema_migrations" ("version" character varying NOT NULL PRIMARY KEY)
-   (4.3ms)  CREATE TABLE "ar_internal_metadata" ("key" character varying NOT NULL PRIMARY KEY, "value" character varying, "created_at" timestamp NOT NULL, "updated_at" timestamp NOT NULL)
-   (0.2ms)  SELECT pg_try_advisory_lock(3791006887383934680);
-   (1.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
-Migrating to CreateIntegrationPalWorkers (20170524203831)
-   (0.1ms)  BEGIN
-   (5.0ms)  CREATE TABLE "integration_pal_workers" ("id" bigserial primary key, "name" character varying, "access_id" character varying, "secret_key" character varying, "job_type" character varying, "encrypted_settings" text, "encrypted_settings_iv" character varying, "created_at" timestamp NOT NULL, "updated_at" timestamp NOT NULL)
-  SQL (0.3ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1) RETURNING "version"  [["version", "20170524203831"]]
-   (0.4ms)  COMMIT
-Migrating to CreateIntegrationPalJobs (20170525153603)
-   (0.2ms)  BEGIN
-   (6.3ms)  CREATE TABLE "integration_pal_jobs" ("id" bigserial primary key, "job_params" text, "status" character varying, "started_at" timestamp, "finished_at" timestamp, "progress" character varying, "worker_id" integer, "created_at" timestamp NOT NULL, "updated_at" timestamp NOT NULL)
-  SQL (0.4ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1) RETURNING "version"  [["version", "20170525153603"]]
-   (0.5ms)  COMMIT
-  ActiveRecord::InternalMetadata Load (1.9ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = $1 LIMIT $2  [["key", "environment"], ["LIMIT", 1]]
-   (0.2ms)  BEGIN
-  SQL (0.5ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES ($1, $2, $3, $4) RETURNING "key"  [["key", "environment"], ["value", "development"], ["created_at", "2017-05-25 21:27:34.579475"], ["updated_at", "2017-05-25 21:27:34.579475"]]
-   (0.4ms)  COMMIT
-   (0.3ms)  SELECT pg_advisory_unlock(3791006887383934680)
-   (0.2ms)  SELECT pg_try_advisory_lock(3791006887383934680);
-   (1.4ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
-  ActiveRecord::InternalMetadata Load (1.2ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = $1 LIMIT $2  [["key", "environment"], ["LIMIT", 1]]
-   (0.2ms)  BEGIN
-   (0.1ms)  COMMIT
-   (0.3ms)  SELECT pg_advisory_unlock(3791006887383934680)
-   (0.2ms)  SELECT pg_try_advisory_lock(3791006887383934680);
-   (0.8ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
-  ActiveRecord::InternalMetadata Load (0.6ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = $1 LIMIT $2  [["key", "environment"], ["LIMIT", 1]]
-   (0.1ms)  BEGIN
-   (0.1ms)  COMMIT
-   (0.2ms)  SELECT pg_advisory_unlock(3791006887383934680)
-   (0.2ms)  SELECT pg_try_advisory_lock(3791006887383934680);
-   (1.3ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
-  ActiveRecord::InternalMetadata Load (1.2ms)  SELECT  "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = $1 LIMIT $2  [["key", "environment"], ["LIMIT", 1]]
-   (0.1ms)  BEGIN
-   (0.1ms)  COMMIT
-   (0.2ms)  SELECT pg_advisory_unlock(3791006887383934680)
-   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC