mumuki-laboratory 7.5.0

data/config/i18n-tasks.yml

@@ -0,0 +1,98 @@
+# i18n-tasks finds and manages missing and unused translations: https://github.com/glebm/i18n-tasks
+
+# The "main" locale.
+base_locale: en
+## All available locales are inferred from the data by default. Alternatively, specify them explicitly:
+# locales: [es, fr]
+## Reporting locale, default: en. Available: en, ru.
+# internal_locale: en
+
+# Read and write translations.
+data:
+  ## Translations are read from the file system. Supported format: YAML, JSON.
+  ## Provide a custom adapter:
+  # adapter: I18n::Tasks::Data::FileSystem
+
+  # Locale files or `File.find` patterns where translations are read from:
+  read:
+    ## Default:
+    # - config/locales/%{locale}.yml
+    ## More files:
+    # - config/locales/**/*.%{locale}.yml
+    ## Another gem:
+    # - "<%= %x[bundle show vagrant].chomp %>/templates/locales/%{locale}.yml"
+
+  # Locale files to write new keys to, based on a list of key pattern => file rules. Matched from top to bottom:
+  # `i18n-tasks normalize -p` will force move the keys according to these rules
+  write:
+    - ['{expectation_}*', 'config/locales/expectations.%{locale}.yml']
+    - ['{:}.*', 'config/locales/\1.%{locale}.yml']
+    - 'config/locales/%{locale}.yml'
+
+  yaml:
+    write:
+      # do not wrap lines at 80 characters
+      line_width: -1
+
+  ## Pretty-print JSON:
+  # json:
+  #   write:
+  #     indent: '  '
+  #     space: ' '
+  #     object_nl: "\n"
+  #     array_nl: "\n"
+
+# Find translate calls
+search:
+  ## Paths or `File.find` patterns to search in:
+  # paths:
+  #  - app/
+
+  ## Root directories for relative keys resolution.
+  # relative_roots:
+  #   - app/views
+  #   - app/controllers
+  #   - app/helpers
+  #   - app/presenters
+
+  ## Files or `File.fnmatch` patterns to exclude from search. Some files are always excluded regardless of this setting:
+  ##   %w(*.jpg *.png *.gif *.svg *.ico *.eot *.otf *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less *.yml *.json)
+  exclude:
+    - app/assets/images
+    - app/assets/fonts
+
+  ## Alternatively, the only files or `File.fnmatch patterns` to search in `paths`:
+  ## If specified, this settings takes priority over `exclude`, but `exclude` still applies.
+  # include: ["*.rb", "*.html.slim"]
+
+  ## Default scanner finds t() and I18n.t() calls.
+  # scanner: I18n::Tasks::Scanners::PatternWithScopeScanner
+
+## Google Translate
+# translation:
+#   # Get an API key and set billing info at https://code.google.com/apis/console to use Google Translate
+#   api_key: "AbC-dEf5"
+
+## Do not consider these keys missing:
+# ignore_missing:
+# - 'errors.messages.{accepted,blank,invalid,too_short,too_long}'
+# - '{devise,simple_form}.*'
+
+## Consider these keys used:
+# ignore_unused:
+# - 'activerecord.attributes.*'
+# - '{devise,kaminari,will_paginate}.*'
+# - 'simple_form.{yes,no}'
+# - 'simple_form.{placeholders,hints,labels}.*'
+# - 'simple_form.{error_notification,required}.:'
+
+## Exclude these keys from the `i18n-tasks eq-base' report:
+# ignore_eq_base:
+#   all:
+#     - common.ok
+#   fr,es:
+#     - common.brand
+
+## Ignore these keys completely:
+# ignore:
+#  - kaminari.*

data/config/initializers/form_builder.rb

@@ -0,0 +1,7 @@
+include EditorHelper
+
+class ActionView::Helpers::FormBuilder
+  def editor(field, language = 'dynamic', options = {})
+    text_area field, editor_defaults(language, options, 'form-control editor')
+  end
+end

data/config/initializers/omniauth.rb

