lcms-engine 0.1.2 → 0.3.1

data/app/views/lcms/engine/documents/show.html.erb

@@ -14,7 +14,7 @@
           Go to Lessons Admin
         <% end %>
         <%= link_to @document.file_url, class: 'o-ub-ld-btn o-ub-ld-btn--bordered', target: '_blank' do %>
-          <i class="ub-icon ub-file-gdoc"></i> Google Doc
+          <i class="fab fa-google"></i> Google Doc
         <% end %>
         <%= render partial: 'lcms/engine/admin/documents/reimport', locals: { lesson: @document, btn_class: 'o-ub-ld-btn o-ub-ld-btn--bordered' } %>
 

data/app/views/lcms/engine/materials/show.html.erb

@@ -6,7 +6,7 @@
       <div>
         <%= link_to 'Go to Materials Admin', admin_materials_path(request.query_parameters), class: 'button primary u-margin-right--base' %>
         <%= link_to @material.file_url, class: 'button primary u-margin-right--base', target: '_blank' do %>
-            <i class="ub-icon ub-file-gdoc"></i> Google Doc
+          <i class="fab fa-google"></i> Google Doc
         <% end %>
         <%= render partial: 'lcms/engine/admin/materials/reimport', locals: { material: @material, btn_size: 'default' } %>
       </div>

data/app/views/lcms/engine/resources/_children_list.html.erb

@@ -4,7 +4,7 @@
   <ul class="o-resource__list o-resource__list--icons o-resource__list--<%= color_code %>">
     <% resource.children.each do |item| %>
       <li>
-        <i class="fa fa-square"></i>
+        <i class="far fa-square"></i>
         <span>
           <% title = "#{item.short_title}: " %>
           <% if item.document.present? %>

data/app/views/lcms/engine/resources/_download.html.erb

@@ -2,15 +2,15 @@
   <% if download.download.attachment_content_type == 'pdf' %>
     <span>
       <%= link_to preview_download_path(id: download, slug: resource.slug), class: 'resource-attachment',
-        data: { no_turbolink: true, heap_data: download_heap_data(download, pdf_preview: true) }, target: '_blank' do %>
-        <i class="ub-icon ub-eye" aria-hidden="true"></i>
+        data: { no_turbolink: true }, target: '_blank' do %>
+        <i class="fas fa-eye" aria-hidden="true"></i>
       <% end %>
     </span>
   <% end %>
   <% id = SecureRandom.hex(4) %>
   <span data-toggle="<%= id %>">
-    <%= link_to download_path(download, slug: resource.slug), class: 'resource-attachment', data: { no_turbolink: true, heap_data: download_heap_data(download) } do %>
-      <i class="ub-icon fa-lg file-<%= "#{file_icon(download.download.attachment_content_type)} #{indent}" %>"></i>
+    <%= link_to download_path(download, slug: resource.slug), class: 'resource-attachment', data: { no_turbolink: true } do %>
+      <i class="far fa-file-<%= "#{file_icon(download.download.attachment_content_type)} #{indent}" %>"></i>
       <%= download.download.title %>
     <% end %>
   </span>

data/app/views/lcms/engine/resources/_unit_bundles.html.erb

@@ -8,13 +8,13 @@
       <ul class="o-resource__list o-resource__list--icons o-resource__list--<%= color_code(resource, base: true) %>">
         <li class="o-unit-bundles__item">
           <div class="o-unit-bundles__item--links">
-            <%= link_to bundle.file&.url, data: { no_turbolink: true, heap_data: bundle_heap_data(resource, bundle, cat, 'pdf') } do %>
-              <i class="ub-icon fa-lg ub-file-zip"></i>
+            <%= link_to bundle.file&.url, data: { no_turbolink: true } do %>
+              <i class="far fa-file-archive"></i>
             <% end %>
             <% if (gdoc_bundle =  resource.document_bundles.detect { |b| b.content_type == 'gdoc' }) %>
               <% if cat == 'full' %>
