sis_core 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c29d73de70fc5e92e4a2baf75b7637f66b15f0395472700be1a3e95ed553d199
+  data.tar.gz: 229c654db2906234a28159fe5fbe2efac479d1fe35ca5aacdf4922238574bbc9
+SHA512:
+  metadata.gz: 7a7f8a28687b32e2a1816c96d6a5292e92a74764a3092ccd892fb045bf3c0ff1f4c07e096b52fc9335117435789fd8e1073090815f4834b3804660bfc8b1e73a
+  data.tar.gz: db2706e8aefa17e8c3dedc7fd0cb707d7b2e6d702df06b4279d4e2c88514b00b1ec1b21afdf3e4c20852de25e905cec7fe31caebdd93870b92b4d8f02772d8c6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Henock L.
+
+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,28 @@
+# SisCore
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sis_core'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install sis_core
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SisCore'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')

data/app/controllers/sis/core/application_controller.rb

@@ -0,0 +1,7 @@
+module Sis
+  module Core
+    class ApplicationController < ActionController::Base
+      protect_from_forgery with: :exception
+    end
+  end
+end

data/app/models/sis/core/applicant.rb

@@ -0,0 +1,8 @@
+module Sis
+  module Core
+    class Applicant < ApplicationRecord
+      validates :first_name, :middle_name, :last_name, :email, :phone_number, presence: true
+      validates :email, uniqueness: true
+    end
+  end
+end

data/app/models/sis/core/application_record.rb

@@ -0,0 +1,7 @@
+module Sis
+  module Core
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/app/models/sis/core/attached_document.rb

@@ -0,0 +1,8 @@
+module Sis
+  module Core
+    class AttachedDocument < ApplicationRecord
+      validates :document, :document_type, presence: true
+      belongs_to :enrollment_application, class_name: 'Sis::Core::EnrollmentApplication'
+    end
+  end
+end

data/app/models/sis/core/enrollment_application.rb

@@ -0,0 +1,9 @@
+module Sis
+  module Core
+    class EnrollmentApplication < ApplicationRecord
+      validates :status, presence: true
+      belongs_to :applicant, class_name: 'Sis::Core::Applicant'
+      belongs_to :program, class_name: 'Sis::Core::Program'
+    end
+  end
+end

data/app/models/sis/core/field_of_study.rb

@@ -0,0 +1,9 @@
+module Sis
+  module Core
+    class FieldOfStudy < ApplicationRecord
+      belongs_to :program_type, class_name: 'Sis::Core::ProgramType', foreign_key: 'lookup_id'
+      validates :name, presence: true
+      validates :name, uniqueness: { case_sensitive: true }
+    end
+  end
+end

data/app/models/sis/core/lookup.rb

@@ -0,0 +1,8 @@
+module Sis
+  module Core
+    class Lookup < ApplicationRecord
+      validates :name, :type, presence: true
+      validates :name, uniqueness: { scope: :type }
+    end
+  end
+end

data/app/models/sis/core/program.rb

@@ -0,0 +1,9 @@
+module Sis
+  module Core
+    class Program < ApplicationRecord
+      belongs_to :program_type, class_name: 'Sis::Core::ProgramType', foreign_key: 'lookup_id'
+      belongs_to :field_of_study, class_name: 'Sis::Core::FieldOfStudy'
+      validates :mode_of_attendance, presence: true
+    end
+  end
+end

data/app/models/sis/core/program_type.rb

@@ -0,0 +1,6 @@
+module Sis
+  module Core
+    class ProgramType < Lookup
+    end
+  end
+end

data/app/models/user.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class User < ActiveRecord::Base
+  # Include default devise modules. Others available are:
+  # :confirmable, :lockable, :timeoutable and :omniauthable
+  devise :database_authenticatable, :registerable,
+         :recoverable, :rememberable, :trackable, :validatable
+  include DeviseTokenAuth::Concerns::User
+end

data/config/database.ci.yml

