rujira 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe3605d3169c9d351d102aac1f818d45248668dbfebfde6ed50efad8185d67ec
-  data.tar.gz: 36d1b09cc7bb319c25a006135d149aa634ba1a86f60fbcef030fda6e518673d0
+  metadata.gz: 8b6d18c441bf30cd86f00a38ccb4a2be266fdbc3aa312f607292d6a7d25d0a26
+  data.tar.gz: 326fb2ea52c1cb8f41f0c7ecfb9e511b325315c6f0bc89df5bc4a8ce4f13edb6
 SHA512:
-  metadata.gz: d14e41226a19f4aec0f4bc56ccf60642c37fd6e3c08bda3871655e7bae9e45e67bd8ef8870049493938680b8ad6aed073cc5cb83fadc7fa9829b2a3e491d05dd
-  data.tar.gz: b7e70af74ed15946de2d724dbfa0d654a4f4698b7626f1db931f16c2711b3f6cd68a8671727aaaae27bdb34c8549687af67bd516e324e56cfb02420e3962e5cf
+  metadata.gz: 4a3c6713caa660260b313a2cd6f3727ba831a7ace828a2fa1f55ae9e827b31a18854abd9f66c06014f07845dd12cbe439bd70d4c4d78ea5f40a847bd0fffe5cb
+  data.tar.gz: '0498ad7989466f66ddb76bd02e793e5ac2905d843db1101f14a3502487bb2efd51effa7f9836c51cf51a8ae4bf5173557daa6ab07b893cd9ad78370bd4aa0c9d'

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [0.3.4] - 2025-09-13
+
+### 🐛 Bug Fixes
+
+- Fix for tasks
+## [0.3.3] - 2025-09-13
+
+### 📚 Documentation
+
+- Added comments from ai #4
+- Added comments from ai #3
+- Added comments from ai #2
+- Added comments from ai
 ## [0.3.2] - 2025-09-13
 
 ### 🚜 Refactor
@@ -70,12 +83,6 @@
 
 - Remove debug line
 
-### ITMG
-
-- Work with missing methods
-- Rewrite tasks for gem
-- Added project create entrypoint
-
 ### Reafactor
 
 - Full

data/lib/rujira/api/attachments.rb

@@ -2,10 +2,18 @@
 
 module Rujira
   module Api
-    # TODO: add docs
-    # Some description
+    # 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
     class Attachments < Common
+      # Uploads a file as an attachment to the specified Jira issue.
+      #
+      # @param [String] id_or_key The issue ID or key to which the file will be attached.
+      # @param [String] path The local file path of the attachment to upload.
+      # @yield [builder] Optional block to customize the request builder.
+      # @return [Object] The API response after executing the request.
+      #
       def create(id_or_key, path, &block)
         abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
         client = @client

data/lib/rujira/api/board.rb

@@ -2,10 +2,14 @@
 
 module Rujira
   module Api
-    # TODO: add docs
-    # Some description
-    # https://docs.atlassian.com/jira-software/REST/9.17.0/#agile/1.0/board
+    # 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
+    #
     class Board < Common
+      # Initializes a new Board API client.
+      #
+      # @param [Object] client The HTTP client instance used to perform requests.
+      #
       def initialize(client)
         super
         builder do
@@ -13,6 +17,11 @@ module Rujira
         end
       end
 
+      # Retrieves details for a specific board by its ID.
+      #
+      # @param [Integer, String] id The board ID.
+      # @return [Object] The API response containing board details.
+      #
       def get(id)
         abort 'Board ID is required' if id.to_s.strip.empty?
         builder do
@@ -21,6 +30,10 @@ module Rujira
         run
       end
 
+      # Lists all boards visible to the current user.
+      #
+      # @return [Object] The API response containing a list of boards.
+      #
       def list
         builder do
           path 'board'
@@ -28,6 +41,11 @@ module Rujira
         run
       end
 
