effective_learndash 0.1.2 → 0.1.5

data/app/models/effective/learndash_course.rb

@@ -3,22 +3,88 @@ module Effective
     has_many :learndash_enrollments
     has_many :learndash_users, through: :learndash_enrollments
 
+    log_changes if respond_to?(:log_changes)
+
+    # rich_text_body - Used by the select step
+    has_many_rich_texts
+
+    # rich_text_body
+
+    # rich_text_all_steps_content
+    # rich_text_start_content
+    # rich_text_select_content
+    # rich_text_select_content
+
+    acts_as_slugged
+    log_changes if respond_to?(:log_changes)
+    acts_as_role_restricted if respond_to?(:acts_as_role_restricted)
+
     effective_resource do
       # This user the wordpress credentials
-      course_id                 :integer
-      status                    :string
-      title                     :string
+      course_id             :integer
+      title                 :string
+      status                :string
+
+      # Our attributes
+      slug                   :string
+
+      # For course purchases
+      can_register           :boolean
+
+      # Pricing
+      regular_price         :integer
+      member_price          :integer
+
+      qb_item_name          :string
+      tax_exempt            :boolean
+
+      # Access
+      roles_mask             :integer
+      authenticate_user      :boolean
 
       timestamps
     end
 
     scope :deep, -> { all }
     scope :sorted, -> { order(:title) }
+    scope :registerable, -> { where(can_register: true) }
+    scope :published, -> { all }
+
+    scope :paginate, -> (page: nil, per_page: nil) {
+      page = (page || 1).to_i
+      offset = [(page - 1), 0].max * (per_page || EffectiveLearndash.per_page)
+
+      limit(per_page).offset(offset)
+    }
+
+    scope :learndash_courses, -> (user: nil, unpublished: false) {
+      scope = all.deep.sorted
+
+      if defined?(EffectiveRoles) && EffectiveLearndash.use_effective_roles
+        scope = scope.for_role(user&.roles)
+      end
+
+      if user.blank?
+        scope = scope.where(authenticate_user: false)
+      end
+
+      # TODO
+      # unless unpublished
+      #   scope = scope.published
+      # end
+
+      scope
+    }
 
     validates :course_id, presence: true
     validates :status, presence: true
     validates :title, presence: true
 
+    with_options(if: -> { can_register? }) do
+      validates :regular_price, presence: true
+      validates :member_price, presence: true
+    end
+
     # Syncs all courses
     def self.refresh!
       courses = all()
@@ -35,5 +101,14 @@ module Effective
       title.presence || 'learndash course'
     end
 
+    def body
+      rich_text_body
+    end
+
+    # Todo
+    def draft?
+      false
+    end
+
   end
 end

data/app/models/effective/learndash_enrollment.rb

@@ -1,11 +1,11 @@
 module Effective
   class LearndashEnrollment < ActiveRecord::Base
     belongs_to :owner, polymorphic: true
-    log_changes(to: :owner) if respond_to?(:log_changes)
-
     belongs_to :learndash_course
     belongs_to :learndash_user
 
+    log_changes(to: :learndash_course, except: [:last_synced_at]) if respond_to?(:log_changes)
+
     PROGRESS_STATUSES = ['not-started', 'in-progress', 'completed']
 
     effective_resource do
@@ -58,7 +58,11 @@ module Effective
       progress_status == 'completed'
     end
 
-    def refresh!
+    def refresh!(force: false)
+      unless force
+        return if last_synced_at.present? && (Time.zone.now - last_synced_at) < 5
+      end
+
       assign_api_attributes
       save!
     end

data/app/models/effective/learndash_user.rb

@@ -44,13 +44,12 @@ module Effective
       owner&.to_s || username.presence || 'learndash user'
     end
 
-    def check_and_refresh!
-      return if last_synced_at.present? && (Time.zone.now - last_synced_at) < 10
-      return if learndash_enrollments.none? { |enrollment| !enrollment.completed? }
-      refresh!
-    end
+    def refresh!(force: false)
+      unless force
+        return if last_synced_at.present? && (Time.zone.now - last_synced_at) < 5
+        return if learndash_enrollments.none? { |enrollment| !enrollment.completed? }
+      end
 
