milady-cima-api 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5539419d40c122e538f50af35e0be9230c3b9e29343ae9afaf47ecc18164cc25
-  data.tar.gz: 175f19d66fd55269468793c5d7ae9eb2eb5b1adf6c874e35f28ca0a7cbf431e7
+  metadata.gz: 4cba4eea16f1a7f12d7085606bdadee4927918c7f960d2bd95ee4b9f10909f0f
+  data.tar.gz: e0519d5dfa0eacecf95237a65669ec5b232d23eb334bf50b9349b501887f1bbb
 SHA512:
-  metadata.gz: 6b14b31072de9c2678cae2938c5de0dc6ba0feb1d9c2571a51db638c6bd740c04eb93d7f6972a40edd31cd07575446d74ad4fdaab401eb8d0bf28bfb70e08ccd
-  data.tar.gz: 63c8e1ec423e9abf96e7a9b3be440e38d3a0a642eb4a76102d3440e5a5da08b3cc3ad577a721f0de455071ec5e4ab6eea71d870cb90d0a53e1a0e279eb03b666
+  metadata.gz: e872f0ae20e5bb564e219625426e4f853cc65ff48ac20a36c73879b7e7dcc4351c22ff6ce5fdb0aee612e11f76fce8cf38588005f54777897c2257c162c630f6
+  data.tar.gz: 4aedb0de4d77fa84fc8d430fb4dfc3df3ca61e6279785a7dd4750490493ee1cfec2003e8b5583d5d5f7afef19a1a5007ed8b12a0a83fb786bfcb4cf2499f9201

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
 
+## [0.2.1] - 2025-12-04
+
+### Added
+- Added `verify_ssl` option to `Client` initialization (defaults to `true`) to allow disabling SSL verification for testing or development.
+- Added `Courses#find` method to retrieve a single course.
+- Added live integration tests for `Courses` and `Assessments` filters (skipped by default).
+
+### Changed
+- Updated `Courses#list` to use explicit keyword arguments for better documentation and usability, matching `Assessments#list`.
+
+## [0.2.0] - 2025-12-04
+
+### Added
+- Added `Assessments` resource under `Courses` to support `GET /courses/{id}/assessments` and `GET /courses/{id}/assessments/{assessment_id}`.
+- Standardized query parameters for `Assessments#list` with validation.
+
 ## [0.1.0] - 2025-10-06
 
 - Initial release

data/lib/milady_cima_api/client.rb

@@ -10,13 +10,15 @@ module MiLadyCimaApi
     API_PAGE_LIMIT = 100
 
     attr_reader :api_key, :base_url
+    attr_reader :api_key, :base_url, :verify_ssl
     attr_reader :users, :organizations, :courses
 
-    def initialize(api_key:, base_url: DEFAULT_BASE_URL)
+    def initialize(api_key:, base_url: DEFAULT_BASE_URL, verify_ssl: true)
       raise ArgumentError, 'api_key is required' if api_key.nil? || api_key.strip.empty?
 
       @api_key = api_key
       @base_url = base_url.chomp('/')
+      @verify_ssl = verify_ssl
       @users = MiLadyCimaApi::Resources::Users.new(self)
       @organizations = MiLadyCimaApi::Resources::Organizations.new(self)
       @courses = MiLadyCimaApi::Resources::Courses.new(self)
@@ -100,6 +102,7 @@ module MiLadyCimaApi
     def perform_request(uri, request)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = uri.scheme == 'https'
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless verify_ssl
       response = http.request(request)
       handle_response(response)
     end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+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