+      # Retrieves all sprints for a specific board.
+      #
+      # @param [Integer, String] id The board ID.
+      # @return [Object] The API response containing sprints.
+      #
       def sprint(id)
         abort 'Board ID is required' if id.to_s.strip.empty?
         builder do

data/lib/rujira/api/comment.rb

@@ -2,10 +2,22 @@
 
 module Rujira
   module Api
-    # TODO: add docs
-    # Some description
+    # Provides access to Jira issue comments via the REST API.
+    # API reference:
     # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/comment/%7BcommentId%7D/properties
+    #
     class Comment < Common
+      # Creates a new comment for the specified Jira issue.
+      #
+      # @param [String] id_or_key The issue ID or key where the comment will be added.
+      # @yield [builder] Optional block to customize the request payload (e.g., setting comment body).
+      # @return [Object] The API response containing the created comment.
+      #
+      # @example Create a comment with body text
+      #   client.Comment.create("ISSUE-123") do
+      #     payload body: "This is a test comment"
+      #   end
+      #
       def create(id_or_key, &block)
         abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
         builder do

data/lib/rujira/api/common.rb

@@ -2,9 +2,14 @@
 
 module Rujira
   module Api
-    # TODO: add docs
-    # Some description
+    # Base class for Jira API resources.
+    # Provides common request setup, authorization, and request execution.
+    #
     class Common
+      # Initializes a new API resource.
+      #
+      # @param [Object] client The HTTP client instance used to build and dispatch requests.
+      #
       def initialize(client)
         # Store the passed client object in an instance variable for later use
         @client = client
@@ -31,8 +36,9 @@ module Rujira
       # @return [Object] The configured request builder stored in @request.
       def builder(&block) = @client.request.builder(&block)
 
-      # Delegate execution to the client's dispatch method
-      # This triggers the configured request to be sent
+      # Executes the configured request.
+      #
+      # @return [Object] The API response after dispatching the request.
       def run = @client.dispatch
     end
   end

data/lib/rujira/api/dashboard.rb

@@ -2,10 +2,19 @@
 
 module Rujira
   module Api
-    # TODO: add docs
-    # Some description
+    # 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
+    #
     class Dashboard < Common
+      # Retrieves a specific dashboard by its ID.
+      #
+      # @param [Integer, String] id The dashboard ID.
+      # @return [Object] The API response containing dashboard details.
+      #
+      # @example Get a dashboard by ID
+      #   client.Dashboard.get(10001)
+      #
       def get(id)
         abort 'Dashboard ID is required' if id.to_s.strip.empty?
         builder do
@@ -14,6 +23,13 @@ module Rujira
         run
       end
 
+      # Lists all dashboards visible to the current user.
+      #
+      # @return [Object] The API response containing a list of dashboards.
+      #
+      # @example List dashboards
+      #   client.Dashboard.list
+      #
       def list
         builder do
           path 'dashboard'

data/lib/rujira/api/issue.rb

@@ -2,10 +2,26 @@
 
 module Rujira
   module Api
-    # TODO: add docs
-    # Some description
+    # Provides access to Jira issues via the REST API.
+    # API reference:
     # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/issue
+    #
     class Issue < Common
+      # Creates a new issue.
+      #
+      # @yield [builder] Optional block to configure the request payload.
+      # @return [Object] The API response containing the created issue.
+      #
+      # @example Create an issue
+      #   client.Issue.create do
+      #     payload fields: {
+      #       summary: "New bug report",
+      #       issuetype: { name: 'Task' },
+      #       project: { key: "TEST" },
+      #       description: 'This task was generated by the bot when creating changes in the repository.'
+      #     }
+      #   end
+      #
       def create(&block)
         builder do
           path 'issue'
@@ -15,6 +31,15 @@ module Rujira
         run
       end
 
+      # Retrieves an issue by its ID or key.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing the issue details.
+      #
+      # @example Get an issue
+      #   client.Issue.get("TEST-123")
+      #
       def get(id_or_key, &block)
         abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
         builder do
@@ -24,6 +49,15 @@ module Rujira
         run
       end
 
