rujira 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab245fcbc9d445b1ffa59c05d66e2b330375f9883d7e8949a4205af02f495824
-  data.tar.gz: 3f7d40b25d30fe5b6f966de78d283604f1d66c23cd9d34c3f433c5f722a7c103
+  metadata.gz: 5e934f91388416b891e49d824c5f3d875708d5102d2084d8fa3c641be5006d02
+  data.tar.gz: 5cc8ee2aa9475057ae26953287f5f99c9be83adc0cd578236d17b758d5c82486
 SHA512:
-  metadata.gz: c90e9d4ac246ec1c39a42dc618450bd6d8a3bda5e8095edb229919b2a5fc89d001c72a986d4c1465d9155ff64785f0439591e37fce9f79041611f231719e6a8f
-  data.tar.gz: ec925b95ca7d73c228cde2b543ef77eee66b049614d3665f66cdc4f7af6913b1ac041581266094daaa645c03df86c4e188a5cd3b58818b01055b4abba9ac5238
+  metadata.gz: 83a61e445cb8b1a3e2e5f5cb338d9f31070df47c3ea1aff9be54c49a63f8d022658d76856fee5f934b0343b79d37c04ae78bf9cfd17cb721fa988f3971f9ac1f
+  data.tar.gz: 503b7bc45991306f9346ee2b8cc1b77e492194544caea88bb3931b71d30f04a8f99fc10a76de98f6ff91d008743de259860503c61698f159b1fbc8bfc04c22de

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## [0.7.0] - 2025-10-01
+
+### 🚀 Features
+
+- Added project as obj
+
+### 🚜 Refactor
+
+- Tuning for tests
+
+### 📚 Documentation
+
+- Updated commentaries for resources
+## [0.6.0] - 2025-09-17
+
+### 🚀 Features
+
+- Added addapter method
+- Commitable style
+- Response object added
+
+### 🚜 Refactor
+
+- Changes for a client
 ## [0.5.1] - 2025-09-15
 
 ### 🚜 Refactor
@@ -62,23 +86,3 @@
 - Cleanup data method
 - Abort if id is nil #2
 - Abort if id is nil
-
-### 📚 Documentation
-
-- Use ENV for URL getting
-- Added some docs
-## [0.3.0] - 2025-09-13
-
-### 🚀 Features
-
-- Added client supports
-
-### 🚜 Refactor
-
-- Updates tasks
-- Use params
-- Added examples
-
-### Reafactor
-
-- How to search sprints

data/README.md

@@ -16,7 +16,7 @@
 Add to your `Gemfile`:
 
 ```ruby
-gem 'rujira', '~> 0.1.0'
+gem 'rujira', '~> 0.6.0'
 ```
 
 Or install directly:
@@ -33,9 +33,9 @@ gem install rujira
 
 ```ruby
 ❯ cat .env
-RUJIRA_DEBUG=false
 RUJIRA_TOKEN='<TOKEN>'
-RUJIRA_URL='http://localhost:8080'
+RUJIRA_DEBUG=true
+LOG_LEVEL=error
 ```
 
 ### Example of usage

data/Rakefile

@@ -23,3 +23,11 @@ end
 task :version do
   puts Rujira::VERSION
 end
+
+desc 'Cleanup test installation'
+task :cleanup do
+  url = ENV.fetch('RUJIRA_URL', 'http://localhost:8080')
+  client = Rujira::Client.new(url, dispatchable: false)
+  projects = client.Project.list
+  projects.map(&:delete)
+end

data/examples/create_issue_as_obj.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'dotenv'
+require_relative '../lib/rujira'
+
+Dotenv.load
+
+client = Rujira::Client.new('http://localhost:8080', dispatchable: false)
+
+project_name = 'TEST124'
+project_key = project_name
+
+issue = client.Issue.create do
+  payload fields: {
+    project: { key: project_key },
+    summary: 'BOT: added a new feature.',
+    description: 'This task was generated by the bot when creating changes in the repository.',
+    issuetype: { name: 'Task' }
+  }
+  params updateHistory: true
+end
+
+puts "Issue create #{issue.key}"
+
+issue.add_comment('Bot added a comment as obj #1')
+comment = issue.add_comment('Bot added a comment as obj #2')
+comment.delete
+
+issue.add_comment('Bot added a comment as obj #3')
+
+issue.delete

