rujira 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0134685b3295946f3e1ae11f3f8f60cb7ef438d67d6c6c93efdf48419f46799
-  data.tar.gz: 3d7503722d60837598dbf4cf938825cf44d8dea497cc5b40d87337887cf43536
+  metadata.gz: ab245fcbc9d445b1ffa59c05d66e2b330375f9883d7e8949a4205af02f495824
+  data.tar.gz: 3f7d40b25d30fe5b6f966de78d283604f1d66c23cd9d34c3f433c5f722a7c103
 SHA512:
-  metadata.gz: 0cfb4598d5b97fbde72b2fef4bf3d2521b4a4009dc979242faa4db7da98673d13a0b8e65466cb815561e04cdce9cba6d1c353dae7403b6e4f26cca5ee924e0ed
-  data.tar.gz: 2668993188f71529679ffa8812216729932d161f2def80f4df0566dc31023aad2b293b2539783394bc67e39a6bfd2d81cdc4785a00e6d766772c8b541707e114
+  metadata.gz: c90e9d4ac246ec1c39a42dc618450bd6d8a3bda5e8095edb229919b2a5fc89d001c72a986d4c1465d9155ff64785f0439591e37fce9f79041611f231719e6a8f
+  data.tar.gz: ec925b95ca7d73c228cde2b543ef77eee66b049614d3665f66cdc4f7af6913b1ac041581266094daaa645c03df86c4e188a5cd3b58818b01055b4abba9ac5238

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [0.5.1] - 2025-09-15
+
+### 🚜 Refactor
+
+- Added logger
+- Cleanup
+
+### 📚 Documentation
+
+- Updated a doc
+## [0.5.0] - 2025-09-15
+
+### 🚀 Features
+
+- Dispatchable for client
 ## [0.4.0] - 2025-09-13
 
 ### 🚀 Features
@@ -67,19 +82,3 @@
 ### Reafactor
 
 - How to search sprints
-## [0.2.0] - 2025-09-11
-
-### 🚀 Features
-
-- Added new method for API
-
-### 📚 Documentation
-
-- Update README
-## [0.1.15] - 2025-09-11
-
-### 🚜 Refactor
-
-- Docs
-- BUILDER
-- RAKE TASKS

data/README.md

@@ -94,14 +94,8 @@ end
 update = client.Sprint.update sprint['id'] do
   payload name: "Bot Sprint #{project}"
 end
-
-assert_equal 'Bot Sprint', sprint['name']
-assert_equal "Bot Sprint #{project}", update['name']
-
 issues = client.Sprint.get_issue sprint['id']
 
-assert_not_empty issues['issues']
-
 client.Issue.get "#{project}-1"
 
 client.Issue.watchers "#{project}-1", name

data/compose.yaml

@@ -2,7 +2,7 @@
 services:
   jira:
     restart: always
-    # mem_limit: 1g
+    mem_limit: 2g
     image: atlassian/jira-software
     environment: {}
       # JVM_SUPPORT_RECOMMENDED_ARGS: "-Datlassian.recovery.password=<PASSWORD>"

data/examples/create_issue_in_sprint.rb

@@ -5,9 +5,11 @@ require_relative '../lib/rujira'
 
 Dotenv.load
 
-client = Rujira::Client.new('http://localhost:8080')
+client = Rujira::Client.new('http://localhost:8080', dispatchable: true)
 
 project_name = 'EXAMPLE2'
+myself = client.Myself.get
+
 name = client.Myself.get['name']
 
 begin

data/lib/rujira/api/application_properties.rb

@@ -3,25 +3,41 @@
 module Rujira
   module Api
     # Provides access to Jira application properties via the REST API.
-    # Allows listing, retrieving, updating, and accessing advanced settings.
+    # You can list all properties, filter them with query parameters,
+    # update specific properties, and access advanced settings.
     #
     # API reference:
     # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/application-properties
     #
     class ApplicationProperties < Common
-      # Retrieves all application properties.
+      # Retrieves application properties.
       #
+      # @param [Hash] params Optional query parameters:
+      #   - :key [String] Return property with a specific key.
+      #   - :permissionLevel [String] Restrict results by permission level (SYSADMIN, ADMIN, USER).
+      #   - :keyFilter [String] Return properties matching a wildcard filter (e.g. "jira.option*").
       # @yield [builder] Optional block to configure the request.
-      # @return [Object] The API response containing all properties.
+      # @return [Object] The API response containing properties.
       #
       # @example List all application properties
-      #   client.application_properties.list
+      #   client.ApplicationProperties.list
       #