+      # Deletes an issue by its ID or key.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response after deletion.
+      #
+      # @example Delete an issue
+      #   client.Issue.delete("TEST-123")
+      #
       def delete(id_or_key, &block)
         abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
         builder do
@@ -36,6 +70,17 @@ module Rujira
 
       alias del delete
 
+      # Updates an existing issue.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @yield [builder] Optional block to configure the update payload.
+      # @return [Object] The API response after updating the issue.
+      #
+      # @example Edit an issue
+      #   client.Issue.edit("TEST-123") do
+      #     payload fields: { summary: "Updated summary" }
+      #   end
+      #
       def edit(id_or_key, &block)
         abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
         builder do
@@ -46,11 +91,32 @@ module Rujira
         run
       end
 
+      # Adds a comment to an issue.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @yield [builder] Optional block to configure the comment payload.
+      # @return [Object] The API response containing the created comment.
+      #
+      # @example Add a comment
+      #   client.Issue.comment("TEST-123") do
+      #     payload body: "This is a comment"
+      #   end
+      #
       def comment(id_or_key, &block)
         abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
         @client.Comment.create id_or_key, &block
       end
 
+      # Adds a watcher to an issue.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @param [String] name The username to add as a watcher.
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response after adding the watcher.
+      #
+      # @example Add a watcher
+      #   client.Issue.watchers("TEST-123", "johndoe")
+      #
       def watchers(id_or_key, name, &block)
         abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
         builder do
@@ -62,6 +128,16 @@ module Rujira
         run
       end
 
+      # Uploads an attachment to an issue.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @param [String] path The local file path of the attachment.
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing the uploaded attachment.
+      #
+      # @example Upload an attachment
+      #   client.Issue.attachments("TEST-123", "/tmp/file.txt")
+      #
       def attachments(id_or_key, path, &block)
         abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
         @client.Attachments.create id_or_key, path, &block

data/lib/rujira/api/myself.rb

@@ -2,10 +2,20 @@
 
 module Rujira
   module Api
-    # TODO: add docs
-    # Some description
+    # Provides access to the Jira "Myself" resource via the REST API.
+    # Allows retrieving details about the currently authenticated user.
+    #
+    # API reference:
     # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/myself
+    #
     class Myself < Common
+      # Retrieves details of the currently authenticated user.
+      #
+      # @return [Object] The API response containing user details.
+      #
+      # @example Get current user details
+      #   client.Myself.get
+      #
       def get
         builder do
           path 'myself'

data/lib/rujira/api/project.rb

@@ -2,10 +2,27 @@
 
 module Rujira
   module Api
-    # TODO: add docs
-    # Some description
+    # Provides access to Jira projects via the REST API.
+    #
+    # API reference:
     # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/project
+    #
     class Project < Common
+      # Creates a new project.
+      #
+      # @yield [builder] Optional block to configure the request payload.
+      # @return [Object] The API response containing the created project.
+      #
+      # @example Create a project
+      #   client.Project.create do
+      #     payload {
+      #       key: "TEST",
+      #       name: "Test Project",
+      #       projectTypeKey: "software",
+      #       projectTemplateKey: "com.atlassian.jira-core-project-templates:jira-core-project-management"
+      #     }
+      #   end
+      #
       def create(&block)
         builder do
           path 'project'
@@ -15,6 +32,17 @@ module Rujira
         run
       end
 
+      # Updates an existing project.
+      #
+      # @param [String] id_or_key The project ID or key.
+      # @yield [builder] Optional block to configure the update payload.
+      # @return [Object] The API response after updating the project.
+      #
+      # @example Update a project
+      #   client.Project.edit("TEST") do
+      #     payload { name: "Renamed Project" }
+      #   end
+      #
       def edit(id_or_key, &block)
         abort 'Project ID or KEY is required' if id_or_key.to_s.strip.empty?
         builder do
@@ -25,6 +53,15 @@ module Rujira
         run
       end
 
