\n
diff --git a/spec/components/schemas/AccessPlanResponse.yaml b/spec/components/schemas/AccessPlanResponse.yaml
deleted file mode 100644
index 1bf89f90..00000000
--- a/spec/components/schemas/AccessPlanResponse.yaml
+++ /dev/null
@@ -1,71 +0,0 @@
-required:
- - price
-allOf:
- - $ref: '#/components/schemas/AccessPlan'
- - type: object
- properties:
- title:
- description: Access plan name.
- type: object
- properties:
- rendered:
- type: string
- description: Rendered title.
- example: Liftetime Access
- raw:
- type: string
- description: Raw title. Useful when displaying title in the WP Block Editor. Only returned in `edit` context.
- example: Liftetime Access
- content:
- description: Access plan short description.
- type: object
- properties:
- rendered:
- type: string
- description: Rendered description.
- example: \n
Expectoque quid ad id
quod quaerebam, respondeas
\n
- raw:
- type: string
- description: Raw description. Useful when displaying title in the WP Block Editor. Only returned in `edit` context.
- example: \n
Expectoque quid ad id
quod quaerebam, respondeas
\n
- _links:
- description: A map of links to other related API resources.
- type: object
- readOnly: true
- properties:
- self:
- description: REST URI to the access plan.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/access-plans/123
- collection:
- description: REST URI to the access plan collection.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/access-plans
- post:
- description: REST URI to the access plan's related course or membership.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/courses/789
- restrictions:
- description: REST URIs to the memberships required to use the access plan.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/memberships?include=123,456,789
diff --git a/spec/components/schemas/Address.yaml b/spec/components/schemas/Address.yaml
deleted file mode 100644
index ba794bfe..00000000
--- a/spec/components/schemas/Address.yaml
+++ /dev/null
@@ -1,26 +0,0 @@
-type: object
-properties:
- address_1:
- description: Address line 1.
- type: string
- example: 1234 Somewhere Place
- address_2:
- description: Address line 2.
- type: string
- example: Suite ABC
- city:
- description: City name.
- type: string
- example: Anywhere
- state:
- description: 'ISO code or state, province, or district name.'
- type: string
- example: CA
- postcode:
- description: Postal code.
- type: string
- example: 12345-678
- country:
- description: ISO country code.
- type: string
- example: US
diff --git a/spec/components/schemas/Course.yaml b/spec/components/schemas/Course.yaml
deleted file mode 100644
index 26e5923a..00000000
--- a/spec/components/schemas/Course.yaml
+++ /dev/null
@@ -1,104 +0,0 @@
-allOf:
- - type: object
- properties:
- id:
- readOnly: true
- description: Unique Course Identifier. The WordPress Post `ID`.
- - $ref: '#/components/schemas/PostPublic'
- - type: object
- properties:
- permalink:
- example: https://example.com/course/getting-started-with-lifterlms
- post_type:
- default: course
- type: string
- catalog_visibility:
- description: Visibility of the course in catalogs and search results.
- type: string
- categories:
- description: List of course categories.
- type: array
- items:
- type: integer
- tags:
- description: List of course tags.
- type: array
- items:
- type: integer
- difficulties:
- description: List of course difficulties.
- type: array
- default: []
- example: [ 7 ]
- items:
- type: integer
- tracks:
- description: List of course tracks.
- type: array
- default: []
- example: [ 8, 9 ]
- items:
- type: integer
- audio_embed:
- description: URL to an oEmbed enable audio URL.
- type: string
- example: https://open.spotify.com/track/trackid
- video_embed:
- description: URL to an oEmbed enable video URL.
- type: string
- example: https://www.youtube.com/watch?v=videoid
- capacity_enabled:
- description: Determines if an enrollment capacity limit is enabled.
- type: boolean
- default: false
- capacity_limit:
- description: Number of students who can be enrolled in the course before enrollment closes.
- minimum: 0
- type: integer
- example: 25
- prerequisite:
- description: Course ID of the prerequisite course.
- type: integer
- example: 456
- prerequisite_track:
- description: Term ID of a the prerequisite track.
- type: integer
- example: 789
- access_opens_date:
- description: >-
- Date when the course opens, allowing enrolled students to begin to view and interact with the restricted course content.
- If blank the course is open until after the `access_closes_date` has passed.
- Does not affect course enrollment, see `enrollment_opens_date` to control the course enrollment start date.
- Format: `Y-m-d H:i:s`.
- type: string
- example: '2019-05-20 17:22:05'
- access_closes_date:
- description: >-
- Date when the course closes. After this date enrolled students may no longer view and interact with the restricted course content.
- If blank the course is open indefinitely after the the `access_opens_date` has passed.
- Does not affect course enrollment, see `enrollment_opens_date` to control the course enrollment close date.
- Format: `Y-m-d H:i:s`.
- type: string
- example: '2019-06-05 17:22:05'
- enrollment_opens_date:
- description: >-
- Date when the course enrollment opens.
- If blank course enrollment is open until after the `enrollment_closes_date` has passed.
- Does not affect course content access, see `access_opens_date` to control course access start date.
- Format: `Y-m-d H:i:s`.
- type: string
- example: '2019-05-15 12:15:00'
- enrollment_closes_date:
- description: >-
- Date when the course enrollment closes.
- If blank course enrollment is open indefinitely after the the `enrollment_opens_date` has passed.
- Does not affect course content access, see `access_opens_date` to control course access close date.
- Format: `Y-m-d H:i:s`.
- type: string
- example: '2019-10-01 23:59:59'
- video_tile:
- description: When `true` the `video_embed` will be used on the course tiles (on the catalog, for example) instead of the featured image.
- type: boolean
- default: false
-
- - $ref: '#/components/schemas/SharedCourseMembership'
diff --git a/spec/components/schemas/CourseRequest.yaml b/spec/components/schemas/CourseRequest.yaml
deleted file mode 100644
index 6c9a01ed..00000000
--- a/spec/components/schemas/CourseRequest.yaml
+++ /dev/null
@@ -1,33 +0,0 @@
-allOf:
- - $ref: '#/components/schemas/PostContentRequest'
- - type: object
- properties:
- access_opens_message:
- description: Message displayed to enrolled students when the course is accessed before the `access_opens_date` has passed.
- type: string
- default: This course opens on [lifterlms_course_info key="start_date"].
- access_closes_message:
- description: Message displayed to enrolled students when the course is accessed after the `access_closes_date` has passed.
- type: string
- default: This course closed on [lifterlms_course_info key="end_date"].
- enrollment_opens_message:
- description: Message displayed to visitors when attempting to enroll into a course before the `enrollment_opens_date` has passed.
- type: string
- default: Enrollment in this course opens on [lifterlms_course_info key="enrollment_start_date"].
- enrollment_closes_message:
- description: Message displayed to visitors when attempting to enroll into a course after the `enrollment_closes_date` has passed.
- type: string
- default: Enrollment in this course closed on [lifterlms_course_info key="enrollment_end_date"].
- capacity_message:
- description: Message displayed when enrollment capacity has been reached.
- type: string
- default: Enrollment has closed because the maximum number of allowed students has been reached.
- length:
- description: User defined course length.
- type: string
- example: 7 days
- restricted_message:
- description: Message displayed when non-enrolled visitors try to access restricted course content (lessons, quizzes, etc..) directly.
- type: string
- default: You must enroll in this course to access course content.
- - $ref: '#/components/schemas/Course'
diff --git a/spec/components/schemas/CourseResponse.yaml b/spec/components/schemas/CourseResponse.yaml
deleted file mode 100644
index ab4097a7..00000000
--- a/spec/components/schemas/CourseResponse.yaml
+++ /dev/null
@@ -1,216 +0,0 @@
-allOf:
- - $ref: '#/components/schemas/PostContentResponse'
- - type: object
- properties:
- access_opens_message:
- description: Message displayed to enrolled students when the course is accessed before the `access_opens_date` has passed.
- type: object
- properties:
- rendered:
- description: Rendered message content.
- type: string
- default: This course opens on January, 28, 2019.
- raw:
- description: Raw message content.
- type: string
- default: This course opens on [lifterlms_course_info key="start_date"].
- access_closes_message:
- description: Message displayed to enrolled students when the course is accessed after the `access_closes_date` has passed.
- type: object
- properties:
- rendered:
- description: Rendered message content.
- type: string
- default: This course closed on March 5, 2018.
- raw:
- description: Raw message content.
- type: string
- default: This course closed on [lifterlms_course_info key="end_date"].
- enrollment_opens_message:
- description: Message displayed to visitors when attempting to enroll into a course before the `enrollment_opens_date` has passed.
- type: object
- properties:
- rendered:
- description: Rendered message content.
- type: string
- default: Enrollment in this course opens on opens on January, 28, 2019.
- raw:
- description: Raw message content.
- type: string
- default: Enrollment in this course opens on [lifterlms_course_info key="enrollment_start_date"].
- enrollment_closes_message:
- description: Message displayed to visitors when attempting to enroll into a course after the `enrollment_closes_date` has passed.
- type: object
- properties:
- rendered:
- description: Rendered message content.
- type: string
- default: Enrollment in this course closed on March 5, 2018.
- raw:
- description: Raw message content.
- type: string
- default: Enrollment in this course closed on [lifterlms_course_info key="enrollment_end_date"].
- capacity_message:
- description: Message displayed when enrollment capacity has been reached.
- type: object
- properties:
- rendered:
- description: Rendered message content.
- type: string
- example: Enrollment has closed because the maximum number of allowed students has been reached.
- raw:
- description: Raw message content.
- type: string
- example: Enrollment has closed because the maximum number of allowed students has been reached.
- length:
- description: User defined course length.
- type: object
- properties:
- rendered:
- description: Rendered length description.
- type: string
- example: 7 days
- raw:
- description: Raw length description.
- type: string
- example: 7 days
- restricted_message:
- description: Message displayed when non-enrolled visitors try to access restricted course content (lessons, quizzes, etc..) directly.
- type: object
- properties:
- rendered:
- description: Rendered message content.
- type: string
- default: You must enroll in this course to access course content.
- raw:
- description: Raw message content.
- type: string
- default: You must enroll in this course to access course content.
- - $ref: '#/components/schemas/Course'
- - type: object
- properties:
- _links:
- description: A map of links to other related API resources.
- type: object
- readOnly: true
- properties:
- self:
- description: REST URI to the course.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/courses/1234
- collection:
- description: REST URI to the course collection.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/courses
- access_plans:
- description: REST URI to the collection of access plans for the course.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/access-plans?post_id=1234
- content:
- description: REST URI to the course's content collection.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/courses/1234/content
- enrollments:
- description: REST URI to the collection of the courses's enrollments.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/courses/1234/enrollments
- instructors:
- description: REST URI to the collection of the course's instructors.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/instructors?post=1234
- prerequisites:
- description: REST URIs to course prerequisite resources.
- type: array
- example: [
- {
- "type": "course",
- "href": "/wp-json/llms/v1/courses/456"
- },
- {
- "type": "track",
- "href": "/wp-json/wp/v2/course_track/789"
- }
- ]
- items:
- type: object
- properties:
- type:
- type: string
- href:
- type: string
- students:
- description: REST URI to the collection of the course's enrolled students.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/students?enrolled_in=1234
- wp:featured_media:
- description: REST URI to the WordPress attachement image.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/wp/v2/media/987
- wp:term:
- description: Collection of REST URIs to the course's taxonomy term information.
- type: array
- example: [
- {
- "taxonomy": "course_cat",
- "href": "/wp-json/wp-v2/course_cat?post=123"
- },
- {
- "taxonomy": "course_tag",
- "href": "/wp-json/wp-v2/course_tag?post=123"
- },
- {
- "taxonomy": "course_difficulty",
- "href": "/wp-json/wp-v2/course_difficulty?post=123"
- },
- {
- "taxonomy": "course_track",
- "href": "/wp-json/wp-v2/course_track?post=123"
- }
- ]
- items:
- type: object
- properties:
- taxonomy:
- type: string
- href:
- type: string
diff --git a/spec/components/schemas/Enrollment.yaml b/spec/components/schemas/Enrollment.yaml
deleted file mode 100644
index b0082abb..00000000
--- a/spec/components/schemas/Enrollment.yaml
+++ /dev/null
@@ -1,72 +0,0 @@
-type: object
-properties:
- student_id:
- description: The ID of the student.
- type: integer
- minimum: 1
- example: 123
- readOnly: true
- post_id:
- description: The ID of the course/membership.
- type: integer
- minimum: 1
- example: 456
- readOnly: true
- date_created:
- description: 'The enrollment creation date. Format: `Y-m-d H:i:s`'
- type: string
- example: '2019-05-21 14:22:05'
- date_updated:
- description: 'The date of the last enrollment update. Format: `Y-m-d H:i:s`'
- type: string
- example: '2019-05-21 19:22:05'
- readOnly: true
- status:
- $ref: '#/components/schemas/EnrollmentStatus'
- _links:
- description: A map of links to other related API resources.
- readOnly: true
- type: object
- properties:
- self:
- description: REST URI to the enrollment.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/students/123/enrollments/456
- collection:
- description: REST URI to the enrollments collection.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/students/123/enrollments
- post:
- description: Rest URI to the post resource.
- type: array
- items:
- type: object
- properties:
- type:
- type: string
- enum:
- - course
- - membership
- example: course
- href:
- type: string
- example: /wp-json/llms/v1/courses/456
- student:
- description: Rest URI to the student resource.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/students/123
diff --git a/spec/components/schemas/EnrollmentStatus.yaml b/spec/components/schemas/EnrollmentStatus.yaml
deleted file mode 100644
index b15505f4..00000000
--- a/spec/components/schemas/EnrollmentStatus.yaml
+++ /dev/null
@@ -1,6 +0,0 @@
-description: The status of the enrollment.
-type: string
-enum:
- - enrolled
- - expired
- - cancelled
diff --git a/spec/components/schemas/Error.yaml b/spec/components/schemas/Error.yaml
deleted file mode 100644
index e2ed46d3..00000000
--- a/spec/components/schemas/Error.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-type: object
-properties:
- code:
- description: The API error code.
- message:
- description: The API error message.
- data:
- description: Additional response data.
- type: object
- properties:
- status:
- minimum: 100
- maximum: 600
- description: The HTTP status code.
diff --git a/spec/components/schemas/Error400.yaml b/spec/components/schemas/Error400.yaml
deleted file mode 100644
index 1ccf8eb4..00000000
--- a/spec/components/schemas/Error400.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-allOf:
- - $ref: '#/components/schemas/Error'
- - properties:
- code:
- default: llms_rest_bad_request
- type: string
- message:
- default: Invalid or malformed request syntax.
- type: string
- data:
- properties:
- status:
- default: 400
- type: integer
diff --git a/spec/components/schemas/Error401.yaml b/spec/components/schemas/Error401.yaml
deleted file mode 100644
index cc687914..00000000
--- a/spec/components/schemas/Error401.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-allOf:
- - $ref: '#/components/schemas/Error'
- - properties:
- code:
- default: llms_rest_unauthorized_request
- type: string
- message:
- default: The API credentials were invalid.
- type: string
- data:
- properties:
- status:
- default: 401
- type: integer
diff --git a/spec/components/schemas/Error403.yaml b/spec/components/schemas/Error403.yaml
deleted file mode 100644
index d2cfcb98..00000000
--- a/spec/components/schemas/Error403.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-allOf:
- - $ref: '#/components/schemas/Error'
- - properties:
- code:
- default: llms_rest_forbidden_request
- type: string
- message:
- default: You are not authorized to perform this request.
- type: string
- data:
- properties:
- status:
- default: 403
- type: integer
diff --git a/spec/components/schemas/Error404.yaml b/spec/components/schemas/Error404.yaml
deleted file mode 100644
index 257d4644..00000000
--- a/spec/components/schemas/Error404.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-allOf:
- - $ref: '#/components/schemas/Error'
- - properties:
- code:
- default: llms_rest_not_found
- type: string
- message:
- default: The requested resource could not be found.
- type: string
- data:
- properties:
- status:
- default: 404
- type: integer
diff --git a/spec/components/schemas/Instructor.yaml b/spec/components/schemas/Instructor.yaml
deleted file mode 100644
index 19cfe9d2..00000000
--- a/spec/components/schemas/Instructor.yaml
+++ /dev/null
@@ -1,52 +0,0 @@
-allOf:
- - type: object
- properties:
- id:
- description: Unique Instructor Identifer. The WordPress User `ID`.
- readOnly: true
- - $ref: '#/components/schemas/User'
- - type: object
- properties:
- roles:
- description: The user's WordPress user role.
- type: array
- default: [ instructor ]
- items:
- type: string
- enum:
- - administrator
- - lms_manager
- - instructor
- - instructors_assistant
- _links:
- description: A map of links to other related API resources.
- type: object
- readOnly: true
- properties:
- self:
- description: REST URI to the instructor.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/instructors/1234
- collection:
- description: REST URI to the instructor collection.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/instructors
- content:
- description: REST URI to a collection of the instructor's content.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/instructors/1234/contents
diff --git a/spec/components/schemas/Lesson.yaml b/spec/components/schemas/Lesson.yaml
deleted file mode 100644
index ffec7664..00000000
--- a/spec/components/schemas/Lesson.yaml
+++ /dev/null
@@ -1,137 +0,0 @@
-allOf:
- - type: object
- properties:
- id:
- description: Unique lesson identifier. The WordPress Post `ID`.
- readOnly: true
- - $ref: '#/components/schemas/PostPublic'
- - type: object
- properties:
- id:
- readOnly: true
- example: 789
- permalink:
- example: https://example.com/lesson/getting-started-with-lifterlms
- post_type:
- default: lesson
- type: string
- audio_embed:
- description: URL to an oEmbed enable audio URL.
- type: string
- example: https://open.spotify.com/track/trackid
- video_embed:
- description: URL to an oEmbed enable video URL.
- type: string
- example: https://www.youtube.com/watch?v=videoid
- prerequisite:
- description: Lesson ID of the prerequisite lesson.
- type: integer
- example: 321
- public:
- description: Denotes a lesson that's publicly accessible regardless of course enrollment.
- type: boolean
- default: false
- course_id:
- description: WordPress post ID of the lesson's parent course.
- type: integer
- minimum: 1
- example: 1234
- readOnly: true
- parent_id:
- description: WordPress post ID of the parent item. Must be a Section ID. `0` indicates an "orphaned" lesson which can be edited and viewed by instructors and admins but cannot be read by students.
- type: integer
- minimum: 0
- example: 987
- points:
- description: Determines the weight of the lesson when grading the course.
- type: integer
- minimum: 0
- default: 1
- order:
- description: Order of the lesson within its immediate parent.
- type: integer
- default: 1
- minimum: 1
- drip_method:
- description: |
- Determine the method with which to make the lesson content available.
-
- - `none`: Drip is disabled; the lesson is immediately available.
- - `date`: Lesson is made available at a specific date and time.
- - `enrollment`: Lesson is made available a specific number of days after enrollment into the course.
- - `start`: Lesson is made available a specific number of days after the course's start date. Only available on courses with a `access_opens_date`.
- - `prerequisite`: Lesson is made available a specific number of days after the `prerequisite` lesson is completed.
- type: string
- enum:
- - none
- - date
- - enrollment
- - start
- - prerequisite
- default: none
- drip_days:
- description: Number of days to wait before allowing access to the lesson. Applicable only when `drip_method` is `enrollment`, `start`, or `prerequisite`.
- type: integer
- minimum: 1
- default: 1
- drip_date:
- description: 'The date and time when the lesson becomes available. Applicable only when `drip_method` is `date`. Format: `Y-m-d H:i:s`.'
- type: string
- nullable: true
- example: '2019-12-12 23:23:59'
- quiz:
- description: Associate a quiz with this lesson.
- type: object
- properties:
- enabled:
- description: Determines if a quiz is enabled for the lesson.
- type: boolean
- default: false
- example: true
- id:
- description: The post ID of the associated quiz.
- type: integer
- minimum: 0
- default: 0
- example: 432
- progression:
- description: |
- Determines lesson progression requirements related to the quiz.
-
- - `complete`: The quiz must be completed (with any grade) to progress the lesson.
- - `pass`: A passing grade must be earned to progress the lesson.
- type: string
- enum:
- - complete
- - pass
- default: complete
- assignment:
- description: |
- Associate an assignment with this lesson.
-
- _While assignment functionality is included with the LifterLMS Core REST API, the assignments themselves are implemented by the LifterLMS Assignments add-on._
- type: object
- properties:
- enabled:
- description: Determines if an assignment is enabled for the lesson.
- type: boolean
- default: false
- example: true
- id:
- description: The post ID of the associated assingment.
- type: integer
- minimum: 0
- default: 0
- example: 876
- progression:
- description: |
- Determines lesson progression requirements related to the assignment.
-
- - `complete`: The assignment must be completed (with any grade) to progress the lesson.
- - `pass`: A passing grade must be earned to progress the lesson.
- type: string
- enum:
- - complete
- - pass
- default: complete
-
diff --git a/spec/components/schemas/LessonRequest.yaml b/spec/components/schemas/LessonRequest.yaml
deleted file mode 100644
index d2cc5328..00000000
--- a/spec/components/schemas/LessonRequest.yaml
+++ /dev/null
@@ -1,3 +0,0 @@
-allOf:
- - $ref: '#/components/schemas/PostContentRequest'
- - $ref: '#/components/schemas/Lesson'
diff --git a/spec/components/schemas/LessonResponse.yaml b/spec/components/schemas/LessonResponse.yaml
deleted file mode 100644
index f185ac3d..00000000
--- a/spec/components/schemas/LessonResponse.yaml
+++ /dev/null
@@ -1,115 +0,0 @@
-allOf:
- - $ref: '#/components/schemas/PostContentResponse'
- - $ref: '#/components/schemas/Lesson'
- - type: object
- properties:
- _links:
- description: A map of links to other related API resources.
- type: object
- readOnly: true
- properties:
- self:
- description: REST URI to the lesson.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/lessons/1234
- collection:
- description: REST URI to the lesson collection.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/lessons
- assignment:
- description: REST URI to the lesson's assignment.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/assignments/876
- course:
- description: REST URI to the lesson's parent course.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/courses/1234
- next:
- description: REST URI to the next sibling lesson in the section.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/lessons/4567
- prerequisite:
- description: REST URIs to lesson prerequisite resources.
- type: array
- items:
- type: object
- properties:
- type:
- type: string
- example: lesson
- href:
- type: string
- example: /wp-json/llms/v1/lessons/321
- previous:
- description: REST URI to the previous sibling lesson in the section.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/lessons/8910
- parent:
- description: REST URI to the lessons's parent.
- type: array
- items:
- type: object
- properties:
- type:
- type: string
- example: section
- href:
- type: string
- example: /wp-json/llms/v1/sections/987
- quiz:
- description: REST URI to the lesson's quiz.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/quizzes/432
- siblings:
- description: REST URI to the collection of the lessons's siblings within its parent.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/lessons?parent=987
- wp:featured_media:
- description: REST URI to the WordPress attachement image.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/wp/v2/media/987
diff --git a/spec/components/schemas/Membership.yaml b/spec/components/schemas/Membership.yaml
deleted file mode 100644
index 5ce81220..00000000
--- a/spec/components/schemas/Membership.yaml
+++ /dev/null
@@ -1,55 +0,0 @@
-allOf:
- - type: object
- properties:
- id:
- readOnly: true
- description: Unique membership identifier. The WordPress Post `ID`.
- - $ref: '#/components/schemas/PostPublic'
- - type: object
- properties:
- permalink:
- example: https://example.com/membership/getting-started-with-lifterlms
- post_type:
- default: membership
- type: string
- categories:
- description: List of membership categories.
- type: array
- items:
- type: integer
- tags:
- description: List of membership tags.
- type: array
- items:
- type: integer
- restriction_action:
- description: |
- Determines the action to take when content restricted by the membership is accessed by a non-member.
- `none`: Remain on page and display the message `restriction_message`.
- `membership`: Redirect to the membership's permalink.
- `page`: Redirect to the permalink of the page identified by `restriction_page_id`.
- `custom`: Redirct to the URL identified by `restriction_url`.
- type: string
- enum:
- - none
- - membership
- - page
- - custom
- default: none
- restriction_page_id:
- description: WordPress page ID used for redirecting non-members when `restriction_action` is `page`.
- type: integer
- minimum: 1
- example: 456
- restriction_url:
- description: URL used for redirecting non-members when `restriction_action` is `custom`.
- type: string
- example: https://example.tld/my-custom-url
- auto_enroll:
- description: List of courses to automatically enroll students into when they're enrolled into the membership.
- type: array
- default: []
- example: [ 456, 789 ]
- items:
- type: integer
- - $ref: '#/components/schemas/SharedCourseMembership'
diff --git a/spec/components/schemas/MembershipRequest.yaml b/spec/components/schemas/MembershipRequest.yaml
deleted file mode 100644
index afc6434d..00000000
--- a/spec/components/schemas/MembershipRequest.yaml
+++ /dev/null
@@ -1,33 +0,0 @@
-allOf:
- - $ref: '#/components/schemas/PostContentRequest'
- - type: object
- properties:
- restriction_message:
- description: Message to display to non-members after a `restriction_action` redirct. When `restriction_action` is `none` replaces the page content with this message.
- type: string
- default: You must belong to the [lifterlms_membership_link id="1234"] membership to access this content.
- # access_closes_message:
- # description: Message displayed to enrolled students when the course is accessed after the `access_closes_date` has passed.
- # type: string
- # default: This course closed on [lifterlms_course_info key="end_date"].
- # enrollment_opens_message:
- # description: Message displayed to visitors when attempting to enroll into a course before the `enrollment_opens_date` has passed.
- # type: string
- # default: Enrollment in this course opens on [lifterlms_course_info key="enrollment_start_date"].
- # enrollment_closes_message:
- # description: Message displayed to visitors when attempting to enroll into a course after the `enrollment_closes_date` has passed.
- # type: string
- # default: Enrollment in this course closed on [lifterlms_course_info key="enrollment_end_date"].
- # capacity_message:
- # description: Message displayed when enrollment capacity has been reached.
- # type: string
- # default: Enrollment has closed because the maximum number of allowed students has been reached.
- # length:
- # description: User defined course length.
- # type: string
- # example: 7 days
- # restricted_message:
- # description: Message displayed when non-enrolled visitors try to access restricted course content (lessons, quizzes, etc..) directly.
- # type: string
- # default: You must enroll in this course to access course content.
- - $ref: '#/components/schemas/Membership'
diff --git a/spec/components/schemas/MembershipResponse.yaml b/spec/components/schemas/MembershipResponse.yaml
deleted file mode 100644
index 2c616e82..00000000
--- a/spec/components/schemas/MembershipResponse.yaml
+++ /dev/null
@@ -1,125 +0,0 @@
-allOf:
- - $ref: '#/components/schemas/PostContentResponse'
- - $ref: '#/components/schemas/Membership'
- - type: object
- properties:
- restriction_message:
- description: Message to display to non-members after a `restriction_action` redirct. When `restriction_action` is `none` replaces the page content with this message.
- type: object
- properties:
- rendered:
- description: Rendered message content.
- type: string
- default: You must belong to the Gold membership to access this content.
- raw:
- description: Raw message content.
- type: string
- default: You must belong to the [lifterlms_membership_link id="1234"] membership to access this content.
- - type: object
- properties:
- _links:
- description: A map of links to other related API resources.
- type: object
- readOnly: true
- properties:
- self:
- description: REST URI to the membership.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/memberships/1234
- collection:
- description: REST URI to the membership collection.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/memberships
- access_plans:
- description: REST URI to the collection of access plans for the membership.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/access-plans?post_id=1234
- auto_enrollment_courses:
- description: REST URI to the collection of automatic enrollment courses for the membership.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/courses?include=456,789
- enrollments:
- description: REST URI to the collection of the memberships's enrollments.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/enrollments?post=1234
- instructors:
- description: REST URI to the collection of the membership's instructors.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/instructors?post=1234
- students:
- description: REST URI to the collection of the membership's enrolled students.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/students?enrolled_in=1234
- wp:featured_media:
- description: REST URI to the WordPress attachement image.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/wp/v2/media/987
- wp:term:
- description: Collection of REST URIs to the membership's taxonomy term information.
- type: array
- example: [
- {
- "taxonomy": "membership_cat",
- "href": "/wp-json/wp-v2/membership_cat?post=123"
- },
- {
- "taxonomy": "membership_tag",
- "href": "/wp-json/wp-v2/membership_tag?post=123"
- },
- {
- "taxonomy": "membership_difficulty",
- "href": "/wp-json/wp-v2/membership_difficulty?post=123"
- },
- {
- "taxonomy": "membership_track",
- "href": "/wp-json/wp-v2/membership_track?post=123"
- }
- ]
- items:
- type: object
- properties:
- taxonomy:
- type: string
- href:
- type: string
-
diff --git a/spec/components/schemas/Post.yaml b/spec/components/schemas/Post.yaml
deleted file mode 100644
index 720a3b37..00000000
--- a/spec/components/schemas/Post.yaml
+++ /dev/null
@@ -1,32 +0,0 @@
-description: Reduced WordPress Post object properties shared by LifterLMS custom post types
-type: object
-required:
- - id
-properties:
- id:
- allOf:
- - description: Unique Post Identifier. The WordPress Post `ID`.
- - $ref: '#/components/schemas/ResourceId'
- date_created:
- description: 'Creation date. Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 17:22:05'
- date_created_gmt:
- description: 'Creation date (in GMT). Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 13:22:05'
- date_updated:
- description: 'Date last modified. Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 17:25:05'
- readOnly: true
- date_updated_gmt:
- description: 'Date last modified (in GMT). Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 13:25:05'
- readOnly: true
- menu_order:
- description: Custom post sort order.
- type: integer
- default: 0
- minimum: 0
diff --git a/spec/components/schemas/PostContentRequest.yaml b/spec/components/schemas/PostContentRequest.yaml
deleted file mode 100644
index eaac5bc6..00000000
--- a/spec/components/schemas/PostContentRequest.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-description: Post content request fields.
-type: object
-properties:
- title:
- type: string
- description: Raw title.
- example: Getting Started with LifterLMS
- content:
- type: string
- description: Raw post content.
- example: \n
Lorem ipsum dolor sit amet.
\n\n\n\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
\n
- excerpt:
- type: string
- description: Raw excerpt content.
- example: Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
-
diff --git a/spec/components/schemas/PostContentResponse.yaml b/spec/components/schemas/PostContentResponse.yaml
deleted file mode 100644
index 1c892062..00000000
--- a/spec/components/schemas/PostContentResponse.yaml
+++ /dev/null
@@ -1,40 +0,0 @@
-description: Post content fields.
-type: object
-properties:
- title:
- description: Post title.
- type: object
- properties:
- rendered:
- type: string
- description: Rendered title.
- example: Getting Started with LifterLMS
- raw:
- type: string
- description: Raw title. Useful when displaying title in the WP Block Editor. Only returned in `edit` context.
- example: Getting Started with LifterLMS
- content:
- description: Post content.
- type: object
- properties:
- rendered:
- type: string
- description: Rendered post content.
- example: \n
Lorem ipsum dolor sit amet.
\n\n\n\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
\n
- raw:
- type: string
- description: Raw post content. Useful when displaying title in the WP Block Editor. Only returned in `edit` context.
- example: \n
Lorem ipsum dolor sit amet.
\n\n\n\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
- raw:
- type: string
- description: Raw HTML content. Useful when displaying title in the WP Block Editor. Only returned in `edit` context.
- example: Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
-
diff --git a/spec/components/schemas/PostPublic.yaml b/spec/components/schemas/PostPublic.yaml
deleted file mode 100644
index c93daf51..00000000
--- a/spec/components/schemas/PostPublic.yaml
+++ /dev/null
@@ -1,42 +0,0 @@
-description: Reduced WordPress Post object properties shared by LifterLMS custom post types
-allOf:
- - $ref: '#/components/schemas/Post'
- - type: object
- properties:
- slug:
- description: Post URL slug.
- type: string
- example: getting-started-with-lifterlms
- permalink:
- description: Post URL.
- type: string
- example: https://example.com/post/getting-started-with-lifterlms
- readOnly: true
- post_type:
- allOf:
- - $ref: '#/components/schemas/PostType'
- - readOnly: true
- status:
- $ref: '#/components/schemas/PostStatus'
- password:
- description: Password used to protect access to the content. Readable only in `edit` context.
- type: string
- example: p4$sW0rd
- featured_media:
- description: Featured image ID.
- type: integer
- example: 987
- comment_status:
- description: Post comment status. Default comment status dependent upon general WordPress post discussion settings.
- type: string
- enum:
- - open
- - closed
- default: open
- ping_status:
- description: Post ping status. Default ping status dependent upon general WordPress post discussion settings.
- type: string
- enum:
- - open
- - closed
- default: open
diff --git a/spec/components/schemas/PostStatus.yaml b/spec/components/schemas/PostStatus.yaml
deleted file mode 100644
index b5b56c39..00000000
--- a/spec/components/schemas/PostStatus.yaml
+++ /dev/null
@@ -1,11 +0,0 @@
-description: The publication status of the course.
-type: string
-enum:
- - publish
- - pending
- - draft
- - auto-draft
- - future
- - private
- - trash
-default: publish
diff --git a/spec/components/schemas/PostType.yaml b/spec/components/schemas/PostType.yaml
deleted file mode 100644
index 7c3dbfe1..00000000
--- a/spec/components/schemas/PostType.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
-description: LifterLMS custom post types available for enrollments
-type: string
-enum:
- - course
- - llms_membership
- - section
-default: course
diff --git a/spec/components/schemas/Progress.yaml b/spec/components/schemas/Progress.yaml
deleted file mode 100644
index 918abd71..00000000
--- a/spec/components/schemas/Progress.yaml
+++ /dev/null
@@ -1,82 +0,0 @@
-type: object
-required:
- - status
-properties:
- student_id:
- description: The ID of the student.
- type: integer
- minimum: 1
- example: 123
- readOnly: true
- post_id:
- description: The ID of the course, section, or lesson.
- type: integer
- minimum: 1
- example: 456
- readOnly: true
- date_created:
- description: The progress creation date. Cannot be in the future.
- type: string
- format: date-time
- example: '2019-05-21T14:22:05'
- date_updated:
- description: The date of the last progress update.
- type: string
- format: date-time
- example: '2019-05-21T19:22:05'
- readOnly: true
- progress:
- description: Student's progress as a percentage.
- type: number
- format: float
- minimum: 0
- maximum: 100
- default: 0
- example: 89.83
- readOnly: true
- status:
- description: Student progress status.
- type: string
- enum:
- - incomplete
- - complete
- default: incomplete
- _links:
- description: A map of links to other related API resources.
- readOnly: true
- type: object
- properties:
- self:
- description: REST URI to the progress.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/students/123/progress/456
- post:
- description: Rest URI to the post resource.
- type: array
- items:
- type: object
- properties:
- type:
- type: string
- enum:
- - course
- - section
- - lesson
- example: course
- href:
- type: string
- example: /wp-json/llms/v1/courses/456
- student:
- description: Rest URI to the student resource.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/students/123
diff --git a/spec/components/schemas/Quiz.yaml b/spec/components/schemas/Quiz.yaml
deleted file mode 100644
index f607ec88..00000000
--- a/spec/components/schemas/Quiz.yaml
+++ /dev/null
@@ -1,103 +0,0 @@
-description: Base quiz post object.
-type: object
-properties:
- id:
- description: Unique quiz identifer. The WordPress Post `ID`.
- type: integer
- minimum: 234
- readOnly: true
- date_created:
- description: 'Creation date. Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 17:22:05'
- date_created_gmt:
- description: 'Creation date (in GMT). Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 13:22:05'
- date_updated:
- description: 'Date last modified. Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 17:25:05'
- readOnly: true
- date_updated_gmt:
- description: 'Date last modified (in GMT). Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 13:25:05'
- readOnly: true
- slug:
- description: Quiz URL slug.
- type: string
- example: final-exam
- permalink:
- description: Quiz URL.
- type: string
- example: https://example.tld/quiz/final-exam
- readOnly: true
- post_type:
- allOf:
- - $ref: '#/components/schemas/PostType'
- - readOnly: true
- type: string
- default: llms_quiz
- status:
- description: The publication status of the quiz.
- type: string
- enum:
- - publish
- - draft
- default: draft
- attempt_limiting:
- description: |
- Determine if attempt limiting is enabled.
-
- When enabled, students are locked out after the number of attempts specified by `allowed_attempts`.
- type: boolean
- default: false
- example: true
- attempts_allowed:
- description: Limit the number of times a student can attempt the quiz before the quiz is locked. Only used when `attempt_limiting` is `true`.
- type: integer
- minimum: 1
- time_limiting:
- description: |
- Determine if a time limit is enforced for each attempt.
-
- When enabled, a quiz attempt is automatically ended after the time period specified by `time_limit` has passed.
- type: boolean
- default: false
- example: true
- time_limit:
- description: Determines the number of minutes allowed for each quiz attempt. Only used when `time_limiting` is `true`.
- type: integer
- minimum: 1
- example: 90
- passing_percentage:
- description: Determines the grade required to consider an attempt "passing".
- type: number
- minimum: 0
- default: 65
- total_points:
- description: The total points of all questions within the quiz.
- type: integer
- minimum: 0
- example: 10
- readOnly: true
- show_correct_answer:
- description: When enabled, students will be shown the correct answers to questions they answered incorrectly during quiz reviews.
- type: boolean
- default: false
- randomize_questions:
- description: When enabled, questions will be shuffled into a random order for each new quiz attempt.
- type: boolean
- default: false
- course_id:
- description: WordPress post ID of the quizzes's parent course.
- type: integer
- minimum: 1
- example: 1234
- readOnly: true
- parent_id:
- description: WordPress post ID of the parent item. Must be a Lesson ID. `0` indicates an "orphaned" quiz which can be edited and viewed by instructors and admins but cannot be taken by students.
- type: integer
- minimum: 0
- example: 789
diff --git a/spec/components/schemas/QuizQuestion.yaml b/spec/components/schemas/QuizQuestion.yaml
deleted file mode 100644
index a87f5e6d..00000000
--- a/spec/components/schemas/QuizQuestion.yaml
+++ /dev/null
@@ -1,57 +0,0 @@
-description: Base quiz question post object.
-type: object
-properties:
- id:
- description: Unique question identifer. The WordPress Post `ID`.
- type: integer
- minimum: 234
- readOnly: true
- date_created:
- description: 'Creation date. Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 17:22:05'
- date_created_gmt:
- description: 'Creation date (in GMT). Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 13:22:05'
- date_updated:
- description: 'Date last modified. Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 17:25:05'
- readOnly: true
- date_updated_gmt:
- description: 'Date last modified (in GMT). Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 13:25:05'
- readOnly: true
- post_type:
- allOf:
- - $ref: '#/components/schemas/PostType'
- - readOnly: true
- type: string
- default: llms_question
- order:
- description: Order of the question within its immediate parent.
- type: integer
- default: 1
- minimum: 1
- parent_id:
- description: Resource ID of the question's parent (quiz).
- type: integer
- minimum: 1
- example: 234
- points:
- description: Number of points awarded for correctly answering the question.
- type: integer
- minimum: 0
- default: 1
- example: 10
- video_embed:
- description: URL to an oEmbed enable video URL.
- type: string
- example: https://www.youtube.com/watch?v=videoid
- featured_media:
- description: Featured image ID.
- type: integer
- example: 205
-
diff --git a/spec/components/schemas/QuizQuestionRequest.yaml b/spec/components/schemas/QuizQuestionRequest.yaml
deleted file mode 100644
index 5a32c721..00000000
--- a/spec/components/schemas/QuizQuestionRequest.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-type: object
-properties:
- title:
- description: Raw quiz title. Most likely in the form of a question.
- type: string
- example: What is your favorite color?
- content:
- description: Raw quiz content. Useful for providing additional information or context to the question.
- type: string
- example:
Lorem ipsum dolor sit amet.
\n\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
- answer_clarification:
- description: Raw additional clarifying information displayed on the quiz attempt review screen when the question was answered incorrectly.
- type: string
- example:
Lorem ipsum dolor sit amet.
\n\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
diff --git a/spec/components/schemas/QuizQuestionResponse.yaml b/spec/components/schemas/QuizQuestionResponse.yaml
deleted file mode 100644
index 016590ca..00000000
--- a/spec/components/schemas/QuizQuestionResponse.yaml
+++ /dev/null
@@ -1,38 +0,0 @@
-type: object
-properties:
- title:
- description: Quiz title. Most likely in the form of a question.
- type: object
- properties:
- rendered:
- type: string
- description: Rendered title.
- example: What is your favorite color?
- raw:
- type: string
- description: Raw title. Useful when displaying title in the WP Editor. Only returned in `edit` context.
- example: What is your favorite color?
- content:
- description: Quiz content. Useful for providing additional information or context to the question.
- type: object
- properties:
- rendered:
- type: string
- description: Rendered content.
- example:
Lorem ipsum dolor sit amet.
\n\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
- raw:
- type: string
- description: Raw content. Useful when displaying title in the WP Block Editor. Only returned in `edit` context.
- example:
Lorem ipsum dolor sit amet.
\n\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
- answer_clarification:
- description: Additional clarifying information displayed on the quiz attempt review screen when the question was answered incorrectly.
- type: object
- properties:
- rendered:
- type: string
- description: Rendered content.
- example:
Lorem ipsum dolor sit amet.
\n\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
- raw:
- type: string
- description: Raw content. Useful when displaying title in the WP Block Editor. Only returned in `edit` context.
- example:
Lorem ipsum dolor sit amet.
\n\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
diff --git a/spec/components/schemas/QuizQuestionTypeBlank.yaml b/spec/components/schemas/QuizQuestionTypeBlank.yaml
deleted file mode 100644
index 172b1841..00000000
--- a/spec/components/schemas/QuizQuestionTypeBlank.yaml
+++ /dev/null
@@ -1,19 +0,0 @@
-title: Fill in the Blank
-description: Fill in the Blank quiz question type
-allOf:
- - $ref: '#/components/schemas/QuizQuestion'
- - type: object
- properties:
- question_type:
- description: The type of question.
- type: string
- default: blank
- correct_value:
- description: |
- Specify the correct value(s) for each blank in the `title` property and enable automatic grading of the question.
-
- For questions with multiple blanks, separate each blank by with a pipe (`|`) character. The correct values should be supplied in the same order as the blanks.
- type: string
- example: 'foo|bar'
-
-
diff --git a/spec/components/schemas/QuizQuestionTypeChoice.yaml b/spec/components/schemas/QuizQuestionTypeChoice.yaml
deleted file mode 100644
index d0a07ac7..00000000
--- a/spec/components/schemas/QuizQuestionTypeChoice.yaml
+++ /dev/null
@@ -1,60 +0,0 @@
-title: Multiple Choice
-description: Choice quiz question type
-allOf:
- - $ref: '#/components/schemas/QuizQuestion'
- - type: object
- properties:
- question_type:
- description: The type of question.
- type: string
- default: choice
- choices:
- description: A collection of choices available for the question.
- type: array
- minItems: 2
- maxItems: 26
- example: [
- {
- "marker": "A",
- "choice": "Red",
- "correct": false
- },
- {
- "marker": "B",
- "choice": "Green",
- "correct": true
- }
- ]
- items:
- type: object
- properties:
- id:
- description: Unique resource identifier for the choice.
- type: string
- readOnly: true
- marker:
- description: |
- The marker used to visually identify and order the choices.
-
- Valid markers: `A` through `Z`.
-
- If no marker is supplied, the next available marker in the range will be used.
- type: string
- default: A
- choice:
- description: Raw choice text.
- type: string
- correct:
- description: |
- Determines if the choice is correct.
-
- When `multi_choices` is disabled, only one choice may be marked as `correct`.
- type: boolean
- default: false
- multi_choices:
- description: |
- Enable multiple correct answers.
-
- When disabled only a single correct choice is available, when enabled, one or more correct choices are available.
- type: boolean
- default: false
diff --git a/spec/components/schemas/QuizQuestionTypeContent.yaml b/spec/components/schemas/QuizQuestionTypeContent.yaml
deleted file mode 100644
index abb668e0..00000000
--- a/spec/components/schemas/QuizQuestionTypeContent.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-title: Content
-description: Content quiz question type
-allOf:
- - type: object
- properties:
- question_type:
- description: The type of question.
- type: string
- default: content
- points:
- type: integer
- readOnly: true
- example: 0
- default: 0
- - $ref: '#/components/schemas/QuizQuestion'
diff --git a/spec/components/schemas/QuizQuestionTypeLongAnswer.yaml b/spec/components/schemas/QuizQuestionTypeLongAnswer.yaml
deleted file mode 100644
index 4b2463dc..00000000
--- a/spec/components/schemas/QuizQuestionTypeLongAnswer.yaml
+++ /dev/null
@@ -1,20 +0,0 @@
-title: Long Answer
-description: Long answer quiz question type
-allOf:
- - $ref: '#/components/schemas/QuizQuestion'
- - type: object
- properties:
- question_type:
- description: The type of question.
- type: string
- default: long_answer
- words_min:
- description: Minimum word count for the answer. Setting the minimum at `0` disables the minimum word count.
- type: integer
- minimum: 0
- example: 500
- words_max:
- description: Maximum word count for the answer. Setting the maximum at `0` disables the maximum word count.
- type: integer
- minimum: 0
- example: 10000
diff --git a/spec/components/schemas/QuizQuestionTypePictureChoice.yaml b/spec/components/schemas/QuizQuestionTypePictureChoice.yaml
deleted file mode 100644
index 2d5ef7b7..00000000
--- a/spec/components/schemas/QuizQuestionTypePictureChoice.yaml
+++ /dev/null
@@ -1,75 +0,0 @@
-title: Picture Choice
-description: Picuter choice quiz question type
-allOf:
- - $ref: '#/components/schemas/QuizQuestion'
- - type: object
- properties:
- question_type:
- description: The type of question.
- type: string
- default: picture_choice
- choices:
- description: A collection of choices available for the question.
- type: array
- minItems: 2
- maxItems: 26
- example: [
- {
- "marker": "A",
- "choice": {
- "id": 98,
- "src": "https://mysite.tld/wp-content/uploads/2019/05/picture-choice-img-1.png"
- },
- "correct": false
- },
- {
- "marker": "B",
- "choice": {
- "id": 99,
- "src": "https://mysite.tld/wp-content/uploads/2019/05/picture-choice-img-2.png"
- },
- "correct": true
- }
- ]
- items:
- type: object
- properties:
- id:
- description: Unique resource identifier for the choice.
- type: string
- readOnly: true
- marker:
- description: |
- The marker used to visually identify and order the choices.
-
- Valid markers: `A` through `Z`.
-
- If no marker is supplied, the next available marker in the range will be used.
- type: string
- default: A
- choice:
- description: Object of image information for the choice.
- type: object
- properties:
- id:
- description: WP Attachment ID for the choice image.
- type: integer
- minimum: 1
- src:
- description: Full URL to the image resource on the server. Only returned in edit context
- type: string
- readOnly: true
- correct:
- description: |
- Determines if the choice is correct.
-
- When `multi_choices` is disabled, only one choice may be marked as `correct`.
- type: boolean
- default: false
- multi_choices:
- description: |
- Enable multiple correct answers.
-
- When disabled only a single correct choice is available, when enabled, one or more correct choices are available.
- type: boolean
- default: false
diff --git a/spec/components/schemas/QuizQuestionTypeTrueFalse.yaml b/spec/components/schemas/QuizQuestionTypeTrueFalse.yaml
deleted file mode 100644
index 6a722369..00000000
--- a/spec/components/schemas/QuizQuestionTypeTrueFalse.yaml
+++ /dev/null
@@ -1,48 +0,0 @@
-title: True / False
-description: True / False quiz question type
-allOf:
- - $ref: '#/components/schemas/QuizQuestion'
- - type: object
- properties:
- question_type:
- description: The type of question.
- type: string
- default: true_false
- choices:
- description: A collection of choices available for the question.
- type: array
- minItems: 2
- maxItems: 2
- example: [
- {
- "marker": "A",
- "choice": "True",
- "correct": false
- },
- {
- "marker": "B",
- "choice": "False",
- "correct": true
- }
- ]
- items:
- type: object
- properties:
- id:
- description: Unique resource identifier for the choice.
- type: string
- readOnly: true
- marker:
- description: The marker used to visually identify and order the choices.
- type: string
- enum:
- - A
- - B
- default: A
- choice:
- description: Raw choice text.
- type: string
- correct:
- description: Determines if the choice is correct.
- type: boolean
- default: false
diff --git a/spec/components/schemas/QuizQuestionTypesResponseList.yaml b/spec/components/schemas/QuizQuestionTypesResponseList.yaml
deleted file mode 100644
index 980cbad8..00000000
--- a/spec/components/schemas/QuizQuestionTypesResponseList.yaml
+++ /dev/null
@@ -1,25 +0,0 @@
-anyOf:
- - title: Multiple Choice
- allOf:
- - $ref: '#/components/schemas/QuizQuestionTypeChoice'
- - $ref: '#/components/schemas/QuizQuestionResponse'
- - title: Picture Choice
- allOf:
- - $ref: '#/components/schemas/QuizQuestionTypePictureChoice'
- - $ref: '#/components/schemas/QuizQuestionResponse'
- - title: True / False
- allOf:
- - $ref: '#/components/schemas/QuizQuestionTypeTrueFalse'
- - $ref: '#/components/schemas/QuizQuestionResponse'
- - title: Content
- allOf:
- - $ref: '#/components/schemas/QuizQuestionTypeContent'
- - $ref: '#/components/schemas/QuizQuestionResponse'
- - title: Fill in the Blank
- allOf:
- - $ref: '#/components/schemas/QuizQuestionTypeBlank'
- - $ref: '#/components/schemas/QuizQuestionResponse'
- - title: Long Answer
- allOf:
- - $ref: '#/components/schemas/QuizQuestionTypeLongAnswer'
- - $ref: '#/components/schemas/QuizQuestionResponse'
diff --git a/spec/components/schemas/QuizRequest.yaml b/spec/components/schemas/QuizRequest.yaml
deleted file mode 100644
index dd08bf92..00000000
--- a/spec/components/schemas/QuizRequest.yaml
+++ /dev/null
@@ -1,12 +0,0 @@
-allOf:
- - $ref: '#/components/schemas/Quiz'
- - type: object
- properties:
- title:
- type: string
- description: Raw title.
- example: Final Exam
- content:
- type: string
- description: Raw content.
- example:
Lorem ipsum dolor sit amet.
\n\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
diff --git a/spec/components/schemas/QuizResponse.yaml b/spec/components/schemas/QuizResponse.yaml
deleted file mode 100644
index 9cff89fd..00000000
--- a/spec/components/schemas/QuizResponse.yaml
+++ /dev/null
@@ -1,72 +0,0 @@
-allOf:
- - $ref: '#/components/schemas/Quiz'
- - type: object
- properties:
- title:
- description: Quiz title.
- type: object
- properties:
- rendered:
- type: string
- description: Rendered title.
- example: Final Exam
- raw:
- type: string
- description: Raw title. Useful when displaying title in the WP Editor. Only returned in `edit` context.
- example: Final Exam
- content:
- description: Post content.
- type: object
- properties:
- rendered:
- type: string
- description: Rendered content.
- example:
Lorem ipsum dolor sit amet.
\n\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
- raw:
- type: string
- description: Raw content. Useful when displaying title in the WP Block Editor. Only returned in `edit` context.
- example:
Lorem ipsum dolor sit amet.
\n\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
- _links:
- description: A map of links to other related API resources.
- type: object
- readOnly: true
- properties:
- self:
- description: REST URI to the lesson.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/quizzes/234
- collection:
- description: REST URI to the lesson collection.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/quizzes
- course:
- description: REST URI to the lesson's parent course.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/courses/1234
- parent:
- description: REST URI to the quiz's parent.
- type: array
- items:
- type: object
- properties:
- type:
- type: string
- example: course
- href:
- type: string
- example: /wp-json/llms/v1/lessons/789
diff --git a/spec/components/schemas/ResourceId.yaml b/spec/components/schemas/ResourceId.yaml
deleted file mode 100644
index 25b661d9..00000000
--- a/spec/components/schemas/ResourceId.yaml
+++ /dev/null
@@ -1,5 +0,0 @@
-description: Unique Resource Identifier.
-type: integer
-minimum: 1
-example: 123
-readOnly: true
diff --git a/spec/components/schemas/Section.yaml b/spec/components/schemas/Section.yaml
deleted file mode 100644
index ee671f87..00000000
--- a/spec/components/schemas/Section.yaml
+++ /dev/null
@@ -1,43 +0,0 @@
-type: object
-properties:
- id:
- allOf:
- - description: Unique section identifier. The WordPress Post `ID`.
- readOnly: true
- - $ref: '#/components/schemas/ResourceId'
- - example: 987
- date_created:
- description: 'Creation date. Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 17:22:05'
- date_created_gmt:
- description: 'Creation date (in GMT). Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 13:22:05'
- date_updated:
- description: 'Date last modified. Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 17:25:05'
- readOnly: true
- date_updated_gmt:
- description: 'Date last modified (in GMT). Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 13:25:05'
- readOnly: true
- order:
- description: Order of the section within the course.
- type: integer
- default: 1
- minimum: 1
- parent_id:
- description: WordPress post ID of the parent item. Must be a Course ID.
- type: integer
- minimum: 1
- example: 1234
- post_type:
- allOf:
- - $ref: '#/components/schemas/PostType'
- - type: string
- default: section
- readOnly: true
-
diff --git a/spec/components/schemas/SectionRequest.yaml b/spec/components/schemas/SectionRequest.yaml
deleted file mode 100644
index ed449305..00000000
--- a/spec/components/schemas/SectionRequest.yaml
+++ /dev/null
@@ -1,12 +0,0 @@
-allOf:
- - type: object
- required:
- - title
- - order
- - parent_id
- properties:
- title:
- type: string
- description: Raw title.
- example: Getting Started with LifterLMS
- - $ref: '#/components/schemas/Section'
diff --git a/spec/components/schemas/SectionResponse.yaml b/spec/components/schemas/SectionResponse.yaml
deleted file mode 100644
index d2b1c608..00000000
--- a/spec/components/schemas/SectionResponse.yaml
+++ /dev/null
@@ -1,88 +0,0 @@
-allOf:
- - $ref: '#/components/schemas/Section'
- - type: object
- properties:
- title:
- description: Section Title
- type: object
- properties:
- rendered:
- description: Rendered title.
- type: string
- example: Introduction
- raw:
- description: Raw title.
- type: string
- example: Introduction
- _links:
- description: A map of links to other related API resources.
- type: object
- readOnly: true
- properties:
- self:
- description: REST URI to the section.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/sections/1234
- collection:
- description: REST URI to the section collection.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/sections
- content:
- description: REST URI to the section's child content.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/sections/1234/content
- next:
- description: REST URI to the next sibling section in the course.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/sections/3456
- parent:
- description: REST URI to the section's parent.
- type: array
- items:
- type: object
- properties:
- type:
- type: string
- example: course
- href:
- type: string
- example: /wp-json/llms/v1/courses/1234
- prevous:
- description: REST URI to the prevous sibling section in the course.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/sections/7891
- siblings:
- description: REST URI to the collection of the section's siblings within its parent.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/courses/1234/content?exclude=7891
-
diff --git a/spec/components/schemas/SharedCourseMembership.yaml b/spec/components/schemas/SharedCourseMembership.yaml
deleted file mode 100644
index bc033bc0..00000000
--- a/spec/components/schemas/SharedCourseMembership.yaml
+++ /dev/null
@@ -1,62 +0,0 @@
-description: Properties shared by courses and memberships.
-type: object
-properties:
- catalog_visibility:
- description: Visibility of the post in catalogs and search results.
- type: string
- enum:
- - catalog_search
- - catalog
- - search
- - hidden
- default: catalog_search
- categories:
- description: List of post categories.
- type: array
- default: []
- example: [ 1, 2, 3 ]
- items:
- type: integer
- tags:
- description: List of post tags.
- type: array
- default: []
- example: [ 4, 5, 6 ]
- items:
- type: integer
- instructors:
- description: List of post instructors. Defaults to current user when creating a new post.
- type: array
- default: []
- example: [ 1, 2, 3 ]
- minItems: 1
- items:
- type: integer
- sales_page_type:
- description: >-
- Defines alternate content displayed to visitors and non-enrolled students when accessing the post.
- - `none` displays the post content.
- - `content` displays alternate content from the `excerpt` property.
- - `page` redirects to the WordPress page defined in `content_page_id`.
- - `url` redirects to the URL defined in `content_page_url`.
- type: string
- enum:
- - none
- - content
- - page
- - url
- default: none
- sales_page_page_id:
- description: >-
- The WordPress page ID of the sales page.
- Required when `sales_page_type` equals `page`.
- Only returned when the `sales_page_type` equals `page`.
- type: integer
- example: 543
- sales_page_url:
- description: >-
- The URL of the sales page content.
- Required when `sales_page_type` equals `url`.
- Only returned when the `sales_page_type` equals `url`.
- type: string
- example: https://example.tld/custom-sales-page
diff --git a/spec/components/schemas/Student.yaml b/spec/components/schemas/Student.yaml
deleted file mode 100644
index b0b99ccc..00000000
--- a/spec/components/schemas/Student.yaml
+++ /dev/null
@@ -1,56 +0,0 @@
-allOf:
- - type: object
- properties:
- id:
- description: Unique Student Identifer. The WordPress User `ID`.
- readOnly: true
- - $ref: '#/components/schemas/User'
- - type: object
- properties:
- roles:
- description: The user's WordPress user role.
- type: array
- default: [ student ]
- items:
- type: string
- _links:
- description: A map of links to other related API resources.
- type: object
- readOnly: true
- properties:
- self:
- description: REST URI to the student.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/students/456
- collection:
- description: REST URI to the student collection.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/students
- enrollments:
- description: REST URI to a collection of the student's enrollments.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/students/456/enrollments
- progress:
- description: REST URI to a collection of the student's progress records.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/students/456/progress
diff --git a/spec/components/schemas/User.yaml b/spec/components/schemas/User.yaml
deleted file mode 100644
index 3f4d7128..00000000
--- a/spec/components/schemas/User.yaml
+++ /dev/null
@@ -1,91 +0,0 @@
-description: Reduced WordPress User object properties shared by LifterLMS custom user types
-type: object
-properties:
- id:
- allOf:
- - $ref: '#/components/schemas/ResourceId'
- - description: Unique User Identifer. The WordPress User `ID`.
- example: 456
- email:
- description: The user's email address.
- type: string
- example: jamie@lifterlms.com
- username:
- description: The user's username.
- type: string
- example: jamie2019
- password:
- description: The user's password.
- type: string
- example: my_l337-p@$5w0rd!
- writeOnly: true
- description:
- description: The user's biography or description.
- type: string
- example: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
- registered_date:
- description: The user's original site registration date.
- type: string
- example: '2019-05-03 19:25:01'
- avatar_urls:
- description: |
- A list of the Gravatars available for the user.
-
- The object key is the size (in pixels) of the avatar and the value is the Gravatar's URL.
- type: object
- readOnly: true
- properties:
- 24:
- type: string
- example: https://secure.gravatar.com/avatar/30eab7b16342fe5f772ed30a36da2763?s=24&d=mm&r=g
- 48:
- type: string
- example: https://secure.gravatar.com/avatar/30eab7b16342fe5f772ed30a36da2763?s=48&d=mm&r=g
- 96:
- type: string
- example: https://secure.gravatar.com/avatar/30eab7b16342fe5f772ed30a36da2763?s=48&d=mm&r=g
- url:
- description: The user's URL.
- type: string
- example: https://myawesomewebsite.tld
- first_name:
- description: The user's first name.
- type: string
- example: Jamie
- last_name:
- description: The user's last name.
- type: string
- example: Cook
- nickname:
- description: The user's chosen nickname.
- type: string
- example: JamieC
- name:
- description: The user's public display name.
- type: string
- example: Jamie Cook
- billing_address_1:
- description: Address line 1.
- type: string
- example: 1234 Somewhere Place
- billing_address_2:
- description: Address line 2.
- type: string
- example: Suite ABC
- billing_city:
- description: City name.
- type: string
- example: Anywhere
- billing_state:
- description: ISO code or state, province, or district name.
- type: string
- example: CA
- billing_postcode:
- description: Postal code.
- type: string
- example: 12345-678
- billing_country:
- description: ISO country code.
- type: string
- example: US
-
diff --git a/spec/components/schemas/UserName.yaml b/spec/components/schemas/UserName.yaml
deleted file mode 100644
index 6a5637dc..00000000
--- a/spec/components/schemas/UserName.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-type: object
-properties:
- first:
- description: The person's first name.
- type: string
- example: Jamie
- last:
- description: The person's last name.
- type: string
- example: Cook
- display:
- description: The person's public display name.
- type: string
- example: Jamie Cook
diff --git a/spec/components/schemas/Webhook.yaml b/spec/components/schemas/Webhook.yaml
deleted file mode 100644
index 8f54c58b..00000000
--- a/spec/components/schemas/Webhook.yaml
+++ /dev/null
@@ -1,100 +0,0 @@
-type: object
-properties:
- id:
- allOf:
- - description: Unique webhook Identifier. The WordPress post `ID`.
- - $ref: '#/components/schemas/ResourceId'
- - example: 654
- name:
- description: A friendly, human-readable name for the webhook.
- type: string
- minimum: 1
- example: A Student Enrolled in a Course
- status:
- description: |
- The status of the webhook.
-
- + `active`: Payload will be delivered
- + `paused`: Delivery is disabled by an admin.
- + `disabled`: Delivery is disabled because of delivery failure.
- type: string
- enum:
- - active
- - paused
- - disabled
- default: active
- topic:
- description: The Webhook topic.
- type: string
- example: student.created
- url:
- description: The webhook payload delivery URL.
- type: string
- example: https://example.tld/webhook-receipt/endpoint
- secret:
- description: |
- An optional secret key used to generate the webhook delivery signature.
-
- If no secret is supplied and random string will be generated using `wp_generate_password()`.
- type: string
- example: $P3CI41-$3CR37!
- resource:
- description: The parsed `topic` resource.
- type: string
- readOnly: true
- example: student
- event:
- description: The parsed `topic` event.
- type: string
- readOnly: true
- example: created
- hooks:
- description: An array of hook names associated with the topic.
- type: array
- items:
- type: string
- example: 'llms_user_registered'
- readOnly: true
- date_created:
- description: 'Creation date. Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 17:22:05'
- readOnly: true
- date_created_gmt:
- description: 'Creation date (in GMT). Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 13:22:05'
- readOnly: true
- date_updated:
- description: 'Date last modified. Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 17:25:05'
- readOnly: true
- date_updated_gmt:
- description: 'Date last modified (in GMT). Format: `Y-m-d H:i:s`.'
- type: string
- example: '2019-05-20 13:25:05'
- readOnly: true
- _links:
- description: A map of links to other related API resources.
- readOnly: true
- type: object
- properties:
- self:
- description: REST URI to the webhook.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/webhooks/654
- collection:
- description: REST URI to the webhooks collection.
- type: array
- items:
- type: object
- properties:
- href:
- type: string
- example: /wp-json/llms/v1/webhooks/
diff --git a/spec/components/securitySchemes/Basic-Authentication.yaml b/spec/components/securitySchemes/Basic-Authentication.yaml
deleted file mode 100644
index d0166009..00000000
--- a/spec/components/securitySchemes/Basic-Authentication.yaml
+++ /dev/null
@@ -1,2 +0,0 @@
-type: http
-scheme: basic
diff --git a/spec/openapi.yaml b/spec/openapi.yaml
deleted file mode 100644
index f3bddcc9..00000000
--- a/spec/openapi.yaml
+++ /dev/null
@@ -1,361 +0,0 @@
-openapi: 3.0.0
-info:
- version: 1.0.0-beta.1
- title: LifterLMS REST API
- description: >-
- # Introduction
-
- LifterLMS (LLMS) is fully integrated with the [WordPress REST API](https://developer.wordpress.org/rest-api/). This allows LifterLMS data to be created, read, updated, and deleted using requests in JSON format and using WordPress REST API Authentication methods and standard HTTP verbs which are understood by most HTTP clients.
-
- ## Public Beta
-
- As of LifterLMS version 3.34.0, the LifterLMS REST API is included in the LifterLMS core plugin for public evaluation and testing.
-
- The specification may change slightly over the next few months as we evaluate feedback and use-cases. If you are building integrations relying on the REST API please keep your eye on our changelog and let us know how things are going!
-
- If you're interested in contributing or discussing the REST API, please join us in [GitHub](https://github.com/gocodebox/lifterlms-rest) and post in `#developers` on the [LifterLMS Community Slack](https://lifterlms.com/slack).
-
- ## Requirements
-
- To use the latest version of the REST API you must be using the following:
-
- + LifterLMS Version 3.34.0+.
- + WordPress 5.2+.
- + Pretty permalinks in `Settings -> Permalinks` so that the custom endpoints are supported. **Default permalinks will not work.**
- + An SSL certificate.
-
- ## Libraries and Tools
-
- ### Official Libraries
-
- LifterLMS develops and maintains official libraries for different programming languages so you can easily build around the REST API.
-
- + [Node/Javascript](https://github.com/gocodebox/llms-api-node)
- + PHP (coming soon)
-
- ### Tools
-
- Some useful tools to help develop and access the REST API:
-
- + [Postman](https://www.getpostman.com/) - A multi platform REST API GUI client.
- + [RESTCLient](https://addons.mozilla.org/en-US/firefox/addon/restclient/) - A free Firefox add-on.
- + [Advanced REST client](https://chrome.google.com/webstore/detail/advanced-rest-client/hgmloofddffdnphfgcellkdfbfbjeloo) - A free Google Chrome extension.
- + [RequestBin](https://requestbin.com/) - A free service allowing you to quickly test webhooks.
-
- # Authentication
-
- Requests to most API resources require authentication. Authentication can be preformed by providing API Credentials by using as the username and password via [HTTP Basic Authentication](http://en.wikipedia.org/wiki/Basic_access_authentication) or through request headers.
-
-
- Requests to the REST API may only be made over [HTTPS](http://en.wikipedia.org/wiki/HTTP_Secure). Requests made over HTTP will fail.
-
- ## Basic Authentication
-
- The preferred authentication method is HTTP Basic Authentication.
-
- To use HTTP Basic Auth, provide the Consumer Key as the username and the Consumer Secret as the password.
-
- ```
- curl https://example.tld/wp-json/llms/v1/courses \
- -u ck_d7W85twOWT0poKzDSAQzI7:sk_8bsMmRfjW1HgEFw5ad7BIF
- ```
-
- ## Header Authentication
-
- Alternatively, requests may be authenticated by providing the Consumer Key and Consumer secret as the request headers `X-LLMS-CONSUMER-KEY` and `X-LLMS-CONSUMER-SECRET`.
-
- ```
- curl https://example.tld/wp-json/llms/v1/courses \
- -H X-LLMS-CONSUMER-KEY: ck_d7W85twOWT0poKzDSAQzI7 \
- -H X-LLMS-CONSUMER-SECRET: sk_8bsMmRfjW1HgEFw5ad7BIF
- ```
-
- x-logo:
- altText: LifterLMS
- url: "https://gocodebox.github.io/lifterlms-brand/assets/img/png/logo/lifterlms-logo.png"
- href: "https://lifterlms.com/"
-
-servers:
- - url: /wp-json/llms/v1
-
-security:
- - Basic-Authentication: []
-
-tags:
-
- - name: API Keys
- description: |
- API Keys are used to authenticate REST API requests.
-
- The API keys API allows you to create, view, update, and delete API keys.
-
- ## API Key Properties
-
-
-
- - name: Access Plans
- description: |
- Access plans allow you to define how LMS content is purchased and accessed by your students.
-
- The access plans API allows you to create, view, update, and delete access plans.
-
- ## Access Plan Properties
-
-
-
- - name: Courses
- description: |
- The courses API allows you to create, view, update, and delete courses.
-
- ## Course Properties
-
-
-
- - name: Instructors
- description: |
- Instructors are members of your site who have the ability to create and manage LMS content and students. Instructors may be Adminstators, LMS Managers, Instructors, and Instructors Assistants.
-
- The instructors API allows you to create, view, update, and delete student accounts.
-
- ## Instructor Properties
-
-
-
- - name: Memberships
- description: |
- The memberships API allows you to create, view, update, and delete memberships.
-
- ## Membership Properties
-
-
-
- - name: Quiz Questions
- description: |
- The quiz questions API allows you to create, view, update, and delete quiz questions.
-
- ## Question Types
-
- There are four unique question types available via the LifterLMS Core:
-
- + Multiple Choice
- + Picture Choice
- + True / False
- + Content
-
- An additional eight question types are available with the LifterLMS Advanced Quizzes Add-on:
-
- + Fill in the Blank
- + Reorder Items
- + Reorder Pictures
- + Short Answer
- + Long Answer
- + File Upload
- + Code
- + Scale
-
- While these additional question types are documented here, they are only available when the LifterLMS Advanced Quizzes Add-on is installed and activated on your site.
-
- - name: Quizzes
- description: |
- The quizzes API allows you to create, view, update, and delete quizzes.
-
- ## Quiz Properties
-
-
-
- - name: Sections
- description: |
- The sections API allows you to create, view, update, and delete sections.
-
- Sections are used within courses to organize content (lessons) into groups.
-
- ## Section Properties
-
-
-
- - name: Students
- description: |
- Students are members of your site who are (or were) enrolled in your courses and memberships. Students can be any WordPress user account on your site (not exclusively the "student" role).
-
- The students API allows you to create, view, update, and delete student accounts as well as view information about the student's LMS content.
-
- ## Student Properties
-
-
-
- - name: Student Enrollments
- description: |
- The Student Enrollments API allows you to create, view, update, and delete records of a student's enrollment into courses and memberships.
-
- ## Enrollment Properties
-
-
-
- - name: Student Progress
- description: |
- The Student Progress API allows you to create, view, update, and delete a student's progress through courses.
-
- A student's progress through a course is calculated by dividing the number of lessons completed by the student by the total number of lessons available in a course. It is not possible to manually update the `progress` percentage property of a course, instead you must update the status of each lesson in the course.
-
- When updating the status of a course or a section, the status of the lessons within that course or section will be automatically updated to match the status of the course or section. For example, when updating a course's status to `complete` a new `complete` progress record will be created/updated for each incomplete lesson in the course.
-
- Finally, the `progress` property of a lesson will _always_ be either `0` _or_ `100` whereas the `progress` of courses and sections will range from `0` _to_ `100`.
-
- ## Progress Properties
-
-
-
- - name: Webhooks
- description: |
- Webhooks can be created to notify you about LMS-related events that happen on your site.
-
- The Webhooks API allows you to create, view, update, and delete webhooks.
-
- Webhooks may additionally be managed on the LifterLMS Webhooks screen on your site's WordPress admin panel.
-
- ## Topics
-
- The `topic` is a combination of the resource (e.g. student) and event (e.g. created). Each `topic` maps to one or more hook names (e.g. `llms_user_registered`). The proper hooks are automatically added based on the `topic`.
-
- The following topics are available:
-
- + Courses
- + `course.created`
- + `course.updated`
- + `course.deleted`
- + `course.restored`
- + Sections
- + `section.created`
- + `section.updated`
- + `section.deleted`
- + `section.restored`
- + Lessons
- + `lesson.created`
- + `lesson.updated`
- + `lesson.deleted`
- + `lesson.restored`
- + Memberships
- + `membership.created`
- + `membership.updated`
- + `membership.deleted`
- + `membership.restored`
- + Students
- + `student.created`
- + `student.updated`
- + `student.deleted`
- + Student Enrollment
- + `enrollment.created`
- + `enrollment.updated`
- + `enrollment.deleted`
- + Student Progress
- + `progress.updated`
- + `progress.deleted`
- + Instructors
- + `instructor.created`
- + `instructor.updated`
- + `instructor.deleted`
-
- Custom topics can also be used in order to create a webhook triggered by an arbitrary WordPress hook. For a custom topic use the `action` resource with any hook as the event. For example, to create a webhook triggered by the `user_register` hook the topic would be `action.user_register`.
-
- ## Delivery
-
- Webhook payloads are delivered in the background using wp-cron and `wp_remote_post()` (HTTP POST).
-
- Custom headers are supplied to assist with the receipt of the webhook:
-
- | Header | Description | Example |
- | ------------------------ | -------------------------------------------------- | ------------------- |
- | X-LLMS-Webhook-Source | The URL of the LifterLMS website. | https://example.tld |
- | X-LLMS-Webhook-Topic | The webhook `topic` property. | student.created |
- | X-LLMS-Webhook-Resource | The webhook `resource` property. | student |
- | X-LLMS-Webhook-Event | The webhook `event` property. | created |
- | X-LLMS-Webhook-Signature | A base64 encoded HMAC-SHA256 hash of the payload. | |
- | X-LLMS-Webhook-ID | The unique webhook identifier (WordPress post ID). | 654 |
- | X-LLMS-Delivery-ID | A unique ID for the webhook delivery. | 765 |
-
- The payload is a JSON-encoded object of the API resource as if retrieved by a `GET` request.
-
- The payload for a custom hook will be a JSON-encoded version of the first parameter supplied by the hook.
-
- ## Signature Verification
-
- Webhooks are signed by LifterLMS and the event's unique signature is included in the `X-LLMS-Webhook-Signature` header. The signature allows you to verify that the webhook was sent by LifterLMS and not by a third party. We recommend verifying all webhooks and discarding any payloads which cannot be verified.
-
- The `X-LLMS-Webhook-Signature` contains a timestamp and one or more signatures. The timestamp is prefixed by `t=` and the signatures are prefixed by `v` and an integer. Currently the only valid signature scheme is `v1`.
-
- ```
- X-LLMS-Webhook-Signature: t=1562715579,v1=0d579d62ef442b6e2d1d522924aafed480fdaaacbe498486a94445de8b995819
- ```
-
- The signature is generated using a hash-based message authentication code ([HMAC](https://en.wikipedia.org/wiki/HMAC)) with [SHA-256](https://en.wikipedia.org/wiki/SHA-2).
-
- To verify a webhook signature you must construct an _expected_ webhook signature which you can then compare against the webhook signature supplied with delivery.
-
- #### Step 1: Extract the timestamps and signatures from the header
-
- Split the header, using the `,` character as the separator, to get a list of elements. Then split each element, using the `=` character as the separator, to get a prefix and value pair.
-
- The value for the prefix `t` corresponds to the timestamp, and `v1` corresponds to the signature. You can discard all other elements.
-
- #### Step 2: Prepare the payload string for signing
-
- You achieve this by concatenating:
-
- + The timestamp (as a string)
- + The character `.`
- + The actual JSON payload (i.e. the request's body)
-
- #### Step 3: Generate the expected signature string
-
- Compute an HMAC with the SHA256 hash function. Use the endpoints signing secret as the key, and use the string from Step 2 as the message.
-
- #### Step 4: Compare the signatures
-
- Compare the signature(s) in the header to the expected signature. If a signature matches, compute the difference between the current timestamp and the received timestamp, then decide if the difference is within your tolerance. We recommend accepting a difference of no more than five minutes between the provided timestamp and the current time.
-
- ## Webook Properties
-
-
-
-x-tagGroups:
-
- - name: API Keys
- tags:
- - API Keys
-
- - name: Courses
- tags:
- - Courses
- - Sections
- - Lessons
-
- # @todo: Implement
- # - name: E-Commerce
- # tags:
- # - Access Plans
-
- - name: Instructors
- tags:
- - Instructors
-
- - name: Memberships
- tags:
- - Memberships
-
- # @todo: Implment.
- # - name: Quizzes
- # tags:
- # - Quizzes
- # - Quiz Questions
- # - Quiz Attempts
-
- - name: Students
- tags:
- - Students
- - Student Enrollments
- - Student Progress
-
- - name: Webhooks
- tags:
- - Webhooks
-
diff --git a/spec/paths/README.md b/spec/paths/README.md
deleted file mode 100644
index 8d584cde..00000000
--- a/spec/paths/README.md
+++ /dev/null
@@ -1,5 +0,0 @@
-Paths
-=====
-
-* Write each path specification in separate file
-* Filename is mapped to path by replacing `@` with `/`, i.e. `user@{username}.yaml` matches to `user/{username}` path
diff --git a/spec/paths/access-plans.yaml b/spec/paths/access-plans.yaml
deleted file mode 100644
index 4fb0f740..00000000
--- a/spec/paths/access-plans.yaml
+++ /dev/null
@@ -1,90 +0,0 @@
-get:
- summary: List access plans
- description: Retrieve a list of access plans.
- tags:
- - Access Plans
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- required: false
- schema:
- type: string
- enum:
- - id
- - title
- - date_created
- - date_updated
- - menu_order
- default: id
- - $ref: '#/components/parameters/Include'
- - $ref: '#/components/parameters/Exclude'
- - name: post_id
- description: Retrieve access plans for a specific list of one or more posts. Accepts a course/membership id or comma separted list of course/membership ids.
- in: query
- schema:
- type: string
- example: 123,456
- responses:
- 200:
- description: Successfully returned a list of access plans.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/AccessPlanResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
-
-post:
- summary: Create an access plan
- description: Create a new access plan object.
- tags:
- - Access Plans
- requestBody:
- required: true
- content:
- application/json:
- schema:
- allOf:
- - $ref: '#/components/schemas/AccessPlanRequest'
- - required:
- - title
- - price
- - post_id
- responses:
- 201:
- description: Successfully created the student.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AccessPlanResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/access-plans@{id}.yaml b/spec/paths/access-plans@{id}.yaml
deleted file mode 100644
index 0dd99217..00000000
--- a/spec/paths/access-plans@{id}.yaml
+++ /dev/null
@@ -1,77 +0,0 @@
-parameters:
- - name: id
- in: path
- description: Unique AccessPlan Identifier. The WordPress Post `ID`.
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: Retrieve an access plan
- description: Retrieve the details of an existing access plan.
- tags:
- - Access Plans
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/PostPassword'
- responses:
- 200:
- description: Successfully retrieved the access plan.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AccessPlanResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-post:
- summary: Update an access plan
- description: >-
- Update the specified access plan by setting the values of the parameters passed.
- Any parameters not provided will be left unchanged.
- tags:
- - Access Plans
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AccessPlanRequest'
- responses:
- 200:
- description: Successfully updated the access plan.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AccessPlanResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-delete:
- summary: Delete an access plan
- description: Delete an existing access plan.
- tags:
- - Access Plans
- responses:
- 204:
- description: Successfully deleted the access plan.
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
diff --git a/spec/paths/api-keys.yaml b/spec/paths/api-keys.yaml
deleted file mode 100644
index c533f32d..00000000
--- a/spec/paths/api-keys.yaml
+++ /dev/null
@@ -1,117 +0,0 @@
-get:
- summary: List API keys
- description: Retrieve a list of API keys.
- tags:
- - API Keys
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- required: false
- schema:
- type: string
- enum:
- - id
- - description
- - last_access
- default: id
- - $ref: '#/components/parameters/Include'
- - $ref: '#/components/parameters/Exclude'
- - name: user
- description: Include only keys for the specified user(s). Accepts a single id or a comma separated list of ids.
- in: query
- required: false
- schema:
- type: integer
- example: [ 123, 456 ]
- - name: user_not_in
- description: Exclude keys for the specified user(s). Accepts a single id or a comma separated list of ids.
- in: query
- required: false
- schema:
- type: integer
- example: [ 123, 456 ]
- - name: permissions
- description: Include only API keys matching a specific permission.
- in: query
- required: false
- schema:
- type: string
- enum:
- - read
- - write
- - read_write
- responses:
- 200:
- description: Successfully returned a list of API keys.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/APIKey'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
-
-post:
- summary: Create an API key
- description: Create a new API key.
- tags:
- - API Keys
- requestBody:
- required: true
- content:
- application/json:
- schema:
- allOf:
- - $ref: '#/components/schemas/APIKey'
- - required:
- - user_id
- - description
- - permissions
- responses:
- 201:
- description: Successfully created the student.
- content:
- application/json:
- schema:
- allOf:
- - type: object
- properties:
- consumer_key:
- description: The Consumer Key. Only returned once with the initial creation request.
- type: string
- example: ck_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
- consumer_secret:
- description: The Consumer Secret. Only returned once with the initial creation request.
- type: string
- example: cs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
- - $ref: '#/components/schemas/APIKey'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/api-keys@{id}.yaml b/spec/paths/api-keys@{id}.yaml
deleted file mode 100644
index 603482b0..00000000
--- a/spec/paths/api-keys@{id}.yaml
+++ /dev/null
@@ -1,74 +0,0 @@
-parameters:
- - name: id
- in: path
- description: Unique API Key Identifier.
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: Retrieve an API key
- description: Retrieve the details of an existing API key.
- tags:
- - API Keys
- parameters:
- - $ref: '#/components/parameters/Context'
- responses:
- 200:
- description: Successfully retrieved the API key.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/APIKey'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-post:
- summary: Update an API key
- description: >-
- Update the specified API key by setting the values of the parameters passed.
- Any parameters not provided will be left unchanged.
- tags:
- - API Keys
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/APIKey'
- responses:
- 200:
- description: Successfully updated the API key.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/APIKey'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-delete:
- summary: Delete an API key
- description: Delete an existing API key.
- tags:
- - API Keys
- responses:
- 204:
- description: Successfully deleted the API key.
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/courses.yaml b/spec/paths/courses.yaml
deleted file mode 100644
index 63fee733..00000000
--- a/spec/paths/courses.yaml
+++ /dev/null
@@ -1,83 +0,0 @@
-get:
- summary: List courses
- description: Retrieve a list of courses.
- tags:
- - Courses
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- required: false
- schema:
- type: string
- enum:
- - id
- - title
- - date_created
- - date_updated
- - menu_order
- default: id
- - $ref: '#/components/parameters/Include'
- - $ref: '#/components/parameters/Exclude'
- responses:
- 200:
- description: Successfully returned a list of courses.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/CourseResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
-
-post:
- summary: Create a course
- description: Create a new course object.
- tags:
- - Courses
- requestBody:
- required: true
- content:
- application/json:
- schema:
- allOf:
- - $ref: '#/components/schemas/CourseRequest'
- - required:
- - title
- - content
- responses:
- 201:
- description: Successfully created the course.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CourseResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/courses@{id}.yaml b/spec/paths/courses@{id}.yaml
deleted file mode 100644
index 3e9df5f9..00000000
--- a/spec/paths/courses@{id}.yaml
+++ /dev/null
@@ -1,98 +0,0 @@
-parameters:
- - name: id
- in: path
- description: Unique Course Identifier. The WordPress Post `ID`.
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: Retrieve a course
- description: Retrieve the details of an existing course.
- tags:
- - Courses
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/PostPassword'
- responses:
- 200:
- description: Successfully retrieved the course.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CourseResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-post:
- summary: Update a course
- description: >-
- Update the specified course by setting the values of the parameters passed.
- Any parameters not provided will be left unchanged.
- tags:
- - Courses
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CourseRequest'
- responses:
- 200:
- description: Successfully updated the course.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CourseResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-delete:
- summary: Delete a course
- description: Delete an existing course.
- tags:
- - Courses
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- force:
- description: Bypass the trash and force course deletion.
- type: boolean
- default: false
- responses:
- 200:
- description: Successfully moved the course to the trash.
- content:
- application/json:
- schema:
- allOf:
- - $ref: '#/components/schemas/CourseResponse'
- - type: object
- properties:
- status:
- type: string
- default: trash
-
- 204:
- description: Successfully deleted the course.
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/courses@{id}@content.yaml b/spec/paths/courses@{id}@content.yaml
deleted file mode 100644
index b475dc92..00000000
--- a/spec/paths/courses@{id}@content.yaml
+++ /dev/null
@@ -1,63 +0,0 @@
-parameters:
- - name: id
- in: path
- description: Unique course Identifier. The WordPress Post `ID`.
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-
-get:
- summary: List course content
- description: Retrieve a collection of an existing course's content.
- tags:
- - Courses
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- required: false
- schema:
- type: string
- enum:
- - order
- - id
- - title
- default: order
- - $ref: '#/components/parameters/Include'
- - $ref: '#/components/parameters/Exclude'
- responses:
- 200:
- description: Successfully retrieved the course outline.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/SectionResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
diff --git a/spec/paths/courses@{id}@enrollments.yaml b/spec/paths/courses@{id}@enrollments.yaml
deleted file mode 100644
index 04a2f843..00000000
--- a/spec/paths/courses@{id}@enrollments.yaml
+++ /dev/null
@@ -1,71 +0,0 @@
-parameters:
- - name: id
- in: path
- description: Unique course Identifier. The WordPress Post `ID`.
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-
-get:
- summary: List course enrollments
- description: Retrieve a collection of an existing course's enrollments.
- tags:
- - Courses
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for the collection of results.
- in: query
- schema:
- type: string
- enum:
- - date_updated
- - date_created
- default: date_updated
- - name: status
- description: Filter results to records matching the specified status.
- in: query
- required: false
- schema:
- $ref: '#/components/schemas/EnrollmentStatus'
- - name: student
- in: query
- description: Limit results to a specific student or a list of students. Accepts a single student `id` or a comma separated list of student `id`s.
- schema:
- type: string
- example: [1,2,3]
- responses:
- 200:
- description: Successfully retrieved the course's enrollments.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Enrollment'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
diff --git a/spec/paths/instructors.yaml b/spec/paths/instructors.yaml
deleted file mode 100644
index 691d6c33..00000000
--- a/spec/paths/instructors.yaml
+++ /dev/null
@@ -1,113 +0,0 @@
-get:
- summary: List instructors
- description: Retrieves a list of all instructors.
- tags:
- - Instructors
- parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- required: false
- schema:
- type: string
- enum:
- - id
- - email
- - name
- - registered_date
- default: id
- - $ref: '#/components/parameters/Include'
- - $ref: '#/components/parameters/Exclude'
- - name: post_in
- description: |
- Retrieve only instructors for the specified course(s) and/or
- membership(s).
-
- Accepts a single WP Post ID or a comma separated list of IDs.
- in: query
- required: false
- schema:
- type: string
- example: [1,2,3]
- - name: post_not_in
- description: |
- Retrieve only instructors for in the specified course(s) and/or
- membership(s).
-
- Accepts a single WP Post ID or a comma separated list of IDs.
- in: query
- required: false
- schema:
- type: string
- example: [4,5,6]
- - name: roles
- description: |
- Retrieve instructors by a specific role.
-
- Accepts a single role name or a comma separated list of role names.
- in: query
- required: false
- schema:
- type: string
- example: [instructor,lms_manager]
- responses:
- 200:
- description: Successfully returned a list of instructors
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Instructor'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
-
-
-post:
- summary: Create an instructor
- description: Creates a new instructor object.
- tags:
- - Instructors
- requestBody:
- required: true
- content:
- application/json:
- schema:
- allOf:
- - $ref: '#/components/schemas/Instructor'
- - required:
- - email
- responses:
- 201:
- description: Successfully created the instructor.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Instructor'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/instructors@{id}.yaml b/spec/paths/instructors@{id}.yaml
deleted file mode 100644
index 9d981bcb..00000000
--- a/spec/paths/instructors@{id}.yaml
+++ /dev/null
@@ -1,94 +0,0 @@
-parameters:
- - name: id
- description: Unique Instructor Identifer. The WordPress User `ID`.
- example: 123
- in: path
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: Retrieve an instructor
- description: Retrieve the details of an existing instructor.
- tags:
- - Instructors
- parameters:
- - $ref: '#/components/parameters/Context'
- responses:
- 200:
- description: Successfully retrieved the instructor.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Instructor'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-post:
- summary: Update an instructor
- description: >-
- Update the specified instructor by setting the values of the parameters passed.
- Any parameters not provided will be left unchanged.
- tags:
- - Instructors
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Instructor'
- responses:
- 200:
- description: Successfully updated the instructor.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Instructor'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-delete:
- summary: Delete an instructor
- description: Delete an existing instructor.
- tags:
- - Instructors
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- reassign:
- description: |
- ID of a WordPress User.
-
- Any posts owned by the deleted user will be reassigned to this user.
-
- LMS content and statuses (enrollments, for example), are not reassigned.
-
- Default (passing `0` or nothing) delete's the users's content.
- type: integer
- minimum: 0
- default: 0
- example: 456
- responses:
- 204:
- description: Successfully deleted the instructor.
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/instructors@{id}@content.yaml b/spec/paths/instructors@{id}@content.yaml
deleted file mode 100644
index c8e2f3f7..00000000
--- a/spec/paths/instructors@{id}@content.yaml
+++ /dev/null
@@ -1,74 +0,0 @@
-parameters:
- - name: id
- description: The instructor's ID.
- example: 123
- in: path
- required: true
- schema:
- type: integer
-
-get:
- summary: List an instructor's content
- description: Retrieves a list of all the instructor's LMS content.
- tags:
- - Instructors
- parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- required: false
- schema:
- type: string
- enum:
- - id
- - email
- default: id
- - $ref: '#/components/parameters/Include'
- - $ref: '#/components/parameters/Exclude'
- - name: post
- description: Retrieve content for a specific list of one or more posts. Accepts a post `id` or comma separted list of post `id`s.
- in: query
- schema:
- type: string
- example: 123,456
- - name: post_exclude
- description: Exclude content for a specific list of one or more posts. Accepts a post `id` or comma separted list of post `id`s.
- in: query
- schema:
- type: string
- example: 789,324
- - $ref: '#/components/parameters/PostType'
- responses:
- 200:
- description: Successfully returned a list of the instructor's content.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- anyOf:
- - $ref: '#/components/schemas/CourseResponse'
- - $ref: '#/components/schemas/MembershipResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/lesson.yaml b/spec/paths/lesson.yaml
deleted file mode 100644
index 95d0aa46..00000000
--- a/spec/paths/lesson.yaml
+++ /dev/null
@@ -1,92 +0,0 @@
-get:
- summary: List lessons
- description: Retrieve a list of lessons.
- tags:
- - Lessons
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- required: false
- schema:
- type: string
- enum:
- - id
- - title
- - date_created
- - date_updated
- - order
- default: id
- - $ref: '#/components/parameters/Include'
- - $ref: '#/components/parameters/Exclude'
- - name: parent
- description: Filter lessons by the parent post (section) ID.
- in: query
- required: false
- schema:
- type: integer
- minimum: 1
- example: 987
-
- responses:
- 200:
- description: Successfully returned a list of lessons.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/LessonResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
-
-post:
- summary: Create a lesson
- description: Create a new lesson object.
- tags:
- - Lessons
- requestBody:
- required: true
- content:
- application/json:
- schema:
- allOf:
- - $ref: '#/components/schemas/LessonRequest'
- - required:
- - title
- - content
- responses:
- 201:
- description: Successfully created the lesson.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/LessonResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/lesson@{id}.yaml b/spec/paths/lesson@{id}.yaml
deleted file mode 100644
index 99857be0..00000000
--- a/spec/paths/lesson@{id}.yaml
+++ /dev/null
@@ -1,87 +0,0 @@
-parameters:
- - name: id
- in: path
- description: Unique lesson Identifier. The WordPress Post `ID`.
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: Retrieve a lesson
- description: Retrieve the details of an existing lesson.
- tags:
- - Lessons
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/PostPassword'
- responses:
- 200:
- description: Successfully retrieved the lesson.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/LessonResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-post:
- summary: Update a lesson
- description: >-
- Update the specified lesson by setting the values of the parameters passed.
- Any parameters not provided will be left unchanged.
- tags:
- - Lessons
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/LessonRequest'
- responses:
- 200:
- description: Successfully updated the lesson.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/LessonResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-delete:
- summary: Delete a lesson
- description: Delete an existing lesson.
- tags:
- - Lessons
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- force:
- description: Bypass the trash and force lesson deletion.
- type: boolean
- default: false
- responses:
- 204:
- description: Successfully deleted the lesson.
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
diff --git a/spec/paths/memberships.yaml b/spec/paths/memberships.yaml
deleted file mode 100644
index 66b9c0b0..00000000
--- a/spec/paths/memberships.yaml
+++ /dev/null
@@ -1,83 +0,0 @@
-get:
- summary: List memberships
- description: Retrieve a list of memberships.
- tags:
- - Memberships
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- required: false
- schema:
- type: string
- enum:
- - id
- - title
- - date_created
- - date_updated
- - menu_order
- default: id
- - $ref: '#/components/parameters/Include'
- - $ref: '#/components/parameters/Exclude'
- responses:
- 200:
- description: Successfully returned a list of memberships.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/MembershipResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
-
-post:
- summary: Create a membership
- description: Create a new membership object.
- tags:
- - Memberships
- requestBody:
- required: true
- content:
- application/json:
- schema:
- allOf:
- - $ref: '#/components/schemas/MembershipRequest'
- - required:
- - title
- - content
- responses:
- 201:
- description: Successfully created the membership.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/MembershipResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/memberships@{id}.yaml b/spec/paths/memberships@{id}.yaml
deleted file mode 100644
index d1d42cf2..00000000
--- a/spec/paths/memberships@{id}.yaml
+++ /dev/null
@@ -1,87 +0,0 @@
-parameters:
- - name: id
- in: path
- description: Unique membership Identifier. The WordPress Post `ID`.
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: Retrieve a membership
- description: Retrieve the details of an existing membership.
- tags:
- - Memberships
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/PostPassword'
- responses:
- 200:
- description: Successfully retrieved the membership.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/MembershipResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-post:
- summary: Update a membership
- description: >-
- Update the specified membership by setting the values of the parameters passed.
- Any parameters not provided will be left unchanged.
- tags:
- - Memberships
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/MembershipRequest'
- responses:
- 200:
- description: Successfully updated the membership.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/MembershipResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-delete:
- summary: Delete a membership
- description: Delete an existing membership.
- tags:
- - Memberships
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- force:
- description: Bypass the trash and force membership deletion.
- type: boolean
- default: false
- responses:
- 204:
- description: Successfully deleted the membership.
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
diff --git a/spec/paths/memberships@{id}@enrollments.yaml b/spec/paths/memberships@{id}@enrollments.yaml
deleted file mode 100644
index 45af64d3..00000000
--- a/spec/paths/memberships@{id}@enrollments.yaml
+++ /dev/null
@@ -1,72 +0,0 @@
-parameters:
- - name: id
- in: path
- description: Unique membership Identifier. The WordPress Post `ID`.
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-
-get:
- summary: List membership enrollments
- description: Retrieve a collection of an existing membership's enrollments.
- tags:
- - Memberships
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for the collection of results.
- in: query
- schema:
- type: string
- enum:
- - date_updated
- - date_created
- default: date_updated
- - $ref: '#/components/parameters/Include'
- - name: status
- description: Filter results to records matching the specified status.
- in: query
- required: false
- schema:
- $ref: '#/components/schemas/EnrollmentStatus'
- - name: student
- in: query
- description: Limit results to a specific student or a list of students. Accepts a single student `id` or a comma separated list of student `id`s.
- schema:
- type: string
- example: [1,2,3]
- responses:
- 200:
- description: Successfully retrieved the membership's enrollments.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Enrollment'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
diff --git a/spec/paths/quiz-questions.yaml b/spec/paths/quiz-questions.yaml
deleted file mode 100644
index 8fcffb6b..00000000
--- a/spec/paths/quiz-questions.yaml
+++ /dev/null
@@ -1,139 +0,0 @@
-get:
- summary: List quiz questions
- description: Retrieve a list of quiz questions.
- tags:
- - Quiz Questions
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- schema:
- type: string
- enum:
- - id
- - title
- - date_created
- - date_updated
- default: id
- - $ref: '#/components/parameters/Include'
- - $ref: '#/components/parameters/Exclude'
- - name: quiz
- description: Filter quiz questions by the parent post (quiz) ID.
- in: query
- schema:
- type: integer
- minimum: 1
- example: 789
-
- responses:
- 200:
- description: Successfully returned a list of quiz questions.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/QuizQuestionTypesResponseList'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
-
-post:
- summary: Create a quiz question
- description: Create a new quiz question object.
- tags:
- - Quiz Questions
- requestBody:
- required: true
- content:
- application/json:
- schema:
- anyOf:
- - title: Multiple Choice
- allOf:
- - required:
- - title
- - choices
- - question_type
- - $ref: '#/components/schemas/QuizQuestionTypeChoice'
- - $ref: '#/components/schemas/QuizQuestionRequest'
- - title: Picture Choice
- allOf:
- - required:
- - title
- - choices
- - question_type
- - $ref: '#/components/schemas/QuizQuestionTypePictureChoice'
- - $ref: '#/components/schemas/QuizQuestionRequest'
- - title: True / False
- allOf:
- - required:
- - title
- - choices
- - question_type
- - $ref: '#/components/schemas/QuizQuestionTypeTrueFalse'
- - $ref: '#/components/schemas/QuizQuestionRequest'
- - title: Content
- allOf:
- - required:
- - title
- - question_type
- - $ref: '#/components/schemas/QuizQuestionTypeContent'
- - $ref: '#/components/schemas/QuizQuestionRequest'
-
- - title: Fill in the Blank
- allOf:
- - required:
- - title
- - question_type
- - $ref: '#/components/schemas/QuizQuestionTypeBlank'
- - $ref: '#/components/schemas/QuizQuestionRequest'
- - title: Long Answer
- allOf:
- - required:
- - title
- - question_type
- - $ref: '#/components/schemas/QuizQuestionTypeLongAnswer'
- - $ref: '#/components/schemas/QuizQuestionRequest'
-
- responses:
- 201:
- description: Successfully created the quiz question.
- content:
- application/json:
- examples:
- choice:
- summary: Multiple Choice Question
- value: {}
- long_answer:
- summary: Long Answer Question
- value: {}
- schema:
- $ref: '#/components/schemas/QuizQuestionTypesResponseList'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/quiz-questions@{id}.yaml b/spec/paths/quiz-questions@{id}.yaml
deleted file mode 100644
index 689d9615..00000000
--- a/spec/paths/quiz-questions@{id}.yaml
+++ /dev/null
@@ -1,102 +0,0 @@
-parameters:
- - name: id
- in: path
- description: Unique quiz question identifier. The WordPress Post `ID`.
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: Retrieve a quiz question
- description: Retrieve the details of an existing quiz question.
- tags:
- - Quiz Questions
- parameters:
- - $ref: '#/components/parameters/Context'
- responses:
- 200:
- description: Successfully retrieved the quiz question.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/QuizQuestionTypesResponseList'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-post:
- summary: Update a quiz question
- description: >-
- Update the specified quiz question by setting the values of the parameters passed.
- Any parameters not provided will be left unchanged.
- tags:
- - Quiz Questions
- requestBody:
- required: true
- content:
- application/json:
- schema:
- anyOf:
- - title: Multiple Choice
- allOf:
- - $ref: '#/components/schemas/QuizQuestionTypeChoice'
- - $ref: '#/components/schemas/QuizQuestionRequest'
- - title: Picture Choice
- allOf:
- - $ref: '#/components/schemas/QuizQuestionTypePictureChoice'
- - $ref: '#/components/schemas/QuizQuestionRequest'
- - title: True / False
- allOf:
- - $ref: '#/components/schemas/QuizQuestionTypeTrueFalse'
- - $ref: '#/components/schemas/QuizQuestionRequest'
- - title: Content
- allOf:
- - $ref: '#/components/schemas/QuizQuestionTypeContent'
- - $ref: '#/components/schemas/QuizQuestionRequest'
-
- - title: Fill in the Blank
- allOf:
- - $ref: '#/components/schemas/QuizQuestionTypeBlank'
- - $ref: '#/components/schemas/QuizQuestionRequest'
- - title: Long Answer
- allOf:
- - $ref: '#/components/schemas/QuizQuestionTypeLongAnswer'
- - $ref: '#/components/schemas/QuizQuestionRequest'
-
- responses:
- 200:
- description: Successfully updated the quiz question.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/QuizQuestionTypesResponseList'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-delete:
- summary: Delete a quiz question
- description: Delete an existing quiz question.
- tags:
- - Quiz Questions
- responses:
- 204:
- description: Successfully deleted the quiz question.
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
diff --git a/spec/paths/quizzes.yaml b/spec/paths/quizzes.yaml
deleted file mode 100644
index 111b9c94..00000000
--- a/spec/paths/quizzes.yaml
+++ /dev/null
@@ -1,104 +0,0 @@
-get:
- summary: List quizzes
- description: Retrieve a list of quizzes.
- tags:
- - Quizzes
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- schema:
- type: string
- enum:
- - id
- - title
- - date_created
- - date_updated
- default: id
- - $ref: '#/components/parameters/Include'
- - $ref: '#/components/parameters/Exclude'
- - name: parent
- description: Filter quizzes by the parent post (lesson) ID.
- in: query
- schema:
- type: integer
- minimum: 1
- example: 789
- - name: course
- description: Filter quizzes by the parent couse ID.
- in: query
- schema:
- type: integer
- minimum: 1
- example: 1234
- - name: status
- description: Filter quizzes by the post status.
- in: query
- schema:
- type: string
- enum:
- - publish
- - draft
-
- responses:
- 200:
- description: Successfully returned a list of quizzes.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/QuizResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
-
-post:
- summary: Create a quiz
- description: Create a new quiz object.
- tags:
- - Quizzes
- requestBody:
- required: true
- content:
- application/json:
- schema:
- allOf:
- - $ref: '#/components/schemas/QuizRequest'
- - required:
- - title
- - content
- responses:
- 201:
- description: Successfully created the quiz.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/QuizResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/quizzes@{id}.yaml b/spec/paths/quizzes@{id}.yaml
deleted file mode 100644
index e017c711..00000000
--- a/spec/paths/quizzes@{id}.yaml
+++ /dev/null
@@ -1,76 +0,0 @@
-parameters:
- - name: id
- in: path
- description: Unique Quiz Identifier. The WordPress Post `ID`.
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: Retrieve a quiz
- description: Retrieve the details of an existing quiz.
- tags:
- - Quizzes
- parameters:
- - $ref: '#/components/parameters/Context'
- responses:
- 200:
- description: Successfully retrieved the quiz.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/QuizResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-post:
- summary: Update a quiz
- description: >-
- Update the specified quiz by setting the values of the parameters passed.
- Any parameters not provided will be left unchanged.
- tags:
- - Quizzes
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/QuizRequest'
- responses:
- 200:
- description: Successfully updated the quiz.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/QuizResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-delete:
- summary: Delete a quiz
- description: Delete an existing quiz.
- tags:
- - Quizzes
- responses:
- 204:
- description: Successfully deleted the quiz.
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
diff --git a/spec/paths/sections.yaml b/spec/paths/sections.yaml
deleted file mode 100644
index 7f56ab81..00000000
--- a/spec/paths/sections.yaml
+++ /dev/null
@@ -1,87 +0,0 @@
-get:
- summary: List sections
- description: Retrieve a list of sections.
- tags:
- - Sections
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- required: false
- schema:
- type: string
- enum:
- - id
- - title
- - date_created
- - date_updated
- - order
- default: id
- - $ref: '#/components/parameters/Include'
- - $ref: '#/components/parameters/Exclude'
- - name: parent
- description: Filter sections by the parent post (course) ID.
- in: query
- required: false
- schema:
- type: integer
- minimum: 1
- example: 1234
- responses:
- 200:
- description: Successfully returned a list of sections.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/SectionResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
-
-post:
- summary: Create a section
- description: Create a new section object.
- tags:
- - Sections
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SectionRequest'
- responses:
- 201:
- description: Successfully created the section.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SectionResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/sections@{id}.yaml b/spec/paths/sections@{id}.yaml
deleted file mode 100644
index af93913e..00000000
--- a/spec/paths/sections@{id}.yaml
+++ /dev/null
@@ -1,74 +0,0 @@
-parameters:
- - name: id
- in: path
- description: Unique Section Identifier. The WordPress Post `ID`.
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: Retrieve a section
- description: Retrieve the details of an existing section.
- tags:
- - Sections
- parameters:
- - $ref: '#/components/parameters/Context'
- responses:
- 200:
- description: Successfully retrieved the section.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SectionResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-post:
- summary: Update a section
- description: >-
- Update the specified section by setting the values of the parameters passed.
- Any parameters not provided will be left unchanged.
- tags:
- - Sections
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SectionRequest'
- responses:
- 200:
- description: Successfully updated the section.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SectionResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-delete:
- summary: Delete a section
- description: Delete an existing section.
- tags:
- - Sections
- responses:
- 204:
- description: Successfully deleted the section.
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/sections@{id}@content.yaml b/spec/paths/sections@{id}@content.yaml
deleted file mode 100644
index 2c909c99..00000000
--- a/spec/paths/sections@{id}@content.yaml
+++ /dev/null
@@ -1,69 +0,0 @@
-parameters:
- - name: id
- in: path
- description: Unique section Identifier. The WordPress Post `ID`.
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: List section content
- description: Retrieve a collection of an existing section's content.
- tags:
- - Sections
- parameters:
- - $ref: '#/components/parameters/Context'
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- required: false
- schema:
- type: string
- enum:
- - order
- - id
- - title
- default: order
- - $ref: '#/components/parameters/Include'
- - name: parent
- description: Filter results to those belonging to the specified parent.
- in: query
- required: false
- schema:
- type: integer
- minimum: 1
- example: 987
- responses:
- 200:
- description: Successfully retrieved the section contents.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/LessonResponse'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
diff --git a/spec/paths/students.yaml b/spec/paths/students.yaml
deleted file mode 100644
index 42b57ffa..00000000
--- a/spec/paths/students.yaml
+++ /dev/null
@@ -1,113 +0,0 @@
-get:
- summary: List students
- description: Retrieves a list of all students.
- tags:
- - Students
- parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- required: false
- schema:
- type: string
- enum:
- - id
- - email
- - name
- - registered_date
- default: id
- - $ref: '#/components/parameters/Include'
- - $ref: '#/components/parameters/Exclude'
- - name: enrolled_in
- description: |
- Retrieve only students not enrolled in the specified course(s) and/or
- membership(s).
-
- Accepts a single WP Post ID or a comma separated list of IDs.
- in: query
- required: false
- schema:
- type: string
- example: [1,2,3]
- - name: enrolled_not_in
- description: |
- Retrieve only students not enrolled in the specified course(s) and/or
- membership(s).
-
- Accepts a single WP Post ID or a comma separated list of IDs.
- in: query
- required: false
- schema:
- type: string
- example: [4,5,6]
- - name: roles
- description: |
- Retrieve students by a specific role.
-
- Accepts a single role name or a comma separated list of role names.
- in: query
- required: false
- schema:
- type: string
- example: [student,customer]
- responses:
- 200:
- description: Successfully returned a list of students
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: |
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Student'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
-
-
-post:
- summary: Create a student
- description: Creates a new student object.
- tags:
- - Students
- requestBody:
- required: true
- content:
- application/json:
- schema:
- allOf:
- - $ref: '#/components/schemas/Student'
- - required:
- - email
- responses:
- 201:
- description: Successfully created the student.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Student'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/students@{id}.yaml b/spec/paths/students@{id}.yaml
deleted file mode 100644
index 0e24cd21..00000000
--- a/spec/paths/students@{id}.yaml
+++ /dev/null
@@ -1,94 +0,0 @@
-parameters:
- - name: id
- description: Unique student Identifer. The WordPress User `ID`.
- example: 123
- in: path
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: Retrieve a student
- description: Retrieve the details of an existing student.
- tags:
- - Students
- parameters:
- - $ref: '#/components/parameters/Context'
- responses:
- 200:
- description: Successfully retrieved the student.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Student'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-post:
- summary: Update a student
- description: >-
- Update the specified student by setting the values of the parameters passed.
- Any parameters not provided will be left unchanged.
- tags:
- - Students
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Student'
- responses:
- 200:
- description: Successfully updated the student.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Student'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-delete:
- summary: Delete a student
- description: Delete an existing student.
- tags:
- - Students
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- reassign:
- description: |
- ID of a WordPress User.
-
- Any posts owned by the deleted user will be reassigned to this user.
-
- LMS content and statuses (enrollments, for example), are not reassigned.
-
- Default (passing `0` or nothing) delete's the users's content.
- type: integer
- minimum: 0
- default: 0
- example: 456
- responses:
- 204:
- description: Successfully deleted the student.
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/students@{id}@enrollments.yaml b/spec/paths/students@{id}@enrollments.yaml
deleted file mode 100644
index a78f824b..00000000
--- a/spec/paths/students@{id}@enrollments.yaml
+++ /dev/null
@@ -1,70 +0,0 @@
-parameters:
- - name: id
- description: Unique student Identifer. The WordPress User `ID`.
- example: 123
- in: path
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: List student enrollments
- description: Retrieves a list of a student's enrollment records.
- tags:
- - Student Enrollments
- parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- schema:
- type: string
- enum:
- - date_updated
- - date_created
- default: date_updated
- - name: status
- description: Filter results to records matching the specified status.
- in: query
- required: false
- schema:
- $ref: '#/components/schemas/EnrollmentStatus'
- - name: post
- in: query
- description: Limit results to a specific course or membership or a list of courses and/or memberships. Accepts a single post `id` or a comma separated list of post `id`s.
- schema:
- type: string
- example: [1,2,3]
- responses:
- 200:
- description: Successfully returned a list of a student's enrollment records.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Enrollment'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
diff --git a/spec/paths/students@{id}@enrollments@{post_id}.yaml b/spec/paths/students@{id}@enrollments@{post_id}.yaml
deleted file mode 100644
index 5586992c..00000000
--- a/spec/paths/students@{id}@enrollments@{post_id}.yaml
+++ /dev/null
@@ -1,101 +0,0 @@
-parameters:
- - name: id
- description: Unique student Identifer. The WordPress User `ID`.
- example: 123
- in: path
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
- - name: post_id
- description: Unique course, lesson, or section Identifer. The WordPress Post `ID`.
- example: 456
- in: path
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: Get student enrollment
- description: Retrieves information about a student's enrollment in a course or membership.
- tags:
- - Student Enrollments
- responses:
- 200:
- description: Successfully retrieved student's enrollment.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Enrollment'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-post:
- summary: Create student enrollment
- description: Create a new enrollment for a student in a course or membership.
- tags:
- - Student Enrollments
- responses:
- 201:
- description: Successfully created the student's enrollment.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Enrollment'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-patch:
- summary: Update student enrollment
- description: Update an enrollment for a student in a course or membership.
- tags:
- - Student Enrollments
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Enrollment'
- responses:
- 200:
- description: Successfully updated student's enrollment.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Enrollment'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-delete:
- summary: Delete student enrollment
- description: Deletes the record of a student's enrollment in a course or membership.
- tags:
- - Student Enrollments
- responses:
- 204:
- description: Successfully deleted student's enrollment.
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
diff --git a/spec/paths/students@{id}@progress@{post_id}.yaml b/spec/paths/students@{id}@progress@{post_id}.yaml
deleted file mode 100644
index e770a407..00000000
--- a/spec/paths/students@{id}@progress@{post_id}.yaml
+++ /dev/null
@@ -1,78 +0,0 @@
-parameters:
- - name: id
- description: Unique student Identifer. The WordPress User `ID`.
- example: 123
- in: path
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
- - name: post_id
- description: Unique course, lesson, or section Identifer. The WordPress Post `ID`.
- example: 456
- in: path
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: Get student progress
- description: Retrieves information about a student's progress through course content.
- tags:
- - Student Progress
- responses:
- 200:
- description: Successfully retrieved student's progress.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Progress'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-post:
- summary: Update student progress
- description: Update the status of a student's progress through course content.
- tags:
- - Student Progress
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Progress'
- responses:
- 200:
- description: Successfully updated student's progress.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Progress'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-delete:
- summary: Delete student progress
- description: Deletes the record of a student's progress through course content.
- tags:
- - Student Progress
- responses:
- 204:
- description: Successfully deleted the student.
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/webhooks.yaml b/spec/paths/webhooks.yaml
deleted file mode 100644
index 58cd5a49..00000000
--- a/spec/paths/webhooks.yaml
+++ /dev/null
@@ -1,89 +0,0 @@
-get:
- summary: List webhooks
- description: Retrieve a list of webhooks.
- tags:
- - Webhooks
- parameters:
- - $ref: '#/components/parameters/Page'
- - $ref: '#/components/parameters/PerPage'
- - $ref: '#/components/parameters/Order'
- - name: orderby
- description: Specify the sort field for a collection of results.
- in: query
- schema:
- type: string
- enum:
- - id
- - name
- - date_created
- - date_updated
- default: id
- - $ref: '#/components/parameters/Include'
- - $ref: '#/components/parameters/Exclude'
- - name: status
- description: Filter results to those matching a specific status.
- in: query
- schema:
- type: string
- enum:
- - active
- - paused
- - disabled
- responses:
- 200:
- description: Successfully returned a list of webhooks.
- headers:
- Link:
- description: Pagination links for the collection.
- schema:
- type: string
- example: >-
- ; rel="first",
- ; rel="prev",
- ; rel="next",
- ; rel="last"
- X-WP-Total:
- $ref: '#/components/headers/PaginationTotalResults'
- X-WP-TotalPages:
- $ref: '#/components/headers/PaginationTotalPages'
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Webhook'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
-
-post:
- summary: Create a webhook
- description: Create a new webhook object.
- tags:
- - Webhooks
- requestBody:
- required: true
- content:
- application/json:
- schema:
- allOf:
- - $ref: '#/components/schemas/Webhook'
- - required:
- - topic
- - url
- responses:
- 201:
- description: Successfully created the webhook.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Webhook'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
diff --git a/spec/paths/webhooks@{id}.yaml b/spec/paths/webhooks@{id}.yaml
deleted file mode 100644
index 9b6479fa..00000000
--- a/spec/paths/webhooks@{id}.yaml
+++ /dev/null
@@ -1,74 +0,0 @@
-parameters:
- - name: id
- in: path
- description: Unique webhook identifier. The WordPress Post `ID`.
- required: true
- schema:
- $ref: '#/components/schemas/ResourceId'
-
-get:
- summary: Retrieve a webhook
- description: Retrieve the details of an existing webhook.
- tags:
- - Webhooks
- responses:
- 200:
- description: Successfully retrieved the webhook.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Webhook'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-post:
- summary: Update a webhook
- description: >-
- Update the specified webhook by setting the values of the parameters passed.
- Any parameters not provided will be left unchanged.
- tags:
- - Webhooks
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Webhook'
- responses:
- 200:
- description: Successfully updated the webhook.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Webhook'
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
-
-delete:
- summary: Delete a webhook
- description: Delete an existing webhook.
- tags:
- - Webhooks
- responses:
- 204:
- description: Successfully deleted the webhook.
- 400:
- $ref: '#/components/responses/Error400'
- 401:
- $ref: '#/components/responses/Error401'
- 403:
- $ref: '#/components/responses/Error403'
- 404:
- $ref: '#/components/responses/Error404'
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
deleted file mode 100644
index 56160618..00000000
--- a/tests/bootstrap.php
+++ /dev/null
@@ -1,53 +0,0 @@
-keys()->create( array(
- 'description' => 'Test Key',
- 'user_id' => $user_id ? $user_id : $this->factory->user->create(),
- 'permissions' => $permissions,
- ) );
-
- if ( $authorize ) {
- $this->mock_authorization( $key->get( 'consumer_key_one_time' ), $key->get( 'consumer_secret' ) );
- }
-
- return $key;
-
- }
-
- /**
- * Create multiple API Keys
- *
- * @since 1.0.0-beta.1
- *
- * @param int $count Number of keys to create.
- * @param string $permissions Define permissions for the keys. If not specified assigns a random permission to each key.
- * @param int $user WP_User Id to assign the key to. If not supplied uses the user factory to create a new admin user for each created key.
- * @return void
- */
- protected function create_many_api_keys( $count, $permissions = 'rand', $user = null ) {
-
- $pems_available = array_keys( LLMS_REST_API()->keys()->get_permissions() );
- $num_pems = count( $pems_available ) - 1;
-
- $i = 1;
- while ( $i <= $count ) {
-
- $pem = 'rand' === $permissions ? $pems_available[ rand( 0, $num_pems ) ] : $permissions;
- $uid = $user ? $user : $this->factory->user->create( array( 'role' => 'administrator' ) );
-
- $this->get_mock_api_key( $pem, $uid, false );
- $i++;
- }
-
- }
-
- public function create_many_webhooks( $count, $status = 'rand', $topic = 'rand' ) {
-
- $statuses = array_keys( LLMS_REST_API()->webhooks()->get_statuses() );
- $num_statuses = count( $statuses ) - 1;
-
- $topics = array_keys( LLMS_REST_API()->webhooks()->get_topics() );
- $num_topics = count( $topics ) - 2; // don't use the custom "action" topic.
-
- $i = 1;
- while ( $i <= $count ) {
-
- $args = array(
- 'status' => 'rand' === $status ? $statuses[ rand( 0, $num_statuses ) ] : $status,
- 'topic' => 'rand' === $topic ? $topics[ rand( 0, $num_topics ) ] : $topic,
- 'delivery_url' => 'https://mock.tld',
- );
-
- LLMS_REST_API()->webhooks()->create( $args );
- $i++;
-
- }
-
- }
-
- /**
- * Mock authorization headers.
- *
- * @since 1.0.0-beta.1
- *
- * @param string $key Consumer key.
- * @param string $secret Consumer secret.
- * @return void
- */
- protected function mock_authorization( $key = null, $secret = null ) {
-
- $_SERVER['HTTP_X_LLMS_CONSUMER_KEY'] = $key;
- $_SERVER['HTTP_X_LLMS_CONSUMER_SECRET'] = $secret;
- }
-
- /**
- * test teardown.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function tearDown() {
-
- parent::tearDown();
-
- // Remove possibly mocked headers.
- unset( $_SERVER['HTTP_X_LLMS_CONSUMER_KEY'], $_SERVER['HTTP_X_LLMS_CONSUMER_SECRET'] );
-
- }
-
-}
diff --git a/tests/framework/class-llms-rest-unit-test-case-posts.php b/tests/framework/class-llms-rest-unit-test-case-posts.php
deleted file mode 100644
index 03b3a3a0..00000000
--- a/tests/framework/class-llms-rest-unit-test-case-posts.php
+++ /dev/null
@@ -1,97 +0,0 @@
-get( 'id' ) );
-
- $expected = array(
- 'id' => $llms_post->get( 'id' ),
- 'title' => array(
- 'raw' => $llms_post->get( 'title', 'raw' ),
- 'rendered' => $llms_post->get( 'title' ),
- ),
- 'status' => $llms_post->get( 'status' ),
- 'content' => array(
- 'raw' => $llms_post->get( 'content', 'raw' ),
- 'rendered' => $password_required ? '' : apply_filters( 'the_content', $llms_post->get( 'content', 'raw' ) ),
- ),
- 'excerpt' => array(
- 'raw' => $llms_post->get( 'excerpt', 'raw' ),
- 'rendered' => $password_required ? '' : apply_filters( 'the_excerpt', $llms_post->get( 'content', 'raw' ) ),
- ),
- 'date_created' => $llms_post->get( 'date', 'Y-m-d H:i:s' ),
- 'date_created_gmt' => $llms_post->get( 'date_gmt', 'Y-m-d H:i:s' ),
- 'date_updated' => $llms_post->get( 'modified', 'Y-m-d H:i:s' ),
- 'date_updated_gmt' => $llms_post->get( 'modified_gmt', 'Y-m-d H:i:s' ),
- );
-
- if ( 'edit' !== $context ) {
- unset(
- $expected['content']['raw'],
- $expected['excerpt']['raw'],
- $expected['title']['raw']
- );
- }
-
- $expected = $this->filter_expected_fields( $expected, $llms_post );
-
- /**
- * The rtrim below is not ideal but at the moment we have templates printed after the course summary (e.g. prerequisites) that,
- * even when printing no data they still print "\n". Let's pretend we're not interested in testing the trailing "\n" presence.
- */
- foreach ( $expected as $key => $value ) {
- if ( ! isset( $llms_post_data[ $key ] ) ) {
- continue;
- }
- if ( is_array( $value ) ) {
- foreach ( $value as $k => $v ) {
- if ( 'content' === $key ) {
- if ( ! isset( $llms_post_data[ $key ][ $k ] ) ) {
- continue;
- }
- $this->assertEquals( rtrim( $v, "\n" ), rtrim( $llms_post_data[ $key ][ $k ], "\n" ) );
- }
- }
- } else {
- if ( 'content' === $key ) {
- $this->assertEquals( rtrim( $value, "\n" ), rtrim( $llms_post_data[ $key ], "\n" ) );
- }
- }
- }
-
- }
-
- protected function filter_expected_fields( $expected, $llms_post ) {
- return $expected;
- }
-
-}
diff --git a/tests/framework/class-llms-rest-unit-test-case-server.php b/tests/framework/class-llms-rest-unit-test-case-server.php
deleted file mode 100644
index dd12eda2..00000000
--- a/tests/framework/class-llms-rest-unit-test-case-server.php
+++ /dev/null
@@ -1,148 +0,0 @@
-server = rest_get_server();
-
- }
-
- /**
- * Assert a WP_REST_Response code equals an expected code.
- *
- * @since 1.0.0-beta.1
- *
- * @param string $expected Expected response code.
- * @param WP_REST_Response $response Response object.
- * @return void
- */
- protected function assertResponseCodeEquals( $expected, WP_REST_Response $response ) {
-
- $data = $response->get_data();
- $this->assertEquals( $expected, $data['code'] );
-
- }
-
- /**
- * Assert a WP_REST_Response message equals an expected message.
- *
- * @since 1.0.0-beta.1
- *
- * @param int $expected Expected response message.
- * @param WP_REST_Response $response Response object.
- * @return void
- */
- protected function assertResponseMessageEquals( $expected, WP_REST_Response $response ) {
-
- $data = $response->get_data();
- $this->assertEquals( $expected, $data['message'] );
-
- }
-
- /**
- * Assert a WP_REST_Response status code equals an expected status code.
- *
- * @since 1.0.0-beta.1
- *
- * @param int $expected Expected response http status code.
- * @param WP_REST_Response $response Response object.
- * @return void
- */
- protected function assertResponseStatusEquals( $expected, WP_REST_Response $response ) {
-
- $this->assertEquals( $expected, $response->get_status() );
-
- }
-
- /**
- * Parse the `Link` header to pull all links into an associative array of rel => uri
- *
- * @since 1.0.0-beta.1
- *
- * @param WP_REST_Response $response Response object.
- * @return array
- */
- protected function parse_link_headers( WP_REST_Response $response ) {
-
- $headers = $response->get_headers();
- $links = isset( $headers['Link'] ) ? $headers['Link'] : '';
-
- $parsed = array();
- if ( $links ) {
-
- foreach ( explode( ',', $links ) as $link ) {
- preg_match( '/<(.*)>; rel="(.*)"/i', trim( $link, ',' ), $match );
- if ( 3 === count( $match ) ) {
- $parsed[ $match[2] ] = $match[1];
- }
- }
-
- }
-
- return $parsed;
-
- }
-
- /**
- * Preform a mock WP_REST_Request
- *
- * @since 1.0.0-beta.1
- *
- * @param string $method Request method.
- * @param string $route Request route, eg: '/llms/v1/courses'.
- * @param array $body Optional request body.
- * @param array $query Optional query arguments.
- * @return WP_REST_Response.
- */
- protected function perform_mock_request( $method, $route, $body = array(), $query = array() ) {
-
- $request = new WP_REST_Request( $method, $route );
- if ( $body ) {
- $request->set_body_params( $body );
- }
- if( $query ) {
- $request->set_query_params( $query );
- }
- return $this->server->dispatch( $request );
-
- }
-
- /**
- * Unset the server.
- *
- * @since 1.0.0-beta.1
- */
- public function tearDown() {
-
- parent::tearDown();
-
- global $wp_rest_server;
- unset( $this->server );
-
- $wp_rest_server = null;
-
- }
-
-}
diff --git a/tests/unit-tests/admin/class-llms-rest-test-admin-form-controller.php b/tests/unit-tests/admin/class-llms-rest-test-admin-form-controller.php
deleted file mode 100644
index c76bb3e9..00000000
--- a/tests/unit-tests/admin/class-llms-rest-test-admin-form-controller.php
+++ /dev/null
@@ -1,465 +0,0 @@
-includes();
- include_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.notices.php';
-
- $this->obj = new LLMS_REST_Admin_Form_Controller();
-
- }
-
- /**
- * Clean up admin notices between tests
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function tearDown() {
-
- parent::tearDown();
- foreach( LLMS_Admin_Notices::get_notices() as $id ) {
- LLMS_Admin_Notices::delete_notice( $id );
- }
-
- global $wpdb;
- $wpdb->query( "TRUNCATE TABLE {$wpdb->prefix}lifterlms_webhooks" );
-
- }
-
- /**
- * Test no events are run on regular admin screens.
- *
- * @since 1.0.0-beta.1
- *
- * @see {Reference}
- * @link {URL}
- *
- * @return [type]
- */
- public function test_handle_events_no_submit() {
-
- $this->assertFalse( $this->obj->handle_events() );
-
- }
-
- /**
- * Ensure required field errors are returned when creating a webhook.
- *
- * @since 1.0.0-beta.1
- *
- * @return [type]
- */
- public function test_create_webhook_required_fields() {
-
- $data = array(
- 'llms_rest_webhook_nonce' => wp_create_nonce( 'create-update-webhook' ),
- );
-
- // Missing topic required field.
- $this->mockPostRequest( $data );
- $ret = $this->obj->handle_events();
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_missing_topic', $ret );
-
- // Missing delivery url.
- $data['llms_rest_webhook_topic'] = 'course.created';
- $this->mockPostRequest( $data );
- $ret = $this->obj->handle_events();
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_missing_delivery_url', $ret );
-
- // Success.
- // redirect and exit back to webooks's edit page.
- $data['llms_rest_webhook_delivery_url'] = 'https://mock.tld';
- $this->mockPostRequest( $data );
- $this->expectException( LLMS_Unit_Test_Exception_Redirect::class );
- $this->expectExceptionMessage( 'http://example.org/wp-admin/admin.php?page=llms-settings&tab=rest-api§ion=webhooks&edit-webhook=1 [301] YES' );
-
- try {
- $this->obj->handle_events();
- } catch ( LLMS_Unit_Test_Exception_Redirect $exception ) {
-
- $hook = LLMS_REST_API()->webhooks()->get( 1 );
-
- $this->assertEquals( 'https://mock.tld', $hook->get( 'delivery_url' ) );
- $this->assertEquals( 'course.created', $hook->get( 'topic' ) );
- $this->assertEquals( 'disabled', $hook->get( 'status' ) );
- $this->assertEquals( 50, strlen( $hook->get( 'secret' ) ) );
- $this->assertEquals( 0, strpos( $hook->get( 'secret' ), 'Webhook created on ' ) );
-
- throw $exception;
-
- }
-
- }
-
- /**
- * Ensure all submittable fields are added to the hook on creation.
- *
- * @since 1.0.0-beta.1
- *
- * @return [type]
- */
- public function test_create_webhook_all_fields() {
-
- $data = array(
- 'llms_rest_webhook_nonce' => wp_create_nonce( 'create-update-webhook' ),
- 'llms_rest_webhook_name' => 'Webhook Name',
- 'llms_rest_webhook_topic' => 'course.created',
- 'llms_rest_webhook_secret' => 'myawesomesecret',
- 'llms_rest_webhook_delivery_url' => 'https://mock.tld',
- 'llms_rest_webhook_status' => 'active',
- );
-
- $this->mockPostRequest( $data );
- $this->expectException( LLMS_Unit_Test_Exception_Redirect::class );
- $this->expectExceptionMessage( 'http://example.org/wp-admin/admin.php?page=llms-settings&tab=rest-api§ion=webhooks&edit-webhook=1 [301] YES' );
-
- try {
- $this->obj->handle_events();
- } catch ( LLMS_Unit_Test_Exception_Redirect $exception ) {
-
- $hook = LLMS_REST_API()->webhooks()->get( 1 );
-
- $this->assertEquals( $data['llms_rest_webhook_name'], $hook->get( 'name' ) );
- $this->assertEquals( $data['llms_rest_webhook_topic'], $hook->get( 'topic' ) );
- $this->assertEquals( $data['llms_rest_webhook_secret'], $hook->get( 'secret' ) );
- $this->assertEquals( $data['llms_rest_webhook_delivery_url'], $hook->get( 'delivery_url' ) );
- $this->assertEquals( $data['llms_rest_webhook_status'], $hook->get( 'status' ) );
-
- throw $exception;
-
- }
-
- }
-
- /**
- * Test creating a webhook with a custom action.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_create_webhook_custom_action() {
-
- $data = array(
- 'llms_rest_webhook_nonce' => wp_create_nonce( 'create-update-webhook' ),
- 'llms_rest_webhook_name' => 'Webhook Name',
- 'llms_rest_webhook_topic' => 'action',
- 'llms_rest_webhook_secret' => 'myawesomesecret',
- 'llms_rest_webhook_delivery_url' => 'https://mock.tld',
- 'llms_rest_webhook_status' => 'active',
- );
-
- $this->mockPostRequest( $data );
- $ret = $this->obj->handle_events();
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_invalid_topic', $ret );
-
- $data['llms_rest_webhook_action'] = 'mock';
- $this->mockPostRequest( $data );
-
- $this->expectException( LLMS_Unit_Test_Exception_Redirect::class );
- $this->expectExceptionMessage( 'http://example.org/wp-admin/admin.php?page=llms-settings&tab=rest-api§ion=webhooks&edit-webhook=1 [301] YES' );
-
- try {
- $this->obj->handle_events();
- } catch ( LLMS_Unit_Test_Exception_Redirect $exception ) {
-
- $hook = LLMS_REST_API()->webhooks()->get( 1 );
-
- $this->assertEquals( 'action.mock', $hook->get( 'topic' ) );
-
- throw $exception;
-
- }
-
- }
-
- /**
- * Test upserting a webhook with weird or invalid ids.
- *
- * @since 1.0.0-beta.1
- *
- * @see {Reference}
- * @link {URL}
- *
- * @return [type]
- */
- public function test_upsert_webhook_weird_ids() {
-
- $data = array(
- 'llms_rest_webhook_nonce' => wp_create_nonce( 'create-update-webhook' ),
- );
-
- $tests = array(
- 'llms_rest_api_webhook_not_found' => array( 999, '999', ), // Will preform a lookup for numeric values.
- 'llms_rest_webhook_missing_topic' => array( 0, '0', 'string', false, null, '', ' ' ), // Will attempt to create.
- );
- foreach ( $tests as $code => $ids ) {
-
- foreach ( $ids as $id ) {
-
- $data['llms_rest_webhook_id'] = $id;
- $this->mockPostRequest( $data );
-
- $ret = $this->obj->handle_events();
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( $code, $ret );
-
- }
-
- }
-
- }
-
- public function test_update_webhook_required_fields() {
-
- $hook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.com',
- 'topic' => 'course.created',
- ) );
-
- // Can't nullify delivery url.
- $this->mockPostRequest( array(
- 'llms_rest_webhook_nonce' => wp_create_nonce( 'create-update-webhook' ),
- 'llms_rest_webhook_id' => $hook->get( 'id' ),
- 'llms_rest_webhook_delivery_url' => '',
- ) );
- $ret = $this->obj->handle_events();
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_invalid_delivery_url', $ret );
-
- }
-
- public function test_update_webhook() {
-
- $hook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.com',
- 'topic' => 'course.created',
- ) );
-
- $data = array(
- 'llms_rest_webhook_nonce' => wp_create_nonce( 'create-update-webhook' ),
- 'llms_rest_webhook_id' => $hook->get( 'id' ),
-
- 'llms_rest_webhook_name' => 'Webhook Name',
- 'llms_rest_webhook_topic' => 'course.created',
- 'llms_rest_webhook_secret' => 'myawesomesecret',
- 'llms_rest_webhook_delivery_url' => 'https://mock.tld',
- 'llms_rest_webhook_status' => 'active',
- );
-
- $this->mockPostRequest( $data );
-
- $this->assertTrue( $this->obj->handle_events() );
-
- $hook = LLMS_REST_API()->webhooks()->get( $hook->get( 'id' ) );
-
- $this->assertEquals( $data['llms_rest_webhook_name'], $hook->get( 'name' ) );
- $this->assertEquals( $data['llms_rest_webhook_topic'], $hook->get( 'topic' ) );
- $this->assertEquals( $data['llms_rest_webhook_secret'], $hook->get( 'secret' ) );
- $this->assertEquals( $data['llms_rest_webhook_delivery_url'], $hook->get( 'delivery_url' ) );
- $this->assertEquals( $data['llms_rest_webhook_status'], $hook->get( 'status' ) );
-
- }
-
- /**
- * Test updating a webhook with a custom action.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_update_webhook_custom_action() {
-
- $hook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.com',
- 'topic' => 'course.created',
- ) );
-
- $data = array(
- 'llms_rest_webhook_nonce' => wp_create_nonce( 'create-update-webhook' ),
- 'llms_rest_webhook_id' => $hook->get( 'id' ),
-
- 'llms_rest_webhook_topic' => 'action',
- );
-
- $this->mockPostRequest( $data );
- $ret = $this->obj->handle_events();
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_invalid_topic', $ret );
-
- $data['llms_rest_webhook_action'] = 'mock';
- $this->mockPostRequest( $data );
-
- $this->obj->handle_events();
-
- $hook = LLMS_REST_API()->webhooks()->get( $hook->get( 'id' ) );
-
- $this->assertEquals( 'action.mock', $hook->get( 'topic' ) );
-
- }
-
- /**
- * Test the "Revoke" nonce URL for deleting api keys.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_revoke_key() {
-
- // Key id but no nonce.
- $this->mockGetRequest( array(
- 'revoke-key' => 9324234,
- ) );
- $this->assertFalse( $this->obj->handle_events() );
-
- // Nonce present but no key.
- $this->mockGetRequest( array(
- 'key-revoke-nonce' => wp_create_nonce( 'revoke' ),
- ) );
- $this->assertFalse( $this->obj->handle_events() );
-
- // Nonce & key but key is fake.
- $this->mockGetRequest( array(
- 'revoke-key' => 9324234,
- 'key-revoke-nonce' => wp_create_nonce( 'revoke' ),
- ) );
- $this->assertFalse( $this->obj->handle_events() );
-
- // Nonce is fake.
- $this->mockGetRequest( array(
- 'revoke-key' => 9324234,
- 'key-revoke-nonce' => 'arstarstarst',
- ) );
- $this->assertFalse( $this->obj->handle_events() );
-
- // Real key and real nonce.
- $key = LLMS_REST_API()->keys()->create( array(
- 'description' => 'Test Key',
- 'user_id' => $this->factory->user->create(),
- ) );
- $this->mockGetRequest( array(
- 'revoke-key' => $key->get( 'id' ),
- 'key-revoke-nonce' => wp_create_nonce( 'revoke' ),
- ) );
-
- // redirect and exit back to the keys list.
- $this->expectException( LLMS_Unit_Test_Exception_Redirect::class );
- $this->expectExceptionMessage( 'http://example.org/wp-admin/admin.php?page=llms-settings&tab=rest-api§ion=keys [302] YES' );
-
- try {
-
- $this->obj->handle_events();
-
- } catch ( LLMS_Unit_Test_Exception_Redirect $exception ) {
-
- // Key will no longer exist.
- $this->assertFalse( LLMS_REST_API()->keys()->get( $key->get( 'id' ) ) );
-
- // Should have an admin notice.
- $notices = LLMS_Admin_Notices::get_notices();
- $this->assertEquals( 1, count( $notices ) );
- $this->assertEquals( 'The API Key has been successfully deleted.', LLMS_Admin_Notices::get_notice( $notices[0] )['html'] );
-
- throw $exception;
- }
-
- }
-
- /**
- * Test the delete nonce URL for deleting webhooks.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_delete_webhook() {
-
- // Key id but no nonce.
- $this->mockGetRequest( array(
- 'delete-webhook' => 9324234,
- ) );
- $this->assertFalse( $this->obj->handle_events() );
-
- // Nonce present but no key.
- $this->mockGetRequest( array(
- 'delete-webhook-nonce' => wp_create_nonce( 'delete' ),
- ) );
- $this->assertFalse( $this->obj->handle_events() );
-
- // Nonce & key but key is fake.
- $this->mockGetRequest( array(
- 'delete-webhook' => 9324234,
- 'delete-webhook-nonce' => wp_create_nonce( 'delete' ),
- ) );
- $this->assertFalse( $this->obj->handle_events() );
-
- // Nonce is fake.
- $this->mockGetRequest( array(
- 'delete-webhook' => 9324234,
- 'delete-webhook-nonce' => 'arstarstarst',
- ) );
- $this->assertFalse( $this->obj->handle_events() );
-
- // Real webhook and real nonce.
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.tld',
- ) );
- $this->mockGetRequest( array(
- 'delete-webhook' => $webhook->get( 'id' ),
- 'delete-webhook-nonce' => wp_create_nonce( 'delete' ),
- ) );
-
- // redirect and exit back to the webhooks list.
- $this->expectException( LLMS_Unit_Test_Exception_Redirect::class );
- $this->expectExceptionMessage( 'http://example.org/wp-admin/admin.php?page=llms-settings&tab=rest-api§ion=webhooks [302] YES' );
-
- try {
-
- $this->obj->handle_events();
-
- } catch ( LLMS_Unit_Test_Exception_Redirect $exception ) {
-
- // Key will no longer exist.
- $this->assertFalse( LLMS_REST_API()->webhooks()->get( $webhook->get( 'id' ) ) );
-
- // Should have an admin notice.
- $notices = LLMS_Admin_Notices::get_notices();
- $this->assertEquals( 1, count( $notices ) );
- $this->assertEquals( 'The webhook has been successfully deleted.', LLMS_Admin_Notices::get_notice( $notices[0] )['html'] );
-
- throw $exception;
- }
-
- }
-
-}
diff --git a/tests/unit-tests/admin/class-llms-rest-test-admin-settings-page.php b/tests/unit-tests/admin/class-llms-rest-test-admin-settings-page.php
deleted file mode 100644
index fe29356b..00000000
--- a/tests/unit-tests/admin/class-llms-rest-test-admin-settings-page.php
+++ /dev/null
@@ -1,106 +0,0 @@
-includes();
- include_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.notices.php';
- include_once LLMS_REST_API_PLUGIN_DIR . 'includes/admin/class-llms-rest-admin-settings-page.php';
- $this->page = new LLMS_REST_Admin_Settings_Page();
-
- $this->user = $this->factory->user->create( array( 'role' => 'administrator' ) );
-
- }
-
- /**
- * Tear down the test case.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function tearDown() {
- parent::tearDown();
- }
-
- /**
- * test hooks are added from the constructor
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_hooks() {
-
- $this->assertEquals( 20, has_filter( 'lifterlms_settings_tabs_array', array( $this->page, 'add_settings_page' ) ) );
- $this->assertEquals( 10, has_action( 'lifterlms_sections_rest-api', array( $this->page, 'output_sections_nav' ) ) );
- $this->assertEquals( 10, has_action( 'lifterlms_settings_rest-api', array( $this->page, 'output' ) ) );
-
- $this->assertEquals( 10, has_action( 'lifterlms_settings_save_rest-api', array( 'LLMS_Rest_Admin_Settings_API_Keys', 'save' ) ) );
-
- $this->assertEquals( 10, has_filter( 'llms_settings_rest-api_has_save_button', '__return_false' ) );
- $this->assertEquals( 10, has_filter( 'llms_table_get_table_classes', array( $this->page, 'get_table_classes' ) ) );
-
- $this->assertEquals( 10, has_action( 'lifterlms_admin_field_title-with-html', array( $this->page, 'output_title_field' ) ) );
-
- }
-
- /**
- * Test get_current_section() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_current_section() {
-
- // Default with no permissions.
- $this->assertEquals( 'main', LLMS_Unit_Test_Util::call_method( $this->page, 'get_current_section' ) );
-
- // Default with permissions.
- wp_set_current_user( $this->user );
- $this->assertEquals( 'keys', LLMS_Unit_Test_Util::call_method( $this->page, 'get_current_section' ) );
-
- }
-
- /**
- * Test get_sections() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_sections() {
-
- // None without permissions.
- $this->assertEquals( array(), $this->page->get_sections() );
-
- // With permissions.
- wp_set_current_user( $this->user );
- $this->assertEquals( array( 'keys', 'webhooks' ), array_keys( $this->page->get_sections() ) );
-
- }
-
-}
diff --git a/tests/unit-tests/class-llms-rest-test-api-key.php b/tests/unit-tests/class-llms-rest-test-api-key.php
deleted file mode 100644
index 94249cd0..00000000
--- a/tests/unit-tests/class-llms-rest-test-api-key.php
+++ /dev/null
@@ -1,114 +0,0 @@
-keys()->create( array(
- 'description' => 'Test Key',
- 'user_id' => $this->factory->user->create(),
- ) );
-
- $this->assertEquals(
- 'http://example.org/wp-admin/admin.php?page=llms-settings&tab=rest-api§ion=keys&edit-key=' . $key->get( 'id' ),
- $key->get_edit_link()
- );
-
- }
-
- /**
- * Test the get_delete_link() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_delete_link() {
-
- $key = LLMS_REST_API()->keys()->create( array(
- 'description' => 'Test Key',
- 'user_id' => $this->factory->user->create(),
- ) );
-
- $link = $key->get_delete_link();
-
- $this->assertEquals( 0, strpos( 'http://example.org/wp-admin/admin.php?page=llms-settings&tab=rest-api§ion=keys&revoke-key=' . $key->get( 'id' ), $key->get_delete_link() ) );
- parse_str( wp_parse_url( $link, PHP_URL_QUERY ), $parts );
- $this->assertTrue( array_key_exists( 'key-revoke-nonce', $parts ) );
-
- }
-
- /**
- * Test has_permissions() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_has_permission() {
-
- $key = $this->get_mock_api_key( 'read' );
- $tests = array(
- 'HEAD' => true,
- 'GET' => true,
- 'POST' => false,
- 'PUT' => false,
- 'PATCH' => false,
- 'DELETE' => false,
- 'OPTIONS' => true,
- 'FAKE' => false,
- );
- foreach ( $tests as $method => $expect ) {
- $this->assertEquals( $expect, $key->has_permission( $method ), $method );
- }
-
- $key = $this->get_mock_api_key( 'write' );
- $tests = array(
- 'HEAD' => false,
- 'GET' => false,
- 'POST' => true,
- 'PUT' => true,
- 'PATCH' => true,
- 'DELETE' => true,
- 'OPTIONS' => true,
- 'FAKE' => false,
- );
- foreach ( $tests as $method => $expect ) {
- $this->assertEquals( $expect, $key->has_permission( $method ), $method );
- }
-
- $key = $this->get_mock_api_key( 'read_write' );
- $tests = array(
- 'HEAD' => true,
- 'GET' => true,
- 'POST' => true,
- 'PUT' => true,
- 'PATCH' => true,
- 'DELETE' => true,
- 'OPTIONS' => true,
- 'FAKE' => false,
- );
- foreach ( $tests as $method => $expect ) {
- $this->assertEquals( $expect, $key->has_permission( $method ), $method );
- }
-
- }
-
-}
diff --git a/tests/unit-tests/class-llms-rest-test-api-keys-query.php b/tests/unit-tests/class-llms-rest-test-api-keys-query.php
deleted file mode 100644
index 56e2b9ab..00000000
--- a/tests/unit-tests/class-llms-rest-test-api-keys-query.php
+++ /dev/null
@@ -1,259 +0,0 @@
-query( "TRUNCATE TABLE {$wpdb->prefix}lifterlms_api_keys" );
-
- }
-
- /**
- * Test the get_keys() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_keys() {
-
- $query = new LLMS_REST_API_Keys_Query();
- $this->assertEquals( array(), $query->get_keys() );
-
- $this->create_many_api_keys( 3 );
-
- foreach ( array( true, false ) as $with_filters ) {
-
- $query = new LLMS_REST_API_Keys_Query( array( 'suppress_filters' => $with_filters ) );
- $keys = $query->get_keys();
- foreach ( $keys as $key ) {
- $this->assertTrue( is_a( $key, 'LLMS_REST_API_Key' ) );
- }
-
- }
-
-
- }
-
- /**
- * Test the include and exclude arguments.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_query_args_include_and_exclude() {
-
- $this->create_many_api_keys( 5 );
- $query = new LLMS_REST_API_Keys_Query( array() );
- $ids = range( 1, 5 );
-
- $this->create_many_api_keys( 5 );
-
- $query = new LLMS_REST_API_Keys_Query( array(
- 'include' => $ids,
- ) );
- $this->assertEquals( 5, $query->found_results );
- $this->assertEquals( $ids, wp_list_pluck( $query->get_results(), 'id' ) );
-
- $query = new LLMS_REST_API_Keys_Query( array(
- 'exclude' => $ids,
- ) );
- $this->assertEquals( 5, $query->found_results );
- $this->assertEquals( range( 6, 10 ), wp_list_pluck( $query->get_results(), 'id' ) );
-
- }
-
- /**
- * Test pagination of query results.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_query_args_pagination() {
-
- $this->create_many_api_keys( 25 );
-
- $query = new LLMS_REST_API_Keys_Query( array() );
- $this->assertEquals( 10, count( $query->get_results() ) );
- $this->assertEquals( 25, $query->found_results );
- $this->assertEquals( 3, $query->max_pages );
- $this->assertEquals( range( 1, 10 ), wp_list_pluck( $query->get_results(), 'id' ) );
- $this->assertTrue( $query->is_first_page() );
-
- $query = new LLMS_REST_API_Keys_Query( array( 'page' => 2 ) );
- $this->assertEquals( range( 11, 20 ), wp_list_pluck( $query->get_results(), 'id' ) );
-
- $query = new LLMS_REST_API_Keys_Query( array( 'page' => 3 ) );
- $this->assertEquals( range( 21, 25 ), wp_list_pluck( $query->get_results(), 'id' ) );
- $this->assertTrue( $query->is_last_page() );
-
- }
-
- /**
- * Test the permissions arguments.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_query_args_permissions() {
-
- $this->create_many_api_keys( 5, 'read' );
- $this->create_many_api_keys( 5, 'read_write' );
- $this->create_many_api_keys( 5, 'write' );
-
- $query = new LLMS_REST_API_Keys_Query( array() );
- $this->assertEquals( 15, $query->found_results );
-
- foreach ( array_keys( LLMS_REST_API()->keys()->get_permissions() ) as $pem ) {
-
- $query = new LLMS_REST_API_Keys_Query( array( 'permissions' => $pem ) );
- $this->assertEquals( 5, $query->found_results );
-
- }
-
- }
-
- /**
- * Test setting up default query args.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_query_args_setup_with_defaults() {
-
- $query = new LLMS_REST_API_Keys_Query();
-
- $args = array(
- 'include' => array(),
- 'exclude' => array(),
- 'permissions' => '',
- 'user' => array(),
- 'user_not_in' => array(),
- 'page' => 1,
- 'per_page' => 10,
- 'sort' => array(
- 'id' => 'ASC'
- ),
- );
-
- foreach ( $args as $arg => $expect ) {
- $this->assertEquals( $expect, $query->get( $arg ), $arg );
- }
-
- }
-
- /**
- * Tests setting up all possible arguments with custom arguments.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_query_args_setup_with_custom() {
-
- $args = array(
- 'include' => array( 1, 2, 3 ),
- 'exclude' => array( 4, 5, 6 ),
- 'permissions' => 'read',
- 'user' => array( 3 ),
- 'user_not_in' => array( 234, 432 ),
- 'page' => 5,
- 'per_page' => 500,
- 'sort' => array(
- 'description' => 'ASC',
- 'id' => 'DESC',
- ),
- );
-
- $query = new LLMS_REST_API_Keys_Query( $args );
-
- foreach ( $args as $arg => $expect ) {
- $this->assertEquals( $expect, $query->get( $arg ), $arg );
- }
-
- }
-
- /**
- * Merge default with custom arguments on setup.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_query_args_setup_with_merge() {
-
- $args = array(
- 'include' => array( 1, 2, 3 ),
- 'exclude' => array( 4, 5, 6 ),
- 'sort' => array(
- 'description' => 'ASC',
- 'id' => 'DESC',
- ),
- );
-
- $query = new LLMS_REST_API_Keys_Query( $args );
-
- $args['page'] = 1;
- $args['per_page'] = 10;
- $args['permissions'] = '';
- $args['user'] = array();
- $args['user_not_in'] = array();
-
- foreach ( $args as $arg => $expect ) {
- $this->assertEquals( $expect, $query->get( $arg ), $arg );
- }
-
- }
-
- /**
- * Test the users include and exclude arguments.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_query_args_users_in_and_not_in() {
-
- $uid = $this->factory->user->create();
-
- $this->create_many_api_keys( 5 );
- $this->create_many_api_keys( 5, 'read', $uid );
-
- $query = new LLMS_REST_API_Keys_Query( array(
- 'user' => $uid,
- ) );
- $res_1 = wp_list_pluck( $query->get_results(), 'id' );
- $this->assertEquals( 5, $query->found_results );
-
- $query = new LLMS_REST_API_Keys_Query( array(
- 'user_not_in' => $uid,
- ) );
- $res_2 = wp_list_pluck( $query->get_results(), 'id' );
- $this->assertEquals( 5, $query->found_results );
- $this->assertTrue( $res_1 !== $res_2 );
-
- }
-
-}
diff --git a/tests/unit-tests/class-llms-rest-test-api-keys.php b/tests/unit-tests/class-llms-rest-test-api-keys.php
deleted file mode 100644
index e591ae10..00000000
--- a/tests/unit-tests/class-llms-rest-test-api-keys.php
+++ /dev/null
@@ -1,312 +0,0 @@
-keys = LLMS_REST_API()->keys();
-
- }
-
- /**
- * Test all potential errors encountered during API Key creation.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_create_errors() {
-
- // Can't create when an ID is supplied.
- $ret = $this->keys->create( array(
- 'id' => 1,
- ) );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_key_exists', $ret );
-
- $data = array();
-
- // No description.
- $ret = $this->keys->create( $data );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_key_missing_description', $ret );
-
- $data['description'] = 'Mock key description';
-
- // No user_ids.
- foreach( array( '0', 0, '' ) as $uid ) {
- $data['user_id'] = $uid;
- $ret = $this->keys->create( $data );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_key_missing_user_id', $ret );
- }
-
- // Invalid user_id.
- $data['user_id'] = 92349234;
- $ret = $this->keys->create( $data );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_key_invalid_user_id', $ret );
-
- $data['user_id'] = $this->factory->user->create();
-
- // Invalid permissions.
- $data['permissions'] = 'fake';
- $ret = $this->keys->create( $data );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_key_invalid_permissions', $ret );
-
- }
-
- /**
- * Test the success of the create() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_create_success() {
-
- $expected_actions = did_action( 'llms_rest_api_key_created' ) + 1;
-
- // Use default permissions.
- $data = array(
- 'description' => 'Test Key',
- 'user_id' => $this->factory->user->create(),
- );
- $ret = $this->keys->create( $data );
- $this->assertEquals( $expected_actions, did_action( 'llms_rest_api_key_created' ) );
- $this->assertTrue( is_a( $ret, 'LLMS_REST_API_Key' ) );
- $this->assertTrue( $ret->exists() );
- $this->assertTrue( ! empty( $ret->get( 'consumer_key_one_time' ) ) );
- $this->assertEquals( llms_rest_api_hash( $ret->get( 'consumer_key_one_time' ) ), $ret->get( 'consumer_key' ) );
- $this->assertEquals( 'read', $ret->get( 'permissions' ) );
- $this->assertEquals( substr( $ret->get( 'consumer_key_one_time' ), -7 ), $ret->get( 'truncated_key' ) );
- $this->assertEquals( $data['description'], $ret->get( 'description' ) );
- $this->assertEquals( $data['user_id'], $ret->get( 'user_id' ) );
- $this->assertTrue( 0 === strpos( $ret->get( 'consumer_secret' ), 'cs_' ) );
-
- // Create a key for each valid permission.
- foreach ( array_keys( $this->keys->get_permissions() ) as $permission ) {
-
- $expected_actions++;
-
- $data = array(
- 'description' => 'Test Key',
- 'user_id' => $this->factory->user->create(),
- 'permissions' => $permission,
- );
- $ret = $this->keys->create( $data );
- $this->assertEquals( $expected_actions, did_action( 'llms_rest_api_key_created' ) );
- $this->assertTrue( is_a( $ret, 'LLMS_REST_API_Key' ) );
- $this->assertTrue( $ret->exists() );
- $this->assertTrue( ! empty( $ret->get( 'consumer_key_one_time' ) ) );
- $this->assertEquals( llms_rest_api_hash( $ret->get( 'consumer_key_one_time' ) ), $ret->get( 'consumer_key' ) );
- $this->assertEquals( $permission, $ret->get( 'permissions' ) );
- $this->assertEquals( substr( $ret->get( 'consumer_key_one_time' ), -7 ), $ret->get( 'truncated_key' ) );
- $this->assertEquals( $data['description'], $ret->get( 'description' ) );
- $this->assertEquals( $data['user_id'], $ret->get( 'user_id' ) );
- $this->assertTrue( 0 === strpos( $ret->get( 'consumer_secret' ), 'cs_' ) );
-
- }
-
- }
-
- /**
- * Test the delete() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_delete() {
-
- $expected_actions = did_action( 'llms_rest_api_key_deleted' ) + 1;
-
- // Invalid key.
- $this->assertFalse( $this->keys->delete( 99993423423 ) );
-
- // Create a mock key to work with.
- $orig = $this->keys->create( array(
- 'description' => 'Test Key',
- 'user_id' => $this->factory->user->create(),
- ) );
-
- // Returns true.
- $this->assertTrue( $this->keys->delete( $orig->get( 'id' ) ) );
-
- // Action was run.
- $this->assertEquals( $expected_actions, did_action( 'llms_rest_api_key_deleted' ) );
-
- // Can't find via new get.
- $this->assertFalse( $this->keys->get( $orig->get( 'id' ) ) );
-
- }
-
- /**
- * Test the get() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get() {
-
- // Invalid Key.
- $this->assertFalse( $this->keys->get( 99993423423 ) );
-
- // Create a mock key to work with.
- $orig = $this->keys->create( array(
- 'description' => 'Test Key',
- 'user_id' => $this->factory->user->create(),
- ) );
-
- // Key exists.
- $ret = $this->keys->get( $orig->get( 'id' ) );
- $this->assertTrue( is_a( $ret, 'LLMS_REST_API_Key' ) );
- $this->assertEquals( $orig->get( 'consumer_key' ), $ret->get( 'consumer_key' ) );
- $this->assertEquals( $orig->get( 'consumer_secret' ), $ret->get( 'consumer_secret' ) );
- $this->assertEquals( llms_rest_api_hash( $orig->get( 'consumer_key_one_time' ) ), $ret->get( 'consumer_key' ) );
-
- }
-
- /**
- * Test the `get_admin_url()` method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_admin_url() {
-
- $this->assertEquals( 'http://example.org/wp-admin/admin.php?page=llms-settings&tab=rest-api§ion=keys', $this->keys->get_admin_url() );
-
- }
-
- /**
- * Test the get_permissions() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_permissions() {
-
- $permissions = $this->keys->get_permissions();
- $this->assertEquals( array( 'read', 'write', 'read_write' ), array_keys( $permissions ) );
- $this->assertEquals( array( 'Read', 'Write', 'Read / Write' ), array_values( $permissions ) );
-
- }
-
- /**
- * Test update() error conditions.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_update_errors() {
-
- // No ID.
- $ret = $this->keys->update( array() );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_key_missing_id', $ret );
-
-
- // Invalid Key.
- $ret = $this->keys->update( array(
- 'id' => 99993423423,
- ) );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_key_invalid_key', $ret );
-
- // Create a mock key to work with.
- $orig = $this->keys->create( array(
- 'description' => 'Test Key',
- 'user_id' => $this->factory->user->create(),
- ) );
-
- $data = array(
- 'id' => $orig->get( 'id' ),
- );
-
- // Empty and invalid user ids.
- foreach( array( '', 0, '0', 92349234 ) as $uid ) {
- // Invalid user_id.
- $data['user_id'] = $uid;
- $ret = $this->keys->update( $data );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_key_invalid_user_id', $ret );
- }
-
- $data['user_id'] = $this->factory->user->create();
-
- // Invalid description.
- $data['description'] = '';
- $ret = $this->keys->update( $data );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_key_invalid_description', $ret );
-
- $data['description'] = 'Okay description';
-
- // Invalid permissions.
- $data['permissions'] = 'fake';
- $ret = $this->keys->update( $data );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_key_invalid_permissions', $ret );
-
- }
-
- /**
- * Test update() method success.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_update_success() {
-
- // Create a mock key to work with.
- $orig = $this->keys->create( array(
- 'description' => 'Test Key',
- 'user_id' => $this->factory->user->create(),
- ) );
-
- // New data.
- $data = array(
- 'id' => $orig->get( 'id' ),
- 'description' => 'Update key description',
- 'user_id' => $this->factory->user->create(),
- 'permissions' => 'read_write',
- 'last_access' => current_time( 'mysql' ),
- );
- $ret = $this->keys->update( $data );
- $this->assertTrue( is_a( $ret, 'LLMS_REST_API_Key' ) );
- $this->assertEquals( $data['description'], $ret->get( 'description' ) );
- $this->assertEquals( $data['user_id'], $ret->get( 'user_id' ) );
- $this->assertEquals( $data['permissions'], $ret->get( 'permissions' ) );
- $this->assertEquals( $data['last_access'], $ret->get( 'last_access' ) );
-
- // Don't allow write-protected keys to be updated.
- $data = array_merge( array(
- 'consumer_key' => 'ast',
- 'consumer_secret' => 'ast',
- 'truncated_key' => 'ast',
- ), $data );
- $ret = $this->keys->update( $data );
- $this->assertEquals( $orig->get( 'consumer_key' ), $ret->get( 'consumer_key' ) );
- $this->assertEquals( $orig->get( 'consumer_secret' ), $ret->get( 'consumer_secret' ) );
- $this->assertEquals( $orig->get( 'truncated_key' ), $ret->get( 'truncated_key' ) );
-
- }
-
-}
diff --git a/tests/unit-tests/class-llms-rest-test-authentication.php b/tests/unit-tests/class-llms-rest-test-authentication.php
deleted file mode 100644
index 21f7739f..00000000
--- a/tests/unit-tests/class-llms-rest-test-authentication.php
+++ /dev/null
@@ -1,210 +0,0 @@
-auth = new LLMS_REST_Authentication();
-
- }
-
- /**
- * Test the authenticate method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_authenticate() {
-
- $expected_actions = did_action( 'llms_rest_basic_auth_success' );
-
- // An already authenticated user.
- $this->assertEquals( 123, $this->auth->authenticate( 123 ) );
- $this->assertEquals( $expected_actions, did_action( 'llms_rest_basic_auth_success' ) );
-
- // No SSL.
- $this->assertEquals( false, $this->auth->authenticate( false ) );
- $this->assertEquals( $expected_actions, did_action( 'llms_rest_basic_auth_success' ) );
-
- $_SERVER['HTTPS'] = 'ON';
-
- $this->assertEquals( false, $this->auth->authenticate( false ) );
- $this->assertEquals( $expected_actions, did_action( 'llms_rest_basic_auth_success' ) );
-
- // Not an LLMS Request.
- $_SERVER['REQUEST_URI'] = 'https://example.org/wp-json/wp/v1/mock';
-
- $this->assertEquals( false, $this->auth->authenticate( false ) );
- $this->assertEquals( $expected_actions, did_action( 'llms_rest_basic_auth_success' ) );
-
- $_SERVER['REQUEST_URI'] = 'https://example.org/wp-json/llms/v1/mock';
-
- // No credentials.
- $this->assertEquals( false, $this->auth->authenticate( false ) );
- $this->assertEquals( $expected_actions, did_action( 'llms_rest_basic_auth_success' ) );
-
- // Success.
- $key = $this->get_mock_api_key();
- $expected_actions++;
- $this->assertEquals( $key->get( 'user_id' ), $this->auth->authenticate( false ) );
- $this->assertEquals( $expected_actions, did_action( 'llms_rest_basic_auth_success' ) );
-
- // Correct key, incorrect secret.
- $_SERVER['HTTP_X_LLMS_CONSUMER_SECRET'] = 'fakesecret';
- $this->assertEquals( false, $this->auth->authenticate( false ) );
- $this->assertEquals( $expected_actions, did_action( 'llms_rest_basic_auth_success' ) );
- $this->assertTrue( is_wp_error( LLMS_Unit_Test_Util::call_method( $this->auth, 'get_error' ) ) );
-
- // Incorrect key.
- $_SERVER['HTTP_X_LLMS_CONSUMER_KEY'] = 'fakekey';
- $this->assertEquals( false, $this->auth->authenticate( false ) );
- $this->assertEquals( $expected_actions, did_action( 'llms_rest_basic_auth_success' ) );
-
- }
-
- /**
- * Test key lookup.
- *
- * @since 1.0.0-beta.1
- *
- * @return [type]
- */
- public function test_find_key() {
-
- // No keys to find.
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $this->auth, 'find_key', array( 'ck_fake' ) ) );
-
- $keys = array();
- $i = 0;
- while ( $i < 3 ) {
-
- $keys[] = LLMS_REST_API()->keys()->create( array(
- 'description' => 'Test Key ' . $i,
- 'user_id' => $this->factory->user->create(),
- ) );
-
- // Fake key.
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $this->auth, 'find_key', array( 'ck_fake' ) ) );
-
- // Find the key
- $found = LLMS_Unit_Test_Util::call_method( $this->auth, 'find_key', array( $keys[ $i ]->get( 'consumer_key_one_time' ) ) );
- $this->assertEquals( $keys[ $i ]->get( 'id' ), $found->get( 'id' ) );
-
- $i++;
-
- }
-
- }
-
- /**
- * Test the get_credentials() method using headers.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_credentials_from_headers() {
-
- $expect = array(
- 'key' => 'mock_key',
- 'secret' => 'mock_secret',
- );
-
- // No key or secret.
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $this->auth, 'locate_credentials', array( 'HTTP_X_LLMS_CONSUMER_KEY', 'HTTP_X_LLMS_CONSUMER_SECRET' ) ) );
-
- // Key, no secret.
- $_SERVER['HTTP_X_LLMS_CONSUMER_KEY'] = $expect['key'];
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $this->auth, 'locate_credentials', array( 'HTTP_X_LLMS_CONSUMER_KEY', 'HTTP_X_LLMS_CONSUMER_SECRET' ) ) );
-
- // Secret, no key.
- unset( $_SERVER['HTTP_X_LLMS_CONSUMER_KEY'] );
- $_SERVER['HTTP_X_LLMS_CONSUMER_SECRET'] = $expect['secret'];
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $this->auth, 'locate_credentials', array( 'HTTP_X_LLMS_CONSUMER_KEY', 'HTTP_X_LLMS_CONSUMER_SECRET' ) ) );
-
- // Key & Secret
- $_SERVER['HTTP_X_LLMS_CONSUMER_KEY'] = $expect['key'];
- $this->assertEquals( $expect, LLMS_Unit_Test_Util::call_method( $this->auth, 'locate_credentials', array( 'HTTP_X_LLMS_CONSUMER_KEY', 'HTTP_X_LLMS_CONSUMER_SECRET' ) ) );
-
- unset( $_SERVER['HTTP_X_LLMS_CONSUMER_KEY'], $_SERVER['HTTP_X_LLMS_CONSUMER_SECRET'] );
-
- }
-
- /**
- * Test the get_credentials() method using basic auth.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_credentials_from_auth() {
-
- $expect = array(
- 'key' => 'mock_key',
- 'secret' => 'mock_secret',
- );
-
- // No key or secret.
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $this->auth, 'locate_credentials', array( 'PHP_AUTH_USER', 'PHP_AUTH_PW' ) ) );
-
- // Key, no secret.
- $_SERVER['PHP_AUTH_USER'] = $expect['key'];
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $this->auth, 'locate_credentials', array( 'PHP_AUTH_USER', 'PHP_AUTH_PW' ) ) );
-
- // Secret, no key.
- unset( $_SERVER['PHP_AUTH_USER'] );
- $_SERVER['PHP_AUTH_PW'] = $expect['secret'];
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $this->auth, 'locate_credentials', array( 'PHP_AUTH_USER', 'PHP_AUTH_PW' ) ) );
-
- // Key & Secret
- $_SERVER['PHP_AUTH_USER'] = $expect['key'];
- $this->assertEquals( $expect, LLMS_Unit_Test_Util::call_method( $this->auth, 'locate_credentials', array( 'PHP_AUTH_USER', 'PHP_AUTH_PW' ) ) );
-
- unset( $_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW'] );
-
- }
-
- /**
- * Test the is_rest_request() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_is_rest_request() {
-
- $tests = array(
- '' => false,
- 'http://example.com/wp-json/wp/v1/mock' => false,
- 'https://example.com/wp-json/mock/v1/mock' => false,
-
- 'https://example.org/wp-json/llms/v1/mock' => true,
- 'https://example.com/wp-json/llms/v1/mock' => true,
- 'https://example.com/wp-json/llms/v2/mock' => true,
- 'http://example.com/wp-json/llms/v1/mock' => true,
- 'http://example.com/wp-json/llms-external/v1/mock' => true,
- );
-
- foreach ( $tests as $uri => $expect ) {
-
- $_SERVER['REQUEST_URI'] = $uri;
- $this->assertEquals( $expect, LLMS_Unit_Test_Util::call_method( $this->auth, 'is_rest_request' ) );
-
- }
-
-
- }
-
-}
diff --git a/tests/unit-tests/class-llms-rest-test-capabilities.php b/tests/unit-tests/class-llms-rest-test-capabilities.php
deleted file mode 100644
index 6fab5c07..00000000
--- a/tests/unit-tests/class-llms-rest-test-capabilities.php
+++ /dev/null
@@ -1,61 +0,0 @@
-assertEquals( array(
- 'manage_lifterlms_api_keys' => true,
- 'manage_lifterlms_webhooks' => true,
- ), LLMS_REST_Capabilities::add( array() ) );
- $this->assertEquals( array(
- 'some_other_cap' => true,
- 'manage_lifterlms_api_keys' => true,
- 'manage_lifterlms_webhooks' => true,
- ), LLMS_REST_Capabilities::add( array( 'some_other_cap' => true ) ) );
-
- }
-
- /**
- * Test various user types to ensure they have the proper capabilities.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_user_capabilites_integration() {
-
- $admin = $this->factory->user->create( array( 'role' => 'administrator' ) );
- $manager = $this->factory->user->create( array( 'role' => 'lms_manager' ) );
- $student = $this->factory->student->create();
- $subscriber = $this->factory->user->create( array( 'role' => 'subscriber' ) );
-
- $this->assertTrue( user_can( $admin, 'manage_lifterlms_api_keys' ) );
- $this->assertTrue( user_can( $manager, 'manage_lifterlms_api_keys' ) );
- $this->assertFalse( user_can( $student, 'manage_lifterlms_api_keys' ) );
- $this->assertFalse( user_can( $subscriber, 'manage_lifterlms_api_keys' ) );
-
- $this->assertTrue( user_can( $admin, 'manage_lifterlms_webhooks' ) );
- $this->assertTrue( user_can( $manager, 'manage_lifterlms_webhooks' ) );
- $this->assertFalse( user_can( $student, 'manage_lifterlms_webhooks' ) );
- $this->assertFalse( user_can( $subscriber, 'manage_lifterlms_webhooks' ) );
-
- }
-
-}
diff --git a/tests/unit-tests/class-llms-rest-test-functions.php b/tests/unit-tests/class-llms-rest-test-functions.php
deleted file mode 100644
index 527f32ee..00000000
--- a/tests/unit-tests/class-llms-rest-test-functions.php
+++ /dev/null
@@ -1,66 +0,0 @@
-assertTrue( is_string( $hash ) );
- $this->assertEquals( 64, strlen( $hash ) );
-
- $hash = llms_rest_api_hash( 'abc' );
- $this->assertTrue( is_string( $hash ) );
- $this->assertEquals( 64, strlen( $hash ) );
-
- $hash = llms_rest_api_hash( llms_rest_random_hash() );
- $this->assertTrue( is_string( $hash ) );
- $this->assertEquals( 64, strlen( $hash ) );
-
- }
-
- /**
- * Test the llms_rest_get_api_endpoint_data() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_llms_rest_get_api_endpoint_data() {
-
- $res = llms_rest_get_api_endpoint_data( '/llms/v1' );
- $this->assertEquals( 'llms/v1', $res['namespace'] );
-
- }
-
- /**
- * Test the llms_rest_random_hash() function
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_llms_rest_random_hash() {
-
- $hash = llms_rest_random_hash();
- $this->assertTrue( is_string( $hash ) );
- $this->assertEquals( 40, strlen( $hash ) );
-
- }
-
-}
diff --git a/tests/unit-tests/class-llms-rest-test-install.php b/tests/unit-tests/class-llms-rest-test-install.php
deleted file mode 100644
index 75089d82..00000000
--- a/tests/unit-tests/class-llms-rest-test-install.php
+++ /dev/null
@@ -1,127 +0,0 @@
-assertEquals( $actions, did_action( 'llms_rest_updated' ) );
-
- // Should run if version is not equal to current version.
- update_option( 'llms_rest_version', '0.0.1-alpha.1' );
- LLMS_REST_Install::check_version();
- $actions++;
- $this->assertEquals( $actions, did_action( 'llms_rest_updated' ) );
-
- // Shouldn't run b/c versions are equal
- LLMS_REST_Install::check_version();
- update_option( 'llms_rest_version', LLMS_REST_API()->version );
- $this->assertEquals( $actions, did_action( 'llms_rest_updated' ) );
-
- // Shouldn't run b/c iframe request.
- define( 'IFRAME_REQUEST', true );
- LLMS_REST_Install::check_version();
- $this->assertEquals( $actions, did_action( 'llms_rest_updated' ) );
-
- }
-
- /**
- * Test the LLMS_REST_Install::get_schema() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_schema() {
-
- global $wpdb;
-
- $collate = '';
- if ( $wpdb->has_cap( 'collation' ) ) {
- if ( ! empty( $wpdb->charset ) ) {
- $collate .= "DEFAULT CHARACTER SET $wpdb->charset";
- }
- if ( ! empty( $wpdb->collate ) ) {
- $collate .= " COLLATE $wpdb->collate";
- }
- }
-
- $default = "CREATE TABLE `{$wpdb->prefix}lifterlms_fake_table` (
-`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT
-) $collate;";
-
- $schema = LLMS_REST_Install::get_schema( $default, $collate );
- $this->assertTrue( is_string( $schema ) );
- $this->assertTrue( 0 === strpos( $schema, $default ) );
- $this->assertTrue( false !== strpos( $schema, "CREATE TABLE `{$wpdb->prefix}lifterlms_api_keys`" ) );
- $this->assertTrue( false !== strpos( $schema, "CREATE TABLE `{$wpdb->prefix}lifterlms_webhooks`" ) );
-
- }
-
- /**
- * Test the install method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_install() {
-
- // clean existing install first.
- if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) {
- define( 'WP_UNINSTALL_PLUGIN', true );
- define( 'LLMS_REMOVE_ALL_DATA', true );
- }
- include dirname( dirname( dirname( __FILE__ ) ) ) . '/uninstall.php';
-
- LLMS_REST_Install::install();
- $this->assertEquals( get_option( 'llms_rest_version' ), LLMS_REST_API()->version );
-
- global $wpdb;
- $this->assertEquals( $wpdb->prefix . 'lifterlms_api_keys', $wpdb->get_var( "SHOW TABLES LIKE '%lifterlms_api_keys'" ) );
- $this->assertEquals( $wpdb->prefix . 'lifterlms_webhooks', $wpdb->get_var( "SHOW TABLES LIKE '%lifterlms_webhooks'" ) );
-
- }
-
- /**
- * Test the update_version() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_update_version() {
-
- LLMS_REST_Install::update_version( '1' );
- $this->assertEquals( '1', get_option( 'llms_rest_version' ) );
-
- LLMS_REST_Install::update_version();
- $this->assertEquals( LLMS_REST_API()->version, get_option( 'llms_rest_version' ) );
-
- LLMS_REST_Install::update_version( '1.2.3' );
- $this->assertEquals( '1.2.3', get_option( 'llms_rest_version' ) );
-
- }
-
-}
diff --git a/tests/unit-tests/class-llms-rest-test-main.php b/tests/unit-tests/class-llms-rest-test-main.php
deleted file mode 100644
index 719fbc86..00000000
--- a/tests/unit-tests/class-llms-rest-test-main.php
+++ /dev/null
@@ -1,55 +0,0 @@
-main = LLMS_REST_API();
-
- }
-
- /**
- * Test keys() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_keys() {
-
- $this->assertTrue( is_a( $this->main->keys(), 'LLMS_REST_API_Keys' ) );
-
- }
-
-
- /**
- * Test webhooks() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_webhooks() {
-
- $this->assertTrue( is_a( $this->main->webhooks(), 'LLMS_REST_Webhooks' ) );
-
- }
-
-}
diff --git a/tests/unit-tests/class-llms-rest-test-webhook-delivery.php b/tests/unit-tests/class-llms-rest-test-webhook-delivery.php
deleted file mode 100644
index 0d8e1868..00000000
--- a/tests/unit-tests/class-llms-rest-test-webhook-delivery.php
+++ /dev/null
@@ -1,172 +0,0 @@
-assertEquals( 200, wp_remote_retrieve_response_code( $res ) );
- $this->assertEquals( $this->hook->get( 'id' ), $webhook->get( 'id' ) );
- $this->res = compact( 'http_args', 'res', 'duration', 'args', 'webhook', 'body' );
-
- }
-
- private function setup_hook( $topic ) {
-
- $this->hook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => $this->endpoint,
- 'topic' => $topic,
- 'status' => 'active',
- ) );
- $this->hook->enqueue();
-
- }
-
- /**
- * Setup the test case.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function setUp() {
- parent::setUp();
- add_filter( 'llms_rest_webhook_deliver_async', '__return_false' );
- add_action( 'llms_rest_webhook_delivery', array( $this, 'watch_for_delivery' ), 10, 5 );
- }
-
- /**
- * Tear down the test case.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function tearDown() {
-
- parent::tearDown();
- remove_filter( 'llms_rest_webhook_deliver_async', '__return_false' );
- remove_action( 'llms_rest_webhook_delivery', array( $this, 'watch_for_delivery' ), 10 );
- global $wpdb;
- $wpdb->query( "TRUNCATE TABLE {$wpdb->prefix}lifterlms_webhooks" );
-
- }
-
- /*
- /$$$$$$
- /$$__ $$
- | $$ \__/ /$$$$$$ /$$ /$$ /$$$$$$ /$$$$$$$ /$$$$$$ /$$$$$$$
- | $$ /$$__ $$| $$ | $$ /$$__ $$ /$$_____/ /$$__ $$ /$$_____/
- | $$ | $$ \ $$| $$ | $$| $$ \__/| $$$$$$ | $$$$$$$$| $$$$$$
- | $$ $$| $$ | $$| $$ | $$| $$ \____ $$| $$_____/ \____ $$
- | $$$$$$/| $$$$$$/| $$$$$$/| $$ /$$$$$$$/| $$$$$$$ /$$$$$$$/
- \______/ \______/ \______/ |__/ |_______/ \_______/|_______/
- */
- public function test_deliver_course_created() {
-
- $this->setup_hook( 'course.created' );
- $id = $this->factory->post->create( array( 'post_type' => 'course' ) );
- $this->assertEquals( $id, $this->res['body']['id'] );
-
- }
-
- public function test_deliver_course_updated() {
-
- $this->setup_hook( 'course.updated' );
- $id = $this->factory->post->create( array( 'post_type' => 'course' ) );
- wp_update_post( array(
- 'ID' => $id,
- 'post_title' => 'New Title',
- ) );
- $this->assertEquals( $id, $this->res['body']['id'] );
- $this->assertEquals( 'New Title', $this->res['body']['title']['rendered'] );
-
- }
-
- public function test_deliver_course_deleted() {
-
- $this->setup_hook( 'course.deleted' );
- $id = $this->factory->post->create( array( 'post_type' => 'course' ) );
- wp_trash_post( $id );
- $this->assertEquals( $id, $this->res['body']['id'] );
-
- }
-
- public function test_deliver_course_deleted_force() {
-
- $this->setup_hook( 'course.deleted' );
- $id = $this->factory->post->create( array( 'post_type' => 'course' ) );
- wp_delete_post( $id, true );
- $this->assertEquals( $id, $this->res['body']['id'] );
-
- }
-
- public function test_deliver_course_restored() {
-
- $this->setup_hook( 'course.restored' );
- $id = $this->factory->post->create( array( 'post_type' => 'course' ) );
- wp_trash_post( $id );
- wp_untrash_post( $id );
- $this->assertEquals( $id, $this->res['body']['id'] );
-
- }
-
- /*
- /$$$$$$ /$$ /$$
- /$$__ $$ | $$ |__/
- | $$ \__/ /$$$$$$ /$$$$$$$ /$$$$$$ /$$ /$$$$$$ /$$$$$$$ /$$$$$$$
- | $$$$$$ /$$__ $$ /$$_____/|_ $$_/ | $$ /$$__ $$| $$__ $$ /$$_____/
- \____ $$| $$$$$$$$| $$ | $$ | $$| $$ \ $$| $$ \ $$| $$$$$$
- /$$ \ $$| $$_____/| $$ | $$ /$$| $$| $$ | $$| $$ | $$ \____ $$
- | $$$$$$/| $$$$$$$| $$$$$$$ | $$$$/| $$| $$$$$$/| $$ | $$ /$$$$$$$/
- \______/ \_______/ \_______/ \___/ |__/ \______/ |__/ |__/|_______/
- */
- public function test_deliver_section_created() {
-
- $this->setup_hook( 'section.created' );
- $id = $this->factory->post->create( array( 'post_type' => 'section' ) );
- $this->assertEquals( $id, $this->res['body']['id'] );
-
- }
-
- public function test_deliver_section_updated() {
-
- $this->setup_hook( 'section.updated' );
- $id = $this->factory->post->create( array( 'post_type' => 'section' ) );
- wp_update_post( array(
- 'ID' => $id,
- 'post_title' => 'New Title',
- ) );
- $this->assertEquals( $id, $this->res['body']['id'] );
- $this->assertEquals( 'New Title', $this->res['body']['title']['rendered'] );
-
- }
-
- public function test_deliver_section_deleted() {
-
- $this->setup_hook( 'section.deleted' );
- $id = $this->factory->post->create( array( 'post_type' => 'section' ) );
- wp_trash_post( $id );
- $this->assertEquals( $id, $this->res['body']['id'] );
-
- }
-
-
-
-}
diff --git a/tests/unit-tests/class-llms-rest-test-webhook.php b/tests/unit-tests/class-llms-rest-test-webhook.php
deleted file mode 100644
index 81932b71..00000000
--- a/tests/unit-tests/class-llms-rest-test-webhook.php
+++ /dev/null
@@ -1,702 +0,0 @@
- array(
- 'code' => 400,
- 'message' => 'Bad Request',
- ),
- );
-
- } elseif ( 'https://mock.tld/200' === $url ) {
-
- return array(
- 'response' => array(
- 'code' => 200,
- 'message' => 'Success',
- ),
- );
-
- }
-
- return $ret;
-
- }
-
- /**
- * Setup the test case.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function setUp() {
- parent::setUp();
- }
-
- /**
- * Tear down the test case.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function tearDown() {
- parent::tearDown();
-
- add_filter( 'llms_rest_webhook_pre_ping', '__return_true' );
- remove_filter( 'pre_http_request', array( $this, 'mock_request' ), 10 );
-
- }
-
- public function test_delivery_errors() {
-
- $course = $this->factory->course->create( array( 'sections' => 0 ) );
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld/400',
- 'topic' => 'course.created',
- 'status' => 'active',
- 'user_id' => $this->factory->user->create( array( 'role' => 'administrator' ) ),
- ) );
-
- add_filter( 'pre_http_request', array( $this, 'mock_request' ), 10, 3 );
-
- $webhook->deliver( array( $course ) );
-
- $this->assertEquals( 1, $webhook->get( 'failure_count' ) );
-
- $webhook = $webhook->set( 'failure_count', 5 );
-
- $webhook->deliver( array( $course ) );
-
- $this->assertEquals( 6, $webhook->get( 'failure_count' ) );
- $this->assertEquals( 'disabled', $webhook->get( 'status' ) );
-
- }
-
-
- public function test_delivery_success() {
-
- $course = $this->factory->course->create( array( 'sections' => 0 ) );
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld/200',
- 'topic' => 'course.created',
- 'status' => 'active',
- 'user_id' => $this->factory->user->create( array( 'role' => 'administrator' ) ),
- ) );
-
- $webhook->set( 'pending_delivery', 1 );
- $webhook->set( 'failure_count', 3 );
-
- add_filter( 'pre_http_request', array( $this, 'mock_request' ), 10, 3 );
-
- $webhook->deliver( array( $course ) );
-
- $this->assertEquals( 0, $webhook->get( 'pending_delivery' ) );
- $this->assertEquals( 0, $webhook->get( 'failure_count' ) );
-
- }
-
- /**
- * Test enqueue for an action with a single hook.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_enqueue_single_hook() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => 'course.created',
- ) );
-
- $this->assertFalse( has_action( 'save_post_course', array( $webhook, 'process_hook' ) ) );
- $webhook->enqueue();
- $this->assertEquals( 10, has_action( 'save_post_course', array( $webhook, 'process_hook' ) ) );
-
- }
-
- /**
- * Test enqueue for an action with a multiple hooks.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_enqueue_multi_hooks() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => 'enrollment.created',
- ) );
-
- $this->assertFalse( has_action( 'llms_user_course_enrollment_created', array( $webhook, 'process_hook' ) ) );
- $this->assertFalse( has_action( 'llms_user_membership_enrollment_created', array( $webhook, 'process_hook' ) ) );
- $webhook->enqueue();
- $this->assertEquals( 10, has_action( 'llms_user_course_enrollment_created', array( $webhook, 'process_hook' ) ) );
- $this->assertEquals( 10, has_action( 'llms_user_membership_enrollment_created', array( $webhook, 'process_hook' ) ) );
-
- }
-
- /**
- * Test enqueue for a custom action
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_enqueue_custom_action() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => 'action.mock_hook',
- ) );
-
- $this->assertFalse( has_action( 'mock_hook', array( $webhook, 'process_hook' ) ) );
- $webhook->enqueue();
- $this->assertEquals( 10, has_action( 'mock_hook', array( $webhook, 'process_hook' ) ) );
-
- }
-
- /**
- * Test the get_edit_link() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_edit_link() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => 'course.created',
- ) );
-
- $this->assertEquals(
- admin_url( 'admin.php?page=llms-settings&tab=rest-api§ion=webhooks&edit-webhook=' . $webhook->get( 'id' ) ),
- $webhook->get_edit_link()
- );
-
- }
-
- /**
- * Test the get_delete_link() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_delete_link() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => 'course.created',
- ) );
-
- $link = $webhook->get_delete_link();
-
- $this->assertEquals( 0, strpos( admin_url( 'admin.php?page=llms-settings&tab=rest-api§ion=webhooks&revoke-webhook=' . $webhook->get( 'id' ) ), $webhook->get_delete_link() ) );
- parse_str( wp_parse_url( $link, PHP_URL_QUERY ), $parts );
- $this->assertTrue( array_key_exists( 'delete-webhook-nonce', $parts ) );
-
- }
-
- /**
- * Test signature generation.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_delivery_signature() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => 'course.created',
- ) );
-
- $expected_ts = time();
- llms_tests_mock_current_time( time() );
- $expected_payload = wp_json_encode( array( 'mock' => 'test' ) );
-
- $sig = $webhook->get_delivery_signature( $expected_payload );
- llms_tests_reset_current_time();
-
- // Make sure the string looks right.
- $this->assertEquals( 0, strpos( $sig, 't=' ) );
- $this->assertEquals( 12, strpos( $sig, ',v1=' ) );
-
- // Parse the string and run some checks.
- $parsed = array();
- $items = explode( ',', $sig );
- foreach ( $items as $item ) {
- $item_parts = explode( '=', $item );
- $parsed[ $item_parts[0] ] = $item_parts[1];
- }
-
- $this->assertEquals( $expected_ts, $parsed['t'] );
- $this->assertArrayHasKey( 'v1', $parsed );
-
- // recreate the signature and compare.
- $hash = hash_hmac( 'sha256', $expected_ts . '.' . $expected_payload, $webhook->get( 'secret' ) );
- $this->assertEquals( $hash, $parsed['v1'] );
-
- }
-
- /**
- * Test event getter.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_event() {
-
- $tests = array(
- 'course.created' => 'created',
- 'course.updated' => 'updated',
- 'progress.updated' => 'updated',
- 'student.deleted' => 'deleted',
- 'action.mock' => 'mock',
- 'action.fake' => 'fake',
- );
-
- foreach ( $tests as $topic => $event ) {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => $topic,
- ) );
-
- $this->assertEquals( $event, $webhook->get_event() );
-
- }
-
- }
-
-
- /**
- * test hook getter.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_hooks() {
-
- foreach ( LLMS_REST_API()->webhooks()->get_hooks() as $topic => $hooks ) {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => $topic,
- ) );
-
- $this->assertEquals( $hooks, $webhook->get_hooks() );
-
- }
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => 'action.mock',
- ) );
-
- $this->assertEquals( array( 'mock' => 1 ), $webhook->get_hooks() );
-
- }
-
- /**
- * Test resource getter.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_resource() {
-
- $tests = array(
- 'course.created' => 'course',
- 'access_plan.updated' => 'access_plan',
- 'progress.updated' => 'progress',
- 'student.deleted' => 'student',
- 'action.mock' => 'action',
- 'action.fake' => 'action',
- );
-
- foreach ( $tests as $topic => $resource ) {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => $topic,
- ) );
-
- $this->assertEquals( $resource, $webhook->get_resource() );
-
- }
-
- }
-
- /**
- * Test is pending checker method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_is_pending() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://fake.tld',
- 'topic' => 'course.created',
- ) );
-
- $this->assertFalse( $webhook->is_pending() );
-
- $webhook->set( 'pending_delivery', 1 );
-
- $this->assertTrue( $webhook->is_pending() );
- }
-
- /**
- * Test validity of post actions.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_is_valid_post_action() {
-
- $post_types = array(
- 'course' => false,
- 'section' => false,
- 'lesson' => false,
- 'llms_membership' => false,
- 'llms_access_plan' => false,
- 'llms_order' => false,
- 'llms_transaction' => false,
- 'post' => false,
- 'page' => false,
- );
-
- $tests = array(
- 'course.deleted' => array_merge( $post_types, array( 'course' => true ) ),
- 'section.deleted' => array_merge( $post_types, array( 'section' => true ) ),
- 'lesson.deleted' => array_merge( $post_types, array( 'lesson' => true ) ),
- 'membership.deleted' => array_merge( $post_types, array( 'llms_membership' => true ) ),
- 'access_plan.deleted' => array_merge( $post_types, array( 'llms_access_plan' => true ) ),
- 'order.deleted' => array_merge( $post_types, array( 'llms_order' => true ) ),
- 'transaction.deleted' => array_merge( $post_types, array( 'llms_transaction' => true ) ),
- );
-
- foreach ( $tests as $topic => $post_types ) {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://fake.tld',
- 'topic' => $topic,
- ) );
-
- foreach ( $post_types as $type => $expect ) {
-
- $post_id = $this->factory->post->create( array( 'post_type' => $type ) );
- $this->assertEquals( $expect, LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_post_action', array( $post_id ) ) );
-
- }
-
- }
-
- }
-
- public function test_is_valid_resource() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://fake.tld',
- 'topic' => 'course.created',
- ) );
-
- $course = $this->factory->post->create_and_get( array( 'post_type' => 'course' ) );
-
- global $wp_current_filter;
- $wp_current_filter = array( 'save_post_course' );
- $this->assertTrue( LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_resource', array( array( $course->ID, $course, false ) ) ) );
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_resource', array( array( $course->ID, $course, true ) ) ) );
- $wp_current_filter = array();
-
- // it's a draft.
- $course->post_status = 'auto-draft';
- wp_update_post( $course );
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_resource', array( array( $course->ID, $course, false ) ) ) );
-
- }
-
- public function test_is_valid_user_action() {
-
- $student = $this->factory->student->create();
- $admin = $this->factory->user->create( array( 'role' => 'administrator' ) );
- $instructor = $this->factory->user->create( array( 'role' => 'instructor' ) );
- $subscriber = $this->factory->user->create( array( 'role' => 'subscriber' ) );
- $fake = $subscriber + 1;
-
- // Student topics.
- $topics = array(
- 'student.created',
- 'student.updated',
- 'student.deleted',
- );
-
- foreach ( $topics as $topic ) {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://fake.tld',
- 'topic' => $topic,
- ) );
-
- $this->assertTrue( LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_user_action', array( $student ) ) );
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_user_action', array( $admin ) ) );
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_user_action', array( $instructor ) ) );
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_user_action', array( $subscriber ) ) );
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_user_action', array( $fake ) ) );
-
- }
-
- // Instructor topics.
- $topics = array(
- 'instructor.created',
- 'instructor.updated',
- 'instructor.deleted',
- );
-
- foreach ( $topics as $topic ) {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://fake.tld',
- 'topic' => $topic,
- ) );
-
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_user_action', array( $student ) ) );
- $this->assertTrue( LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_user_action', array( $admin ) ) );
- $this->assertTrue( LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_user_action', array( $instructor ) ) );
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_user_action', array( $subscriber ) ) );
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $webhook, 'is_valid_user_action', array( $fake ) ) );
-
- }
-
- }
-
- public function test_scheduling_student_created() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => 'student.created',
- 'status' => 'active',
- ) );
-
- $webhook->enqueue();
-
- $schedule_args = array(
- 'webhook_id' => $webhook->get( 'id' ),
- 'args' => array( $this->factory->student->create() ),
- );
-
- $this->assertTrue( false !== as_next_scheduled_action( 'lifterlms_rest_deliver_webhook_async', $schedule_args, 'llms-webhooks' ) );
-
- }
-
- public function test_scheduling_enrollment_created() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => 'enrollment.created',
- 'status' => 'active',
- ) );
-
- $webhook->enqueue();
-
- $student = $this->factory->student->create();
- $course = $this->factory->course->create( array( 'sections' => 0 ) );
-
- $schedule_args = array(
- 'webhook_id' => $webhook->get( 'id' ),
- 'args' => array( $student, $course ),
- );
-
- llms_enroll_student( $student, $course );
-
- $this->assertTrue( false !== as_next_scheduled_action( 'lifterlms_rest_deliver_webhook_async', $schedule_args, 'llms-webhooks' ) );
-
- }
-
- /**
- * Test ping() on unresolveable urls.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_ping_unreachable() {
-
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://fake.tld',
- 'topic' => 'course.created',
- ) );
-
- remove_filter( 'llms_rest_webhook_pre_ping', '__return_true' );
-
- $ret = $webhook->ping();
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_ping_unreachable', $ret );
-
- }
-
- /**
- * Test ping() on non 200 responses.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_ping_non_200_status() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld/400',
- 'topic' => 'course.created',
- ) );
-
- add_filter( 'pre_http_request', array( $this, 'mock_request' ), 10, 3 );
- remove_filter( 'llms_rest_webhook_pre_ping', '__return_true' );
-
- $ret = $webhook->ping();
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_ping_not_200', $ret );
-
- }
-
- /**
- * Test ping() success.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_ping_success() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld/200',
- 'topic' => 'course.created',
- ) );
-
- add_filter( 'pre_http_request', array( $this, 'mock_request' ), 10, 3 );
- remove_filter( 'llms_rest_webhook_pre_ping', '__return_true' );
-
- $this->assertTrue( $webhook->ping() );
-
- }
-
- /**
- * Test the delivery failure setter.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_set_delivery_failure() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => 'student.created',
- 'status' => 'active',
- ) );
-
- $i = 1;
- while ( $i <= 6 ) {
-
- $webhook = LLMS_Unit_Test_Util::call_method( $webhook, 'set_delivery_failure' );
-
- $this->assertEquals( $i, $webhook->get( 'failure_count' ) );
- $this->assertEquals( 6 === $i ? 'disabled' : 'active', $webhook->get( 'status' ) );
- $i++;
-
- }
-
- }
-
- /**
- * Test the status condition of the should_deliver() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_should_deliver_status() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => 'student.created',
- ) );
-
- // Inactive.
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $webhook, 'should_deliver', array( array( $this->factory->student->create() ) ) ) );
-
- // Active.
- $webhook->set( 'status', 'active' )->save();
- $this->assertTrue( LLMS_Unit_Test_Util::call_method( $webhook, 'should_deliver', array( array( $this->factory->student->create() ) ) ) );
-
- }
-
- /**
- * Test the status condition of the should_deliver() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_should_deliver_pending_delivery() {
-
- $webhook = LLMS_REST_API()->webhooks()->create( array(
- 'delivery_url' => 'https://mock.tld',
- 'topic' => 'student.created',
- 'status' => 'active',
- ) );
-
- // Not Pending.
- $this->assertTrue( LLMS_Unit_Test_Util::call_method( $webhook, 'should_deliver', array( array( $this->factory->student->create() ) ) ) );
-
- // Pending.
- $webhook->set( 'pending_delivery', 1 )->save();
- $this->assertFalse( LLMS_Unit_Test_Util::call_method( $webhook, 'should_deliver', array( array( $this->factory->student->create() ) ) ) );
-
-
- }
-
-}
diff --git a/tests/unit-tests/class-llms-rest-test-webhooks-query.php b/tests/unit-tests/class-llms-rest-test-webhooks-query.php
deleted file mode 100644
index 0fb7ffb4..00000000
--- a/tests/unit-tests/class-llms-rest-test-webhooks-query.php
+++ /dev/null
@@ -1,221 +0,0 @@
-query( "TRUNCATE TABLE {$wpdb->prefix}lifterlms_webhooks" );
-
- }
-
- /**
- * Test the get_webhooks() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_webhooks() {
-
- $query = new LLMS_REST_Webhooks_Query();
- $this->assertEquals( array(), $query->get_webhooks() );
-
- $this->create_many_webhooks( 3 );
-
- foreach ( array( true, false ) as $with_filters ) {
-
- $query = new LLMS_REST_Webhooks_Query( array( 'suppress_filters' => $with_filters ) );
- $keys = $query->get_webhooks();
- foreach ( $keys as $key ) {
- $this->assertTrue( is_a( $key, 'LLMS_REST_Webhook' ) );
- }
-
- }
-
-
- }
-
- /**
- * Test the include and exclude arguments.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_query_args_include_and_exclude() {
-
- $this->create_many_webhooks( 5 );
- $query = new LLMS_REST_Webhooks_Query( array() );
- $ids = range( 1, 5 );
-
- $this->create_many_webhooks( 5 );
-
- $query = new LLMS_REST_Webhooks_Query( array(
- 'include' => $ids,
- ) );
- $this->assertEquals( 5, $query->found_results );
- $this->assertEquals( $ids, wp_list_pluck( $query->get_results(), 'id' ) );
-
- $query = new LLMS_REST_Webhooks_Query( array(
- 'exclude' => $ids,
- ) );
- $this->assertEquals( 5, $query->found_results );
- $this->assertEquals( range( 6, 10 ), wp_list_pluck( $query->get_results(), 'id' ) );
-
- }
-
- /**
- * Test pagination of query results.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_query_args_pagination() {
-
- $this->create_many_webhooks( 25 );
-
- $query = new LLMS_REST_Webhooks_Query( array() );
- $this->assertEquals( 10, count( $query->get_results() ) );
- $this->assertEquals( 25, $query->found_results );
- $this->assertEquals( 3, $query->max_pages );
- $this->assertEquals( range( 1, 10 ), wp_list_pluck( $query->get_results(), 'id' ) );
- $this->assertTrue( $query->is_first_page() );
-
- $query = new LLMS_REST_Webhooks_Query( array( 'page' => 2 ) );
- $this->assertEquals( range( 11, 20 ), wp_list_pluck( $query->get_results(), 'id' ) );
-
- $query = new LLMS_REST_Webhooks_Query( array( 'page' => 3 ) );
- $this->assertEquals( range( 21, 25 ), wp_list_pluck( $query->get_results(), 'id' ) );
- $this->assertTrue( $query->is_last_page() );
-
- }
-
- /**
- * Test the status filter arguments.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_query_args_status() {
-
- $this->create_many_webhooks( 5, 'active' );
- $this->create_many_webhooks( 5, 'disabled' );
- $this->create_many_webhooks( 5, 'paused' );
-
- $query = new LLMS_REST_Webhooks_Query( array() );
- $this->assertEquals( 15, $query->found_results );
-
- foreach ( array_keys( LLMS_REST_API()->webhooks()->get_statuses() ) as $status ) {
-
- $query = new LLMS_REST_Webhooks_Query( array( 'status' => $status ) );
- $this->assertEquals( 5, $query->found_results );
-
- }
-
- }
-
- /**
- * Test setting up default query args.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_query_args_setup_with_defaults() {
-
- $query = new LLMS_REST_Webhooks_Query();
-
- $args = array(
- 'include' => array(),
- 'exclude' => array(),
- 'page' => 1,
- 'per_page' => 10,
- 'sort' => array(
- 'id' => 'ASC'
- ),
- );
-
- foreach ( $args as $arg => $expect ) {
- $this->assertEquals( $expect, $query->get( $arg ), $arg );
- }
-
- }
-
- /**
- * Tests setting up all possible arguments with custom arguments.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_query_args_setup_with_custom() {
-
- $args = array(
- 'include' => array( 1, 2, 3 ),
- 'exclude' => array( 4, 5, 6 ),
- 'page' => 5,
- 'per_page' => 500,
- 'sort' => array(
- 'name' => 'ASC',
- 'id' => 'DESC',
- ),
- );
-
- $query = new LLMS_REST_Webhooks_Query( $args );
-
- foreach ( $args as $arg => $expect ) {
- $this->assertEquals( $expect, $query->get( $arg ), $arg );
- }
-
- }
-
- /**
- * Merge default with custom arguments on setup.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_query_args_setup_with_merge() {
-
- $args = array(
- 'include' => array( 1, 2, 3 ),
- 'exclude' => array( 4, 5, 6 ),
- 'sort' => array(
- 'name' => 'ASC',
- 'id' => 'DESC',
- ),
- );
-
- $query = new LLMS_REST_Webhooks_Query( $args );
-
- $args['page'] = 1;
- $args['per_page'] = 10;
-
- foreach ( $args as $arg => $expect ) {
- $this->assertEquals( $expect, $query->get( $arg ), $arg );
- }
-
- }
-
-}
diff --git a/tests/unit-tests/class-llms-rest-test-webhooks.php b/tests/unit-tests/class-llms-rest-test-webhooks.php
deleted file mode 100644
index 32174d2b..00000000
--- a/tests/unit-tests/class-llms-rest-test-webhooks.php
+++ /dev/null
@@ -1,524 +0,0 @@
-webhooks = LLMS_REST_API()->webhooks();
-
- }
-
- /**
- * Can't create a webhook with an ID.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_create_with_id() {
-
- $ret = $this->webhooks->create( array( 'id' => 1 ) );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_exists', $ret );
-
- }
-
- /**
- * Can't create a webhook with a bad url.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_create_bad_url() {
-
- remove_filter( 'llms_rest_webhook_pre_ping', '__return_true' );
-
- $ret = $this->webhooks->create( array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- ) );
-
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_ping_unreachable', $ret );
-
- add_filter( 'llms_rest_webhook_pre_ping', '__return_true' );
-
- }
-
- /**
- * Creation attempts missing required columns should fail.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_create_required_cols() {
-
- $to_test = array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- );
- $data = array();
-
- foreach ( $to_test as $key => $val ) {
-
- $ret = $this->webhooks->create( $data );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_missing_' . $key, $ret );
- $data[ $key ] = $val;
-
- }
-
- }
-
- /**
- * Fill required data with default data during creation.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_create_with_defaults() {
-
- $data = array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- );
-
- $user_id = $this->factory->user->create();
- wp_set_current_user( $user_id );
-
- $ret = $this->webhooks->create( $data );
-
- $this->assertEquals( 'disabled', $ret->get( 'status' ) );
- $this->assertEquals( 0, $ret->get( 'failure_count' ) );
- $this->assertEquals( 0, $ret->get( 'pending_delivery' ) );
- $this->assertEquals( $user_id, $ret->get( 'user_id' ) );
-
- $this->assertEquals( 50, strlen( $ret->get( 'secret' ) ) );
-
- $this->assertEquals( 0, strpos( $ret->get( 'name' ), 'Webhook created on ' ) );
-
- }
-
- /**
- * Create with entirely custom values.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_create_all_vals() {
-
- $data = array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- 'name' => 'Mock Webhook Name',
- 'status' => 'active',
- 'secret' => 'DontTellAnyonePlease',
- );
-
- $ret = $this->webhooks->create( $data );
-
- foreach ( $data as $key => $val ) {
- $this->assertEquals( $val, $ret->get( $key ) );
- }
-
- }
-
- /**
- * Ensure created/updated dates are automatically added during creation.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_create_dates() {
-
- $time = current_time( 'timestamp' );
- llms_tests_mock_current_time( $time );
-
- $hook = $this->webhooks->create( array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- ) );
-
- $this->assertEquals( $time, strtotime( $hook->get( 'created' ) ) );
- $this->assertEquals( $time, strtotime( $hook->get( 'updated' ) ) );
-
- llms_tests_reset_current_time( $time );
-
- }
-
- /**
- * Test deleting a webhook.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_delete() {
-
- $hook = $this->webhooks->create( array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- ) );
-
- // Can't delete a non-existant webhook.
- $this->assertFalse( $this->webhooks->delete( $hook->get( 'id' ) + 1 ) );
-
- // Deleted.
- $this->assertTrue( $this->webhooks->delete( $hook->get( 'id' ) ) );
-
- // Can't be found.
- $this->assertFalse( $this->webhooks->get( $hook->get( 'id' ) ) );
-
- // Can't be deleted again.
- $this->assertFalse( $this->webhooks->delete( $hook->get( 'id' ) ) );
-
- }
-
- /**
- * Test hook getter.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get() {
-
- $hook = $this->webhooks->create( array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- ) );
-
- // Get the hook.
- $get = $this->webhooks->get( $hook->get( 'id' ) );
- $this->assertEquals( $hook->get( 'id' ), $get->get( 'id' ) );
-
- // Non-existant hook.
- $this->assertFalse( $this->webhooks->get( $hook->get( 'id' ) + 1 ) );
-
- }
-
- /**
- * Can't create with invalid status
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_is_data_valid_status() {
-
- $data = array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- );
-
- $tests = array( 'mock', '', false, true );
- foreach ( $tests as $val ) {
-
- $data['status'] = $val;
- $ret = LLMS_Unit_Test_Util::call_method( $this->webhooks, 'is_data_valid', array( $data ) );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_invalid_status', $ret );
-
- }
-
- }
-
- /**
- * Can't create with invalid topic
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_is_data_valid_topic() {
-
- $data = array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- 'status' => 'disabled',
- );
-
- $tests = array( 'mock', '', false, true, 'course.fake' );
- foreach ( $tests as $val ) {
-
- $data['topic'] = $val;
- $ret = LLMS_Unit_Test_Util::call_method( $this->webhooks, 'is_data_valid', array( $data ) );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_invalid_topic', $ret );
-
- }
-
- }
-
- /**
- * Can't create/update with an empty description.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_is_data_valid_description() {
-
- $data = array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- 'status' => 'disabled',
- );
-
- $tests = array( false, 0, '' );
- foreach ( $tests as $val ) {
-
- $data['name'] = $val;
- $ret = LLMS_Unit_Test_Util::call_method( $this->webhooks, 'is_data_valid', array( $data ) );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_invalid_name', $ret );
-
- }
-
- }
-
- /**
- * Validate delivery url (can't be empty)
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_is_data_valid_delivery_url() {
-
- $data = array(
- 'topic' => 'course.created',
- 'status' => 'disabled',
- );
-
- $tests = array( false, 0, '' );
- foreach ( $tests as $val ) {
-
- $data['delivery_url'] = $val;
- $ret = LLMS_Unit_Test_Util::call_method( $this->webhooks, 'is_data_valid', array( $data ) );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_invalid_delivery_url', $ret );
-
- }
-
- }
-
- /**
- * Test default column values getter
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_default_column_values() {
-
- $vals = $this->webhooks->get_default_column_values();
-
- $this->assertEquals( 50, strlen( $vals['secret'] ) );
- $this->assertEquals( 'disabled', $vals['status'] );
- $this->assertEquals( 0, $vals['failure_count'] );
- $this->assertEquals( 0, $vals['pending_delivery'] );
-
- }
-
- /**
- * Test the is_topic_valid() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_is_topic_valid() {
-
- $tests = array_fill_keys( array_keys( $this->webhooks->get_topics() ), true );
-
- $tests['action.mock'] = true;
- $tests['course.fake'] = false;
- $tests['courses.created'] = false;
- $tests['action'] = false;
- $tests['action.'] = false;
-
- foreach ( $tests as $topic => $expected ) {
-
- $this->assertEquals( $expected, LLMS_Unit_Test_Util::call_method( $this->webhooks, 'is_topic_valid', array( $topic ) ), $topic );
-
- }
-
- }
-
- /**
- * Can't update without supplying an ID
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_update_no_id() {
-
- $hook = $this->webhooks->create( array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- ) );
-
- $ret = $this->webhooks->update( array() );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_missing_id', $ret );
-
- }
-
- /**
- * Can't update something that doesn't exist
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_update_non_existant() {
-
- $hook = $this->webhooks->create( array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- ) );
-
- $ret = $this->webhooks->update( array( 'id' => $hook->get( 'id' ) + 1 ) );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_invalid_webhook', $ret );
-
- }
-
- /**
- * Can't supply an empty url during an update
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_update_blank_url() {
-
- $hook = $this->webhooks->create( array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- ) );
-
- $ret = $this->webhooks->update( array(
- 'id' => $hook->get( 'id' ),
- 'delivery_url' => '',
- ) );
-
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_invalid_delivery_url', $ret );
-
- }
-
- /**
- * test updating
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_update() {
-
- $hook = $this->webhooks->create( array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- ) );
-
- $args = array(
- 'id' => $hook->get( 'id' ),
- 'topic' => 'action.mock',
- 'delivery_url' => 'http://mock.com',
- 'pending_delivery' => 1,
- 'failure_count' => 5,
- 'name' => 'Changed it',
- 'secret' => 'new secret',
- );
-
- $ret = $this->webhooks->update( $args );
-
- foreach ( $args as $key => $expected ) {
-
- $this->assertEquals( $expected, $ret->get( $key ) );
-
- }
-
- }
-
- /**
- * Test updating delivery_url to a bad url.
- *
- * @since 1.0.0-beta.1
- *
- * @see {Reference}
- * @link {URL}
- *
- * @return [type]
- */
- public function test_update_bad_url() {
-
- $hook = $this->webhooks->create( array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- ) );
-
- remove_filter( 'llms_rest_webhook_pre_ping', '__return_true' );
-
- $ret = $this->webhooks->update( array(
- 'id' => $hook->get( 'id' ),
- 'delivery_url' => 'https://mock.tld'
- ) );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_webhook_ping_unreachable', $ret );
-
- add_filter( 'llms_rest_webhook_pre_ping', '__return_true' );
-
- }
-
- /**
- * Test that the updated date is automatically updated during an update.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_updated_date() {
-
- llms_tests_mock_current_time( strtotime( '-10 minutes' ) );
- $hook = $this->webhooks->create( array(
- 'topic' => 'course.created',
- 'delivery_url' => 'https://mock.com',
- ) );
- llms_tests_reset_current_time();
-
- $ret = $this->webhooks->update( array(
- 'id' => $hook->get( 'id' ),
- 'topic' => 'action.mock',
- ) );
-
- $this->assertTrue( $ret->get( 'updated' ) > $ret->get( 'created' ) );
-
- }
-
-}
diff --git a/tests/unit-tests/server/class-llms-rest-test-abstract-users-controller.php b/tests/unit-tests/server/class-llms-rest-test-abstract-users-controller.php
deleted file mode 100644
index f21bb2b5..00000000
--- a/tests/unit-tests/server/class-llms-rest-test-abstract-users-controller.php
+++ /dev/null
@@ -1,102 +0,0 @@
-stub = new class extends LLMS_REST_Users_Controller {
-
- // stub required abstract method.
- protected function get_object( $id ) { return $id; }
-
- };
-
- $this->request = new WP_REST_Request( 'POST', 'mock' );
-
- }
-
- /**
- * Filter for testing banned usernames added via the `illegal_user_logins` filter.
- *
- * @since 1.0.0-beta.1
- *
- * @param string[] $illegal List of illegal usernames.
- * @return string[]
- */
- public function get_illegal_user_logins( $illegal ) {
- $illegal[] = 'illegal';
- return $illegal;
- }
-
-
- /**
- * Test the sanitize_password method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_sanitize_password() {
-
- // Good.
- $this->assertEquals( 'password', $this->stub->sanitize_username( 'password', $this->request, 'username' ) );
-
- // Illegal chars.
- $ret = $this->stub->sanitize_username( 'mock\\password', $this->request, 'username' );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_bad_request', $ret );
-
- }
-
-
- /**
- * Test the sanitize_username method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_sanitize_username() {
-
- // Good.
- $this->assertEquals( 'okay', $this->stub->sanitize_username( 'okay', $this->request, 'username' ) );
-
- // Illegal chars.
- $ret = $this->stub->sanitize_username( '¯\_(ツ)_/¯', $this->request, 'username' );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_bad_request', $ret );
-
- // Banned username.
- add_filter( 'illegal_user_logins', array( $this, 'get_illegal_user_logins' ) );
-
- $ret = $this->stub->sanitize_username( 'illegal', $this->request, 'username' );
- $this->assertIsWPError( $ret );
- $this->assertWPErrorCodeEquals( 'llms_rest_bad_request', $ret );
-
- $this->assertEquals( 'something-else', $this->stub->sanitize_username( 'something-else', $this->request, 'username' ) );
-
- remove_filter( 'illegal_user_logins', array( $this, 'get_illegal_user_logins' ) );
-
- }
-
-}
diff --git a/tests/unit-tests/server/class-llms-rest-test-api-keys-controller.php b/tests/unit-tests/server/class-llms-rest-test-api-keys-controller.php
deleted file mode 100644
index db437cf2..00000000
--- a/tests/unit-tests/server/class-llms-rest-test-api-keys-controller.php
+++ /dev/null
@@ -1,475 +0,0 @@
-user_allowed = $this->factory->user->create( array( 'role' => 'administrator', ) );
- $this->user_forbidden = $this->factory->user->create( array( 'role' => 'subscriber', ) );
- $this->endpoint = new LLMS_REST_API_Keys_Controller();
-
- }
-
- /**
- * Teardown test
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function tearDown() {
-
- parent::tearDown();
-
- global $wpdb;
- $wpdb->query( "TRUNCATE TABLE {$wpdb->prefix}lifterlms_api_keys" );
-
- }
-
- /**
- * Test route registration.
- *
- * @since 1.0.0-beta.1
- */
- public function test_register_routes() {
-
- $routes = $this->server->get_routes();
- $this->assertArrayHasKey( $this->route, $routes );
- $this->assertArrayHasKey( $this->route . '/(?P[\d]+)', $routes );
-
- }
-
- public function test_get_item_schema() {
-
- $schema = $this->endpoint->get_item_schema();
- $this->assertTrue( array_key_exists( '$schema', $schema ) );
- $this->assertTrue( array_key_exists( 'title', $schema ) );
- $this->assertTrue( array_key_exists( 'type', $schema ) );
- $this->assertTrue( array_key_exists( 'properties', $schema ) );
- $this->assertTrue( array_key_exists( 'description', $schema['properties'] ) );
- $this->assertTrue( array_key_exists( 'permissions', $schema['properties'] ) );
- $this->assertTrue( array_key_exists( 'user_id', $schema['properties'] ) );
- $this->assertTrue( array_key_exists( 'truncated_key', $schema['properties'] ) );
- $this->assertTrue( array_key_exists( 'last_access', $schema['properties'] ) );
-
- }
-
- /**
- * Test error responses for creating a key
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_create_item_errors() {
-
- // Empty body.
- $response = $this->perform_mock_request( 'POST', $this->route );
- $this->assertResponseStatusEquals( 400, $response );
- $this->assertResponseCodeEquals( 'rest_missing_callback_param', $response );
-
- // Unauthorized.
- $args = array(
- 'description' => 'Mock Description',
- 'user_id' => $this->factory->user->create(),
- 'permissions' => 'read',
- );
- $response = $this->perform_mock_request( 'POST', $this->route, $args );
- $this->assertResponseStatusEquals( 401, $response );
- $this->assertResponseCodeEquals( 'llms_rest_unauthorized_request', $response );
-
- // Forbidden.
- wp_set_current_user( $this->user_forbidden );
- $response = $this->perform_mock_request( 'POST', $this->route, $args );
- $this->assertResponseStatusEquals( 403, $response );
- $this->assertResponseCodeEquals( 'llms_rest_forbidden_request', $response );
-
- // Invalid submitted user_id
- wp_set_current_user( $this->user_allowed );
- $args['user_id'] = 9032423402934;
- $response = $this->perform_mock_request( 'POST', $this->route, $args );
- $this->assertResponseStatusEquals( 400, $response );
- $this->assertResponseCodeEquals( 'rest_invalid_param', $response );
-
- }
-
- /**
- * Test creation of a new key success.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_create_item_success() {
-
- wp_set_current_user( $this->user_allowed );
- $args = array(
- 'description' => 'Mock Description',
- 'user_id' => $this->factory->user->create(),
- 'permissions' => 'read',
- );
- $response = $this->perform_mock_request( 'POST', $this->route, $args );
-
- $this->assertResponseStatusEquals( 201, $response );
-
- $res_data = $response->get_data();
-
- $this->assertEquals( $args['description'], $res_data['description'] );
- $this->assertEquals( $args['user_id'], $res_data['user_id'] );
- $this->assertEquals( $args['permissions'], $res_data['permissions'] );
- $this->assertTrue( array_key_exists( 'id', $res_data ) );
- $this->assertTrue( array_key_exists( 'consumer_key', $res_data ) );
- $this->assertTrue( array_key_exists( 'consumer_secret', $res_data ) );
- $this->assertTrue( array_key_exists( 'last_access', $res_data ) );
- $this->assertEquals( $res_data['truncated_key'], substr( $res_data['consumer_key'], -7 ) );
-
- $headers = $response->get_headers();
- $this->assertTrue( array_key_exists( 'Location', $headers ) );
-
- $links = $response->get_links();
- $this->assertTrue( array_key_exists( 'self', $links ) );
- $this->assertTrue( array_key_exists( 'collection', $links ) );
- $this->assertTrue( array_key_exists( 'user', $links ) );
-
- }
-
- /**
- * Test the permissions check methods.
- *
- * @return void
- */
- public function test_check_permissions() {
-
- $request = new WP_REST_Request( 'GET', $this->route );
-
- $methods = array(
- 'create_item_permissions_check',
- 'delete_item_permissions_check',
- 'get_item_permissions_check',
- 'get_items_permissions_check',
- 'update_item_permissions_check',
- );
-
- // No user.
- wp_set_current_user( null );
- foreach ( $methods as $method ) {
- $res = $this->endpoint->{$method}( $request );
- $this->assertIsWPError( $res );
- $this->assertWPErrorCodeEquals( 'llms_rest_unauthorized_request', $res );
- }
-
-
- // Disallowed User.
- wp_set_current_user( $this->user_forbidden );
- foreach ( $methods as $method ) {
- $res = $this->endpoint->{$method}( $request );
- $this->assertIsWPError( $res );
- $this->assertWPErrorCodeEquals( 'llms_rest_forbidden_request', $res );
- }
-
- // Allowed User.
- wp_set_current_user( $this->user_allowed );
- foreach ( $methods as $method ) {
- $this->assertTrue( $this->endpoint->{$method}( $request ) );
- }
-
- }
-
- /**
- * test the delete_item() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_delete_item() {
-
- wp_set_current_user( $this->user_allowed );
-
- $key = $this->get_mock_api_key( 'read_write', $this->user_allowed, false );
- $id = $key->get( 'id' );
-
- // Successful deletion.
- $response = $this->perform_mock_request( 'DELETE', sprintf( '%1$s/%2$d', $this->route, $id ) );
- $this->assertResponseStatusEquals( 204, $response );
- $this->assertFalse( LLMS_REST_API()->keys()->get( $id ) );
-
- // Responds 204 even if resource can't be found.
- $response = $this->perform_mock_request( 'DELETE', sprintf( '%1$s/%2$d', $this->route, $id ) );
- $this->assertResponseStatusEquals( 204, $response );
-
- }
-
- /**
- * test the get_item() for an invalid resource.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_item_not_found() {
-
- wp_set_current_user( $this->user_allowed );
-
- $key = $this->get_mock_api_key( 'read_write', $this->user_allowed, false );
- $id = $key->get( 'id' ) + 1;
-
- $response = $this->perform_mock_request( 'GET', sprintf( '%1$s/%2$d', $this->route, $id ) );
- $this->assertResponseStatusEquals( 404, $response );
- $this->assertResponseCodeEquals( 'llms_rest_not_found', $response );
-
- }
-
- /**
- * test the get_item() for an invalid resource.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_item_success() {
-
- wp_set_current_user( $this->user_allowed );
-
- $key = $this->get_mock_api_key( 'read_write', $this->user_allowed, false );
- $id = $key->get( 'id' );
-
- $response = $this->perform_mock_request( 'GET', sprintf( '%1$s/%2$d', $this->route, $id ) );
- $this->assertResponseStatusEquals( 200, $response );
-
- $res_data = $response->get_data();
-
- $this->assertEquals( $id, $res_data['id'] );
- $this->assertEquals( $key->get( 'description' ), $res_data['description'] );
- $this->assertEquals( $key->get( 'permissions' ), $res_data['permissions'] );
- $this->assertEquals( $key->get( 'user_id' ), $res_data['user_id'] );
- $this->assertEquals( $key->get( 'user_id' ), $res_data['user_id'] );
- $this->assertEquals( $key->get( 'truncated_key' ), $res_data['truncated_key'] );
- $this->assertTrue( array_key_exists( 'last_access', $res_data ) );
-
- $links = $response->get_links();
- $this->assertTrue( array_key_exists( 'self', $links ) );
- $this->assertTrue( array_key_exists( 'collection', $links ) );
- $this->assertTrue( array_key_exists( 'user', $links ) );
-
- }
-
- /**
- * test the get_items() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_get_items_pagination() {
-
- wp_set_current_user( $this->user_allowed );
-
- // No results.
- $response = $this->perform_mock_request( 'GET', $this->route );
- $this->assertResponseStatusEquals( 200, $response );
-
- // Make keys for remaining tests.
- $keys = $this->create_many_api_keys( 25 );
-
- // Page 1.
- $response = $this->perform_mock_request( 'GET', $this->route );
-
- $body = $response->get_data();
- $headers = $response->get_headers();
-
- $links = $this->parse_link_headers( $response );
-
- $this->assertResponseStatusEquals( 200, $response );
- $this->assertEquals( 25, $headers['X-WP-Total'] );
- $this->assertEquals( 3, $headers['X-WP-TotalPages'] );
- $this->assertEquals( array( 'first', 'next', 'last' ), array_keys( $links ) );
-
- $this->assertEquals( range( 1, 10 ), wp_list_pluck( $body, 'id' ) );
-
- // Page 2.
- $response = $this->perform_mock_request( 'GET', $this->route, array(), array( 'page' => 2 ) );
-
- $body = $response->get_data();
- $headers = $response->get_headers();
-
- $links = $this->parse_link_headers( $response );
-
- $this->assertResponseStatusEquals( 200, $response );
- $this->assertEquals( 25, $headers['X-WP-Total'] );
- $this->assertEquals( 3, $headers['X-WP-TotalPages'] );
- $this->assertEquals( array( 'first', 'prev', 'next', 'last' ), array_keys( $links ) );
-
- $this->assertEquals( range( 11, 20 ), wp_list_pluck( $body, 'id' ) );
-
- // Page 3.
- $response = $this->perform_mock_request( 'GET', $this->route, array(), array( 'page' => 3 ) );
-
- $body = $response->get_data();
- $headers = $response->get_headers();
-
- $links = $this->parse_link_headers( $response );
-
- $this->assertResponseStatusEquals( 200, $response );
- $this->assertEquals( 25, $headers['X-WP-Total'] );
- $this->assertEquals( 3, $headers['X-WP-TotalPages'] );
- $this->assertEquals( array( 'first', 'prev', 'last' ), array_keys( $links ) );
-
- $this->assertEquals( range( 21, 25 ), wp_list_pluck( $body, 'id' ) );
-
- // Out of bounds.
- $response = $this->perform_mock_request( 'GET', $this->route, array(), array( 'page' => 4 ) );
-
- $this->assertResponseStatusEquals( 400, $response );
- $this->assertResponseCodeEquals( 'llms_rest_bad_request', $response );
-
- }
-
- /**
- * test the update_item() method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_update_item() {
-
- wp_set_current_user( $this->user_allowed );
-
- $key = $this->get_mock_api_key( 'read_write', $this->user_allowed, false );
- $id = $key->get( 'id' );
-
- $updates = array(
- 'description' => 'New Description',
- 'user_id' => $this->factory->user->create(),
- 'permissions' => 'read',
- );
-
- $response = $this->perform_mock_request( 'POST', sprintf( '%1$s/%2$d', $this->route, $id ), $updates );
- $this->assertResponseStatusEquals( 200, $response );
-
- $res_data = $response->get_data();
-
- $this->assertEquals( $id, $res_data['id'] );
- $this->assertEquals( $updates['description'], $res_data['description'] );
- $this->assertEquals( $updates['permissions'], $res_data['permissions'] );
- $this->assertEquals( $updates['user_id'], $res_data['user_id'] );
- $this->assertEquals( $key->get( 'truncated_key' ), $res_data['truncated_key'] );
-
- $links = $response->get_links();
- $this->assertTrue( array_key_exists( 'self', $links ) );
- $this->assertTrue( array_key_exists( 'collection', $links ) );
- $this->assertTrue( array_key_exists( 'user', $links ) );
-
- }
-
- /**
- * Test the prepare collection query args method.
- *
- * @since 1.0.0-beta.1
- *
- * @return [type]
- */
- public function test_prepare_collection_query_args() {
-
- $route = $this->route;
-
- // Defaults (no args passed).
- $request = new WP_REST_Request( 'GET', $route );
- $args = LLMS_Unit_Test_Util::call_method( $this->endpoint, 'prepare_collection_query_args', array( $request ) );
- $this->assertEquals( array(), $args );
-
- // Pass order and use default orderby.
- $request = new WP_REST_Request( 'GET', $route );
- $request->set_query_params( array( 'order' => 'desc' ) );
- $args = LLMS_Unit_Test_Util::call_method( $this->endpoint, 'prepare_collection_query_args', array( $request ) );
- $this->assertEquals( array(
- 'sort' => array(
- 'id' => 'desc',
- ),
- ), $args );
-
- // Pass orderby and use default order.
- $request = new WP_REST_Request( 'GET', $route );
- $request->set_query_params( array( 'orderby' => 'last_access' ) );
- $args = LLMS_Unit_Test_Util::call_method( $this->endpoint, 'prepare_collection_query_args', array( $request ) );
- $this->assertEquals( array(
- 'sort' => array(
- 'last_access' => 'asc',
- ),
- ), $args );
-
- // Pass orderby and order.
- $request = new WP_REST_Request( 'GET', $route );
- $request->set_query_params( array(
- 'orderby' => 'last_access',
- 'order' => 'desc'
- ) );
- $args = LLMS_Unit_Test_Util::call_method( $this->endpoint, 'prepare_collection_query_args', array( $request ) );
- $this->assertEquals( array(
- 'sort' => array(
- 'last_access' => 'desc',
- ),
- ), $args );
-
- // Set other args.
- // Pass orderby and order.
- $request = new WP_REST_Request( 'GET', $route );
- $request->set_query_params( array(
- 'include' => '1,2,3,4,5',
- 'exclude' => '83',
- 'user' => '1',
- 'user_not_in' => '25,26',
- 'permissions' => 'read',
- ) );
- $args = LLMS_Unit_Test_Util::call_method( $this->endpoint, 'prepare_collection_query_args', array( $request ) );
- $this->assertEquals( array(
- 'include' => range( 1, 5 ),
- 'exclude' => array( 83 ),
- 'user' => array( 1 ),
- 'user_not_in' => array( 25, 26 ),
- 'permissions' => 'read',
- ), $args );
-
- }
-
- /**
- * Test the validate_user_exists callback method.
- *
- * @since 1.0.0-beta.1
- *
- * @return void
- */
- public function test_validate_user_exists() {
-
- $this->assertTrue( $this->endpoint->validate_user_exists( $this->user_allowed ) );
- $this->assertFalse( $this->endpoint->validate_user_exists( $this->factory->user->create() + 1 ) );
-
- }
-
-}
diff --git a/tests/unit-tests/server/class-llms-rest-test-courses.php b/tests/unit-tests/server/class-llms-rest-test-courses.php
deleted file mode 100644
index 2cdc0e13..00000000
--- a/tests/unit-tests/server/class-llms-rest-test-courses.php
+++ /dev/null
@@ -1,1341 +0,0 @@
-endpoint = new LLMS_REST_Courses_Controller();
- $this->user_allowed = $this->factory->user->create(
- array(
- 'role' => 'administrator',
- )
- );
-
- $this->user_forbidden = $this->factory->user->create(
- array(
- 'role' => 'subscriber',
- )
- );
-
- $this->sample_course_args = array(
- 'title' => array(
- 'rendered' => 'Getting Started with LifterLMS',
- 'raw' => 'Getting Started with LifterLMS',
- ),
- 'content' => array(
- 'rendered' => "\\n
Lorem ipsum dolor sit amet.
\\n\\n\\n\\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
\\n",
- 'raw' => "\\n
Lorem ipsum dolor sit amet.
\\n\\n\\n\\n
Expectoque quid ad id, quod quaerebam, respondeas. Nec enim, omnes avaritias si aeque avaritias esse dixerimus, sequetur ut etiam aequas esse dicamus.
\\n",
- ),
- 'date_created' => '2019-05-20 17:22:05',
- 'status' => 'publish',
- );
-
- global $wpdb;
- $wpdb->delete( $wpdb->prefix . 'posts', array( 'post_type' => $this->post_type ) );
-
- // assume all courses have been migrated to the block editor to avoid adding parts to the content.
- add_filter( 'llms_blocks_is_post_migrated', '__return_true' );
- }
-
- /**
- * Test route registration.
- *
- * @since 1.0.0-beta.1
- */
- public function test_register_routes() {
-
- $routes = $this->server->get_routes();
- $this->assertArrayHasKey( $this->route, $routes );
- $this->assertArrayHasKey( $this->route . '/(?P[\d]+)', $routes );
-
- // Enrollments.
- $this->assertArrayHasKey( $this->route . '/(?P[\d]+)/enrollments', $routes );
- // Child sections.
- $this->assertArrayHasKey( $this->route . '/(?P[\d]+)/content', $routes );
- }
-
-
- /**
- * Test list courses.
- *
- * @since 1.0.0-beta.1
- */
- public function test_get_courses() {
-
- wp_set_current_user( $this->user_allowed );
-
- // create 12 courses.
- $courses = $this->factory->course->create_many( 12, array( 'sections' => 0 ) );
-
- $response = $this->server->dispatch( new WP_REST_Request( 'GET', $this->route ) );
-
- // Success.
- $this->assertEquals( 200, $response->get_status() );
-
- $res_data = $response->get_data();
- $this->assertEquals( 10, count( $res_data ) ); // default per_page is 10.
-
- // Check retrieved courses are the same as the generated ones.
- // Note: the check can be done in this simple way as by default the rest api courses are ordered by id.
- for ( $i = 0; $i < 10; $i++ ) {
- $this->llms_posts_fields_match( new LLMS_Course( $courses[ $i ] ), $res_data[ $i ] );
- }
-
- $headers = $response->get_headers();
- $this->assertEquals( 12, $headers['X-WP-Total'] );
- $this->assertEquals( 2, $headers['X-WP-TotalPages'] );
-
- }
-
- /**
- * Test list courses pagination success.
- *
- * @since 1.0.0-beta.1
- */
- public function test_get_courses_with_pagination() {
-
- wp_set_current_user( $this->user_allowed );
-
- // create 15 courses.
- $courses = $this->factory->course->create_many( 15, array( 'sections' => 0 ) );
- $request = new WP_REST_Request( 'GET', $this->route );
- $request->set_param( 'page', 2 );
-
- $response = $this->server->dispatch( $request );
-
- $res_data = $response->get_data();
-
- // Success.
- $this->assertEquals( 200, $response->get_status() );
- $this->assertEquals( 5, count( $res_data ) );
-
- // Check retrieved courses are the same as the generated ones with an offset of 10 (first page).
- // Note: the check can be done in this simple way as by default the rest api courses are ordered by id.
- for ( $i = 0; $i < 5; $i++ ) {
- $this->llms_posts_fields_match( new LLMS_Course( $courses[ $i + 10 ] ), $res_data[ $i ] );
- }
-
- }
-
- /**
- * Test list courses include arg
- *
- * @since 1.0.0-beta.1
- */
- public function test_get_courses_include() {
-
- wp_set_current_user( $this->user_allowed );
-
- // create 15 courses.
- $courses = $this->factory->course->create_many( 5, array( 'sections' => 0 ) );
- $request = new WP_REST_Request( 'GET', $this->route );
-
- // get only the 2nd and 3rd course.
- $request->set_param( 'include', "$courses[1], $courses[2]" );
-
- $response = $this->server->dispatch( $request );
-
- $res_data = $response->get_data();
-
- // Success.
- $this->assertEquals( 200, $response->get_status() );
- $this->assertEquals( 2, count( $res_data ) );
-
- // Check retrieved courses are the same as the second and third generated courses.
- for ( $i = 0; $i < 2; $i++ ) {
- $this->llms_posts_fields_match( new LLMS_Course( $courses[ $i + 1 ] ), $res_data[ $i ] );
- }
-
- }
-
- /**
- * Test list courses exclude arg
- *
- * @since 1.0.0-beta.1
- */
- public function test_get_courses_exclude() {
-
- wp_set_current_user( $this->user_allowed );
-
- // create 15 courses.
- $courses = $this->factory->course->create_many( 5, array( 'sections' => 0 ) );
- $request = new WP_REST_Request( 'GET', $this->route );
-
- // get only the 2nd and 3rd course.
- $request->set_param( 'exclude', "$courses[0], $courses[1]" );
-
- $response = $this->server->dispatch( $request );
-
- $res_data = $response->get_data();
-
- // Success.
- $this->assertEquals( 200, $response->get_status() );
- $this->assertEquals( 3, count( $res_data ) );
- // Check retrieved data do not contain first and second created courses.
- $this->assertEquals( array_slice( $courses, 2 ), wp_list_pluck( $res_data, 'id' ) );
- }
-
- /**
- * Test list courses ordered by id desc.
- *
- * @since 1.0.0-beta.1
- */
- public function test_get_courses_ordered_by_id_desc() {
-
- wp_set_current_user( $this->user_allowed );
-
- // create 5 courses.
- $courses = $this->factory->course->create_many( 5, array( 'sections' => 0 ) );
- $request = new WP_REST_Request( 'GET', $this->route );
- $request->set_param( 'order', 'desc' ); // default is 'asc'.
-
- $response = $this->server->dispatch( $request );
-
- $res_data = $response->get_data();
-
- // Success.
- $this->assertEquals( 200, $response->get_status() );
-
- // Check retrieved courses are the same as the generated ones but in the reversed order.
- // Note: the check can be done in this simple way as by default the rest api courses are ordered by id.
- $reversed_data = array_reverse( $res_data );
- for ( $i = 0; $i < 5; $i++ ) {
- $this->llms_posts_fields_match( new LLMS_Course( $courses[ $i ] ), $reversed_data[ $i ] );
- }
-
- }
-
- /**
- * Test list courses ordered by title.
- *
- * @since 1.0.0-beta.1
- */
- public function test_get_courses_ordered_by_title() {
-
- wp_set_current_user( $this->user_allowed );
-
- // create 3 courses.
- $courses = $this->factory->course->create_many( 3, array( 'sections' => 0 ) );
-
- $course_first = new LLMS_Course( $courses[0] );
- $course_first->set( 'title', 'Course B' );
- $course_second = new LLMS_Course( $courses[1] );
- $course_second->set( 'title', 'Course A' );
- $course_second = new LLMS_Course( $courses[2] );
- $course_second->set( 'title', 'Course C' );
-
- $request = new WP_REST_Request( 'GET', $this->route );
- $request->set_param( 'orderby', 'title' ); // default is id.
-
- $response = $this->server->dispatch( $request );
-
- $res_data = $response->get_data();
-
- // Check retrieved courses are ordered by title asc.
- $this->assertEquals( 'Course A', $res_data[0]['title']['rendered'] );
- $this->assertEquals( 'Course B', $res_data[1]['title']['rendered'] );
- $this->assertEquals( 'Course C', $res_data[2]['title']['rendered'] );
- }
-
- /**
- * Test list courses ordered by title
- *
- * @since 1.0.0-beta.1
- */
- public function test_get_courses_ordered_by_title_desc() {
-
- wp_set_current_user( $this->user_allowed );
-
- // create 3 courses.
- $courses = $this->factory->course->create_many( 3, array( 'sections' => 0 ) );
-
- $course_first = new LLMS_Course( $courses[0] );
- $course_first->set( 'title', 'Course B' );
- $course_second = new LLMS_Course( $courses[1] );
- $course_second->set( 'title', 'Course A' );
- $course_second = new LLMS_Course( $courses[2] );
- $course_second->set( 'title', 'Course C' );
-
- $request = new WP_REST_Request( 'GET', $this->route );
- $request->set_param( 'orderby', 'title' ); // default is id.
- $request->set_param( 'order', 'desc' ); // default is 'asc'.
-
- $response = $this->server->dispatch( $request );
- $res_data = $response->get_data();
-
- // Check retrieved courses are ordered by title desc.
- $this->assertEquals( 'Course C', $res_data[0]['title']['rendered'] );
- $this->assertEquals( 'Course B', $res_data[1]['title']['rendered'] );
- $this->assertEquals( 'Course A', $res_data[2]['title']['rendered'] );
- }
-
- /**
- * Test getting courses without permission.
- *
- * @since 1.0.0-beta.1
- *//*
- public function test_get_courses_without_permission() {
-
- wp_set_current_user( 0 );
-
- // Setup course.
- $this->factory->course->create();
-
- $response = $this->server->dispatch( new WP_REST_Request( 'GET', $this->route ) );
-
- // Check we don't have permissions to make this request.
- $this->assertEquals( 401, $response->get_status() );
-
- }
- */
-
- /**
- * Test getting courses: forbidden request.
- *
- * @since 1.0.0-beta.1
- *//*
- public function test_get_courses_forbidden() {
-
- wp_set_current_user( $this->user_forbidden );
-
- // Setup course.
- $this->factory->course->create();
-
- $response = $this->server->dispatch( new WP_REST_Request( 'GET', $this->route ) );
-
- // Check we're not allowed to get results.
- $this->assertEquals( 403, $response->get_status() );
-
- }*/
-
- /**
- * Test getting courses: bad request.
- *
- * @since 1.0.0-beta.1
- */
- public function test_get_courses_bad_request() {
-
- wp_set_current_user( $this->user_allowed );
-
- // create 5 courses.
- $courses = $this->factory->course->create_many( 5, array( 'sections' => 0 ) );
- $request = new WP_REST_Request( 'GET', $this->route );
-
- // Bad request, there's no page 2.
- $request->set_param( 'page', 2 );
- $response = $this->server->dispatch( $request );
- $this->assertEquals( 400, $response->get_status() );
-
- // Bad request, order param allowed are only "desc" and "asc" (emum).
- $request->set_param( 'order', 'not_desc' );
- $response = $this->server->dispatch( $request );
- $this->assertEquals( 400, $response->get_status() );
-
- }
-
- /**
- * Test getting a single course.
- *
- * @since 1.0.0-beta.1
- */
- public function test_get_course() {
-
- wp_set_current_user( $this->user_allowed );
-
- // Setup course.
- $course = $this->factory->course->create_and_get();
- $response = $this->server->dispatch( new WP_REST_Request( 'GET', $this->route . '/' . $course->get( 'id' ) ) );
-
- // Success.
- $this->assertEquals( 200, $response->get_status() );
-
- // Check retrieved course matches the created ones.
- $this->llms_posts_fields_match( $course, $response->get_data() );
-
- }
-
-
- /**
- * Test getting single course without permission.
- *
- * @since 1.0.0-beta.1
- */
- /*
- public function test_get_course_without_permission() {
-
- wp_set_current_user( 0 );
-
- // Setup course.
- $course_id = $this->factory->course->create();
- $response = $this->server->dispatch( new WP_REST_Request( 'GET', $this->route . '/' . $course_id ) );
-
- // Check we don't have permissions to make this request.
- $this->assertEquals( 401, $response->get_status() );
-
- }
- */
-
- /**
- * Test getting forbidden single course.
- *
- * @since 1.0.0-beta.1
- */
- /*
- public function test_get_course_forbidden() {
-
- wp_set_current_user( $this->user_forbidden );
-
- // Setup course.
- $course_id = $this->factory->course->create();
- $response = $this->server->dispatch( new WP_REST_Request( 'GET', $this->route . '/' . $course_id ) );
-
- // Check we're not allowed to get results.
- $this->assertEquals( 403, $response->get_status() );
-
- }
- */
-
- /**
- * Test getting single course that doesn't exist.
- *
- * @since 1.0.0-beta.1
- */
- public function test_get_nonexistent_course() {
-
- wp_set_current_user( 0 );
-
- // Setup course.
- $course_id = $this->factory->course->create();
- $response = $this->server->dispatch( new WP_REST_Request( 'GET', $this->route . '/' . $course_id . '4' ) );
-
- // the course doesn't exists.
- $this->assertEquals( 404, $response->get_status() );
-
- }
-
- /**
- * Test creating a single course.
- *
- * @since 1.0.0-beta.1
- */
- public function test_create_course() {
-
- wp_set_current_user( $this->user_allowed );
-
- $request = new WP_REST_Request( 'POST', $this->route );
-
- $catalog_visibility = array_keys( llms_get_product_visibility_options() )[2];
- $sample_course_args = array_merge(
- $this->sample_course_args,
- array(
- 'catalog_visibility' => $catalog_visibility,
- 'instructors' => array(
- get_current_user_id(),
- $this->factory->user->create(
- array(
- 'role' => 'instructor',
- )
- ),
- ),
- 'video_tile' => true,
- )
- );
-
- $request->set_body_params( $sample_course_args );
- $response = $this->server->dispatch( $request );
-
- // Success.
- $this->assertEquals( 201, $response->get_status() );
-
- $res_data = $response->get_data();
-
- $this->assertEquals( $sample_course_args['title']['rendered'], $res_data['title']['rendered'] );
- /**
- * The rtrim below is not ideal but at the moment we have templates printed after the course summary (e.g. prerequisites) that,
- * even when printing no data they still print "\n". Let's pretend we're not interested in testing the trailing "\n" presence.
- */
- $this->assertEquals( rtrim( $sample_course_args['content']['rendered'], "\n" ), rtrim( $res_data['content']['rendered'], "\n" ) );
-
- $this->assertEquals( $sample_course_args['date_created'], $res_data['date_created'] );
- $this->assertEquals( $sample_course_args['status'], $res_data['status'] );
- $this->assertEquals( $sample_course_args['catalog_visibility'], $res_data['catalog_visibility'] );
- $this->assertEquals( $sample_course_args['instructors'], $res_data['instructors'] );
- $this->assertEquals( $sample_course_args['video_tile'], $res_data['video_tile'] );
-
- }
-
- /**
- * Test creating a single course defaults are correctly set.
- *
- * @since 1.0.0-beta.1
- */
- public function test_create_course_check_defaults() {
- wp_set_current_user( $this->user_allowed );
-
- $request = new WP_REST_Request( 'POST', $this->route );
-
- $course_args = array(
- 'title' => 'Title',
- 'content' => 'Content',
- 'access_opens_date' => '2019-05-22 17:20:05',
- 'access_closes_date' => '2019-05-22 17:23:08',
- 'enrollment_opens_date' => '2019-05-22 17:22:05',
- 'enrollment_closes_date' => '2019-05-22 17:22:08',
- );
-
- $request->set_body_params( $course_args );
- $response = $this->server->dispatch( $request );
-
- $res_data = $response->get_data();
-
- // Check defaults.
- // Access period messages.
- $this->assertEquals( 'This course opens on [lifterlms_course_info id=' . $res_data['id'] . ' key="start_date"].', $res_data['access_opens_message']['raw'] );
- $this->assertEquals( do_shortcode( 'This course opens on [lifterlms_course_info id=' . $res_data['id'] . ' key="start_date"].' ), $res_data['access_opens_message']['rendered'] );
- $this->assertEquals( 'This course closed on [lifterlms_course_info id=' . $res_data['id'] . ' key="end_date"].', $res_data['access_closes_message']['raw'] );
- $this->assertEquals( do_shortcode( 'This course closed on [lifterlms_course_info id=' . $res_data['id'] . ' key="end_date"].' ), $res_data['access_closes_message']['rendered'] );
-
- // Enrollment period messages.
- $this->assertEquals( 'Enrollment in this course opens on [lifterlms_course_info id=' . $res_data['id'] . ' key="enrollment_start_date"].', $res_data['enrollment_opens_message']['raw'] );
- $this->assertEquals( do_shortcode( 'Enrollment in this course opens on [lifterlms_course_info id=' . $res_data['id'] . ' key="enrollment_start_date"].' ), $res_data['enrollment_opens_message']['rendered'] );
- $this->assertEquals( 'Enrollment in this course closed on [lifterlms_course_info id=' . $res_data['id'] . ' key="enrollment_end_date"].', $res_data['enrollment_closes_message']['raw'] );
- $this->assertEquals( do_shortcode( 'Enrollment in this course closed on [lifterlms_course_info id=' . $res_data['id'] . ' key="enrollment_end_date"].' ), $res_data['enrollment_closes_message']['rendered'] );
-
- // Capacity enabled.
- $this->assertFalse( $res_data['capacity_enabled'] );
-
- // Catalog visibility.
- $this->assertEquals( 'catalog_search', $res_data['catalog_visibility'] );
-
- // Categories.
- $this->assertEquals( array(), $res_data['categories'] );
-
- // Comment_status.
- $this->assertEquals( 'open', $res_data['comment_status'] );
-
- // Difficulties.
- $this->assertEquals( array(), $res_data['difficulties'] );
-
- // Instructors. If empty, llms core responds with the course author in an array.
- $this->assertEquals( array( get_current_user_id() ), $res_data['instructors'] );
-
- // Menu order.
- $this->assertEquals( 0, $res_data['menu_order'] );
-
- // Comment_status.
- $this->assertEquals( 'open', $res_data['ping_status'] );
-
- // Sales page type.
- $this->assertEquals( 'none', $res_data['sales_page_page_type'] );
-
- // Status.
- $this->assertEquals( 'publish', $res_data['status'] );
-
- // Tags.
- $this->assertEquals( array(), $res_data['tags'] );
-
- // Tracks.
- $this->assertEquals( array(), $res_data['tracks'] );
-
- // Video tile.
- $this->assertFalse( $res_data['video_tile'] );
- }
-
- /**
- * Test creating a single course special props.
- * These props, when set, alter the rendered content so we test them separetaly.
- *
- * @since 1.0.0-beta.1
- */
- public function test_create_course_special() {
-
- wp_set_current_user( $this->user_allowed );
-
- $request = new WP_REST_Request( 'POST', $this->route );
-
- $sample_course_args = array_merge(
- $this->sample_course_args,
- array(
- 'audio_embed' => 'https://www.youtube.com/abc',
- 'video_embed' => 'www.youtube.com/efg',
- 'capacity_limit' => 22,
- 'capacity_enabled' => true,
- 'capacity_message' => 'Enrollment has closed because the maximum number of allowed students has been reached.',
- 'access_opens_date' => '2019-05-22 17:20:05',
- 'access_closes_date' => '2019-05-22 17:23:08',
- 'enrollment_opens_date' => '2019-05-22 17:22:05',
- 'enrollment_closes_date' => '2019-05-22 17:22:08',
- )
- );
-
- $request->set_body_params( $sample_course_args );
- $response = $this->server->dispatch( $request );
-
- // Success.
- $this->assertEquals( 201, $response->get_status() );
-
- $res_data = $response->get_data();
-
- $this->assertEquals( esc_url_raw( $sample_course_args['audio_embed'] ), $res_data['audio_embed'] );
- $this->assertEquals( esc_url_raw( $sample_course_args['video_embed'] ), $res_data['video_embed'] );
- $this->assertEquals( $sample_course_args['capacity_enabled'], $res_data['capacity_enabled'] );
- $this->assertEquals( do_shortcode( $sample_course_args['capacity_message'] ), $res_data['capacity_message']['rendered'] );
- $this->assertEquals( $sample_course_args['capacity_limit'], $res_data['capacity_limit'] );
-
- // Dates.
- $this->assertEquals( $sample_course_args['access_opens_date'], $res_data['access_opens_date'] );
- $this->assertEquals( $sample_course_args['access_closes_date'], $res_data['access_closes_date'] );
- $this->assertEquals( $sample_course_args['enrollment_opens_date'], $res_data['enrollment_opens_date'] );
- $this->assertEquals( $sample_course_args['enrollment_closes_date'], $res_data['enrollment_closes_date'] );
- }
-
- /**
- * Test creating a single course with taxonomies
- *
- * @since 1.0.0-beta.1
- */
- public function test_create_course_with_taxonomies() {
-
- wp_set_current_user( $this->user_allowed );
- $taxonomies = array(
- 'categories' => array(
- 1,
- 2,
- 3,
- ),
- 'tags' => array(
- 6,
- 4,
- 8,
- ),
- 'difficulties' => array(
- 9,
- ),
- 'tracks' => array(
- 7,
- 5,
- 6,
- ),
- );
-
- $course_args = array_merge(
- $this->sample_course_args,
- $taxonomies
- );
-
- $request = new WP_REST_Request( 'POST', $this->route );
-
- $request->set_body_params( $course_args );
- $response = $this->server->dispatch( $request );
-
- // Terms have not ben created, I expect the course is created with empty taxonomies.
- $this->assertEquals( 201, $response->get_status() );
-
- $res_data = $response->get_data();
-
- foreach ( $taxonomies as $tax => $tid ) {
- $this->assertEquals( array(), $res_data[ $tax ] );
- }
-
- // let's create the terms.
- $taxonomies = array(
- 'categories' => $this->factory()->term->create_many(
- 3,
- array(
- 'taxonomy' => 'course_cat',
- )
- ),
- 'tags' => $this->factory()->term->create_many(
- 3,
- array(
- 'taxonomy' => 'course_tag',
- )
- ),
- 'difficulties' => $this->factory()->term->create_many(
- 1,
- array(
- 'taxonomy' => 'course_difficulty',
- )
- ),
- 'tracks' => $this->factory()->term->create_many(
- 3,
- array(
- 'taxonomy' => 'course_track',
- )
- ),
- );
-
- $course_args = array_merge(
- $this->sample_course_args,
- $taxonomies
- );
-
- $request->set_body_params( $course_args );
- $response = $this->server->dispatch( $request );
-
- // Terms have been created, I expect the course is created with taxonomies set.
- $this->assertEquals( 201, $response->get_status() );
-
- $res_data = $response->get_data();
-
- foreach ( $taxonomies as $tax => $tid ) {
- $this->assertEquals( $tid, $res_data[ $tax ] );
- }
- }
-
- /**
- * Test creating a single course with taxonomies
- *
- * @since 1.0.0-beta.1
- */
- public function test_create_course_with_prerequisites() {
- wp_set_current_user( $this->user_allowed );
-
- $course_args = array_merge(
- $this->sample_course_args,
- array(
- 'prerequisite' => 2,
- 'prerequisite_track' => 5,
- )
- );
-
- $request = new WP_REST_Request( 'POST', $this->route );
-
- $request->set_body_params( $course_args );
- $response = $this->server->dispatch( $request );
- $res_data = $response->get_data();
-
- // Courses with id 2 do not exist, hence I expect an empty prerequisite property.
- $this->assertEquals( 0, $res_data['prerequisite'] );
- // Tracks with id 5 do not exist, hence I expect an empty prerequisite track.
- $this->assertEquals( 0, $res_data['prerequisite_track'] );
-
- $course = new LLMS_Course( $res_data['id'] );
-
- // Check that the created course's has_prerequisite is set accordingly.
- $this->assertEquals( 'no', $course->get( 'has_prerequisite' ) );
-
- // Create a course and a track.
- $prereq_course = $this->factory->course->create( array( 'sections' => 0 ) );
- $prereq_track = $this->factory()->term->create(
- array(
- 'taxonomy' => 'course_track',
- )
- );
-
- $course_args = array_merge(
- $this->sample_course_args,
- array(
- 'prerequisite' => $prereq_course,
- 'prerequisite_track' => $prereq_track,
- )
- );
-
- $request->set_body_params( $course_args );
- $response = $this->server->dispatch( $request );
- $res_data = $response->get_data();
-
- // I expect prerequisites now match.
- $this->assertEquals( $prereq_course, $res_data['prerequisite'] );
- $this->assertEquals( $prereq_track, $res_data['prerequisite_track'] );
-
- $course = new LLMS_Course( $res_data['id'] );
-
- // Check that the created course's has_prerequisite is set accordingly.
- $this->assertEquals( 'yes', $course->get( 'has_prerequisite' ) );
-
- }
-
- /**
- * Test course "periods".
- *
- * @since 1.0.0-beta.1
- */
- public function test_create_course_and_periods() {
-
- wp_set_current_user( $this->user_allowed );
-
- $request = new WP_REST_Request( 'POST', $this->route );
-
- $course_args = array_merge(
- $this->sample_course_args,
- array(
- 'access_opens_date' => '2019-05-22 17:20:05',
- 'enrollment_closes_date' => '2019-05-22 17:22:05',
- )
- );
-
- $request->set_body_params( $course_args );
- $response = $this->server->dispatch( $request );
-
- $res_data = $response->get_data();
-
- $course = new LLMS_Course( $res_data['id'] );
-
- // Check that the created course's 'time_period' is enabled, since one of access_opens_date and access_closes_date is set.
- $this->assertEquals( 'yes', $course->get( 'time_period' ) );
- // Check that the created course's 'enrollment_period' is enabled, since one of enrollment_opens_date and enrollment_closes_date is set.
- $this->assertEquals( 'yes', $course->get( 'enrollment_period' ) );
-
- $course_args = array_merge(
- $this->sample_course_args,
- array(
- 'access_closes_date' => '2019-05-22 17:20:05',
- 'enrollment_opens_date' => '2019-05-22 17:22:05',
- )
- );
-
- $request->set_body_params( $course_args );
- $response = $this->server->dispatch( $request );
-
- $res_data = $response->get_data();
-
- $course = new LLMS_Course( $res_data['id'] );
-
- // Check that the created course's 'time_period' is enabled, since one of access_opens_date and access_closes_date is set.
- $this->assertEquals( 'yes', $course->get( 'time_period' ) );
- // Check that the created course's 'enrollment_period' is enabled, since one of enrollment_opens_date and enrollment_closes_date is set.
- $this->assertEquals( 'yes', $course->get( 'enrollment_period' ) );
-
- $request->set_body_params( $this->sample_course_args );
- $response = $this->server->dispatch( $request );
-
- $res_data = $response->get_data();
-
- $course = new LLMS_Course( $res_data['id'] );
-
- // Check that the created course's 'time_period' is not enabled, since none of access_opens_date and access_closes_date is set.
- $this->assertEquals( 'no', $course->get( 'time_period' ) );
- // Check that the created course's 'enrollment_period' is not enabled, since none of enrollment_opens_date and enrollment_closes_date is set.
- $this->assertEquals( 'no', $course->get( 'enrollment_period' ) );
-
- }
-
- /**
- * Test create course with raw properties.
- * Check textual properties are still set when supplying them as 'raw'.
- *
- * @since 1.0.0-beta.1
- */
- public function test_create_course_and_raws() {
- wp_set_current_user( $this->user_allowed );
-
- $request = new WP_REST_Request( 'POST', $this->route );
-
- $course_raw_messages = array(
- 'length' => array(
- 'raw' => 'Length raw message',
- ),
- 'restricted_message' => array(
- 'raw' => 'Restricted raw message',
- ),
- 'capacity_message' => array(
- 'raw' => 'Capacity raw message',
- ),
- 'access_opens_message' => array(
- 'raw' => 'Access opens raw message',
- ),
- 'access_closes_message' => array(
- 'raw' => 'Access closes raw message',
- ),
- 'enrollment_opens_message' => array(
- 'raw' => 'Enrollment opens raw message',
- ),
- 'enrollment_closes_message' => array(
- 'raw' => 'Enrollment closess raw message',
- ),
- );
-
- $course_args = array_merge(
- $this->sample_course_args,
- $course_raw_messages
- );
-
- $request->set_body_params( $course_args );
- $response = $this->server->dispatch( $request );
-
- $res_data = $response->get_data();
-
- foreach ( $course_raw_messages as $property => $content ) {
- $this->assertEquals( $content['raw'], $res_data[ $property ]['raw'] );
- }
-
- }
-
- /**
- * Test producing bad request error when creating a single course.
- *
- * @since 1.0.0-beta.1
- */
- public function test_create_course_bad_request() {
-
- wp_set_current_user( $this->user_allowed );
-
- $request = new WP_REST_Request( 'POST', $this->route );
-
- $course_args = $this->sample_course_args;
-
- // Creating a course passing an id produces a bad request.
- $course_args['id'] = '123';
-
- $request->set_body_params( $course_args );
- $response = $this->server->dispatch( $request );
-
- // Bad request.
- $this->assertEquals( 400, $response->get_status() );
-
- // create a course without title.
- $course_args = $this->sample_course_args;
- unset( $course_args['title'] );
-
- $request->set_body_params( $course_args );
- $response = $this->server->dispatch( $request );
- // Bad request.
- $this->assertEquals( 400, $response->get_status() );
-
- // create a course without content.
- $course_args = $this->sample_course_args;
- unset( $course_args['content'] );
-
- $request->set_body_params( $course_args );
- $response = $this->server->dispatch( $request );
- // Bad request.
- $this->assertEquals( 400, $response->get_status() );
-
- // status param must respect the item scehma, hence one of "publish" "pending" "draft" "auto-draft" "future" "private" "trash".
- $course_args = $this->sample_course_args;
- $status = array_merge( array_keys( get_post_statuses() ), array( 'future', 'trash', 'auto-draft' ) );
- $course_args['status'] = $status[0] . rand() . 'not_in_enum';
-
- $request->set_body_params( $course_args );
- $response = $this->server->dispatch( $request );
-
- // Bad request.
- $this->assertEquals( 400, $response->get_status() );
-
- // catalog_visibility param must respect the item schema, hence one of array_keys( llms_get_product_visibility_options() ).
- $course_args = $this->sample_course_args;
- $catalog_visibility = array_keys( llms_get_product_visibility_options() );
- $course_args['catalog_visibility'] = $catalog_visibility[0] . rand() . 'not_in_enum';
-
- $request->set_body_params( $course_args );
- $response = $this->server->dispatch( $request );
-
- // Bad request.
- $this->assertEquals( 400, $response->get_status() );
-
- }
-
- /**
- * Test creating single course without permissions.
- *
- * @since 1.0.0-beta.1
- */
- public function test_create_course_without_permissions() {
-
- wp_set_current_user( 0 );
-
- $request = new WP_REST_Request( 'POST', $this->route );
-
- $request->set_body_params( $this->sample_course_args );
- $response = $this->server->dispatch( $request );
-
- // Unhauthorized.
- $this->assertEquals( 401, $response->get_status() );
-
- }
-
- /**
- * Test forbidden single course creation.
- *
- * @since 1.0.0-beta.1
- */
- public function test_create_course_forbidden() {
-
- wp_set_current_user( $this->user_forbidden );
-
- $request = new WP_REST_Request( 'POST', $this->route );
-
- $request->set_body_params( $this->sample_course_args );
- $response = $this->server->dispatch( $request );
-
- // Forbidden.
- $this->assertEquals( 403, $response->get_status() );
-
- }
-
-
- /**
- * Test updating a course.
- *
- * @since 1.0.0-beta.1
- */
- public function test_update_course() {
-
- // create a course first.
- $course = $this->factory->course->create_and_get();
-
- wp_set_current_user( $this->user_allowed );
-
- // update.
- $update_data = array(
- 'title' => 'A TITLE UPDTAED',
- 'content' => '