-    def refresh!
       assign_api_course_enrollments
       save!
     end

data/app/views/admin/learndash_courses/_form.html.haml

@@ -0,0 +1,25 @@
+= tabs do
+  = tab "Learndash Course" do
+    = render 'admin/learndash_courses/form_learndash_course', learndash_course: learndash_course
+
+  - if learndash_course.persisted?
+    = tab 'Enrollments' do
+      %h2 Enrollments
+      %p Click the New button from the below table to enroll a user into this course.
+      %p Enrolling a user here will enroll them on the LearnDash site.
+      %p Alternately, if this course is available for registration, the enrollment will be created upon registration purchase.
+
+      - datatable = Admin::EffectiveLearndashEnrollmentsDatatable.new(learndash_course: learndash_course)
+      = render_datatable(datatable, inline: true)
+
+    = tab 'Registrations' do
+      %h2 Purchases
+      - datatable = Admin::EffectiveCourseRegistrationsDatatable.new(learndash_course: learndash_course)
+      = render_inline_datatable(datatable)
+
+    = tab 'Wizard' do
+      = render '/admin/learndash_courses/form_course_registration_content', learndash_course: learndash_course
+
+    - if learndash_course.respond_to?(:log_changes_datatable)
+      = tab "Logs" do
+        = render_inline_datatable(learndash_course.log_changes_datatable)

data/app/views/admin/learndash_courses/_form_course_registration_content.html.haml

@@ -0,0 +1,19 @@
+%p Each of the following content areas will be displayed on the course purchase wizard.
+
+= effective_form_with(model: [:admin, learndash_course], engine: true) do |f|
+  = card("All Steps") do
+    = f.rich_text_area "rich_text_all_steps_content", label: false,
+      hint: "displayed on all steps"
+
+  %hr
+
+  - enabled = EffectiveLearndash.CourseRegistration.all_wizard_steps
+
+  - EffectiveLearndash.CourseRegistration::WIZARD_STEPS.each do |step, title|
+    - next unless enabled.include?(step)
+
+    = card("#{title}") do
+      = f.rich_text_area "rich_text_#{step}_content", label: false,
+        hint: "displayed on the course purchase wizard #{step} wizard step only"
+
+  = f.submit

data/app/views/admin/learndash_courses/_form_learndash_course.html.haml

@@ -0,0 +1,32 @@
+= effective_form_with(model: [:admin, learndash_course], engine: true) do |f|
+  = f.static_field :title
+
+  = f.static_field :learndash_course_url do
+    = link_to(learndash_course.link, learndash_course.link, target: '_blank')
+
+  = f.static_field :learndash_course_admin do
+    = link_to "Learndash LMS Course Admin", EffectiveLearndash.learndash_url.chomp('/') + "/wp-admin/post.php?post=#{learndash_course.course_id}&action=edit", target: '_blank'
+
+  - if f.object.persisted? || f.object.errors.include?(:slug)
+    - current_url = (effective_learndash.learndash_course_url(f.object) rescue nil)
+    = f.text_field :slug, hint: "The slug controls this course's internet address. Be careful, changing the slug will break links that other websites may have to the old address.<br>#{('This course is currently reachable via ' + link_to(current_url.gsub(f.object.slug, '<strong>' + f.object.slug + '</strong>').html_safe, current_url)) if current_url }".html_safe
+
+  = f.check_box :can_register, label: 'Yes, this course is displayed and available for registration'
+
+  = f.show_if :can_register, true do
+    = card('Pricing Information') do
+      %p.text-muted
+        Charge the following amounts during course registration. Enter $0 for free.
+
+      .row
+        .col-lg-3= f.price_field :regular_price, label: 'Price to applicants or new users'
+
+      .row
+        .col-lg-3= f.price_field :member_price, label: 'Price to existing members'
+
+      = f.check_box :tax_exempt
+
+      .row
+        .col-lg-3= f.text_field :qb_item_name, label: "Quickbooks Item Name"
+
+  = f.submit

