rujira 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e934f91388416b891e49d824c5f3d875708d5102d2084d8fa3c641be5006d02
-  data.tar.gz: 5cc8ee2aa9475057ae26953287f5f99c9be83adc0cd578236d17b758d5c82486
+  metadata.gz: 0f34a8819ae3c7e4746ba9230b4a90fc4e12bbd07511b637bc9f525e154658cb
+  data.tar.gz: 0ae20244cf2b25fff933d644499d749d62e41a69fefe71f98c884d716935e6ce
 SHA512:
-  metadata.gz: 83a61e445cb8b1a3e2e5f5cb338d9f31070df47c3ea1aff9be54c49a63f8d022658d76856fee5f934b0343b79d37c04ae78bf9cfd17cb721fa988f3971f9ac1f
-  data.tar.gz: 503b7bc45991306f9346ee2b8cc1b77e492194544caea88bb3931b71d30f04a8f99fc10a76de98f6ff91d008743de259860503c61698f159b1fbc8bfc04c22de
+  metadata.gz: 0a7f45cf6ca2ec3b6e812d1acc0c4286453da1b0f5695f19c4bb73e27e5b12f2ed6b3c13a0b8f3c887035c93fb4d84c4bdcb209e1374bcfd42d259d843f966d4
+  data.tar.gz: '07279fa66131a36441a959028e7d41ee6cffade569f4fe251db24dff47ba412452810f1930c321a7c999aa9dbf1f77414f31f3f345c66f4425721f5d8e64a608'

data/README.md

@@ -1,7 +1,11 @@
 # RUJIRA
 