-                <%= link_to gdoc_bundle.url, target: '_blank', data: { no_turbolink: true, heap_data: bundle_heap_data(resource, gdoc_bundle, :full, 'gdoc') } do %>
-                  <i class="ub-icon fa-lg ub-file-gdoc"></i>
+                <%= link_to gdoc_bundle.url, target: '_blank', data: { no_turbolink: true } do %>
+                  <i class="fab fa-google"></i>
                 <% end %>
               <% else %>
                 <span class="o-unit-bundles__item--placeholder"></span>

data/app/views/lcms/engine/resources/show.html.erb

@@ -28,11 +28,11 @@
   <div class="o-page__module">
     <div class="o-page__wrap--row">
       <div class="o-page__module u-margin-bottom--gutter">
-        <%= link_to back_to_resource_path(@resource), class: 'o-btn o-btn--base o-btn--xs-full' do %>
+        <%= link_to back_to_resource_path(@resource), class: 'button o-btn--base o-btn--xs-full' do %>
           <i class="fa-lg ub-arrow-left u-text--middled"></i> <%= t('resources.btn.back') %>
         <% end %>
         <% if user_signed_in? %>
-          <%= link_to edit_admin_resource_path(@resource), class: 'o-btn o-btn--base', target: '_blank' do %>
+          <%= link_to edit_admin_resource_path(@resource), class: 'button o-btn--base', target: '_blank' do %>
             <%= t('ui.edit') %>
           <% end %>
         <% end %>

data/app/views/lcms/engine/shared/_footer.html.erb

@@ -2,9 +2,7 @@
   <footer class="c-footer u-supported <%= add_class_for_action(:resources, :show, 'c-footer--with-sticky') %>">
     <div class="c-footer__wrap o-page__wrap--row-column c-navbar">
       <div class="c-footer__logo">
-        <%= link_to root_path do %>
-          <%= image_tag('lcms/engine/logo-beta.svg') %>
-        <% end %>
+        <%= link_to 'LCMS Engine', lcms_engine.root_path %>
       </div>
     </div>
   </footer>

data/app/views/lcms/engine/shared/_header.html.erb

@@ -3,8 +3,8 @@
   <div class="o-page">
     <div class="o-top-bar">
       <div class="o-top-bar__item c-header-title">
-        <%= link_to root_path, class: 'c-header-title__logo c-header__link' do %>
-          <%= image_tag('lcms/engine/logo-beta.svg') %>
+        <%= link_to lcms_engine.root_path, class: 'c-header-title__logo c-header__link' do %>
+          LCMS Engine
         <% end %>
         <% if current_user&.ready_to_go? %>
           <span class="c-header-title__h-menu" data-responsive-toggle="navbar" data-hide-for="large">
@@ -18,40 +18,12 @@
         <% if current_user&.ready_to_go? %>
           <div class="o-top-bar__item">
             <ul class="menu c-header__menu">
-              <li class="hide-for-large">
-                <%= render partial: 'lcms/engine/shared/search_form' %>
-              </li>
-              <%= nav_link t('nav.curriculum_html'), explore_curriculum_index_path, { class: "c-header__link #{add_class_for_action(:resources, :show, 'active')}" }, { class: 'u-show' } %>
-              <%= nav_link t('nav.lessons_html'), find_lessons_path, { class: 'c-header__link' }, { class: 'u-show' } %>
-              <%= nav_link t('nav.instructions_html'), enhance_instruction_index_path, { class: "c-header__link #{add_class_for_action(:resources, :media, 'active')}" }, { class: 'u-show' } %>
-              <%# nav_link t('nav.leadership_html'), leadership_path, { class: 'c-header__link' }, { class: 'u-show' } %>
-              <%# nav_link t('nav.about_html'), about_path, { class: "c-header__link #{add_class_for_path(about_people_path, 'active')}" }, { class: 'u-show' } %>
-              <%= nav_link t('nav.helpdesk'), ENV['FRESHDESK_URL'], { class: 'c-header__link hide-for-large' }, target: '_blank'  if ENV['FRESHDESK_URL'].present? %>
               <%= nav_link t('nav.logout'), destroy_user_session_path, { class: 'c-header__link hide-for-large' } %>
             </ul>
           </div>
         <% end %>
         <div class="o-top-bar__item">
           <ul class="menu c-header__left-menu">