+
+        # List assessments for a course
+        #
+        # GET /courses/{id}/assessments
+        # @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
+        # @return [Array, Hash] Parsed JSON response from the API
+        def list(course_id:, filter: 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['$limit'] = limit if limit
+          params['$offset'] = offset if offset
+          params['$after'] = after if after
+          params['$count'] = count if count
+
+          @client.get("/courses/#{course_id}/assessments", params: params)
+        end
+
+        # Get a single assessment
+        #
+        # GET /courses/{id}/assessments/{assessment_id}
+        # @param course_id [Integer, String] ID of the course
+        # @param assessment_id [Integer, String] ID of the assessment
+        # @return [Hash] Parsed JSON response from the API
+        def find(course_id:, assessment_id:)
+          raise ArgumentError, 'course_id is required' if course_id.nil?
+          raise ArgumentError, 'assessment_id is required' if assessment_id.nil?
+
+          @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
+end

data/lib/milady_cima_api/resources/courses.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
+require_relative 'courses/assessments'
 
 module MiLadyCimaApi
   module Resources
@@ -12,22 +13,54 @@ module MiLadyCimaApi
         @client = client
       end
 
+      # @return [MiLadyCimaApi::Resources::Courses::Assessments]
+      def assessments
+        @assessments ||= Assessments.new(@client)
+      end
+
       # List courses
       #
       # GET /courses
-      # @param params [Hash] Optional query params. Supports the special key
-      #   "$filter" (String or Hash). If provided as a Hash, it will be JSON-encoded
-      #   to match the API expectation (e.g., {"organization_id" => 123} or
-      #   {"and" => [{"gt" => {"metadata.created_at" => "2025-01-01T00:00:00.000Z"}}]}).
-      # @option params [String, Hash] :$filter JSON string or Ruby Hash representing the filter
+      # @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 order [String] Comma separated attribute names to sort by
+      # @param include [String] Comma separated list of relationships to include
       # @return [Array, Hash] Parsed JSON response from the API
-      # @raise [MiLadyCimaApi::UnauthorizedError, MiLadyCimaApi::NotFoundError, MiLadyCimaApi::ClientError, MiLadyCimaApi::ServerError]
-      def list(params = {})
-        params = params.dup || {}
-        normalize_filter_param!(params)
+      def list(filter: nil, limit: nil, offset: nil, after: nil, count: nil, order: nil, include: 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['$order'] = order if order
+        params['$include'] = include if include
+
         @client.get('/courses', params: params)
       end
 
+      # Get a single course
+      #
+      # GET /courses/{id}
+      # @param id [Integer, String] ID of the course
+      # @param include [String] Comma separated list of relationships to include
+      # @return [Hash] Parsed JSON response from the API
+      def find(id:, include: nil)
+        raise ArgumentError, 'id is required' if id.nil?
+
+        params = {}
+        params['$include'] = include if include
+
+        @client.get("/courses/#{id}", params: params)
+      end
+
       # Convenience: List courses by organization
       # @param organization_id [Integer, String]
       # @param extra_params [Hash] Additional query params (e.g., pagination)
@@ -35,7 +68,7 @@ module MiLadyCimaApi
       def by_organization(organization_id:, **extra_params)
         raise ArgumentError, 'organization_id is required' if organization_id.nil?
         filter = { 'organization_id' => organization_id }
-        list({ '$filter' => filter }.merge(extra_params))
+        list(filter: filter, **extra_params)
       end
 
       # Convenience: List courses filtered by created_at with comparison operator
@@ -55,26 +88,16 @@ module MiLadyCimaApi
                    { 'and' => [time_filter, { 'organization_id' => organization_id }] }
                  end
 
-        list({ '$filter' => filter }.merge(extra_params))
+        list(filter: filter, **extra_params)
       end
 
       private
 
-      # Mutates params hash to ensure $filter is a JSON string when provided as a Hash
-      def normalize_filter_param!(params)
-        # support both symbol and string keys
-        filter_key = params.key?(:$filter) ? :$filter : (params.key?("$filter") ? "$filter" : nil)
-        return unless filter_key
-
-        value = params[filter_key]
-        case value
-        when Hash
-          params[filter_key] = JSON.generate(value)
-        when String
-          # pass through
-        else
-          raise ArgumentError, "$filter must be a String (JSON) or a Hash"
-        end
+      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

data/lib/milady_cima_api/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: milady-cima-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - marcus.salinas
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: milady-cima-api is a lightweight Ruby client that wraps the MiLady CIMA
   API, providing simple, idiomatic access to its endpoints.
@@ -29,10 +28,10 @@ files:
 - lib/milady_cima_api/client.rb
 - lib/milady_cima_api/errors.rb
 - lib/milady_cima_api/resources/courses.rb
+- lib/milady_cima_api/resources/courses/assessments.rb
 - lib/milady_cima_api/resources/organizations.rb
 - lib/milady_cima_api/resources/users.rb
 - lib/milady_cima_api/version.rb
-- milady-cima-api.gemspec
 homepage: https://github.com/jippylong12/milady-cima-api
 licenses:
 - MIT
@@ -41,7 +40,6 @@ metadata:
   homepage_uri: https://github.com/jippylong12/milady-cima-api
   source_code_uri: https://github.com/jippylong12/milady-cima-api
   changelog_uri: https://github.com/jippylong12/milady-cima-api/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -56,8 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Ruby wrapper for the MiLady CIMA API.
 test_files: []

data/milady-cima-api.gemspec

@@ -1,40 +0,0 @@
-# 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