data/app/views/admin/learndash_courses/_learndash_course.html.haml

@@ -1,10 +1,10 @@
-= card('Learndash Course') do
+= card('LearnDash Course') do
   %p= learndash_course.title
   %p= link_to(learndash_course.link, learndash_course.link, target: '_blank')
 
-  %p= link_to "Learndash LMS Course Admin", EffectiveLearndash.learndash_url.chomp('/') + "/wp-admin/post.php?post=#{learndash_course.course_id}}&action=edit", target: '_blank'
+  %p= link_to "LearnDash LMS Course Admin", EffectiveLearndash.learndash_url.chomp('/') + "/wp-admin/post.php?post=#{learndash_course.course_id}}&action=edit", target: '_blank'
 
-%h3 Learndash User Enrollments
+%h3 LearnDash User Enrollments
 
 %p Click the New button from the below table to enroll a user into this course.
 

data/app/views/admin/learndash_owners/_form.html.haml

@@ -1,5 +1,5 @@
 - if owner.learndash_user.blank?
-  %p #{owner} does not yet have an account on Learndash.
+  %p #{owner} does not yet have an account on LearnDash.
 
 - if owner.learndash_user.present?
   = render('admin/learndash_users/learndash_user', learndash_user: owner.learndash_user)

data/app/views/admin/learndash_users/_form.html.haml

@@ -1,6 +1,6 @@
 = effective_form_with(model: [:admin, learndash_user], engine: true) do |f|
 
   = f.select :owner, {'Owners' => current_user.class.sorted }, polymorphic: true,
-    hint: 'Create a Learndash user account for this website user'
+    hint: 'Create a LearnDash account for this user'
 
   = f.submit

data/app/views/admin/learndash_users/_learndash_user.html.haml

@@ -1,19 +1,19 @@
-= card('Learndash User') do
+= card('LearnDash') do
   %p
     = link_to(learndash_user.owner, "/admin/users/#{learndash_user.owner.to_param}/edit")
-    has an existing account on Learndash.
+    has an existing account on LearnDash.
 
   %ul
     %li Email: #{learndash_user.email}
     %li Username: #{learndash_user.username}
     %li Password: #{learndash_user.password}
 
-  %p= link_to "Learndash LMS User Admin", EffectiveLearndash.learndash_url.chomp('/') + "/wp-admin/user-edit.php?user_id=#{learndash_user.user_id}", target: '_blank'
+  %p= link_to "LearnDash LMS User Admin", EffectiveLearndash.learndash_url.chomp('/') + "/wp-admin/user-edit.php?user_id=#{learndash_user.user_id}", target: '_blank'
 
   %p
     %small Last refreshed #{time_ago_in_words(learndash_user.last_synced_at)} ago.
 
-%h3 Learndash Course Enrollments
+%h3 LearnDash Course Enrollments
 
 %p Click the New button from the below table to manually enroll this user into a new course.
 

data/app/views/effective/course_registrations/_content.html.haml

@@ -0,0 +1,10 @@
+- all_steps_content = resource.learndash_course&.rich_text_all_steps_content
+- step_content = resource.learndash_course&.send("rich_text_#{step}_content")
+
+- if all_steps_content.present?
+  .card.mb-4
+    .card-body= all_steps_content
+
+- if step_content.present?
+  .card.mb-4
+    .card-body= step_content

data/app/views/effective/course_registrations/_course.html.haml

@@ -0,0 +1,9 @@
+= card do
+  .row
+    .col-sm
+      %h5.card-title= course_registration.wizard_step_title(:course)
+    .col-sm-auto.text-right
+      = link_to('Edit', wizard_path(:course)) if edit_effective_wizard?
+
+  - datatable = EffectiveCourseRegistrantsDatatable.new(course_registration: course_registration)
+  .mb-4= render_simple_datatable(datatable)