-            <% if current_user&.ready_to_go? %>
-              <li class="c-header__link show-for-large">
-                <%= link_to search_path do %>
-                  <i class="ub-search u-margin-right--zero"></i>
-                <% end %>
-              </li>
-              <% if ENV['FRESHDESK_URL'].present? %>
-                <li class="c-header__link c-header__link--full c-header__link--semi-dark show-for-large">
-                  <%= link_to ENV['FRESHDESK_URL'], target: '_blank', class: 'u-flex' do %>
-                    <i class="ub-helpdesk u-margin-right--zero"></i>
-                  <% end %>
-                  <ul class="c-header__left-submenu c-header__helpdesk-hover menu" data-turbolinks="false">
-                    <li class="u-txt--ld-tooltip">
-                      <%= t('nav.helpdesk_hover_html') %>
-                    </li>
-                  </ul>
-                </li>
-              <% end %>
-            <% end %>
             <% if user_signed_in? %>
               <li class="c-header__link c-header__link--full c-header__link--semi-light show-for-large">
                 <a class="u-flex" data-turbolinks="false"><i class="ub-user u-margin-right--zero"></i></a>
@@ -65,12 +37,6 @@
                 </ul>
               </li>
             <% end %>
-            <%# if current_user&.ready_to_go? >
-              <li class="c-header__link c-header__link--full c-header__link--light">
-                <a class="u-flex show-for-large" data-turbolinks="false"><i class="ub-share"></i></a>
-                <%= render partial: 'lcms/engine/shared/social_sharing_menu', locals: { cls: 'c-header' } >
-              </li>
-            <% end %>
           </ul>
         </div>
       </div>

data/app/views/lcms/engine/surveys/show.html.erb

@@ -84,7 +84,7 @@
         <div class="row">
           <div class="medium-12 columns">
             <div class="u-margin-top--xlarge">
-              <%= f.submit 'Proceed to Beta', class: 'o-btn o-btn--xs-full o-btn--yellow o-btn--xs-full' %>
+              <%= f.submit 'Proceed to Beta', class: 'button o-btn--xs-full warning o-btn--xs-full' %>
             </div>
           </div>
         </div>

data/app/views/lcms/engine/welcome/index.html.erb

