milady-cima-api 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aaad5052e67c719bbf81aa0bf40493865049dc2a75d6e2b429c0a41f222423f
-  data.tar.gz: 6152b2c8620b19c94cfad4b9b889cf508fb1050da2345f7b9c5c39f207687e7a
+  metadata.gz: a2393c91cf9004a6e89b17a133fb6a22c1c975709ba0e2deed96de5ea7798e2b
+  data.tar.gz: 4587a63c10a2a296db283dd54e0f09ddf2b2fac072f0a14a1580b21e7cf2e539
 SHA512:
-  metadata.gz: bb2e79691071cb967e6b5f5c874c174994d081b9c15acdea8fca92b006038c3299ca4ef79479e8c69313339e10dadc68bcd990ae2218fc1558de66d23f9494e6
-  data.tar.gz: 406ad4d1a9ba63daa511a575ff1520f1e695af2ebb8f2a21d9d2792d0a005ab28e0a64f917045e86e4b2899242c6fe548018a815f526b99d0722936799e1149a
+  metadata.gz: 48a557304dd197103eef126d739a9d02b27a440116fa9e2e4309a56d2754c2071f291e03d165adb346ccb234a5ca71686c5c0e09f71c1c3d86fd29dbfff4e8ae
+  data.tar.gz: ec1b31c51524ddc83edea4fc6631b3a73bc033029450f83ccdd660bc471730e9ae5a8185cf2b144243d01d27eac9274849a17d4a2e6a3a75dfc9111856070883

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.7.0] - 2025-12-29
+### Added
+- Added `Modules` resource under `Courses` to support `GET /courses/{id}/modules` and `GET /courses/{id}/modules/{module_id}`.
+
+## [0.6.0] - 2025-12-05
+### Added
+- Added `AssessmentGrades` resource under `Users` to support `GET /users/{id}/assessment_grades` and `GET /users/{id}/assessment_grades/{grade_id}`.
+
 ## [0.5.1] - 2025-12-05
 ### Fixed
 - Fixed SSL certificate verification error in `Client` by explicitly configuring `OpenSSL::X509::Store` with default paths.

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative '../base'
+
+module MiLadyCimaApi
+  module Resources
+    class Courses
+      # Modules resource exposes endpoints under /courses/{id}/modules
+      class Modules < Resources::Base
+
+        # List modules for a course
+        #
+        # GET /courses/{id}/modules
+        # @param course_id [Integer, String] ID of the course
+        # @param filter [Hash, String] Filter using JSON structure (id, start_at, begin_at, end_at, course_id, tags)
+        # @param include [String] Comma separated list of relationships to include (course)
+        # @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 by setting the value to the last object id
+        # @param count [Boolean] If true, just return the number of list items
+        # @return [Array, Hash] Parsed JSON response from the API
+        def list(course_id:, filter: nil, include: nil, limit: nil, offset: nil, after: nil, count: 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['$include'] = include if include
+          params['$limit'] = limit if limit
+          params['$offset'] = offset if offset
+          params['$after'] = after if after
+          params['$count'] = count if count
+
+          @client.get("/courses/#{course_id}/modules", params: params)
+        end
+
+        # Get a single module
+        #
+        # GET /courses/{id}/modules/{module_id}
+        # @param course_id [Integer, String] ID of the course
+        # @param module_id [Integer, String] ID of the module
+        # @param include [String] Comma separated list of relationships to include (course)
+        # @return [Hash] Parsed JSON response from the API
+        def find(course_id:, module_id:, include: nil)
+          raise ArgumentError, 'course_id is required' if course_id.nil?
+          raise ArgumentError, 'module_id is required' if module_id.nil?
+
+          params = {}
+          params['$include'] = include if include
+
+          @client.get("/courses/#{course_id}/modules/#{module_id}", params: params)
+        end
+
+      end
+    end
+  end
+end

data/lib/milady_cima_api/resources/courses.rb

@@ -17,6 +17,11 @@ module MiLadyCimaApi
         @learners ||= Learners.new(@client)
       end
 
+      # @return [MiLadyCimaApi::Resources::Courses::Modules]
+      def modules
+        @modules ||= Modules.new(@client)
+      end
+
       # List courses
       #
       # GET /courses
@@ -96,3 +101,4 @@ end
 
 require_relative 'courses/assessments'
 require_relative 'courses/learners'
+require_relative 'courses/modules'

data/lib/milady_cima_api/resources/users/assessment_grades.rb

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

data/lib/milady_cima_api/resources/users.rb

@@ -55,9 +55,16 @@ module MiLadyCimaApi
         @client.get("/users/#{id}", params: params)
       end
 
+
+      # @return [MiLadyCimaApi::Resources::Users::AssessmentGrades]
+      def assessment_grades
+        @assessment_grades ||= AssessmentGrades.new(@client)
+      end
+
     end
   end
 end
 
 
-require_relative 'users/course_learners'
+require_relative 'users/course_learners'
+require_relative 'users/assessment_grades'

data/lib/milady_cima_api/version.rb

@@ -2,5 +2,5 @@
 
 module MiLadyCimaApi
   # Gem version
-  VERSION = "0.5.1"
+  VERSION = "0.7.0"
 end

data/milady-cima-api.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/milady_cima_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "milady-cima-api"
+  spec.version = MiLadyCimaApi::VERSION
+  spec.authors = ["marcus.salinas"]
+  spec.email = ["12.marcus.salinas@gmail.com"]
+
+  spec.summary = "Ruby wrapper for the MiLady CIMA API."
+  spec.description = "milady-cima-api is a lightweight Ruby client that wraps the MiLady CIMA API, providing simple, idiomatic access to its endpoints."
+  spec.homepage = "https://github.com/jippylong12/milady-cima-api"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jippylong12/milady-cima-api"
+  spec.metadata["changelog_uri"] = "https://github.com/jippylong12/milady-cima-api/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: milady-cima-api
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - marcus.salinas
@@ -32,10 +32,13 @@ files:
 - lib/milady_cima_api/resources/courses/assessments.rb
 - lib/milady_cima_api/resources/courses/assessments/grades.rb
 - lib/milady_cima_api/resources/courses/learners.rb
+- lib/milady_cima_api/resources/courses/modules.rb
 - lib/milady_cima_api/resources/organizations.rb
 - lib/milady_cima_api/resources/users.rb
+- lib/milady_cima_api/resources/users/assessment_grades.rb
 - lib/milady_cima_api/resources/users/course_learners.rb
 - lib/milady_cima_api/version.rb
+- milady-cima-api.gemspec
 homepage: https://github.com/jippylong12/milady-cima-api
 licenses:
 - MIT