milady-cima-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5539419d40c122e538f50af35e0be9230c3b9e29343ae9afaf47ecc18164cc25
+  data.tar.gz: 175f19d66fd55269468793c5d7ae9eb2eb5b1adf6c874e35f28ca0a7cbf431e7
+SHA512:
+  metadata.gz: 6b14b31072de9c2678cae2938c5de0dc6ba0feb1d9c2571a51db638c6bd740c04eb93d7f6972a40edd31cd07575446d74ad4fdaab401eb8d0bf28bfb70e08ccd
+  data.tar.gz: 63c8e1ec423e9abf96e7a9b3be440e38d3a0a642eb4a76102d3440e5a5da08b3cc3ad577a721f0de455071ec5e4ab6eea71d870cb90d0a53e1a0e279eb03b666

data/.env.test.example

@@ -0,0 +1,3 @@
+# Copy this file to .env.test and adjust values for local testing
+# This API key is used by the test suite when running locally.
+MILADY_CIMA_API_KEY=secret

data/.junie/guidelines.md

@@ -0,0 +1,45 @@
+Junie Agent Guidelines for the MiLady CIMA Project
+==================================================
+
+Welcome, Junie. You are an AI coding agent tasked with assisting with the **MiLady CIMA** project, which is being developed as a Ruby gem. Your primary function is to help build and maintain an API wrapper. To ensure your work is aligned with our standards and goals, please follow the guidelines below.
+
+* * * * *
+
+1\. Project Description: MiLady CIMA
+------------------------------------
+
+The **MiLady CIMA** project is an **API wrapper** built as a Ruby gem. Its purpose is to provide a clean, user-friendly interface for interacting with an external API. The core principle is to abstract away the complexities of direct API calls, such as handling authentication, request headers, data serialization, and error responses. Our goal is to make the external API accessible to other developers in a simple, intuitive, and consistent manner, following established Ruby gem paradigms.
+
+* * * * *
+
+2\. Core Principles for the Ruby Gem
+------------------------------------
+
+When working on this project, your code should always reflect these core design principles:
+
+-   **Resource-Oriented Design:** The gem's structure must mirror the external API's resources. We will use a **class-based approach** where a main client class contains instances of other classes that represent specific API resources (e.g., `client.users`, `client.posts`). This prevents a monolithic "God object" and creates a clear, logical hierarchy.
+
+-   **Separation of Concerns:** Each class or module should have a single responsibility. A `Users` class, for example, should only contain logic related to the `/users` endpoint and its sub-resources.
+
+-   **Clear Error Handling:** The gem should catch API errors and raise descriptive, custom Ruby exceptions. A user should not have to parse raw JSON error messages to understand what went wrong. For example, a 404 response should raise a `MiLadyCima::NotFoundError`.
+
+-   **Adherence to Ruby Best Practices:** Write clean, well-commented code that follows the standard Ruby style guide (e.g., using `snake_case` for methods and variables). Use meaningful variable names and clear function signatures.
+
+* * * * *
+
+3\. Your Role as Junie
+----------------------
+
+As the AI agent, your role is to write code that aligns with the principles above. When a task involves creating a new endpoint or modifying an existing one, you should:
+
+-   **Determine the correct resource class** for the new endpoint (e.g., `Users`, `Posts`, `Comments`). If the class does not exist, you must create it.
+
+-   **Add a new method** to the appropriate resource class that encapsulates the API call.
+
+-   **Implement proper error handling** for potential API responses (e.g., 404 Not Found, 401 Unauthorized, 500 Server Error) by rescuing them and raising custom exceptions.
+
+-   **Add clear YARD-style documentation** (`@param`, `@return`, etc.) to the method explaining its purpose, parameters, and return values.
+
+-   **Write corresponding tests** using a framework like RSpec to ensure the new functionality works as expected and doesn't introduce regressions.
+
+By following these guidelines, you'll help us create a robust, well-documented, and professionally designed Ruby gem for the **MiLady CIMA** project.

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-10-06
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 12.marcus.salinas@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 marcus.salinas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Milady::Cima::Api
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/milady/cima/api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/milady-cima-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/milady-cima-api/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Milady::Cima::Api project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/milady-cima-api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/milady_cima_api/client.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'net/http'
+require 'json'
+
+module MiLadyCimaApi
+  class Client
+    DEFAULT_BASE_URL = 'https://www.miladycima.com/api/v3'
+    API_PAGE_LIMIT = 100
+
+    attr_reader :api_key, :base_url
+    attr_reader :users, :organizations, :courses
+
+    def initialize(api_key:, base_url: DEFAULT_BASE_URL)
+      raise ArgumentError, 'api_key is required' if api_key.nil? || api_key.strip.empty?
+
+      @api_key = api_key
+      @base_url = base_url.chomp('/')
+      @users = MiLadyCimaApi::Resources::Users.new(self)
+      @organizations = MiLadyCimaApi::Resources::Organizations.new(self)
+      @courses = MiLadyCimaApi::Resources::Courses.new(self)
+    end
+
+    def get(path, params: {})
+      params = params || {}
+      requested_limit = extract_numeric(params['$limit'] || params[:'$limit'])
+      if requested_limit && requested_limit > API_PAGE_LIMIT
+        raise ArgumentError, "$limit cannot be greater than #{API_PAGE_LIMIT}"
+      end
+
+      uri = build_uri(path, params)
+      request = Net::HTTP::Get.new(uri)
+      attach_headers(request)
+      perform_request(uri, request)
+    end
+    
+    def post(path, body: {})
+      uri = build_uri(path)
+      request = Net::HTTP::Post.new(uri)
+      attach_headers(request)
+      request.body = JSON.generate(body)
+      perform_request(uri, request)
+    end
+
+    private
+    
+    def build_uri(path, params = {})
+      raise ArgumentError, 'path must start with /' unless path.start_with?('/')
+      uri = URI.parse(base_url + path)
+
+      unless params.nil? || params.empty?
+        # 1) stringify keys/values properly
+        stringified = deep_stringify_keys(params)
+        # 2) JSON-encode complex values and preserve $-prefixed keys (e.g., "$filter")
+        json_ready = encode_complex_query_values(stringified)
+        query = URI.decode_www_form(String(uri.query)) + json_ready.to_a
+        uri.query = URI.encode_www_form(query)
+      end
+
+      uri
+    end
+    
+    def deep_stringify_keys(obj)
+      case obj
+      when Hash
+        obj.each_with_object({}) do |(k, v), h|
+          h[k].is_a?(Symbol) ? h[k.to_s] = deep_stringify_keys(v) : h[k.to_s] = deep_stringify_keys(v)
+        end
+      when Array
+        obj.map { |v| deep_stringify_keys(v) }
+      else
+        obj
+      end
+    end
+    
+    # Ensure nested hashes/arrays are sent as JSON strings in query values.
+    # Keys that begin with "$" (e.g., "$filter") are preserved verbatim.
+    # Example:
+    # { "$filter" => { "and" => [ ... ] } }
+    # => "$filter" => "{\"and\":[...]}"
+    def encode_complex_query_values(params)
+      return params unless params.is_a?(Hash)
+
+      params.each_with_object({}) do |(k, v), h|
+        if v.is_a?(Hash) || v.is_a?(Array)
+          h[k] = JSON.generate(v)
+        else
+          h[k] = v
+        end
+      end
+    end
+    
+    def attach_headers(request)
+      request['Accept'] = 'application/json'
+      request['Content-Type'] = 'application/json'
+      request['x-api-key'] = api_key
+    end
+    
+    def perform_request(uri, request)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+      response = http.request(request)
+      handle_response(response)
+    end
+    
+    def handle_response(response)
+      code = response.code.to_i
+      body = response.body
+
+      case code
+      when 200..299
+        parse_json(body)
+      when 401
+        raise MiLadyCimaApi::UnauthorizedError, error_message(body, code)
+      when 404
+        raise MiLadyCimaApi::NotFoundError, error_message(body, code)
+      when 400..499
+        raise MiLadyCimaApi::ClientError, error_message(body, code)
+      when 500..599
+        raise MiLadyCimaApi::ServerError, error_message(body, code)
+      else
+        raise MiLadyCimaApi::Error, error_message(body, code)
+      end
+    end
+    
+    def parse_json(body)
+      return nil if body.nil? || body.strip.empty?
+      JSON.parse(body)
+    rescue JSON::ParserError => e
+      raise MiLadyCimaApi::ResponseError, "Invalid JSON response: #{e.message}"
+    end
+    
+    def error_message(body, code)
+      begin
+        parsed = body && !body.strip.empty? ? JSON.parse(body) : nil
+        message = parsed.is_a?(Hash) ? (parsed['message'] || parsed['error'] || parsed['errors'] || parsed.to_s) : body.to_s
+      rescue JSON::ParserError
+        message = body.to_s
+      end
+      "HTTP #{code}: #{message}"
+    end
+
+    def extract_numeric(value)
+      return nil if value.nil?
+      return value if value.is_a?(Integer)
+      return value.to_i if value.is_a?(String) && value.to_s =~ /\A\d+\z/
+      nil
+    end
+  end
+end