data/app/views/effective/course_registrations/_course_registration.html.haml

@@ -0,0 +1,3 @@
+.effective-course-registration
+  - course_registration.render_steps.each do |partial|
+    = render "effective/course_registrations/#{partial}", course_registration: course_registration, step: partial

data/app/views/effective/course_registrations/_dashboard.html.haml

@@ -0,0 +1,30 @@
+-# In progress course purchase
+- wizard = EffectiveLearndash.CourseRegistration.in_progress.for(current_user).first
+- datatable = EffectiveResources.best('EffectiveCourseRegistrationsDatatable').new(self, namespace: :effective)
+
+- if wizard.present?
+  %h2 In Progress Course Registrations
+
+  %p
+    Your course registration for
+    = link_to(wizard.learndash_course, effective_learndash.learndash_course_path(wizard.learndash_course))
+    is incomplete
+
+  %p
+    Please
+    = link_to("Continue registration for #{wizard.learndash_course}", effective_learndash.learndash_course_course_registration_build_path(wizard.learndash_course, wizard, wizard.next_step), 'data-turbolinks' => false, class: 'btn btn-primary')
+    or you can
+    = link_to('Abandon course registration', effective_learndash.learndash_course_course_registration_path(wizard.learndash_course, wizard), 'data-confirm': "Really delete #{wizard}?", 'data-method': :delete, class: 'btn btn-danger')
+    to register for another course.
+
+  %hr
+
+%h2 Course Registrations
+
+- if datatable.present?
+  = render_simple_datatable(datatable)
+- else
+  %p You have no past course registrations. When you do, we'll show them here.
+
+- if false
+  %p= link_to 'View all Course', effective_learndash.learndash_courses_path, class: 'btn btn-primary'

data/app/views/effective/course_registrations/_layout.html.haml

@@ -0,0 +1,3 @@
+.row
+  .col-lg-3.mb-3= render_wizard_sidebar(resource)
+  .col-lg-9= yield

data/app/views/effective/course_registrations/_orders.html.haml

@@ -0,0 +1,4 @@
+- if course_registration.submit_order&.purchased?
+  .card.mb-4
+    .card-body
+      = render(course_registration.submit_order)

data/app/views/effective/course_registrations/_summary.html.haml

@@ -0,0 +1,39 @@
+= card('Course Registration') do
+  %table.table.table-sm
+    %tbody
+      %tr
+        %th.border-0 Course
+        %td.border-0
+          %p
+            %strong=course_registration.course
+
+          - learndash_user = course_registration.learndash_owner.learndash_user
+          %p Your course account credentials are:
+
+          %ul
+            %li
+              %strong Username:
+              #{learndash_user.username}
+            %li
+              %strong Password:
+              #{learndash_user.password}
+
+          %p= link_to('Sign in to your course account', EffectiveLearndash.learndash_url, target: '_blank', class: 'btn btn-primary mb-2')
+
+      - if request.path.start_with?('/admin')
+        %tr
+          %th Registered by
+          %td
+            - url = (polymorphic_admin_path(course_registration.owner) rescue "/admin/users/#{course_registration.owner.to_param}/edit")
+            = link_to(course_registration.owner, url)
+      - else
+        %tr
+          %th Registered by
+          %td= course_registration.owner
+
+      - if course_registration.orders.present?
+        %tr
+          %th Order
+          %td
+            - course_registration.orders.each do |order|
+              = link_to(order, effective_orders.order_path(order))

data/app/views/effective/course_registrations/billing.html.haml

@@ -0,0 +1,15 @@
+= render 'layout' do
+  = render 'effective/course_registrations/content', resource: resource
+
+  - raise('expected owner to respond to billing_address') unless resource.owner.respond_to?(:billing_address)
+
+  = card('Billing Address') do
+    %p Please enter your billing address
+
+    = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
+      = f.hidden_field :id
+
+      = f.fields_for(:owner, f.object.owner) do |fu|
+        = effective_address_fields(fu, :billing)
+
+      = f.save 'Save and Continue'