+[![Ruby](https://github.com/itmagelab/rujira/actions/workflows/ruby.yml/badge.svg)](https://github.com/itmagelab/rujira/actions/workflows/ruby.yml)
+
 **RUJIRA** is a Ruby gem for easy interaction with the Jira API. It provides a simple and flexible interface to work with Jira resources and includes Rake tasks for convenient command-line operations.
 
+This project was created as an alternative to <https://github.com/sumoheavy/jira-ruby>, offering a more user-friendly and intuitive interface. It lets you work with requests as objects or hash arrays, provides flexibility in choosing a connection adapter, and makes the codebase easier to maintain.
+
 ---
 
 ## Features
@@ -16,7 +20,7 @@
 Add to your `Gemfile`:
 
 ```ruby
-gem 'rujira', '~> 0.6.0'
+gem 'rujira', '~> 0.7.0'
 ```
 
 Or install directly:
@@ -40,6 +44,24 @@ LOG_LEVEL=error
 
 ### Example of usage
 
+By default, we can use an object-oriented approach, but this method does not cover all API capabilities.
+
+```ruby
+url = ENV.fetch('RUJIRA_URL', 'http://localhost:8080')
+client = Rujira::Client.new(url, dispatchable: false)
+
+project = random_name
+me = client.Myself.get
+project = me.create_software_project key: project.to_s,
+                                     name: project.to_s
+task = project.add_task summary: 'BOT: added a new task.',
+                        description: 'This task was generated by the bot when creating changes in the repository.'
+task.add_comment 'Bot added a comment as obj #1'
+task.attach_file '/tmp/upload.file'
+```
+
+Alternatively, we can work with the API directly, as with a regular request dispatcher; in this form, most operations are available.
+
 ```ruby
 require 'date'
 

data/compose.yaml

@@ -13,7 +13,7 @@ services:
 
   db:
     image: postgres
-    mem_limit: 128mb  
+    mem_limit: 128mb
     restart: always
     shm_size: 128mb
     environment:

data/lib/rujira/api/board.rb

@@ -8,7 +8,7 @@ module Rujira
     # API reference:
     # https://docs.atlassian.com/jira-software/REST/9.17.0/#agile/1.0/board
     #
-    class Board < Common
+    class Board < Common # rubocop:disable Metrics/ClassLength
       # Initializes a new Board API client.
       #
       # @param [Object] client The HTTP client instance used to perform requests.
@@ -63,6 +63,145 @@ module Rujira
         call
       end
 
+      def create(&block)
+        builder do
+          method :post
+          path 'board'
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def delete(id, &block)
+        abort 'Board ID is required' if id.to_s.strip.empty?
+        builder do
+          method :delete
+          path "board/#{id}"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def backlog(id, &block)
+        abort 'Board ID is required' if id.to_s.strip.empty?
+        builder do
+          path "board/#{id}/backlog"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def configuration(id, &block)
+        abort 'Board ID is required' if id.to_s.strip.empty?
+        builder do
+          path "board/#{id}/configuration"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def issue(id, &block)
+        abort 'Board ID is required' if id.to_s.strip.empty?
+        builder do
+          path "board/#{id}/issue"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def epic(id, &block)
+        abort 'Board ID is required' if id.to_s.strip.empty?
+        builder do
+          path "board/#{id}/epic"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def epic_issues(id, epic_id, &block)
+        abort 'Board ID is required' if id.to_s.strip.empty?
+        builder do
+          path "board/#{id}/epic/#{epic_id}/issue"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def epic_none_issues(id, &block)
+        abort 'Board ID is required' if id.to_s.strip.empty?
+        builder do
+          path "board/#{id}/epic/none/issue"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def project(id, &block)
+        abort 'Board ID is required' if id.to_s.strip.empty?
+        builder do
+          path "board/#{id}/project"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def settings(id, &block)
+        abort 'Board ID is required' if id.to_s.strip.empty?
+        builder do
+          path "board/#{id}/settings/refined-velocity"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def set_settings(id, &block)
+        abort 'Board ID is required' if id.to_s.strip.empty?
+        builder do
+          method :put
+          path "board/#{id}/settings/refined-velocity"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def properties(id, &block)
+        abort 'Board ID is required' if id.to_s.strip.empty?
+        builder do
+          path "board/#{id}/properties"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def set_properties(id, property_key, &block)
+        abort 'board id is required' if id.to_s.strip.empty?
+        builder do
+          method :put
+          path "board/#{id}/properties/#{property_key}"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def get_properties(id, property_key, &block)
+        abort 'board id is required' if id.to_s.strip.empty?
+        builder do
+          path "board/#{id}/properties/#{property_key}"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
+      def delete_properties(id, property_key, &block)
+        abort 'board id is required' if id.to_s.strip.empty?
+        builder do
+          method :delete
+          path "board/#{id}/properties/#{property_key}"
+          instance_eval(&block) if block_given?
+        end
+        call
+      end
+
       # Retrieves all sprints for a specific board.
       #
       # Available query parameters:

data/lib/rujira/api/common.rb

@@ -41,7 +41,7 @@ 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
+        return self if @client.lazy
 
         to_obj
       end
@@ -52,6 +52,7 @@ module Rujira
       def commit
         @client.dispatch(@request)
       end
+      alias execute commit
 
       # Converts the API response into structured Ruby objects.
       # If the response is an array of hashes, maps each element through `process`.
@@ -59,9 +60,9 @@ module Rujira
       #
       # @return [Object] Processed response as one or more resource objects, or original response.
       def to_obj
-        response = commit
+        response = execute
 
-        return response.map { |el| process(el) } if response.is_a?(Array) && response.all? { |el| el.is_a?(Hash) }
+        return response.map { |el| process(el) } if response.is_a?(Array) && response.all?(Hash)
         return response unless response.is_a?(Hash)
 
         process response
@@ -76,7 +77,12 @@ module Rujira
       def process(response)
         response.merge!(@metadata)
         resource_class_name = self.class.name.sub('Api', 'Resource')
-        Object.const_get(resource_class_name).new(@client, **response)
+        begin
+          Object.const_get(resource_class_name).new(@client, **response)
+        rescue NameError
+          raise "Resource class '#{resource_class_name}' not found. " \
+                'Please ensure the class exists or use dispatchable mode.'
+        end
       end
 
       # Sets ownership context for the resource by storing a parent ID or key

data/lib/rujira/client.rb

@@ -11,7 +11,7 @@ module Rujira
   #   client.issue.get("TEST-123")
   #
   class Client
-    attr_reader :dispatchable, :logger, :commitable
+    attr_reader :dispatchable, :logger, :lazy
 
     SUPPORTED_METHODS = %i[get delete head post put patch].freeze
 
@@ -23,9 +23,9 @@ module Rujira
     # @example Initialize client
     #   client = Rujira::Client.new("https://jira.example.com", debug: true)
     #
-    def initialize(url, debug: false, dispatchable: true, commitable: false, log_level: 'error') # rubocop:disable Metrics/MethodLength
+    def initialize(url, debug: false, dispatchable: true, lazy: false, log_level: 'error') # rubocop:disable Metrics/MethodLength
       @dispatchable = dispatchable
-      @commitable = commitable
+      @lazy = lazy
       @uri = URI(url)
       @debug = ENV.fetch('RUJIRA_DEBUG', debug.to_s) == 'true'
       @raise_error = false

data/lib/rujira/resource/common.rb

@@ -2,7 +2,7 @@
 
 module Rujira
   module Resource
-    class Common
+    class Common # rubocop:disable Style/Documentation
       def initialize(client, **_args)
         @client = client
       end

data/lib/rujira/resource/issue.rb

@@ -47,6 +47,10 @@ module Rujira
         @client.logger.debug "Deleting issue #{@key}"
         @client.Issue.delete(@id)
       end
+
+      def attach_file(path)
+        @client.Issue.attachments @key, path
+      end
     end
   end
 end

data/lib/rujira/resource/myself.rb

@@ -25,6 +25,18 @@ module Rujira
         @name = args['name']
         @email = args['emailAddress']
       end
+
+      def create_software_project(**args)
+        key = args[:key]
+        project_name = args[:name]
+        name = @name
+        @client.Project.create do
+          payload key: key,
+                  name: project_name,
+                  projectTypeKey: 'software',
+                  lead: name
+        end
+      end
     end
   end
 end

data/lib/rujira/resource/project.rb

@@ -30,6 +30,19 @@ module Rujira
       def delete
         @client.Project.delete(@id)
       end
+
+      def add_task(**args)
+        key = @key
+        @client.Issue.create do
+          payload fields: {
+            project: { key: key },
+            summary: args[:summary],
+            description: args[:description],
+            issuetype: { name: 'Task' }
+          }
+          params updateHistory: true
+        end
+      end
     end
   end
 end

data/lib/rujira/tasks/generate.rake

@@ -8,7 +8,7 @@ require 'json'
 module Rujira
   module Tasks
     # TODO
-    class Jira
+    class Jira # rubocop:disable Metrics/ClassLength
       include Rake::DSL if defined?(Rake::DSL)
       def initialize
         generate
@@ -34,7 +34,7 @@ module Rujira
       end
 
       def generate # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
-        namespace :jira do
+        namespace :jira do # rubocop:disable Metrics/BlockLength
           desc 'Test connection by getting username'
           task :whoami do
             result = client.Myself.get
@@ -53,6 +53,18 @@ module Rujira
               result = client.Project.list
               puts JSON.pretty_generate(result)
             end
+
+            desc 'Create project'
+            task :create do |t|
+              options = fetch_options(%w[KEY NAME TYPE LEAD], t.name)
+              result = client.Project.create do
+                payload key: options[:key],
+                        name: options[:name],
+                        projectTypeKey: options[:type],
+                        lead: options[:lead]
+              end
+              puts JSON.pretty_generate(result)
+            end
           end
 
           namespace :dashboard do
@@ -107,15 +119,15 @@ module Rujira
             end
           end
 
-          namespace :issue do
+          namespace :issue do # rubocop:disable Metrics/BlockLength
             desc 'Create a issue'
             task :create do |t|
-              options = fetch_options(%w[PROJECT SUMMARY DESCRIPTION ISSUETYPE], t.name)
+              options = fetch_options(%w[PROJECT_KEY SUMMARY DESCRIPTION ISSUETYPE], t.name)
               abort 'ISSUETYPE must start with a capital letter' unless options[:issuetype].match?(/\A[A-Z]/)
 
               result = client.Issue.create do
                 payload fields: {
-                  project: { key: options[:project] },
+                  project: { key: options[:project_key] },
                   summary: options[:summary],
                   issuetype: { name: options[:issuetype] },
                   description: options[:description]

data/lib/rujira/version.rb

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

metadata

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