-      def list
+      # @example Filter by key
+      #   client.ApplicationProperties.list do
+      #     params key: "jira.lf.date.format"
+      #   end
+      #
+      # @example Filter by permission level
+      #   client.ApplicationProperties.list do
+      #     params permissionLevel: "SYSADMIN"
+      #   end
+      #
+      def list(&block)
         builder do
           path 'application-properties'
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       alias get list
@@ -33,7 +49,7 @@ module Rujira
       # @return [Object] The API response after updating the property.
       #
       # @example Update an application property
-      #   client.application_properties.set("jira.option.someFeature") do
+      #   client.ApplicationProperties.set("jira.option.allowattachments") do
       #     payload value: true
       #   end
       #
@@ -43,7 +59,7 @@ module Rujira
           path "application-properties/#{id}"
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Retrieves advanced application settings.
@@ -52,13 +68,14 @@ module Rujira
       # @return [Object] The API response containing advanced settings.
       #
       # @example Get advanced settings
-      #   client.application_properties.advanced_settings
+      #   client.ApplicationProperties.advanced_settings
       #
-      def advanced_settings
+      def advanced_settings(&block)
         builder do
           path 'application-properties/advanced-settings'
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
     end
   end

data/lib/rujira/api/applicationrole.rb

@@ -15,7 +15,7 @@ module Rujira
       # @return [Object] The API response after updating roles.
       #
       # @example Bulk update roles
-      #   client.Application_role.put_bulk do
+      #   client.ApplicationRole.put_bulk do
       #     payload [
       #       { key: "jira-software-users", groups: ["jira-users"] },
       #       { key: "jira-administrators", groups: ["admins"] }
@@ -28,7 +28,7 @@ module Rujira
           path 'applicationrole'
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Lists all application roles.
@@ -37,13 +37,14 @@ module Rujira
       # @return [Object] The API response containing all application roles.
       #
       # @example List all application roles
-      #   client.Application_role.list
+      #   client.ApplicationRole.list
       #
-      def list
+      def list(&block)
         builder do
           path 'applicationrole'
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Retrieves a specific application role by key.
@@ -52,13 +53,14 @@ module Rujira
       # @return [Object] The API response containing role details.
       #
       # @example Get a role
-      #   client.Application_role.get("jira-software-users")
+      #   client.ApplicationRole.get("jira-software-users")
       #
-      def get(key)
+      def get(key, &block)
         builder do
           path "applicationrole/#{key}"
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Updates a specific application role by key.
@@ -68,7 +70,7 @@ module Rujira
       # @return [Object] The API response after updating the role.
       #
       # @example Update a role
-      #   client.Application_role.put("jira-software-users") do
+      #   client.ApplicationRole.put("jira-software-users") do
       #     payload groups: ["jira-users", "new-group"]
       #   end
       #
@@ -78,7 +80,7 @@ module Rujira
           path "applicationrole/#{key}"
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
     end
   end

data/lib/rujira/api/attachments.rb

@@ -2,42 +2,48 @@
 
 module Rujira
   module Api
-    # This class provides methods to manage Jira issue attachments via the REST API.
-    # Currently, it supports creating (uploading) attachments for a given issue ID or key.
-    # Example: Attach a file to an issue by calling `create("ISSUE-123", "/path/to/file")`.
-    # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/issue/%7BissueIdOrKey%7D/attachments
+    # Provides methods to manage Jira issue attachments via the REST API.
+    # Supports retrieving, deleting, and accessing metadata of attachments.
+    #
+    # API reference:
+    # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/attachment
+    #
     class Attachments < Common
       # Retrieves a specific attachment by ID.
       #
       # @param [String] id The attachment ID.
+      # @yield [builder] Optional block to configure the request.
       # @return [Object] The API response containing attachment details.
       #
       # @example Get an attachment
-      #   client.attachments.get("10001")
+      #   client.Attachments.get("10001")
       #
-      def get(id)
+      def get(id, &block)
         abort 'Attachment ID is required' if id.to_s.strip.empty?
         builder do
           path "attachment/#{id}"
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Deletes a specific attachment by ID.
       #
       # @param [String] id The attachment ID.
+      # @yield [builder] Optional block to configure the request.
       # @return [Object] The API response after deletion.
       #
       # @example Delete an attachment
-      #   client.attachments.delete("10001")
+      #   client.Attachments.delete("10001")
       #