@@ -0,0 +1,5 @@
+OmniAuth.config.logger = Rails.logger
+
+Rails.application.config.middleware.use OmniAuth::Builder do
+  Mumukit::Login.configure_omniauth! self
+end

data/config/initializers/session_store.rb

@@ -0,0 +1 @@
+Rails.application.config.session_store :cookie_store, key: '_mumuki_laboratory_session', same_site: Mumukit::Login::Mucookie.cookie_same_site

data/config/routes.rb

@@ -0,0 +1,106 @@
+Rails.application.routes.draw do
+
+  Mumukit::Login.configure_login_routes! self
+
+  Mumukit::Platform.map_organization_routes!(self) do
+    root to: 'book#show'
+
+    concern :debatable do |options|
+      resources :discussions, options.merge(only: [:index, :show, :create, :update, :destroy]) do
+        post :subscription, on: :member
+        post :upvote, on: :member
+      end
+    end
+
+    concerns :debatable, controller: 'book_discussions', only: :index
+
+    resources :discussions, only: [] do
+      resources :messages, only: [:create, :destroy], controller: 'discussions_messages' do
+        post :approve, on: :member
+      end
+    end
+
+    resources :book, only: [:show]
+    resources :chapters, only: [:show] do
+      concerns :debatable, debatable_class: 'Chapter'
+      resource :appendix, only: :show
+    end
+
+    # All users
+    resources :exercises, only: :show do
+      # Current user
+      resources :confirmations, controller: 'exercise_confirmations', only: :create
+      resources :solutions, controller: 'exercise_solutions', only: :create
+      resources :queries, controller: 'exercise_query', only: :create
+      resources :tries, controller: 'exercise_tries', only: :create
+    end
+
+    resources :exercises, only: :show do
+      concerns :debatable, debatable_class: 'Exercise'
+    end
+
+    # All users
+    resources :guides, only: :show do
+      resource :progress, controller: 'guide_progress', only: :destroy
+    end
+
+    resources :lessons, only: :show do
+      concerns :debatable, debatable_class: 'Lesson'
+    end
+    resources :complements, only: :show
+    resources :exams, only: :show
+
+    # All users
+    resource :user, only: :show
+
+    # Current user
+    resources :messages, only: [:index, :create]
+    get '/messages/errors' => 'messages#errors'
+
+    # Routes by slug
+    get '/guides/:organization/:repository' => 'guides#show_transparently', as: :transparent_guide
+    get '/topics/:organization/:repository' => 'topics#show_transparently', as: :transparent_topic
+    get '/exercises/:organization/:repository/:bibliotheca_id' => 'exercises#show_transparently', as: :transparent_exercise
+
+    # Join to course
+    get '/join/:code' => 'invitations#show', as: :invitation
+    post '/join/:code' => 'invitations#join'
+
+    # Notification subscriptions
+    get '/user/unsubscribe' => 'users#unsubscribe'
+    put '/user' => 'users#update', as: :update_user
+
+    # Route for reading messages
+    post '/messages/read_messages/:exercise_id' => 'messages#read_messages', as: :read_messages
+
+    # Organizations assets
+    get '/theme_stylesheet'     => 'assets#theme_stylesheet'
+    get '/extension_javascript' => 'assets#extension_javascript'
+
+
+    namespace :api do
+      organization_regexp = Regexp.new Mumukit::Platform::Organization.valid_name_regex
+      uid_regexp = /[^\/]+/
+
+      resources :users, only: [:create, :update],  constraints: {id: uid_regexp}
+      resources :organizations,
+                    only: [:index, :show, :create, :update],
+                    constraints: {id: organization_regexp}
+
+      resources :courses, only: [:create]
+      constraints(uid: uid_regexp, organization: organization_regexp) do
+        '/courses/:organization/:course'.tap do |it|
+          post "#{it}/students" => 'students#create'
+          post "#{it}/students/:uid/attach" => 'students#attach'
+          post "#{it}/students/:uid/detach" => 'students#detach'
+          post "#{it}/teachers" => 'teachers#create'
+          post "#{it}/teachers/:uid/attach" => 'teachers#attach'
+          post "#{it}/teachers/:uid/detach" => 'teachers#detach'
+        end
+      end
+    end
+  end
+
+  #Rescue not found routes
+  get '*not_found', to: 'application#not_found'
+end

