lcms-engine 0.3.0 → 0.4.0

data/app/controllers/lcms/engine/admin/materials_controller.rb

@@ -5,39 +5,35 @@ module Lcms
     module Admin
       class MaterialsController < AdminController
         include Lcms::Engine::GoogleCredentials
+        include Lcms::Engine::PathHelper
         include Reimportable
 
         before_action :find_selected, only: %i(destroy_selected reimport_selected)
+        before_action :set_query_params
 
         def index
-          @query = OpenStruct.new params[:query]
+          @query = OpenStruct.new @query_params # rubocop:disable Style/OpenStructUse
           @materials = DocTemplate.config['queries']['material'].constantize.call(@query, page: params[:page])
           render_customized_view
         end
 
         def create
-          @material_form = DocumentGenerator.material_form.new(form_params)
+          @material_form = DocumentGenerator.material_form.new(form_params.except(:async))
 
-          return create_from_folder if form_params[:link].match?(RE_GOOGLE_FOLDER)
+          return create_multiple if form_params[:link].match?(RE_GOOGLE_FOLDER)
 
-          if @material_form.save
-            material = @material_form.material
-            redirect_to AdminController.material_path(material),
-                        notice: t('.success', name: material.name)
-          else
-            render :new
-          end
+          form_params[:async].to_i.zero? ? create_sync : create_async
         end
 
         def destroy
           material = Material.find(params[:id])
           material.destroy
-          redirect_to admin_materials_path(query: params[:query]), notice: t('.success')
+          redirect_to lcms_engine.admin_materials_path(query: @query_params), notice: t('.success')
         end
 
         def destroy_selected
           count = @materials.destroy_all.count
-          redirect_to admin_materials_path(query: params[:query]), notice: t('.success', count: count)
+          redirect_to lcms_engine.admin_materials_path(query: @query_params), notice: t('.success', count: count)
         end
 
         def import_status
@@ -56,6 +52,21 @@ module Lcms
 
         private
 
+        def create_async
+          bulk_import(Array.wrap(form_params[:link]))
+          render :import
+        end
+
+        def create_sync
+          if @material_form.save
+            material = @material_form.material
+            redirect_to dynamic_material_path(material),
+                        notice: t('lcms.engine.admin.materials.create.success', name: material.name)
+          else
+            render :new
+          end
+        end
+
         def bulk_import(files)
           jobs = {}
           files.each do |url|
@@ -73,7 +84,7 @@ module Lcms
         end
 
         def form_params
-          params.require(:material_form).permit(:link, :source_type)
+          params.require(:material_form).permit(:async, :link, :source_type)
         end
 
         def gdoc_files_from(url)
@@ -89,6 +100,14 @@ module Lcms
               .map { |id| ::Lt::Lcms::Lesson::Downloader::Gdoc.gdoc_file_url(id) }
           end
         end
+
+        def set_query_params
+          @query_params = params[:query]
+            &.permit(
+              :course, :lesson, :name_date, :orientation, :search_term, :search_file_name, :sort_by, :title, :type,
+              :unit
+            ) || {}
+        end
       end
     end
   end

data/app/controllers/lcms/engine/admin/resource_bulk_edits_controller.rb

@@ -10,7 +10,7 @@ module Lcms
           if @resources.any?
             @resource = BulkEditResourcesService.new(@resources).init_sample
           else
-            redirect_to :admin_resources, alert: t('.no_resources')
+            redirect_to lcms_engine.admin_resources_path, alert: t('.no_resources')
           end
         end
 
@@ -18,7 +18,7 @@ module Lcms
           BulkEditResourcesService.new(@resources, resource_params).edit!
           resources_count_msg = t(:resources_count, count: @resources.count)
           notice = t('.success', count: @resources.count, resources_count: resources_count_msg)
-          redirect_to :admin_resources, notice: notice
+          redirect_to lcms_engine.admin_resources_path, notice: notice
         end
 
         private

