rujira 0.3.4 → 0.4.0

data/lib/rujira/api/issue.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
+require_relative 'issue/watchers'
+require_relative 'issue/comments'
+
 module Rujira
   module Api
     # 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
+    class Issue < Common # rubocop:disable Metrics/ClassLength
+      include Watchers
+      include Comments
+
       # Creates a new issue.
       #
       # @yield [builder] Optional block to configure the request payload.
@@ -31,6 +37,28 @@ module Rujira
         run
       end
 
+      # Creates multiple issues in bulk.
+      #
+      # @yield [builder] Block to configure the payload for bulk creation.
+      # @return [Object] The API response after creating issues.
+      #
+      # @example Create issues in bulk
+      #   client.Issue.create_bulk do
+      #     payload issues: [
+      #       { fields: { project: { key: "TEST" }, summary: "Issue 1", issuetype: { name: "Task" } } },
+      #       { fields: { project: { key: "TEST" }, summary: "Issue 2", issuetype: { name: "Bug" } } }
+      #     ]
+      #   end
+      #
+      def create_bulk(&block)
+        builder do
+          path 'issue/bulk'
+          method :post
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
       # Retrieves an issue by its ID or key.
       #
       # @param [String] id_or_key The issue ID or key.
@@ -91,57 +119,315 @@ module Rujira
         run
       end
 
-      # Adds a comment to an issue.
+      # Archives an issue by its ID or key.
       #
       # @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.
+      # @return [Object] The API response after archiving the issue.
+      #
+      # @example Archive an issue
+      #   client.Issue.archive("TEST-123")
       #
-      # @example Add a comment
-      #   client.Issue.comment("TEST-123") do
-      #     payload body: "This is a comment"
+      def archive(id_or_key)
+        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
+        builder do
+          path "issue/#{id_or_key}/archive"
+          method :put
+        end
+        run
+      end
+
+      # Retrieves the archive information for a given issue.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @return [Object] The API response containing archive details for the issue.
+      #
+      # @example List archive information for an issue
+      #   client.Issue.list_archive("TEST-123")
+      def list_archive(id_or_key)
+        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
+        builder do
+          path "issue/#{id_or_key}/archive"
+        end
+        run
+      end
+
+      # Updates the assignee of an issue.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @yield [builder] Block to configure the payload for assignee update.
+      # @return [Object] The API response after updating the assignee.
+      #
+      # @example Assign an issue to a user
+      #   client.Issue.assignee("TEST-123") do
+      #     payload name: "john.doe"
       #   end
       #
-      def comment(id_or_key, &block)
+      def assignee(id_or_key)
         abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
-        @client.Comment.create id_or_key, &block
+        builder do
+          path "issue/#{id_or_key}/assignee"
+          method :put
+        end
+        run
       end
 
-      # Adds a watcher to an issue.
+      # Retrieves the edit metadata for a given issue.
+      # This provides information about which fields can be edited and their constraints.
       #
       # @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.
+      # @yield [builder] Optional block to configure additional request parameters.
+      # @return [Object] The API response containing edit metadata.
       #
-      # @example Add a watcher
-      #   client.Issue.watchers("TEST-123", "johndoe")
+      # @example Get edit metadata for an issue
+      #   client.Issue.editmeta("TEST-123") do
+      #     # Optional: add query parameters or headers
+      #     params expand: "projects,issuetypes.fields"
+      #   end
+      def editmeta(id_or_key, &block)
+        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
+        builder do
+          path "issue/#{id_or_key}/editmeta"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Sends a notification about a specific issue.
       #
-      def watchers(id_or_key, name, &block)
+      # @param [String] id_or_key The issue ID or key.
+      # @yield [builder] Block to configure the payload for the notification.
+      # @return [Object] The API response after sending the notification.
+      #
+      # @example Notify users about an issue
+      #   client.Issue.notify("TEST-123") do
+      #     payload {
+      #       subject: "Issue Update",
+      #       textBody: "The issue has been updated.",
+      #       to: [{ type: "user", username: "john.doe" }]
+      #     }
+      #   end
+      def notify(id_or_key, &block)
         abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
         builder do
-          path "issue/#{id_or_key}/watchers"
           method :post
-          payload name.to_json
+          path "issue/#{id_or_key}/notify"
           instance_eval(&block) if block_given?
         end
         run
       end
 