-      def delete(id)
+      def delete(id, &block)
         abort 'Attachment ID is required' if id.to_s.strip.empty?
         builder do
           method :delete
           path "attachment/#{id}"
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Retrieves metadata for attachments.
@@ -46,13 +52,14 @@ module Rujira
       # @return [Object] The API response containing attachment metadata.
       #
       # @example Get attachment metadata
-      #   client.attachments.meta
+      #   client.Attachments.meta
       #
-      def meta
+      def meta(&block)
         builder do
           path 'attachment/meta'
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
     end
   end

data/lib/rujira/api/avatar.rb

@@ -12,16 +12,18 @@ module Rujira
       # Retrieves all system avatars of a given type.
       #
       # @param [String] type The type of avatar (e.g., "project", "user").
+      # @yield [builder] Optional block to configure the request.
       # @return [Object] The API response containing system avatars.
       #
       # @example Get system avatars for projects
       #   client.Avatar.get("project")
       #
-      def get(type)
+      def get(type, &block)
         builder do
           path "avatar/#{type}/system"
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Uploads a temporary avatar for a given type.
@@ -41,7 +43,7 @@ module Rujira
           path "avatar/#{type}/temporary"
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Crops a previously uploaded temporary avatar.
@@ -52,7 +54,7 @@ module Rujira
       #
       # @example Crop a temporary avatar
       #   client.Avatar.crop("project") do
-      #     payload { x: 0, y: 0, width: 48, height: 48 }
+      #     payload x: 0, y: 0, width: 48, height: 48
       #   end
       #
       def crop(type, &block)
@@ -61,7 +63,7 @@ module Rujira
           path "avatar/#{type}/temporaryCrop"
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
     end
   end

data/lib/rujira/api/board.rb

@@ -3,7 +3,10 @@
 module Rujira
   module Api
     # Provides access to Jira Agile board resources via the REST API.
-    # API reference: https://docs.atlassian.com/jira-software/REST/9.17.0/#agile/1.0/board
+    # Allows retrieving boards, board details, and sprints.
+    #
+    # API reference:
+    # https://docs.atlassian.com/jira-software/REST/9.17.0/#agile/1.0/board
     #
     class Board < Common
       # Initializes a new Board API client.
@@ -20,38 +23,69 @@ module Rujira
       # Retrieves details for a specific board by its ID.
       #
       # @param [Integer, String] id The board ID.
+      # @yield [builder] Optional block to configure the request.
       # @return [Object] The API response containing board details.
       #
-      def get(id)
+      # @example Get board details
+      #   client.Board.get(123)
+      #
+      def get(id, &block)
         abort 'Board ID is required' if id.to_s.strip.empty?
         builder do
           path "board/#{id}"
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Lists all boards visible to the current user.
       #
+      # Available query parameters:
+      # - `startAt` [Integer]: The index of the first item to return (pagination).
+      # - `maxResults` [Integer]: The maximum number of items to return.
+      # - `type` [String]: Filters boards by type ("scrum" or "kanban").
+      # - `name` [String]: Filters boards by name.
+      # - `projectKeyOrId` [String]: Filters boards by associated project.
+      #
+      # @yield [builder] Optional block to configure query parameters.
       # @return [Object] The API response containing a list of boards.
       #
-      def list
+      # @example List boards with pagination
+      #   client.Board.list do
+      #     params startAt: 0, maxResults: 50
+      #   end
+      #
+      def list(&block)
         builder do
           path 'board'
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Retrieves all sprints for a specific board.
       #
+      # Available query parameters:
+      # - `state` [String]: Filters sprints by state ("future", "active", "closed").
+      # - `startAt` [Integer]: The index of the first item to return (pagination).
+      # - `maxResults` [Integer]: The maximum number of items to return.
+      #
       # @param [Integer, String] id The board ID.
+      # @yield [builder] Optional block to configure query parameters.
       # @return [Object] The API response containing sprints.
       #
-      def sprint(id)
+      # @example Get active sprints for a board
+      #   client.Board.sprint(123) do
+      #     params state: "active"
+      #   end
+      #
+      def sprint(id, &block)
         abort 'Board ID is required' if id.to_s.strip.empty?
         builder do
           path "board/#{id}/sprint"
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
     end
   end

data/lib/rujira/api/comment.rb

@@ -25,7 +25,7 @@ module Rujira
           method :post
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
     end
   end

data/lib/rujira/api/common.rb

@@ -13,9 +13,7 @@ module Rujira
       def initialize(client)
         # Store the passed client object in an instance variable for later use
         @client = client
-
-        # Configure requests using the client's builder DSL
-        @client.request.builder do
+        @request = Request.new.builder do
           # Set the Bearer token for authorization
           bearer @token
 