data/app/controllers/lcms/engine/admin/resources_controller.rb

@@ -4,6 +4,8 @@ module Lcms
   module Engine
     module Admin
       class ResourcesController < AdminController
+        include Lcms::Engine::ViewHelper
+
         CREATE_TAG_KEYS = %i(new_topic_names new_tag_names new_content_source_names
                              new_standard_names).freeze
         CREATE_TAG_METHODS = {
@@ -30,7 +32,7 @@ module Lcms
 
           if @resource.save
             create_tags
-            redirect_to :admin_resources, notice: t('.success', resource_id: @resource.id)
+            redirect_to lcms_engine.admin_resources_path, notice: t('.success', resource_id: @resource.id)
           else
             render :new
           end
@@ -50,17 +52,17 @@ module Lcms
         end
 
         def bundle
-          return redirect_to :admin_resources, notice: t('.fail') unless can_bundle?(@resource)
+          return redirect_to lcms_engine.admin_resources_path, notice: t('.fail') unless can_bundle?(@resource)
 
           # see settings loaded via `lcms.yml`
           generator = DocTemplate.config.dig('bundles', @resource.curriculum_type).constantize
           generator.perform(@resource)
-          redirect_to :admin_resources, notice: t('.success')
+          redirect_to lcms_engine.admin_resources_path, notice: t('.success')
         end
 
         def update
           unless Settings[:editing_enabled]
-            return redirect_to(:admin_resources, alert: t('admin.common.editing_disabled'))
+            return redirect_to(lcms_engine.admin_resources_path, alert: t('admin.common.editing_disabled'))
           end
 
           create_tags
@@ -69,8 +71,8 @@ module Lcms
             resource_params[:standard_ids] << std.id
           end
 
-          if @resource.update_attributes(resource_params)
-            redirect_to :admin_resources, notice: t('.success', resource_id: @resource.id)
+          if @resource.update(resource_params)
+            redirect_to lcms_engine.admin_resources_path, notice: t('.success', resource_id: @resource.id)
           else
             render :edit
           end
@@ -78,7 +80,7 @@ module Lcms
 
         def destroy
           @resource.destroy
-          redirect_to :admin_resources, notice: t('.success', resource_id: @resource.id)
+          redirect_to lcms_engine.admin_resources_path, notice: t('.success', resource_id: @resource.id)
         end
 
         protected

data/app/controllers/lcms/engine/admin/settings_controller.rb

@@ -7,7 +7,7 @@ module Lcms
         def toggle_editing_enabled
           Settings[:editing_enabled] = !Settings[:editing_enabled]
           notice = Settings[:editing_enabled] ? t('.enabled') : t('.disabled')
-          redirect_to :admin_resources, notice: notice
+          redirect_to lcms_engine.admin_resources_path, notice: notice
         end
       end
     end

data/app/controllers/lcms/engine/admin/standards_controller.rb

@@ -5,11 +5,12 @@ module Lcms
     module Admin
       class StandardsController < AdminController
         before_action :find_standard, except: [:index]
+        before_action :set_query_params
 
         def edit; end
 
         def index
-          @query = OpenStruct.new params[:query]
+          @query = OpenStruct.new @query_params # rubocop:disable Style/OpenStructUse
 
           scope = Standard.order(:id)
           scope = scope.search_by_name(@query.name) if @query.name.present?
@@ -19,7 +20,7 @@ module Lcms
 
         def update
           if @standard.update(standard_params)
-            redirect_to admin_standards_path, notice: t('.success')
+            redirect_to lcms_engine.admin_standards_path, notice: t('.success')
           else
             render :edit
           end
@@ -31,6 +32,10 @@ module Lcms
           @standard = Standard.find(params[:id])
         end
 
+        def set_query_params
+          @query_params = params[:query]&.permit(:name) || {}
+        end
+
         def standard_params
           params.require(:standard).permit(:description)
         end

data/app/controllers/lcms/engine/admin/users_controller.rb

@@ -5,9 +5,10 @@ module Lcms
     module Admin
       class UsersController < AdminController
         before_action :find_user, except: %i(index new create)
+        before_action :set_query_params
 
         def index
-          @query = OpenStruct.new(params[:query])
+          @query = OpenStruct.new @query_params # rubocop:disable Style/OpenStructUse
           @users = users(@query)
         end
 
@@ -20,30 +21,33 @@ module Lcms
           @user.generate_password
           if @user.save
             @user.send_reset_password_instructions
-            redirect_to(:admin_users, notice: t('.success', user: @user.email))
+            redirect_to lcms_engine.admin_users_path, notice: t('.success', user: @user.email)
           else
             render :new
           end
         end
 
-        def edit; end
+        def edit
+          @url = lcms_engine.admin_user_path(@user)
+        end
 
         def update
-          if @user.update_attributes(user_params)
-            redirect_to edit_admin_user_path(@user), notice: t('.success', user: @user.email)
+          if @user.update(user_params)
+            redirect_to lcms_engine.admin_users_path, notice: t('.success', user: @user.email)
           else
+            @url = lcms_engine.admin_user_path(@user)
             render :edit
           end
         end
 
         def destroy
           @user.destroy
-          redirect_to :admin_users, notice: t('.success')
+          redirect_to lcms_engine.admin_users_path, notice: t('.success')
         end
 
         def reset_password
           @user.send_reset_password_instructions
-          redirect_to :admin_users, notice: t('.success')
+          redirect_to lcms_engine.admin_users_path, notice: t('.success')
         end
 
         private
@@ -52,6 +56,10 @@ module Lcms
           @user = User.find(params[:id])
         end
 
+        def set_query_params
+          @query_params = params[:query]&.permit(:access_code, :email) || {}
+        end
+
         def user_params
           params.require(:user).permit(:access_code, :email, :name, :role)
         end

data/app/controllers/lcms/engine/application_controller.rb

@@ -21,7 +21,7 @@ module Lcms
       # Raise translation missing errors in controllers too
       def t(key, options = {})
         options[:raise] = true
-        translate(key, options)
+        translate(key, **options)
       end
 
       def check_user_has_survey_filled_in

data/app/controllers/lcms/engine/resources_controller.rb

@@ -7,13 +7,13 @@ module Lcms
         @resource = find_resource
 
         # redirect to document if resource has it (#161)
-        return redirect_to document_path(@resource.document) if @resource.document?
+        return redirect_to dynamic_document_path(@resource.document) if @resource.document?
 
         # redirect grade and module to explore_curriculum (#122)
-        return redirect_to explore_curriculum_index_path(p: @resource.slug, e: 1) if grade_or_module?
+        return redirect_to lcms_engine.explore_curriculum_index_path(p: @resource.slug, e: 1) if grade_or_module?
 
         # redirect to the path with slug if we are using just the id
-        return redirect_to show_with_slug_path(@resource.slug), status: 301 if using_id?
+        return redirect_to lcms_engine.show_with_slug_path(@resource.slug), status: 301 if using_id?
 
         @related_instructions = related_instructions
         @props = CurriculumMap.new(@resource).props
@@ -27,14 +27,14 @@ module Lcms
 
       def media
         resource = Resource.find(params[:id])
-        return redirect_to resource_path(resource) unless resource.media?
+        return redirect_to lcms_engine.resource_path(resource) unless resource.media?
 
         @resource = MediaPresenter.new(resource)
       end
 
       def generic
         resource = Resource.find(params[:id])
-        return redirect_to resource_path(resource) unless resource.generic?
+        return redirect_to lcms_engine.resource_path(resource) unless resource.generic?
 
         @resource = GenericPresenter.new(resource)
       end

data/app/controllers/lcms/engine/welcome_controller.rb

@@ -3,7 +3,18 @@
 module Lcms
   module Engine
     class WelcomeController < Lcms::Engine::ApplicationController
+      skip_before_action :authenticate_user!, if: -> { request.path.index('oauth2callback').present? }
+
+      OAUTH_REFERER = 'https://accounts.google.com/'
+      OAUTH_MESSAGE = 'Copy this code and use it to continue authorization'
+
       def index; end
+
+      def oauth2callback
+        head(:not_found) && return unless request.referer == OAUTH_REFERER
+
+        render json: { text: OAUTH_MESSAGE, code: params[:code] }
+      end
     end
   end
 end

data/app/entities/lcms/engine/grades.rb

@@ -12,31 +12,42 @@ module Lcms
 
       attr_reader :model
 
+      class << self
+        def grades
+          ::Lcms::Engine::Grades::GRADES
+        end
+
+        def grades_abbrevs
+          ::Lcms::Engine::Grades::GRADES_ABBR
+        end
+      end
+
       def initialize(model)
         @model = model
       end
 
       def list
-        @list ||= if model.is_a?(Resource)
+        @list ||= case model
+                  when Resource
                     Array.wrap model.metadata['grade']
-                  elsif model.is_a?(Search::Document)
+                  when Search::Document
                     Array.wrap model.grade.presence
                   else
                     model.grade_list
-                  end.sort_by { |g| GRADES.index(g) }
+                  end.sort_by { |g| self.class.grades.index(g) }
       end
 
       def average(abbr: true)
         return nil if average_number.nil?
 
-        avg = GRADES[average_number]
+        avg = self.class.grades[average_number]
         abbr ? (grade_abbr(avg) || 'base') : avg
       end
 
       def average_number
         return nil if list.empty?
 
-        list.map { |g| GRADES.index(g) }.sum / (list.size.nonzero? || 1)
+        list.map { |g| self.class.grades.index(g) }.sum / (list.size.nonzero? || 1)
       end
 
       def grade_abbr(abbr)
@@ -62,7 +73,7 @@ module Lcms
           abbr = grade_abbr(g).upcase
 
           # if the current grade is subsequent we store on the same chain
-          if idx.zero? || GRADES.index(g) == GRADES.index(prev) + 1
+          if idx.zero? || self.class.grades.index(g) == self.class.grades.index(prev) + 1
             chain << abbr
           else
             # the grade is not subsequent, so we store the current chain, and create a new one

data/app/entities/lcms/engine/hierarchical_position.rb

@@ -75,8 +75,7 @@ module Lcms
         val =  resource.lesson? ? resource.level_position : nil
         return val if val
 
-        lesson = resource.metadata['lesson']
-        lesson =~ lesson.try(:match, /(\d+)/).try(:[], 1).to_i
+        resource.metadata['lesson'].to_s.match(/(\d+)/)&.captures&.first.to_i
       end
     end
   end

data/app/entities/lcms/engine/media_embed.rb

@@ -8,7 +8,7 @@ module Lcms
       def self.soundcloud(url, subject)
         color = SUBJECT_COLORS[subject || :default]
         oembed_url = "http://soundcloud.com/oembed?url=#{url}&iframe=true&maxheight=166&" \
-                 "color=#{color}&auto_play=false&format=json"
+                     "color=#{color}&auto_play=false&format=json"
         RestClient.get(oembed_url) do |response|
           if response.code == 200
             oembed = JSON.parse(response)['html']
@@ -26,7 +26,7 @@ module Lcms
         when /vimeo\.com/
           url.match(%r{https?://(www\.)?vimeo.com/(\d+)}).try(:[], 2)
         when /youtu\.be/
-          url.match(%r{https?://(www\.)?youtu\.be/([^"&?\/]+)}).try(:[], 2)
+          url.match(%r{https?://(www\.)?youtu\.be/([^"&?/]+)}).try(:[], 2)
         end
       end
     end

data/app/entities/lcms/engine/pagination.rb

@@ -28,17 +28,21 @@ module Lcms
       end
 
       def serialize(resources, serializer)
-        options = { root: :results }
-        options[:meta_key] = :pagination
-        options[:pagination] = {
-          total_pages: resources.total_pages,
-          current_page: resources.current_page,
-          per_page: resources.per_page,
-          order: params[:order],
-          total_hits: resources.total_entries
+        options = {
+          adapter: :json,
+          each_serializer: serializer,
+          meta_key: {
+            pagination: {
+              total_pages: resources.total_pages,
+              current_page: resources.current_page,
+              per_page: resources.per_page,
+              order: params[:order],
+              total_hits: resources.total_entries
+            }
+          },
+          root: :results
         }
-        options[:each_serializer] = serializer
-        ActiveModel::Serializer::CollectionSerializer.new(resources, options).as_json
+        ActiveModelSerializers::SerializableResource.new(resources, options).as_json
       end
 
       private

data/app/entities/lcms/engine/roman_numerals.rb

@@ -3,7 +3,7 @@
 module Lcms
   module Engine
     class RomanNumerals
-      ROMAN_NUMERALS_RE = /^(M|CM|D|CD|C|XC|L|XL|X|IX|V|IV|I)/
+      ROMAN_NUMERALS_RE = /^(M|CM|D|CD|C|XC|L|XL|X|IX|V|IV|I)/.freeze
       SYMBOLS = [
         [1000, 'M'],
         [900, 'CM'],
@@ -28,7 +28,7 @@ module Lcms
               num -= arab
             end
           end
-        end.join('')
+        end.join
       end
 
       def self.from_roman(roman)

data/app/exceptions/lcms/engine/document_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Lcms
+  module Engine
+    class DocumentError < StandardError
+    end
+  end
+end

data/app/exceptions/lcms/engine/material_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Lcms
+  module Engine
+    class MaterialError < StandardError
+    end
+  end
+end

data/app/forms/lcms/engine/document_form.rb

@@ -13,7 +13,7 @@ module Lcms
       validates_presence_of :link, if: -> { link_fs.blank? }
       validates_presence_of :link_fs, if: -> { link.blank? }
 
-      attr_reader :document
+      attr_reader :document, :service_errors
 
       def initialize(attributes = {}, opts = {})
         @is_reimport = attributes.delete(:reimport).present? || false
@@ -29,7 +29,7 @@ module Lcms
         @document.update(reimported: true)
       rescue StandardError => e
         @document&.update(reimported: false)
-        Rails.logger.error e.message + "\n " + e.backtrace.join("\n ")
+        Rails.logger.error "#{e.message}\n #{e.backtrace.join("\n ")}"
         errors.add(:link, e.message)
         false
       end
@@ -45,18 +45,23 @@ module Lcms
       def build_document
         service = document_build_service
 
-        if is_reimport
-          doc = service.build_for(link)
-          doc = service.build_for(link_fs, expand: true) if link_fs.present?
-          doc
-        elsif (full_doc = find_full_document)
-          # if there is a document with the same file_id or foundational_file_id
-          # we need to make full re-import to correctly handle expand process
-          service.build_for(full_doc.file_url)
-          service.build_for(full_doc.file_fs_url, expand: true)
-        else
-          service.build_for link
-        end
+        result =
+          if is_reimport
+            doc = service.build_for(link)
+            doc = service.build_for(link_fs, expand: true) if link_fs.present?
+            doc
+          elsif (full_doc = find_full_document)
+            # if there is a document with the same file_id or foundational_file_id
+            # we need to make full re-import to correctly handle expand process
+            service.build_for(full_doc.file_url)
+            service.build_for(full_doc.file_fs_url, expand: true)
+          else
+            service.build_for link
+          end
+
+        @service_errors = service.errors
+
+        result
       end
 
       def document_build_service

data/app/forms/lcms/engine/material_form.rb

@@ -11,7 +11,7 @@ module Lcms
       attribute :source_type, String
       validates :link, presence: true
 
-      attr_accessor :material
+      attr_accessor :material, :service_errors
 
       def initialize(attributes = {}, opts = {})
         super(attributes)
@@ -28,12 +28,13 @@ module Lcms
         }.compact
         service = MaterialBuildService.new google_credentials, params
         @material = service.build link
+        @service_errors = service.errors
 
         material.update preview_links: {}
         after_reimport_hook
         true
       rescue StandardError => e
-        Rails.logger.error e.message + "\n " + e.backtrace.join("\n ")
+        Rails.logger.error "#{e.message}\n #{e.backtrace.join("\n ")}"
         errors.add(:link, e.message)
         false
       end

data/app/helpers/admin/components_helper.rb

@@ -2,9 +2,9 @@
 
 module Admin
   module ComponentsHelper
-    HIDDEN_FIELD_RE = /\b(?<=name=")[^"]+(?=")/
+    HIDDEN_FIELD_RE = /\b(?<=name=")[^"]+(?=")/.freeze
 
-    def resource_picker_field(form, collection, allow_multiple: true, path:, name:)
+    def resource_picker_field(form, collection, path:, name:, allow_multiple: true)
       path = path.to_s
 
       base_name = form.hidden_field(name).scan(HIDDEN_FIELD_RE)[0]
@@ -60,7 +60,7 @@ module Admin
           id: resource.parent_id,
           title: resource.parent.try(:title)
         },
-        tree: Lcms::Engine::CurriculumPresenter.new.editor_props[:tree]
+        path: lcms_engine_url_helpers.children_admin_curriculum_path
       }
     end
   end

data/app/helpers/lcms/engine/path_helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Lcms
+  module Engine
+    module PathHelper
+      include Rails.application.routes.url_helpers
+
+      def dynamic_path(path, *args)
+        host_engine_path(path, *args).presence || main_app.send(path.to_sym, *args)
+      end
+
+      def dynamic_document_path(*args)
+        host_engine_path(:document_path, *args).presence || main_app.document_path(*args)
+      end
+
+      def dynamic_material_path(*args)
+        host_engine_path(:material_path, *args).presence || main_app.material_path(*args)
+      end
+
+      private
+
+      def host_engine_path(key, *args)
+        settings = Lcms::Engine::Admin::AdminController.settings
+        if (host_route = settings.dig(:redirect, :host, key)).present?
+          main_app.send(host_route.to_sym, *args)
+        elsif (engine_route = settings.dig(:redirect, :engine, key)).present?
+          lcms_engine.send(engine_route.to_sym, *args)
+        end
+      end
+    end
+  end
+end

data/app/helpers/lcms/engine/resource_helper.rb

@@ -46,7 +46,7 @@ module Lcms
 
         [].tap do |result|
           pieces.each_with_index do |piece, idx|
-            result << piece && next if idx.zero?
+            ((result << piece) && next) if idx.zero?
 
             slug = Slug.build_from(pieces[0..idx])
 

data/app/helpers/lcms/engine/view_helper.rb

@@ -97,14 +97,6 @@ module Lcms
         strip_tags(str).squish
       end
 
-      def set_social_media_sharing(target) # rubocop:disable Naming/AccessorMethodName
-        @social_media_presenter = SocialMediaPresenter.new(target: target, view: self)
-      end
-
-      def social_media
-        @social_media_presenter || SocialMediaPresenter.new(target: nil, view: self)
-      end
-
       def color_code(model, base: false)
         subject_color_code = model.try(:subject) || 'default'
         grade_avg = base ? 'base' : model.grades.average
@@ -116,7 +108,7 @@ module Lcms
         return unless selected_ids.present?
 
         case selected_ids
-        when Array then
+        when Array
           selected_ids.include?(id.to_s)
         else
           selected_ids.split(',').include?(id.to_s)