+      # Retrieves a specific project by ID or key.
+      #
+      # @param [String] id_or_key The project ID or key.
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing project details.
+      #
+      # @example Get a project
+      #   client.Project.get("TEST")
+      #
       def get(id_or_key, &block)
         abort 'Project ID or KEY is required' if id_or_key.to_s.strip.empty?
         builder do
@@ -34,6 +71,14 @@ module Rujira
         run
       end
 
+      # Lists all projects visible to the current user.
+      #
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing the list of projects.
+      #
+      # @example List projects
+      #   client.Project.list
+      #
       def list(&block)
         builder do
           path 'project'
@@ -42,6 +87,14 @@ module Rujira
         run
       end
 
+      # Deletes a project by ID or key.
+      #
+      # @param [String] id_or_key The project ID or key.
+      # @return [Object] The API response after deletion.
+      #
+      # @example Delete a project
+      #   client.Project.delete("TEST")
+      #
       def delete(id_or_key)
         abort 'Project ID or KEY is required' if id_or_key.to_s.strip.empty?
         builder do
@@ -51,6 +104,15 @@ module Rujira
         run
       end
 
+      # Retrieves the security levels for a specific project.
+      #
+      # @param [String] id_or_key The project ID or key.
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing security levels.
+      #
+      # @example Get project security levels
+      #   client.Project.securitylevel("TEST")
+      #
       def securitylevel(id_or_key, &block)
         abort 'Project ID or KEY is required' if id_or_key.to_s.strip.empty?
         builder do

data/lib/rujira/api/search.rb

@@ -2,10 +2,24 @@
 
 module Rujira
   module Api
-    # TODO: add docs
-    # Some description
+    # Provides access to Jira issue search via the REST API.
+    # Allows searching for issues using JQL (Jira Query Language).
+    #
+    # API reference:
     # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/search
+    #
     class Search < Common
+      # Executes a search query against Jira issues.
+      #
+      # @yield [builder] Optional block to configure the request payload
+      #   (e.g., provide JQL, fields, pagination).
+      # @return [Object] The API response containing matching issues.
+      #
+      # @example Search issues with JQL
+      #   client.Search.get do
+      #     payload jql: "project = TEST AND status = 'To Do'", maxResults: 10
+      #   end
+      #
       def get(&block)
         builder do
           path 'search'

data/lib/rujira/api/server_info.rb

@@ -2,10 +2,20 @@
 
 module Rujira
   module Api
-    # TODO: add docs
-    # Some description
+    # Provides access to Jira server information via the REST API.
+    # Retrieves details about the Jira server instance, including version and build info.
+    #
+    # API reference:
     # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/serverInfo
+    #
     class ServerInfo < Common
+      # Retrieves Jira server information.
+      #
+      # @return [Object] The API response containing server details.
+      #
+      # @example Get server info
+      #   client.Server_info.get
+      #
       def get
         builder do
           path 'serverInfo'

data/lib/rujira/api/sprint.rb

@@ -2,10 +2,17 @@
 
 module Rujira
   module Api
-    # TODO: add docs
-    # Some description
+    # Provides access to Jira sprints via the Agile REST API.
+    # Allows creating, updating, retrieving, and managing sprints and their issues.
+    #
+    # API reference:
     # https://docs.atlassian.com/jira-software/REST/9.17.0/#agile/1.0/sprint
+    #
     class Sprint < Common
+      # Initializes a new Sprint API client.
+      #
+      # @param [Object] client The HTTP client instance used to perform requests.
+      #
       def initialize(client)
         super
         builder do
@@ -13,6 +20,16 @@ module Rujira
         end
       end
 
+      # Creates a new sprint.
+      #
+      # @yield [builder] Optional block to configure the sprint payload.
+      # @return [Object] The API response containing the created sprint.
+      #
+      # @example Create a sprint
+      #   client.Sprint.create do
+      #     payload name: "Sprint 1", startDate: "2025-09-01", endDate: "2025-09-14", originBoardId: 1
+      #   end
+      #
       def create(&block)
         builder do
           path 'sprint'