data/lib/milady_cima_api/errors.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module MiLadyCimaApi
+  # Base error class for all API-related errors
+  class Error < StandardError; end
+
+  # Raised when the API returns 401 Unauthorized
+  class UnauthorizedError < Error; end
+
+  # Raised when the API returns 404 Not Found
+  class NotFoundError < Error; end
+
+  # Raised when the API returns 4xx errors other than 401/404
+  class ClientError < Error; end
+
+  # Raised when the API returns 5xx errors
+  class ServerError < Error; end
+
+  # Raised when the response cannot be parsed or is otherwise invalid
+  class ResponseError < Error; end
+end

data/lib/milady_cima_api/resources/courses.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'json'
+
+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
+
+      # 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
+      # @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)
+        @client.get('/courses', params: params)
+      end
+
+      # Convenience: List courses by organization
+      # @param organization_id [Integer, String]
+      # @param extra_params [Hash] Additional query params (e.g., pagination)
+      # @return [Array, Hash]
+      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))
+      end
+
+      # Convenience: List courses filtered by created_at with comparison operator
+      # @param created_at [String, Time] ISO8601 string or Time
+      # @param op [String] One of 'gt' or 'lt'
+      # @param organization_id [Integer, String, nil] Optional extra filter combined with AND
+      # @param extra_params [Hash]
+      # @return [Array, Hash]
+      def by_created_at(created_at:, op:, organization_id: nil, **extra_params)
+        raise ArgumentError, "op must be 'gt' or 'lt'" unless %w[gt lt].include?(op.to_s)
+        ts = created_at.is_a?(Time) ? created_at.utc.iso8601(3) : created_at.to_s
+        time_filter = { op.to_s => { 'metadata.created_at' => ts } }
+
+        filter = if organization_id.nil?
+                   { 'and' => [time_filter] }
+                 else
+                   { 'and' => [time_filter, { 'organization_id' => organization_id }] }
+                 end
+
+        list({ '$filter' => filter }.merge(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
+      end
+    end
+  end
+end

data/lib/milady_cima_api/resources/organizations.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module MiLadyCimaApi
+  module Resources
+    # Organizations resource exposes endpoints under /organizations
+    class Organizations
+      # @param client [MiLadyCimaApi::Client]
+      def initialize(client)
+        @client = client
+      end
+
+      # List organizations.
+      #
+      # GET /organizations
+      # @param params [Hash] Optional query params (e.g., pagination)
+      # @return [Array, Hash] Parsed JSON response from the API
+      # @raise [MiLadyCimaApi::UnauthorizedError, MiLadyCimaApi::NotFoundError, MiLadyCimaApi::ClientError, MiLadyCimaApi::ServerError]
+      def list(params = {})
+        @client.get('/organizations', params: params)
+      end
+    end
+  end
+end

data/lib/milady_cima_api/resources/users.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module MiLadyCimaApi
+  module Resources
+    # Users resource exposes endpoints under /users
+    class Users
+      # @param client [MiLadyCimaApi::Client]
+      def initialize(client)
+        @client = client
+      end
+
+      # List users.
+      #
+      # GET /users
+      # @param params [Hash] Optional query params (e.g., pagination)
+      # @return [Array, Hash] Parsed JSON response from the API
+      # @raise [MiLadyCimaApi::UnauthorizedError, MiLadyCimaApi::NotFoundError, MiLadyCimaApi::ClientError, MiLadyCimaApi::ServerError]
+      def list(params = {})
+        @client.get('/users', params: params)
+      end
+
+      # List users by organization.
+      #
+      # GET /users with organization filter
+      # @param organization_id [String, Integer] Organization ID to filter by
+      # @param role [String, nil] Optional role to filter by (e.g., 'Learner')
+      # @param params [Hash] Optional additional query params (e.g., pagination)
+      # @return [Array, Hash] Parsed JSON response from the API
+      # @raise [MiLadyCimaApi::UnauthorizedError, MiLadyCimaApi::NotFoundError, MiLadyCimaApi::ClientError, MiLadyCimaApi::ServerError]
+      def list_by_organization(organization_id, role: nil, **params)
+        filter = build_organization_filter(organization_id, role: role)
+        @client.get('/users', params: params.merge('$filter': filter))
+      end
+
+      # List learners by organization.
+      #
+      # GET /users with organization and Learner role filter
+      # @param organization_id [String, Integer] Organization ID to filter by
+      # @param params [Hash] Optional additional query params (e.g., pagination)
+      # @return [Array, Hash] Parsed JSON response from the API
+      # @raise [MiLadyCimaApi::UnauthorizedError, MiLadyCimaApi::NotFoundError, MiLadyCimaApi::ClientError, MiLadyCimaApi::ServerError]
+      def list_learners_by_organization(organization_id, **params)
+        list_by_organization(organization_id, role: 'Learner', **params)
+      end
+
+      private
+
+      # Build filter object for organization and optional role
+      # @param organization_id [String, Integer]
+      # @param role [String, nil]
+      # @return [Hash] Filter hash
+      def build_organization_filter(organization_id, role: nil)
+        conditions = [{ eq: { organization_id: organization_id } }]
+        conditions << { contains: { roles: role } } if role
+
+        { and: conditions }
+      end
+    end
+  end
+end

data/lib/milady_cima_api/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MiLadyCimaApi
+  # Gem version
+  VERSION = "0.1.0"
+end

data/lib/milady_cima_api.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "milady_cima_api/version"
+require_relative "milady_cima_api/errors"
+require_relative "milady_cima_api/client"
+require_relative "milady_cima_api/resources/users"
+require_relative "milady_cima_api/resources/organizations"
+require_relative "milady_cima_api/resources/courses"
+
+# MiLadyCimaApi is the top-level namespace for the MiLady CIMA API Ruby client.
+# It provides a simple, resource-oriented interface for interacting with the
+# MiLady CIMA API v3.
+module MiLadyCimaApi
+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

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: milady-cima-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- marcus.salinas
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-10-22 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.
+email:
+- 12.marcus.salinas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.test.example"
+- ".junie/guidelines.md"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/milady_cima_api.rb
+- lib/milady_cima_api/client.rb
+- lib/milady_cima_api/errors.rb
+- lib/milady_cima_api/resources/courses.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
+metadata:
+  allowed_push_host: https://rubygems.org
+  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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for the MiLady CIMA API.
+test_files: []