@@ -0,0 +1,12 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  pool: 5
+  timeout: 5000
+  host: <%= ENV['DB_HOST'] %>
+  username: <%= ENV['POSTGRES_USER'] %>
+  password: <%= ENV['POSTGRES_PASSWORD'] %>
+  database: <%= ENV['POSTGRES_DB'] %>
+
+test:
+  <<: *default

data/config/initializers/devise_token_auth.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+DeviseTokenAuth.setup do |config|
+  # By default the authorization headers will change after each request. The
+  # client is responsible for keeping track of the changing tokens. Change
+  # this to false to prevent the Authorization header from changing after
+  # each request.
+  # config.change_headers_on_each_request = true
+
+  # By default, users will need to re-authenticate after 2 weeks. This setting
+  # determines how long tokens will remain valid after they are issued.
+  # config.token_lifespan = 2.weeks
+
+  # Limiting the token_cost to just 4 in testing will increase the performance of
+  # your test suite dramatically. The possible cost value is within range from 4
+  # to 31. It is recommended to not use a value more than 10 in other environments.
+  config.token_cost = Rails.env.test? ? 4 : 10
+
+  # Sets the max number of concurrent devices per user, which is 10 by default.
+  # After this limit is reached, the oldest tokens will be removed.
+  # config.max_number_of_devices = 10
+
+  # Sometimes it's necessary to make several requests to the API at the same
+  # time. In this case, each request in the batch will need to share the same
+  # auth token. This setting determines how far apart the requests can be while
+  # still using the same auth token.
+  # config.batch_request_buffer_throttle = 5.seconds
+
+  # This route will be the prefix for all oauth2 redirect callbacks. For
+  # example, using the default '/omniauth', the github oauth2 provider will
+  # redirect successful authentications to '/omniauth/github/callback'
+  # config.omniauth_prefix = "/omniauth"
+
+  # By default sending current password is not needed for the password update.
+  # Uncomment to enforce current_password param to be checked before all
+  # attribute updates. Set it to :password if you want it to be checked only if
+  # password is updated.
+  # config.check_current_password_before_update = :attributes
+
+  # By default we will use callbacks for single omniauth.
+  # It depends on fields like email, provider and uid.
+  # config.default_callbacks = true
+
+  # Makes it possible to change the headers names
+  # config.headers_names = {:'access-token' => 'access-token',
+  #                        :'client' => 'client',
+  #                        :'expiry' => 'expiry',
+  #                        :'uid' => 'uid',
+  #                        :'token-type' => 'token-type' }
+
+  # By default, only Bearer Token authentication is implemented out of the box.
+  # If, however, you wish to integrate with legacy Devise authentication, you can
+  # do so by enabling this flag. NOTE: This feature is highly experimental!
+  # config.enable_standard_devise_support = false
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Sis::Core::Engine.routes.draw do
+end

data/db/migrate/20200105061717_create_sis_core_lookups.rb

@@ -0,0 +1,12 @@
+class CreateSisCoreLookups < ActiveRecord::Migration[6.0]
+  def change
+    create_table :sis_core_lookups do |t|
+      t.string :name, null: false
+      t.string :type, null: false
+
+      t.timestamps
+    end
+
+    add_index :sis_core_lookups, %i[name type], unique: true
+  end
+end

data/db/migrate/20200106001016_create_sis_core_field_of_studies.rb

@@ -0,0 +1,9 @@
+class CreateSisCoreFieldOfStudies < ActiveRecord::Migration[6.0]
+  def change
+    create_table :sis_core_field_of_studies do |t|
+      t.string :name
+      t.references :lookup, index: true, null: false, foreign_key: { to_table: :sis_core_lookups }
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200106130428_create_sis_core_programs.rb

@@ -0,0 +1,10 @@
+class CreateSisCorePrograms < ActiveRecord::Migration[6.0]
+  def change
+    create_table :sis_core_programs do |t|
+      t.string :mode_of_attendance, null: false
+      t.references :lookup, index: true, null: false, foreign_key: { to_table: :sis_core_lookups }
+      t.references :field_of_study, index: true, null: false, foreign_key: { to_table: :sis_core_field_of_studies }
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200106133937_create_sis_core_applicants.rb