data/lib/mumuki/laboratory.rb

@@ -0,0 +1,48 @@
+require 'mumukit/core'
+
+I18n.load_translations_path File.join(__dir__, 'laboratory', 'locales', '*.yml')
+
+
+module Mumuki
+  module Laboratory
+  end
+end
+
+require 'mumuki/domain'
+require 'mumukit/login'
+require 'mumukit/nuntius'
+require 'mumukit/platform'
+
+require 'kaminari'
+require 'bootstrap-kaminari-views'
+
+Mumukit::Nuntius.configure do |config|
+  config.app_name = 'laboratory'
+end
+
+Mumukit::Platform.configure do |config|
+  config.application = Mumukit::Platform.laboratory
+  config.web_framework = Mumukit::Platform::WebFramework::Rails
+end
+
+class Mumuki::Laboratory::Engine < ::Rails::Engine
+  config.i18n.available_locales = Mumukit::Platform::Locale.supported
+end
+
+module Mumukit::Platform::OrganizationMapping::Path
+  class << self
+    patch :organization_name do |request, domain, hyper|
+      name = hyper.(request, domain)
+      if %w(auth login logout).include? name
+        'central'
+      else
+        name
+      end
+    end
+  end
+end
+
+require_relative './laboratory/version'
+require_relative './laboratory/extensions'
+require_relative './laboratory/controllers'
+require_relative './laboratory/engine'

data/lib/mumuki/laboratory/controllers.rb

@@ -0,0 +1,13 @@
+module Mumuki::Laboratory::Controllers
+end
+
+require_relative './controllers/authorization'
+require_relative './controllers/disabling'
+require_relative './controllers/current_organization'
+require_relative './controllers/dynamic_errors'
+require_relative './controllers/notifications'
+require_relative './controllers/embedded_mode'
+require_relative './controllers/nested_in_exercise'
+require_relative './controllers/results_rendering'
+require_relative './controllers/exercise_seed'
+require_relative './controllers/content'

data/lib/mumuki/laboratory/controllers/authorization.rb

@@ -0,0 +1,10 @@
+module Mumuki::Laboratory::Controllers::Authorization
+  def authorize_if_private!
+    return if Organization.current.public? || from_sessions?
+    authorize! :student
+  end
+
+  def authorization_slug
+    Organization.current.slug
+  end
+end

data/lib/mumuki/laboratory/controllers/content.rb

@@ -0,0 +1,12 @@
+module Mumuki::Laboratory::Controllers::Content
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :validate_used_here!, only: :show
+  end
+
+  # ensures contents are in current organization's path
+  def validate_used_here! #TODO refactor subject logic (e.g. we can't move validate_accessible! here because ExerciseSolutionsController does not declare a subject)
+    raise Mumuki::Domain::NotFoundError unless subject&.used_in?(Organization.current)
+  end
+end

data/lib/mumuki/laboratory/controllers/current_organization.rb

@@ -0,0 +1,16 @@
+module Mumuki::Laboratory::Controllers::CurrentOrganization
+  def set_current_organization!
+    Organization.find_by!(name: organization_name).switch!
+  rescue => e
+    Organization.central.switch!
+    raise e
+  end
+
+  def organization_name
+    Mumukit::Platform.organization_name(request)
+  end
+
+  def visit_organization!
+    current_user.visit!(Organization.current)
+  end
+end

data/lib/mumuki/laboratory/controllers/disabling.rb

@@ -0,0 +1,5 @@
+module Mumuki::Laboratory::Controllers::Disabling
+  def ensure_user_enabled!
+    current_user.ensure_enabled! unless from_sessions?
+  end
+end

data/lib/mumuki/laboratory/controllers/dynamic_errors.rb