@@ -23,6 +40,17 @@ module Rujira
         run
       end
 
+      # Updates an existing sprint partially.
+      #
+      # @param [Integer] id The sprint ID.
+      # @yield [builder] Block to configure update payload (required).
+      # @return [Object] The API response after updating the sprint.
+      #
+      # @example Update sprint
+      #   client.Sprint.update(1) do
+      #     payload name: "Updated Sprint Name"
+      #   end
+      #
       def update(id, &block)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
         raise ArgumentError, 'block is required' unless block
@@ -31,11 +59,22 @@ module Rujira
           path "sprint/#{id}"
           headers 'Content-Type': 'application/json', Accept: 'application/json'
           method :post
-          instance_eval(&block) if block_given?
+          instance_eval(&block)
         end
         run
       end
 
+      # Replaces an existing sprint.
+      #
+      # @param [Integer] id The sprint ID.
+      # @yield [builder] Block to configure replace payload (required).
+      # @return [Object] The API response after replacing the sprint.
+      #
+      # @example Replace sprint
+      #   client.Sprint.replace(1) do
+      #     payload name: "New Sprint Name", startDate: "2025-09-01", endDate: "2025-09-14"
+      #   end
+      #
       def replace(id, &block)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
         raise ArgumentError, 'block is required' unless block
@@ -44,11 +83,16 @@ module Rujira
           path "sprint/#{id}"
           headers 'Content-Type': 'application/json', Accept: 'application/json'
           method :put
-          instance_eval(&block) if block_given?
+          instance_eval(&block)
         end
         run
       end
 
+      # Retrieves details of a specific sprint.
+      #
+      # @param [Integer] id The sprint ID.
+      # @return [Object] The API response containing sprint details.
+      #
       def get(id)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
         builder do
@@ -57,6 +101,11 @@ module Rujira
         run
       end
 
+      # Retrieves all issues in a sprint.
+      #
+      # @param [Integer] id The sprint ID.
+      # @return [Object] The API response containing issues.
+      #
       def get_issue(id)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
         builder do
@@ -65,6 +114,11 @@ module Rujira
         run
       end
 
+      # Deletes a sprint.
+      #
+      # @param [Integer] id The sprint ID.
+      # @return [Object] The API response after deletion.
+      #
       def delete(id)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
         builder do
@@ -74,6 +128,11 @@ module Rujira
         run
       end
 
+      # Retrieves all properties of a sprint.
+      #
+      # @param [Integer] id The sprint ID.
+      # @return [Object] The API response containing sprint properties.
+      #
       def properties(id)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
         builder do
@@ -82,6 +141,15 @@ module Rujira
         run
       end
 
+      # Adds issues to a sprint.
+      #
+      # @param [Integer] id The sprint ID.
+      # @param [Array<Integer>] issues List of issue IDs to add to the sprint.
+      # @return [Object] The API response after adding issues.
+      #
+      # @example Add issues to a sprint
+      #   client.Sprint.issue(1, [101, 102])
+      #
       def issue(id, issues)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
         builder do

data/lib/rujira/client.rb

@@ -1,17 +1,40 @@
 # frozen_string_literal: true
 
 module Rujira
-  # TODO: add docs
-  # Some description
+  # Main Jira API client.
+  # Provides access to Jira resources via method_missing delegation to API classes.
+  #
+  # Example:
+  #   client = Rujira::Client.new("https://jira.example.com")
+  #   client.issue.get("TEST-123")
+  #
   class Client
+    # @return [Rujira::Request] The current request object being configured
     attr_accessor :request
 
+    # Initializes a new Jira client.
+    #
+    # @param [String] url Base URL of the Jira instance.
+    # @param [Boolean] debug Whether to enable debug logging. Can also be set via ENV['RUJIRA_DEBUG'].
+    #
+    # @example Initialize client
+    #   client = Rujira::Client.new("https://jira.example.com", debug: true)
+    #
     def initialize(url, debug: false)
       @uri = URI(url)
       @debug = ENV.fetch('RUJIRA_DEBUG', debug.to_s) == 'true'
       @request = Request.new
     end
 