@@ -0,0 +1,13 @@
+class CreateSisCoreApplicants < ActiveRecord::Migration[6.0]
+  def change
+    create_table :sis_core_applicants do |t|
+      t.string :first_name, null: false
+      t.string :middle_name, null: false
+      t.string :last_name, null: false
+      t.string :email, null: false, unique: true
+      t.string :phone_number, null: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200108092202_devise_token_auth_create_users.rb

@@ -0,0 +1,53 @@
+class DeviseTokenAuthCreateUsers < ActiveRecord::Migration[6.0]
+  def change
+    create_table(:users) do |t|
+      ## Required
+      t.string :provider, null: false, default: 'email'
+      t.string :uid, null: false, default: ''
+
+      ## Database authenticatable
+      t.string :encrypted_password, null: false, default: ''
+
+      ## Recoverable
+      t.string   :reset_password_token
+      t.datetime :reset_password_sent_at
+      t.boolean  :allow_password_change, default: false
+
+      ## Rememberable
+      t.datetime :remember_created_at
+
+      ## Confirmable
+      t.string   :confirmation_token
+      t.datetime :confirmed_at
+      t.datetime :confirmation_sent_at
+      t.string   :unconfirmed_email # Only if using reconfirmable
+      ## Trackable
+      t.integer  :sign_in_count, default: 0, null: false
+      t.datetime :current_sign_in_at
+      t.datetime :last_sign_in_at
+      t.string     :current_sign_in_ip
+      t.string     :last_sign_in_ip
+      ## Lockable
+      # t.integer  :failed_attempts, :default => 0, :null => false # Only if lock strategy is :failed_attempts
+      # t.string   :unlock_token # Only if unlock strategy is :email or :both
+      # t.datetime :locked_at
+
+      ## User Info
+      t.string :name
+      t.string :nickname
+      t.string :image
+      t.string :email
+
+      ## Tokens
+      t.text :tokens
+
+      t.timestamps
+    end
+
+    add_index :users, :email,                unique: true
+    add_index :users, %i[uid provider],      unique: true
+    add_index :users, :reset_password_token, unique: true
+    add_index :users, :confirmation_token,   unique: true
+    # add_index :users, :unlock_token,       unique: true
+  end
+end

data/db/migrate/20200108094449_create_sis_core_enrollment_applications.rb

@@ -0,0 +1,10 @@
+class CreateSisCoreEnrollmentApplications < ActiveRecord::Migration[6.0]
+  def change
+    create_table :sis_core_enrollment_applications do |t|
+      t.string :status, null: false
+      t.references :applicant, index: true, null: false, foreign_key: { to_table: :sis_core_applicants }
+      t.references :program, index: true, null: false, foreign_key: { to_table: :sis_core_programs }
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200108101638_create_sis_core_attached_documents.rb

@@ -0,0 +1,11 @@
+class CreateSisCoreAttachedDocuments < ActiveRecord::Migration[6.0]
+  def change
+    create_table :sis_core_attached_documents do |t|
+      t.string :document, null: false
+      t.string :document_type, null: false
+      t.references :enrollment_application, index: true, null: false,
+                                            foreign_key: { to_table: :sis_core_enrollment_applications }
+      t.timestamps
+    end
+  end
+end

data/lib/sis/core/engine.rb

@@ -0,0 +1,25 @@
+module Sis
+  module Core
+    class Engine < ::Rails::Engine
+      isolate_namespace Sis::Core
+
+      config.generators.api_only = true
+
+      config.generators do |g|
+        g.test_framework :rspec
+        g.fixture_replacement :factory_bot
+        g.factory_bot dir: 'spec/factories'
+      end
+
+      initializer 'sis_core.factories', after: 'factory_bot.set_factory_paths' do
+        FactoryBot.definition_file_paths << File.expand_path('../../../spec/factories', __dir__) if defined?(FactoryBot)
+      end
+
+      initializer :append_migrations do |app|
+        unless app.root.to_s.match(root.to_s + File::SEPARATOR)
+          app.config.paths['db/migrate'].concat(config.paths['db/migrate'].expanded)
+        end
+      end
+    end
+  end
+end

data/lib/sis/core/version.rb

