milady-cima-api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cba4eea16f1a7f12d7085606bdadee4927918c7f960d2bd95ee4b9f10909f0f
-  data.tar.gz: e0519d5dfa0eacecf95237a65669ec5b232d23eb334bf50b9349b501887f1bbb
+  metadata.gz: 8e9fdba0b8e942edd14809c180519a39323e7110110b6c862a2006b331741206
+  data.tar.gz: d4c5eadceb6dc83739abab360ff44137c7d42b254d86c829d53c1e5aca0aabc0
 SHA512:
-  metadata.gz: e872f0ae20e5bb564e219625426e4f853cc65ff48ac20a36c73879b7e7dcc4351c22ff6ce5fdb0aee612e11f76fce8cf38588005f54777897c2257c162c630f6
-  data.tar.gz: 4aedb0de4d77fa84fc8d430fb4dfc3df3ca61e6279785a7dd4750490493ee1cfec2003e8b5583d5d5f7afef19a1a5007ed8b12a0a83fb786bfcb4cf2499f9201
+  metadata.gz: 49bbf4f1f574aa9b5d2b6b07f18a943bc2660cb265ccbac038b21ea08e40ae177d631ca0382411d68280a679d886a6fd9a8db8611ab77fc4cc52f70ef71c9fe6
+  data.tar.gz: be4ba9b6f41686c4a8acfcaa16a503e17d43b49a59cf6c6b0ea6c91fb5a3b94bf82e500a282f00aedbf0dbd7cb72e9d11869d06d1e908ac81045f4b33f10bfbe

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.3.0] - 2025-12-04
+
+### Added
+- Added `Learners` resource under `Courses` to support `GET /courses/{id}/learners` and `GET /courses/{id}/learners/{user_id}`.
+
+### Changed
+- Refactored `Courses`, `Assessments`, and `Learners` resources to inherit from a common `Base` class to share initialization and filter normalization logic.
+
 ## [0.2.1] - 2025-12-04
 
 ### Added

data/lib/milady_cima_api/resources/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module MiLadyCimaApi
+  module Resources
+    class Base
+      # @param client [MiLadyCimaApi::Client]
+      def initialize(client)
+        @client = client
+      end
+
+      protected
+
+      def normalize_filter(filter)
+        return filter if filter.is_a?(String)
+        return JSON.generate(filter) if filter.is_a?(Hash)
+
+        raise ArgumentError, 'filter must be a String (JSON) or a Hash'
+      end
+    end
+  end
+end

data/lib/milady_cima_api/resources/courses/assessments.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
+require_relative '../base'
+
 module MiLadyCimaApi
   module Resources
     class Courses
       # Assessments resource exposes endpoints under /courses/{id}/assessments
-      class Assessments
-        # @param client [MiLadyCimaApi::Client]
-        def initialize(client)
-          @client = client
-        end
+      class Assessments < Resources::Base
 
         # List assessments for a course
         #
@@ -50,14 +48,6 @@ module MiLadyCimaApi
           @client.get("/courses/#{course_id}/assessments/#{assessment_id}")
         end
 
-        private
-
-        def normalize_filter(filter)
-          return filter if filter.is_a?(String)
-          return JSON.generate(filter) if filter.is_a?(Hash)
-
-          raise ArgumentError, 'filter must be a String (JSON) or a Hash'
-        end
       end
     end
   end

data/lib/milady_cima_api/resources/courses/learners.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+
+module MiLadyCimaApi
+  module Resources
+    class Courses
+      # Learners resource exposes endpoints under /courses/{id}/learners
+      class Learners < Resources::Base
+
+        # List learners for a course
+        #
+        # GET /courses/{id}/learners
+        # @param course_id [Integer, String] ID of the course
+        # @param filter [Hash, String] Filter using JSON structure
+        # @param limit [Integer] Limit the number of returned objects (default 10, max 100)
+        # @param offset [Integer] Used for paging through a small dataset
+        # @param after [Integer] Used for fast paging
+        # @param count [Boolean] If true, just return the number of list items
+        # @param include [String] Comma separated list of relationships to include
+        # @return [Array, Hash] Parsed JSON response from the API
+        def list(course_id:, filter: nil, limit: nil, offset: nil, after: nil, count: nil, include: nil)
+          raise ArgumentError, 'course_id is required' if course_id.nil?
+
+          if limit && limit > 100
+            raise ArgumentError, 'limit cannot be greater than 100'
+          end
+
+          params = {}
+          params['$filter'] = normalize_filter(filter) if filter
+          params['$limit'] = limit if limit
+          params['$offset'] = offset if offset
+          params['$after'] = after if after
+          params['$count'] = count if count
+          params['$include'] = include if include
+
+          @client.get("/courses/#{course_id}/learners", params: params)
+        end
+
+        # Get a single learner
+        #
+        # GET /courses/{id}/learners/{user_id}
+        # @param course_id [Integer, String] ID of the course
+        # @param user_id [Integer, String] ID of the user
+        # @param include [String] Comma separated list of relationships to include
+        # @return [Hash] Parsed JSON response from the API
+        def find(course_id:, user_id:, include: nil)
+          raise ArgumentError, 'course_id is required' if course_id.nil?
+          raise ArgumentError, 'user_id is required' if user_id.nil?
+
+          params = {}
+          params['$include'] = include if include
+
+          @client.get("/courses/#{course_id}/learners/#{user_id}", params: params)
+        end
+
+      end
+    end
+  end
+end

data/lib/milady_cima_api/resources/courses.rb

@@ -1,23 +1,22 @@
 # frozen_string_literal: true
-
-require 'json'
-require_relative 'courses/assessments'
+require_relative 'base'
 
 module MiLadyCimaApi
   module Resources
     # Courses resource exposes endpoints under /courses
     # Provides convenience helpers for building $filter queries.
-    class Courses
-      # @param client [MiLadyCimaApi::Client]
-      def initialize(client)
-        @client = client
-      end
+    class Courses < Base
 
       # @return [MiLadyCimaApi::Resources::Courses::Assessments]
       def assessments
         @assessments ||= Assessments.new(@client)
       end
 
+      # @return [MiLadyCimaApi::Resources::Courses::Learners]
+      def learners
+        @learners ||= Learners.new(@client)
+      end
+
       # List courses
       #
       # GET /courses
@@ -91,14 +90,9 @@ module MiLadyCimaApi
         list(filter: filter, **extra_params)
       end
 
-      private
-
-      def normalize_filter(filter)
-        return filter if filter.is_a?(String)
-        return JSON.generate(filter) if filter.is_a?(Hash)
-
-        raise ArgumentError, 'filter must be a String (JSON) or a Hash'
-      end
     end
   end
 end
+
+require_relative 'courses/assessments'
+require_relative 'courses/learners'

data/lib/milady_cima_api/version.rb

@@ -2,5 +2,5 @@
 
 module MiLadyCimaApi
   # Gem version
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: milady-cima-api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - marcus.salinas
@@ -27,8 +27,10 @@ files:
 - lib/milady_cima_api.rb
 - lib/milady_cima_api/client.rb
 - lib/milady_cima_api/errors.rb
+- lib/milady_cima_api/resources/base.rb
 - lib/milady_cima_api/resources/courses.rb
 - lib/milady_cima_api/resources/courses/assessments.rb
+- lib/milady_cima_api/resources/courses/learners.rb
 - lib/milady_cima_api/resources/organizations.rb
 - lib/milady_cima_api/resources/users.rb
 - lib/milady_cima_api/version.rb