rujira 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b6d18c441bf30cd86f00a38ccb4a2be266fdbc3aa312f607292d6a7d25d0a26
-  data.tar.gz: 326fb2ea52c1cb8f41f0c7ecfb9e511b325315c6f0bc89df5bc4a8ce4f13edb6
+  metadata.gz: d0134685b3295946f3e1ae11f3f8f60cb7ef438d67d6c6c93efdf48419f46799
+  data.tar.gz: 3d7503722d60837598dbf4cf938825cf44d8dea497cc5b40d87337887cf43536
 SHA512:
-  metadata.gz: 4a3c6713caa660260b313a2cd6f3727ba831a7ace828a2fa1f55ae9e827b31a18854abd9f66c06014f07845dd12cbe439bd70d4c4d78ea5f40a847bd0fffe5cb
-  data.tar.gz: '0498ad7989466f66ddb76bd02e793e5ac2905d843db1101f14a3502487bb2efd51effa7f9836c51cf51a8ae4bf5173557daa6ab07b893cd9ad78370bd4aa0c9d'
+  metadata.gz: 0cfb4598d5b97fbde72b2fef4bf3d2521b4a4009dc979242faa4db7da98673d13a0b8e65466cb815561e04cdce9cba6d1c353dae7403b6e4f26cca5ee924e0ed
+  data.tar.gz: 2668993188f71529679ffa8812216729932d161f2def80f4df0566dc31023aad2b293b2539783394bc67e39a6bfd2d81cdc4785a00e6d766772c8b541707e114

data/CHANGELOG.md

@@ -1,8 +1,27 @@
-## [0.3.4] - 2025-09-13
+## [0.4.0] - 2025-09-13
+
+### 🚀 Features
+
+- Extend Issue #2
+- Extend Issue
+- Added Filter
+- Extend Avatar, Configuration, CustomFields, Field
+- Extend Attachments
+- Added ApplicationRole
+- Added ApplicationProperties
+- Added permissions api
 
 ### 🐛 Bug Fixes
 
 - Fix for tasks
+
+### 🚜 Refactor
+
+- Dont raising for faraday
+- Cleanup attachments
+- Split issue #3
+- Split issue #2
+- Split issue
 ## [0.3.3] - 2025-09-13
 
 ### 📚 Documentation
@@ -59,30 +78,8 @@
 - Update README
 ## [0.1.15] - 2025-09-11
 
-### 🚀 Features
-
-- Added dotenv
-- Update a gems
-- Example of generation url
-
-### 🐛 Bug Fixes
-
-- No test in CI
-
 ### 🚜 Refactor
 
 - Docs
 - BUILDER
 - RAKE TASKS
-
-### 📚 Documentation
-
-- Fix a readme
-
-### Hotfix
-
-- Remove debug line
-
-### Reafactor
-
-- Full

data/lib/rujira/api/application_properties.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Api
+    # Provides access to Jira application properties via the REST API.
+    # Allows listing, retrieving, updating, and accessing 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.
+      #
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing all properties.
+      #
+      # @example List all application properties
+      #   client.application_properties.list
+      #
+      def list
+        builder do
+          path 'application-properties'
+        end
+        run
+      end
+
+      alias get list
+
+      # Updates a specific application property.
+      #
+      # @param [String] id The property ID to update.
+      # @yield [builder] Block to configure the payload.
+      # @return [Object] The API response after updating the property.
+      #
+      # @example Update an application property
+      #   client.application_properties.set("jira.option.someFeature") do
+      #     payload value: true
+      #   end
+      #
+      def set(id, &block)
+        builder do
+          method :put
+          path "application-properties/#{id}"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Retrieves advanced application settings.
+      #
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing advanced settings.
+      #
+      # @example Get advanced settings
+      #   client.application_properties.advanced_settings
+      #
+      def advanced_settings
+        builder do
+          path 'application-properties/advanced-settings'
+        end
+        run
+      end
+    end
+  end
+end