data/examples/create_issue_in_sprint.rb

@@ -7,21 +7,15 @@ Dotenv.load
 
 client = Rujira::Client.new('http://localhost:8080', dispatchable: true)
 
-project_name = 'EXAMPLE2'
-myself = client.Myself.get
-
+project_name = 'TEST124'
+project_key = project_name
 name = client.Myself.get['name']
 
-begin
-  project = client.Project.create do
-    payload key: project_name.to_s,
-            name: project_name.to_s,
-            projectTypeKey: 'software',
-            lead: name
-  end
-rescue StandardError
-  projects = client.Project.list
-  project = projects.find { |p| p['name'] == project_name }
+project = client.Project.create do
+  payload key: project_key,
+          name: project_name.to_s,
+          projectTypeKey: 'software',
+          lead: name
 end
 
 client.Issue.create do
@@ -43,7 +37,7 @@ sprint = client.Sprint.create do
           goal: 'Finish core features for release 1.0',
           startDate: now,
           endDate: before,
-          autoStartStop: true
+          autoStartStop: false
 end
 
 client.Sprint.update sprint['id'] do

data/lib/rujira/api/comment.rb

@@ -19,6 +19,8 @@ module Rujira
       #   end
       #
       def create(id_or_key, &block)
+        owned_by 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}/comment"
@@ -27,6 +29,26 @@ module Rujira
         end
         call
       end
+
+      # Deletes a comment from an issue.
+      #
+      # @param [String] id_or_key The issue ID or key.
+      # @param [String] id The comment ID.
+      # @yield [builder] Optional block to configure additional request parameters.
+      # @return [Object] The API response after deleting the comment.
+      #
+      # @example Delete a comment
+      #   client.Issue.delete_comment("TEST-123", "10001")
+      #
+      def delete(id_or_key, id, &block)
+        abort 'Issue ID or KEY is required' if id_or_key.to_s.strip.empty?
+        builder do
+          path "issue/#{id_or_key}/comment/#{id}"
+          method :delete
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
     end
   end
 end

data/lib/rujira/api/common.rb

@@ -13,6 +13,7 @@ module Rujira
       def initialize(client)
         # Store the passed client object in an instance variable for later use
         @client = client
+        @metadata ||= {}
         @request = Request.new.builder do
           # Set the Bearer token for authorization
           bearer @token
@@ -40,13 +41,52 @@ module Rujira
       def call
         @client.logger.debug "Call the method: #{caller_locations(1, 1)[0].label}"
         return @client.dispatch(@request) if @client.dispatchable
+        return self if @client.commitable
 
-        self
+        to_obj
       end
 
+      # Executes the configured request via the client's dispatch mechanism.
+      #
+      # @return [Object] The raw API response from the dispatched request.
       def commit
         @client.dispatch(@request)
       end
+
+      # Converts the API response into structured Ruby objects.
+      # If the response is an array of hashes, maps each element through `process`.
+      # If it's a single hash, processes it directly. Otherwise, returns as-is.
+      #
+      # @return [Object] Processed response as one or more resource objects, or original response.
+      def to_obj
+        response = commit
+
+        return response.map { |el| process(el) } if response.is_a?(Array) && response.all? { |el| el.is_a?(Hash) }
+        return response unless response.is_a?(Hash)
+
+        process response
+      end
+
+      # Processes a single response hash by merging metadata and instantiating
+      # the corresponding Resource object based on the current class name.
+      #
+      # @param [Hash] response The API response hash to process.
+      # @return [Object] An instance of the corresponding Resource class.
+      # @raise [NameError] If the corresponding Resource class does not exist.
+      def process(response)
+        response.merge!(@metadata)
+        resource_class_name = self.class.name.sub('Api', 'Resource')
+        Object.const_get(resource_class_name).new(@client, **response)
+      end
+
+      # Sets ownership context for the resource by storing a parent ID or key
+      # in metadata, which may be used during object instantiation.
+      #
+      # @param [String, Integer] id_or_key The ID or key of the parent resource.
+      # @return [Hash] The updated metadata hash with the parent set.
+      def owned_by(id_or_key)
+        @metadata.merge!({ parent: id_or_key })
+      end
     end
   end
 end

