rujira 0.4.0 → 0.5.1

data/lib/rujira/api/project.rb

@@ -3,6 +3,8 @@
 module Rujira
   module Api
     # Provides access to Jira projects via the REST API.
+    # Allows creating, updating, retrieving, listing, and deleting projects,
+    # as well as retrieving project security levels.
     #
     # API reference:
     # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/project
@@ -15,21 +17,20 @@ module Rujira
       #
       # @example Create a project
       #   client.Project.create do
-      #     payload {
+      #     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'
           method :post
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Updates an existing project.
@@ -40,9 +41,8 @@ module Rujira
       #
       # @example Update a project
       #   client.Project.edit("TEST") do
-      #     payload { name: "Renamed Project" }
+      #     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
@@ -50,7 +50,7 @@ module Rujira
           method :put
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Retrieves a specific project by ID or key.
@@ -61,14 +61,13 @@ module Rujira
       #
       # @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
           path "project/#{id_or_key}"
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Lists all projects visible to the current user.
@@ -78,30 +77,30 @@ module Rujira
       #
       # @example List projects
       #   client.Project.list
-      #
       def list(&block)
         builder do
           path 'project'
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Deletes a project by ID or key.
       #
       # @param [String] id_or_key The project ID or key.
+      # @yield [builder] Optional block to configure additional request parameters.
       # @return [Object] The API response after deletion.
       #
       # @example Delete a project
       #   client.Project.delete("TEST")
-      #
-      def delete(id_or_key)
+      def delete(id_or_key, &block)
         abort 'Project ID or KEY is required' if id_or_key.to_s.strip.empty?
         builder do
           method :delete
           path "project/#{id_or_key}"
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Retrieves the security levels for a specific project.
@@ -112,14 +111,13 @@ module Rujira
       #
       # @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
           path "project/#{id_or_key}/securitylevel"
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
     end
   end

data/lib/rujira/api/search.rb

@@ -11,22 +11,25 @@ module Rujira
     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).
+      # @yield [builder] Optional block to configure the request payload,
+      #   such as JQL query, fields to return, pagination, and sorting.
       # @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
+      #     payload({
+      #       jql: "project = TEST AND status = 'To Do'",
+      #       maxResults: 10,
+      #       fields: ["summary", "assignee", "status"]
+      #     })
       #   end
-      #
       def get(&block)
         builder do
           path 'search'
           method :post
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
     end
   end

data/lib/rujira/api/server_info.rb

@@ -3,7 +3,7 @@
 module Rujira
   module Api
     # Provides access to Jira server information via the REST API.
-    # Retrieves details about the Jira server instance, including version and build info.
+    # Allows retrieving 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
@@ -11,16 +11,18 @@ module Rujira
     class ServerInfo < Common
       # Retrieves Jira server information.
       #
+      # @yield [builder] Optional block to configure additional request parameters.
       # @return [Object] The API response containing server details.
       #
-      # @example Get server info
-      #   client.Server_info.get
+      # @example Get Jira server information
+      #   client.ServerInfo.get
       #
-      def get
+      def get(&block)
         builder do
           path 'serverInfo'
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
     end
   end

data/lib/rujira/api/sprint.rb

@@ -37,7 +37,7 @@ module Rujira
           method :post
           instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Updates an existing sprint partially.
@@ -53,7 +53,7 @@ module Rujira
       #
       def update(id, &block)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
-        raise ArgumentError, 'block is required' unless block
+        raise ArgumentError, 'Block is required' unless block
 
         builder do
           path "sprint/#{id}"
@@ -61,7 +61,7 @@ module Rujira
           method :post
           instance_eval(&block)
         end
-        run
+        call
       end
 
       # Replaces an existing sprint.
@@ -77,7 +77,7 @@ module Rujira
       #
       def replace(id, &block)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
-        raise ArgumentError, 'block is required' unless block
+        raise ArgumentError, 'Block is required' unless block
 
         builder do
           path "sprint/#{id}"
@@ -85,79 +85,101 @@ module Rujira
           method :put
           instance_eval(&block)
         end
-        run
+        call
       end
 
       # Retrieves details of a specific sprint.
       #
       # @param [Integer] id The sprint ID.
+      # @yield [builder] Optional block to configure the request.
       # @return [Object] The API response containing sprint details.
       #
-      def get(id)
+      # @example Get sprint details
+      #   client.Sprint.get(1)
+      #
+      def get(id, &block)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
         builder do
           path "sprint/#{id}"
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Retrieves all issues in a sprint.
       #
       # @param [Integer] id The sprint ID.