data/lib/rujira/api/applicationrole.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Api
+    # Provides access to Jira application roles via the REST API.
+    # Allows listing, retrieving, and updating application roles.
+    #
+    # API reference:
+    # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/applicationrole
+    #
+    class ApplicationRole < Common
+      # Updates multiple application roles in bulk.
+      #
+      # @yield [builder] Block to configure the payload for bulk update.
+      # @return [Object] The API response after updating roles.
+      #
+      # @example Bulk update roles
+      #   client.Application_role.put_bulk do
+      #     payload [
+      #       { key: "jira-software-users", groups: ["jira-users"] },
+      #       { key: "jira-administrators", groups: ["admins"] }
+      #     ]
+      #   end
+      #
+      def put_bulk(&block)
+        builder do
+          method :put
+          path 'applicationrole'
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Lists all application roles.
+      #
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing all application roles.
+      #
+      # @example List all application roles
+      #   client.Application_role.list
+      #
+      def list
+        builder do
+          path 'applicationrole'
+        end
+        run
+      end
+
+      # Retrieves a specific application role by key.
+      #
+      # @param [String] key The key of the application role.
+      # @return [Object] The API response containing role details.
+      #
+      # @example Get a role
+      #   client.Application_role.get("jira-software-users")
+      #
+      def get(key)
+        builder do
+          path "applicationrole/#{key}"
+        end
+        run
+      end
+
+      # Updates a specific application role by key.
+      #
+      # @param [String] key The key of the application role to update.
+      # @yield [builder] Block to configure the payload for update.
+      # @return [Object] The API response after updating the role.
+      #
+      # @example Update a role
+      #   client.Application_role.put("jira-software-users") do
+      #     payload groups: ["jira-users", "new-group"]
+      #   end
+      #
+      def put(key, &block)
+        builder do
+          method :put
+          path "applicationrole/#{key}"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+    end
+  end
+end

data/lib/rujira/api/attachments.rb

@@ -7,22 +7,50 @@ module Rujira
     # 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.
+      # Retrieves a specific attachment by ID.
       #
-      # @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.
+      # @param [String] id The attachment ID.
+      # @return [Object] The API response containing attachment details.
       #
-      def create(id_or_key, path, &block)
-        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
-        client = @client
+      # @example Get an attachment
+      #   client.attachments.get("10001")
+      #
+      def get(id)
+        abort 'Attachment ID is required' if id.to_s.strip.empty?
+        builder do
+          path "attachment/#{id}"
+        end
+        run
+      end
+
+      # Deletes a specific attachment by ID.
+      #
+      # @param [String] id The attachment ID.
+      # @return [Object] The API response after deletion.
+      #
+      # @example Delete an attachment
+      #   client.attachments.delete("10001")
+      #
+      def delete(id)
+        abort 'Attachment ID is required' if id.to_s.strip.empty?
+        builder do
+          method :delete
+          path "attachment/#{id}"
+        end
+        run
+      end
+
+      # Retrieves metadata for attachments.
+      #
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing attachment metadata.
+      #
+      # @example Get attachment metadata
+      #   client.attachments.meta
+      #
+      def meta
         builder do
-          path "issue/#{id_or_key}/attachments"
-          method :post
-          headers 'X-Atlassian-Token': 'no-check'
-          payload file: client.file(path)
-          instance_eval(&block) if block_given?
+          path 'attachment/meta'
         end
         run
       end

