effective_learndash 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81bcba4c739ea9bac4b39489414f6cefbaff0530deb01af45e18960072057476
-  data.tar.gz: 461b4243fa49f7d9cc4a5aba4f2be46d991648328c42a8d81f7cadb193d21031
+  metadata.gz: bf3a76614af4d9fba4a5d9e483ecfc78ec821c042643b0d59508b42f80aead20
+  data.tar.gz: 3e383233f17438db0bc4c134e8fb767183b3697b0036100ddf89e80961b42332
 SHA512:
-  metadata.gz: bf9e1c610922fd5a50d9217ca3edd65861599a21e68d6ccfacbe1ffe47276e0612645b691c92955fac10dbf03c2b30c6a0cf4051cf7616edf5bde243673e7ad4
-  data.tar.gz: 30913570908343e2eb323a4a73fd646a3751db4916073e857abd16069d26f156d233149fe381a0d53b79bc63a45c61ce93dc9985598638a6fe5a3e2a6a190e40
+  metadata.gz: 73041dc5fa8d6e130f865cd0ed5acf4c966ff1d7148168d6482f582f68c29d86fd8521c6d23aeb35227ca1f70810bd54b88408527767c3654b0998f8f6513d37
+  data.tar.gz: 58d39dc3138ff44d2be3152aba69734f7f83146714b1b79a44b084cdc05dcd865974e457b4f61c2c3dd2436e5a81b709db7ea3cde5b68b807a325bf28df7c58e

data/README.md

@@ -1,6 +1,6 @@
-# Effective Learndash
+# Effective LearnDash
 
-Create Wordpress users and read Learndash course progress. This is an unoffocial integration that is not supported or affiliated with WordPress or Learndash.
+Create Wordpress users and read LearnDash course progress. This is an unofficial integration that is not supported or affiliated with WordPress or LearnDash.
 
 ## Getting Started
 
@@ -74,6 +74,12 @@ The permissions you actually want to define are as follows (using CanCan):
 can(:show, Effective::LearndashUser) { |lduser| lduser.owner_id == user.id }
 can(:index, Effective::LearndashEnrollment)
 
+can([:index, :show], Effective::LearndashCourse) { |course| !course.draft? }
+can([:show, :index], Effective::CourseRegistrant) { |registrant| registrant.owner == user || registrant.owner.blank? }
+can([:new, :create], EffectiveLearndash.CourseRegistration)
+can([:show, :index], EffectiveLearndash.CourseRegistration) { |registration| registration.owner == user }
+can([:update, :destroy], EffectiveLearndash.CourseRegistration) { |registration| registration.owner == user && !registration.was_submitted? }
+
 if user.admin?
   can :admin, :effective_learndash
 