data/lib/rujira/api/issue/comments.rb

@@ -42,27 +42,6 @@ module Rujira
           call
         end
 
-        # Adds a new comment to an issue.
-        #
-        # @param [String] id_or_key The issue ID or key.
-        # @yield [builder] Block to configure the payload for the new comment.
-        # @return [Object] The API response containing the created comment.
-        #
-        # @example Add a comment
-        #   client.Issue.add_comment("TEST-123") do
-        #     payload body: "New comment text"
-        #   end
-        #
-        def add_comment(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}/comment"
-            method :post
-            instance_eval(&block) if block_given?
-          end
-          call
-        end
-
         # Retrieves a specific comment by its ID.
         #
         # @param [String] id_or_key The issue ID or key.
@@ -173,7 +152,7 @@ module Rujira
         #     payload body: "This is a comment"
         #   end
         #
-        def comment(id_or_key, &block)
+        def add_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

data/lib/rujira/client.rb

@@ -11,7 +11,9 @@ module Rujira
   #   client.issue.get("TEST-123")
   #
   class Client
-    attr_reader :logger, :dispatchable
+    attr_reader :dispatchable, :logger, :commitable
+
+    SUPPORTED_METHODS = %i[get delete head post put patch].freeze
 
     # Initializes a new Jira client.
     #
@@ -21,8 +23,9 @@ module Rujira
     # @example Initialize client
     #   client = Rujira::Client.new("https://jira.example.com", debug: true)
     #
-    def initialize(url, debug: false, dispatchable: true, log_level: 'error') # rubocop:disable Metrics/MethodLength
+    def initialize(url, debug: false, dispatchable: true, commitable: false, log_level: 'error') # rubocop:disable Metrics/MethodLength
       @dispatchable = dispatchable
+      @commitable = commitable
       @uri = URI(url)
       @debug = ENV.fetch('RUJIRA_DEBUG', debug.to_s) == 'true'
       @raise_error = false
@@ -40,6 +43,22 @@ module Rujira
         ENV.fetch('LOG_LEVEL', log_level).downcase,
         Logger::ERROR
       )
+
+      @adapter = adapter
+    end
+
+    def adapter # rubocop:disable Metrics/MethodLength
+      case ENV.fetch('RUJIRA_ADAPTER', nil)
+      when 'typhoeus'
+        @logger.debug 'Using Typhoeus adapter'
+        require 'faraday/typhoeus'
+        :typhoeus
+      when 'async'
+        require 'async/http/faraday'
+        :async_http
+      else
+        Faraday.default_adapter
+      end
     end
 
     # Dynamically instantiates the appropriate API resource class.
@@ -68,23 +87,27 @@ module Rujira
       Rujira::Api.const_defined?(method_name.to_s) || super
     end
 
+    def build_options(request)
+      {
+        url: @uri,
+        headers: request.headers,
+        params: request.params
+      }
+    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(request) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
-      raise "method #{request.method} not supported" unless %i[get delete head post put patch].include?(request.method)
+      raise "method #{request.method} not supported" unless SUPPORTED_METHODS.include?(request.method)
 
       begin
         args = [request.path]
         args << request.payload if %i[post put patch].include?(request.method)
 
-        options = {
-          url: @uri,
-          headers: request.headers,
-          params: request.params
-        }
+        options = build_options(request)
         response = connection(options, request.authorization).public_send(request.method, *args)
 
         if response.success?
@@ -94,7 +117,8 @@ module Rujira
                  "and body #{response.body}")
         end
       rescue StandardError => e
-        raise "Error: #{e.class} - #{e.message}"
+        @logger.error "Error: #{e.class} - #{e.message}"
+        raise
       end
     end
 