+    # Dynamically instantiates the appropriate API resource class.
+    #
+    # @param [Symbol] method_name Name of the API resource (e.g., :issue, :project)
+    # @param [...] args Arguments passed to the resource class constructor
+    # @return [Object] An instance of the corresponding API resource class
+    #
+    # @example Access an API resource
+    #   client.issue.get("TEST-123")
+    #
     def method_missing(method_name, ...)
       resource_class = Rujira::Api.const_get(method_name.to_s)
       resource_class.new(self, ...)
@@ -19,19 +42,33 @@ module Rujira
       super
     end
 
+    # Options for Faraday connection.
+    #
+    # @return [Hash] Options including URL, headers, and params
+    #
     def options
       {
         url: @uri,
         headers: @request.headers,
         params: @request.params
-
       }
     end
 
+    # Checks if a resource class exists for method_missing.
+    #
+    # @param [Symbol] method_name Method name to check
+    # @param [Boolean] include_private Include private methods
+    # @return [Boolean] true if the resource exists, false otherwise
+    #
     def respond_to_missing?(method_name, include_private = false)
       Rujira::Api.const_defined?(method_name.to_s) || super
     end
 
+    # Executes the configured request.
+    #
+    # @return [Object] The API response body if successful
+    # @raise [RuntimeError] If the request fails or method is unsupported
+    #
     def dispatch # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
       unless %i[get delete head post put patch].include?(@request.method)
         raise "method #{@request.method} not supported"
@@ -49,6 +86,10 @@ module Rujira
       end
     end
 
+    # Builds the Faraday connection for HTTP requests.
+    #
+    # @return [Faraday::Connection] Configured Faraday connection
+    #
     def connection
       Faraday.new(options) do |builder|
         builder.request :authorization, *@request.authorization if @request.authorization
@@ -60,10 +101,20 @@ module Rujira
       end
     end
 
+    # Prepares a file for multipart upload.
+    #
+    # @param [String] path Path to the file
+    # @return [Faraday::Multipart::FilePart] File ready for upload
+    #
     def file(path)
       Faraday::Multipart::FilePart.new(path, 'multipart/form-data')
     end
 
+    # Generates mock JSON files for API responses (useful for caching or testing).
+    #
+    # @param [Object] res API response object
+    # @return [void]
+    #
     def generate_mocks(res)
       path = res.to_hash[:url].path
       cache_path = File.join('.cache', path)

data/lib/rujira/request.rb

@@ -3,11 +3,17 @@
 require 'fileutils'
 
 module Rujira
-  # TODO: add docs
-  # Some description
+  # Represents an HTTP request configuration for Jira API calls.
+  # Used internally by Rujira::Client to build requests with headers, params, payloads, and authorization.
+  #
   class Request
-    attr_reader :authorization, :options
+    # @return [Array, nil] Authorization information, e.g., Bearer token or basic auth credentials
+    attr_reader :authorization
+    # @return [Hash] Additional options for the request (currently unused)
+    attr_reader :options
 
+    # Initializes a new request object with default values.
+    #
     def initialize
       @token = ENV['RUJIRA_TOKEN'] if ENV.include?('RUJIRA_TOKEN')
       @method = :get
@@ -19,53 +25,104 @@ module Rujira
       @path = nil
     end
 
+    # Evaluates a block in the context of the request for configuration.
+    #
+    # @yield [self] Block used to set path, headers, params, method, etc.
+    # @return [Request] Returns self for chaining.
+    #
+    # @example Configure a request
+    #   request.builder do
+    #     path 'issue/TEST-123'
+    #     method :get
+    #     headers 'X-Custom-Header': 'value'
+    #   end
+    #
     def builder(&block)
       return self unless block_given?
 
       instance_eval(&block)
       self
     end
-
     alias build builder
 