data/lib/rujira/api/avatar.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Api
+    # Provides access to Jira avatars via the REST API.
+    # Allows retrieving system avatars, uploading temporary avatars, and cropping them.
+    #
+    # API reference:
+    # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/avatar
+    #
+    class Avatar < Common
+      # Retrieves all system avatars of a given type.
+      #
+      # @param [String] type The type of avatar (e.g., "project", "user").
+      # @return [Object] The API response containing system avatars.
+      #
+      # @example Get system avatars for projects
+      #   client.Avatar.get("project")
+      #
+      def get(type)
+        builder do
+          path "avatar/#{type}/system"
+        end
+        run
+      end
+
+      # Uploads a temporary avatar for a given type.
+      #
+      # @param [String] type The type of avatar (e.g., "project", "user").
+      # @yield [builder] Block to configure the payload, usually including the file.
+      # @return [Object] The API response after uploading the temporary avatar.
+      #
+      # @example Upload a temporary avatar
+      #   client.Avatar.store("project") do
+      #     payload file: client.file("/path/to/avatar.png")
+      #   end
+      #
+      def store(type, &block)
+        builder do
+          method :post
+          path "avatar/#{type}/temporary"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Crops a previously uploaded temporary avatar.
+      #
+      # @param [String] type The type of avatar (e.g., "project", "user").
+      # @yield [builder] Block to configure crop parameters.
+      # @return [Object] The API response after cropping the avatar.
+      #
+      # @example Crop a temporary avatar
+      #   client.Avatar.crop("project") do
+      #     payload { x: 0, y: 0, width: 48, height: 48 }
+      #   end
+      #
+      def crop(type, &block)
+        builder do
+          method :post
+          path "avatar/#{type}/temporaryCrop"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+    end
+  end
+end

data/lib/rujira/api/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Api
+    # Provides access to Jira configuration settings via the REST API.
+    #
+    # API reference:
+    # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/configuration
+    #
+    class Configuration < Common
+      # Retrieves the current Jira configuration.
+      #
+      # @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
+        builder do
+          path 'configuration'
+        end
+        run
+      end
+    end
+  end
+end

data/lib/rujira/api/custom_fields.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Api
+    # Provides access to Jira custom fields via the REST API.
+    # Allows retrieving and deleting custom fields.
+    #
+    # API reference:
+    # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/customFields
+    #
+    class CustomFields < Common
+      # Retrieves all custom fields.
+      #
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing all custom fields.
+      #
+      # @example Get all custom fields
+      #   client.CustomFields.get
+      #
+      def get
+        builder do
+          path 'customFields'
+        end
+        run
+      end
+
+      # Deletes custom fields based on provided parameters.
+      #
+      # @yield [builder] Block to configure the deletion payload or parameters.
+      # @return [Object] The API response after deletion.
+      #
+      # @example Delete custom fields
+      #   client.CustomFields.delete do
+      #     payload fieldIds: ["customfield_10001", "customfield_10002"]
+      #   end
+      #
+      def delete(&block)
+        builder do
+          method :delete
+          path 'customFields'
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+    end
+  end
+end

data/lib/rujira/api/field.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Api
+    # Provides access to Jira fields via the REST API.
+    # Allows listing all fields and creating new fields.
+    #
+    # API reference:
+    # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/field
+    #
+    class Field < Common
+      # Retrieves all fields.
+      #
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing all fields.
+      #
+      # @example List all fields
+      #   client.Field.get
+      #   client.Field.list
+      #
+      def list
+        builder do
+          path 'field'
+        end
+        run
+      end
+      alias get list
+
+      # Creates a new field.
+      #
+      # @yield [builder] Block to configure the payload for the new field.
+      # @return [Object] The API response after creating the field.
+      #
+      # @example Create a custom field
+      #   client.Field.create do
+      #     payload name: "My Field", type: "com.atlassian.jira.plugin.system.customfieldtypes:textfield"
+      #   end
+      #
+      def create(&block)
+        builder do
+          method :post
+          path 'field'
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+    end
+  end
+end