@@ -1,80 +1 @@
-<div class="c-hp-hero">
-  <div class="o-page">
-    <div class="o-page__module c-hp-hero__wrap">
-      <div class="c-hp-hero__body">
-        <h1>Supporting educators in their work to meet high standards</h1>
-        <p>We provide free, standards-aligned resources and immersive training for teachers and leaders in pursuit of equity.</p>
-        <%= link_to t('ui.learn_more'), about_path, class: 'o-btn o-btn--yellow o-btn--xs-full u-margin-bottom--zero' %>
-      </div>
-    </div>
-  </div>
-</div>
-<div class="c-hp">
-  <div class="o-page">
-    <div class="o-page__module c-hp-register">
-      <div class="o-page__wrap--row c-hp-register__wrap">
-        <div class="c-hp-register__item text-center">
-          <div>
-            <strong class="st-logo__standards">Standards</strong>
-            <span class="st-logo__institute">Institute</span>
-          </div>
-          <div class="u-txt--st-label">Florida, June 26-30, 2017</div>
-        </div>
-        <div class="c-hp-register__text">
-          An immersive, engaging five-day professional development experience tailored to leaders and teachers of ELA and math.
-          <br>
-          <div class="c-hp-register__btn--ipad">
-            <%= standardsinstitutes_link %>
-          </div>
-        </div>
-        <div class="c-hp-register__item c-hp-register__btn">
-          <%= standardsinstitutes_link %>
-        </div>
-      </div>
-    </div>
-    <div class="o-page__module">
-      <div class="o-page__wrap--row-nest">
-        <div class="c-hp-panel">
-          <div class="c-hp-panel__body c-hp-panel__body--ela">
-            <h2 class="u-margin-bottom--base">ELA Curriculum</h2>
-            <div class="u-hr-small"></div>
-            <p>Browse our collection of free, standards-aligned PreK-Grade 12 resources in English Language Arts. These materials draw from the critically acclaimed EngageNY content and have been sequenced by experts in curriculum design and instructional implementation.</p>
-            <div>
-              <%= link_to 'Explore ELA', explore_curriculum_index_path(subjects: 'ela'), class: 'o-btn o-btn--bordered-yellow o-btn--xs-full u-margin-bottom--zero' %>
-            </div>
-          </div>
-        </div>
-        <div class="c-hp-panel">
-          <div class="c-hp-panel__body c-hp-panel__body--math">
-            <h2 class="u-margin-bottom--base">Math Curriculum</h2>
-            <div class="u-hr-small"></div>
-            <p>Our comprehensive collection of free, standards-aligned math resources for grades PreK-12 has been reviewed and sequenced by our math experts and is based on the critically acclaimed EngageNY content.</p>
-            <div>
-              <%= link_to 'Explore Math', explore_curriculum_index_path(subjects: 'math'), class: 'o-btn o-btn--bordered-yellow o-btn--xs-full u-margin-bottom--zero' %>
-            </div>
-          </div>
-        </div>
-      </div>
-    </div>
-    <div class="c-hp-media o-page__module o-media u-bg--light">
-      <div class="o-media__img o-media__img--left c-hp-img--fl">
-      </div>
-      <div class="o-media__body">
-        <h2>Find Lessons</h2>
-        <div class="u-hr-small"></div>
-        <p>Looking for a lesson on a specific topic and grade level? You can find it quickly here.</p>
-        <%= link_to 'Find Lessons', find_lessons_path, class: 'o-btn o-btn--yellow o-btn--xs-full u-margin-bottom--zero' %>
-      </div>
-    </div>
-    <div class="c-hp-media o-page__module o-media u-bg--light">
-      <div class="o-media__body">
-        <h2>Enhance Instruction</h2>
-        <div class="u-hr-small"></div>
-        <p>Our professional learning resources include teaching guides, videos, and podcasts that build educators' knowledge of content related to the standards and their application in the classroom.</p>
-        <%= link_to 'Videos', enhance_instruction_index_path(tab: 1), class: 'o-btn o-btn--xs-full o-btn--bordered-yellow u-color--base' %>
-      </div>
-      <div class="o-media__img o-media__img--right c-hp-img--ei">
-      </div>
-    </div>
-  </div>
-</div>
+<h1 class="text-center">Welcome to LCMS Engine</h1>

data/config/initializers/carrier_wave.rb

@@ -4,7 +4,6 @@ CarrierWave.configure do |config|
   if (Rails.env.development? && ENV['AWS_ACCESS_KEY_ID'].blank?) || Rails.env.test?
     config.storage = :file
   else