+    # Sets the base REST path for the request.
+    #
+    # @param [String] path The base path (e.g., 'rest/api/2' or 'rest/agile/1.0')
+    # @return [void]
+    #
     def rest_base(path)
       @rest_base_path = path
     end
 
+    # Gets or sets query parameters for the request.
+    #
+    # @param [Hash, nil] params Optional parameters to set.
+    # @return [Hash] The current parameters.
+    #
     def params(params = nil)
       return @params if params.nil?
 
       @params = params
     end
 
+    # Gets or sets HTTP headers for the request.
+    #
+    # @param [Hash, nil] headers Optional headers to set.
+    # @return [Hash] The current headers.
+    #
     def headers(headers = nil)
       return @headers if headers.nil?
 
       @headers = headers
     end
 
+    # Gets or sets the HTTP method for the request.
+    #
+    # @param [Symbol, nil] method Optional HTTP method (:get, :post, etc.)
+    # @return [Symbol] The current method.
+    #
     def method(method = nil)
       return @method if method.nil?
 
       @method = method
     end
 
+    # Sets Bearer token authorization.
+    #
+    # @param [String] token The token to use for authorization.
+    # @return [void]
+    #
     def bearer(token)
       @authorization = 'Bearer', -> { token }
     end
 
+    # Sets basic authentication.
+    #
+    # @param [String] username The username.
+    # @param [String] password The password.
+    # @return [void]
+    #
     def basic(username, password)
       @authorization = :basic, username, password
     end
 
+    # Gets or sets the request path (appended to rest_base_path).
+    #
+    # @param [String, nil] path The relative path to set.
+    # @return [String] The full path combining rest_base_path and the given path.
+    #
     def path(path = nil)
       return @path if path.nil?
 
       @path = "#{@rest_base_path}/#{path}"
-
       @path
     end
 
+    # Gets or sets the request payload (body for POST/PUT/PATCH requests).
+    #
+    # @param [Object, nil] payload The payload to set.
+    # @return [Object] The current payload.
+    #
     def payload(payload = nil)
       return @payload if payload.nil?
 

data/lib/rujira/tasks/generate.rake

@@ -15,7 +15,8 @@ module Rujira
       end
 
       def client
-        @client ||= Rujira::Client.new('http://localhost:8080', debug: false)
+        url = ENV.fetch('RUJIRA_URL', 'http://localhost:8080')
+        @client ||= Rujira::Client.new(url, debug: false)
       end
 
       def fetch_options(params, name)

data/lib/rujira/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rujira
-  VERSION = '0.3.2'
+  VERSION = '0.3.4'
 end

data/lib/rujira.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+# Load Rake tasks if Rake is defined
 Dir[File.join(__dir__, 'rujira', 'tasks', '*.rake')].each { |r| load r } if defined?(Rake)
 
 require 'faraday'
 require 'faraday/multipart'
 require 'json'
+
 require_relative 'rujira/error'
 require_relative 'rujira/version'
 require_relative 'rujira/request'
@@ -21,11 +23,27 @@ require_relative 'rujira/api/dashboard'
 require_relative 'rujira/api/board'
 require_relative 'rujira/api/sprint'
 
-# TODO: add docs
-# Some description
+# Main Rujira module.
+# Serves as the namespace for the Jira SDK.
+#
+# Provides utility methods and custom error handling.
+#
 module Rujira
+  # Custom error class for Rujira SDK
+  #
+  # @example
+  #   raise Rujira::Error, "Something went wrong"
+  #
   class Error < StandardError; end
 
+  # Checks if an environment variable is truthy.
+  #
+  # @param [String] var The name of the environment variable
+  # @return [Boolean] true if the value is 'true', '1', or 'yes' (case-insensitive), false otherwise
+  #
+  # @example Check if debug mode is enabled
+  #   Rujira.env_var?('RUJIRA_DEBUG')
+  #
   def self.env_var?(var)
     %w[true 1 yes].include?(ENV[var]&.downcase)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rujira
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Andrey Semenov