@@ -104,6 +128,7 @@ module Rujira
     #
     def connection(options, authorization)
       Faraday.new(options) do |builder|
+        builder.adapter @adapter
         builder.request :authorization, *authorization if authorization
         builder.request :multipart, flat_encode: true
         builder.request :json

data/lib/rujira/request.rb

@@ -106,6 +106,14 @@ module Rujira
       @authorization = :basic, username, password
     end
 
+    # Disables any authentication for subsequent requests.
+    #
+    # @return [void]
+    #
+    def disable_auth
+      @authorization = nil
+    end
+
     # Gets or sets the request path (appended to rest_base_path).
     #
     # @param [String, nil] path The relative path to set.
@@ -128,5 +136,14 @@ module Rujira
 
       @payload = payload
     end
+
+    # Extends the current payload by merging the given hash into it.
+    #
+    # @param [Hash, nil] payload Optional hash to merge into the current payload.
+    def extend_payload(payload = nil)
+      return @payload if payload.nil?
+
+      @payload.merge!(payload)
+    end
   end
 end

data/lib/rujira/resource/comment.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Resource
+    # Represents a Jira comment resource.
+    # Provides access to comment attributes and actions such as deletion.
+    #
+    # Example usage:
+    #   comment = Rujira::Resource::Comment.new(client, data)
+    #   comment.delete  # Deletes the comment via the API
+    #
+    class Comment < Common
+      # @return [String] The ID of the comment
+      attr_reader :id
+      # @return [String] The issue key or resource key associated with the comment
+      attr_reader :key
+      # @return [String] The URL to access this comment via Jira REST API
+      attr_reader :url
+
+      # Initializes a Comment resource
+      #
+      # @param [Object] client The API client instance used to make requests
+      # @param [Hash] hash The comment data from the Jira API
+      def initialize(client, **args)
+        super
+
+        @url = args['self']
+        @id = args['id']
+
+        @author = args['author']
+        @body = args['body']
+        @update_author = args['updateAuthor']
+        @created = args['created']
+        @updated = args['updated']
+
+        @parent = args[:parent] # The parent issue key or resource
+      end
+
+      # Deletes this comment from Jira.
+      #
+      # @return [Object] The API response from the delete operation
+      #
+      # @example Delete a comment
+      #   comment.delete
+      def delete
+        @client.Comment.delete(@parent, @id)
+      end
+    end
+  end
+end

data/lib/rujira/resource/common.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Resource
+    class Common
+      def initialize(client, **_args)
+        @client = client
+      end
+    end
+  end
+end

data/lib/rujira/resource/issue.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Resource
+    # Represents a Jira issue resource.
+    # Provides access to issue attributes and actions such as adding comments.
+    #
+    # Example usage:
+    #   issue = Rujira::Resource::Issue.new(client, data)
+    #   issue.add_comment("This is a comment")
+    #
+    class Issue < Common
+      # @return [String] The ID of the issue
+      attr_reader :id
+      # @return [String] The key of the issue (e.g., "TEST-123")
+      attr_reader :key
+      # @return [String] The URL to access this issue via Jira REST API
+      attr_reader :url
+
+      # Initializes an Issue resource
+      #
+      # @param [Object] client The API client instance used to make requests
+      # @param [Hash] hash The issue data from the Jira API
+      def initialize(client, **args)
+        super
+
+        @id = args['id']
+        @key = args['key']
+        @url = args['self']
+      end
+
+      # Adds a comment to this issue.
+      #
+      # @param [String] text The content of the comment
+      # @return [Object] The API response after adding the comment
+      #
+      # @example Add a comment to an issue
+      #   issue.add_comment("This is a new comment")
+      def add_comment(text)
+        @client.logger.debug "Adding comment to issue #{@key}"
+        @client.Issue.add_comment(@id) do
+          payload body: text
+        end
+      end
+
+      def delete
+        @client.logger.debug "Deleting issue #{@key}"
+        @client.Issue.delete(@id)
+      end
+    end
+  end
+end