@@ -0,0 +1,74 @@
+module Mumuki::Laboratory::Controllers::DynamicErrors
+  extend ActiveSupport::Concern
+
+  included do
+    unless Rails.application.config.consider_all_requests_local
+      rescue_from Exception, with: :internal_server_error
+      rescue_from ActionController::RoutingError, with: :not_found
+    end
+    rescue_from ActiveRecord::RecordNotFound, with: :not_found
+    rescue_from Mumukit::Auth::UnauthorizedAccessError, with: :forbidden
+    rescue_from Mumukit::Auth::InvalidTokenError, with: :unauthorized
+    rescue_from Mumuki::Domain::NotFoundError, with: :not_found
+    rescue_from Mumuki::Domain::ForbiddenError, with: :forbidden
+    rescue_from Mumuki::Domain::UnauthorizedError, with: :unauthorized
+    rescue_from Mumuki::Domain::GoneError, with: :gone
+    rescue_from Mumuki::Domain::BlockedForumError, with: :blocked_forum
+    rescue_from Mumuki::Domain::DisabledError, with: :disabled
+    rescue_from ActiveRecord::RecordInvalid, with: :bad_record
+  end
+
+  def bad_record(exception)
+    # bad records can only be produced thourgh API
+    render_api_errors exception.record.errors, 400
+  end
+
+  def not_found
+    render_error 'not_found', 404, formats: [:html]
+  end
+
+  def internal_server_error(exception)
+    Rails.logger.error "Internal server error: #{exception} \n#{exception.backtrace.join("\n")}"
+    render_error 'internal_server_error', 500
+  end
+
+  def unauthorized(exception)
+    render_error 'unauthorized', 401, error_message: exception.message
+  end
+
+  def forbidden
+    message = "The operation on organization #{Organization.current} was forbidden to user #{current_user.uid} with permissions #{current_user.permissions}"
+    Rails.logger.info message
+    render_error 'forbidden', 403, locals: { explanation: :forbidden_explanation }, error_message: message
+  end
+
+  def disabled
+    render_error 'forbidden', 403, locals: { explanation: :disabled_explanation }
+  end
+
+  def blocked_forum
+    render_error 'forbidden', 403, locals: { explanation: :blocked_forum_explanation }
+  end
+
+  def gone
+    render_error 'gone', 410
+  end
+
+  def render_error(template, status, options={})
+    if Mumukit::Platform.organization_mapping.path_under_namespace? Mumukit::Platform.current_organization_name, request.path, 'api'
+      render_api_errors [options[:error_message] || template.gsub('_', ' ')], status
+    else
+      render_app_errors template, options.merge(status: status).except(:error_message)
+    end
+  end
+
+  private
+
+  def render_app_errors(template, options)
+    render "errors/#{template}", options
+  end
+
+  def render_api_errors(errors, status)
+    render json: { errors: errors }, status: status
+  end
+end

data/lib/mumuki/laboratory/controllers/embedded_mode.rb

@@ -0,0 +1,45 @@
+# This mixin provides support for implementing the
+# embedded mode - as opposed to the standalone mode -in which
+# the mumuki pages
+#
+#  * are displayed used a simplified layout, called `embedded.html.erb`
+#  * are served using `X-Frame-Options` that allow them to be used within
+#    an iframe
+#
+# Not all organizations can be emedded - only those that have the `embeddable?`
+# setting set.
+#
+# This mixin provides two sets of methods:
+#
+# * `embedded_mode?` / `standalone_mode?`, which are helpers aimed to be used by views
+#    and change very specific rendering details in one or the other mode
+# *  `enable_embedded_rendering`, which is designed to be called from main-views controller-methods that
+#     actually support embedded mode.
+module Mumuki::Laboratory::Controllers::EmbeddedMode
+  extend ActiveSupport::Concern
+
+  included do
+    helper_method :embedded_mode?,
+                  :standalone_mode?
+  end
+
+  def embedded_mode?
+    @embedded_mode ||= params[:embed] == 'true' && Organization.current.embeddable?
+  end
+
+  def standalone_mode?
+    !embedded_mode?
+  end
+
+  def enable_embedded_rendering
+    return unless embedded_mode?
+    allow_parent_iframe!
+    render layout: 'embedded'
+  end
+
+  private
+
+  def allow_parent_iframe!
+    response.delete_header 'X-Frame-Options'
+  end
+end