@@ -34,12 +32,21 @@ module Rujira
       #
       # @yield [builder] Optional block to configure the request builder.
       # @return [Object] The configured request builder stored in @request.
-      def builder(&block) = @client.request.builder(&block)
+      def builder(&block) = @request.builder(&block)
 
       # Executes the configured request.
       #
       # @return [Object] The API response after dispatching the request.
-      def run = @client.dispatch
+      def call
+        @client.logger.debug "Call the method: #{caller_locations(1, 1)[0].label}"
+        return @client.dispatch(@request) if @client.dispatchable
+
+        self
+      end
+
+      def commit
+        @client.dispatch(@request)
+      end
     end
   end
 end

data/lib/rujira/api/configuration.rb

@@ -3,6 +3,8 @@
 module Rujira
   module Api
     # Provides access to Jira configuration settings via the REST API.
+    # The configuration resource contains system-wide settings such as
+    # the base URL, time tracking configuration, attachment settings, etc.
     #
     # API reference:
     # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/configuration
@@ -10,17 +12,28 @@ module Rujira
     class Configuration < Common
       # Retrieves the current Jira configuration.
       #
+      # The response typically includes:
+      # - `timeTrackingConfiguration` (time tracking settings)
+      # - `attachmentsEnabled` (whether attachments are enabled)
+      # - `baseUrl` (the base URL of Jira)
+      #
       # @yield [builder] Optional block to configure the request.
       # @return [Object] The API response containing configuration details.
       #
       # @example Get Jira configuration
       #   client.Configuration.get
       #
-      def get
+      # @example With a block (adding custom headers)
+      #   client.Configuration.get do
+      #     headers "X-Experimental-API" => "true"
+      #   end
+      #
+      def get(&block)
         builder do
           path 'configuration'
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
     end
   end

data/lib/rujira/api/custom_fields.rb

@@ -9,22 +9,35 @@ module Rujira
     # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/customFields
     #
     class CustomFields < Common
-      # Retrieves all custom fields.
+      # Retrieves all custom fields in Jira.
       #
-      # @yield [builder] Optional block to configure the request.
-      # @return [Object] The API response containing all custom fields.
+      # The response typically contains:
+      # - `id` (e.g., "customfield_10001")
+      # - `name` (field display name)
+      # - `schema` (field type and configuration)
+      #
+      # @yield [builder] Optional block to configure the request (e.g., add query parameters).
+      # @return [Object] The API response containing an array of custom fields.
       #
       # @example Get all custom fields
       #   client.CustomFields.get
       #
-      def get
+      # @example With query parameters
+      #   client.CustomFields.get do
+      #     params maxResults: 50, startAt: 0
+      #   end
+      #
+      def get(&block)
         builder do
           path 'customFields'
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
-      # Deletes custom fields based on provided parameters.
+      # Deletes one or more custom fields by their IDs.
+      #
+      # The request must include `fieldIds` in the payload.
       #
       # @yield [builder] Block to configure the deletion payload or parameters.
       # @return [Object] The API response after deletion.
@@ -40,7 +53,7 @@ module Rujira
           path 'customFields'
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
     end
   end

data/lib/rujira/api/dashboard.rb

@@ -3,8 +3,9 @@
 module Rujira
   module Api
     # Provides access to Jira dashboards via the REST API.
+    #
     # API reference:
-    # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/myself
+    # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/dashboard
     #
     class Dashboard < Common
       # Retrieves a specific dashboard by its ID.
@@ -15,26 +16,39 @@ module Rujira
       # @example Get a dashboard by ID
       #   client.Dashboard.get(10001)
       #
-      def get(id)
+      def get(id, &block)
         abort 'Dashboard ID is required' if id.to_s.strip.empty?
         builder do
           path "dashboard/#{id}"
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Lists all dashboards visible to the current user.
       #
+      # Optional query parameters:
+      # - `startAt` [Integer] The index of the first dashboard to return (default: 0).
+      # - `maxResults` [Integer] The maximum number of dashboards to return (default: 20, max: 1000).
+      # - `filter` [String] A string to filter dashboards by name.
+      #
+      # @yield [builder] Optional block to configure query parameters.
       # @return [Object] The API response containing a list of dashboards.
       #
       # @example List dashboards
       #   client.Dashboard.list
       #
-      def list
+      # @example List dashboards with pagination
+      #   client.Dashboard.list do
+      #     params startAt: 20, maxResults: 50
+      #   end
+      #
+      def list(&block)
         builder do
           path 'dashboard'
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
     end
   end