@@ -0,0 +1,5 @@
+module Sis
+  module Core
+    VERSION = '1.0.0'.freeze
+  end
+end

data/lib/sis/core.rb

@@ -0,0 +1,4 @@
+module Sis
+  module Core
+  end
+end

data/lib/sis_core.rb

@@ -0,0 +1,2 @@
+require 'sis/core'
+require 'sis/core/engine'

data/lib/tasks/sis_core_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sis_core do
+#   # Task goes here
+# end

data/spec/factories/sis/core/applicants.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :applicant, class: 'Sis::Core::Applicant' do
+    first_name { FFaker::Name.name }
+    middle_name { FFaker::Name.name }
+    last_name { FFaker::Name.name }
+    email { FFaker::Internet.email }
+    phone_number { FFaker::PhoneNumber.phone_number }
+  end
+end

data/spec/factories/sis/core/attached_documents.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :attached_document, class: 'Sis::Core::AttachedDocument' do
+    document { FFaker::Name.name }
+    document_type { FFaker::Name.name }
+    association :enrollment_application
+  end
+end

data/spec/factories/sis/core/enrollment_applications.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :enrollment_application, class: 'Sis::Core::EnrollmentApplication' do
+    status { FFaker::Name.name }
+    association :applicant
+    association :program
+  end
+end

data/spec/factories/sis/core/field_of_studies.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :field_of_study, class: 'Sis::Core::FieldOfStudy' do
+    name { FFaker::Name.name }
+    association :program_type
+  end
+end

data/spec/factories/sis/core/lookups.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :lookup, class: 'Sis::Core::Lookup' do
+    name { FFaker::Name.name }
+    type { 'Sis::Core::Lookup' }
+  end
+end

data/spec/factories/sis/core/program_types.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :program_type, class: 'Sis::Core::ProgramType', parent: :lookup do
+    type { 'Sis::Core::ProgramType' }
+  end
+end

data/spec/factories/sis/core/programs.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :program, class: 'Sis::Core::Program' do
+    mode_of_attendance { FFaker::Name.name }
+    association :program_type
+    association :field_of_study
+  end
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: sis_core
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Henock L.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  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: ffaker
+  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: rspec-rails
+  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: shoulda-matchers
+  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: simplecov
+  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: sqlite3
+  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'
+description: An engine which contains the core of the student information system app
+  as a layer.
+email:
+- henockl@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/sis/core/application_controller.rb
+- app/models/sis/core/applicant.rb
+- app/models/sis/core/application_record.rb
+- app/models/sis/core/attached_document.rb
+- app/models/sis/core/enrollment_application.rb
+- app/models/sis/core/field_of_study.rb
+- app/models/sis/core/lookup.rb
+- app/models/sis/core/program.rb
+- app/models/sis/core/program_type.rb
+- app/models/user.rb
+- config/database.ci.yml
+- config/initializers/devise_token_auth.rb
+- config/routes.rb
+- db/migrate/20200105061717_create_sis_core_lookups.rb
+- db/migrate/20200106001016_create_sis_core_field_of_studies.rb
+- db/migrate/20200106130428_create_sis_core_programs.rb
+- db/migrate/20200106133937_create_sis_core_applicants.rb
+- db/migrate/20200108092202_devise_token_auth_create_users.rb
+- db/migrate/20200108094449_create_sis_core_enrollment_applications.rb
+- db/migrate/20200108101638_create_sis_core_attached_documents.rb
+- lib/sis/core.rb
+- lib/sis/core/engine.rb
+- lib/sis/core/version.rb
+- lib/sis_core.rb
+- lib/tasks/sis_core_tasks.rake
+- spec/factories/sis/core/applicants.rb
+- spec/factories/sis/core/attached_documents.rb
+- spec/factories/sis/core/enrollment_applications.rb
+- spec/factories/sis/core/field_of_studies.rb
+- spec/factories/sis/core/lookups.rb
+- spec/factories/sis/core/program_types.rb
+- spec/factories/sis/core/programs.rb
+homepage: http://www.mks.com.et
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Core engine for student information system application.
+test_files: []