@@ -85,29 +91,29 @@ if user.admin?
 end
 ```
 
-## Configuring Learndash
+## Configuring LearnDash
 
-Your Wordpress should be configured ahead of time with the Learndash plugin.
+Your WordPress should be configured ahead of time with the LearnDash plugin.
 
 Please generate an application password via:
 
 https://make.wordpress.org/core/2020/11/05/application-passwords-integration-guide/
 
-and fill in the username/password details in config/initializers/effective_leardash.rb
+and fill in the username/password details in config/initializers/effective_learndash.rb
 
-## Working with Learndash
+## Working with LearnDash
 
 Visit `/admin/learndash_courses` and Refresh the list of Courses.
 
-Create a New Learndash User will create a new Wordpress/Learndash account with a username/password according to the settings in the config file.
+Create a New LearnDash User will create a new WordPress/LearnDash account with a username/password according to the settings in the config file.
 
 When you create a user, you only get access to the password once. So any existing users will have an unknown password.
 
-Create a new Learndash Enrollment to enroll a learndash user into a course. This will begin tracking their progress.
+Create a new LearnDash Enrollment to enroll a LearnDash user into a course. This will begin tracking their progress.
 
-There are no webhooks or callbacks from Learndash, everything is a GET request that updates the local database.
+There are no webhooks or callbacks from LearnDash, everything is a GET request that updates the local database.
 
-You can refresh an entire learndash user in one operation and it will sync the entire user at once, `user.learndash_user.refresh!`
+You can refresh an entire LearnDash user in one operation and it will sync the entire user at once, `user.learndash_user.refresh!`
 
 ## License
 

data/app/assets/config/effective_learndash_manifest.js

@@ -1,3 +1,2 @@
 //= link_directory ../javascripts .js
 //= link_directory ../stylesheets .css
-//= link_directory ../images/effective_learndash

data/app/controllers/admin/course_registrations_controller.rb

@@ -0,0 +1,8 @@
+module Admin
+  class CourseRegistrationsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_learndash) }
+
+    include Effective::CrudController
+  end
+end

data/app/controllers/admin/learndash_courses_controller.rb

@@ -7,7 +7,7 @@ module Admin
 
     def refresh
       resource_scope.refresh!
-      flash[:success] = "Successfully refreshed Courses from Learndash"
+      flash[:success] = "Successfully refreshed Courses from LearnDash"
       redirect_to effective_learndash.admin_learndash_courses_path
     end
 

data/app/controllers/effective/course_registrations_controller.rb

@@ -0,0 +1,13 @@
+module Effective
+  class CourseRegistrationsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+
+    include Effective::WizardController
+
+    resource_scope -> {
+      learndash_course = Effective::LearndashCourse.find(params[:learndash_course_id])
+      EffectiveLearndash.CourseRegistration.deep.where(owner: current_user, learndash_course: learndash_course)
+    }
+
+  end
+end

data/app/controllers/effective/learndash_courses_controller.rb

@@ -0,0 +1,32 @@
+module Effective
+  class LearndashCoursesController < ApplicationController
+    include Effective::CrudController
+
+    resource_scope -> {
+      unpublished = EffectiveResources.authorized?(self, :admin, :effective_learndash)
+      Effective::LearndashCourse.learndash_courses(user: current_user, unpublished: unpublished)
+    }
+
+    def show
+      @learndash_course = resource_scope.find(params[:id])
+
+      if @learndash_course.respond_to?(:roles_permit?)
+        raise Effective::AccessDenied.new('Access Denied', :show, @learndash_course) unless @learndash_course.roles_permit?(current_user)
+      end
+
+      EffectiveResources.authorize!(self, :show, @learndash_course)
+
+      if EffectiveResources.authorized?(self, :admin, :effective_learndash)
+        flash.now[:warning] = [
+          'Hi Admin!',
+          ('You are viewing a hidden course.' if @learndash_course.draft?),
+          'Click here to',
+          ("<a href='#{effective_learndash.edit_admin_learndash_course_path(@learndash_course)}' class='alert-link'>edit learndash course settings</a>.")
+        ].compact.join(' ')
+      end
+
+      @page_title ||= @learndash_course.to_s
+    end
+
+  end
+end

data/app/datatables/admin/effective_course_registrations_datatable.rb

@@ -0,0 +1,28 @@
+module Admin
+  class EffectiveCourseRegistrationsDatatable < Effective::Datatable
+    datatable do
+      col :updated_at, visible: false
+      col :created_at, visible: false
+      col :id, visible: false
+
+      col :token, visible: false
+
+      col :created_at, label: 'Created', visible: false
+      col :updated_at, label: 'Updated', visible: false
+      col :submitted_at, label: 'Submitted', visible: false, as: :date
+
+      col :learndash_course
+      col :owner
+
+      col :course_registrants, search: :string, visible: false
+      col :orders, label: 'Order'
+
+      actions_col
+    end
+
+    collection do
+      scope = EffectiveLearndash.CourseRegistration.all.deep.done
+    end
+
+  end
+end

data/app/datatables/admin/effective_learndash_courses_datatable.rb

@@ -4,7 +4,7 @@ module Admin
       order :title
 
       col :id, visible: false
-      col :course_id, label: 'Learndash Id', visible: false
+      col :course_id, label: 'LearnDash Id', visible: false
 
       col :title
       col :status
@@ -15,6 +15,10 @@ module Admin
 
       col :learndash_users, visible: false
 
+      col :can_register
+      col :regular_price, as: :price
+      col :member_price, as: :price
+
       actions_col
     end
 

data/app/datatables/admin/effective_learndash_enrollments_datatable.rb

@@ -14,8 +14,7 @@ module Admin
         time_ago_in_words(enrollment.last_synced_at) + ' ago'
       end
 
-      col :owner, visible: false
-
+      col :owner
       col :learndash_course
       col :learndash_user
 

data/app/datatables/admin/effective_learndash_users_datatable.rb

@@ -2,7 +2,7 @@ module Admin
   class EffectiveLearndashUsersDatatable < Effective::Datatable
     datatable do
       col :id, visible: false
-      col :user_id, label: 'Learndash Id', visible: false
+      col :user_id, label: 'LearnDash Id', visible: false
 
       col :last_refreshed, visible: true do |user|
         time_ago_in_words(user.last_synced_at) + ' ago'

data/app/datatables/effective_course_registrants_datatable.rb

@@ -0,0 +1,24 @@
+# Used on the Course Registrations courses step
+
+class EffectiveCourseRegistrantsDatatable < Effective::Datatable
+  datatable do
+    col :learndash_course
+    col :owner, label: 'User', action: false
+    col :price, as: :price
+  end
+
+  collection do
+    scope = Effective::CourseRegistrant.deep.all
+
+    if attributes[:learndash_course_id].present?
+      scope = scope.where(learndash_course_id: attributes[:learndash_course_id])
+    end
+
+    if attributes[:course_registration_id].present?
+      scope = scope.where(course_registration_id: attributes[:course_registration_id])
+    end
+
+    scope
+  end
+
+end

data/app/datatables/effective_course_registrations_datatable.rb

@@ -0,0 +1,35 @@
+# Dashboard Course Registrations
+class EffectiveCourseRegistrationsDatatable < Effective::Datatable
+  datatable do
+    order :created_at
+
+    col :token, visible: false
+    col :created_at, visible: false
+
+    col :learndash_course, label: 'Title', search: :string do |registration|
+      registration.learndash_course.to_s
+    end
+
+    col(:submitted_at, label: 'Registered on') do |registration|
+      registration.submitted_at&.strftime('%F') || 'Incomplete'
+    end
+
+    col :owner, visible: false, search: :string
+    col :status, visible: false
+    col :orders, action: :show, visible: false, search: :string
+
+    actions_col(actions: []) do |registration|
+      if registration.draft?
+        dropdown_link_to('Continue', effective_learndash.learndash_course_course_registration_build_path(registration.learndash_course, registration, registration.next_step), 'data-turbolinks' => false)
+        dropdown_link_to('Delete', effective_learndash.learndash_course_course_registration_path(registration.learndash_course, registration), 'data-confirm': "Really delete #{registration}?", 'data-method': :delete)
+      else
+        dropdown_link_to('Show', effective_learndash.learndash_course_course_registration_path(registration.learndash_course, registration))
+      end
+    end
+  end
+
+  collection do
+    EffectiveLearndash.CourseRegistration.deep.where(owner: current_user)
+  end
+
+end

data/app/datatables/effective_learndash_courses_datatable.rb

@@ -0,0 +1,30 @@
+# Dashboard Courses
+class EffectiveLearndashCoursesDatatable < Effective::Datatable
+  filters do
+    # Registerable should be first here, so when displayed as a simple datatable on the dashboard they only see registerable courses
+    scope :registerable
+    scope :all
+  end
+
+  datatable do
+    order :title
+    col :id, visible: false
+
+    col :title do |learndash_course|
+      learndash_course.to_s
+    end
+
+    actions_col show: false do |learndash_course|
+      if current_user.learndash_enrollment(course: learndash_course).present?
+        'Registered. Please access from the home dashboard or applicant wizard.'
+      elsif learndash_course.can_register?
+        dropdown_link_to('Register', effective_learndash.new_learndash_course_course_registration_path(learndash_course))
+      end
+    end
+  end
+
+  collection do
+    Effective::LearndashCourse.deep.learndash_courses(user: current_user)
+  end
+
+end

data/app/datatables/effective_learndash_enrollments_datatable.rb

@@ -1,8 +1,11 @@
 # Dashboard LearndashUsers
 class EffectiveLearndashEnrollmentsDatatable < Effective::Datatable
   datatable do
-    col :learndash_course
-    col :progress_status
+    col :learndash_course, label: 'Title' do |enrollment|
+      enrollment.learndash_course.to_s
+    end
+
+    col :progress_status, label: 'Status'
 
     col :last_step, visible: false
     col :steps_completed, visible: false
@@ -13,9 +16,9 @@ class EffectiveLearndashEnrollmentsDatatable < Effective::Datatable
 
     actions_col(show: false) do |enrollment|
       if enrollment.not_started?
-        dropdown_link_to('Start', EffectiveLearndash.learndash_url, target: '_blank')
+        dropdown_link_to('Access Course', EffectiveLearndash.learndash_url, target: '_blank')
       elsif enrollment.in_progress?
-        dropdown_link_to('Continue', EffectiveLearndash.learndash_url, target: '_blank')
+        dropdown_link_to('Continue Course', EffectiveLearndash.learndash_url, target: '_blank')
       else
         dropdown_link_to('Show', EffectiveLearndash.learndash_url, target: '_blank')
       end

data/app/models/concerns/effective_learndash_course_registration.rb

@@ -0,0 +1,172 @@
+# frozen_stcourse_registrant_literal: true
+
+# EffectiveLearndashCourseRegistration
+#
+# Mark your owner model with effective_learndash_course_registration to get all the includes
+
+module EffectiveLearndashCourseRegistration
+  extend ActiveSupport::Concern
+
+  module Base
+    def effective_learndash_course_registration
+      include ::EffectiveLearndashCourseRegistration
+    end
+  end
+
+  module ClassMethods
+    def effective_learndash_course_registration?; true; end
+  end
+
+  included do
+    acts_as_purchasable_parent
+    acts_as_tokened
+
+    acts_as_statused(
+      :draft,      # Just Started
+      :submitted   # All done
+    )
+
+    acts_as_wizard(
+      start: 'Start',
+      course: 'Course',
+      summary: 'Review',
+      billing: 'Billing Address',
+      checkout: 'Checkout',
+      submitted: 'Submitted'
+    )
+
+    acts_as_purchasable_wizard
+
+    log_changes(except: :wizard_steps) if respond_to?(:log_changes)
+
+    # Application Namespace
+    belongs_to :owner, polymorphic: true
+    accepts_nested_attributes_for :owner
+
+    # Effective Namespace
+    belongs_to :learndash_course, class_name: 'Effective::LearndashCourse'
+
+    has_many :course_registrants, -> { order(:id) }, class_name: 'Effective::CourseRegistrant', inverse_of: :course_registration, dependent: :destroy
+    accepts_nested_attributes_for :course_registrants, reject_if: :all_blank, allow_destroy: true
+
+    has_many :orders, -> { order(:id) }, as: :parent, class_name: 'Effective::Order', dependent: :nullify
+    accepts_nested_attributes_for :orders
+
+    effective_resource do
+      # Acts as Statused
+      status                 :string, permitted: false
+      status_steps           :text, permitted: false
+
+      # Dates
+      submitted_at           :datetime
+
+      # Acts as Wizard
+      wizard_steps           :text, permitted: false
+
+      timestamps
+    end
+
+    scope :deep, -> { includes(:owner, :orders, :course_registrants) }
+    scope :sorted, -> { order(:id) }
+
+    scope :in_progress, -> { where.not(status: [:submitted]) }
+    scope :done, -> { where(status: [:submitted]) }
+
+    scope :for, -> (user) { where(owner: user) }
+
+    # All Steps validations
+    validates :owner, presence: true
+
+    # Course Step
+    validate(if: -> { current_step == :course }) do
+      self.errors.add(:course_registrants, "can't be blank") unless present_course_registrants.present?
+    end
+
+    # All Fees and Orders
+    def submit_fees
+      course_registrants
+    end
+
+    # Enroll them in all courses.
+    def after_submit_purchased!
+      course_registrants.each { |registrant| registrant.owner.create_learndash_enrollment(course: registrant.learndash_course) }
+    end
+
+  end
+
+  # Instance Methods
+  def to_s
+    persisted? ? "#{learndash_course} - #{owner}" : 'course registration'
+  end
+
+  def course
+    learndash_course
+  end
+
+  def in_progress?
+    draft?
+  end
+
+  def done?
+    submitted?
+  end
+
+  def course_registrant
+    course_registrants.first
+  end
+
+  def build_course_registrant
+    course_registrants.build(owner: owner, learndash_course: learndash_course)
+  end
+
+  def learndash_owner
+    (course_registrant&.owner || owner)
+  end
+
+  def member_pricing?
+    learndash_owner.membership_present?
+  end
+
+  def registration_price
+    raise('expected a learndash course') unless learndash_course.present?
+    raise('expected a learndash owner') unless learndash_owner.present?
+
+    member_pricing? ? learndash_course.member_price : learndash_course.regular_price
+  end
+
+  def assign_pricing
+    course_registrant.assign_attributes(
+      price: registration_price,
+      qb_item_name: learndash_course.qb_item_name,
+      tax_exempt: learndash_course.tax_exempt
+    )
+  end
+
+  # After the course step.
+  def course!
+    raise('expected a learndash course') unless learndash_course.present?
+    raise('expected a course_registrant to be present') unless course_registrant.present?
+    raise('expected a course_registrant to have an owner') unless course_registrant.owner.present?
+    raise('expected a learndash owner') unless learndash_owner.class.try(:effective_learndash_owner?)
+
+    # Assign prices
+    assign_pricing()
+    raise('expected course_registrants to have a price') if course_registrants.any? { |registrant| registrant.price.blank? }
+
+    # Save record
+    save!
+
+    # Create a learndash user now before payment to catch any errors in server stuff before payment.
+    learndash_owner.create_learndash_user
+    raise('expected a persisted learndash user') unless learndash_owner.learndash_user&.persisted?
+
+    true
+  end
+
+  private
+
+  def present_course_registrants
+    course_registrants.reject(&:marked_for_destruction?)
+  end
+
+end

data/app/models/concerns/effective_learndash_owner.rb

@@ -57,7 +57,7 @@ module EffectiveLearndashOwner
     return true if enrollment.completed?
 
     # Check the API
-    enrollment.sync!
+    enrollment.refresh!
     enrollment.completed?
   end
 

data/app/models/effective/course_registrant.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# This is the registrant as created by the course registration
+# It tracks who purchased which course for how much
+
+module Effective
+  class CourseRegistrant < ActiveRecord::Base
+    acts_as_purchasable
+
+    log_changes(to: :learndash_course) if respond_to?(:log_changes)
+
+    # The learndash course containing all the pricing and unique info about this course purchase
+    belongs_to :learndash_course
+
+    # Every course is charged to a owner
+    belongs_to :owner, polymorphic: true
+
+    # As checked out through the learndash course purchase wizard
+    belongs_to :course_registration, polymorphic: true
+
+    effective_resource do
+      # Acts as Purchasable
+      price             :integer
+      qb_item_name      :string
+      tax_exempt        :boolean
+
+      timestamps
+    end
+
+    scope :sorted, -> { order(:id) }
+    scope :deep, -> { includes(:learndash_course, :owner, :course_registration) }
+
+    before_validation(if: -> { course_registration.present? }) do
+      self.learndash_course ||= course_registration.learndash_course
+      self.owner ||= course_registration.owner
+    end
+
+    before_validation(if: -> { learndash_course.present? }) do
+      self.price ||= learndash_course.price
+      self.qb_item_name ||= learndash_course.qb_item_name
+      self.tax_exempt = learndash_course.tax_exempt? if self.tax_exempt.nil?
+    end
+
+    def to_s
+      persisted? ? title : 'course purchase'
+    end
+
+    def title
+      "#{learndash_course} - #{owner}"
+    end
+
+  end
+end

data/app/models/effective/course_registration.rb

@@ -0,0 +1,5 @@
+module Effective
+  class CourseRegistration < ActiveRecord::Base
+    effective_learndash_course_registration
+  end
+end

data/app/models/effective/learndash_api.rb

@@ -60,13 +60,14 @@ module Effective
 
       username = username_for(owner)
       password = password_for(owner)
+      email = email_for(owner)
 
       payload = {
         username: username,
         password: password,
+        email: email,
 
         name: owner.to_s,
-        email: owner.email,
         roles: ['subscriber'],
 
         first_name: owner.try(:first_name),
@@ -145,15 +146,23 @@ module Effective
     end
 
     def username_for(resource)
-      raise('expected a learndash owner') unless resource.class.respond_to?(:effective_learndash_owner?) # This is a user
+      raise('expected a LearnDash owner') unless resource.class.respond_to?(:effective_learndash_owner?) # This is a user
 
       name = EffectiveLearndash.wp_username_for(resource)
       name = "test#{name}" unless Rails.env.production?
       name
     end
 
+    def email_for(resource)
+      raise('expected a LearnDash owner') unless resource.class.respond_to?(:effective_learndash_owner?) # This is a user
+
+      email = resource.email
+      email = "test#{email}" unless Rails.env.production?
+      email
+    end
+
     def password_for(resource)
-      raise('expected a learndash owner') unless resource.class.respond_to?(:effective_learndash_owner?) # This is a user
+      raise('expected a LearnDash owner') unless resource.class.respond_to?(:effective_learndash_owner?) # This is a user
       EffectiveLearndash.wp_password_for(resource)
     end
 
@@ -169,7 +178,7 @@ module Effective
       elsif response.kind_of?(Array)
         response.first
       else
-        raise("unexpected Learndash API response #{response}")
+        raise("unexpected LearnDash API response #{response}")
       end
     end
 
@@ -190,7 +199,7 @@ module Effective
         elsif response.kind_of?(Array)
           response
         else
-          raise("unexpected Learndash API find_by response #{response}")
+          raise("unexpected LearnDash API find_by response #{response}")
         end
       )