-      # @return [Object] The API response containing issues.
+      # @yield [builder] Optional block to configure the request.
+      # @return [Object] The API response containing sprint issues.
+      #
+      # @example Get issues in sprint
+      #   client.Sprint.get_issue(1)
       #
-      def get_issue(id)
+      def get_issue(id, &block)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
         builder do
           path "sprint/#{id}/issue"
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Deletes a sprint.
       #
       # @param [Integer] id The sprint ID.
+      # @yield [builder] Optional block to configure the request.
       # @return [Object] The API response after deletion.
       #
-      def delete(id)
+      # @example Delete sprint
+      #   client.Sprint.delete(1)
+      #
+      def delete(id, &block)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
         builder do
           method :delete
           path "sprint/#{id}"
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
 
       # Retrieves all properties of a sprint.
       #
       # @param [Integer] id The sprint ID.
+      # @yield [builder] Optional block to configure the request.
       # @return [Object] The API response containing sprint properties.
       #
-      def properties(id)
+      # @example Get sprint properties
+      #   client.Sprint.properties(1)
+      #
+      def properties(id, &block)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
         builder do
           path "sprint/#{id}/properties"
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       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.
+      # @yield [builder] Optional block to configure the request.
       # @return [Object] The API response after adding issues.
       #
-      # @example Add issues to a sprint
+      # @example Add issues to sprint
       #   client.Sprint.issue(1, [101, 102])
       #
-      def issue(id, issues)
+      def issue(id, issues, &block)
         abort 'Sprint ID is required' if id.to_s.strip.empty?
         builder do
           method :post
           path "sprint/#{id}/issue"
           payload issues: issues
+          instance_eval(&block) if block_given?
         end
-        run
+        call
       end
     end
   end

data/lib/rujira/client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'logger'
+
 module Rujira
   # Main Jira API client.
   # Provides access to Jira resources via method_missing delegation to API classes.
@@ -9,8 +11,7 @@ module Rujira
   #   client.issue.get("TEST-123")
   #
   class Client
-    # @return [Rujira::Request] The current request object being configured
-    attr_accessor :request
+    attr_reader :logger, :dispatchable
 
     # Initializes a new Jira client.
     #
@@ -20,11 +21,25 @@ module Rujira
     # @example Initialize client
     #   client = Rujira::Client.new("https://jira.example.com", debug: true)
     #
-    def initialize(url, debug: false)
+    def initialize(url, debug: false, dispatchable: true, log_level: 'error') # rubocop:disable Metrics/MethodLength
+      @dispatchable = dispatchable
       @uri = URI(url)
       @debug = ENV.fetch('RUJIRA_DEBUG', debug.to_s) == 'true'
       @raise_error = false
-      @request = Request.new
+      @logger ||= Logger.new($stdout)
+
+      log_levels = {
+        'debug' => Logger::DEBUG,
+        'info' => Logger::INFO,
+        'warn' => Logger::WARN,
+        'error' => Logger::ERROR,
+        'fatal' => Logger::FATAL
+      }
+
+      @logger.level = log_levels.fetch(
+        ENV.fetch('LOG_LEVEL', log_level).downcase,
+        Logger::ERROR
+      )
     end
 
     # Dynamically instantiates the appropriate API resource class.
@@ -36,25 +51,13 @@ module Rujira
     # @example Access an API resource
     #   client.issue.get("TEST-123")
     #
-    def method_missing(method_name, ...)
+    def method_missing(method_name)
       resource_class = Rujira::Api.const_get(method_name.to_s)
-      resource_class.new(self, ...)
+      resource_class.new(self)
     rescue NameError
       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
@@ -70,16 +73,19 @@ module Rujira
     # @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"
-      end
+    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)
 
       begin
-        args = [@request.path]
-        args << @request.payload if %i[post put patch].include?(@request.method)
+        args = [request.path]
+        args << request.payload if %i[post put patch].include?(request.method)
 
-        response = connection.public_send(@request.method, *args)
+        options = {
+          url: @uri,
+          headers: request.headers,
+          params: request.params
+        }
+        response = connection(options, request.authorization).public_send(request.method, *args)
 
         if response.success?
           response.body
@@ -96,14 +102,14 @@ module Rujira
     #
     # @return [Faraday::Connection] Configured Faraday connection
     #
-    def connection
+    def connection(options, authorization)
       Faraday.new(options) do |builder|
-        builder.request :authorization, *@request.authorization if @request.authorization
+        builder.request :authorization, *authorization if authorization
         builder.request :multipart, flat_encode: true
         builder.request :json
         builder.response :json
         builder.response :raise_error if @raise_error
-        builder.response :logger if @debug
+        builder.response :logger, @logger if @debug
       end
     end
 

data/lib/rujira/version.rb

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

metadata

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