data/app/views/effective/course_registrations/checkout.html.haml

@@ -0,0 +1,6 @@
+= render 'layout' do
+  = render 'effective/course_registrations/content', resource: resource
+
+  .card
+    .card-body
+      = render_checkout_step2(resource.submit_order, purchased_url: wizard_path(:submitted), deferred_url: wizard_path(:checkout), declined_url: wizard_path(:checkout))

data/app/views/effective/course_registrations/course.html.haml

@@ -0,0 +1,20 @@
+= render 'layout' do
+  = render 'effective/course_registrations/content', resource: resource
+
+  = card('Course') do
+    %p= resource.learndash_course
+    %p= price_to_currency(resource.registration_price)
+
+    = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
+      = f.hidden_field :id
+
+      = f.fields_for :course_registrants, (f.object.course_registrant || f.object.build_course_registrant) do |fr|
+        = fr.hidden_field :course_registration_id
+        = fr.hidden_field :course_registration_type
+
+        = fr.hidden_field :owner_id
+        = fr.hidden_field :owner_type
+
+        = fr.hidden_field :learndash_course_id
+
+      = f.save 'Save and Continue'

data/app/views/effective/course_registrations/start.html.haml

@@ -0,0 +1,25 @@
+= render 'layout' do
+  = render 'effective/course_registrations/content', resource: resource
+
+  .card
+    .card-body
+      %p Welcome #{current_user}!
+
+      %p You are registering for #{resource.course}.
+
+      - existing = resource.owner.learndash_user&.enrollment(course: resource.course)
+
+      - if existing.present?
+        .alert.alert-warning
+          You are already enrolled in #{link_to(resource.course, EffectiveLearndash.learndash_url, target: '_blank')}.
+
+      - if existing.blank?
+        = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
+          = f.hidden_field :id
+
+          = f.hidden_field :learndash_course_id
+
+          = f.hidden_field :owner_type
+          = f.hidden_field :owner_id
+
+          = f.save 'Save and Continue'

data/app/views/effective/course_registrations/submitted.html.haml

@@ -0,0 +1,15 @@
+= render 'layout' do
+  = render 'effective/course_registrations/content', resource: resource
+
+  - raise('expected a submitted course_registration') unless resource.was_submitted?
+  - raise('expected a purchased course_registration submit_order') unless resource.submit_order&.purchased?
+
+  .alert.alert-warning.mb-4
+    Successfully paid on #{resource.submit_order.purchased_at.strftime('%F')}.
+
+  = link_to "Return to Dashboard", root_path, class: 'btn btn-lg btn-primary mb-4'
+
+  = render 'effective/course_registrations/summary', course_registration: resource
+  = render 'effective/course_registrations/orders', course_registration: resource
+
+  = link_to "Return to Dashboard", root_path, class: 'btn btn-lg btn-primary'

data/app/views/effective/course_registrations/summary.html.haml

@@ -0,0 +1,8 @@
+= render 'layout' do
+  = render 'effective/course_registrations/content', resource: resource
+
+  = render('effective/course_registrations/course_registration', course_registration: resource)
+
+  = effective_form_with(model: resource, url: wizard_path(step), method: :put) do |f|
+    = f.hidden_field :id
+    = f.submit 'Save and Continue', class: 'btn btn-primary'

data/app/views/effective/learndash/_dashboard.html.haml

@@ -1,31 +1,29 @@
 - learndash_user = current_user.try(:learndash_user)
 - authorized = learndash_user && EffectiveResources.authorized?(self, :show, learndash_user)
 
-%h2 Learndash Courses
+%h2 Courses
 
 - if learndash_user.blank?
-  %p You do not have a Learndash account.
-
-- if learndash_user.present?
-  %p
-    = succeed('.') do
-      You have an existing account on
-      = link_to('Learndash', EffectiveLearndash.learndash_url, target: '_blank')
+  %p You do not have an account to access courses. When you are enrolled in a course, your account credentials will be displayed here.
 
 - if learndash_user.present? && authorized