-      # Uploads an attachment to an issue.
+      # Retrieves remote links for a given 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.
+      # @yield [builder] Optional block to configure additional request parameters.
+      # @return [Object] The API response containing remote links.
+      #
+      # @example Get remote links for an issue
+      #   client.Issue.remotelink("TEST-123") do
+      #     # Optional: add query parameters or headers
+      #     params expand: "application"
+      #   end
+      def remotelink(id_or_key, &block)
+        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
+        builder do
+          path "issue/#{id_or_key}/remotelink"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Creates a remote link for a given issue.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @yield [builder] Block to configure the payload for the remote link.
+      # @return [Object] The API response after creating the remote link.
+      #
+      # @example Create a remote link for an issue
+      #   client.Issue.create_remotelink("TEST-123") do
+      #     payload {
+      #       object: {
+      #         url: "https://example.com/task/123",
+      #         title: "External Task"
+      #       }
+      #     }
+      #   end
+      def create_remotelink(id_or_key, &block)
+        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
+        builder do
+          method :post
+          path "issue/#{id_or_key}/remotelink"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Deletes remote links for a given issue.
       #
-      # @example Upload an attachment
-      #   client.Issue.attachments("TEST-123", "/tmp/file.txt")
+      # @param [String] id_or_key The issue ID or key.
+      # @yield [builder] Optional block to configure additional request parameters.
+      # @return [Object] The API response after deleting the remote link(s).
       #
-      def attachments(id_or_key, path, &block)
+      # @example Delete remote links for an issue
+      #   client.Issue.delete_remotelink("TEST-123") do
+      #     # Optional: add query parameters or headers if needed
+      #     params globalId: "com.example:task-123"
+      #   end
+      def delete_remotelink(id_or_key, &block)
         abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
-        @client.Attachments.create id_or_key, path, &block
+        builder do
+          method :delete
+          path "issue/#{id_or_key}/remotelink"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Retrieves a specific remote link for a given issue.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @param [String] link_id The remote link ID.
+      # @yield [builder] Optional block to configure additional request parameters.
+      # @return [Object] The API response containing the remote link details.
+      #
+      # @example Get a specific remote link
+      #   client.Issue.get_remotelink_by_id("TEST-123", "20001") do
+      #     # Optional: add headers or query parameters
+      #   end
+      def get_remotelink_by_id(id_or_key, link_id, &block)
+        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
+        builder do
+          path "issue/#{id_or_key}/remotelink/#{link_id}"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Updates a specific remote link for a given issue.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @param [String] link_id The remote link ID.
+      # @yield [builder] Block to configure the payload for updating the remote link.
+      # @return [Object] The API response after updating the remote link.
+      #
+      # @example Update a specific remote link
+      #   client.Issue.update_remotelink("TEST-123", "20001") do
+      #     payload {
+      #       object: {
+      #         url: "https://example.com/updated-task/123",
+      #         title: "Updated Task"
+      #       }
+      #     }
+      #   end
+      def update_remotelink(id_or_key, link_id, &block)
+        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
+        builder do
+          method :put
+          path "issue/#{id_or_key}/remotelink/#{link_id}"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Deletes a specific remote link by its ID for a given issue.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @param [String] link_id The remote link ID.
+      # @yield [builder] Optional block to configure additional request parameters.
+      # @return [Object] The API response after deleting the remote link.
+      #
+      # @example Delete a specific remote link
+      #   client.Issue.delete_remotelink_by_id("TEST-123", "20001") do
+      #     # Optional: add headers or query parameters
+      #   end
+      def delete_remotelink_by_id(id_or_key, link_id, &block)
+        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
+        builder do
+          method :delete
+          path "issue/#{id_or_key}/remotelink/#{link_id}"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Restores a previously archived issue.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @yield [builder] Optional block to configure additional request parameters.
+      # @return [Object] The API response after restoring the issue.
+      #
+      # @example Restore an issue
+      #   client.Issue.restore("TEST-123") do
+      #     # Optional: add headers or payload if needed
+      #   end
+      def restore(id_or_key, &block)
+        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
+        builder do
+          method :put
+          path "issue/#{id_or_key}/restore"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Performs a transition on a given issue (e.g., change status).
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @yield [builder] Block to configure the payload for the transition.
+      # @return [Object] The API response after performing the transition.
+      #
+      # @example Transition an issue
+      #   client.Issue.transitions("TEST-123") do
+      #     payload transition: { id: "31" }
+      #   end
+      def transitions(id_or_key, &block)
+        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
+        builder do
+          method :post
+          path "issue/#{id_or_key}/transitions"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Retrieves available transitions for a given issue.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @yield [builder] Optional block to configure additional request parameters.
+      # @return [Object] The API response containing available transitions.
+      #
+      # @example Get available transitions
+      #   client.Issue.get_transitions("TEST-123") do
+      #     # Optional: add query parameters or headers
+      #   end
+      def get_transitions(id_or_key, &block)
+        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
+        builder do
+          path "issue/#{id_or_key}/transitions"
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # 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_attachments(id_or_key, path, &block)
+        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
+        client = @client
+        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?
+        end
+        run
       end