-    config.fog_provider = 'fog/aws'
     config.fog_credentials = {
       provider: 'AWS',
       aws_access_key_id: ENV['AWS_ACCESS_KEY_ID'],

data/config/locales/admin/en.yml

@@ -20,6 +20,7 @@ en:
             success: Access Code updated successfully.
         common:
           editing_disabled: Resource editing is disabled. Turn editing on in order to edit resources.
+          empty_folder: Google Documents folder is empty
         curriculums:
           update:
             success: Curriculum Tree saved successfully.
@@ -215,7 +216,7 @@ en:
             unit_bundles: Generate Unit Bundles
           create:
             error: Error
-            success: Lesson %{name} parsed successfully.
+            success: Lesson %{name} parsed successfully. %{errors}
           new:
             page_title: Add a lesson
             submit: Parse

data/config/routes.rb

@@ -1,37 +1,8 @@
 # frozen_string_literal: true
 
 Lcms::Engine::Engine.routes.draw do
-  get '/404'          => 'pages#not_found'
-  get '/about'        => 'pages#show_slug', slug: 'about'
-  get '/about/people' => 'pages#show_slug', slug: 'about_people'
-  get '/tos'          => 'pages#show_slug', slug: 'tos',     as: :tos_page
-  get '/privacy'      => 'pages#show_slug', slug: 'privacy', as: :privacy_page
-  get '/forthcoming'  => 'pages#forthcoming'
-
-  get '/search' => 'search#index'
-
   mount PdfjsViewer::Rails::Engine, at: '/pdfjs', as: 'pdfjs'
 
-  resources :downloads, only: [:show] do
-    member do
-      get :preview
-      get 'pdf_proxy(/:s3)' => 'downloads#pdf_proxy', as: :pdf_proxy_download, constraints: { s3: %r{[^\/]+} }
-    end
-  end
-
-  resources :explore_curriculum, only: %i(index show)
-  resources :enhance_instruction, only: :index
-  resources :find_lessons, only: :index
-  resources :pages, only: :show
-  resources :resources, only: :show do
-    get :pdf_proxy, on: :collection, path: 'pdf-proxy'
-  end
-  resource :survey, only: %i(create show)
-
-  get '/resources/:id/related_instruction' => 'resources#related_instruction', as: :related_instruction
-  get '/media/:id' => 'resources#media', as: :media
-  get '/other/:id' => 'resources#generic', as: :generic
-
   resources :documents, only: :show do
     member do
       post 'export', to: 'documents#export'
@@ -45,12 +16,12 @@ Lcms::Engine::Engine.routes.draw do
       get 'preview/gdoc', to: 'materials#preview_gdoc'
     end
   end
+  resources :resources, only: [:show]
 
   unless ENV.fetch('DEVISE_ROUTES_REDEFINED', false)
     devise_for :users, class_name: 'Lcms::Engine::User',
                        controllers: {
-                         registrations: 'lcms/engine/registrations',
-                         sessions: 'lcms/engine/sessions'
+                         registrations: 'lcms/engine/registrations'
                        },
                        module: :devise
   end
@@ -62,9 +33,7 @@ Lcms::Engine::Engine.routes.draw do
   namespace :admin do
     get '/' => 'welcome#index'
     get '/whoami' => 'admin#whoami'
-    get 'google_oauth2_callback' => 'google_oauth2#callback'
     get '/association_picker' => 'association_picker#index'
-    resources :reading_assignment_texts
     resource :resource_bulk_edits, only: %i(new create)
     get '/resource_picker' => 'resource_picker#index'
     resources :resources, except: :show do
@@ -73,7 +42,6 @@ Lcms::Engine::Engine.routes.draw do
         post :bundle
       end
     end
-    resources :pages, except: :show
     resources :settings, only: [] do
       patch :toggle_editing_enabled, on: :collection
     end
@@ -106,8 +74,6 @@ Lcms::Engine::Engine.routes.draw do
     resource :batch_reimport, only: %i(new create)
   end
 
-  get '/ExcludeMeGA' => 'analytics_exclusion#exclude'
-
   get '/*slug' => 'resources#show', as: :show_with_slug
 
   root to: 'welcome#index'

data/db/migrate/20200422130652_add_reimported_at_to_documents.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddReimportedAtToDocuments < Lcms::Engine::Migration
+  def change
+    add_column :documents, :reimported_at, :datetime
+  end
+end

data/db/migrate/20200429130353_drop_pages.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class DropPages < Lcms::Engine::Migration
+  def change
+    drop_table :pages do |t|
+      t.text :body, null: false
+      t.string :slug, null: false
+      t.string :title, null: false
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/schema.rb

@@ -14,8 +14,8 @@
 ActiveRecord::Schema.define(version: 0) do
 
   # These are extensions that must be enabled in order to support this database
-  enable_extension "plpgsql"
   enable_extension "hstore"
+  enable_extension "plpgsql"
 
   create_table "access_codes", force: :cascade do |t|
     t.string   "code",                      null: false

data/docs/env-variables.md

@@ -0,0 +1,87 @@
+## Required variables
+
+- APP_NAME
+- APPLICATION_DOMAIN
+- AWS_ACCESS_KEY_ID
+- AWS_REGION
+- AWS_S3_BUCKET_NAME
+- AWS_SECRET_ACCESS_KEY
+- BACKGROUND_JOBS
+- ELASTICSEARCH_ADDRESS
+- NODE_ENV
+- POSTGRESQL_ADDRESS
+- POSTGRESQL_DATABASE
+- POSTGRESQL_USERNAME
+- POSTGRESQL_PASSWORD
+- POSTGRESQL_PORT
+- WEBPACKER_CHECK_YARN
+- WKHTMLTOPDF_PATH
+
+## All other variables
+
+* [AirBrake](#airbrake-config)
+* [Amazon](#amazon-config)
+* [Google](#google-config)
+* [Miscellaneous settings](#miscellaneous-settings)
+* [PDF](#pdf-related-config)
+* [Postgres](#postgres-config)
+
+### AirBrake config
+The project is set up to support Airbrake, if you use it. You can provide an Airbrake ID and key in the config to enable it (Should be omitted for `development`&`test` environments)
+
+|Name|Description|
+|----|-----------|
+|AIR_BRAKE_PROJECT_ID|Project id in the AirBrake service|
+|AIR_BRAKE_PROJECT_KEY|Project key in the AirBrake service|
+
+### Amazon config
+The project uses AWS S3 to store and serve generated PDFs of learning content. You will need to set up an S3 bucket and provide a key and secret here:
+
+|Name|Description|
+|----|-----------|
+|AWS_ACCESS_KEY_ID|Public part of the AWS credentials|
+|AWS_REGION|Name of the region used for AWS service|
+|AWS_SECRET_ACCESS_KEY|Private part of the AWS credentials|
+|AWS_S3_BUCKET_NAME|Bucket used by application to store generated files|
+
+### Google config
+The project uses several Google products, including analytics, OAuth for allowing the application to use Google APIs, and several Google Drive folders.
+
+|Name|Description|
+|----|-----------|
+|GOOGLE_APPLICATION_FOLDER_ID|Id of the Google Drive folder where generated lessons and materials will be placed(It's `0B7` for url like `https://drive.google.com/drive/u/0/folders/0B7/...`)|
+|GOOGLE_APPLICATION_SCRIPT_ID|Id of the Google Script created to post-process generated Google documents. More details can be found [here](google-cloud-platform-setup.md)|
+|GOOGLE_APPLICATION_SCRIPT_FUNCTION|Name of the function to call to start post-processing|
+|GOOGLE_APPLICATION_TEMPLATE_PORTRAIT|Id of the Google document which is a template for portrait materials(can be identified the same way as `GOOGLE_APPLICATION_FOLDER_ID `)|
+|GOOGLE_APPLICATION_TEMPLATE_LANDSCAPE|Id of the Google document which is a template for landscape materials(can be identified the same way as `GOOGLE_APPLICATION_FOLDER_ID `)|
+|GOOGLE_APPLICATION_PREVIEW_FOLDER_ID| Folder ID where preview documents should get placed
+|GOOGLE_API_CLIENT_UPLOAD_RETRIES||
+|GOOGLE_API_CLIENT_UPLOAD_TIMEOUT||
+
+### Miscellaneous settings
+|Name|Description|
+|----|-----------|
+|APP_NAME|The title which will be shown in the page title and in other places. Something like `OpenSciEd LCMS`|
+|BITLY_API_TOKEN|Token of the Bitly service|
+|RESQUE_NAMESPACE|Value is used to separate data stored in Redis when the same redis server is used by multiple environments|
+|PUPPETEER_TIMEOUT|Default is 30 sec|
+|WORKERS_COUNT|Used on the servers. Specifies the number of workers to be started|
+|ELASTICSEARCH_ADDRESS|Elasticsearch server address|
+
+Obs: if you're setting a local dev machine on OSX and getting small fonts when generating pdfs, try downgrading wkhtmltopdf to `0.12.3`
+
+### PDF related config
+|Name|Description|
+|----|-----------|
+|ENABLE_BASE64_CACHING|Turns on/off caching of assets used for PDF generation (`true` by default, recommended as `false` for local env)|
+|NODE_ENV|We're using puppeteer(npm package) for PDF Generation, should be set as `production` for other env than local|
+|WKHTMLTOPDF_PATH|Path to the [wkhtmltopdf](https://wkhtmltopdf.org) binary. Default to `/usr/local/bin/wkhtmltopdf`. Will be removed when we will be certain on puppeteer|
+
+### Postgres config
+|Name|
+|----|
+|POSTGRESQL_ADDRESS|
+|POSTGRESQL_DATABASE|
+|POSTGRESQL_USERNAME|
+|POSTGRESQL_PASSWORD|
+|POSTGRESQL_PORT|