-  - learndash_user.check_and_refresh!
+  - learndash_user.refresh!
 
-  %p Please sign into Learndash with the following credentials:
+  %p Your course account credentials are:
 
   %ul
-    %li Email: #{learndash_user.email}
-    %li Username: #{learndash_user.username}
-    %li Password: #{learndash_user.password}
+    %li
+      %strong Username:
+      #{learndash_user.username}
+    %li
+      %strong Password:
+      #{learndash_user.password}
 
-  - if learndash_user.learndash_enrollments.present?
-    %p You are enrolled in #{pluralize(learndash_user.learndash_enrollments.length, 'course')}.
+  %p= link_to('Sign in to your course account', EffectiveLearndash.learndash_url, target: '_blank', class: 'btn btn-primary')
 
+  - if learndash_user.learndash_enrollments.present?
     - datatable = EffectiveResources.best('EffectiveLearndashEnrollmentsDatatable').new(self)
     = render_datatable(datatable, simple: true)
+
   - else
-    You are not enrolled in any Learndash courses.
+    %p You are not enrolled in any courses.

data/app/views/effective/learndash_courses/_learndash_course.html.haml

@@ -0,0 +1,13 @@
+%table.table.effective-learndash-courses-table
+  %tbody
+    %tr
+      %th Regular Price
+      %td= price_to_currency(learndash_course.regular_price)
+    %tr
+      %th Discounted Price
+      %td= price_to_currency(learndash_course.member_price)
+
+    - if learndash_course.body.present?
+      %tr
+        %th Description
+        %td= learndash_course.body

data/app/views/effective/learndash_courses/index.html.haml

@@ -0,0 +1,5 @@
+= card do
+  - if @datatable.present?(self)
+    = render_datatable(@datatable, simple: true)
+  - else
+    %p There are no courses available for purchase. When there are, we'll show them here.

data/app/views/effective/learndash_courses/show.html.haml

@@ -0,0 +1,6 @@
+.effective-learndash-course
+  - if @learndash_course.registerable?
+    .resource-buttons
+      = link_to 'Register', effective_learndash.new_learndash_course_course_registration_path(@learndash_course), class: 'btn btn-primary'
+
+  = render 'effective/learndash_courses/learndash_course', learndash_course: @learndash_course

data/config/effective_learndash.rb

@@ -15,4 +15,13 @@ EffectiveLearndash.setup do |config|
   # Usernames can only contain lowercase letters (a-z) and numbers.
   # config.wp_username = Proc.new { |user| "user#{user.id}" }
   # config.wp_password = Proc.new { |user| SecureRandom.base64(12) }
+
+  # Course Purchase Wizard Settings
+  # config.course_registration_class_name = 'Effective::CourseRegistration'
+
+  # Pagination length on the Events#index page
+  config.per_page = 10
+
+  # Events can be restricted by role
+  config.use_effective_roles = true
 end

data/config/routes.rb

@@ -5,10 +5,19 @@ Rails.application.routes.draw do
 end
 
 EffectiveLearndash::Engine.routes.draw do
+  # Public routes
+  scope module: 'effective' do
+    resources :learndash_courses, only: [:index] do
+      resources :course_registrations, only: [:new, :show, :destroy] do
+        resources :build, controller: :course_registrations, only: [:show, :update]
+      end
+    end
+  end
+
   namespace :admin do
     get '/learndash', to: 'learndash#index', as: :learndash
 
-    resources :learndash_users, only: [:index, :show, :new, :create, :update] do
+    resources :learndash_users, except: [:edit, :destroy] do
       post :refresh, on: :member
     end
 
@@ -16,10 +25,11 @@ EffectiveLearndash::Engine.routes.draw do
       post :refresh, on: :member
     end
 
-    resources :learndash_courses, only: [:index, :show, :update] do
+    resources :learndash_courses, only: [:index, :edit, :update] do
       get :refresh, on: :collection
     end
 
+    resources :course_registrants, only: [:index]
+    resources :course_registrations, only: [:index, :show]
   end
-
 end