+      alias attachments create_attachments
     end
   end
 end

data/lib/rujira/api/myself.rb

@@ -22,6 +22,42 @@ module Rujira
         end
         run
       end
+
+      # Updates the current user's profile.
+      #
+      # @yield [builder] Block to configure the payload or additional request parameters.
+      # @return [Object] The API response after updating the user profile.
+      #
+      # @example Update user profile
+      #   client.Myself.update do
+      #     payload({ displayName: "New Name", emailAddress: "new@example.com" })
+      #   end
+      def update(&block)
+        builder do
+          method :put
+          path 'myself'
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
+
+      # Changes the current user's password.
+      #
+      # @yield [builder] Block to configure the payload for the password change.
+      # @return [Object] The API response after changing the password.
+      #
+      # @example Change user password
+      #   client.Myself.password do
+      #     payload({ password: "newpassword123" })
+      #   end
+      def password(&block)
+        builder do
+          method :put
+          path 'myself'
+          instance_eval(&block) if block_given?
+        end
+        run
+      end
     end
   end
 end

data/lib/rujira/api/permissions.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Api
+    # Provides access to Jira permissions via the REST API.
+    # Allows listing all permission schemes available in Jira.
+    #
+    # API reference:
+    # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/permissions
+    #
+    class Permissions < Common
+      # Retrieves the list of all permissions in Jira.
+      #
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing permissions details.
+      #
+      # @example List all permissions
+      #   client.Permissions.list
+      #
+      def list
+        builder do
+          path 'permissions'
+          method :get
+        end
+        run
+      end
+
+      # Retrieves the list of my permissions in Jira.
+      #
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing permissions details.
+      #
+      # @example List all permissions
+      #   client.Permissions.my
+      #
+      def my
+        builder do
+          path 'mypermissions'
+          method :get
+        end
+        run
+      end
+    end
+  end
+end

data/lib/rujira/client.rb

@@ -23,6 +23,7 @@ module Rujira
     def initialize(url, debug: false)
       @uri = URI(url)
       @debug = ENV.fetch('RUJIRA_DEBUG', debug.to_s) == 'true'
+      @raise_error = false
       @request = Request.new
     end
 
@@ -80,7 +81,12 @@ module Rujira
 
         response = connection.public_send(@request.method, *args)
 
-        response.success? ? response.body : (raise "Request failed with status #{response.status}")
+        if response.success?
+          response.body
+        else
+          (raise "Request failed with status #{response.status} " \
+                 "and body #{response.body}")
+        end
       rescue StandardError => e
         raise "Error: #{e.class} - #{e.message}"
       end
@@ -96,7 +102,7 @@ module Rujira
         builder.request :multipart, flat_encode: true
         builder.request :json
         builder.response :json
-        builder.response :raise_error
+        builder.response :raise_error if @raise_error
         builder.response :logger if @debug
       end
     end

data/lib/rujira/version.rb

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

data/lib/rujira.rb

@@ -22,6 +22,14 @@ require_relative 'rujira/api/server_info'
 require_relative 'rujira/api/dashboard'
 require_relative 'rujira/api/board'
 require_relative 'rujira/api/sprint'
+require_relative 'rujira/api/permissions'
+require_relative 'rujira/api/application_properties'
+require_relative 'rujira/api/applicationrole'
+require_relative 'rujira/api/avatar'
+require_relative 'rujira/api/configuration'
+require_relative 'rujira/api/custom_fields'
+require_relative 'rujira/api/field'
+require_relative 'rujira/api/filter'
 
 # Main Rujira module.
 # Serves as the namespace for the Jira SDK.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rujira
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrey Semenov
@@ -55,13 +55,23 @@ files:
 - contrib/jira_link_generator.rb
 - examples/create_issue_in_sprint.rb
 - lib/rujira.rb
+- lib/rujira/api/application_properties.rb
+- lib/rujira/api/applicationrole.rb
 - lib/rujira/api/attachments.rb
+- lib/rujira/api/avatar.rb
 - lib/rujira/api/board.rb
 - lib/rujira/api/comment.rb
 - lib/rujira/api/common.rb
+- lib/rujira/api/configuration.rb
+- lib/rujira/api/custom_fields.rb
 - lib/rujira/api/dashboard.rb
+- lib/rujira/api/field.rb
+- lib/rujira/api/filter.rb
 - lib/rujira/api/issue.rb
+- lib/rujira/api/issue/comments.rb
+- lib/rujira/api/issue/watchers.rb
 - lib/rujira/api/myself.rb
+- lib/rujira/api/permissions.rb
 - lib/rujira/api/project.rb
 - lib/rujira/api/search.rb
 - lib/rujira/api/server_info.rb