data/lib/rujira/resource/myself.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Resource
+    # Represents the currently authenticated Jira user (Myself).
+    # Provides access to basic user attributes retrieved from the Jira API.
+    #
+    class Myself < Common
+      attr_reader :url, :email, :name, :id, :key
+
+      # Initializes a Myself resource with data from the Jira API response.
+      #
+      # @param [Object] client The HTTP client used for API communication.
+      # @param [Hash] args The user data hash returned by the Jira API.
+      # @option args [String] 'self' The URL of the user's Jira profile.
+      # @option args [String] 'key' The user's Jira key.
+      # @option args [String] 'name' The user's display name.
+      # @option args [String] 'emailAddress' The user's email address.
+      def initialize(client, **args)
+        super
+
+        @url = args['self']
+
+        @key = args['key']
+        @name = args['name']
+        @email = args['emailAddress']
+      end
+    end
+  end
+end

data/lib/rujira/resource/project.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Resource
+    # Represents a Jira project.
+    # Provides access to project attributes and operations such as deletion.
+    #
+    class Project < Common
+      attr_reader :url, :id, :key
+
+      # Initializes a Project resource with data from the Jira API response.
+      #
+      # @param [Object] client The HTTP client used for API communication.
+      # @param [Hash] args The project data hash returned by the Jira API.
+      # @option args [String] 'self' The URL of the project in Jira.
+      # @option args [String] 'id' The internal ID of the project.
+      # @option args [String] 'key' The project key (e.g., PROJ).
+      def initialize(client, **args)
+        super
+
+        @url = args['self']
+        @id = args['id']
+        @key = args['key']
+      end
+
+      # Deletes the project from Jira using the client's Project API.
+      #
+      # @return [Object] The API response from the delete operation.
+      # @note This operation is irreversible and should be used with caution.
+      def delete
+        @client.Project.delete(@id)
+      end
+    end
+  end
+end

data/lib/rujira/version.rb

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

data/lib/rujira.rb

@@ -7,17 +7,21 @@ require 'faraday'
 require 'faraday/multipart'
 require 'json'
 
-require_relative 'rujira/error'
 require_relative 'rujira/version'
 require_relative 'rujira/request'
 require_relative 'rujira/client'
 require_relative 'rujira/api/common'
+require_relative 'rujira/resource/common'
 require_relative 'rujira/api/search'
 require_relative 'rujira/api/issue'
+require_relative 'rujira/resource/issue'
 require_relative 'rujira/api/project'
+require_relative 'rujira/resource/project'
 require_relative 'rujira/api/comment'
+require_relative 'rujira/resource/comment'
 require_relative 'rujira/api/attachments'
 require_relative 'rujira/api/myself'
+require_relative 'rujira/resource/myself'
 require_relative 'rujira/api/server_info'
 require_relative 'rujira/api/dashboard'
 require_relative 'rujira/api/board'
@@ -43,16 +47,4 @@ module Rujira
   #   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
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rujira
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrey Semenov
@@ -53,6 +53,7 @@ files:
 - cliff.toml
 - compose.yaml
 - contrib/jira_link_generator.rb
+- examples/create_issue_as_obj.rb
 - examples/create_issue_in_sprint.rb
 - lib/rujira.rb
 - lib/rujira/api/application_properties.rb
@@ -77,8 +78,12 @@ files:
 - lib/rujira/api/server_info.rb
 - lib/rujira/api/sprint.rb
 - lib/rujira/client.rb
-- lib/rujira/error.rb
 - lib/rujira/request.rb
+- lib/rujira/resource/comment.rb
+- lib/rujira/resource/common.rb
+- lib/rujira/resource/issue.rb
+- lib/rujira/resource/myself.rb
+- lib/rujira/resource/project.rb
 - lib/rujira/tasks/generate.rake
 - lib/rujira/version.rb
 - sig/rujira.rbs

data/lib/rujira/error.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Rujira
-  class Error < StandardError; end
-
-  # TODO: add docs
-  # Some description
-  class PathArgumentError < Error
-    def message
-      "No argument to 'path' was given."
-    end
-  end
-
-  # TODO: add docs
-  # Some description
-  class DataArgumentError < Error
-    def message
-      "No argument to 'data' was given."
-    end
-  end
-end