data/lib/rujira/api/filter.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Api
+    # Provides access to Jira filters via the REST API.
+    # Allows creating, editing, deleting, retrieving filters,
+    # managing filter columns, permissions, and favorite/default settings.
+    #
+    # API reference:
+    # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/filter
+    #
+    class Filter < Common
+      # Creates a new filter.
+      #
+      # @yield [builder] Block to configure the payload for the new filter.
+      # @return [Object] The API response after creating the filter.
+      #
+      # @example Create a filter
+      #   client.Filter.create do
+      #     payload name: "My Filter", jql: "project = TEST", favourite: true
+      #   end
+      #
+      def create(&block)
+        builder do
+          method :post
+          path 'filter'
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Updates an existing filter by ID.
+      #
+      # @param [String] id The filter ID.
+      # @yield [builder] Block to configure the payload for update.
+      # @return [Object] The API response after editing the filter.
+      #
+      # @example Edit a filter
+      #   client.Filter.edit("10001") do
+      #     payload name: "Updated Filter Name"
+      #   end
+      #
+      def edit(id, &block)
+        builder do
+          method :put
+          path "filter/#{id}"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Deletes a filter by ID.
+      #
+      # @param [String] id The filter ID.
+      # @return [Object] The API response after deletion.
+      #
+      def delete(id)
+        builder do
+          method :delete
+          path "filter/#{id}"
+        end
+        run
+      end
+
+      # Retrieves a filter by ID.
+      #
+      # @param [String] id The filter ID.
+      # @return [Object] The API response containing filter details.
+      #
+      def get(id)
+        builder do
+          path "filter/#{id}"
+        end
+        run
+      end
+
+      # Retrieves columns configuration of a filter.
+      #
+      # @param [String] id The filter ID.
+      # @return [Object] The API response with columns configuration.
+      #
+      def columns(id)
+        builder do
+          path "filter/#{id}/columns"
+        end
+        run
+      end
+
+      # Updates columns configuration of a filter.
+      #
+      # @param [String] id The filter ID.
+      # @yield [builder] Block to configure the payload for columns.
+      # @return [Object] The API response after updating columns.
+      #
+      # @example Set columns for a filter
+      #   client.Filter.set_columns("10001") do
+      #     payload ["summary", "assignee", "status"]
+      #   end
+      #
+      def set_columns(id, &block)
+        builder do
+          method :put
+          path "filter/#{id}/columns"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Resets columns of a filter to default.
+      #
+      # @param [String] id The filter ID.
+      # @return [Object] The API response after resetting columns.
+      #
+      def reset_columns(id)
+        builder do
+          method :delete
+          path "filter/#{id}/columns"
+        end
+        run
+      end
+
+      # Lists permissions of a filter.
+      #
+      # @param [String] id The filter ID.
+      # @return [Object] The API response containing permissions.
+      #
+      def list_permission(id)
+        builder do
+          path "filter/#{id}/permission"
+        end
+        run
+      end
+
+      # Adds a permission to a filter.
+      #
+      # @param [String] id The filter ID.
+      # @yield [builder] Block to configure the permission payload.
+      # @return [Object] The API response after adding permission.
+      #
+      # @example Add permission to a filter
+      #   client.Filter.add_permission("10001") do
+      #     payload type: "group", groupname: "jira-users"
+      #   end
+      #
+      def add_permission(id, &block)
+        builder do
+          method :post
+          path "filter/#{id}/permission"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Retrieves a specific permission of a filter.
+      #
+      # @param [String] id The filter ID.
+      # @param [String] permission_id The permission ID.
+      # @return [Object] The API response containing the permission details.
+      #
+      def permission(id, permission_id)
+        builder do
+          path "filter/#{id}/permission/#{permission_id}"
+        end
+        run
+      end
+
+      # Deletes a specific permission of a filter.
+      #
+      # @param [String] id The filter ID.
+      # @param [String] permission_id The permission ID.
+      # @return [Object] The API response after deletion.
+      #
+      def delete_permission(id, permission_id)
+        builder do
+          method :delete
+          path "filter/#{id}/permission/#{permission_id}"
+        end
+        run
+      end
+
+      # Retrieves the default share scope of filters.
+      #
+      # @return [Object] The API response with default share scope.
+      #
+      def default_share_scope
+        builder do
+          path 'filter/defaultShareScope'
+        end
+        run
+      end
+
+      # Updates the default share scope of filters.
+      #
+      # @yield [builder] Block to configure the payload.
+      # @return [Object] The API response after updating default share scope.
+      #
+      # @example Set default share scope
+      #   client.Filter.set_default_share_scope do
+      #     payload type: "PROJECT", projectId: "10000"
+      #   end
+      #
+      def set_default_share_scope(&block)
+        builder do
+          method :put
+          path 'filter/defaultShareScope'
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Retrieves favorite filters.
+      #
+      # @return [Object] The API response containing favorite filters.
+      #
+      def favourite
+        builder do
+          path 'filter/favourite'
+        end
+        run
+      end
+    end
+  end
+end